CrudPanel::setRouteName() - Code Metrics - Inspection of "changelog" - Laravel-Backpack/CRUD - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( 0be2ba...247314 )

by Cristian

created 2017-12-05 07:27 UTC

CrudPanel::setRouteName() A

↳ Parent: CrudPanel

Complexity

Conditions	2
Paths	2

Size

Total Lines	11
Code Lines	6

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	4
CRAP Score	2.3149

Importance

Changes

Metric	Value
cc	2
eloc	6
nc	2
nop	2
dl	0
loc	11
ccs	4
cts	7
cp	0.5714
crap	2.3149
rs	9.4285
c	0
b	0
f	0

<?php

namespace Backpack\CRUD;

use Backpack\CRUD\PanelTraits\Read;
use Backpack\CRUD\PanelTraits\Tabs;
use Backpack\CRUD\PanelTraits\Query;
use Backpack\CRUD\PanelTraits\Views;
use Backpack\CRUD\PanelTraits\Access;
use Backpack\CRUD\PanelTraits\Create;
use Backpack\CRUD\PanelTraits\Delete;
use Backpack\CRUD\PanelTraits\Errors;
use Backpack\CRUD\PanelTraits\Fields;
use Backpack\CRUD\PanelTraits\Search;
use Backpack\CRUD\PanelTraits\Update;
use Backpack\CRUD\PanelTraits\AutoSet;
use Backpack\CRUD\PanelTraits\Buttons;
use Backpack\CRUD\PanelTraits\Columns;
use Backpack\CRUD\PanelTraits\Filters;
use Backpack\CRUD\PanelTraits\Reorder;
use Backpack\CRUD\PanelTraits\AutoFocus;
use Backpack\CRUD\PanelTraits\FakeFields;
use Backpack\CRUD\PanelTraits\FakeColumns;
use Backpack\CRUD\PanelTraits\ViewsAndRestoresRevisions;

class CrudPanel

{
    use Create, Read, Search, Update, Delete, Errors, Reorder, Access, Columns, Fields, Query, Buttons, AutoSet, FakeFields, FakeColumns, ViewsAndRestoresRevisions, AutoFocus, Filters, Tabs, Views;


    // --------------
    // CRUD variables
    // --------------
    // These variables are passed to the CRUD views, inside the $crud variable.
    // All variables are public, so they can be modified from your EntityCrudController.
    // All functions and methods are also public, so they can be used in your EntityCrudController to modify these variables.


    // TODO: translate $entity_name and $entity_name_plural by default, with english fallback

    public $model = "\App\Models\Entity"; // what's the namespace for your entity's model
    public $route; // what route have you defined for your entity? used for links.
    public $entity_name = 'entry'; // what name will show up on the buttons, in singural (ex: Add entity)
    public $entity_name_plural = 'entries'; // what name will show up on the buttons, in plural (ex: Delete 5 entities)
    public $request;

    public $access = ['list', 'create', 'update', 'delete'/* 'revisions', reorder', 'show', 'details_row' */];

    public $reorder = false;
    public $reorder_label = false;
    public $reorder_max_level = 3;

    public $details_row = false;
    public $export_buttons = false;

    public $columns = []; // Define the columns for the table view as an array;
    public $create_fields = []; // Define the fields for the "Add new entry" view as an array;
    public $update_fields = []; // Define the fields for the "Edit entry" view as an array;

    public $query;
    public $entry;
    public $buttons;
    public $db_column_types = [];
    public $default_page_length = false;

    // TONE FIELDS - TODO: find out what he did with them, replicate or delete
    public $sort = [];

    // The following methods are used in CrudController or your EntityCrudController to manipulate the variables above.

    public function __construct()
    {
        $this->setErrorDefaults();
        $this->initButtons();
    }

    // ------------------------------------------------------
    // BASICS - model, route, entity_name, entity_name_plural
    // ------------------------------------------------------

