Pluf API Documentation
\
Pluf
Backup
Views
Bank
Cache
HTTP
Response
Middleware
Captcha
Engine
Middleware
CMS
Discount
HTTP
Download2
Header2
HTTP2
Jms
Views
LoggerAppender
LoggerFormatter
Mall
Marketplace
Middleware
Monitor
Pluf
Sdp
Seo
Middleware
Shop
SuperJms
Views
SuperTenant
SuperTms
Tenant
Test
Tms
Todo
User
Workflow

\Verifier_Engine_SmsIr

Defines a general verifier engine. Different verifier engines should impelement this class.

Summary

Methods
Properties
Constants
getType()
getSymbol()
getTitle()
getDescription()
send()
jsonSerialize()
getParameters()
getGeneralParam()
getExtraParam()
No public properties found
ENGINE_PREFIX
ENGINE_PARAMETER_API_KEY
ENGINE_PARAMETER_SECRET_KEY
ENGINE_PARAMETER_TEMPLATE_ID
No protected methods found
No protected properties found
N/A
getMobile()
getToken()
sendSms()
No private properties found
N/A

Constants

ENGINE_PREFIX

ENGINE_PREFIX = 'verifier_engine_'

ENGINE_PARAMETER_API_KEY

ENGINE_PARAMETER_API_KEY = 'verifier.engine.SmsIr.ApiKey'

ENGINE_PARAMETER_SECRET_KEY

ENGINE_PARAMETER_SECRET_KEY = 'verifier.engine.SmsIr.SecretKey'

ENGINE_PARAMETER_TEMPLATE_ID

ENGINE_PARAMETER_TEMPLATE_ID = 'verifier.engine.SmsIr.TemplateId'

Methods

getType()

getType() : string

Returns

string

getSymbol()

getSymbol() : string

Returns

string

getTitle()

getTitle() : string

Returns

string

getDescription()

getDescription() : string

Returns

string

send()

send(\User_Verification  $verification) : boolean

Sends verification to its related account.

This function should be overrided by implementors.

Parameters

\User_Verification $verification

Returns

boolean —

true if sending verification is successful else false.

jsonSerialize()

jsonSerialize()

(non-PHPdoc)

getParameters()

getParameters()

Returns an array of parameters of the verifier engine

Each verifier engine needs some parameters which should be provided by the creator. This function returns these parameters as an array.

The returned value of this function is a list of property descriptors.

getGeneralParam()

getGeneralParam() :

Returns a list of the general parameters.

Returns

getExtraParam()

getExtraParam() : array

Returns a list of the extra parameters.

This functions should be overrided by implementors which have some other parameters other than general parameters.

Returns

array

getMobile()

getMobile(  $verification)

Parameters

$verification

getToken()

getToken()

sendSms()

sendSms(  $verification,   $mobile,   $token)

Parameters

$verification
$mobile
$token