BackendController::attachSubmenuIfExists() - Code Metrics - Inspection of "menu model refactor" - webshelf/framework - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( 1c3701...3da348 )

by Mark

created 2017-09-03 18:32 UTC

BackendController::attachSubmenuIfExists() A

↳ Parent: BackendController

Complexity

Conditions	2
Paths	2

Size

Total Lines	11
Code Lines	5

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
cc	2
eloc	5
nc	2
nop	2
dl	0
loc	11
rs	9.4285
c	0
b	0
f	0

<?php
/**
 * Created by PhpStorm.
 * User: Mark
 * Date: 13/03/2016
 * Time: 14:55.
 */

namespace App\Plugins\Menus;

use DB;
use App\Model\Menu;
use App\Model\Page;
use App\Classes\Popup;
use Illuminate\Http\Request;
use App\Plugins\PluginEngine;
use League\Flysystem\Exception;
use App\Classes\Repositories\MenuRepository;
use App\Classes\Repositories\PageRepository;
use Illuminate\Database\Eloquent\Collection;

/**
 * Class Controller.
 */
class BackendController extends PluginEngine
{
    /**
     * @var MenuRepository
     */
    private $menus;

    /**
     * @var PageRepository
     */
    private $pages;

    /**
     * AdminController constructor.
     * @param MenuRepository $menus
     * @param PageRepository $pages
     */
    public function __construct(MenuRepository $menus, PageRepository $pages)
    {
        $this->menus = $menus;

        $this->pages = $pages;
    }

    /**
     * Show all the menus in one place.
     */
    public function index()
    {
        return $this->make('index')->with('menus', $this->menus->allByPriorityOrder())->with('pages', $this->pages->allPagesWithoutMenusAndEditable())->with('submenu_group', $this->menus->allSubmenusByPriorityOrderAndGrouped());

    }

    /**
     * Create a menu form.
     */
    public function create()
    {
        return $this->make('create')->with('submenus', $this->menus->listAllMenusNotRequired())->with('pages', $this->pages->listAllPagesWithoutMenusAndEditable());

    }

    /**
     * Delete a menu with ajax.
     *
     * @param Request $request
     * @param $id
     * @return bool

     */
    public function ajax_delete(Request $request, $id)