    /**
     * This function binds the CRUD to its corresponding Model (which extends Eloquent).
     * All Create-Read-Update-Delete operations are done using that Eloquent Collection.
     *
     * @param string $model_namespace Full model namespace. Ex: App\Models\Article]
     *
     * @throws \Exception in case the model does not exist
     */
    public function setModel($model_namespace)

    {
        if (! class_exists($model_namespace)) {
            throw new \Exception('This model does not exist.', 404);
        }

        $this->model = new $model_namespace();

        $this->query = $this->model->select('*');
        $this->entry = null;
    }

    /**
     * Get the corresponding Eloquent Model for the CrudController, as defined with the setModel() function;.
     *
     * @return [Eloquent Collection]

     */
    public function getModel()
    {
        return $this->model;
    }

    /**
     * Set the route for this CRUD.
     * Ex: admin/article.
     *
     * @param [string] Route name.
     * @param [array] Parameters.
     */
    public function setRoute($route)
    {
        $this->route = $route;
    }

    /**
     * Set the route for this CRUD using the route name.
     * Ex: admin.article.
     *
     * @param [string] Route name.
     * @param [array] Parameters.
     */
    public function setRouteName($route, $parameters = [])
    {
        $complete_route = $route.'.index';

        if (! \Route::has($complete_route)) {
            throw new \Exception('There are no routes for this route name.', 404);
        }

        $this->route = route($complete_route, $parameters);
        $this->initButtons();
    }

    /**
     * Get the current CrudController route.
     *
     * Can be defined in the CrudController with:
     * - $this->crud->setRoute(config('backpack.base.route_prefix').'/article')
     * - $this->crud->setRouteName(config('backpack.base.route_prefix').'.article')
     * - $this->crud->route = config('backpack.base.route_prefix')."/article"
     *
     * @return [string]

     */
    public function getRoute()
    {
        return $this->route;
    }

    /**
     * Set the entity name in singular and plural.
     * Used all over the CRUD interface (header, add button, reorder button, breadcrumbs).
     *
     * @param [string] Entity name, in singular. Ex: article
     * @param [string] Entity name, in plural. Ex: articles
     */
    public function setEntityNameStrings($singular, $plural)
    {
        $this->entity_name = $singular;
        $this->entity_name_plural = $plural;
    }

    // ----------------------------------
    // Miscellaneous functions or methods
    // ----------------------------------

    /**
     * Return the first element in an array that has the given 'type' attribute.
     *
     * @param string $type
     * @param array  $array
     *
     * @return array
     */
    public function getFirstOfItsTypeInArray($type, $array)
    {
        return array_first($array, function ($item) use ($type) {
            return $item['type'] == $type;
        });
    }

    // ------------
    // TONE FUNCTIONS - UNDOCUMENTED, UNTESTED, SOME MAY BE USED IN THIS FILE
    // ------------
    //
    // TODO:
    // - figure out if they are really needed
    // - comments inside the function to explain how they work
    // - write docblock for them
    // - place in the correct section above (CREATE, READ, UPDATE, DELETE, ACCESS, MANIPULATION)

    public function sync($type, $fields, $attributes)
    {
        if (! empty($this->{$type})) {
            $this->{$type} = array_map(function ($field) use ($fields, $attributes) {
                if (in_array($field['name'], (array) $fields)) {
                    $field = array_merge($field, $attributes);
                }

                return $field;
            }, $this->{$type});
        }
    }

    /**
     * @deprecated No longer used by internal code and not recommended.
     */
    public function setSort($items, $order)
    {
        $this->sort[$items] = $order;
    }

    /**
     * @deprecated No longer used by internal code and not recommended.
     */
    public function sort($items)

    {
        if (array_key_exists($items, $this->sort)) {
            $elements = [];

            foreach ($this->sort[$items] as $item) {
                if (is_numeric($key = array_search($item, array_column($this->{$items}, 'name')))) {
                    $elements[] = $this->{$items}[$key];
                }
            }

            return $this->{$items} = array_merge($elements, array_filter($this->{$items}, function ($item) use ($items) {

                return ! in_array($item['name'], $this->sort[$items]);
            }));
        }

        return $this->{$items};
    }

