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

Completed

Push — master ( 54fb66...bd2bad )

by Cristian

created 2017-11-06 11:51 UTC

Read::getFields() A

↳ Parent: Read

Complexity

Conditions	3
Paths	3

Size

Total Lines	16
Code Lines	11

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	6
CRAP Score	3.0261

Importance

Changes

Metric	Value
cc	3
eloc	11
nc	3
nop	2
dl	0
loc	16
ccs	6
cts	7
cp	0.8571
crap	3.0261
rs	9.4285
c	0
b	0
f	0

<?php

namespace Backpack\CRUD\PanelTraits;

trait Read
{
    /*
    |--------------------------------------------------------------------------
    |                                   READ
    |--------------------------------------------------------------------------
    */

    /**
     * Find and retrieve an entry in the database or fail.
     *
     * @param  [int] The id of the row in the db to fetch.
     *
     * @return [Eloquent Collection] The row in the db.

     */
    public function getEntry($id)

    {
        if (! $this->entry) {
            $this->entry = $this->model->findOrFail($id);
class MyClass { }

$x = new MyClass();
$x->foo = true;
            $this->entry = $this->entry->withFakes();
        }

        return $this->entry;
    }

    /**
     * Make the query JOIN all relationships used in the columns, too,
     * so there will be less database queries overall.
     */
    public function autoEagerLoadRelationshipColumns()
    {
        $relationships = $this->getColumnsRelationships();
trait Idable {
    public function equalIds(Idable $other) {
        return $this->getId() === $other->getId();
    }
}

        if (count($relationships)) {
            $this->with($relationships);
trait Idable {
    public function equalIds(Idable $other) {
        return $this->getId() === $other->getId();
    }
}
        }
    }

    /**
     * Get all entries from the database.
     *
     * @return [Collection of your model]

     */
    public function getEntries()

    {
        $this->autoEagerLoadRelationshipColumns();

        $entries = $this->query->get();
class MyClass { }

$x = new MyClass();
$x->foo = true;

        // add the fake columns for each entry
        foreach ($entries as $key => $entry) {
            $entry->addFakes($this->getFakeColumnsAsArray());
trait Idable {
    public function equalIds(Idable $other) {
        return $this->getId() === $other->getId();
    }
}
        }

        return $entries;
    }

    /**
     * Get the fields for the create or update forms.
     *
     * @param  [form] create / update / both - defaults to 'both'
     * @param  [integer] the ID of the entity to be edited in the Update form
     *
     * @return [array] all the fields that need to be shown and their information

     */
    public function getFields($form, $id = false)

    {
        switch (strtolower($form)) {
            case 'create':
                return $this->getCreateFields();
trait Idable {
    public function equalIds(Idable $other) {
        return $this->getId() === $other->getId();
    }
}
                break;
switch ($x) {
    case 1:
        return 'foo';
        break; // This break is not necessary and can be left off.
}

            case 'update':
                return $this->getUpdateFields($id);
trait Idable {
    public function equalIds(Idable $other) {
        return $this->getId() === $other->getId();
    }
}
                break;
switch ($x) {
    case 1:
        return 'foo';
        break; // This break is not necessary and can be left off.
}

            default:
                return $this->getCreateFields();
trait Idable {
    public function equalIds(Idable $other) {
        return $this->getId() === $other->getId();
    }
}
                break;
switch ($x) {
    case 1:
        return 'foo';
        break; // This break is not necessary and can be left off.
}
        }
    }

    /**
     * Check if the create/update form has upload fields.
     * Upload fields are the ones that have "upload" => true defined on them.
     * @param  [form] create / update / both - defaults to 'both'
     * @param  [id] id of the entity - defaults to false
     * @return bool
     */
    public function hasUploadFields($form, $id = false)
    {
        $fields = $this->getFields($form, $id);
        $upload_fields = array_where($fields, function ($value, $key) {

            return isset($value['upload']) && $value['upload'] == true;
        });

        return count($upload_fields) ? true : false;
    }

