Klasa Domain

namespace Kei\Webas\VPS

Klasa do zarządzania domenami. Funkcjonalne odwzorowanie panelu na stronie https://webas12345.tld.pl/Domain.

UWAGA!

Klasa ta zawiera bardzo ważną podklasę \Kei\Webas\VPS\Domain\Profile. Koniecznie zapoznaj się z nią jeśli jeszcze tego nie zrobiłeś.

---

Charakterystyka

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

Index	Lista zasobów w postaci tabeli danych
Add	Dodanie jednej pozycji listy
AddMany	Dodanie większej ilości domen
Edit	Edycja wybranej domeny
Remove	Usunięcie jednej lub więcej pozycji listy
Block	Zablokowanie wybranej domeny
Unblock	Odblokowanie wybranej domeny
IsWwwBlocked	Sprawdzenie stanu zablokowania obsługi stron www
IsMailBlocked	Sprawdzenie stanu zablokowania poczty w domenie

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\Domain zwraca obiekt \Kei\Webas\VPS\Domain\Edit itd.

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

---

Podklasa Domain

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

::exists($domain_name) return bool

Statyczna metoda oferująca sprawdzenie istnienia podanej domeny $domain_name → Nazwa domeny

---

Wyjątki

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

• \Kei\Webas\VPS\Domain\Exception\DomainNotFoundException
• \Kei\Webas\VPS\Domain\Exception\ProfileNotFoundException
• \Kei\Webas\VPS\Domain\Exception\ProfileOptionValueException
• \Kei\Webas\VPS\Domain\Exception\ResultException
• \Kei\Webas\VPS\Domain\Exception\ValidationException
• \Kei\Webas\VPS\Domain\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...

// Pobranie listy wszystkich domen
$table = $webas->Domain()->Index()->paginate();
\Kei\Library\Out::pd($table);

// Dodanie jednej domeny bez ustawionego profilu - domyślne ustawienia panelu Webas
$webas->Domain()->Add("jakas-nowa.example.pl", 'addedmany1', "8k55HFBz6A")->execute();

// Dodanie jednej domeny z wykrozystaniem profilu 'abc'
$profile = \Kei\Webas\VPS\Domain\Profile::load("abc");
$webas->Domain()->Add("jakas-nowa3.example.pl", 'addedmany1', "8k55HFBz6A", "", $profile)->execute();

// Czy podana domena ma zablokowany serwer www ?
\Kei\Library\Out::vd($webas->Domain()->IsWwwBlocked('tester1.12345.v.tld.pl')->execute()->getActionResult());

// Blokada domeny
$webas->Domain()->Block('jakas-nowa.example.pl')->execute();

// Odblokowanie domeny
$webas->Domain()->Unblock('jakas-nowa.example.pl')->execute();

// Edycja domeny wraz z rekonfiguracją ustawień
$webas->Domain()->
Edit('jakas-nowa.example.pl')->
    setForceWww(\Kei\Webas\VPS\YesNoEnum::Yes)->
    setMailBlocked(\Kei\Webas\VPS\YesNoEnum::Yes)->
    execute();

// Dodanie większej ilości domen bez uwzględnienia wspólnego profilu
$webas->Domain()->
    AddMany(['test1.12345.v.tld.pl', 'test2.12345.v.tld.pl'], 'addedmany1', "8k55HFBz6A", 'common_dir')->
    execute();