    /**
     * Get the Eloquent Model name from the given relation definition string.
     *
     * @example For a given string 'company' and a relation between App/Models/User and App/Models/Company, defined by a
     *          company() method on the user model, the 'App/Models/Company' string will be returned.
     *
     * @example For a given string 'company.address' and a relation between App/Models/User, App/Models/Company and
     *          App/Models/Address defined by a company() method on the user model and an address() method on the
     *          company model, the 'App/Models/Address' string will be returned.
     *
     * @param $relationString String Relation string. A dot notation can be used to chain multiple relations.
     *
     * @return string relation model name
     */
    private function getRelationModel($relationString)
    {
        $result = array_reduce(explode('.', $relationString), function ($obj, $method) {
            return $obj->$method()->getRelated();
        }, $this->model);

        return get_class($result);
    }
}


1		<?php
2
3		namespace Backpack\CRUD;
4
5		use Backpack\CRUD\PanelTraits\Read;
6		use Backpack\CRUD\PanelTraits\Tabs;
7		use Backpack\CRUD\PanelTraits\Query;
8		use Backpack\CRUD\PanelTraits\Views;
9		use Backpack\CRUD\PanelTraits\Access;
10		use Backpack\CRUD\PanelTraits\Create;
11		use Backpack\CRUD\PanelTraits\Delete;
12		use Backpack\CRUD\PanelTraits\Errors;
13		use Backpack\CRUD\PanelTraits\Fields;
14		use Backpack\CRUD\PanelTraits\Search;
15		use Backpack\CRUD\PanelTraits\Update;
16		use Backpack\CRUD\PanelTraits\AutoSet;
17		use Backpack\CRUD\PanelTraits\Buttons;
18		use Backpack\CRUD\PanelTraits\Columns;
19		use Backpack\CRUD\PanelTraits\Filters;
20		use Backpack\CRUD\PanelTraits\Reorder;
21		use Backpack\CRUD\PanelTraits\AutoFocus;
22		use Backpack\CRUD\PanelTraits\FakeFields;
23		use Backpack\CRUD\PanelTraits\FakeColumns;
24		use Backpack\CRUD\PanelTraits\ViewsAndRestoresRevisions;
25
26		class CrudPanel
		0 ignored issues – show Coding Style introduced 2016-06-16 14:52 UTC by Report Bug Copy Issue Report The property $entity_name is not named in camelCase. This check marks property names that have not been written in camelCase. In camelCase names are written without any punctuation, the start of each new word being marked by a capital letter. Thus the name database connection string becomes `databaseConnectionString`. Loading history... Coding Style introduced 2016-06-16 14:52 UTC by Report Bug Copy Issue Report The property $entity_name_plural is not named in camelCase. This check marks property names that have not been written in camelCase. In camelCase names are written without any punctuation, the start of each new word being marked by a capital letter. Thus the name database connection string becomes `databaseConnectionString`. Loading history... Coding Style introduced 2016-06-16 14:52 UTC by Report Bug Copy Issue Report The property $reorder_label is not named in camelCase. This check marks property names that have not been written in camelCase. In camelCase names are written without any punctuation, the start of each new word being marked by a capital letter. Thus the name database connection string becomes `databaseConnectionString`. Loading history... Coding Style introduced 2016-06-16 14:52 UTC by Report Bug Copy Issue Report The property $reorder_max_level is not named in camelCase. This check marks property names that have not been written in camelCase. In camelCase names are written without any punctuation, the start of each new word being marked by a capital letter. Thus the name database connection string becomes `databaseConnectionString`. Loading history... Coding Style introduced 2016-06-16 14:52 UTC by Report Bug Copy Issue Report The property $details_row is not named in camelCase. This check marks property names that have not been written in camelCase. In camelCase names are written without any punctuation, the start of each new word being marked by a capital letter. Thus the name database connection string becomes `databaseConnectionString`. Loading history... Coding Style introduced 2016-09-12 13:47 UTC by Report Bug Copy Issue Report The property $export_buttons is not named in camelCase. This check marks property names that have not been written in camelCase. In camelCase names are written without any punctuation, the start of each new word being marked by a capital letter. Thus the name database connection string becomes `databaseConnectionString`. Loading history... Coding Style introduced 2016-06-16 14:52 UTC by Report Bug Copy Issue Report The property $create_fields is not named in camelCase. This check marks property names that have not been written in camelCase. In camelCase names are written without any punctuation, the start of each new word being marked by a capital letter. Thus the name database connection string becomes `databaseConnectionString`. Loading history... Coding Style introduced 2016-06-16 14:52 UTC by Report Bug Copy Issue Report The property $update_fields is not named in camelCase. This check marks property names that have not been written in camelCase. In camelCase names are written without any punctuation, the start of each new word being marked by a capital letter. Thus the name database connection string becomes `databaseConnectionString`. Loading history... Coding Style introduced 2016-07-22 16:53 UTC by Report Bug Copy Issue Report The property $db_column_types is not named in camelCase. This check marks property names that have not been written in camelCase. In camelCase names are written without any punctuation, the start of each new word being marked by a capital letter. Thus the name database connection string becomes `databaseConnectionString`. Loading history... Coding Style introduced 2016-07-22 16:53 UTC by Report Bug Copy Issue Report The property $default_page_length is not named in camelCase. This check marks property names that have not been written in camelCase. In camelCase names are written without any punctuation, the start of each new word being marked by a capital letter. Thus the name database connection string becomes `databaseConnectionString`. Loading history...
