Klasa Index

namespace Kei\Webas\Dedicated\EmailAlias

Klasa służy do odczytu tabeli aliasów kont pocztowych dostępnej w panelu Webas pod adresem https://webas12345.tld.pl/EmailAlias/Index.

Klasa dziedziczy bezpośrednio z obiektu AbstractPaginator.

Dostępne metody klasy

::buildSearchParams($domain) 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\EmailAlias\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\EmailAlias\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...

// Lista wszystkich aliasów w domenie 'example.pl'
$table = $webas->EmailAlias()->Index()->setSearch("", \Kei\Webas\Dedicated\EmailAlias\Index::buildSearchParams("example.pl"))->paginate();
\Kei\Library\Out::pd($table);

Klasa Index

namespace Kei\Webas\Dedicated\EmailAlias

Dostępne metody klasy

::buildSearchParams($domain)

return Array

*paginate()

return InfoTable

*setPaginator()

return $this

*setSearch()

return $this

*countAllResults()

return int

*getCurrentPage()

return int

*getRowsOnPage()

return int

Wyjątki

Przykłady wykorzystania

Newsletter NiceAPI

Produkt

Wsparcie

Kontakt

Dołącz do nas

Menu