Klasa Add

namespace Kei\Webas\Dedicated\Domain

Klasa służy do dodania nowej konfiguracji domeny analogicznie jak w panelu Webas pod adresem https://webas12345.tld.pl/Domain/Add.

Klasa dziedziczy bezpośrednio z obiektu AbstractActionResult.


Dostępne metody klasy

__construct($a, $b, $c,
$d, $e, $f, $g)

Konstruktor dzięki któremu utworzysz nowy obiekt klasy.

  • $a → Nazwa domeny lub subdomeny jaką chcesz skonfigurować np. własny-adres.pl, moj.wlasnyadres.pl (bez WWW). Nazwa domeny może zawierać od 1 do 60 znaków. W przypadku domen z polskimi znakami nazwę należy wpisać ze znakami diakrytycznymi.
  • $b → Konto FTP do którego będzie przypisana domena. Użytkownik tego konta samodzielnie może zarządzać domenami do niego przypisanymi poprzez własny panel.
  • $c → Hasło dostępowe dla domyślnie zakładanego konta pocztowego postmaster@ w domenie. Konto postmaster jest kontem administracyjnym umożliwiającym zarządzenie innymi kontami oraz usługami w domenie. Umożliwia jednocześnie wysyłanie i odbieranie poczty tak jak każde inne konto.
    Hasło musi zawierać od 6 do 15 znaków oraz zawierać przynajmniej jedną cyfrę lub jeden ze znaków specjalnych: ~ ! @ # % ^ & * ( ) _ \ = \ - ; , . / < > ? : [ ] { }. Wskazane jest użycie min. 2 cyfr i jednej dużej litery.
  • $d → Podkatalog utworzony w katalogu public_html na koncie FTP, w którym zostanie umieszczona strona WWW dla domeny. Jeżeli katalog nie istnieje na serwerze, zostanie automatycznie utworzony.

    Uwaga! W przypadku gdy pliki strony znajdują się bezpośrednio w public_html nie trzeba uzupełniać tego pola. Domyślnie <pusty ciąg znaków>
  • $e → Profil domeny. Wykorzystaj instancję klasy \Kei\Webas\Dedicated\Domain\Profile. Domyślnie: null
  • $f → Przyspieszenie działania strony poprzez rozproszenie treści statycznych (np. obrazki, multimedia, style CSS) w sieci CDN (Content Delivery Network) CloudFlare. Użyj \Kei\Webas\YesNoEnum. Domyślnie \Kei\Webas\YesNoEnum::No
  • $g → W przypadku wywołania przez użytkownika strony bez prefiksu www. w adresie zostanie on automatycznie przekierowany na adres z tym prefiksem. Użyj \Kei\Webas\YesNoEnum. Domyślnie \Kei\Webas\YesNoEnum::No

*execute()
return Add

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

// 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\Dedicated\Domain\Profile::load("abc");
$webas->Domain()->Add("jakas-nowa3.example.pl", 'addedmany1', "8k55HFBz6A", "", $profile)->execute();

Klasa Add · NiceAPI dla PHP 5.6