TicketController::actionTemplateText() - Code Metrics - Inspection of "Implemented templates for tickets" - hiqdev/hipanel-module-ticket - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( 63ab7f...7e002b )

by Dmitry

created 2016-06-24 08:29 UTC

TicketController::actionTemplateText() A

↳ Parent: TicketController

Complexity

Conditions	3
Paths	3

Size

Total Lines	18
Code Lines	10

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	0
CRAP Score	12

Importance

Changes	1
Bugs	0	Features	1

Metric	Value
c	1
b	0
f	1
dl	0
loc	18
ccs	0
cts	14
cp	0
rs	9.4285
cc	3
eloc	10
nc	3
nop	2
crap	12

<?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\controllers;

use hipanel\actions\Action;
use hipanel\actions\IndexAction;
use hipanel\actions\OrientationAction;
use hipanel\actions\PrepareAjaxViewAction;
use hipanel\actions\PrepareBulkAction;
use hipanel\actions\ProxyAction;
use hipanel\actions\SearchAction;
use hipanel\actions\SmartCreateAction;
use hipanel\actions\SmartPerformAction;
use hipanel\actions\SmartUpdateAction;
use hipanel\actions\ValidateFormAction;
use hipanel\actions\ViewAction;
use hipanel\models\File;
use hipanel\models\Ref;
use hipanel\modules\client\models\Article;
use hipanel\modules\client\models\ArticleSearch;
use hipanel\modules\client\models\Client;
use hipanel\modules\ticket\models\Thread;
use hipanel\modules\ticket\models\ThreadSearch;
use hipanel\modules\ticket\models\TicketSettings;
use hiqdev\hiart\ErrorResponseException;
use Yii;
use yii\base\Event;
use yii\filters\PageCache;
use yii\helpers\ArrayHelper;
use yii\web\NotFoundHttpException;
use yii\web\Response;

/**
 * Class TicketController.
 */
class TicketController extends \hipanel\base\CrudController
{
    /**
     * Used to create newModel.
     *
     * @return string
     */
    public static function modelClassName()
    {
        return Thread::className();
    }

    public function behaviors()
    {
        return array_merge(parent::behaviors(), [
class Author {
    private $name;

    public function __construct($name) {
        $this->name = $name;
    }

    public function getName() {
        return $this->name;
    }
}

abstract class Post {
    public function getAuthor() {
        return 'Johannes';
    }
}

class BlogPost extends Post {
    public function getAuthor() {
        return new Author('Johannes');
    }
}

class ForumPost extends Post { /* ... */ }

function my_function(Post $post) {
    echo strtoupper($post->getAuthor());
}
            [
                'class' => PageCache::class,
                'only' => ['templates'],
                'duration' => 7200, // 2h
                'variations' => [
                    Yii::$app->user->getId(),
                ],
            ]
        ]);
    }

