Controller::renderJson() - Code Metrics - Inspection of "+ enableCsrfCookie option to be configured properl..." - hiqdev/hipanel-core - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( 5a0a6c...47e90b )

by Andrii

created 2016-07-18 13:32 UTC

Controller::renderJson() A

↳ Parent: Controller

Complexity

Conditions	1
Paths	1

Size

Total Lines	6
Code Lines	3

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	0
CRAP Score	2

Importance

Changes

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

<?php

/*
 * HiPanel core package
 *
 * @link      https://hipanel.com/
 * @package   hipanel-core
 * @license   BSD-3-Clause
 * @copyright Copyright (c) 2014-2016, HiQDev (http://hiqdev.com/)
 */

namespace hipanel\base;

use hipanel\components\Cache;
use hipanel\components\Response;
use hiqdev\hiart\ActiveRecord;
use Yii;
use yii\di\Instance;
use yii\filters\AccessControl;
use yii\helpers\Inflector;
use yii\web\NotFoundHttpException;

/**
 * Site controller.
 */
class Controller extends \yii\web\Controller
{
    /**
     * @var Cache|array|string the cache object or the application component ID of the cache object.
     */
    protected $_cache = 'cache';

    public function setCache($cache)
    {
        $this->_cache = $cache;
    }

    public function getCache()
    {
        if (!is_object($this->_cache)) {
            $this->_cache = Instance::ensure($this->_cache, Cache::class);
        }

        return $this->_cache;
    }

    /**
     * @var array internal actions.
     */
    protected $_internalActions;

    /**
     * {@inheritdoc}
     */
    public function behaviors()
    {
        return [
            'access' => [
                'class' => AccessControl::class,
                'only'  => ['index'],
                'rules' => [
                    [
                        'actions' => ['index'],
                        'allow'   => true,
                        'roles'   => ['@'],
                    ],
                ],
            ],
        ];
    }

    /**
     * @param string $submodel the submodel that will be added to the ClassName
/**
 * @param array $germany
 * @param array $island
 * @param array $italy
 */
function finale($germany, $island) {
    return "2:1";
}
     * @return string Main Model class name
     */
    public static function modelClassName()
    {
        $parts = explode('\\', static::class);
        $last  = array_pop($parts);
        array_pop($parts);
        $parts[] = 'models';
        $parts[] = substr($last, 0, -10);

        return implode('\\', $parts);
    }

    /**
     * @param array $config config to be used to create the [[Model]]
     * @return ActiveRecord
     */
    public static function newModel($config = [], $submodel = '')
    {
        $config['class'] = static::modelClassName() . $submodel;
        return Yii::createObject($config);
    }

    /**
     * @param array $config config to be used to create the [[Model]]
     * @return ActiveRecord|SearchModelTrait Search Model object
     */
    public static function searchModel($config = [])
    {
        return static::newModel($config, 'Search');
    }

    /**
     * @return string main model's formName()
     */
    public static function formName()
    {
        return static::newModel()->formName();
    }

    /**
     * @return string search model's formName()
     */
    public static function searchFormName()
    {
        return static::newModel()->formName() . 'Search';
    }

    /**
     * @param string $separator
     * @return string Main model's camel2id'ed formName()
     */
    public static function modelId($separator = '-')
    {
        return Inflector::camel2id(static::formName(), $separator);
    }

    /**
     * Returns the module ID based on the namespace of the controller.
     * @return mixed
     */
    public static function moduleId()
    {
        return explode('\\', get_called_class())[2];
    }

    public static function controllerId()
    {
        return strtolower(substr(explode('\\', get_called_class())[4], 0, -10));
    }

    /**
     * @param int|array $condition scalar ID or array to be used for searching
     * @param array $config config to be used to create the [[Model]]
     * @throws NotFoundHttpException
     * @return array|ActiveRecord|null|static
     */
    public static function findModel($condition, $config = [])
    {
        /* @noinspection PhpVoidFunctionResultUsedInspection */
        $model = static::newModel($config)->findOne(is_array($condition) ? $condition : ['id' => $condition]);
        if ($model === null) {
            throw new NotFoundHttpException('The requested object not found.');
        }

        return $model;
    }

