UniquePageCrudController - Code Metrics - Inspection of "Unique pages" - Laravel-Backpack/PageManager - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Pull Request — master (#61)

by Cristian

created 2018-01-12 10:38 UTC

UniquePageCrudController A

↳ Parent: Project

Complexity

Total Complexity

Size/Duplication

Total Lines	181
Duplicated Lines	9.94 %

Coupling/Cohesion

Components	1
Dependencies	6

Importance

Changes	2
Bugs	1	Features	1

Metric	Value
wmc	15
c	2
b	1
f	1
lcom	1
cbo	6
dl	18
loc	181
rs	10

12 Methods

Rating	Name	Duplication	Size	Complexity
A	createMissingPage()	0	21	2
A	uniqueRevisions()	9	9	1
A	restoreUniqueRevision()	9	9	1
A	uniqueSetup()	0	9	1
A	getSaveAction()	0	12	1
A	setSaveAction()	0	4	1
B	setup()	0	24	2
A	uniqueEdit()	0	13	2
A	update()	0	6	1
A	setRoute()	0	4	1
B	addDefaultPageFields()	0	25	1
A	buttons()	0	7	1

How to fix Duplicated Code

<?php

namespace Backpack\PageManager\app\Http\Controllers\Admin;

use App\UniquePages;
use Backpack\PageManager\app\TraitReflections;
use Backpack\CRUD\app\Http\Controllers\CrudController;
use Backpack\CRUD\app\Http\Controllers\CrudFeatures\SaveActions;

class UniquePageCrudController extends CrudController
{
    use SaveActions;
    use UniquePages;
    use TraitReflections;

    public function setup()
    {
        parent::__construct();
class Daddy
{
    protected function getFirstName()
    {
        return "Eidur";
    }

    protected function getSurName()
    {
        return "Gudjohnsen";
    }
}

class Son
{
    public function getFirstName()
    {
        return parent::getSurname();
    }
}

        $modelClass = config('backpack.pagemanager.unique_page_model_class', 'Backpack\PageManager\app\Models\Page');

        $this->checkForTemplatesAndUniquePagesNotDistinct();

        /*
        |--------------------------------------------------------------------------
        | BASIC CRUD INFORMATION
        |--------------------------------------------------------------------------
        */
        $this->crud->setModel($modelClass);
        // don't set route or entity names here. these depend on the page you are editing

        // unique pages can not be created nor deleted
        $this->crud->denyAccess('create');
        $this->crud->denyAccess('delete');

        if (config('backpack.pagemanager.unique_page_revisions')) {
            $this->crud->allowAccess('revisions');
        }
    }

    /**
     * As we want to edit pages by slug we need a new edit function.
     *
     * @param string $slug the page slug
     * @return Response

     */
    public function uniqueEdit($slug)
    {
        $model = $this->crud->model;
        $entry = $model::findBySlug($slug);

        if (! $entry) {
            $entry = $this->createMissingPage($slug);
        }

        $this->uniqueSetup($entry);

        return parent::edit($entry->id);
class Daddy
{
    protected function getFirstName()
    {
        return "Eidur";
    }

    protected function getSurName()
    {
        return "Gudjohnsen";
    }
}

class Son
{
    public function getFirstName()
    {
        return parent::getSurname();
    }
}
    }

    public function update($slug, $id)

    {
        $this->setRoute($slug);

        return parent::updateCrud();
class Daddy
{
    protected function getFirstName()
    {
        return "Eidur";
    }

    protected function getSurName()
    {
        return "Gudjohnsen";
    }
}

class Son
{
    public function getFirstName()
    {
        return parent::getSurname();
    }
}
    }

    public function setRoute($slug)
    {
        $this->crud->setRoute(config('backpack.base.route_prefix').'/unique/'.$slug);
    }

    /**
     * Populate the update form with basic fields, that all pages need.
     *
     * @param Model $page the page entity
     */
    public function addDefaultPageFields($page)
    {
        $this->crud->addField([
            'name' => 'template',
            'type' => 'hidden',
        ]);
        $this->crud->addField([
            'name' => 'name',
            'type' => 'hidden',
        ]);
        $this->crud->addField([
            'name' => 'title',
            'type' => 'hidden',
        ]);
        $this->crud->addField([
            'name' => 'slug',
            'type' => 'hidden',
        ]);

        $this->crud->addField([
            'name' => 'open',
            'type' => 'custom_html',
            'value' => $this->buttons($page),
        ]);
    }

    public function buttons($page)
    {
        $openButton = $page->getOpenButton();
        $revisionsButton = view('crud::buttons.revisions', ['crud' => $this->crud, 'entry' => $page]);

        return $openButton.' '.$revisionsButton;
    }

    public function createMissingPage($slug)

    {
        $pages = collect($this->getUniquePages());

        $slugs = $pages->mapWithKeys(function ($page) {
            return [str_slug($page->name) => $page->name];
        });

        if (! $page = $slugs->pull($slug)) {
            abort(404);
        }

        $model = $this->crud->model;

        return $model::create([
            'template' => $page,
            'name' => camel_case($page),
            'title' => camel_case($page),
            'slug' => $slug,
        ]);
    }

    public function uniqueRevisions($slug, $id)

    {
        $model = $this->crud->model;
        $entry = $model::findBySlugOrFail($slug);

        $this->uniqueSetup($entry);

        return parent::listRevisions($entry->id);
class Daddy
{
    protected function getFirstName()
    {
        return "Eidur";
    }

    protected function getSurName()
    {
        return "Gudjohnsen";
    }
}

class Son
{
    public function getFirstName()
    {
        return parent::getSurname();
    }
}
    }

    public function restoreUniqueRevision($slug, $id)

    {
        $model = $this->crud->model;
        $entry = $model::findBySlugOrFail($slug);

        $this->uniqueSetup($entry);

        return parent::restoreRevision($id);
class Daddy
{
    protected function getFirstName()
    {
        return "Eidur";
    }

    protected function getSurName()
    {
        return "Gudjohnsen";
    }
}

class Son
{
    public function getFirstName()
    {
        return parent::getSurname();
    }
}
    }

    protected function uniqueSetup($entry)
    {
        $this->setRoute($entry->slug);

        $this->addDefaultPageFields($entry);
        $this->crud->setEntityNameStrings($this->crud->makeLabel($entry->template), '');

        $this->{$entry->template}();
    }

    /*
    |--------------------------------------------------------------------------
    | SaveActions overrides
    |--------------------------------------------------------------------------
    */

    /**
     * Overrides trait version to remove.
     */
    public function getSaveAction()
    {
        $saveCurrent = [
            'value' => $this->getSaveActionButtonName('save_and_back'),
            'label' => $this->getSaveActionButtonName('save_and_back'),
        ];

        return [
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());
}
            'active' => $saveCurrent,
            'options' => [],
        ];
    }

    public function setSaveAction($forceSaveAction = null)
    {
        // do nothing to preserve session value for other crud
    }
}


