Klasa Edit

namespace Kei\Webas\Dedicated\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

setDescription($a)
return $this

$a → Ustala opis dla konta FTP

getDescription()
return string

Zwraca ustawiony opis konta FTP

setExpirationTime($a)
return $this

$a → Data wygaśnięcia konta FTP w formacie 'YYYY-MM-DD' lub enumerator \Kei\Webas\YesNoEnum.

getExpirationTime()
return string

Zwraca datę wygaśnięcia konta FTP lub enumerator YesNoEnum

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.

setProfile($a)
return $this

$a → Profil konta FTP. Użyj obiektu \Kei\Webas\Dedicated\Ftp\Profile.

getProfile()
return Profile

Zwraca profil konta FTP jako obiekt \Kei\Webas\Dedicated\Ftp\Profile.

setLockFtp($a)
return $this

Blokada dostępu do konta FTP to brak możliwości pobierania i wgrywania plików na konto.
Blokada administratora jest traktowana jako blokada usługi i uniemożliwia również wykonywanie operacji w panelu WebAs. Przypisane strony WWW oraz poczta e-mail w domenach będą poprawnie funkcjonować.

Blokada użytkownika jest traktowana jako ochrona zawartości konta przed włamaniem.
$a → Użyj enumeratora \Kei\Webas\Dedicated\YesNoUserlockEnum

getLockFtp()
return string

Zwraca status blokady dostępu do konta FTP

setLockMail($a)
return $this

Blokada odbierania i wysyłania poczty przez serwer pocztowy wiadomości z kont e-mail w domenach przypisanych do tego konta FTP.

Uwaga! Właściciele kont e-mail dalej będą mogli się połączyć ze swoją skrzynką za pomocą POP3, IMAP w celu czytania poczty tam zgromadzonej.
$a → Blokada poczty. Użyj obiektu \Kei\Webas\YesNoEnum.

getLockMail()
return int

Zwraca stan blokady poczty

setLockWww($a)
return $this

Blokada wyświetlania wszystkich stron WWW. Zamiast właściwej treści widoczna będzie strona informacyjna z komunikatem o blokadzie. Jej wygląd i zawartość może być dostosowana do potrzeb przez administratora serwera.
$a → Blokada WWW. Użyj obiektu \Kei\Webas\YesNoEnum.

getLockWww()
return int

Zwraca stan blokady WWW

setBlockFtpUploads($a)
return $this

$a → Blokada wgrywania danych. Użyj enumeratora \Kei\Webas\YesNoSelectedEnum

getBlockFtpUploads()
return string

Zwraca stan blokady wgrywania danych

setBlockFtpDownloads($a)
return $this

$a → Blokada pobierania danych. Użyj enumeratora \Kei\Webas\YesNoSelectedEnum.

getBlockFtpDownloads()
return string

Zwraca stan blokady pobierania danych

*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' wraz ze zmianą w ustawieniach profilu konta
$wapi_test = $webas->Ftp()->Edit('wapi_test');
$wapi_test_profile = $wapi_test->getProfile();
    $wapi_test->
        setDescription("nowy opis 2")->
        setLockFtp(\Kei\Webas\Dedicated\YesNoUserlockEnum::UserLock)->
        setProfile($wapi_test_profile->
        setPhpMode(\Kei\Webas\Dedicated\Ftp\Profile\phpMode::Factory(\Kei\Webas\Dedicated\PhpModeEnum::MultiPhp, \Kei\Webas\Dedicated\PhpVersionsEnum::Php55)))->
    execute();

Klasa Edit · NiceAPI dla PHP 5.6