Sms::parseAgentArrayOptions() - Code Metrics - Inspection of "update" - toplan/phpsms - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Pull Request — master (#17)

by lan tian

created 2015-12-30 05:38 UTC

Sms::parseAgentArrayOptions() A

↳ Parent: Sms

Complexity

Conditions	1
Paths	1

Size

Total Lines	10
Code Lines	7

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	0
CRAP Score	2

Importance

Changes	3
Bugs	0	Features	0

Metric	Value
c	3
b	0
f	0
dl	0
loc	10
ccs	0
cts	7
cp	0
rs	9.4286
cc	1
eloc	7
nc	1
nop	1
crap	2

<?php

namespace Toplan\PhpSms;

use Toplan\TaskBalance\Balancer;

/**
 * Class Sms
 */
class Sms
{
    /**
     * sms send task name
     */
    const TASK = 'PhpSms';

    /**
     * agents instance
     */
    protected static $agents;

    /**
     * agents`s name
     *
     * @var
     */
    protected static $agentsName = [];

    /**
     * agents`s config
     *
     * @var
     */
    protected static $agentsConfig = [];

    /**
     * whether to enable queue
     *
     * @var bool
     */
    protected static $enableQueue = false;

    /**
     * queue work
     *
     * @var null
     */
    protected static $howToUseQueue = null;

    /**
     * sms already pushed to queue
     *
     * @var bool
     */
    protected $pushedToQueue = false;

    /**
     * hook handlers
     *
     * @var array
     */
    protected static $enableHooks = [
        'beforeRun',
        'beforeDriverRun',
        'afterDriverRun',
        'afterRun',
    ];

    /**
     * sms data
     *
     * @var array
     */
    protected $smsData = [
        'to'           => null,
        'templates'    => [],
        'content'      => '',
        'templateData' => [],
        'voiceCode'    => null,
    ];

    /**
     * first agent for send sms/voice verify
     *
     * @var string
     */
    protected $firstAgent = null;

    /**
     * construct
     *
     * @param bool $autoBoot
     */
    public function __construct($autoBoot = true)
    {
        if ($autoBoot) {
            self::bootstrap();
        }
    }

    /**
     * create sms instance and set templates
     *
     * @param null $agentName
     * @param null $tempId
     *
     * @return Sms
     */
    public static function make($agentName = null, $tempId = null)
    {
        $sms = new self();
        if (is_array($agentName)) {
            $sms->template($agentName);
        } elseif ($agentName && is_string($agentName)) {
            if ($tempId === null) {
                $sms->content($agentName);
            } elseif (is_string("$tempId")) {
                $sms->template($agentName, $tempId);
            }
        }

        return $sms;
    }

    /**
     * send voice verify
     *
     * @param $code
     *
     * @return Sms
     */
    public static function voice($code)
    {
        $sms = new self();
        $sms->smsData['voiceCode'] = $code;

        return $sms;
    }

    /**
     * set how to use queue.
     *
     * @param $enable
     * @param $handler
     *
     * @return bool
     */
    public static function queue($enable = null, $handler = null)
    {
        if ($enable === null && $handler === null) {
            return self::$enableQueue;
        }
        if (is_callable($enable)) {
            $handler = $enable;
            $enable = true;
        }
        self::$enableQueue = (bool) $enable;
        if (is_callable($handler)) {
            self::$howToUseQueue = $handler;

        }

        return self::$enableQueue;
    }

    /**
     * set the mobile number
     *
     * @param $mobile
     *
     * @return $this
     */
    public function to($mobile)
    {
        $this->smsData['to'] = $mobile;

        return $this;
    }

    /**
     * set content for content sms
     *
     * @param $content
     *
     * @return $this
     */
    public function content($content)
    {
        $this->smsData['content'] = trim((String) $content);

        return $this;
    }

    /**
     * set template id for template sms
     *
     * @param $agentName
     * @param $tempId
     *
     * @return $this
     */
    public function template($agentName, $tempId = null)
    {
        if (is_array($agentName)) {
            foreach ($agentName as $k => $v) {
                $this->template($k, $v);
            }
        } elseif ($agentName && $tempId) {
            if (!isset($this->smsData['templates']) || !is_array($this->smsData['templates'])) {
                $this->smsData['templates'] = [];
            }
            $this->smsData['templates']["$agentName"] = $tempId;
        }

        return $this;
    }

    /**
     * set data for template sms
     *
     * @param array $data
     *
     * @return $this
     */
    public function data(array $data)
    {
        $this->smsData['templateData'] = $data;

        return $this;
    }

    /**
     * set the first agent
     *
     * @param $name
     *
     * @return $this
     */
    public function agent($name)
    {
        $this->firstAgent = (String) $name;

        return $this;
    }

    /**
     * start send
     *
     * @param bool $immediately
     *
     * @return mixed
     */
    public function send($immediately = false)
    {
        $this->validator();

        // if disable push to queue,
        // send the sms immediately.
        if (!self::$enableQueue) {
            $immediately = true;
        }

        // whatever 'PhpSms' whether to enable or disable push to queue,
        // if you are already pushed sms instance to queue,
        // you can recall the method `send()` in queue job without `true` parameter.
        //
        // So this mechanism in order to make you convenient use the method `send()` in queue system.
        if ($this->pushedToQueue) {
            $immediately = true;
        }

        // whether to send sms immediately,
        // or push it to queue.
        if ($immediately) {
            $result = Balancer::run(self::TASK, $this->getData(), $this->firstAgent);
function acceptsInteger($int) { }

$x = '123'; // string "123"

// Instead of
acceptsInteger($x);

// we recommend to use
acceptsInteger((integer) $x);
        } else {
            $result = $this->push();
        }

        return $result;
    }

    /**
     * push sms send task to queue
     *
     * @throws \Exception | PhpSmsException
     *
     * @return mixed
     */
    protected function push()
    {
        if (is_callable(self::$howToUseQueue)) {
            try {
                $this->pushedToQueue = true;

                return call_user_func_array(self::$howToUseQueue, [$this, $this->smsData]);
            } catch (\Exception $e) {
                $this->pushedToQueue = false;
                throw $e;
            }
        } else {
            throw new PhpSmsException('Please define how to use queue by method `queue($enable, $handler)`');
        }
    }

    /**
     * get sms data
     *
     * @return array
     */
    public function getData()
    {
        return $this->smsData;
    }

    /**
     * bootstrap
     */
    public static function bootstrap()
    {
        $task = self::generatorTask();
        if (!count($task->drivers)) {
            self::configuration();
            self::createDrivers($task);
        }
    }

    /**
     * generator a sms send task
     *
     * @return object
     */
    public static function generatorTask()
    {
        if (!Balancer::hasTask(self::TASK)) {
            Balancer::task(self::TASK, null);
        }

        return Balancer::getTask(self::TASK);
    }

    /**
     * configuration
     */
    protected static function configuration()
    {
        $config = [];
        self::generatorAgentsName($config);
        self::generatorAgentsConfig($config);
        self::configValidator();
    }

    /**
     * generate enabled agents name
     *
     * @param array $config
     */
    protected static function generatorAgentsName(&$config)
    {
        if (empty(self::$agentsName)) {
            $config = $config ?: include __DIR__ . '/../config/phpsms.php';
            $enableAgents = isset($config['enable']) ? $config['enable'] : null;
            self::enable($enableAgents);
        }
    }

    /**
     * generator agents config
     *
     * @param array $config
     */
    protected static function generatorAgentsConfig(&$config)
    {
        $diff = array_diff_key(self::$agentsName, self::$agentsConfig);
        $diff = array_keys($diff);
        if (count($diff)) {
            $config = $config ?: include __DIR__ . '/../config/phpsms.php';
            $agentsConfig = isset($config['agents']) ? $config['agents'] : [];
            foreach ($diff as $name) {
                $agentConfig = isset($agentsConfig[$name]) ? $agentsConfig[$name] : [];
                self::agents($name, $agentConfig);
            }
        }
    }

    /**
     * config value validator
     *
     * @throws PhpSmsException
     */
    protected static function configValidator()
    {
        if (!count(self::$agentsName)) {
            throw new PhpSmsException('Please set at least one enable agent in config file(config/phpsms.php) or use method enable()');
        }
    }

    /**
     * create drivers for sms send task
     *
     * @param $task
     */
    protected static function createDrivers($task)
    {
        foreach (self::$agentsName as $name => $options) {
            //获取代理器配置
            $configData = self::getAgentConfigData($name);
            //解析代理器数组模式的调度配置
            if (is_array($options)) {
                $data = self::parseAgentArrayOptions($options);
                $configData = array_merge($configData, $data);
                $options = $data['driverOpts'];
            }
            //创建任务驱动器
            $task->driver("$name $options")->data($configData)
                 ->work(function ($driver) {
                     $configData = $driver->getDriverData();
                     $agent = self::getSmsAgent($driver->name, $configData);
                     $smsData = $driver->getTaskData();
                     extract($smsData);
                     if (isset($smsData['voiceCode']) && $smsData['voiceCode']) {
                         $agent->voiceVerify($to, $voiceCode);
                     } else {
                         $template = isset($templates[$driver->name]) ? $templates[$driver->name] : 0;
                         $agent->sendSms($template, $to, $templateData, $content);
                     }
                     $result = $agent->getResult();
                     if ($result['success']) {
                         $driver->success();
                     }
                     unset($result['success']);

                     return $result;
                 });
        }
    }

    /**
     * 解析可用代理器的数组模式的调度配置
     *
     * @param array $options
     *
     * @return array
     */
    protected static function parseAgentArrayOptions(array $options)
    {
        $agentClass = self::pullAgentOptionByName($options, 'agentClass');
        $sendSms = self::pullAgentOptionByName($options, 'sendSms');
        $voiceVerify = self::pullAgentOptionByName($options, 'voiceVerify');
        $backup = self::pullAgentOptionByName($options, 'backup');
        $driverOpts = implode(' ', array_values($options)) . " $backup";

        return compact('agentClass', 'sendSms', 'voiceVerify', 'driverOpts');
    }

    /**
     * 从调度配置中拉取指定数据
     *
     * @param array  $options
     * @param string $name
     *
     * @return null|string
     */
    protected static function pullAgentOptionByName(array &$options, $name)
    {
        $value = isset($options[$name]) ? $options[$name] : null;
        if ($name === 'backup') {
            $value = isset($options[$name]) ? ($options[$name] ? 'backup' : '') : '';
        }
        unset($options[$name]);

        return $value;
    }

    /**
     * get agent config data by name
     *
     * @param $name
     *
     * @return array
     */
    protected static function getAgentConfigData($name)
    {
        return isset(self::$agentsConfig[$name]) ?
               (Array) self::$agentsConfig[$name] : [];
    }

    /**
     * get a sms agent instance,
     * if null, will create a new agent instance
     *
     * @param       $name
     * @param array $configData
     *
     * @throws PhpSmsException
     *
     * @return mixed
     */
    public static function getSmsAgent($name, array $configData)
    {
        if (!isset(self::$agents[$name])) {
            $configData['name'] = $name;
            $className = isset($configData['agentClass']) ? $configData['agentClass'] : ('Toplan\\PhpSms\\' . $name . 'Agent');
            if ((isset($configData['sendSms']) && is_callable($configData['sendSms'])) ||
                (isset($configData['voiceVerify']) && is_callable($configData['voiceVerify']))) {
                //将临时代理器寄生到LogAgent
                self::$agents[$name] = new LogAgent($configData);
            } elseif (class_exists($className)) {
                //创建新代理器
                self::$agents[$name] = new $className($configData);
            } else {
                //无代理器可用
                throw new PhpSmsException("Agent [$name] not support. If you are want to use parasitic agent, please set callable arguments: [sendSms] and [voiceVerify]");
            }
        }

        return self::$agents[$name];
    }

    /**
     * validate
     *
     * @throws PhpSmsException
     */
    protected function validator()
    {
        if (!$this->smsData['to']) {
            throw new PhpSmsException('Please set send sms(or voice verify) to who use `to()` method.');
        }

        return true;
    }

    /**
     * set enable agents
     *
     * @param      $agentName
     * @param null $options
     */
    public static function enable($agentName, $options = null)
    {
        if (is_array($agentName)) {
            foreach ($agentName as $name => $opt) {
                self::enable($name, $opt);
            }
        } elseif ($agentName && is_string($agentName) && $options !== null) {
            self::$agentsName["$agentName"] = is_array($options) ? $options : "$options";
        } elseif (is_int($agentName) && !is_array($options) && "$options") {
            self::$agentsName["$options"] = '1';
        } elseif ($agentName && $options === null) {
            self::$agentsName["$agentName"] = '1';
        }
    }

    /**
     * set config for available agents
     *
     * @param       $agentName
     * @param array $config
     *
     * @throws PhpSmsException
     */
    public static function agents($agentName, array $config = [])
    {
        if (is_array($agentName)) {
            foreach ($agentName as $name => $conf) {
                self::agents($name, $conf);
            }
        } elseif ($agentName && is_array($config)) {
            if (preg_match('/^[0-9]+$/', $agentName)) {
                throw new PhpSmsException("Agent name [$agentName] must be string, could not be a pure digital");
            }
            self::$agentsConfig["$agentName"] = $config;
        }
    }

    /**
     * get enable agents
     *
     * @return array
     */
    public static function getEnableAgents()
    {
        return self::$agentsName;
    }

    /**
     * get agents config info
     *
     * @return array
     */
    public static function getAgentsConfig()
    {
        return self::$agentsConfig;
    }

    /**
     * tear down enable agents
     */
    public static function cleanEnableAgents()
    {
        self::$agentsName = [];
    }

    /**
     * tear down agents config
     */
    public static function cleanAgentsConfig()
    {
        self::$agentsConfig = [];
    }

    /**
     * overload static method
     *
     * @param $name
     * @param $args
     *
     * @throws PhpSmsException
     */
    public static function __callStatic($name, $args)
    {
        $name = $name === 'beforeSend' ? 'beforeRun' : $name;
        $name = $name === 'afterSend' ? 'afterRun' : $name;
        $name = $name === 'beforeAgentSend' ? 'beforeDriverRun' : $name;
        $name = $name === 'afterAgentSend' ? 'afterDriverRun' : $name;
        if (in_array($name, self::$enableHooks)) {
            $handler = $args[0];
            $override = isset($args[1]) ? (bool) $args[1] : false;
            if (is_callable($handler)) {
                $task = self::generatorTask();
                $task->hook($name, $handler, $override);
            } else {
                throw new PhpSmsException("Please give method static $name() a callable parameter");
            }
        } else {
            throw new PhpSmsException("Do not find static method $name()");
        }
    }

    /**
     * overload method
     *
     * @param $name
     * @param $args
     *
     * @throws PhpSmsException
     * @throws \Exception
     */
    public function __call($name, $args)
    {
        try {
            $this->__callStatic($name, $args);
        } catch (\Exception $e) {
            throw $e;
        }
    }
}


1		<?php
2
3		namespace Toplan\PhpSms;
4
5		use Toplan\TaskBalance\Balancer;
6
7		/**
8		* Class Sms
9		*/
10		class Sms
11		{
12		/**
13		* sms send task name
14		*/
15		const TASK = 'PhpSms';
16
17		/**
18		* agents instance
19		*/
20		protected static $agents;
21
22		/**
23		* agents`s name
24		*
25		* @var
26		*/
27		protected static $agentsName = [];
28
29		/**
30		* agents`s config
31		*
32		* @var
33		*/
34		protected static $agentsConfig = [];
35
36		/**
37		* whether to enable queue
38		*
39		* @var bool
40		*/
41		protected static $enableQueue = false;
42
43		/**
44		* queue work
45		*
46		* @var null
47		*/
48		protected static $howToUseQueue = null;
49
50		/**
51		* sms already pushed to queue
52		*
53		* @var bool
54		*/
55		protected $pushedToQueue = false;
56
57		/**
58		* hook handlers
59		*
60		* @var array
61		*/
62		protected static $enableHooks = [
63		'beforeRun',
64		'beforeDriverRun',
65		'afterDriverRun',
66		'afterRun',
67		];
68
69		/**
70		* sms data
71		*
72		* @var array
73		*/
74		protected $smsData = [
75		'to' => null,
76		'templates' => [],
77		'content' => '',
78		'templateData' => [],
79		'voiceCode' => null,
80		];
81
82		/**
83		* first agent for send sms/voice verify
84		*
85		* @var string
86		*/
87		protected $firstAgent = null;
88
89		/**
90		* construct
91		*
92		* @param bool $autoBoot
93		*/
94	9	public function __construct($autoBoot = true)
95		{
96	9	if ($autoBoot) {
97	9	self::bootstrap();
98	9	}
99	9	}
100
101		/**
102		* create sms instance and set templates
103		*
104		* @param null $agentName
105		* @param null $tempId
106		*
107		* @return Sms
108		*/
109	3	public static function make($agentName = null, $tempId = null)
110		{
111	3	$sms = new self();
112	3	if (is_array($agentName)) {
113		$sms->template($agentName);
114	3	} elseif ($agentName && is_string($agentName)) {
115		if ($tempId === null) {
116		$sms->content($agentName);
117		} elseif (is_string("$tempId")) {
118		$sms->template($agentName, $tempId);
119		}
120		}
121
122	3	return $sms;
123		}
124
125		/**
126		* send voice verify
127		*
128		* @param $code
129		*
130		* @return Sms
131		*/
132	3	public static function voice($code)
133		{
134	3	$sms = new self();
135	3	$sms->smsData['voiceCode'] = $code;
136
137	3	return $sms;
138		}
139
140		/**
141		* set how to use queue.
142		*
143		* @param $enable
144		* @param $handler
145		*
146		* @return bool
147		*/
148	3	public static function queue($enable = null, $handler = null)
149		{
150	3	if ($enable === null && $handler === null) {
151	3	return self::$enableQueue;
152		}
153	3	if (is_callable($enable)) {
154	3	$handler = $enable;
155	3	$enable = true;
156	3	}
157	3	self::$enableQueue = (bool) $enable;
158	3	if (is_callable($handler)) {
159	3	self::$howToUseQueue = $handler;
		0 ignored issues – show Documentation Bug introduced 2015-12-14 04:10 UTC by Report Bug Copy Issue Report It seems like `$handler` of type `callable` is incompatible with the declared type `null` of property `$howToUseQueue`. Our type inference engine has found an assignment to a property that is incompatible with the declared type of that property. Either this assignment is in error or the assigned type should be added to the documentation/type hint for that property.. Loading history...
160	3	}
161
162	3	return self::$enableQueue;
163		}
164
165		/**
166		* set the mobile number
167		*
168		* @param $mobile
169		*
170		* @return $this
171		*/
172	6	public function to($mobile)
173		{
174	6	$this->smsData['to'] = $mobile;
175
176	6	return $this;
177		}
178
179		/**
180		* set content for content sms
181		*
182		* @param $content
183		*
184		* @return $this
185		*/
186	3	public function content($content)
187		{
188	3	$this->smsData['content'] = trim((String) $content);
189
190	3	return $this;
191		}
192
193		/**
194		* set template id for template sms
195		*
196		* @param $agentName
197		* @param $tempId
198		*
199		* @return $this
200		*/
201	3	public function template($agentName, $tempId = null)
202		{
203	3	if (is_array($agentName)) {
204	3	foreach ($agentName as $k => $v) {
205	3	$this->template($k, $v);
206	3	}
207	3	} elseif ($agentName && $tempId) {
208	3	if (!isset($this->smsData['templates']) \|\| !is_array($this->smsData['templates'])) {
209		$this->smsData['templates'] = [];
210		}
211	3	$this->smsData['templates']["$agentName"] = $tempId;
212	3	}
213
214	3	return $this;
215		}
216
217		/**
218		* set data for template sms
219		*
220		* @param array $data
221		*
222		* @return $this
223		*/
224	15	public function data(array $data)
225	15	{
226	3	$this->smsData['templateData'] = $data;
227
228	3	return $this;
229		}
230
231		/**
232		* set the first agent
233		*
234		* @param $name
235		*
236		* @return $this
237		*/
238	3	public function agent($name)
239		{
240	3	$this->firstAgent = (String) $name;
241
242	3	return $this;
243		}
244
245		/**
246		* start send
247		*
248		* @param bool $immediately
249		*
250		* @return mixed
251		*/
252	15	public function send($immediately = false)
253		{
254	15	$this->validator();
255
256		// if disable push to queue,
257		// send the sms immediately.
258	15	if (!self::$enableQueue) {
259	12	$immediately = true;
260	12	}
261
262		// whatever 'PhpSms' whether to enable or disable push to queue,
263		// if you are already pushed sms instance to queue,
264		// you can recall the method `send()` in queue job without `true` parameter.
265		//
266		// So this mechanism in order to make you convenient use the method `send()` in queue system.
267	15	if ($this->pushedToQueue) {
268	3	$immediately = true;
269	3	}
270
271		// whether to send sms immediately,
272		// or push it to queue.
273	15	if ($immediately) {
274	15	$result = Balancer::run(self::TASK, $this->getData(), $this->firstAgent);
		0 ignored issues – show Documentation introduced 2015-12-14 04:10 UTC by Report Bug Copy Issue Report `$this->getData()` is of type `array`, but the function expects a `string\|null`. It seems like the type of the argument is not accepted by the function/method which you are calling. In some cases, in particular if PHP’s automatic type-juggling kicks in this might be fine. In other cases, however this might be a bug. We suggest to add an explicit type cast like in the following example: function acceptsInteger($int) { } $x = '123'; // string "123" // Instead of acceptsInteger($x); // we recommend to use acceptsInteger((integer) $x); Loading history...
275	15	} else {
276	3	$result = $this->push();
277		}
278
279	15	return $result;
280		}
281
282		/**
283		* push sms send task to queue
284		*
285		* @throws \Exception \| PhpSmsException
286		*
287		* @return mixed
288		*/
289	3	protected function push()
290		{
291	3	if (is_callable(self::$howToUseQueue)) {
292		try {
293	3	$this->pushedToQueue = true;
294
295	3	return call_user_func_array(self::$howToUseQueue, [$this, $this->smsData]);
296		} catch (\Exception $e) {
297		$this->pushedToQueue = false;
298		throw $e;
299		}
300		} else {
301		throw new PhpSmsException('Please define how to use queue by method `queue($enable, $handler)`');
302		}
303		}
304
305		/**
306		* get sms data
307		*
308		* @return array
309		*/
310	33	public function getData()
311		{
312	33	return $this->smsData;
313		}
314
315		/**
316		* bootstrap
317		*/
318	9	public static function bootstrap()
319		{
320	9	$task = self::generatorTask();
321	9	if (!count($task->drivers)) {
322	3	self::configuration();
323	3	self::createDrivers($task);
324	3	}
325	9	}
326
327		/**
328		* generator a sms send task
329		*
330		* @return object
331		*/
332	18	public static function generatorTask()
333		{
334	18	if (!Balancer::hasTask(self::TASK)) {
335	3	Balancer::task(self::TASK, null);
336	3	}
337
338	18	return Balancer::getTask(self::TASK);
339		}
340
341		/**
342		* configuration
343		*/
344	3	protected static function configuration()
345		{
346	3	$config = [];
347	3	self::generatorAgentsName($config);
348	3	self::generatorAgentsConfig($config);
349	3	self::configValidator();
350	3	}
351
352		/**
353		* generate enabled agents name
354		*
355		* @param array $config
356		*/
357	3	protected static function generatorAgentsName(&$config)
358		{
359	3	if (empty(self::$agentsName)) {
360	3	$config = $config ?: include __DIR__ . '/../config/phpsms.php';
361	3	$enableAgents = isset($config['enable']) ? $config['enable'] : null;
362	3	self::enable($enableAgents);
363	3	}
364	3	}
365
366		/**
367		* generator agents config
368		*
369		* @param array $config
370		*/
371	3	protected static function generatorAgentsConfig(&$config)
372		{
373	3	$diff = array_diff_key(self::$agentsName, self::$agentsConfig);
374	3	$diff = array_keys($diff);
375	3	if (count($diff)) {
376	3	$config = $config ?: include __DIR__ . '/../config/phpsms.php';
377	3	$agentsConfig = isset($config['agents']) ? $config['agents'] : [];
378	3	foreach ($diff as $name) {
379	3	$agentConfig = isset($agentsConfig[$name]) ? $agentsConfig[$name] : [];
380	3	self::agents($name, $agentConfig);
381	3	}
382	3	}
383	3	}
384
385		/**
386		* config value validator
387		*
388		* @throws PhpSmsException
389		*/
390	3	protected static function configValidator()
391		{
392	3	if (!count(self::$agentsName)) {
393		throw new PhpSmsException('Please set at least one enable agent in config file(config/phpsms.php) or use method enable()');
394		}
395	3	}
396
397		/**
398		* create drivers for sms send task
399		*
400		* @param $task
401		*/
402	15	protected static function createDrivers($task)
403		{
404	3	foreach (self::$agentsName as $name => $options) {
405		//获取代理器配置
406	3	$configData = self::getAgentConfigData($name);
407		//解析代理器数组模式的调度配置
408	3	if (is_array($options)) {
409		$data = self::parseAgentArrayOptions($options);
410		$configData = array_merge($configData, $data);
411		$options = $data['driverOpts'];
412		}
413		//创建任务驱动器
414	3	$task->driver("$name $options")->data($configData)
415	15	->work(function ($driver) {
416	15	$configData = $driver->getDriverData();
417	15	$agent = self::getSmsAgent($driver->name, $configData);
418	15	$smsData = $driver->getTaskData();
419	15	extract($smsData);
420	15	if (isset($smsData['voiceCode']) && $smsData['voiceCode']) {
421		$agent->voiceVerify($to, $voiceCode);
422		} else {
423	15	$template = isset($templates[$driver->name]) ? $templates[$driver->name] : 0;
424	15	$agent->sendSms($template, $to, $templateData, $content);
425		}
426	15	$result = $agent->getResult();
427	15	if ($result['success']) {
428	15	$driver->success();
429	15	}
430	15	unset($result['success']);
431
432	15	return $result;
433	3	});
434	3	}
435	3	}
436
437		/**
438		* 解析可用代理器的数组模式的调度配置
439		*
440		* @param array $options
441		*
442		* @return array
443		*/
444		protected static function parseAgentArrayOptions(array $options)
445		{
446		$agentClass = self::pullAgentOptionByName($options, 'agentClass');
447		$sendSms = self::pullAgentOptionByName($options, 'sendSms');
448		$voiceVerify = self::pullAgentOptionByName($options, 'voiceVerify');
449		$backup = self::pullAgentOptionByName($options, 'backup');
450		$driverOpts = implode(' ', array_values($options)) . " $backup";
451
452		return compact('agentClass', 'sendSms', 'voiceVerify', 'driverOpts');
453		}
454
455		/**
456		* 从调度配置中拉取指定数据
457		*
458		* @param array $options
459		* @param string $name
460		*
461		* @return null\|string
462		*/
463		protected static function pullAgentOptionByName(array &$options, $name)
464		{
465		$value = isset($options[$name]) ? $options[$name] : null;
466		if ($name === 'backup') {
467		$value = isset($options[$name]) ? ($options[$name] ? 'backup' : '') : '';
468		}
469		unset($options[$name]);
470
471		return $value;
472		}
473
474		/**
475		* get agent config data by name
476		*
477		* @param $name
478		*
479		* @return array
480		*/
481	3	protected static function getAgentConfigData($name)
482		{
483	3	return isset(self::$agentsConfig[$name]) ?
484	3	(Array) self::$agentsConfig[$name] : [];
485		}
486
487		/**
488		* get a sms agent instance,
489		* if null, will create a new agent instance
490		*
491		* @param $name
492		* @param array $configData
493		*
494		* @throws PhpSmsException
495		*
496		* @return mixed
497		*/
498	18	public static function getSmsAgent($name, array $configData)
499		{
500	18	if (!isset(self::$agents[$name])) {
501	3	$configData['name'] = $name;
502	3	$className = isset($configData['agentClass']) ? $configData['agentClass'] : ('Toplan\\PhpSms\\' . $name . 'Agent');
503	3	if ((isset($configData['sendSms']) && is_callable($configData['sendSms'])) \|\|
504	3	(isset($configData['voiceVerify']) && is_callable($configData['voiceVerify']))) {
505		//将临时代理器寄生到LogAgent
506		self::$agents[$name] = new LogAgent($configData);
507	3	} elseif (class_exists($className)) {
508		//创建新代理器
509	3	self::$agents[$name] = new $className($configData);
510	3	} else {
511		//无代理器可用
512		throw new PhpSmsException("Agent [$name] not support. If you are want to use parasitic agent, please set callable arguments: [sendSms] and [voiceVerify]");
513		}
514	3	}
515
516	18	return self::$agents[$name];
517		}
518
519		/**
520		* validate
521		*
522		* @throws PhpSmsException
523		*/
524	18	protected function validator()
525		{
526	18	if (!$this->smsData['to']) {
527		throw new PhpSmsException('Please set send sms(or voice verify) to who use `to()` method.');
528		}
529
530	18	return true;
531		}
532
533		/**
534		* set enable agents
535		*
536		* @param $agentName
537		* @param null $options
538		*/
539	6	public static function enable($agentName, $options = null)
540		{
541	6	if (is_array($agentName)) {
542	6	foreach ($agentName as $name => $opt) {
543	6	self::enable($name, $opt);
544	6	}
545	6	} elseif ($agentName && is_string($agentName) && $options !== null) {
546	3	self::$agentsName["$agentName"] = is_array($options) ? $options : "$options";
547	6	} elseif (is_int($agentName) && !is_array($options) && "$options") {
548	3	self::$agentsName["$options"] = '1';
549	6	} elseif ($agentName && $options === null) {
550	3	self::$agentsName["$agentName"] = '1';
551	3	}
552	6	}
553
554		/**
555		* set config for available agents
556		*
557		* @param $agentName
558		* @param array $config
559		*
560		* @throws PhpSmsException
561		*/
562	6	public static function agents($agentName, array $config = [])
563		{
564	6	if (is_array($agentName)) {
565	3	foreach ($agentName as $name => $conf) {
566	3	self::agents($name, $conf);
567	3	}
568	6	} elseif ($agentName && is_array($config)) {
569	6	if (preg_match('/^[0-9]+$/', $agentName)) {
570		throw new PhpSmsException("Agent name [$agentName] must be string, could not be a pure digital");
571		}
572	6	self::$agentsConfig["$agentName"] = $config;
573	6	}
574	6	}
575
576		/**
577		* get enable agents
578		*
579		* @return array
580		*/
581	9	public static function getEnableAgents()
582		{
583	9	return self::$agentsName;
584		}
585
586		/**
587		* get agents config info
588		*
589		* @return array
590		*/
591	9	public static function getAgentsConfig()
592		{
593	9	return self::$agentsConfig;
594		}
595
596		/**
597		* tear down enable agents
598		*/
599	3	public static function cleanEnableAgents()
600		{
601	3	self::$agentsName = [];
602	3	}
603
604		/**
605		* tear down agents config
606		*/
607	3	public static function cleanAgentsConfig()
608		{
609	3	self::$agentsConfig = [];
610	3	}
611
612		/**
613		* overload static method
614		*
615		* @param $name
616		* @param $args
617		*
618		* @throws PhpSmsException
619		*/
620	6	public static function __callStatic($name, $args)
621		{
622	6	$name = $name === 'beforeSend' ? 'beforeRun' : $name;
623	6	$name = $name === 'afterSend' ? 'afterRun' : $name;
624	6	$name = $name === 'beforeAgentSend' ? 'beforeDriverRun' : $name;
625	6	$name = $name === 'afterAgentSend' ? 'afterDriverRun' : $name;
626	6	if (in_array($name, self::$enableHooks)) {
627	6	$handler = $args[0];
628	6	$override = isset($args[1]) ? (bool) $args[1] : false;
629	6	if (is_callable($handler)) {
630	6	$task = self::generatorTask();
631	6	$task->hook($name, $handler, $override);
632	6	} else {
633		throw new PhpSmsException("Please give method static $name() a callable parameter");
634		}
635	6	} else {
636		throw new PhpSmsException("Do not find static method $name()");
637		}
638	6	}
639
640		/**
641		* overload method
642		*
643		* @param $name
644		* @param $args
645		*
646		* @throws PhpSmsException
647		* @throws \Exception
648		*/
649	3	public function __call($name, $args)
650		{
651		try {
652	3	$this->__callStatic($name, $args);
653	3	} catch (\Exception $e) {
654		throw $e;
655		}
656	3	}
657		}
658

toplan / phpsms

Pull Request — master (#17)

Sms::parseAgentArrayOptions() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like