Klasa SettingsTools

namespace Kei\Webas\Dedicated

Klasa oferująca konfigurację adresacji podstawowych narzędzi panelu WebAs.
Funkcjonalne odwzorowanie panelu na stronie https://webas12345.tld.pl/SettingsTools.


Charakterystyka

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

Edit Edycja ustawień zakładki narzędzia panelu WebAs

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

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



Wyjątki

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

  • \Kei\Webas\Dedicated\SettingsTools\Exception\ResourceNotFoundException
  • \Kei\Webas\Dedicated\SettingsTools\Exception\ServiceFoundException
  • \Kei\Webas\Dedicated\SettingsTools\Exception\ResultException
  • \Kei\Webas\Dedicated\SettingsTools\Exception\ValidationException
  • \Kei\Webas\Dedicated\SettingsTools\Exception\WrongTypeException

oraz wyjątki standardowe dla wszystkich obiektów położonych wyżej w hierarchii:

  • \Kei\Webas\Dedicated\Exception\DefaultPaginatorActionException
  • \Kei\Webas\Dedicated\Exception\InfoTableColumnCountException
  • \Kei\Webas\Dedicated\Exception\InitialCookieNotFoundException
  • \Kei\Webas\Dedicated\Exception\ServiceNumberFormatException
  • \Kei\Webas\Dedicated\Exception\UncountableResultsException
  • \Kei\Webas\Dedicated\Exception\WebasAuthenticationException
  • \Kei\Webas\Dedicated\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...

// Utworzenie instancji klasy Edit
$handle = $webas->SettingsTools()->Edit();

// Pobranie domyślnie ustawionych/zapisanych wartości...
$bapv = $handle->getBasicAddressingParametersValue();

// ...i ich zmiana na nowe...
$bapv->setDomainMode(\Kei\Webas\Dedicated\SettingsTools\DomainMode::Factory()->
    setAllPanelsInDifferentDomains(\Kei\Webas\Dedicated\SettingsTools\DifferentPanelDomains::Factory()->
        setStatDomain("qp.pl")->
        setWebmailCustomDomain("qwert.com")));


// ... podobnie tutaj. Pobranie domyślnych wartości sekcji "Dostępne narzędzia i panele"...
$tap = $handle->getToolsAndPanelsValue();

// ...i zmiana ich wartości
$tap->setWebmailCustom("pocztex");

// Wprowadzenie i zapisanie zmian
$handle->
    setToolsAndPanelsValue($tap)->
    setBasicAddressingParametersValue($bapv)->
execute();

Klasa SettingsTools · NiceAPI dla PHP 5.6