1		<?php
2
3		namespace Backpack\PageManager\app\Http\Controllers\Admin;
4
5		use App\UniquePages;
6		use Backpack\PageManager\app\TraitReflections;
7		use Backpack\CRUD\app\Http\Controllers\CrudController;
8		use Backpack\CRUD\app\Http\Controllers\CrudFeatures\SaveActions;
9
10		class UniquePageCrudController extends CrudController
11		{
12		use SaveActions;
13		use UniquePages;
14		use TraitReflections;
15
16		public function setup()
17		{
18		parent::__construct();
		0 ignored issues – show Comprehensibility Bug introduced 2018-01-11 23:35 UTC by Report Bug Copy Issue Report It seems like you call parent on a different method (`__construct()` instead of `setup()`). Are you sure this is correct? If so, you might want to change this to `$this->__construct()`. This check looks for a call to a parent method whose name is different than the method from which it is called. Consider the following code: class Daddy { protected function getFirstName() { return "Eidur"; } protected function getSurName() { return "Gudjohnsen"; } } class Son { public function getFirstName() { return parent::getSurname(); } } The `getFirstName()` method in the `Son` calls the wrong method in the parent class. Loading history...
19
20		$modelClass = config('backpack.pagemanager.unique_page_model_class', 'Backpack\PageManager\app\Models\Page');
21
22		$this->checkForTemplatesAndUniquePagesNotDistinct();
23
24		/*
25		\|--------------------------------------------------------------------------
26		\| BASIC CRUD INFORMATION
27		\|--------------------------------------------------------------------------
28		*/
29		$this->crud->setModel($modelClass);
30		// don't set route or entity names here. these depend on the page you are editing
31
32		// unique pages can not be created nor deleted
33		$this->crud->denyAccess('create');
34		$this->crud->denyAccess('delete');
35
36		if (config('backpack.pagemanager.unique_page_revisions')) {
37		$this->crud->allowAccess('revisions');
38		}
39		}
40
41		/**
42		* As we want to edit pages by slug we need a new edit function.
43		*
44		* @param string $slug the page slug
45		* @return Response
		0 ignored issues – show Documentation introduced 2018-01-12 10:41 UTC by Report Bug Copy Issue Report Should the return type not be `\Illuminate\View\View\|\I...\Contracts\View\Factory`? This check compares the return type specified in the `@return` annotation of a function or method doc comment with the types returned by the function and raises an issue if they mismatch. Loading history...
46		*/
47		public function uniqueEdit($slug)
48		{
49		$model = $this->crud->model;
50		$entry = $model::findBySlug($slug);
51
52		if (! $entry) {
53		$entry = $this->createMissingPage($slug);
54		}
55
56		$this->uniqueSetup($entry);
57
58		return parent::edit($entry->id);
		0 ignored issues – show Comprehensibility Bug introduced 2018-01-11 23:35 UTC by Report Bug Copy Issue Report It seems like you call parent on a different method (`edit()` instead of `uniqueEdit()`). Are you sure this is correct? If so, you might want to change this to `$this->edit()`. This check looks for a call to a parent method whose name is different than the method from which it is called. Consider the following code: class Daddy { protected function getFirstName() { return "Eidur"; } protected function getSurName() { return "Gudjohnsen"; } } class Son { public function getFirstName() { return parent::getSurname(); } } The `getFirstName()` method in the `Son` calls the wrong method in the parent class. Loading history...
59		}
60
61		public function update($slug, $id)
		0 ignored issues – show Unused Code introduced 2018-01-11 23:35 UTC by Report Bug Copy Issue Report The parameter `$id` is not used and could be removed. This check looks from parameters that have been defined for a function or method, but which are not used in the method body. Loading history...
62		{
63		$this->setRoute($slug);
64
65		return parent::updateCrud();
		0 ignored issues – show Comprehensibility Bug introduced 2018-01-11 23:35 UTC by Report Bug Copy Issue Report It seems like you call parent on a different method (`updateCrud()` instead of `update()`). Are you sure this is correct? If so, you might want to change this to `$this->updateCrud()`. This check looks for a call to a parent method whose name is different than the method from which it is called. Consider the following code: class Daddy { protected function getFirstName() { return "Eidur"; } protected function getSurName() { return "Gudjohnsen"; } } class Son { public function getFirstName() { return parent::getSurname(); } } The `getFirstName()` method in the `Son` calls the wrong method in the parent class. Loading history...
66		}
67
68		public function setRoute($slug)
69		{
70		$this->crud->setRoute(config('backpack.base.route_prefix').'/unique/'.$slug);
71		}
72
73		/**
74		* Populate the update form with basic fields, that all pages need.
75		*
76		* @param Model $page the page entity
77		*/
78		public function addDefaultPageFields($page)
79		{
80		$this->crud->addField([
81		'name' => 'template',
82		'type' => 'hidden',
83		]);
84		$this->crud->addField([
85		'name' => 'name',
86		'type' => 'hidden',
87		]);
88		$this->crud->addField([
89		'name' => 'title',
90		'type' => 'hidden',
91		]);
92		$this->crud->addField([
93		'name' => 'slug',
94		'type' => 'hidden',
95		]);
96
97		$this->crud->addField([
98		'name' => 'open',
99		'type' => 'custom_html',
100		'value' => $this->buttons($page),
101		]);
102		}
103
104		public function buttons($page)
105		{
106		$openButton = $page->getOpenButton();
107		$revisionsButton = view('crud::buttons.revisions', ['crud' => $this->crud, 'entry' => $page]);
108
109		return $openButton.' '.$revisionsButton;
110		}
111
112		public function createMissingPage($slug)
		0 ignored issues – show Documentation introduced 2018-01-11 23:35 UTC by Report Bug Copy Issue Report The return type could not be reliably inferred; please add a `@return` annotation. Our type inference engine in quite powerful, but sometimes the code does not provide enough clues to go by. In these cases we request you to add a `@return` annotation as described here. Loading history...
113		{
114		$pages = collect($this->getUniquePages());
115
116		$slugs = $pages->mapWithKeys(function ($page) {
117		return [str_slug($page->name) => $page->name];
118		});
119
120		if (! $page = $slugs->pull($slug)) {
121		abort(404);
122		}
123
124		$model = $this->crud->model;
125
126		return $model::create([
127		'template' => $page,
128		'name' => camel_case($page),
129		'title' => camel_case($page),
130		'slug' => $slug,
131		]);
132		}
133
134	View Code Duplication	public function uniqueRevisions($slug, $id)
		0 ignored issues – show Unused Code introduced 2018-01-12 10:41 UTC by Report Bug Copy Issue Report The parameter `$id` is not used and could be removed. This check looks from parameters that have been defined for a function or method, but which are not used in the method body. Loading history... Duplication introduced 2018-01-12 10:41 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...
135		{
136		$model = $this->crud->model;
137		$entry = $model::findBySlugOrFail($slug);
138
139		$this->uniqueSetup($entry);
140
141		return parent::listRevisions($entry->id);
		0 ignored issues – show Comprehensibility Bug introduced 2018-01-12 10:41 UTC by Report Bug Copy Issue Report It seems like you call parent on a different method (`listRevisions()` instead of `uniqueRevisions()`). Are you sure this is correct? If so, you might want to change this to `$this->listRevisions()`. This check looks for a call to a parent method whose name is different than the method from which it is called. Consider the following code: class Daddy { protected function getFirstName() { return "Eidur"; } protected function getSurName() { return "Gudjohnsen"; } } class Son { public function getFirstName() { return parent::getSurname(); } } The `getFirstName()` method in the `Son` calls the wrong method in the parent class. Loading history...
142		}
143
144	View Code Duplication	public function restoreUniqueRevision($slug, $id)
		0 ignored issues – show Duplication introduced 2018-01-12 10:41 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...
145		{
146		$model = $this->crud->model;
147		$entry = $model::findBySlugOrFail($slug);
148
149		$this->uniqueSetup($entry);
150
151		return parent::restoreRevision($id);
		0 ignored issues – show Comprehensibility Bug introduced 2018-01-12 10:41 UTC by Report Bug Copy Issue Report It seems like you call parent on a different method (`restoreRevision()` instead of `restoreUniqueRevision()`). Are you sure this is correct? If so, you might want to change this to `$this->restoreRevision()`. This check looks for a call to a parent method whose name is different than the method from which it is called. Consider the following code: class Daddy { protected function getFirstName() { return "Eidur"; } protected function getSurName() { return "Gudjohnsen"; } } class Son { public function getFirstName() { return parent::getSurname(); } } The `getFirstName()` method in the `Son` calls the wrong method in the parent class. Loading history...
152		}
153
154		protected function uniqueSetup($entry)
155		{
156		$this->setRoute($entry->slug);
157
158		$this->addDefaultPageFields($entry);
159		$this->crud->setEntityNameStrings($this->crud->makeLabel($entry->template), '');
160
161		$this->{$entry->template}();
162		}
163
164		/*
165		\|--------------------------------------------------------------------------
166		\| SaveActions overrides
167		\|--------------------------------------------------------------------------
168		*/
169
170		/**
171		* Overrides trait version to remove.
172		*/
173		public function getSaveAction()
174		{
175		$saveCurrent = [
176		'value' => $this->getSaveActionButtonName('save_and_back'),
177		'label' => $this->getSaveActionButtonName('save_and_back'),
178		];
179
180		return [
		0 ignored issues – show Bug Best Practice introduced 2018-01-11 23:35 UTC by Report Bug Copy Issue Report The return type of `return array('active' =>... 'options' => array());` (`array<string,array>`) is incompatible with the return type of the parent method `Backpack\CRUD\app\Http\C...ntroller::getSaveAction` of type `array<string,array>`. If you return a value from a function or method, it should be a sub-type of the type that is given by the parent type f.e. an interface, or abstract method. This is more formally defined by the Lizkov substitution principle, and guarantees that classes that depend on the parent type can use any instance of a child type interchangably. This principle also belongs to the SOLID principles for object oriented design. Let’s take a look at an example: 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()); } Our function `my_function` expects a `Post` object, and outputs the author of the post. The base class `Post` returns a simple string and outputting a simple string will work just fine. However, the child class `BlogPost` which is a sub-type of `Post` instead decided to return an `object`, and is therefore violating the SOLID principles. If a `BlogPost` were passed to `my_function`, PHP would not complain, but ultimately fail when executing the `strtoupper` call in its body. Loading history...
181		'active' => $saveCurrent,
182		'options' => [],
183		];
184		}
185
186		public function setSaveAction($forceSaveAction = null)
187		{
188		// do nothing to preserve session value for other crud
189		}
190		}
191

Laravel-Backpack / PageManager

Scrutinizer GitHub App not installed

Pull Request — master (#61)

UniquePageCrudController A

Complexity

Size/Duplication

Coupling/Cohesion

Importance

12 Methods

How to fix Duplicated Code

Duplicated Code

Duplication Side-by-Side

Filter issues like