Manager
Table of Contents
Methods
- canUse() : bool
- createMessage() : Message
- getDefaultProvider() : Base
- Get default SMS provider.
- getManageUrl() : string
- getProviderById() : Base|null
- getProviderInfoList() : array<string|int, mixed>
- getProviders() : array<string|int, Base>
- getProviderSelectList() : array<string|int, mixed>
- getUsableProvider() : Base|null
- Get first Provider which is ready to use it.
- sendMessage() : SendMessageResult
Methods
canUse()
public
static canUse() : bool
Return values
bool —Can use SMS transport.
createMessage()
public
static createMessage(array<string|int, mixed> $messageFields[, Base|null $provider = null ]) : Message
Parameters
- $messageFields : array<string|int, mixed>
- $provider : Base|null = null
Return values
MessagegetDefaultProvider()
Get default SMS provider.
public
static getDefaultProvider() : Base
Return values
BasegetManageUrl()
public
static getManageUrl() : string
Return values
string —Manage url
getProviderById()
public
static getProviderById(mixed $id) : Base|null
Parameters
- $id : mixed
Return values
Base|null —Provider instance.
getProviderInfoList()
public
static getProviderInfoList() : array<string|int, mixed>
Return values
array<string|int, mixed> —Provider information.
getProviders()
public
static getProviders() : array<string|int, Base>
Return values
array<string|int, Base> —List of providers.
getProviderSelectList()
public
static getProviderSelectList() : array<string|int, mixed>
Return values
array<string|int, mixed> —Simple list of providers, array(provider_id => provider_name)
getUsableProvider()
Get first Provider which is ready to use it.
public
static getUsableProvider() : Base|null
Return values
Base|null —Provider instance.
sendMessage()
public
static sendMessage(array<string|int, mixed> $messageFields[, Base|null $provider = null ]) : SendMessageResult
Parameters
- $messageFields : array<string|int, mixed>
- $provider : Base|null = null