    /**
     * Enable the DETAILS ROW functionality:.
     *
     * In the table view, show a plus sign next to each entry.
     * When clicking that plus sign, an AJAX call will bring whatever content you want from the EntityCrudController::showDetailsRow($id) and show it to the user.

     */
    public function enableDetailsRow()
    {
        $this->details_row = true;
class MyClass { }

$x = new MyClass();
$x->foo = true;
    }

    /**
     * Disable the DETAILS ROW functionality:.
     */
    public function disableDetailsRow()
    {
        $this->details_row = false;
    }

    /**
     * Set the number of rows that should be show on the table page (list view).
     */
    public function setDefaultPageLength($value)
    {
        $this->default_page_length = $value;
class MyClass { }

$x = new MyClass();
$x->foo = true;
    }

    /**
     * Get the number of rows that should be show on the table page (list view).
     */
    public function getDefaultPageLength()
    {
        // return the custom value for this crud panel, if set using setPageLength()
        if ($this->default_page_length) {
            return $this->default_page_length;
        }

        // otherwise return the default value in the config file
        if (config('backpack.crud.default_page_length')) {
            return config('backpack.crud.default_page_length');
        }

        return 25;
    }

    /*
    |--------------------------------------------------------------------------
    |                                EXPORT BUTTONS
    |--------------------------------------------------------------------------
    */

    /**
     * Tell the list view to show the DataTables export buttons.
     */
    public function enableExportButtons()
    {
        $this->export_buttons = true;
class MyClass { }

$x = new MyClass();
$x->foo = true;
    }

    /**
     * Check if export buttons are enabled for the table view.
     * @return bool
     */
    public function exportButtons()
    {
        return $this->export_buttons;
    }
}


