Klasa Index

namespace Kei\Webas\Dedicated\Domain

Klasa służy do odczytu tabeli domen dostępnej w panelu Webas pod adresem https://webas12345.tld.pl/Domain/Index.

Klasa dziedziczy bezpośrednio z obiektu AbstractPaginator.

---

Dostępne metody klasy

::buildSearchParams($p1, $p2) return Array	Statyczna metoda tworząca pomocniczy parametr filtrujący wyniki wyszukiwania.
*paginate() return InfoTable	Bezparametrowana metoda wykonująca, filtrująca oraz grupująca wyniki zapytania w obiekcie InfoTable - zwraca ten obiekt
*setPaginator() return $this	Ustawia aktualny stan paginacji prezentowanych wyników w obiekcie InfoTable. Zwraca obiekt \Kei\Webas\Dedicated\Domain\Index.
*setSearch() return $this	Metoda pozwalająca na sprecyzowanie słów kluczowych dla wyszukiwania w tabeli danych. Wyszukiwanie wykonywane jest po stronie panelu Webas. Zwraca obiekt \Kei\Webas\Dedicated\Domain\Index.
*countAllResults() return int	Bezparametrowana metoda zwracająca liczbę wszystkich znalezionych wierszy w tabeli obiektu (bez zastosowania filtrowania) InfoTable. Można wykonać zamiast metody paginate().
*getCurrentPage() return int	Bezparametrowana metoda zwracająca aktualny numer strony ustawiony za pomocą metody setPaginator()
*getRowsOnPage() return int	Bezparametrowana metoda zwracająca aktualną liczbę wyników na stronę. Wartość ustawiana za pomocą metody setPaginator()

Gwiazdka przed nazwą metody oznacza iż ta metoda jest własnością klasy rodzica (dziedziczącej).

---

Wyjątki

Przejdź do pełnej listy wyjątków

Pamiętaj o tym, aby zawsze być przygotowanym na zwrócenie wyjątku przez skrypt PHP niezależnie od tego jak bardzo małoprawdopodobnym uważasz jego wystąpienie.

---

Przykłady wykorzystania

W poniższym przykładzie pominięto autoryzację do serwera. Obiekt Client znajduje się w zmiennej $webas. Więcej o autoryzacji przeczytasz w dziale jak rozpocząć ?

Nie zawijaj wierszy<?php
// Autoryzacja...

// Pobranie listy wszystkich domen
$table = $webas->Domain()->Index()->paginate();
\Kei\Library\Out::pd($table);

// Pobranie listy domen o profilu 'bez-limitu', których właścicielem jest użytkownik 'admin'
$table = $webas->Domain()->Index()->setSearch("", \Kei\Webas\Dedicated\Domain\Index::buildSearchParams("bez-limitu", "admin"))->paginate();
\Kei\Library\Out::pd($table);