    {
        try {
            /** @var Menu $menu */
            $menu = $this->menus->whereID($id);

            if ($menu->required) {
                return response()->json(['success' => false, 'message' => 'You cannot remove application bound menus']);
            }

            $menu_id = $menu->id;

            $menu->submenus()->delete();
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.
}

            $menu->delete();

            if ($menu_id) {
                $this->reorderRowsFromCollection($this->menus->allMenus());
            } else {
                $this->reorderRowsFromCollection($this->menus->submenusWhereID($menu_id));

            }

            popups()->setSession($request->session())->add((new Popup(['message' => 'Menu and its entities were removed successfully.']))->success());
function acceptsInteger($int) { }

$x = '123'; // string "123"

// Instead of
acceptsInteger($x);

// we recommend to use
acceptsInteger((integer) $x);

            return response()->json(['success' => true, 'notify' => false]);
        } catch (\Exception $e) {
            return response()->json(['success' => false, 'notify' => true]);
        }
    }

    /**
     * Update the menu values with ajax.
     *
     * @param Request $request
     * @return \Illuminate\Http\JsonResponse

     */
    public function ajax_update(Request $request)

    {
        $validator = \Validator::make($request->all(),
            [
                'value' => 'required',
            ],
            [
                'value.required' => 'A valid value is required.',
            ]);

        if ($validator->fails()) {

            return response()->json(['error' => ['message' => $validator->errors()->first()]]);
        }

        // VALIDATION FOR TITLES
        if ($request['name'] == 'title') {
            $request['title'] = str_slug($request['value']);

            $validator = \Validator::make($request->all(),
                [
                    'title' => 'unique:menus,slug,NULL,id,deleted_at,NULL|required|min:3|max:255',
                ],
                [
                    'title.unique' => 'A menu with this name already exists!',
                ]);

            if ($validator->fails()) {

                return response()->json(['error' => ['message' => $validator->errors()->first()]]);
            }
        }

        // VALIDATION FOR LINKS
        if ($request['name'] == 'link') {
            $request['link'] = $request['value'];
            {
                $hashed = str_contains($request['value'], '#');

                if ($hashed == false) {

                    $validator = \Validator::make($request->all(),
                    [
                        'link' => 'active_url',
                    ]);

                    if ($validator->fails()) {

                        return response()->json(['error' => ['message' => $validator->errors()->first()]]);
                    }
                }
            }
        }

        try {
            $method = 'set'.ucwords($request['name']);

            /** @var Menu $menu */
            $menu = $this->menus->whereID($request['pk']);

            /*
             * DO NOT CHANGE THE SLUG OF REQUIRED ITEMS, SINCE
             * THE APPLICATION USES THE SLUG TO RETRIEVE THE ITEM.
             */
            if (!$menu->required && $request['name'] == 'title') {
                $menu->slug = ($request['title']);
            }
            $menu->$method($request['value'])->save();
        } catch (Exception $e) {
            return response()->json(['error' => ['message' => 'Some strange error has occurred.']]);
        }
    }

    /**
     * Run this to re-order all columns of their counterpart menus
     * if a row is deleted or it becaomes somewhat unsynced.
     *
     * @param Collection $collection

     * @return bool
     */
    public function reorderRowsFromCollection(Collection $collection = null)
    {
        $menus = $collection->sortBy('order_id');
function someFunction(A $objectMaybe = null)
{
    if ($objectMaybe instanceof A) {
        $objectMaybe->doSomething();
    }
}

        $order = 1;

        /** @var Menu $menu */
        foreach ($menus as $menu) {
            $menu->order_id = $order;
            $menu->save();
            $order += 1;

        }

        return true;
    }

    /**
     * Reorder the menus location to the table using datatables API.
     * This uses a transaction protocol so that no interactions can be made to it
     * while this is in progress, which in turn makes it more consistent with what it does.
     *
     * @param Request $request
     * @return \Illuminate\Http\JsonResponse
     */
    public function ajax_order(Request $request)

    {
        $json = $request->json()->all();

        DB::beginTransaction();

        try {
            foreach ($json as $array) {
                $slug = $array['slug'];
                $new_value = $array['n'];

                $menu = $this->menus->whereName($slug);
                $menu->order_id = $new_value;
                $menu->save();
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.
}
            }

            DB::commit();
        } catch (\Exception $e) {
            DB::rollBack();

            return response()->json(['success'=>false, 'message'=>'Changes could not be saved.']);
        }

        return response()->json(['success'=>true, 'message'=>'Your changes to the row orders have been saved.']);
    }

    /**
     *  Process a form into a mode.
     *
     * @param Request $request
     * @return \Illuminate\Http\RedirectResponse
     */
    public function store(Request $request, Menu $menu)
    {
        $request['slug'] = str_slug($request['title']);

        // we must validate that a title exists.
        $this->validate($request, ['slug' => 'required|unique:menus,slug,NULL,id,deleted_at,NULL|min:3|max:255']);

        /*
         * Generic page creation with only a single attached internal page.
         * This does not contain, submenus, or external links.
         */
        if ($this->isInternalPageCreation($request)) {
            /** @var Page $page */
            $page = $this->pages->whereID($request['page_id']);

            $menu->title = ($request['title']);
            $menu->slug = (str_slug($request['title']));
            $menu->target = ($request['target']);
            $menu->enabled = $request['enabled'] ? true : false;
            $menu->creator_id = (account()->id);
            $this->attachSubmenuIfExists($request, $menu);
            $page->menus()->save($menu);
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.
}
            if ($request['submenu_id']) {

                $this->reorderRowsFromCollection($this->menus->submenusWhereID($request['submenu_id']));

            } else {
                $this->reorderRowsFromCollection($this->menus->all());
            }

            return redirect()->route('menus');
        } elseif ($this->isExternalPageCreation($request)) {
            $this->validate($request, ['external_link'=>'url']);
            $menu->title = ($request['title']);
            $menu->slug = (str_slug($request['title']));
            $menu->target = ($request['target']);
            $menu->enabled = $request['enabled'] ? true : false;
            $menu->creator_id =(account()->id);
            $menu->link = ($request['external_link']);
            $this->attachSubmenuIfExists($request, $menu);
            $menu->save();
            if ($request['submenu_id']) {

                $this->reorderRowsFromCollection($this->menus->submenusWhereID($request['submenu_id']));

            } else {
                $this->reorderRowsFromCollection($this->menus->all());
            }

            return redirect()->route('menus');
        }

        $this->validate($request, ['page_id' => 'required', 'external_link' => 'required'], ['required'=>'Please attach either a page or external link to this menu']);


        return redirect()->route('menus');
    }

    /**
     * Check if a submenu id exists for the new menu.
     * If true, save it to the menus creation.
     *
     * @param Request $request
     * @param Menu $menu
     * @return Menu
     */
    private function attachSubmenuIfExists(Request $request, Menu $menu)
    {
        if ($request['submenu_id']) {
            /** @var Menu $submenu */
            $submenu = $this->menus->whereID($request['submenu_id']);

            $menu->menu_id = ($submenu->id);
        }

        return $menu;
    }

    /**
     * Check that the form being process is a internal page creation only.
     *
     * @param Request $request
     * @return bool
     */
    private function isExternalPageCreation(Request $request)
    {
        return $request['external_link'] && ! $request['page_id'];
    }

    /**
     * Check that the form being process is a internal page creation only.
     *
     * @param Request $request
     * @return bool
     */
    private function isInternalPageCreation(Request $request)
    {
        return $request['page_id'] && ! $request['external_link'];
    }

    /**
     * Attach a page to the menu as a sub.
     *
     * Messey on one line but saves some space.
     * @param Request $request
     * @return \Illuminate\Http\RedirectResponse
     */
    public function attach(Request $request)
    {
        /** @var Page $page */
        $page = $this->pages->whereID($request['page_id']);

        /** @var Menu $menu */
        $menu = $this->menus->whereID($request['menu_id']);

        $model = new Menu;
        $model->title = ucfirst($page->seo_title);
        $model->link = url(str_slug(ucfirst($page->seo_title)));
        $model->enabled = true;
        $menu->submenus()->save($model);

        return redirect()->route('menus');
    }

    /**
     * Create a menu using a page as a base information.
     *
     * @param Request $request
     * @param Menu $menu
     * @return mixed

     */
    public function page(Request $request, Menu $menu)

    {
        /** @var Page $page */
        $page = $this->pages->whereID($request['page_id']);

        $menu = new Menu;
        $menu->link = (url($page->slug));
        $menu->title = ($page->seo_title);
        $menu->enabled = true;
        $menu->save();

        return redirect()->route('menus');
    }
}