27		{
28		use Create, Read, Search, Update, Delete, Errors, Reorder, Access, Columns, Fields, Query, Buttons, AutoSet, FakeFields, FakeColumns, ViewsAndRestoresRevisions, AutoFocus, Filters, Tabs, Views;
		0 ignored issues – show Coding Style introduced 2016-06-16 14:52 UTC by Report Bug Copy Issue Report This line exceeds maximum limit of 120 characters; contains 197 characters Overly long lines are hard to read on any screen. Most code styles therefor impose a maximum limit on the number of characters in a line. Loading history...
29
30		// --------------
31		// CRUD variables
32		// --------------
33		// These variables are passed to the CRUD views, inside the $crud variable.
34		// All variables are public, so they can be modified from your EntityCrudController.
35		// All functions and methods are also public, so they can be used in your EntityCrudController to modify these variables.
		0 ignored issues – show Coding Style introduced 2016-06-16 14:52 UTC by Report Bug Copy Issue Report This line exceeds maximum limit of 120 characters; contains 125 characters Overly long lines are hard to read on any screen. Most code styles therefor impose a maximum limit on the number of characters in a line. Loading history...
36
37		// TODO: translate $entity_name and $entity_name_plural by default, with english fallback
38
39		public $model = "\App\Models\Entity"; // what's the namespace for your entity's model
40		public $route; // what route have you defined for your entity? used for links.
41		public $entity_name = 'entry'; // what name will show up on the buttons, in singural (ex: Add entity)
42		public $entity_name_plural = 'entries'; // what name will show up on the buttons, in plural (ex: Delete 5 entities)
43		public $request;
44
45		public $access = ['list', 'create', 'update', 'delete'/* 'revisions', reorder', 'show', 'details_row' */];
46
47		public $reorder = false;
48		public $reorder_label = false;
49		public $reorder_max_level = 3;
50
51		public $details_row = false;
52		public $export_buttons = false;
53
54		public $columns = []; // Define the columns for the table view as an array;
55		public $create_fields = []; // Define the fields for the "Add new entry" view as an array;
56		public $update_fields = []; // Define the fields for the "Edit entry" view as an array;
57
58		public $query;
59		public $entry;
60		public $buttons;
61		public $db_column_types = [];
62		public $default_page_length = false;
63
64		// TONE FIELDS - TODO: find out what he did with them, replicate or delete
65		public $sort = [];
66
67		// The following methods are used in CrudController or your EntityCrudController to manipulate the variables above.
68
69	159	public function __construct()
70		{
71	159	$this->setErrorDefaults();
72	159	$this->initButtons();
73	159	}
74
75		// ------------------------------------------------------
76		// BASICS - model, route, entity_name, entity_name_plural
77		// ------------------------------------------------------
78
79		/**
80		* This function binds the CRUD to its corresponding Model (which extends Eloquent).
81		* All Create-Read-Update-Delete operations are done using that Eloquent Collection.
82		*
83		* @param string $model_namespace Full model namespace. Ex: App\Models\Article]
84		*
85		* @throws \Exception in case the model does not exist
86		*/
87	159	public function setModel($model_namespace)
		0 ignored issues – show Coding Style Naming introduced 2017-08-03 17:04 UTC by Report Bug Copy Issue Report The parameter $model_namespace is not named in camelCase. This check marks parameter names that have not been written in camelCase. In camelCase names are written without any punctuation, the start of each new word being marked by a capital letter. Thus the name database connection string becomes `databaseConnectionString`. Loading history...
88		{
89	159	if (! class_exists($model_namespace)) {
90	1	throw new \Exception('This model does not exist.', 404);
91		}
92
93	159	$this->model = new $model_namespace();
		0 ignored issues – show Documentation Bug introduced 2017-04-18 11:15 UTC by Report Bug Copy Issue Report It seems like `new $model_namespace()` of type `object` is incompatible with the declared type `string` of property `$model`. Our type inference engine has found an assignment to a property that is incompatible with the declared type of that property. Either this assignment is in error or the assigned type should be added to the documentation/type hint for that property.. Loading history...
94	159	$this->query = $this->model->select('*');
95	159	$this->entry = null;
96	159	}
97
98		/**
99		* Get the corresponding Eloquent Model for the CrudController, as defined with the setModel() function;.
100		*
101		* @return [Eloquent Collection]
		0 ignored issues – show Documentation introduced 2016-06-16 14:52 UTC by Report Bug Copy Issue Report The doc-type `Eloquent">[Eloquent` could not be parsed: Unknown type name "[" at position 0. [(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...
102		*/
103	159	public function getModel()
104		{
105	159	return $this->model;
106		}
107
108		/**
109		* Set the route for this CRUD.
110		* Ex: admin/article.
111		*
112		* @param [string] Route name.
113		* @param [array] Parameters.
114		*/
115		public function setRoute($route)
116		{
117		$this->route = $route;
118		}
119
120		/**
121		* Set the route for this CRUD using the route name.
122		* Ex: admin.article.
123		*
124		* @param [string] Route name.
125		* @param [array] Parameters.
126		*/
127	1	public function setRouteName($route, $parameters = [])
128		{
129	1	$complete_route = $route.'.index';
130
131	1	if (! \Route::has($complete_route)) {
132	1	throw new \Exception('There are no routes for this route name.', 404);
133		}
134
135		$this->route = route($complete_route, $parameters);
136		$this->initButtons();
137		}
138
139		/**
140		* Get the current CrudController route.
141		*
142		* Can be defined in the CrudController with:
143		* - $this->crud->setRoute(config('backpack.base.route_prefix').'/article')
144		* - $this->crud->setRouteName(config('backpack.base.route_prefix').'.article')
145		* - $this->crud->route = config('backpack.base.route_prefix')."/article"
146		*
147		* @return [string]
		0 ignored issues – show Documentation introduced 2017-04-18 11:15 UTC by Report Bug Copy Issue Report The doc-type `[string]` could not be parsed: Unknown type name "" at position 0. [(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...
148		*/
149		public function getRoute()
150		{
151		return $this->route;
152		}
153
154		/**
155		* Set the entity name in singular and plural.
156		* Used all over the CRUD interface (header, add button, reorder button, breadcrumbs).
157		*
158		* @param [string] Entity name, in singular. Ex: article
159		* @param [string] Entity name, in plural. Ex: articles
160		*/
161		public function setEntityNameStrings($singular, $plural)
162		{
163		$this->entity_name = $singular;
164		$this->entity_name_plural = $plural;
165		}
166
167		// ----------------------------------
168		// Miscellaneous functions or methods
169		// ----------------------------------
170
171		/**
172		* Return the first element in an array that has the given 'type' attribute.
173		*
174		* @param string $type
175		* @param array $array
176		*
177		* @return array
178		*/
179		public function getFirstOfItsTypeInArray($type, $array)
180		{
181	2	return array_first($array, function ($item) use ($type) {
182	2	return $item['type'] == $type;
183	2	});
184		}
185
186		// ------------
187		// TONE FUNCTIONS - UNDOCUMENTED, UNTESTED, SOME MAY BE USED IN THIS FILE
188		// ------------
189		//
190		// TODO:
191		// - figure out if they are really needed
192		// - comments inside the function to explain how they work
193		// - write docblock for them
194		// - place in the correct section above (CREATE, READ, UPDATE, DELETE, ACCESS, MANIPULATION)
195
196		public function sync($type, $fields, $attributes)
197		{
198		if (! empty($this->{$type})) {
199		$this->{$type} = array_map(function ($field) use ($fields, $attributes) {
200		if (in_array($field['name'], (array) $fields)) {
201		$field = array_merge($field, $attributes);
202		}
203
204		return $field;
205		}, $this->{$type});
206		}
207		}
208
209		/**
210		* @deprecated No longer used by internal code and not recommended.
211		*/
212		public function setSort($items, $order)
213		{
214		$this->sort[$items] = $order;
215		}
216
217		/**
218		* @deprecated No longer used by internal code and not recommended.
219		*/
220		public function sort($items)
		0 ignored issues – show Documentation introduced 2017-09-27 09:44 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...
221		{
222		if (array_key_exists($items, $this->sort)) {
223		$elements = [];
224
225		foreach ($this->sort[$items] as $item) {
226		if (is_numeric($key = array_search($item, array_column($this->{$items}, 'name')))) {
227		$elements[] = $this->{$items}[$key];
228		}
229		}
230
231		return $this->{$items} = array_merge($elements, array_filter($this->{$items}, function ($item) use ($items) {
		0 ignored issues – show Coding Style introduced 2016-06-16 14:52 UTC by Report Bug Copy Issue Report This line exceeds maximum limit of 120 characters; contains 121 characters Overly long lines are hard to read on any screen. Most code styles therefor impose a maximum limit on the number of characters in a line. Loading history...
232		return ! in_array($item['name'], $this->sort[$items]);
233		}));
234		}
235
236		return $this->{$items};
237		}
238
239		/**
240		* Get the Eloquent Model name from the given relation definition string.
241		*
242		* @example For a given string 'company' and a relation between App/Models/User and App/Models/Company, defined by a
243		* company() method on the user model, the 'App/Models/Company' string will be returned.
244		*
245		* @example For a given string 'company.address' and a relation between App/Models/User, App/Models/Company and
246		* App/Models/Address defined by a company() method on the user model and an address() method on the
247		* company model, the 'App/Models/Address' string will be returned.
248		*
249		* @param $relationString String Relation string. A dot notation can be used to chain multiple relations.
250		*
251		* @return string relation model name
252		*/
253		private function getRelationModel($relationString)
254		{
255	9	$result = array_reduce(explode('.', $relationString), function ($obj, $method) {
256	9	return $obj->$method()->getRelated();
257	9	}, $this->model);
258
259	9	return get_class($result);
260		}
261		}
262

Laravel-Backpack / CRUD

Scrutinizer GitHub App not installed

Push — master ( 0be2ba...247314 )

CrudPanel::setRouteName() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like