freyo / laravel-queue-cmq

src/Queue/Driver/Account.php

<?php

namespace Freyo\LaravelQueueCMQ\Queue\Driver;

/*
Account 对象非线程安全，如果多线程使用，需要每个线程单独初始化Account对象类
*/
class Account
{
    private $secretId;
    private $secretKey;
    private $cmq_client;

    /*
        @type host: string
        @param host: 访问的url，例如：https://cmq-queue-gz.api.qcloud.com

The doc comment 访问的url，例如：https://cmq-queue-gz.api.qcloud.com at position 0 could not be parsed: Unknown type name '访问的url，例如：https' at position 0 in 访问的url，例如：https://cmq-queue-gz.api.qcloud.com.

        @type secretId: string
        @param secretId: 用户的secretId, 腾讯云官网获取

        @type secretKey: string
        @param secretKey:  用户的secretKey，腾讯云官网获取

        @note: Exception
        :: CMQClientParameterException host格式错误
    */

    public function __construct($host, $secretId, $secretKey)
    {
        $this->host = $host;

The property host does not exist. Although not strictly required by PHP, it is generally a best practice to declare properties explicitly.

        $this->secretId = $secretId;
        $this->secretKey = $secretKey;
        $this->cmq_client = new CMQClient($host, $secretId, $secretKey);
    }

    /*
     * @type sign_method:string
     * @param sign_method : only support sha1 and sha256

The doc comment : only at position 0 could not be parsed: Unknown type name ':' at position 0 in : only.

     */
    public function set_sign_method($sign_method = 'sha1')
    {
        $this->cmq_client->set_sign_method($sign_method);
    }

    /* 设置访问的url

        @type host: string
        @param host: 访问的url，例如：http://cmq-queue-gz.api.tencentyun.com

The doc comment 访问的url，例如：http://cmq-queue-gz.api.tencentyun.com at position 0 could not be parsed: Unknown type name '访问的url，例如：http' at position 0 in 访问的url，例如：http://cmq-queue-gz.api.tencentyun.com.

        @type secretId: string
        @param secretId: 用户的secretId，腾讯云官网获取

        @type secretKey: string
        @param secretKey: 用户的secretKey，腾讯云官网获取

        @note: Exception
        :: CMQClientParameterException host格式错误
    */
    public function set_client($host, $secretId = null, $secretKey = null)
    {
        if ($secretId == null) {
            $secretId = $this->secretId;
        }
        if ($secretKey == null) {
            $secretKey = $this->secretKey;
        }
        $this->cmq_client = new CMQClient($host, $secretId, $secretKey);
    }

    /* 获取queue client

        @rtype: CMQClient object
        @return: 返回使用的CMQClient object
    */
    public function get_client()
    {
        return $this->cmq_client;
    }

    /* 获取Account的一个Queue对象

            @type queue_name: string
            @param queue_name: 队列名

The doc comment 队列名 at position 0 could not be parsed: Unknown type name '队列名' at position 0 in 队列名.

            @rtype: Queue object
            @return: 返回该Account的一个Queue对象
     */
    public function get_queue($queue_name)
    {
        return new Queue($queue_name, $this->cmq_client);
    }

    /* 列出Account的队列

           @type searchWord: string
           @param searchWord: 队列名的前缀

The doc comment 队列名的前缀 at position 0 could not be parsed: Unknown type name '队列名的前缀' at position 0 in 队列名的前缀.

           @type limit: int
           @param limit: list_queue最多返回的队列数

           @type offset: string
           @param offset: list_queue的起始位置，上次list_queue返回的next_offset

           @rtype: tuple
           @return: QueueURL的列表和下次list queue的起始位置; 如果所有queue都list出来，next_offset为"".
     */
    public function list_queue($searchWord = '', $limit = -1, $offset = '')
    {
        $params = [];
        if ($searchWord != '') {
            $params['searchWord'] = $searchWord;
        }
        if ($limit != -1) {
            $params['limit'] = $limit;
        }
        if ($offset != '') {
            $params['offset'] = $offset;
        }

        $ret_pkg = $this->cmq_client->list_queue($params);

        if ($offset == '') {
            $next_offset = count($ret_pkg['queueList']);
        } else {
            $next_offset = (int) $offset + count($ret_pkg['queueList']);
        }
        if ($next_offset >= $ret_pkg['totalCount']) {
            $next_offset = '';
        }

        return ['totalCount'      => $ret_pkg['totalCount'],
                     'queueList'  => $ret_pkg['queueList'], 'next_offset' => $next_offset, ];
    }

    /* 列出Account的主题

          @type searchWord: string
          @param searchWord: 主题关键字

The doc comment 主题关键字 at position 0 could not be parsed: Unknown type name '主题关键字' at position 0 in 主题关键字.

          @type limit: int
          @param limit: 最多返回的主题数目

          @type offset: string
          @param offset: list_topic的起始位置，上次list_topic返回的next_offset

          @rtype: tuple
          @return: TopicURL的列表和下次list topic的起始位置; 如果所有topic都list出来，next_offset为"".
    */
    public function list_topic($searchWord = '', $limit = -1, $offset = '')
    {
        $params = [];
        if ($searchWord != '') {
            $params['searchWord'] = $searchWord;
        }
        if ($limit != -1) {
            $params['limit'] = $limit;
        }
        if ($offset != '') {
            $params['offset'] = $offset;
        }

        $resp = $this->cmq_client->list_topic($params);

        if ($offset == '') {
            $next_offset = count($resp['topicList']);
        } else {
            $next_offset = (int) $offset + count($resp['topicList']);
        }
        if ($next_offset >= $resp['totalCount']) {
            $next_offset = '';
        }

        return ['totalCoult'       => $resp['totalCount'],
                     'topicList'   => $resp['topicList'],
                     'next_offset' => $next_offset, ];
    }

    /* 获取Account的一个Topic对象

    @type topic_name: string
    @param queue_name:

    @rtype: Topic object
    @return: 返回该Account的一个Topic对象
    */

The doc comment @rtype: Topic at position 0 could not be parsed: Unknown type name '@rtype' at position 0 in @rtype: Topic.

    public function get_topic($topic_name)
    {
        return new Topic($topic_name, $this->cmq_client);
    }

    /* 获取Account的一个Subscription对象

    @type topic_name: string
    @param queue_name:

    @type subscription_name :string
    @param subscription_name:

    @rtype: Subscription object
    @return: 返回该Account的一个Subscription对象
    */

The doc comment @type at position 0 could not be parsed: Unknown type name '@type' at position 0 in @type.

    public function get_subscription($topic_name, $subscription_name)
    {
        return new Subscription($topic_name, $subscription_name, $this->cmq_client);
    }
}