hipanel\modules\ticket\models\Thread

Complexity

Total Complexity

27

Size/Duplication

Total Lines	285
Duplicated Lines	0 %

Coupling/Cohesion

Components	0
Dependencies	6

Test Coverage

Coverage

0%

Importance

Changes

0

21 Methods

Rating	Name	Duplication	Size	Complexity
A	init()	0	5	1
A	beforeChange()	0	7	1
A	behaviors()	0	11	1
A	attributes()	0	56	1
B	rules()	0	45	1
A	getClient()	0	4	1
A	getSeller()	0	4	1
A	getThreadUrl()	0	4	1
A	parseMessage()	0	7	1
A	prepareSpentTime()	0	4	1
A	prepareTopic()	0	4	2
A	getWatchersLogin()	0	10	2
A	xFormater()	0	12	2
A	getAnswers()	0	5	1
A	getResponsibleClientTypes()	0	4	1
A	getAnswer()	0	8	3
A	getMaxAnswerId()	0	8	2
A	scenarioCommands()	0	7	1
A	attributeLabels()	0	17	1
A	getClient_id()	0	4	1
A	getSeller_id()	0	4	1

<?php

/*
 * HiPanel tickets module
 *
 * @link      https://github.com/hiqdev/hipanel-module-ticket
 * @package   hipanel-module-ticket
 * @license   BSD-3-Clause
 * @copyright Copyright (c) 2015-2016, HiQDev (http://hiqdev.com/)
 */

namespace hipanel\modules\ticket\models;

use hipanel\behaviors\File;
use hipanel\helpers\Markdown;
use hipanel\modules\client\models\Client;
use stdClass;
use Yii;
use yii\web\NotFoundHttpException;

/**
 * Class Ticket.
 */
class Thread extends \hipanel\base\Model
{
    use \hipanel\base\ModelTrait;

    public static $i18nDictionary = 'hipanel:ticket';

    const STATE_OPEN = 'opened';
    const STATE_CLOSE = 'closed';

    public $search_form;

    public function init()
    {
        $this->on(static::EVENT_BEFORE_INSERT, [$this, 'beforeChange']);
        $this->on(static::EVENT_BEFORE_UPDATE, [$this, 'beforeChange']);
    }

    public function beforeChange($event)

The parameter $event is not used and could be removed.

    {
        $this->prepareSpentTime();
        $this->prepareTopic();

        return true;
    }

    /**
     * @return array
     */
    public function behaviors()
    {
        return [
            [
                'class' => File::class,
                'attribute' => 'file',
                'targetAttribute' => 'file_ids',
                'scenarios' => ['create', 'answer'],
            ],
        ];
    }

    /**
     * @return array
     */
    public function attributes()
    {
        return [
            'id',
            'subject',
            'state',
            'state_label',
            'author_email',
            'author',
            'author_id',
            'responsible_id',
            'responsible_email',
            'author_seller',
            'author_seller_id',
            'recipient_id',
            'recipient',
            'recipient_seller',
            'recipient_seller_id',
            'replier_id',
            'replier',
            'replier_seller',
            'replier_name',
            'responsible',
            'priority',
            'priority_label',
            'spent', 'spent_hours',
            'answer_count',
            'status',
            'reply_time',
            'create_time',
            'a_reply_time',
            'elapsed',
            'topics',
            'topic',
            'watchers',
            'watcher',
            'add_tag_ids',
            'file_ids',
            'file',
            'message', // 'answer_message',
            'is_private',

            'anonym_name',
            'anonym_email',
            'anonym_seller',

            'lastanswer',
            'time',
            'add_watchers', 'del_watchers',

            'time_from',
            'time_till',

            'contact',
        ];
    }

    /**
     * {@inheritdoc}
     */
    public function rules()
    {
        $rules = [
            [['author_id', 'responsible_id'], 'integer'],
            [['subject', 'message'], 'required', 'on' => ['create']],
            [['id'], 'required', 'on' => ['answer', 'update-answer', 'open', 'close']],
            [
                [
                    'topics',
                    'state',
                    'priority',
                    'responsible',
                    'recipient_id',
                    'watchers',
                    'spent', 'spent_hours',
                    'file_ids',
                ],
                'safe',
                'on' => 'create',
            ],
            [
                [
                    'message',
                    'topics', 'state', 'priority',
                    'responsible', 'recipient_id',
                    'watchers', 'add_watchers', 'del_watchers',
                    'is_private',
                    'file_ids',
                    'spent', 'spent_hours',
                ],
                'safe',
                'on' => 'answer',
            ],
            [['state'], 'safe', 'on' => ['close', 'open']],
            // only client-side validation. Answer is actually possible without a message,
            // but does not make any sense.
            [['message'], 'required', 'on' => ['answer'], 'when' => function () { return false; }],
            [['id'], 'integer', 'on' => 'answer'],
            [['file'], 'file', 'maxFiles' => 5],
            [['lastanswer', 'create_time', 'recipient'], 'safe'],
            [['author', 'author_seller'], 'safe', 'when' => Yii::$app->user->can('support')],
        ];

        return $rules;
    }

