Klasa Index

namespace Kei\Webas\Dedicated\HistoryPanel

Klasa do prezentacji tabeli danych dotyczących zmian aktywności w panelu WebAs w postaci obiektu InfoTable zgodnie ze stroną https://webas12345.tld.pl/HistoryPanel/Index.

Klasa dziedziczy bezpośrednio z obiektu AbstractPaginator.


Dostępne metody klasy

::buildSearchParams($a, $b)
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\HistoryPanel\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\HistoryPanel\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...

// Filtrowanie wyników wyszukiwania
$res1 = $webas->HistoryPanel()->Index()->paginate();
\Kei\Library\Out::pd($res1);

// Pokaż historię zmian w DNSie z podanego przedziału dat
$res2 = $webas->HistoryPanel()->Index()->
    setSearch("", \Kei\Webas\Dedicated\HistoryPanel\Index::buildSearchParams("2017-01-01", "2017-03-01"))->
    paginate();
\Kei\Library\Out::pd($res2);

Klasa Index · NiceAPI dla PHP 5.6