MenuController::actionIndex() - Code Metrics - writesdown/app-cms - Measure and Improve Code Quality continuously with Scrutinizer

MenuController::actionIndex() B
last analyzed 2016-04-17 09:32 UTC

↳ Parent: MenuController

Complexity

Conditions	5
Paths	3

Size

Total Lines	22
Code Lines	15

Duplication

Lines	0
Ratio	0 %

Importance

Changes	4
Bugs	0	Features	0

Metric	Value
c	4
b	0
f	0
dl	0
loc	22
rs	8.6737
cc	5
eloc	15
nc	3
nop	1

<?php
/**
 * @link http://www.writesdown.com/
 * @copyright Copyright (c) 2015 WritesDown
 * @license http://www.writesdown.com/license/
 */

namespace backend\controllers;

use common\components\Json;
use common\models\Menu;
use common\models\MenuItem;
use common\models\Post;
use common\models\PostType;
use common\models\Taxonomy;
use common\models\Term;
use Yii;
use yii\filters\AccessControl;
use yii\filters\VerbFilter;
use yii\helpers\ArrayHelper;
use yii\web\Controller;
use yii\web\NotFoundHttpException;

/**
 * MenuController, controlling the actions for Menu and MenuItem model.
 *
 * @author Agiel K. Saputra <[email protected]>
 * @since 0.1.0
 */
class MenuController extends Controller
{
    /**
     * @inheritdoc
     */
    public function behaviors()

    {
        return [
            'access' => [
                'class' => AccessControl::className(),
                'rules' => [
                    [
                        'actions' => ['index', 'update', 'create', 'delete', 'create-menu-item', 'delete-menu-item'],
                        'allow' => true,
                        'roles' => ['administrator'],
                    ],
                ],
            ],
            'verbs' => [
                'class' => VerbFilter::className(),
                'actions' => [
                    'delete' => ['post'],
                    'update' => ['post'],
                    'create-menu-item' => ['post'],
                    'delete-menu-item' => ['post'],
                ],
            ],
        ];
    }

    /**
     * Displays menu page consists of CRUD for Menu and MenuItem model.
     *
     * @param null $id
     * @return mixed
     */
    public function actionIndex($id = null)
    {
        $model = new Menu();
        $postTypes = PostType::find()->where(['menu_builder' => PostType::MENU_BUILDER])->all();
        $taxonomies = Taxonomy::find()->where(['menu_builder' => Taxonomy::MENU_BUILDER])->all();

        if ($available = ArrayHelper::map(Menu::find()->all(), 'id', 'title')) {
            if ($id === null && $available) {

                reset($available);
                $id = key($available);
            }
            $selected = $this->findModel($id);
        }

        return $this->render('index', [
            'model' => $model,
            'available' => $available,
            'selected' => isset($selected) ? $selected : null,
            'postTypes' => $postTypes,
            'taxonomies' => $taxonomies,
        ]);
    }

    /**
     * Creates a new Menu model.
     * If creation is successful, the browser will be redirected to the 'index' page.
     *
     * @return mixed
     */
    public function actionCreate()
    {
        $model = new Menu();

        if ($model->load(Yii::$app->request->post()) && $model->save()) {
            return $this->redirect(['index', 'id' => $model->id]);
        }

        return $this->redirect(['index']);
    }