    /**
     * {@inheritdoc}
     */
    public function attributeLabels()
    {
        return $this->mergeAttributeLabels([
            'author'           => Yii::t('hipanel:ticket', 'Author'),
            'author_id'        => Yii::t('hipanel:ticket', 'Author'),
            'recipient'        => Yii::t('hipanel:ticket', 'Recipient'),
            'is_private'       => Yii::t('hipanel:ticket', 'Make private'),
            'responsible'      => Yii::t('hipanel:ticket', 'Assignee'),
            'responsible_id'   => Yii::t('hipanel:ticket', 'Assignee'),
            'spent'            => Yii::t('hipanel:ticket', 'Spent time'),
            'create_time'      => Yii::t('hipanel:ticket', 'Created'),
            'a_reply_time'     => Yii::t('hipanel:ticket', 'a_reply_time'),
            'file'             => Yii::t('hipanel:ticket', 'Files'),
            'lastanswer'       => Yii::t('hipanel:ticket', 'Last answer'),
            'author_seller'    => Yii::t('hipanel:ticket', 'Seller'),
        ]);
    }

    public function getClient()
    {
        return $this->author;

The property author does not exist on object<hipanel\modules\ticket\models\Thread>. Since you implemented __get, maybe consider adding a @property annotation.

    }

    public function getClient_id()
    {
        return $this->author_id;

The property author_id does not exist on object<hipanel\modules\ticket\models\Thread>. Since you implemented __get, maybe consider adding a @property annotation.

    }

    public function getSeller()
    {
        return $this->author_seller;

The property author_seller does not exist on object<hipanel\modules\ticket\models\Thread>. Since you implemented __get, maybe consider adding a @property annotation.

    }

    public function getSeller_id()
    {
        return $this->author_seller_id;

The property author_seller_id does not exist on object<hipanel\modules\ticket\models\Thread>. Since you implemented __get, maybe consider adding a @property annotation.

    }

    public function getThreadUrl()
    {
        return ['@ticket/view', 'id' => $this->id];

The property id does not exist on object<hipanel\modules\ticket\models\Thread>. Since you implemented __get, maybe consider adding a @property annotation.

    }

    public static function parseMessage($message)
    {
        $message = str_replace(["\n\r", "\r\r", "\r\n"], "\n", $message); // "\n\n",
        $message = Markdown::process($message);

        return $message;
    }

    public function prepareSpentTime()
    {
        list($this->spent_hours, $this->spent) = explode(':', $this->spent, 2);

The property spent_hours does not exist on object<hipanel\modules\ticket\models\Thread>. Since you implemented __get, maybe consider adding a @property annotation.

The property spent does not exist on object<hipanel\modules\ticket\models\Thread>. Since you implemented __get, maybe consider adding a @property annotation.

    }

    public function prepareTopic()
    {
        $this->topics = is_array($this->topics) ? implode(',', $this->topics) : $this->topics;

The property topics does not exist on object<hipanel\modules\ticket\models\Thread>. Since you implemented __set, maybe consider adding a @property annotation.

The property topics does not exist on object<hipanel\modules\ticket\models\Thread>. Since you implemented __get, maybe consider adding a @property annotation.

    }

    public function getWatchersLogin()
    {
        $results = [];
        foreach ((array) $this->watchers as $id => $watcher) {
            list($login, $email) = explode(' ', $watcher);

The assignment to $email is unused. Consider omitting it like so list($first,,$third).

            $results[$id] = $login;
        }

        return $results;
    }

    public function xFormater(array $items)
    {
        $result = [];
        foreach ($items as $id => $label) {
            $object = new stdClass();
            $object->value = $id;
            $object->text = $label;
            $result[] = $object;
        }

        return $result;
    }

    public function getAnswers()
    {
        // TODO: redo API in order to have different `Thread` and `ThreadMessage` models
        return $this->hasMany(Answer::class, ['id' => 'id'])->join('files')->indexBy('answer_id');
    }

    /**
     * Returns array of client types, that can be set as responsible for the thread.
     *
     * @return array
     */
    public static function getResponsibleClientTypes()
    {
        return [Client::TYPE_SELLER, Client::TYPE_ADMIN, Client::TYPE_MANAGER, Client::TYPE_OWNER];
    }

    /**
     * @param integer $id
     * @param bool $throwOnError whether to throw an exception when answer is not found in thread
     * @throws NotFoundHttpException
     * @return Answer
     */
    public function getAnswer($id, $throwOnError = true)
    {
        if (!isset($this->answers[$id]) && $throwOnError) {

The property answers does not exist on object<hipanel\modules\ticket\models\Thread>. Since you implemented __get, maybe consider adding a @property annotation.

            throw new NotFoundHttpException('Answer does not belong to this model');
        }

        return $this->answers[$id];

The property answers does not exist on object<hipanel\modules\ticket\models\Thread>. Since you implemented __get, maybe consider adding a @property annotation.

    }

    public function getMaxAnswerId()
    {
        if ($this->isRelationPopulated('answers')) {
            return max(array_keys($this->answers));

The property answers does not exist on object<hipanel\modules\ticket\models\Thread>. Since you implemented __get, maybe consider adding a @property annotation.

        }

        return $this->id;

The property id does not exist on object<hipanel\modules\ticket\models\Thread>. Since you implemented __get, maybe consider adding a @property annotation.

    }

    public function scenarioCommands()
    {
        return [
            'open' => 'answer',
            'close' => 'answer',
        ];
    }
}