Klasa NotificationSettings

namespace Kei\Webas\Dedicated\EmailAccount

Klasa dzięki, której skonfigurujesz powiadamianie poprzez SMS.

Klasa implementuje interfejs DumperInterface


Charakterystyka

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

__construct($a, $b)
return NotificationSettings

Konstruktor dzięki, któremu utworzysz obiekt z domyślną konfiguracją ustawień wysyłki powiadomień poprzez SMS - adekwatnie do domyślnych ustawień panelu Webas.
$a → Sposób w jaki automat będzie się komunikował z bramką SMS. Użyj enumeratora SmsOperatorSendToEnum. Domyślnie: SmsOperatorSendToEnum::OperatorsGateway
$b → Wybór treści jakie mają trafiać do powiadomienia SMS oraz ich liczba. Użyj enumeratora SmsNotificationPatternEnum. Domyślnie: SmsNotificationPatternEnum::Sms1OnlyMailTitle

::Factory($a, $b)
return NotificationSettings

Statyczna metoda zwracająca instancję klasy. Wzorzec projektowy Fabryka.


$a → Sposób w jaki automat będzie się komunikował z bramką SMS. Użyj enumeratora SmsOperatorSendToEnum. Domyślnie: SmsOperatorSendToEnum::OperatorsGateway
$b → Wybór treści jakie mają trafiać do powiadomienia SMS oraz ich liczba. Użyj enumeratora SmsNotificationPatternEnum. Domyślnie: SmsNotificationPatternEnum::Sms1OnlyMailTitle
setSmsCnt($a)
return $this

$a → Wybór treści jakie mają trafiać do powiadomienia SMS oraz ich liczba. Użyj enumeratora SmsNotificationPatternEnum.

getSmsCnt()
return int

Zwraca treści jakie mają trafiać do powiadomienia SMS oraz ich liczba.

setSmsSendTo($a)
return $this

$a → Sposób w jaki automat będzie się komunikował z bramką SMS. Użyj enumeratora SmsOperatorSendToEnum.

getSmsSendTo()
return int

Zwraca sposób komunikacji z bramką SMS.

*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 NotificationSettings z wykorzystaniem konstruktora
$ns = new \Kei\Webas\Dedicated\EmailAccount\NotificationSettings();
$ns->setSmsSendTo(\Kei\Webas\SmsOperatorSendToEnum::OperatorsEmailAccount);
\Kei\Library\Out::pd($ns);

// Utworzenie nowej instancji klasy NotificationSettings z wykorzystaniem statycznej metody Factory
$ns = \Kei\Webas\Dedicated\EmailAccount\NotificationSettings::Factory()->
    setSmsSendTo(\Kei\Webas\SmsOperatorSendToEnum::OperatorsEmailAccount);
\Kei\Library\Out::pd($ns);

Klasa NotificationSettings · NiceAPI dla PHP 5.6