Documentation

SMSNotifier_Basic_Provider
in package

Basic class to sms provider.

Table of Contents

$messageName  : string
Variable name.
$toName  : string
Variable name.
$name  : string
Provider name.
$url  : string
Address URL.
get()  : mixed
Get.
getAuthorization()  : string
Authorization.
getHeaders()  : array<string|int, string>
Headers.
getName()  : string
Function to get provider name.
getPath()  : string
Function to get full path.
getRequiredParams()  : array<string|int, string>
Required fields.
getResponse()  : mixed
Response.
getSettingsEditFieldsModel()  : array<string|int, Settings_Vtiger_Field_Model>
Fields to edit in settings.
getUrl()  : string
Function to get service URL.
has()  : bool
Function to check if the key exists.
send()  : mixed
Function to handle SMS Send operation.
set()  : self
Set.

Properties

$messageName

Variable name.

public string $messageName = 'message'

$toName

Variable name.

public string $toName = 'to'

$name

Provider name.

protected string $name

$url

Address URL.

protected string $url

Methods

get()

Get.

public get(string $key) : mixed
Parameters
$key : string
Return values
mixed

getAuthorization()

Authorization.

public getAuthorization() : string
Return values
string

getHeaders()

Headers.

public getHeaders() : array<string|int, string>
Return values
array<string|int, string>

getName()

Function to get provider name.

public getName() : string
Return values
string

provider name

getPath()

Function to get full path.

public getPath() : string
Return values
string

getRequiredParams()

Required fields.

public getRequiredParams() : array<string|int, string>
Return values
array<string|int, string>

getResponse()

Response.

public abstract getResponse(Response $request) : mixed
Parameters
$request : Response
Return values
mixed

getUrl()

Function to get service URL.

public getUrl() : string
Return values
string

has()

Function to check if the key exists.

public has(string $key) : bool
Parameters
$key : string
Return values
bool

send()

Function to handle SMS Send operation.

public send() : mixed
Return values
mixed

set()

Set.

public set(string $key, mixed $value) : self
Parameters
$key : string
$value : mixed
Return values
self

Search results