Klasa Add

namespace Kei\Webas\Dedicated\AntyspamWhitelist

Klasa służy do dodania nowego elementu uprzywilejowanego dostępnego w panelu Webas pod adresem https://webas12345.tld.pl/AntyspamWhitelist/Add.

Klasa dziedziczy bezpośrednio z obiektu AbstractActionResult.

---

Dostępne metody klasy

__construct($names = null)	Konstruktor dzięki któremu utworzysz nowy obiekt klasy. Domyślnie = NULL. Podczas jego wykonywania następuje połączenie do panelu Webas oraz odczytanie wartości aktualnego limitu wpisów oraz aktualnej ilości zużytych wpisów. Możesz podać jako parametr wartość PHP NULL, ciąg znaków lub tablicę elementów
getLimit() return int	Bezparametrowa metoda zwracająca akutalny limit wpisów.
getUsage() return int	Bezparametrowa metoda zwracająca akutalny stan użycia wpisów.
setNames($names) return Add	Ustawia jeden lub więcej wpisów do dodania. Możesz podać jedną wartość w postaci ciągu znaków lub więcej jako tablicę takich ciągów.
getNames() return Array	Metoda zwraca ustawione wcześniej wpisy.
*execute() return Add	Bezparametrowa metoda zatwierdzająca i wykonująca akcję opisaną główną funkcją tej klasy.
*getActionResult() return bool	Bezparametrowa metoda zwracająca status ostatniej operacji.

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...

// Wyświetlenie statystyk
$handle = $webas->AntyspamWhitelist()->Add();
$limit = $handle->getLimit();
$usage = $handle->getUsage();

\Kei\Library\Out::p($limit);
\Kei\Library\Out::pd($usage);

// Dodanie pojedyńczego wpisu
$result = $webas->AntyspamWhitelist()->
    Add('wp.pl')->
    execute();

\Kei\Library\Out::vd($result->getActionResult());

// Hurtowe dodanie kilku wpisów jednocześnie
$result2 = $webas->AntyspamWhitelist()->
    Add(['mail@example.com', 'onet.pl', 'example.com'])->
    execute();

\Kei\Library\Out::vd($result2->getActionResult());