Klasa Identity

namespace Kei\Webas\VPS\EmailAccount\Profile

Klasa pochodząca z przestrzeni nazw \Kei\Webas\VPS\EmailAccount\Profile. Za jej pomocą stworzysz część profilu poczty nazwany w panelu Webas jako Identyfikacja

Klasa implementuje interfejs DumperInterface

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


Charakterystyka

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

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

Konstruktor dzięki, któremu utworzysz obiekt z domyślną konfiguracją identyfikacji w profilu konta pocztowego - adekwatnie do domyślnych ustawień panelu Webas.
$a → Nazwa profilu
$b → Opis profilu
$c → (bool) Ustaw wartość true jeśli chcesz aby ustawienia profilu były domyślnymi ustawieniami w formularzu dodawania konta pocztowego. Domyślnie false

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

Statyczna metoda zwracająca instancję klasy. Wzorzec projektowy Fabryka.
$a → Nazwa profilu
$b → Opis profilu
$c → (bool) Ustaw wartość true jeśli chcesz aby ustawienia profilu były domyślnymi ustawieniami w formularzu dodawania konta pocztowego. 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

setDefault($default)
return $this

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

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\VPS\EmailAccount\Profile\Identity("nowy-profil-poczty", "lorem lipsum");
$identity->setDefault(true);
\Kei\Library\Out::pd($identity);

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

Klasa Identity · NiceAPI dla PHP 5.6