Klasa Identity

namespace Kei\Webas\Dedicated\Ftp\Profile

Za pomocą tej klasy stworzysz część profilu konta FTP nazwany w panelu Webas jako Identyfikacja

Klasa implementuje interfejs DumperInterface

Klasa ma zastosowanie m.in w klasie \Kei\Webas\Dedicated\Ftp\Profile i metodzie
Profile :: setIdentityValue()


Charakterystyka

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

__construct($a, $b, $c, $d)
return Identity

Konstruktor dzięki, któremu utworzysz obiekt z domyślną konfiguracją identyfikacji w profilu ftp - adekwatnie do domyślnych ustawień panelu Webas.
$a → Nazwa profilu
$b → Opis profilu
$c → Numer SKEL to predefiniowana startowa zawartość konta FTP jaka będzie wgrana zaraz po jego utworzeniu. Wartość domyślna: NULL
$d → (bool) Ustaw wartość true jeśli chcesz aby ustawienia profilu były domyślnymi ustawieniami w formularzu dodawania FTP. Domyślnie false

::Factory($a, $b, $c, $d)
return Identity

Statyczna metoda zwracająca instancję klasy. Wzorzec projektowy Fabryka.
$a → Nazwa profilu
$b → Opis profilu
$c → Numer SKEL to predefiniowana startowa zawartość konta FTP jaka będzie wgrana zaraz po jego utworzeniu. Wartość domyślna: NULL
$d → (bool) Ustaw wartość true jeśli chcesz aby ustawienia profilu były domyślnymi ustawieniami w formularzu dodawania FTP. Domyślnie false

setName($name)
return $this

$name → Podaj nazwę profilu

getName()
return string

Zwraca nazwę profilu

setDescription($description)
return $this

$description → Opis profilu

getDescription()
return string

Zwraca ustawiony opis profilu

setSkelId($skel)
return $this

$skel → Numer SKEL to predefiniowana startowa zawartość konta FTP jaka będzie wgrana zaraz po jego utworzeniu.

getSkelId()
return string

Zwraca numer SKEL.

setDefault($default)
return $this

$default → (bool) Ustaw wartość true jeśli chcesz aby ustawienia profilu były domyślnymi ustawieniami w formularzu dodawania FTP.

getDefault()
return PhpMode

Zwraca wartość logiczną statusu ustwienia profilu jako domyślnego.

*dump()
return Array

Zobacz więcej tutaj DumperInterface

Gwiazdka przed nazwą metody oznacza iż ta metoda jest własnością klasy rodzica (dziedziczącej).


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

// Utworzenie nowej instancji klasy Identity z wykorzystaniem konstruktora
$identity = new \Kei\Webas\Dedicated\Ftp\Profile\Identity("nowy-profil-ftp", "lorem lipsum");
$identity->setDefault(true);
\Kei\Library\Out::pd($identity);

// Utworzenie nowej instancji klasy Identity z wykorzystaniem statycznej metody Factory
$identity = \Kei\Webas\Dedicated\Ftp\Profile\Identity::Factory("nowy-profil-ftp", "lorem lipsum");
$identity->setDefault(true);
\Kei\Library\Out::pd($identity);

// Zaimportowanie obiektu Identity z zewnętrznego profilu FTP i ...
$profile = \Kei\Webas\Dedicated\Ftp\Profile::load("testowy");
$identity = $profile->getIdentityValue();
// ... zmiana jego wartości
$identity->
    setDefault(true)->
    setName("moja-nowa-nazwa")->
    setSkelId("123456");
        
    
Klasa Identity · NiceAPI dla PHP 5.6