Overtrue\Wechat\Messages\BaseMessage

Complexity

Total Complexity

13

Size/Duplication

Total Lines	153
Duplicated Lines	0 %

Coupling/Cohesion

Components	2
Dependencies	2

Importance

Changes	4
Bugs	0	Features	0

6 Methods

Rating	Name	Duplication	Size	Complexity
A	buildForStaff()	0	16	3
A	buildForReply()	0	15	2
A	buildForBroadcastPreview()	0	13	2
A	getDefaultMessageType()	0	6	1
A	validate()	0	6	1
B	buildForBroadcast()	0	31	4

<?php
/**
 * BaseMessage.php
 *
 * Part of Overtrue\Wechat.
 *
 * For the full copyright and license information, please view the LICENSE
 * file that was distributed with this source code.
 *
 * @author    overtrue <i@overtrue.me>
 * @copyright 2015 overtrue <i@overtrue.me>
 * @link      https://github.com/overtrue
 * @link      http://overtrue.me
 */

namespace Overtrue\Wechat\Messages;

use Overtrue\Wechat\Utils\MagicAttributes;
use Overtrue\Wechat\Utils\XML;

/**
 * 消息基类
 *
 * @property string      $from
 * @property string      $to
 * @property string      $staff
 *
 * @method BaseMessage to($to)
 * @method BaseMessage from($from)
 * @method BaseMessage staff($staff)
 * @method array       toStaff()
 * @method array       toReply()
 * @method array       toBroadcast()
 */
abstract class BaseMessage extends MagicAttributes
{

    /**
     * 允许的属性
     *
     * @var array
     */
    protected $properties = array();

    /**
     * 基础属性
     *
     * @var array
     */
    protected $baseProperties = array(
                                 'from',
                                 'to',
                                 'to_group',
                                 'to_all',
                                 'staff',
                                );

    /**
     * 生成用于主动推送的数据
     *
     * @return array
     */
    public function buildForStaff()
    {
        if (!method_exists($this, 'toStaff')) {
            throw new \Exception(__CLASS__.'未实现此方法：toStaff()');
        }

        $base = array(
                 'touser'  => $this->to,
                 'msgtype' => $this->getDefaultMessageType(),
                );
        if (!empty($this->staff)) {
            $base['customservice'] = array('kf_account' => $this->staff);
        }

        return array_merge($base, $this->toStaff());
    }

    /**
     * 生成用于回复的数据
     *
     * @return array
     */
    public function buildForReply()
    {
        if (!method_exists($this, 'toReply')) {
            throw new \Exception(__CLASS__.'未实现此方法：toReply()');
        }

        $base = array(
                 'ToUserName'   => $this->to,
                 'FromUserName' => $this->from,
                 'CreateTime'   => time(),
                 'MsgType'      => $this->getDefaultMessageType(),
                );

        return XML::build(array_merge($base, $this->toReply()));
    }

    /**
     * 生成通过群发的数据
     *
     * @return array
     */
    public function buildForBroadcast()
    {
        if (!method_exists($this, 'toStaff')) {
            throw new \Exception(__CLASS__.'未实现此方法：toStaff()');
        }

        if (is_null($this->to_group)) {

The property to_group does not exist on object<Overtrue\Wechat\Messages\BaseMessage>. Since you implemented __get, maybe consider adding a @property annotation.

            $group = array(
                'filter' => array(
                    'is_to_all' => true,
                ),
            );
        } elseif (is_array($this->to_group)) {

The property to_group does not exist on object<Overtrue\Wechat\Messages\BaseMessage>. Since you implemented __get, maybe consider adding a @property annotation.

            $group = array(
                'touser' => $this->to_group,

The property to_group does not exist on object<Overtrue\Wechat\Messages\BaseMessage>. Since you implemented __get, maybe consider adding a @property annotation.

            );
        } else {
            $group = array(
                'filter' => array(
                    'is_to_all' => false,
                    'group_id' => $this->to_group,

The property to_group does not exist on object<Overtrue\Wechat\Messages\BaseMessage>. Since you implemented __get, maybe consider adding a @property annotation.

                ),
            );
        }

        $base = array(
            'msgtype' => $this->getDefaultMessageType(),
        );

        return array_merge($group, $this->toStaff(), $base);
    }

    /**
     * 生成通过群发预览的数据
     *
     * @param $type
     *
     * @return array
     *
     * @throws \Exception
     */
    public function buildForBroadcastPreview($type)
    {
        if (!method_exists($this, 'toStaff')) {
            throw new \Exception(__CLASS__.'未实现此方法：toStaff()');
        }

        $base = array(
            $type => $this->to,
            'msgtype' => $this->getDefaultMessageType(),
        );

        return array_merge($base, $this->toStaff());
    }

    /**
     * 获取默认的消息类型名称
     *
     * @return string
     */
    public function getDefaultMessageType()
    {
        $class = explode('\\', get_class($this));

        return strtolower(array_pop($class));
    }

    /**
     * 验证
     *
     * @param string $attribute
     * @param mixed  $value
     *
     * @return bool
     */
    protected function validate($attribute, $value)
    {
        $properties = array_merge($this->baseProperties, $this->properties);

        return in_array($attribute, $properties, true);
    }
}