Klasa Remove

namespace Kei\Webas\Dedicated\AntyspamWhitelist

Klasa służy do usuwania jednego lub więcej uprzywilejowanych wpisów listy antyspamowej.

Klasa dziedziczy bezpośrednio z obiektu AbstractActionResult.


Dostępne metody klasy

__construct($names)

Konstruktor dzięki któremu utworzysz nowy obiekt klasy. Możesz przekazać ciąg znaków lub numeryczną tablicę ciągów.

*execute()
return Remove

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

// Usunięcie wpisu o treści example.pl
$result = $webas->AntyspamWhitelist()->
    Remove('example.pl')->
    execute();

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

// Usunięcie wybranych wpisów
$result2 = $webas->AntyspamWhitelist()->
    Remove(['mail@example.pl', 'onet.pl'])->
    execute();

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

Klasa Remove · NiceAPI dla PHP 5.6