    public function actions()
    {
        return [
            'set-orientation' => [
                'class' => OrientationAction::class,
                'allowedRoutes' => [
                    '@ticket/index',
                ],
            ],
            'index' => [
                'class' => IndexAction::class,
                'data' => $this->prepareRefs(),
            ],
            'view' => [
                'class' => ViewAction::class,
                'findOptions' => $this->getSearchOptions(),
                'on beforeSave' => function (Event $event) {
                    /** @var PrepareBulkAction $action */
                    $action = $event->sender;
                    $dataProvider = $action->getDataProvider();
                    $dataProvider->query->joinWith('answers');
                },
                'data' => function ($action) {
                    $client = Client::find()
                        ->withDomains()
                        ->withServers()
                        ->where([
                            'id' => $action->model->recipient_id,
                            'with_contact' => 1,
                        ])->one();

                    if ($client->login === 'anonym') {
                        $client->name = $action->model->anonym_name;
                        $client->email = $action->model->anonym_email;
                        $client->seller = $action->model->anonym_seller;
                    }

                    return array_merge(compact('client'), $this->prepareRefs());
                },
            ],
            'validate-form' => [
                'class' => ValidateFormAction::class,
            ],
            'answer' => [
                'class' => SmartUpdateAction::class,
                'success' => Yii::t('hipanel/ticket', 'Ticket changed'),
            ],
            'create' => [
                'class' => SmartCreateAction::class,
                'success' => Yii::t('hipanel/ticket', 'Ticket posted'),
                'data' => function () {
                    return $this->prepareRefs();
                },
            ],
            'delete' => [
                'class' => SmartPerformAction::class,
                'success' => Yii::t('hipanel/ticket', 'Ticket deleted'),
            ],
            'subscribe' => [
                'class' => SmartPerformAction::class,
                'scenario' => 'answer',
                'success' => Yii::t('hipanel/ticket', 'Subscribed'),
                'on beforeSave' => function (Event $event) {

                    /** @var Action $action */
                    $action = $event->sender;
                    foreach ($action->collection->models as $model) {
                        $model->{$this->_subscribeAction[$action->id]} = Yii::$app->user->identity->username;
                    }
                },
                'POST pjax' => [
                    'save' => true,
                    'success' => [
                        'class' => ViewAction::class,
                        'view' => '_subscribe_button',
                        'findOptions' => ['with_answers' => 1, 'show_closed' => 1],
                    ],
                ],
            ],
            'unsubscribe' => [
                'class' => SmartPerformAction::class,
                'scenario' => 'answer',
                'success' => Yii::t('hipanel/ticket', 'Unsubscribed'),
                'on beforeSave' => function (Event $event) {

                    /** @var Action $action */
                    $action = $event->sender;
                    foreach ($action->collection->models as $model) {
                        $model->{$this->_subscribeAction[$action->id]} = Yii::$app->user->identity->username;
                    }
                },
                'POST pjax' => [
                    'save' => true,
                    'success' => [
                        'class' => ViewAction::class,
                        'view' => '_subscribe_button',
                        'findOptions' => ['with_answers' => 1, 'show_closed' => 1],
                    ],
                ],
            ],
            'close' => [
                'class' => SmartPerformAction::class,
                'scenario' => 'close',
                'success' => Yii::t('hipanel/ticket', 'Ticket closed'),
                'on beforeSave' => function (Event $event) {

                    /** @var Action $action */
                    $action = $event->sender;
                    foreach ($action->collection->models as $model) {
                        $model->{'state'} = Thread::STATE_CLOSE;
                    }
                },
                'POST pjax' => [
                    'save' => true,
                    'success' => [
                        'class' => ProxyAction::class,
                        'action' => 'view',
                        'params' => function ($action, $model) {
                            return ['id' => $model->id];
                        },
                    ],
                ],
            ],
            'open' => [
                'class' => SmartPerformAction::class,
                'scenario' => 'open',
                'success' => Yii::t('hipanel/ticket', 'Ticket opened'),
                'on beforeSave' => function (Event $event) {

                    /** @var Action $action */
                    $action = $event->sender;
                    foreach ($action->collection->models as $model) {
                        $model->{'state'} = Thread::STATE_OPEN;
                    }
                },
                'POST pjax' => [
                    'save' => true,
                    'success' => [
                        'class' => ProxyAction::class,
                        'action' => 'view',
                        'params' => function ($action, $model) {
                            return ['id' => $model->id];
                        },
                    ],
                ],
            ],
            'update-answer-modal' => [
                'class' => PrepareAjaxViewAction::class,
                'on beforeSave' => function (Event $event) {
                    /** @var PrepareBulkAction $action */
                    $action = $event->sender;
                    $dataProvider = $action->getDataProvider();
                    $dataProvider->query->joinWith('answers');
interface User
{
    /** @return string */
    public function getPassword();
}

class MyUser implements User
{
    public function getPassword()
    {
        // return something
    }

    public function getDisplayName()
    {
        // return some name.
    }
}

class AuthSystem
{
    public function authenticate(User $user)
    {
        $this->logger->info(sprintf('Authenticating %s.', $user->getDisplayName()));
        // do something.
    }
}
                },
                'data' => function ($action, $data) {
                    $answer_id = Yii::$app->request->get('answer_id');
                    if (!is_numeric($answer_id)) {
                        throw new NotFoundHttpException('Invalid answer_id');
                    }

                    return ArrayHelper::merge($data, [
                        'answer_id' => $answer_id,
                    ]);
                },
                'findOptions' => $this->getSearchOptions(),
                'scenario' => 'answer-update',
                'view' => '_updateAnswerModal',
            ],
            'templates' => [
                'class' => SearchAction::class,
                'searchModel' => ArticleSearch::class,
                'collection' => ['model' => Article::class],
                'findOptions' => [
                    'realm' => 'ticket_template',
                    'with_data' => true,
                ]
            ],
        ];
    }

    /**
     * @var array
     */
    private $_subscribeAction = ['subscribe' => 'add_watchers', 'unsubscribe' => 'del_watchers'];

