Klasa Edit

namespace Kei\Webas\Dedicated\Domain

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

Klasa dziedziczy bezpośrednio z obiektu AbstractActionResult.


Dostępne metody klasy

__construct($a)

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

setFtpAccountName($a)
return Edit

$a → Podaj nazwę konta FTP właściciela domeny

getFtpAccountName()
return string

Zwraca nazwę konta FTP właściciela domeny

setEmailPassword($a)
return Edit

$a → 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.

getEmailPassword()
return string

Zwraca ustawione hasło administratora poczty. UWAGA! tylko gdy zostało ustawione/zmienione w klasie.

setDirectory($a)
return Edit

$a → 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.

getDirectory()
return string

Zwraca podkatalog utworzony w katalogu public_html na koncie FTP

setCdnDelivery($a)
return Edit

$a → Ustawia obsługę przez sieć CDN CloudFlare. Użyj wartości enumeratora YesNoEnum

getCdnDelivery()
return int

Obsługa przez sieć CDN CloudFlare

setForceWww($a)
return Edit

$a → Wymuś przekierowanie na SSL (https://). Użyj wartości enumeratora YesNoEnum

getForceWww()
return int

Przekierowanie na SSL (https://)

setWwwBlocked($a)
return Edit

$a → Blokada wyświetlania strony 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. Użyj wartości enumeratora YesNoEnum

getWwwBlocked()
return int

Blokada wyświetlania strony WWW

setMailBlocked($a)
return Edit

$a → Blokada odbierania i wysyłania poczty przez serwer pocztowy wiadomości z kont e-mail w domenie.

Uwaga! Właściciele kont e-mail w ramach domeny dalej będą mogli się połączyć ze swoją skrzynką za pomocą POP3, IMAP w celu czytania poczty już tam zgromadzonej. Użyj wartości enumeratora YesNoEnum

getMailBlocked()
return int

Blokada odbierania i wysyłania poczty przez serwer pocztowy wiadomości z kont e-mail w domenie.

setProfile($a)
return Edit

$a → Ustawia aktywny profil. Użyj obiektu \Kei\Webas\Dedicated\Domain\Profile

getProfile()
return int

Pobiera aktualnie ustawiony profil domeny.

*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 domeny wraz z rekonfiguracją ustawień
$webas->Domain()->
    Edit('jakas-nowa.example.pl')->
        setForceWww(\Kei\Webas\Dedicated\YesNoEnum::Yes)->
        setMailBlocked(\Kei\Webas\Dedicated\YesNoEnum::Yes)->
    execute();

Klasa Edit · NiceAPI dla PHP 5.6