Scrutinizer GitHub App not installed

Push — master ( 1c3701...3da348 )

BackendController::attachSubmenuIfExists() A

Complexity

Size

Duplication

Importance

Available Fixes

Available Fixes

Available Fixes

1			<?php
2			/**
3			* Created by PhpStorm.
4			* User: Mark
5			* Date: 13/03/2016
6			* Time: 14:55.
7			*/
8
9			namespace App\Plugins\Menus;
10
11			use DB;
12			use App\Model\Menu;
13			use App\Model\Page;
14			use App\Classes\Popup;
15			use Illuminate\Http\Request;
16			use App\Plugins\PluginEngine;
17			use League\Flysystem\Exception;
18			use App\Classes\Repositories\MenuRepository;
19			use App\Classes\Repositories\PageRepository;
20			use Illuminate\Database\Eloquent\Collection;
21
22			/**
23			* Class Controller.
24			*/
25			class BackendController extends PluginEngine
26			{
27			/**
28			* @var MenuRepository
29			*/
30			private $menus;
31
32			/**
33			* @var PageRepository
34			*/
35			private $pages;
36
37			/**
38			* AdminController constructor.
39			* @param MenuRepository $menus
40			* @param PageRepository $pages

webshelf / framework

Scrutinizer GitHub App not installed

Push — master ( 1c3701...3da348 )

BackendController::attachSubmenuIfExists() A

Complexity

Size

Duplication

Importance

Available Fixes

Available Fixes

Available Fixes

Duplication Side-by-Side

Filter issues like