\SMSServiceApi
Class SMSServiceApi to be inherited by real SMS services APIs implementations located in 'api/vendor/sms_service_APIs' to provide re-usability and common interaction interface for SendDogAdvanced class
Synopsis
class SMSServiceApi
{
- // members
- protected $instanceSendDog = NULL;
- protected array $apiSettingsRaw = ;
- protected integer $serviceId = 0;
- protected string $serviceLogin = '';
- protected string $servicePassword = '';
- protected string $serviceGatewayAddr = '';
- protected string $serviceAlphaName = '';
- protected string $serviceApiKey = '';
- protected bool $isDefaultService = false;
- protected array $smsMessagePack = ;
- protected $ubConfig = NULL;
- // methods
- public void __construct()
- protected void getSettings()
- protected void showErrorFeatureIsNotSupported()
- public abstract void getBalance()
- public abstract void getSMSQueue()
- public abstract void pushMessages()
- public abstract void checkMessagesStatuses()
Members
protected
- $apiSettingsRaw
—
array
Placeholder for settings record data from sms_services table - $instanceSendDog
—
null
SendDogAdvanced instance plceholder - $isDefaultService
—
bool
Assigned as a default SMS service - $serviceAlphaName
—
string
SMS service alpha name - $serviceApiKey
—
string
SMS service API key - $serviceGatewayAddr
—
string
SMS service base URL/IP - $serviceId
—
int
SMS service ID in sms_services table - $serviceLogin
—
string
SMS service login - $servicePassword
—
string
SMS service password - $smsMessagePack
—
array
Messages to be processed by push method - $ubConfig
—
null
Placeholder for UbillingConfig object
Methods
protected
- getSettings() — Fills up the config placeholders for a particular SMS service
- showErrorFeatureIsNotSupported() — Returns styled error message about not supported features