Klasa Ftp

namespace Kei\Webas\VPS

Klasa do zarządzania kontami FTP. Funkcjonalne odwzorowanie panelu na stronie https://webas12345.tld.pl/Ftp.

---

Charakterystyka

Metody obiektu - zapoznaj się z opisem pod tabelą.

Index	Lista zasobów w postaci tabeli danych
Add	Dodanie jednej pozycji listy
Edit	Edycja wybranego konta FTP
Remove	Usunięcie jednej lub więcej pozycji listy

Każda z powyższych metod zwraca odpowiadający jej obiekt klasy znajdujący się w tej samej przestrzeni nazw i nazywający się tak samo jak metoda do której się odnosi.

Np. metoda Edit klasy \Kei\Webas\VPS\Ftp zwraca obiekt \Kei\Webas\VPS\Ftp\Edit itd.

Po kliknięciu w jedną z powyższych metod przejdziesz do strony charakteryzującej odpowiadający jej obiekt.

---

Podklasa Ftp

Klasa pochodząca z przestrzeni nazw \Kei\Webas\VPS\Ftp zawierająca metody pomocnicze

::exists($ftp_name) return bool	Statyczna metoda oferująca sprawdzenie istnienia podanej domeny $ftp_name → Nazwa domeny
::mainAccountExists($ftp_name) return bool	Statyczna metoda oferująca sprawdzenie istnienia głównego konta FTP $ftp_name → Nazwa domeny

---

Wyjątki

Wyjątki jakie zwraca ta klasa oraz pozostałe klasy powiązane są następujące:

• \Kei\Webas\VPS\Ftp\Exception\FtpAccountNotFoundException
• \Kei\Webas\VPS\Ftp\Exception\ProfileNotFoundException
• \Kei\Webas\VPS\Ftp\Exception\ProfileOptionValueException
• \Kei\Webas\VPS\Ftp\Exception\ResultException
• \Kei\Webas\VPS\Ftp\Exception\ValidationException
• \Kei\Webas\VPS\Ftp\Exception\WrongTypeException

oraz wyjątki standardowe dla wszystkich obiektów położonych wyżej w hierarchii:

• \Kei\Webas\VPS\Exception\DefaultPaginatorActionException
• \Kei\Webas\VPS\Exception\InfoTableColumnCountException
• \Kei\Webas\VPS\Exception\InitialCookieNotFoundException
• \Kei\Webas\VPS\Exception\ServiceNumberFormatException
• \Kei\Webas\VPS\Exception\UncountableResultsException
• \Kei\Webas\VPS\Exception\WebasAuthenticationException
• \Kei\Webas\VPS\Exception\WebasConnectionException

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 metod

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

// Filtrowanie wyników wyszukiwania
\Kei\Library\Out::vd($webas->Ftp()->Index()->paginate());
\Kei\Library\Out::pd($webas->Ftp()->Index()->setPaginator(1,5)->paginate());
\Kei\Library\Out::pd($webas->Ftp()->Index()->setSearch("admin")->paginate());
\Kei\Library\Out::pd($webas->Ftp()->Index()->countAllResults());
        
// Dodanie nowego konta FTP
$webas->Ftp()->
    Add("wapi_test", "lorem lipsum", "tajnehasloftp")->
        execute();

// Edycja konta FTP 'wapi_test'
$wapi_test = $webas->Ftp()->Edit('wapi_test')->
    setDirectory('/nowa/lokalizacja')->
    execute();

// Weryfikacja istnienia konta
$ftp_exists = \Kei\Webas\VPS\Ftp\Ftp::exists('admin');
\Kei\Library\Out::vd($ftp_exists);

// Usunięcie kont FTP
$webas->Ftp()->
    Remove(['wapi_test', 'wapi_test2'])->
    execute();