    public static function findModels($condition, $config = [])
    {
        $containsIntKeys = 0;
        if (is_array($condition)) {
            foreach (array_keys($condition) as $item) {
                if (is_numeric($item)) {
                    $containsIntKeys = true;
                    break;
                }
            }
        }

        if (!is_array($condition) || $containsIntKeys) {
            $condition = ['id' => $condition];
        }
        $models = static::searchModel($config)->search([static::searchFormName() => $condition], ['pagination' => false])->getModels();
        if ($models === null) {
            throw new NotFoundHttpException('The requested object not found.');
        }

        return $models;
    }

    public static function renderJson($data)
    {
        Yii::$app->response->format = Response::FORMAT_JSON;

        return $data;
    }

    public static function renderJsonp($data)
    {
        Yii::$app->response->format = Response::FORMAT_JSONP;

        return $data;
    }

    public function actionIndex()
    {
        return $this->render('index');
    }

    public function setInternalAction($id, $action)
    {
        $this->_internalActions[$id] = $action;
    }

    public function hasInternalAction($id)
    {
        return array_key_exists($id, $this->_internalActions);
    }

    public function createAction($id)
    {
        $config = $this->_internalActions[$id];
        return $config ? Yii::createObject($config, [$id, $this]) : parent::createAction($id);
    }

    /**
     * Prepares array for building url to action based on given action id and parameters.
     *
     * @param string $action action id
     * @param string|int|array $params ID of object to be action'ed or array of parameters
     * @return array array suitable for Url::to
     */
    public static function getActionUrl($action = 'index', $params = [])
    {
        $params = is_array($params) ? $params : ['id' => $params];
        return array_merge([implode('/', ['', static::moduleId(), static::controllerId(), $action])], $params);
    }

    /**
     * Prepares array for building url to search with given filters.
     */
    public static function getSearchUrl(array $params = [])
    {
        return static::getActionUrl('index', [static::searchFormName() => $params]);
    }
}


