Klasa Edit

namespace Kei\Webas\Dedicated\FirewallBlockedIp

Klasa służy do edycji wskazanej pozycji firewalla analogicznie jak w panelu Webas pod adresem https://webas12345.tld.pl/FirewallBlockedIp/Edit.

Klasa dziedziczy bezpośrednio z obiektu AbstractActionResult.


Dostępne metody klasy

__construct($ip)

Konstruktor dzięki któremu utworzysz nowy obiekt klasy.

  • $ip → Adres IP, adres IP z maską lub nazwa domeny do zablokowania

setActive($a)
return $this

$a → (true|false) Czy blokada ma być aktywowana ?

getActive()
return bool

Zwraca status blokady.

setDescription($a)
return $this

$a → Podaj opis dla blokowanej pozycji

getDescription()
return Parameters

Zwraca opis blokowanej pozycji

setIp($a)
return $this

$a → Adres IP, adres IP z maską lub nazwa domeny do zablokowania

getIp()
return string

Zwraca nazwę blokowanej pozycji

*execute()
return Edit

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

// Edycja wybranej blokady. UWAGA! ID blokady należy zaczerpnąć z obiektu InfoTable (wylistowanie blokad)
$webas->FirewallBlockedIp()->
    Edit(54829)->
        setDescription("lorem lipsum eer33")->
        setActive(false)->
    execute();

Klasa Edit · NiceAPI dla PHP 5.6