    /**
     * @return array
     */
    protected function prepareRefs()

    {
        return [
            'topic_data' => $this->getRefs('topic,ticket', 'hipanel/ticket'),
            'state_data' => $this->getClassRefs('state', 'hipanel/ticket'),
            'priority_data' => $this->getPriorities(),
        ];
    }

    public function actionTemplateText($id, $lang)
    {
        Yii::$app->response->format = Response::FORMAT_JSON;

        $result = [];

        try {
            $template = Article::find()->ticketTemplates()->andWhere(['id' => $id])->one();
        } catch (ErrorResponseException $e) {
            return [];
        }

        if (isset($template->data[$lang])) {
            $result['text'] = $template->data[$lang]['text'];
        }

        return $result;
    }

    /**
     * @return string
     */
    public function actionSettings()
    {
        $model = new TicketSettings();
        $request = Yii::$app->request;
        if ($request->isAjax && $model->load($request->post()) && $model->validate()) {
            $model->setFormData();
            \Yii::$app->getSession()->setFlash('success', \Yii::t('hipanel/ticket', 'Ticket settings saved'));
class A
{
    public function foo() { }
}

class B extends A
{
    public function bar() { }
}

/**
 * @param A|B $x
 */
function someFunction($x)
{
    $x->foo(); // This call is fine as the method exists in A and B.
    $x->bar(); // This method only exists in B and might cause an error.
}
        } else {
            $model->getFormData();
        }

        return $this->render('settings', [
            'model' => $model,
        ]);
    }

    /**
     * @param $id
     *
     * @return \yii\web\Response
     */
    public function actionPriorityUp($id)

    {
        $options[$id] = ['id' => $id, 'priority' => 'high'];
foreach ($collection as $item) {
    $myArray['foo'] = $item->getFoo();

    if ($item->hasBar()) {
        $myArray['bar'] = $item->getBar();
    }

    // do something with $myArray
}
        if ($this->_ticketChange($options)) {
            \Yii::$app->getSession()->setFlash('success',
class A
{
    public function foo() { }
}

class B extends A
{
    public function bar() { }
}

/**
 * @param A|B $x
 */
function someFunction($x)
{
    $x->foo(); // This call is fine as the method exists in A and B.
    $x->bar(); // This method only exists in B and might cause an error.
}
                \Yii::t('hipanel/ticket', 'Priority has been changed to high'));
        } else {
            \Yii::$app->getSession()->setFlash('error',
                \Yii::t('hipanel/ticket', 'Some error occurred! Priority has not been changed to high'));
        }

        return $this->redirect(Yii::$app->request->referrer);
    }

    /**
     * @param $id
     *
     * @return \yii\web\Response
     */
    public function actionPriorityDown($id)

    {
        $options[$id] = ['id' => $id, 'priority' => 'medium'];
foreach ($collection as $item) {
    $myArray['foo'] = $item->getFoo();

    if ($item->hasBar()) {
        $myArray['bar'] = $item->getBar();
    }

    // do something with $myArray
}
        if ($this->_ticketChange($options)) {
            \Yii::$app->getSession()->setFlash('success',
class A
{
    public function foo() { }
}

class B extends A
{
    public function bar() { }
}

/**
 * @param A|B $x
 */
function someFunction($x)
{
    $x->foo(); // This call is fine as the method exists in A and B.
    $x->bar(); // This method only exists in B and might cause an error.
}
                \Yii::t('hipanel/ticket', 'Priority has been changed to medium'));
        } else {
            \Yii::$app->getSession()->setFlash('error', \Yii::t('hipanel/ticket', 'Something goes wrong!'));
        }

        return $this->redirect(Yii::$app->request->referrer);
    }

    /**
     * Numerous ticket changes in one method, like BladeRoot did :).
     *
     * @param array $options
     * @param string $apiCall
     * @param bool $bulk
     *
     * @return bool
     */
    private function _ticketChange($options = [], $apiCall = 'Answer', $bulk = true)
    {
        try {
            Thread::perform($apiCall, $options, $bulk);
        } catch (ErrorResponseException $e) {
            return false;
        }

        return true;
    }

    /**
     * @return string
     */
    public function actionGetQuotedAnswer()
    {
        $request = Yii::$app->request;
        if ($request->isAjax) {
            $id = $request->post('id');
            if ($id !== null) {
                try {
                    $answer = Thread::perform('GetAnswer', ['id' => $id]);
                } catch (ErrorResponseException $e) {

                }
                if (isset($answer['message'])) {
                    return '> ' . str_replace("\n", "\n> ", $answer['message']);
                }
            }
        }
        Yii::$app->end();
    }