1		<?php
2
3		/*
4		* HiPanel core package
5		*
6		* @link https://hipanel.com/
7		* @package hipanel-core
8		* @license BSD-3-Clause
9		* @copyright Copyright (c) 2014-2016, HiQDev (http://hiqdev.com/)
10		*/
11
12		namespace hipanel\base;
13
14		use hipanel\components\Cache;
15		use hipanel\components\Response;
16		use hiqdev\hiart\ActiveRecord;
17		use Yii;
18		use yii\di\Instance;
19		use yii\filters\AccessControl;
20		use yii\helpers\Inflector;
21		use yii\web\NotFoundHttpException;
22
23		/**
24		* Site controller.
25		*/
26		class Controller extends \yii\web\Controller
27		{
28		/**
29		* @var Cache\|array\|string the cache object or the application component ID of the cache object.
30		*/
31		protected $_cache = 'cache';
32
33		public function setCache($cache)
34		{
35		$this->_cache = $cache;
36		}
37
38		public function getCache()
39		{
40		if (!is_object($this->_cache)) {
41		$this->_cache = Instance::ensure($this->_cache, Cache::class);
42		}
43
44		return $this->_cache;
45		}
46
47		/**
48		* @var array internal actions.
49		*/
50		protected $_internalActions;
51
52		/**
53		* {@inheritdoc}
54		*/
55	1	public function behaviors()
56		{
57		return [
58		'access' => [
59		'class' => AccessControl::class,
60		'only' => ['index'],
61		'rules' => [
62		[
63		'actions' => ['index'],
64		'allow' => true,
65		'roles' => ['@'],
66		],
67		],
68		],
69	1	];
70		}
71
72		/**
73		* @param string $submodel the submodel that will be added to the ClassName
		0 ignored issues – show Bug introduced 2016-03-31 13:05 UTC by Report Bug Copy Issue Report There is no parameter named `$submodel`. Was it maybe removed? This check looks for PHPDoc comments describing methods or function parameters that do not exist on the corresponding method or function. Consider the following example. The parameter `$italy` is not defined by the method `finale(...)`. /** * @param array $germany * @param array $island * @param array $italy */ function finale($germany, $island) { return "2:1"; } The most likely cause is that the parameter was removed, but the annotation was not. Loading history...
74		* @return string Main Model class name
75		*/
76		public static function modelClassName()
77		{
78		$parts = explode('\\', static::class);
79		$last = array_pop($parts);
80		array_pop($parts);
81		$parts[] = 'models';
82		$parts[] = substr($last, 0, -10);
83
84		return implode('\\', $parts);
85		}
86
87		/**
88		* @param array $config config to be used to create the [[Model]]
89		* @return ActiveRecord
90		*/
91		public static function newModel($config = [], $submodel = '')
92		{
93		$config['class'] = static::modelClassName() . $submodel;
94		return Yii::createObject($config);
95		}
96
97		/**
98		* @param array $config config to be used to create the [[Model]]
99		* @return ActiveRecord\|SearchModelTrait Search Model object
100		*/
101		public static function searchModel($config = [])
102		{
103		return static::newModel($config, 'Search');
104		}
105
106		/**
107		* @return string main model's formName()
108		*/
109		public static function formName()
110		{
111		return static::newModel()->formName();
112		}
113
114		/**
115		* @return string search model's formName()
116		*/
117		public static function searchFormName()
118		{
119		return static::newModel()->formName() . 'Search';
120		}
121
122		/**
123		* @param string $separator
124		* @return string Main model's camel2id'ed formName()
125		*/
126		public static function modelId($separator = '-')
127		{
128		return Inflector::camel2id(static::formName(), $separator);
129		}
130
131		/**
132		* Returns the module ID based on the namespace of the controller.
133		* @return mixed
134		*/
135		public static function moduleId()
136		{
137		return explode('\\', get_called_class())[2];
138		}
139
140		public static function controllerId()
141		{
142		return strtolower(substr(explode('\\', get_called_class())[4], 0, -10));
143		}
144
145		/**
146		* @param int\|array $condition scalar ID or array to be used for searching
147		* @param array $config config to be used to create the [[Model]]
148		* @throws NotFoundHttpException
149		* @return array\|ActiveRecord\|null\|static
150		*/
151		public static function findModel($condition, $config = [])
152		{
153		/* @noinspection PhpVoidFunctionResultUsedInspection */
154		$model = static::newModel($config)->findOne(is_array($condition) ? $condition : ['id' => $condition]);
155		if ($model === null) {
156		throw new NotFoundHttpException('The requested object not found.');
157		}
158
159		return $model;
160		}
161
162		public static function findModels($condition, $config = [])
163		{
164		$containsIntKeys = 0;
165		if (is_array($condition)) {
166		foreach (array_keys($condition) as $item) {
167		if (is_numeric($item)) {
168		$containsIntKeys = true;
169		break;
170		}
171		}
172		}
173
174		if (!is_array($condition) \|\| $containsIntKeys) {
175		$condition = ['id' => $condition];
176		}
177		$models = static::searchModel($config)->search([static::searchFormName() => $condition], ['pagination' => false])->getModels();
178		if ($models === null) {
179		throw new NotFoundHttpException('The requested object not found.');
180		}
181
182		return $models;
183		}
184
185		public static function renderJson($data)
186		{
187		Yii::$app->response->format = Response::FORMAT_JSON;
188
189		return $data;
190		}
191
192		public static function renderJsonp($data)
193		{
194		Yii::$app->response->format = Response::FORMAT_JSONP;
195
196		return $data;
197		}
198
199		public function actionIndex()
200		{
201		return $this->render('index');
202		}
203
204		public function setInternalAction($id, $action)
205		{
206		$this->_internalActions[$id] = $action;
207		}
208
209		public function hasInternalAction($id)
210		{
211		return array_key_exists($id, $this->_internalActions);
212		}
213
214		public function createAction($id)
215		{
216		$config = $this->_internalActions[$id];
217		return $config ? Yii::createObject($config, [$id, $this]) : parent::createAction($id);
218		}
219
220		/**
221		* Prepares array for building url to action based on given action id and parameters.
222		*
223		* @param string $action action id
224		* @param string\|int\|array $params ID of object to be action'ed or array of parameters
225		* @return array array suitable for Url::to
226		*/
227		public static function getActionUrl($action = 'index', $params = [])
228		{
229		$params = is_array($params) ? $params : ['id' => $params];
230		return array_merge([implode('/', ['', static::moduleId(), static::controllerId(), $action])], $params);
231		}
232
233		/**
234		* Prepares array for building url to search with given filters.
235		*/
236		public static function getSearchUrl(array $params = [])
237		{
238		return static::getActionUrl('index', [static::searchFormName() => $params]);
239		}
240		}
241

hiqdev / hipanel-core

Push — master ( 5a0a6c...47e90b )

Controller::renderJson() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like