MenuItemController - Code Metrics - Inspection of "Introducing menu types" - AsgardCms/Menu - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Pull Request — 2.0 (#31)

by Nicolas

created 2016-08-02 13:48 UTC

MenuItemController A

↳ Parent: Project

Complexity

Total Complexity

Size/Duplication

Total Lines	156
Duplicated Lines	8.97 %

Coupling/Cohesion

Components	1
Dependencies	4

Importance

Changes	8
Bugs	0	Features	0

Metric	Value
wmc	24
c	8
b	0
f	0
lcom	1
cbo	4
dl	14
loc	156
rs	10

11 Methods

Rating	Name	Duplication	Size	Complexity
A	__construct()	0	6	1
A	create()	0	8	1
A	store()	7	7	1
A	edit()	0	8	1
A	update()	7	7	1
A	destroy()	0	7	1
A	getMenuSelect()	0	4	1
B	addMenuId()	0	16	5
C	getUri()	0	28	8
A	getPageSlug()	0	11	2
A	getParentUri()	0	4	2

How to fix Duplicated Code

<?php

namespace Modules\Menu\Http\Controllers\Admin;

use Illuminate\Foundation\Http\FormRequest;
use Mcamara\LaravelLocalization\Facades\LaravelLocalization;
use Modules\Core\Http\Controllers\Admin\AdminBaseController;
use Modules\Menu\Entities\Menu;
use Modules\Menu\Entities\Menuitem;
use Modules\Menu\Http\Requests\CreateMenuItemRequest;
use Modules\Menu\Http\Requests\UpdateMenuItemRequest;
use Modules\Menu\Repositories\MenuItemRepository;
use Modules\Page\Repositories\PageRepository;

class MenuItemController extends AdminBaseController
{
    /**
     * @var MenuItemRepository
     */
    private $menuItem;
    /**
     * @var PageRepository
     */
    private $page;

    public function __construct(MenuItemRepository $menuItem, PageRepository $page)
    {
        parent::__construct();
        $this->menuItem = $menuItem;
        $this->page = $page;
    }

    public function create(Menu $menu)
    {
        $pages = $this->page->all();

        $menuSelect = $this->getMenuSelect($menu);

        return view('menu::admin.menuitems.create', compact('menu', 'pages', 'menuSelect'));
    }

    public function store(Menu $menu, CreateMenuItemRequest $request)

    {
        $this->menuItem->create($this->addMenuId($menu, $request));

        return redirect()->route('admin.menu.menu.edit', [$menu->id])
<?php

/**
 * @property int $x
 * @property int $y
 * @property string $text
 */
class MyLabel
{
    private $properties;

    private $allowedProperties = array('x', 'y', 'text');

    public function __get($name)
    {
        if (isset($properties[$name]) && in_array($name, $this->allowedProperties)) {
            return $properties[$name];
        } else {
            return null;
        }
    }

    public function __set($name, $value)
    {
        if (in_array($name, $this->allowedProperties)) {
            $properties[$name] = $value;
        } else {
            throw new \LogicException("Property $name is not defined.");
        }
    }

}
            ->withSuccess(trans('menu::messages.menuitem created'));
    }

    public function edit(Menu $menu, Menuitem $menuItem)
    {
        $pages = $this->page->all();

        $menuSelect = $this->getMenuSelect($menu);

        return view('menu::admin.menuitems.edit', compact('menu', 'menuItem', 'pages', 'menuSelect'));
    }

    public function update(Menu $menu, Menuitem $menuItem, UpdateMenuItemRequest $request)

    {
        $this->menuItem->update($menuItem, $this->addMenuId($menu, $request));

        return redirect()->route('admin.menu.menu.edit', [$menu->id])
<?php

/**
 * @property int $x
 * @property int $y
 * @property string $text
 */
class MyLabel
{
    private $properties;

    private $allowedProperties = array('x', 'y', 'text');

    public function __get($name)
    {
        if (isset($properties[$name]) && in_array($name, $this->allowedProperties)) {
            return $properties[$name];
        } else {
            return null;
        }
    }

    public function __set($name, $value)
    {
        if (in_array($name, $this->allowedProperties)) {
            $properties[$name] = $value;
        } else {
            throw new \LogicException("Property $name is not defined.");
        }
    }

}
            ->withSuccess(trans('menu::messages.menuitem updated'));
    }

    public function destroy(Menu $menu, Menuitem $menuItem)
    {
        $this->menuItem->destroy($menuItem);

        return redirect()->route('admin.menu.menu.edit', [$menu->id])
<?php

/**
 * @property int $x
 * @property int $y
 * @property string $text
 */
class MyLabel
{
    private $properties;

    private $allowedProperties = array('x', 'y', 'text');

    public function __get($name)
    {
        if (isset($properties[$name]) && in_array($name, $this->allowedProperties)) {
            return $properties[$name];
        } else {
            return null;
        }
    }

    public function __set($name, $value)
    {
        if (in_array($name, $this->allowedProperties)) {
            $properties[$name] = $value;
        } else {
            throw new \LogicException("Property $name is not defined.");
        }
    }

}
            ->withSuccess(trans('menu::messages.menuitem deleted'));
    }

    /**
     * @param Menu, $menuItemId
/**
 * @param array $germany
 * @param array $island
 * @param array $italy
 */
function finale($germany, $island) {
    return "2:1";
}
     * @return array
     */
    private function getMenuSelect($menu)
    {
        return $menu->menuitems()->where('is_root', '!=', true)->get()->nest()->listsFlattened('title');
    }

    /**
     * @param  Menu $menu
     * @param  \Illuminate\Foundation\Http\FormRequest $request
     * @return array
     */
    private function addMenuId(Menu $menu, FormRequest $request)
    {
        $data = $request->all();

        foreach (LaravelLocalization::getSupportedLanguagesKeys() as $lang) {
            if ($data['link_type'] === 'page' && ! empty($data['page_id'])) {
                $data[$lang]['uri'] = $this->getUri($data['page_id'], $data['parent_id'], $lang);
            }
        }

        if (empty($data['parent_id'])) {
            $data['parent_id'] = $this->menuItem->getRootForMenu($menu->id)->id;
<?php

/**
 * @property int $x
 * @property int $y
 * @property string $text
 */
class MyLabel
{
    private $properties;

    private $allowedProperties = array('x', 'y', 'text');

    public function __get($name)
    {
        if (isset($properties[$name]) && in_array($name, $this->allowedProperties)) {
            return $properties[$name];
        } else {
            return null;
        }
    }

    public function __set($name, $value)
    {
        if (in_array($name, $this->allowedProperties)) {
            $properties[$name] = $value;
        } else {
            throw new \LogicException("Property $name is not defined.");
        }
    }

}
        }

        return array_merge($data, ['menu_id' => $menu->id]);
<?php

/**
 * @property int $x
 * @property int $y
 * @property string $text
 */
class MyLabel
{
    private $properties;

    private $allowedProperties = array('x', 'y', 'text');

    public function __get($name)
    {
        if (isset($properties[$name]) && in_array($name, $this->allowedProperties)) {
            return $properties[$name];
        } else {
            return null;
        }
    }

    public function __set($name, $value)
    {
        if (in_array($name, $this->allowedProperties)) {
            $properties[$name] = $value;
        } else {
            throw new \LogicException("Property $name is not defined.");
        }
    }

}
    }

    /**
     * Get uri
     * @param string $pageId
     * @param string $parentId
     * @param string $lang
     * @return string
     */
    private function getUri($pageId, $parentId, $lang)
    {
        $linkPathArray = [];

        $linkPathArray[] = $this->getPageSlug($pageId, $lang);

        if ($parentId !== '') {
            $hasParentItem = !(is_null($parentId)) ? true : false;
            while ($hasParentItem) {
                $parentItemId = isset($parentItem) ? $parentItem->parent_id : $parentId;
                $parentItem = $this->menuItem->find($parentItemId);

                if ($parentItem->is_root === 0) {
                    if ($parentItem->page_id !== '') {
                        $linkPathArray[] = $this->getPageSlug($parentItem->page_id, $lang);
                    } else {
                        $linkPathArray[] = $this->getParentUri($parentItem, $linkPathArray);
                    }
                    $hasParentItem = !is_null($parentItem->parent_id) ? true : false;
                } else {
                    $hasParentItem = false;
                }
            }
        }
        $parentLinkPath = implode('/', array_reverse($linkPathArray));

        return $parentLinkPath;
    }

    /**
     * Get page slug
     *
     * @params $pageId, $lang
     * @return string
     */
    private function getPageSlug($id, $lang)
    {
        $page = $this->page->find($id);
        $translation = $page->translate($lang);

        if ($translation === null) {
            return $page->translate(config('app.fallback_locale'))->slug;
        }

        return $translation->slug;
    }

    /**
     * Get parent uri
     *
     * @params $pageId, $lang
     * @return string
     */
    private function getParentUri($item, $linkPathArray)
    {
        return ! is_null($item->uri) ? $item->uri . '/' . implode('/', $linkPathArray) : implode('/', $linkPathArray);
    }
}


1		<?php
2
3		namespace Modules\Menu\Http\Controllers\Admin;
4
5		use Illuminate\Foundation\Http\FormRequest;
6		use Mcamara\LaravelLocalization\Facades\LaravelLocalization;
7		use Modules\Core\Http\Controllers\Admin\AdminBaseController;
8		use Modules\Menu\Entities\Menu;
9		use Modules\Menu\Entities\Menuitem;
10		use Modules\Menu\Http\Requests\CreateMenuItemRequest;
11		use Modules\Menu\Http\Requests\UpdateMenuItemRequest;
12		use Modules\Menu\Repositories\MenuItemRepository;
13		use Modules\Page\Repositories\PageRepository;
14
15		class MenuItemController extends AdminBaseController
16		{
17		/**
18		* @var MenuItemRepository
19		*/
20		private $menuItem;
21		/**
22		* @var PageRepository
23		*/
24		private $page;
25
26		public function __construct(MenuItemRepository $menuItem, PageRepository $page)
27		{
28		parent::__construct();
29		$this->menuItem = $menuItem;
30		$this->page = $page;
31		}
32
33		public function create(Menu $menu)
34		{
35		$pages = $this->page->all();
36
37		$menuSelect = $this->getMenuSelect($menu);
38
39		return view('menu::admin.menuitems.create', compact('menu', 'pages', 'menuSelect'));
40		}
41
42	View Code Duplication	public function store(Menu $menu, CreateMenuItemRequest $request)
		0 ignored issues – show Duplication introduced 2015-11-20 22:22 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...
43		{
44		$this->menuItem->create($this->addMenuId($menu, $request));
45
46		return redirect()->route('admin.menu.menu.edit', [$menu->id])
		0 ignored issues – show Documentation introduced 2015-11-20 22:22 UTC by Report Bug Copy Issue Report The property `id` does not exist on `object<Modules\Menu\Entities\Menu>`. Since you implemented `__get`, maybe consider adding a @property annotation. Since your code implements the magic getter `_get`, this function will be called for any read access on an undefined variable. You can add the `@property` annotation to your class or interface to document the existence of this variable. <?php /** * @property int $x * @property int $y * @property string $text */ class MyLabel { private $properties; private $allowedProperties = array('x', 'y', 'text'); public function __get($name) { if (isset($properties[$name]) && in_array($name, $this->allowedProperties)) { return $properties[$name]; } else { return null; } } public function __set($name, $value) { if (in_array($name, $this->allowedProperties)) { $properties[$name] = $value; } else { throw new \LogicException("Property $name is not defined."); } } } If the property has read access only, you can use the @property-read annotation instead. Of course, you may also just have mistyped another name, in which case you should fix the error. See also the PhpDoc documentation for @property. Loading history...
47		->withSuccess(trans('menu::messages.menuitem created'));
48		}
49
50		public function edit(Menu $menu, Menuitem $menuItem)
51		{
52		$pages = $this->page->all();
53
54		$menuSelect = $this->getMenuSelect($menu);
55
56		return view('menu::admin.menuitems.edit', compact('menu', 'menuItem', 'pages', 'menuSelect'));
57		}
58
59	View Code Duplication	public function update(Menu $menu, Menuitem $menuItem, UpdateMenuItemRequest $request)
		0 ignored issues – show Duplication introduced 2015-11-20 22:22 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...
60		{
61		$this->menuItem->update($menuItem, $this->addMenuId($menu, $request));
62
63		return redirect()->route('admin.menu.menu.edit', [$menu->id])
		0 ignored issues – show Documentation introduced 2016-06-27 17:56 UTC by Report Bug Copy Issue Report The property `id` does not exist on `object<Modules\Menu\Entities\Menu>`. Since you implemented `__get`, maybe consider adding a @property annotation. Since your code implements the magic getter `_get`, this function will be called for any read access on an undefined variable. You can add the `@property` annotation to your class or interface to document the existence of this variable. <?php /** * @property int $x * @property int $y * @property string $text */ class MyLabel { private $properties; private $allowedProperties = array('x', 'y', 'text'); public function __get($name) { if (isset($properties[$name]) && in_array($name, $this->allowedProperties)) { return $properties[$name]; } else { return null; } } public function __set($name, $value) { if (in_array($name, $this->allowedProperties)) { $properties[$name] = $value; } else { throw new \LogicException("Property $name is not defined."); } } } If the property has read access only, you can use the @property-read annotation instead. Of course, you may also just have mistyped another name, in which case you should fix the error. See also the PhpDoc documentation for @property. Loading history...
64		->withSuccess(trans('menu::messages.menuitem updated'));
65		}
66
67		public function destroy(Menu $menu, Menuitem $menuItem)
68		{
69		$this->menuItem->destroy($menuItem);
70
71		return redirect()->route('admin.menu.menu.edit', [$menu->id])
		0 ignored issues – show Documentation introduced 2015-11-20 22:22 UTC by Report Bug Copy Issue Report The property `id` does not exist on `object<Modules\Menu\Entities\Menu>`. Since you implemented `__get`, maybe consider adding a @property annotation. Since your code implements the magic getter `_get`, this function will be called for any read access on an undefined variable. You can add the `@property` annotation to your class or interface to document the existence of this variable. <?php /** * @property int $x * @property int $y * @property string $text */ class MyLabel { private $properties; private $allowedProperties = array('x', 'y', 'text'); public function __get($name) { if (isset($properties[$name]) && in_array($name, $this->allowedProperties)) { return $properties[$name]; } else { return null; } } public function __set($name, $value) { if (in_array($name, $this->allowedProperties)) { $properties[$name] = $value; } else { throw new \LogicException("Property $name is not defined."); } } } If the property has read access only, you can use the @property-read annotation instead. Of course, you may also just have mistyped another name, in which case you should fix the error. See also the PhpDoc documentation for @property. Loading history...
72		->withSuccess(trans('menu::messages.menuitem deleted'));
73		}
74
75		/**
76		* @param Menu, $menuItemId
		0 ignored issues – show Documentation introduced 2015-12-30 16:14 UTC by Report Bug Copy Issue Report The doc-type `Menu,` could not be parsed: Expected "\|" or "end of type", but got "," at position 4. (view supported doc-types) This check marks PHPDoc comments that could not be parsed by our parser. To see which comment annotations we can parse, please refer to our documentation on supported doc-types. Loading history... Bug introduced 2016-08-01 17:10 UTC by Report Bug Copy Issue Report There is no parameter named `$menuItemId`. 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...
77		* @return array
78		*/
79		private function getMenuSelect($menu)
80		{
81		return $menu->menuitems()->where('is_root', '!=', true)->get()->nest()->listsFlattened('title');
82		}
83
84		/**
85		* @param Menu $menu
86		* @param \Illuminate\Foundation\Http\FormRequest $request
87		* @return array
88		*/
89		private function addMenuId(Menu $menu, FormRequest $request)
90		{
91		$data = $request->all();
92
93		foreach (LaravelLocalization::getSupportedLanguagesKeys() as $lang) {
94		if ($data['link_type'] === 'page' && ! empty($data['page_id'])) {
95		$data[$lang]['uri'] = $this->getUri($data['page_id'], $data['parent_id'], $lang);
96		}
97		}
98
99		if (empty($data['parent_id'])) {
100		$data['parent_id'] = $this->menuItem->getRootForMenu($menu->id)->id;
		0 ignored issues – show Documentation introduced 2016-08-01 17:10 UTC by Report Bug Copy Issue Report The property `id` does not exist on `object<Modules\Menu\Entities\Menu>`. Since you implemented `__get`, maybe consider adding a @property annotation. Since your code implements the magic getter `_get`, this function will be called for any read access on an undefined variable. You can add the `@property` annotation to your class or interface to document the existence of this variable. <?php /** * @property int $x * @property int $y * @property string $text */ class MyLabel { private $properties; private $allowedProperties = array('x', 'y', 'text'); public function __get($name) { if (isset($properties[$name]) && in_array($name, $this->allowedProperties)) { return $properties[$name]; } else { return null; } } public function __set($name, $value) { if (in_array($name, $this->allowedProperties)) { $properties[$name] = $value; } else { throw new \LogicException("Property $name is not defined."); } } } If the property has read access only, you can use the @property-read annotation instead. Of course, you may also just have mistyped another name, in which case you should fix the error. See also the PhpDoc documentation for @property. Loading history...
101		}
102
103		return array_merge($data, ['menu_id' => $menu->id]);
		0 ignored issues – show Documentation introduced 2015-11-20 22:22 UTC by Report Bug Copy Issue Report The property `id` does not exist on `object<Modules\Menu\Entities\Menu>`. Since you implemented `__get`, maybe consider adding a @property annotation. Since your code implements the magic getter `_get`, this function will be called for any read access on an undefined variable. You can add the `@property` annotation to your class or interface to document the existence of this variable. <?php /** * @property int $x * @property int $y * @property string $text */ class MyLabel { private $properties; private $allowedProperties = array('x', 'y', 'text'); public function __get($name) { if (isset($properties[$name]) && in_array($name, $this->allowedProperties)) { return $properties[$name]; } else { return null; } } public function __set($name, $value) { if (in_array($name, $this->allowedProperties)) { $properties[$name] = $value; } else { throw new \LogicException("Property $name is not defined."); } } } If the property has read access only, you can use the @property-read annotation instead. Of course, you may also just have mistyped another name, in which case you should fix the error. See also the PhpDoc documentation for @property. Loading history...
104		}
105
106		/**
107		* Get uri
108		* @param string $pageId
109		* @param string $parentId
110		* @param string $lang
111		* @return string
112		*/
113		private function getUri($pageId, $parentId, $lang)
114		{
115		$linkPathArray = [];
116
117		$linkPathArray[] = $this->getPageSlug($pageId, $lang);
118
119		if ($parentId !== '') {
120		$hasParentItem = !(is_null($parentId)) ? true : false;
121		while ($hasParentItem) {
122		$parentItemId = isset($parentItem) ? $parentItem->parent_id : $parentId;
123		$parentItem = $this->menuItem->find($parentItemId);
124
125		if ($parentItem->is_root === 0) {
126		if ($parentItem->page_id !== '') {
127		$linkPathArray[] = $this->getPageSlug($parentItem->page_id, $lang);
128		} else {
129		$linkPathArray[] = $this->getParentUri($parentItem, $linkPathArray);
130		}
131		$hasParentItem = !is_null($parentItem->parent_id) ? true : false;
132		} else {
133		$hasParentItem = false;
134		}
135		}
136		}
137		$parentLinkPath = implode('/', array_reverse($linkPathArray));
138
139		return $parentLinkPath;
140		}
141
142		/**
143		* Get page slug
144		*
145		* @params $pageId, $lang
146		* @return string
147		*/
148		private function getPageSlug($id, $lang)
149		{
150		$page = $this->page->find($id);
151		$translation = $page->translate($lang);
152
153		if ($translation === null) {
154		return $page->translate(config('app.fallback_locale'))->slug;
155		}
156
157		return $translation->slug;
158		}
159
160		/**
161		* Get parent uri
162		*
163		* @params $pageId, $lang
164		* @return string
165		*/
166		private function getParentUri($item, $linkPathArray)
167		{
168		return ! is_null($item->uri) ? $item->uri . '/' . implode('/', $linkPathArray) : implode('/', $linkPathArray);
169		}
170		}
171

AsgardCms / Menu

Pull Request — 2.0 (#31)

MenuItemController A

Complexity

Size/Duplication

Coupling/Cohesion

Importance

11 Methods

How to fix Duplicated Code

Duplicated Code

Duplication Side-by-Side

Filter issues like