    /**
     * @return mixed|string
     */
    public function actionPreview()
    {
        $request = Yii::$app->request;
        if ($request->isAjax) {
            $text = $request->post('text');
            if ($text) {
                return Thread::parseMessage($text);
            }
        }
        Yii::$app->end();
    }

    public function actionGetNewAnswers($id, $answer_id)
    {
        Yii::$app->response->format = Response::FORMAT_JSON;

        $result = ['id' => $id, 'answer_id' => $answer_id];

        try {
            $data = Thread::perform('GetLastAnswerId', ['id' => $id, 'answer_id' => $answer_id]);
            $result['answer_id'] = $data['answer_id'];
            if ($data['answer_id'] > $answer_id) {
                $dataProvider = (new ThreadSearch())->search([]);
                $dataProvider->query->joinWith('answers');
interface User
{
    /** @return string */
    public function getPassword();
}

class MyUser implements User
{
    public function getPassword()
    {
        // return something
    }

    public function getDisplayName()
    {
        // return some name.
    }
}

class AuthSystem
{
    public function authenticate(User $user)
    {
        $this->logger->info(sprintf('Authenticating %s.', $user->getDisplayName()));
        // do something.
    }
}
                $dataProvider->query->andWhere(['id' => $id]);
                $dataProvider->query->andWhere($this->getSearchOptions());
                $models = $dataProvider->getModels();

                $result['html'] = $this->renderPartial('_comments', ['model' => reset($models)]);
            }
        } catch (ErrorResponseException $e) {

        }

        return $result;
    }

    /**
     * @param $id
     * @param $object_id
     *
     * @return array|bool
     */
    public function actionFileView($id, $object_id)
    {
        return File::renderFile($id, $object_id, 'thread', true);
    }

    private function getSearchOptions()
    {
        return ['with_anonym' => 1, 'with_answers' => 1, 'with_files' => 1, 'show_closed' => 1];
    }

    public function getPriorities()
    {
        return $this->getRefs('type,priority', 'hipanel/ticket');
    }
}


Push — master ( 63ab7f...7e002b )

TicketController::actionTemplateText() A

Complexity

Size

Duplication

Code Coverage

Importance

Available Fixes

Available Fixes

Available Fixes

Available Fixes

Available Fixes

1			<?php
2
3			/*
4			* HiPanel tickets module
5			*
6			* @link https://github.com/hiqdev/hipanel-module-ticket
7			* @package hipanel-module-ticket
8			* @license BSD-3-Clause
9			* @copyright Copyright (c) 2015-2016, HiQDev (http://hiqdev.com/)
10			*/
11
12			namespace hipanel\modules\ticket\controllers;
13
14			use hipanel\actions\Action;
15			use hipanel\actions\IndexAction;
16			use hipanel\actions\OrientationAction;
17			use hipanel\actions\PrepareAjaxViewAction;
18			use hipanel\actions\PrepareBulkAction;
19			use hipanel\actions\ProxyAction;
20			use hipanel\actions\SearchAction;
21			use hipanel\actions\SmartCreateAction;
22			use hipanel\actions\SmartPerformAction;
23			use hipanel\actions\SmartUpdateAction;
24			use hipanel\actions\ValidateFormAction;
25			use hipanel\actions\ViewAction;
26			use hipanel\models\File;
27			use hipanel\models\Ref;
28			use hipanel\modules\client\models\Article;
29			use hipanel\modules\client\models\ArticleSearch;
30			use hipanel\modules\client\models\Client;
31			use hipanel\modules\ticket\models\Thread;
32			use hipanel\modules\ticket\models\ThreadSearch;
33			use hipanel\modules\ticket\models\TicketSettings;
34			use hiqdev\hiart\ErrorResponseException;
35			use Yii;
36			use yii\base\Event;
37			use yii\filters\PageCache;
38			use yii\helpers\ArrayHelper;
39			use yii\web\NotFoundHttpException;
40			use yii\web\Response;

hiqdev / hipanel-module-ticket

Push — master ( 63ab7f...7e002b )

TicketController::actionTemplateText() A

Complexity

Size

Duplication

Code Coverage

Importance

Available Fixes

Available Fixes

Available Fixes

Available Fixes

Available Fixes

Duplication Side-by-Side

Filter issues like