• Home
• Toplan
• PhpSms
• Sms

PHP Class Toplan\PhpSms\Sms

Show file Open project: toplan/phpsms Class Usage Examples

Protected Properties

Property	Type	Description
$_status_before_enqueue_	array	Status container, store some configuration information before serialize current instance(before enqueue).
$agents	array	The instances of Agent.
$agentsConfig	array	The configuration information of agents.
$availableHooks	array	The available hooks for balancing task.
$enableQueue	boolean	Whether to use the queue.
$firstAgent	string | null	The name of first agent.
$howToUseQueue	Closure	How to use the queue.
$pushedToQueue	boolean	Whether the current instance has already pushed to the queue system.
$scheme	array	example: [ 'Agent1' => '10 backup', 'Agent2' => '20 backup', ]
$serializer	SuperClosure\Serializer	An instance of class [SuperClosure\Serializer] for serialize closure objects.
$smsData	array	The data container of SMS/voice verify.

Public Methods

Method	Description
__call ( string $name, array $args )	Overload method.
__callStatic ( string $name, array $args )	Overload static method.
__construct ( boolean $autoBoot = true )	Constructor
__sleep ( ) : array	Serialize magic method.
__wakeup ( )	Deserialize magic method.
agent ( string $name )	Set the first agent by name.
bootstrap ( )	Boot balancing task for send SMS/voice verify.
cleanConfig ( )	Tear down all the configuration information of agent.
cleanScheme ( )	Tear down agent use scheme and prepare to create and start a new balancing task, so before do it must destroy old task instance.
config ( mixed $name = null, mixed $config = null, boolean $override = false ) : array	Set or get configuration information by agent name.
content ( string $content )	Set the content for content SMS.
data ( array $data )	Set the template data for template SMS.
getAgent ( string $name ) : mixed	Get a sms agent instance by agent name, if null, will try to create a new agent instance.
getData ( null | string $name = null ) : mixed	Get all the data of SMS/voice verify.
getTask ( ) : Toplan\TaskBalance\Task	Get or generate a balancing task instance for send SMS/voice verify.
hasAgent ( string $name ) : boolean	Whether to has specified agent.
make ( mixed $agentName = null, mixed $tempId = null ) : Sms	Create a sms instance send SMS, your can also set SMS templates or content at the same time.
push ( ) : mixed	Push to the queue by a custom method.
queue ( mixed $enable = null, mixed $handler = null ) : boolean	Set whether to use the queue system, and define how to use it.
scheme ( mixed $name = null, mixed $scheme = null ) : mixed	Set or get the dispatch scheme of agent by name.
send ( boolean $immediately = false ) : mixed	Start send SMS/voice verify.
template ( mixed $name, mixed $tempId = null )	Set the template id for template SMS.
to ( string $mobile )	Set the recipient`s mobile number.
voice ( integer | string | null $code = null ) : Sms	Create a sms instance send voice verify, your can also set verify code at the same time.

Protected Methods

Method	Description
configuration ( )	Configuration.
getSerializer ( ) : SuperClosure\Serializer	Get a closure serializer.
initAgentsConfig ( array $agents, array &$config )	Try to initialize the specified agents` configuration information.
initScheme ( array &$config )	Try to read the dispatch scheme of agent from config file.
initTask ( )	Initialize the task.
modifyConfig ( string $key, array $value )	Modify the configuration information of agent by name.
modifyScheme ( $key, $value )	Modify the dispatch scheme of agent by name.
parseScheme ( array $options ) : array	Parsing the dispatch scheme.
reinstallHandlers ( array $handlers )	Reinstall hooks` handlers for balancing task.
serializeHandlers ( ) : array	Serialize the hooks` handlers of balancing task
serializeOrDeserializeClosureAndReplace ( array &$options, integer | string $key )	Serialize/deserialize the specified closure and replace the origin value.
serializeOrDeserializeScheme ( array $scheme ) : array	Serialize or deserialize the agent use scheme.
taskInitialized ( ) : boolean	Whether task initialized.
validateAgentName ( string $name )	Validate the agent name.
validateConfig ( )	validate configuration.

Method Details

Property Details