1		<?php
2
3		namespace Backpack\CRUD\PanelTraits;
4
5		trait Read
6		{
7		/*
8		\|--------------------------------------------------------------------------
9		\| READ
10		\|--------------------------------------------------------------------------
11		*/
12
13		/**
14		* Find and retrieve an entry in the database or fail.
15		*
16		* @param [int] The id of the row in the db to fetch.
17		*
18		* @return [Eloquent Collection] The row in the db.
		0 ignored issues – show Documentation introduced 2016-05-18 15:19 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...
19		*/
20	17	public function getEntry($id)
		0 ignored issues – show Documentation introduced 2017-08-03 17:04 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...
21		{
22	17	if (! $this->entry) {
23	17	$this->entry = $this->model->findOrFail($id);
		0 ignored issues – show Bug introduced 2017-02-13 15:30 UTC by Report Bug Copy Issue Report The property `entry` does not exist. Did you maybe forget to declare it? In PHP it is possible to write to properties without declaring them. For example, the following is perfectly valid PHP code: class MyClass { } $x = new MyClass(); $x->foo = true; Generally, it is a good practice to explictly declare properties to avoid accidental typos and provide IDE auto-completion: class MyClass { public $foo; } $x = new MyClass(); $x->foo = true; Loading history... Bug introduced 2016-06-16 14:52 UTC by Report Bug Copy Issue Report The property `model` does not exist. Did you maybe forget to declare it? In PHP it is possible to write to properties without declaring them. For example, the following is perfectly valid PHP code: class MyClass { } $x = new MyClass(); $x->foo = true; Generally, it is a good practice to explictly declare properties to avoid accidental typos and provide IDE auto-completion: class MyClass { public $foo; } $x = new MyClass(); $x->foo = true; Loading history...
24	10	$this->entry = $this->entry->withFakes();
25		}
26
27	10	return $this->entry;
28		}
29
30		/**
31		* Make the query JOIN all relationships used in the columns, too,
32		* so there will be less database queries overall.
33		*/
34	3	public function autoEagerLoadRelationshipColumns()
35		{
36	3	$relationships = $this->getColumnsRelationships();
		0 ignored issues – show Bug introduced 2017-04-18 11:15 UTC by Report Bug Copy Issue Report It seems like `getColumnsRelationships()` must be provided by classes using this trait. How about adding it as abstract method to this trait? This check looks for methods that are used by a trait but not required by it. To illustrate, let’s look at the following code example trait Idable { public function equalIds(Idable $other) { return $this->getId() === $other->getId(); } } The trait `Idable` provides a method `equalsId` that in turn relies on the method `getId()`. If this method does not exist on a class mixing in this trait, the method will fail. Adding the `getId()` as an abstract method to the trait will make sure it is available. Loading history...
37
38	3	if (count($relationships)) {
39	1	$this->with($relationships);
		0 ignored issues – show Bug introduced 2017-04-18 11:15 UTC by Report Bug Copy Issue Report It seems like `with()` must be provided by classes using this trait. How about adding it as abstract method to this trait? This check looks for methods that are used by a trait but not required by it. To illustrate, let’s look at the following code example trait Idable { public function equalIds(Idable $other) { return $this->getId() === $other->getId(); } } The trait `Idable` provides a method `equalsId` that in turn relies on the method `getId()`. If this method does not exist on a class mixing in this trait, the method will fail. Adding the `getId()` as an abstract method to the trait will make sure it is available. Loading history...
40		}
41	3	}
42
43		/**
44		* Get all entries from the database.
45		*
46		* @return [Collection of your model]
		0 ignored issues – show Documentation introduced 2016-06-16 14:52 UTC by Report Bug Copy Issue Report The doc-type `Collection">[Collection` 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...
47		*/
48	1	public function getEntries()
		0 ignored issues – show Documentation introduced 2017-08-03 17:04 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...
49		{
50	1	$this->autoEagerLoadRelationshipColumns();
51
52	1	$entries = $this->query->get();
		0 ignored issues – show Bug introduced 2017-04-18 11:15 UTC by Report Bug Copy Issue Report The property `query` does not exist. Did you maybe forget to declare it? In PHP it is possible to write to properties without declaring them. For example, the following is perfectly valid PHP code: class MyClass { } $x = new MyClass(); $x->foo = true; Generally, it is a good practice to explictly declare properties to avoid accidental typos and provide IDE auto-completion: class MyClass { public $foo; } $x = new MyClass(); $x->foo = true; Loading history...
53
54		// add the fake columns for each entry
55	1	foreach ($entries as $key => $entry) {
56	1	$entry->addFakes($this->getFakeColumnsAsArray());
		0 ignored issues – show Bug introduced 2017-02-14 09:48 UTC by Report Bug Copy Issue Report It seems like `getFakeColumnsAsArray()` must be provided by classes using this trait. How about adding it as abstract method to this trait? This check looks for methods that are used by a trait but not required by it. To illustrate, let’s look at the following code example trait Idable { public function equalIds(Idable $other) { return $this->getId() === $other->getId(); } } The trait `Idable` provides a method `equalsId` that in turn relies on the method `getId()`. If this method does not exist on a class mixing in this trait, the method will fail. Adding the `getId()` as an abstract method to the trait will make sure it is available. Loading history...
57		}
58
59	1	return $entries;
60		}
61
62		/**
63		* Get the fields for the create or update forms.
64		*
65		* @param [form] create / update / both - defaults to 'both'
66		* @param [integer] the ID of the entity to be edited in the Update form
67		*
68		* @return [array] all the fields that need to be shown and their information
		0 ignored issues – show Documentation introduced 2016-06-16 14:52 UTC by Report Bug Copy Issue Report The doc-type `[array]` 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...
69		*/
70	23	public function getFields($form, $id = false)
		0 ignored issues – show Documentation introduced 2017-08-03 17:04 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...
71		{
72	23	switch (strtolower($form)) {
73	23	case 'create':
74	14	return $this->getCreateFields();
		0 ignored issues – show Bug introduced 2017-04-18 11:15 UTC by Report Bug Copy Issue Report It seems like `getCreateFields()` must be provided by classes using this trait. How about adding it as abstract method to this trait? This check looks for methods that are used by a trait but not required by it. To illustrate, let’s look at the following code example trait Idable { public function equalIds(Idable $other) { return $this->getId() === $other->getId(); } } The trait `Idable` provides a method `equalsId` that in turn relies on the method `getId()`. If this method does not exist on a class mixing in this trait, the method will fail. Adding the `getId()` as an abstract method to the trait will make sure it is available. Loading history...
75		break;
		0 ignored issues – show Unused Code introduced 2017-04-18 11:15 UTC by Report Bug Copy Issue Report `break` is not strictly necessary here and could be removed. The `break` statement is not necessary if it is preceded for example by a `return` statement: switch ($x) { case 1: return 'foo'; break; // This break is not necessary and can be left off. } If you would like to keep this construct to be consistent with other `case` statements, you can safely mark this issue as a false-positive. Loading history...
76
77	11	case 'update':
78	11	return $this->getUpdateFields($id);
		0 ignored issues – show Bug introduced 2017-04-18 11:15 UTC by Report Bug Copy Issue Report It seems like `getUpdateFields()` must be provided by classes using this trait. How about adding it as abstract method to this trait? This check looks for methods that are used by a trait but not required by it. To illustrate, let’s look at the following code example trait Idable { public function equalIds(Idable $other) { return $this->getId() === $other->getId(); } } The trait `Idable` provides a method `equalsId` that in turn relies on the method `getId()`. If this method does not exist on a class mixing in this trait, the method will fail. Adding the `getId()` as an abstract method to the trait will make sure it is available. Loading history...
79		break;
		0 ignored issues – show Unused Code introduced 2017-04-18 11:15 UTC by Report Bug Copy Issue Report `break` is not strictly necessary here and could be removed. The `break` statement is not necessary if it is preceded for example by a `return` statement: switch ($x) { case 1: return 'foo'; break; // This break is not necessary and can be left off. } If you would like to keep this construct to be consistent with other `case` statements, you can safely mark this issue as a false-positive. Loading history...
80
81		default:
82		return $this->getCreateFields();
		0 ignored issues – show Bug introduced 2017-04-18 11:15 UTC by Report Bug Copy Issue Report It seems like `getCreateFields()` must be provided by classes using this trait. How about adding it as abstract method to this trait? This check looks for methods that are used by a trait but not required by it. To illustrate, let’s look at the following code example trait Idable { public function equalIds(Idable $other) { return $this->getId() === $other->getId(); } } The trait `Idable` provides a method `equalsId` that in turn relies on the method `getId()`. If this method does not exist on a class mixing in this trait, the method will fail. Adding the `getId()` as an abstract method to the trait will make sure it is available. Loading history...
83		break;
		0 ignored issues – show Unused Code introduced 2017-04-18 11:15 UTC by Report Bug Copy Issue Report `break` is not strictly necessary here and could be removed. The `break` statement is not necessary if it is preceded for example by a `return` statement: switch ($x) { case 1: return 'foo'; break; // This break is not necessary and can be left off. } If you would like to keep this construct to be consistent with other `case` statements, you can safely mark this issue as a false-positive. Loading history...
84		}
85		}
86
87		/**
88		* Check if the create/update form has upload fields.
89		* Upload fields are the ones that have "upload" => true defined on them.
90		* @param [form] create / update / both - defaults to 'both'
91		* @param [id] id of the entity - defaults to false
92		* @return bool
93		*/
94	4	public function hasUploadFields($form, $id = false)
95		{
96	4	$fields = $this->getFields($form, $id);
97	3	$upload_fields = array_where($fields, function ($value, $key) {
		0 ignored issues – show Unused Code introduced 2016-09-14 15:57 UTC by Report Bug Copy Issue Report The parameter `$key` 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...
98	3	return isset($value['upload']) && $value['upload'] == true;
99	3	});
100
101	3	return count($upload_fields) ? true : false;
102		}
103
104		/**
105		* Enable the DETAILS ROW functionality:.
106		*
107		* In the table view, show a plus sign next to each entry.
108		* When clicking that plus sign, an AJAX call will bring whatever content you want from the EntityCrudController::showDetailsRow($id) and show it to the user.
		0 ignored issues – show Coding Style introduced 2016-05-20 15:02 UTC by Report Bug Copy Issue Report This line exceeds maximum limit of 120 characters; contains 162 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...
109		*/
110	1	public function enableDetailsRow()
111		{
112	1	$this->details_row = true;
		0 ignored issues – show Bug introduced 2017-08-03 17:04 UTC by Report Bug Copy Issue Report The property `details_row` does not exist. Did you maybe forget to declare it? In PHP it is possible to write to properties without declaring them. For example, the following is perfectly valid PHP code: class MyClass { } $x = new MyClass(); $x->foo = true; Generally, it is a good practice to explictly declare properties to avoid accidental typos and provide IDE auto-completion: class MyClass { public $foo; } $x = new MyClass(); $x->foo = true; Loading history...
113	1	}
114
115		/**
116		* Disable the DETAILS ROW functionality:.
117		*/
118	1	public function disableDetailsRow()
119		{
120	1	$this->details_row = false;
121	1	}
122
123		/**
124		* Set the number of rows that should be show on the table page (list view).
125		*/
126	1	public function setDefaultPageLength($value)
127		{
128	1	$this->default_page_length = $value;
		0 ignored issues – show Bug introduced 2016-07-22 16:53 UTC by Report Bug Copy Issue Report The property `default_page_length` does not exist. Did you maybe forget to declare it? In PHP it is possible to write to properties without declaring them. For example, the following is perfectly valid PHP code: class MyClass { } $x = new MyClass(); $x->foo = true; Generally, it is a good practice to explictly declare properties to avoid accidental typos and provide IDE auto-completion: class MyClass { public $foo; } $x = new MyClass(); $x->foo = true; Loading history...
129	1	}
130
131		/**
132		* Get the number of rows that should be show on the table page (list view).
133		*/
134	2	public function getDefaultPageLength()
135		{
136		// return the custom value for this crud panel, if set using setPageLength()
137	2	if ($this->default_page_length) {
138	1	return $this->default_page_length;
139		}
140
141		// otherwise return the default value in the config file
142	1	if (config('backpack.crud.default_page_length')) {
143		return config('backpack.crud.default_page_length');
144		}
145
146	1	return 25;
147		}
148
149		/*
150		\|--------------------------------------------------------------------------
151		\| EXPORT BUTTONS
152		\|--------------------------------------------------------------------------
153		*/
154
155		/**
156		* Tell the list view to show the DataTables export buttons.
157		*/
158	1	public function enableExportButtons()
159		{
160	1	$this->export_buttons = true;
		0 ignored issues – show Bug introduced 2016-09-12 13:47 UTC by Report Bug Copy Issue Report The property `export_buttons` does not exist. Did you maybe forget to declare it? In PHP it is possible to write to properties without declaring them. For example, the following is perfectly valid PHP code: class MyClass { } $x = new MyClass(); $x->foo = true; Generally, it is a good practice to explictly declare properties to avoid accidental typos and provide IDE auto-completion: class MyClass { public $foo; } $x = new MyClass(); $x->foo = true; Loading history...
161	1	}
162
163		/**
164		* Check if export buttons are enabled for the table view.
165		* @return bool
166		*/
167	2	public function exportButtons()
168		{
169	2	return $this->export_buttons;
170		}
171		}
172

Laravel-Backpack / CRUD

Scrutinizer GitHub App not installed

Push — master ( 54fb66...bd2bad )

Read::getFields() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like