Klasa Add

namespace Kei\Webas\VPS\SecurityDirectory

Klasa służy do dodania hasła na katalog analogicznie jak w panelu Webas pod adresem https://webas12345.tld.pl/SecurityDirectory/Add.

Klasa dziedziczy bezpośrednio z obiektu AbstractActionResult.


Dostępne metody klasy

__construct($a, $b, $c)

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

  • $a → Opis
  • $b → Komunikat przeglądarki WWW
  • $c → Zabezpieczany katalog (ścieżka od katalogu nadrzędnego). Domyślnie <pusty_ciąg>

setDescription($a)
return $this

$a → Ustawia opis

getDescription()
return string

Zwraca opis

setAccessForValue($a)
return $this

$a → Ustawia wartość określającą dla kogo będzie dostępne logowanie do zabezpieczonego katalogu. Użyj obiektu \Kei\Webas\VPS\SecurityDirectory\AccessFor.

getAccessForValue()
return AccessFor

Zwraca \Kei\Webas\VPS\SecurityDirectory\AccessFor

setDirectory($a)
return $this

$a → Ustawia zabezpieczany katalog

getDirectory()
return string

Zwraca zabezpieczany katalog

setPrompt($a)
return $this

$a → Ustawia komunikat przeglądarki WWW

getPrompt()
return string

Zwraca komunikat przeglądarki WWW

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

// Utworzenie zabezpieczenia całego katalogu public_html z podanym hasłem.
$webas->SecurityDirectoryUser()->
    Add("Lorem lipsum...", "6Sd.Wtxvkg")->
    execute();

Klasa Add · NiceAPI dla PHP 5.6