Klasa Edit

namespace Kei\Webas\VPS\Ftp

Klasa służy do edycji konta FTP analogicznie jak w panelu Webas pod adresem https://webas12345.tld.pl/Ftp/Edit.

Klasa dziedziczy bezpośrednio z obiektu AbstractActionResult.


Dostępne metody klasy

__construct($a)

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

  • $a → Nazwa edytowanego konta FTP

setPrivilegesValue($a)
return $this

Ustaw uprawnienia konta
$a → Użyj obiektu \Kei\Webas\VPS\Ftp\Privileges

getPrivilegesValue()
return Privileges

Zwraca uprawnienia konta

setDescription($a)
return $this

$a → Ustala opis dla konta FTP

getDescription()
return string

Zwraca ustawiony opis konta FTP

setPassword($a)
return $this

$a → Hasło do konta FTP

getPassword()
return string

Zwraca hasło do konta FTP. UWAGA! Nie ma możliwości odczytania wcześniej zapisanego hasła.

setDirectory($a)
return $this

$a → Ustawia podkatalog na pliki

getDirectory()
return string

Zwraca ścieżkę katalogu na pliki

*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 konta FTP 'wapi_test'
$wapi_test = $webas->Ftp()->Edit('wapi_test')->
    setDirectory('/nowa/lokalizacja')->
    execute();

Klasa Edit · NiceAPI dla PHP 5.6