    /**
     * Updates an existing Menu model.
     * If update is successful, the browser will be redirected to the 'view' page.
     *
     * @param integer $id
     * @return mixed
     */
    public function actionUpdate($id)
    {
        $model = $this->findModel($id);

        if ($model->load(Yii::$app->request->post()) && $model->save()) {

            if ($menuOrder = Yii::$app->request->post('MenuOrder')) {
                $this->saveMenuItem(Json::decode($menuOrder));
            }
        }

        Yii::$app->getSession()->setFlash('success', Yii::t('writesdown', 'Menu successfully 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.
}

        return $this->redirect(['/menu/index', 'id' => $id]);
    }

    /**
     * Deletes an existing Menu model.
     * If deletion is successful, the browser will be redirected to the 'index' page.
     *
     * @return mixed
     * @throws NotFoundHttpException
     * @throws \Exception
     */
    public function actionDelete()
    {
        $id = Yii::$app->request->post('id');
        $this->findModel($id)->delete();


        return $this->redirect(['index']);
    }

    /**
     * Create MenuItem models.
     *
     * @param int $id
     * @return string
     */
    public function actionCreateMenuItem($id)
    {
        $items = '';

        if (Yii::$app->request->post('type') === 'link') {
            $model = new MenuItem();
            $model->menu_id = $id;
            if ($model->load(Yii::$app->request->post()) && $model->save()) {
                $items .= $this->renderPartial('_render-item', ['item' => $model, 'wrap' => 'true']);
            }
        }

        if (Yii::$app->request->post('type') === 'post' && $postIds = Yii::$app->request->post('postIds')) {

            foreach ($postIds as $postId) {
                if ($post = $this->findPost($postId)) {
                    $model = new MenuItem([
                        'menu_id' => $id,
                        'label' => $post->title,
                        'url' => $post->getUrl(),

                    ]);
                    if ($model->save()) {
                        $items .= $this->renderPartial('_render-item', ['item' => $model, 'wrap' => 'true']);
                    }
                }
            }
        }

        if (Yii::$app->request->post('type') === 'taxonomy' && $termIds = Yii::$app->request->post('termIds')) {

            foreach ($termIds as $termId) {
                if ($term = $this->findTerm($termId)) {
                    $model = new MenuItem([
                        'menu_id' => $id,
                        'label' => $term->name,
                        'url' => $term->getUrl(),

                    ]);
                    if ($model->save()) {
                        $items .= $this->renderPartial('_render-item', ['item' => $model, 'wrap' => 'true']);
                    }
                }
            }
        }

        return $items;
    }

    /**
     * Delete an existing MenuItem model via AJAX request.
     *
     * @throws NotFoundHttpException
     * @throws \Exception
     */
    public function actionDeleteMenuItem()
    {
        /* @var $children \common\models\MenuItem[] */
        if ($id = Yii::$app->request->post('id')) {
            $model = $this->findMenuItem($id);
            if ($model && $model->delete()) {

                $children = MenuItem::find()->where(['parent' => $model->id])->all();
                foreach ($children as $child) {
                    $child->updateAttributes(['parent' => $model->parent]);
                }
            } else {
                throw new NotFoundHttpException(Yii::t('writesdown', 'The requested page does not exist.'));
            }
        }
    }

    /**
     * Save menu item recursively based on parent and child.
     *
     * @param array $menuOrder
     * @param int $menuParent
     */
    protected function saveMenuItem($menuOrder, $menuParent = 0)
    {
        foreach ($menuOrder as $key => $order) {
            $menuItem = Yii::$app->request->post('MenuItem')[$order['id']];
            if ($model = $this->findMenuItem($order['id'])) {
                $model->setAttributes($menuItem);

                $model->setAttributes([

                    'parent' => $menuParent,
                    'order' => $key,
                ]);
                if ($model->save()) {

                    if ($orderItems = ArrayHelper::getValue($order, 'items')) {
                        $this->saveMenuItem($orderItems, $model->id);
                    }
                }
            }
        }
    }

    /**
     * Finds the Menu model based on its primary key value.
     * If the model is not found, a 404 HTTP exception will be thrown.
     *
     * @param integer $id
     * @return Menu the loaded model
     * @throws NotFoundHttpException if the model cannot be found
     */
    protected function findModel($id)
    {
        if (($model = Menu::findOne($id)) !== null) {
            return $model;
        }

        throw new NotFoundHttpException(Yii::t('writesdown', 'The requested page does not exist.'));
    }

    /**
     * Finds the MenuItem model based on its primary key value.
     * If the model is not found, it will return false.
     *
     * @param integer $id
     * @return MenuItem the loaded model
     * @throws NotFoundHttpException if the model cannot be found
     */
    protected function findMenuItem($id)
    {
        if (($model = MenuItem::findOne($id)) !== null) {
            return $model;
        }

        throw new NotFoundHttpException(Yii::t('writesdown', 'The requested page does not exist.'));
    }

    /**
     * Finds the Post model based on its primary key value.
     * If the model is not found, it will return false.
     *
     * @param integer $id
     * @return Post the loaded model
     * @throws NotFoundHttpException if the model cannot be found
     */
    protected function findPost($id)
    {
        if (($model = Post::findOne($id)) !== null) {
            return $model;
        }

        throw new NotFoundHttpException(Yii::t('writesdown', 'The requested page does not exist.'));
    }

    /**
     * Finds the Term model based on its primary key value.
     * If the model is not found, it will return false.
     *
     * @param integer $id
     * @return Term the loaded model
     * @throws NotFoundHttpException if the model cannot be found
     */
    protected function findTerm($id)
    {
        if (($model = Term::findOne($id)) !== null) {
            return $model;
        }

        throw new NotFoundHttpException(Yii::t('writesdown', 'The requested page does not exist.'));
    }
}


1		<?php
2		/**
3		* @link http://www.writesdown.com/
4		* @copyright Copyright (c) 2015 WritesDown
5		* @license http://www.writesdown.com/license/
6		*/
7
8		namespace backend\controllers;
9
10		use common\components\Json;
11		use common\models\Menu;
12		use common\models\MenuItem;
13		use common\models\Post;
14		use common\models\PostType;
15		use common\models\Taxonomy;
16		use common\models\Term;
17		use Yii;
18		use yii\filters\AccessControl;
19		use yii\filters\VerbFilter;
20		use yii\helpers\ArrayHelper;
21		use yii\web\Controller;
22		use yii\web\NotFoundHttpException;
23
24		/**
25		* MenuController, controlling the actions for Menu and MenuItem model.
26		*
27		* @author Agiel K. Saputra <[email protected]>
28		* @since 0.1.0
29		*/
30		class MenuController extends Controller
31		{
32		/**
33		* @inheritdoc
34		*/
35	View Code Duplication	public function behaviors()
		0 ignored issues – show Duplication introduced 2016-02-11 01:42 UTC by Report Bug Copy Issue Report This method seems to be duplicated in your project. Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation. You can also find more detailed suggestions in the “Code” section of your repository. Loading history...
36		{
37		return [
38		'access' => [
39		'class' => AccessControl::className(),
40		'rules' => [
41		[
42		'actions' => ['index', 'update', 'create', 'delete', 'create-menu-item', 'delete-menu-item'],
43		'allow' => true,
44		'roles' => ['administrator'],
45		],
46		],
47		],
48		'verbs' => [
49		'class' => VerbFilter::className(),
50		'actions' => [
51		'delete' => ['post'],
52		'update' => ['post'],
53		'create-menu-item' => ['post'],
54		'delete-menu-item' => ['post'],
55		],
56		],
57		];
58		}
59
60		/**
61		* Displays menu page consists of CRUD for Menu and MenuItem model.
62		*
63		* @param null $id
64		* @return mixed
65		*/
66		public function actionIndex($id = null)
67		{
68		$model = new Menu();
69		$postTypes = PostType::find()->where(['menu_builder' => PostType::MENU_BUILDER])->all();
70		$taxonomies = Taxonomy::find()->where(['menu_builder' => Taxonomy::MENU_BUILDER])->all();
71
72		if ($available = ArrayHelper::map(Menu::find()->all(), 'id', 'title')) {
73		if ($id === null && $available) {
		0 ignored issues – show Bug Best Practice introduced 2016-02-11 01:42 UTC by Report Bug Copy Issue Report The expression `$available` of type `array` is implicitly converted to a boolean; are you sure this is intended? If so, consider using `! empty($expr)` instead to make it clear that you intend to check for an array without elements. This check marks implicit conversions of arrays to boolean values in a comparison. While in PHP an empty array is considered to be equal (but not identical) to false, this is not always apparent. Consider making the comparison explicit by using `empty(..)` or `! empty(...)` instead. Loading history...
74		reset($available);
75		$id = key($available);
76		}
77		$selected = $this->findModel($id);
78		}
79
80		return $this->render('index', [
81		'model' => $model,
82		'available' => $available,
83		'selected' => isset($selected) ? $selected : null,
84		'postTypes' => $postTypes,
85		'taxonomies' => $taxonomies,
86		]);
87		}
88
89		/**
90		* Creates a new Menu model.
91		* If creation is successful, the browser will be redirected to the 'index' page.
92		*
93		* @return mixed
94		*/
95		public function actionCreate()
96		{
97		$model = new Menu();
98
99		if ($model->load(Yii::$app->request->post()) && $model->save()) {
100		return $this->redirect(['index', 'id' => $model->id]);
101		}
102
103		return $this->redirect(['index']);
104		}
105
106		/**
107		* Updates an existing Menu model.
108		* If update is successful, the browser will be redirected to the 'view' page.
109		*
110		* @param integer $id
111		* @return mixed
112		*/
113		public function actionUpdate($id)
114		{
115		$model = $this->findModel($id);
116
117		if ($model->load(Yii::$app->request->post()) && $model->save()) {
		0 ignored issues – show Bug introduced 2016-02-11 01:42 UTC by Report Bug Copy Issue Report The method `load` cannot be called on `$model` (of type `array\|boolean`). Methods can only be called on objects. This check looks for methods being called on variables that have been inferred to never be objects. Loading history... Bug introduced 2016-02-11 01:42 UTC by Report Bug Copy Issue Report The method `save` cannot be called on `$model` (of type `array\|boolean`). Methods can only be called on objects. This check looks for methods being called on variables that have been inferred to never be objects. Loading history...
118		if ($menuOrder = Yii::$app->request->post('MenuOrder')) {
119		$this->saveMenuItem(Json::decode($menuOrder));
120		}
121		}
122
123		Yii::$app->getSession()->setFlash('success', Yii::t('writesdown', 'Menu successfully saved.'));
		0 ignored issues – show Bug introduced 2016-02-11 01:42 UTC by Report Bug Copy Issue Report The method `getSession` does only exist in `yii\web\Application`, but not in `yii\console\Application`. It seems like the method you are trying to call exists only in some of the possible types. Let’s take a look at an example: 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. } Available Fixes Add an additional type-check: /* * @param A\|B $x / function someFunction($x) { $x->foo(); if ($x instanceof B) { $x->bar(); } } Only allow a single type to be passed if the variable comes from a parameter: function someFunction(B $x) { /* ... */ } Loading history...
124
125		return $this->redirect(['/menu/index', 'id' => $id]);
126		}
127
128		/**
129		* Deletes an existing Menu model.
130		* If deletion is successful, the browser will be redirected to the 'index' page.
131		*
132		* @return mixed
133		* @throws NotFoundHttpException
134		* @throws \Exception
135		*/
136		public function actionDelete()
137		{
138		$id = Yii::$app->request->post('id');
139		$this->findModel($id)->delete();
		0 ignored issues – show Bug introduced 2016-02-11 01:42 UTC by Report Bug Copy Issue Report The method `delete` cannot be called on `$this->findModel($id)` (of type `array\|boolean`). Methods can only be called on objects. This check looks for methods being called on variables that have been inferred to never be objects. Loading history...
140
141		return $this->redirect(['index']);
142		}
143
144		/**
145		* Create MenuItem models.
146		*
147		* @param int $id
148		* @return string
149		*/
150		public function actionCreateMenuItem($id)
151		{
152		$items = '';
153
154		if (Yii::$app->request->post('type') === 'link') {
155		$model = new MenuItem();
156		$model->menu_id = $id;
157		if ($model->load(Yii::$app->request->post()) && $model->save()) {
158		$items .= $this->renderPartial('_render-item', ['item' => $model, 'wrap' => 'true']);
159		}
160		}
161
162	View Code Duplication	if (Yii::$app->request->post('type') === 'post' && $postIds = Yii::$app->request->post('postIds')) {
		0 ignored issues – show Duplication introduced 2016-02-11 01:42 UTC by Report Bug Copy Issue Report This code seems to be duplicated across your project. Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation. You can also find more detailed suggestions in the “Code” section of your repository. Loading history...
163		foreach ($postIds as $postId) {
164		if ($post = $this->findPost($postId)) {
165		$model = new MenuItem([
166		'menu_id' => $id,
167		'label' => $post->title,
168		'url' => $post->getUrl(),
		0 ignored issues – show Bug introduced 2016-02-11 01:42 UTC by Report Bug Copy Issue Report The method `getUrl` cannot be called on `$post` (of type `array\|boolean`). Methods can only be called on objects. This check looks for methods being called on variables that have been inferred to never be objects. Loading history...
169		]);
170		if ($model->save()) {
171		$items .= $this->renderPartial('_render-item', ['item' => $model, 'wrap' => 'true']);
172		}
173		}
174		}
175		}
176
177	View Code Duplication	if (Yii::$app->request->post('type') === 'taxonomy' && $termIds = Yii::$app->request->post('termIds')) {
		0 ignored issues – show Duplication introduced 2016-02-11 01:42 UTC by Report Bug Copy Issue Report This code seems to be duplicated across your project. Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation. You can also find more detailed suggestions in the “Code” section of your repository. Loading history...
178		foreach ($termIds as $termId) {
179		if ($term = $this->findTerm($termId)) {
180		$model = new MenuItem([
181		'menu_id' => $id,
182		'label' => $term->name,
183		'url' => $term->getUrl(),
		0 ignored issues – show Bug introduced 2016-02-11 01:42 UTC by Report Bug Copy Issue Report The method `getUrl` cannot be called on `$term` (of type `array\|boolean`). Methods can only be called on objects. This check looks for methods being called on variables that have been inferred to never be objects. Loading history...
184		]);
185		if ($model->save()) {
186		$items .= $this->renderPartial('_render-item', ['item' => $model, 'wrap' => 'true']);
187		}
188		}
189		}
190		}
191
192		return $items;
193		}
194
195		/**
196		* Delete an existing MenuItem model via AJAX request.
197		*
198		* @throws NotFoundHttpException
199		* @throws \Exception
200		*/
201		public function actionDeleteMenuItem()
202		{
203		/* @var $children \common\models\MenuItem[] */
204		if ($id = Yii::$app->request->post('id')) {
205		$model = $this->findMenuItem($id);
206		if ($model && $model->delete()) {
		0 ignored issues – show Bug introduced 2016-02-11 01:42 UTC by Report Bug Copy Issue Report The method `delete` cannot be called on `$model` (of type `array\|boolean`). Methods can only be called on objects. This check looks for methods being called on variables that have been inferred to never be objects. Loading history...
207		$children = MenuItem::find()->where(['parent' => $model->id])->all();
208		foreach ($children as $child) {
209		$child->updateAttributes(['parent' => $model->parent]);
210		}
211		} else {
212		throw new NotFoundHttpException(Yii::t('writesdown', 'The requested page does not exist.'));
213		}
214		}
215		}
216
217		/**
218		* Save menu item recursively based on parent and child.
219		*
220		* @param array $menuOrder
221		* @param int $menuParent
222		*/
223		protected function saveMenuItem($menuOrder, $menuParent = 0)
224		{
225		foreach ($menuOrder as $key => $order) {
226		$menuItem = Yii::$app->request->post('MenuItem')[$order['id']];
227		if ($model = $this->findMenuItem($order['id'])) {
228		$model->setAttributes($menuItem);
		0 ignored issues – show Bug introduced 2016-02-11 01:42 UTC by Report Bug Copy Issue Report The method `setAttributes` cannot be called on `$model` (of type `array\|boolean`). Methods can only be called on objects. This check looks for methods being called on variables that have been inferred to never be objects. Loading history...
229		$model->setAttributes([
		0 ignored issues – show Bug introduced 2016-02-11 01:42 UTC by Report Bug Copy Issue Report The method `setAttributes` cannot be called on `$model` (of type `array\|boolean`). Methods can only be called on objects. This check looks for methods being called on variables that have been inferred to never be objects. Loading history...
230		'parent' => $menuParent,
231		'order' => $key,
232		]);
233		if ($model->save()) {
		0 ignored issues – show Bug introduced 2016-02-11 01:42 UTC by Report Bug Copy Issue Report The method `save` cannot be called on `$model` (of type `array\|boolean`). Methods can only be called on objects. This check looks for methods being called on variables that have been inferred to never be objects. Loading history...
234		if ($orderItems = ArrayHelper::getValue($order, 'items')) {
235		$this->saveMenuItem($orderItems, $model->id);
236		}
237		}
238		}
239		}
240		}
241
242		/**
243		* Finds the Menu model based on its primary key value.
244		* If the model is not found, a 404 HTTP exception will be thrown.
245		*
246		* @param integer $id
247		* @return Menu the loaded model
248		* @throws NotFoundHttpException if the model cannot be found
249		*/
250		protected function findModel($id)
251		{
252		if (($model = Menu::findOne($id)) !== null) {
253		return $model;
254		}
255
256		throw new NotFoundHttpException(Yii::t('writesdown', 'The requested page does not exist.'));
257		}
258
259		/**
260		* Finds the MenuItem model based on its primary key value.
261		* If the model is not found, it will return false.
262		*
263		* @param integer $id
264		* @return MenuItem the loaded model
265		* @throws NotFoundHttpException if the model cannot be found
266		*/
267		protected function findMenuItem($id)
268		{
269		if (($model = MenuItem::findOne($id)) !== null) {
270		return $model;
271		}
272
273		throw new NotFoundHttpException(Yii::t('writesdown', 'The requested page does not exist.'));
274		}
275
276		/**
277		* Finds the Post model based on its primary key value.
278		* If the model is not found, it will return false.
279		*
280		* @param integer $id
281		* @return Post the loaded model
282		* @throws NotFoundHttpException if the model cannot be found
283		*/
284		protected function findPost($id)
285		{
286		if (($model = Post::findOne($id)) !== null) {
287		return $model;
288		}
289
290		throw new NotFoundHttpException(Yii::t('writesdown', 'The requested page does not exist.'));
291		}
292
293		/**
294		* Finds the Term model based on its primary key value.
295		* If the model is not found, it will return false.
296		*
297		* @param integer $id
298		* @return Term the loaded model
299		* @throws NotFoundHttpException if the model cannot be found
300		*/
301		protected function findTerm($id)
302		{
303		if (($model = Term::findOne($id)) !== null) {
304		return $model;
305		}
306
307		throw new NotFoundHttpException(Yii::t('writesdown', 'The requested page does not exist.'));
308		}
309		}
310

writesdown / app-cms

MenuController::actionIndex() B last analyzed 2016-04-17 09:32 UTC

Complexity

Size

Duplication

Importance

Available Fixes

Duplication Side-by-Side

Filter issues like

MenuController::actionIndex() B
last analyzed 2016-04-17 09:32 UTC