Update::getUpdateFields() - Code Metrics - Inspection of "Feature select2_many and select2_one" - Laravel-Backpack/CRUD - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Pull Request — master (#1453)

by Oliver

created 2018-06-09 18:20 UTC

Update::getUpdateFields() B

↳ Parent: Update

Complexity

Conditions	6
Paths	8

Size

Total Lines	30
Code Lines	17

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	13
CRAP Score	6.2373

Importance

Changes

Metric	Value
cc	6
eloc	17
nc	8
nop	1
dl	0
loc	30
ccs	13
cts	16
cp	0.8125
crap	6.2373
rs	8.439
c	0
b	0
f	0

<?php

namespace Backpack\CRUD\PanelTraits;

use Illuminate\Database\Eloquent\Relations\HasOne;
use Illuminate\Database\Eloquent\Relations\HasMany;

trait Update
{
    /*
    |--------------------------------------------------------------------------
    |                                   UPDATE
    |--------------------------------------------------------------------------
    */

    /**
     * Update a row in the database.
     *
     * @param  [Int] The entity's id
     * @param  [Request] All inputs to be updated.
     *
     * @return [Eloquent Collection]

     */
    public function update($id, $data)

    {
        $data = $this->decodeJsonCastedAttributes($data, 'update', $id);
trait Idable {
    public function equalIds(Idable $other) {
        return $this->getId() === $other->getId();
    }
}
        $data = $this->compactFakeFields($data, 'update', $id);
trait Idable {
    public function equalIds(Idable $other) {
        return $this->getId() === $other->getId();
    }
}

        $item = $this->model->findOrFail($id);
class MyClass { }

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

        $this->createRelations($item, $data, 'update');
trait Idable {
    public function equalIds(Idable $other) {
        return $this->getId() === $other->getId();
    }
}

        // omit the n-n relationships when updating the eloquent item
        $nn_relationships = array_pluck($this->getRelationFieldsWithPivot('update'), 'name');
trait Idable {
    public function equalIds(Idable $other) {
        return $this->getId() === $other->getId();
    }
}
        $data = array_except($data, $nn_relationships);
        $updated = $item->update($data);
$myVar = 'Value';
$higher = false;

if (rand(1, 6) > 3) {
    $higher = true;
} else {
    $higher = false;
}

        return $item;
    }

    /**
     * Get all fields needed for the EDIT ENTRY form.
     *
     * @param int $id The id of the entry that is being edited.
     *
     * @return array The fields with attributes, fake attributes and values.
     */
    public function getUpdateFields($id)
    {
        $fields = $this->update_fields;
class MyClass { }

$x = new MyClass();
$x->foo = true;
        $entry = $this->getEntry($id);
trait Idable {
    public function equalIds(Idable $other) {
        return $this->getId() === $other->getId();
    }
}

        foreach ($fields as &$field) {
            // set the value
            if (! isset($field['value'])) {
                if (isset($field['subfields'])) {
                    $field['value'] = [];
                    foreach ($field['subfields'] as $subfield) {
                        $field['value'][] = $entry->{$subfield['name']};
                    }
                } else {
                    $field['value'] = $this->getModelAttributeValue($entry, $field);
                }
            }
        }

        // always have a hidden input for the entry id
        if (! array_key_exists('id', $fields)) {
            $fields['id'] = [
                'name'  => $entry->getKeyName(),
                'value' => $entry->getKey(),
                'type'  => 'hidden',
            ];
        }

        return $fields;
    }

    /**
     * Get the value of the 'name' attribute from the declared relation model in the given field.
     *
     * @param \Illuminate\Database\Eloquent\Model $model The current CRUD model.
     * @param array $field The CRUD field array.
     *
     * @return mixed The value of the 'name' attribute from the relation model.
     */
    private function getModelAttributeValue($model, $field)
    {
        if (isset($field['entity'])) {
            $relationArray = explode('.', $field['entity']);
            $relatedModel = array_reduce(array_splice($relationArray, 0, -1), function ($obj, $method) {
                return $obj->{$method} ? $obj->{$method} : $obj;
            }, $model);

            $relationMethod = end($relationArray);
            if ($relatedModel->{$relationMethod} && $relatedModel->{$relationMethod}() instanceof HasOne) {
                return $relatedModel->{$relationMethod}->getKey();
            } elseif ($relatedModel->{$relationMethod} && $relatedModel->{$relationMethod}() instanceof HasMany) {
                return $relatedModel->{$relationMethod};
            } else {
                return $relatedModel->{$field['name']};
            }
        }

        return $model->{$field['name']};
    }
}


1		<?php
2
3		namespace Backpack\CRUD\PanelTraits;
4
5		use Illuminate\Database\Eloquent\Relations\HasOne;
6		use Illuminate\Database\Eloquent\Relations\HasMany;
7
8		trait Update
9		{
10		/*
11		\|--------------------------------------------------------------------------
12		\| UPDATE
13		\|--------------------------------------------------------------------------
14		*/
15
16		/**
17		* Update a row in the database.
18		*
19		* @param [Int] The entity's id
20		* @param [Request] All inputs to be updated.
21		*
22		* @return [Eloquent Collection]
		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...
23		*/
24	2	public function update($id, $data)
		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...
25		{
26	2	$data = $this->decodeJsonCastedAttributes($data, 'update', $id);
		0 ignored issues – show Bug introduced 2017-04-18 11:15 UTC by Report Bug Copy Issue Report It seems like `decodeJsonCastedAttributes()` 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...
27	1	$data = $this->compactFakeFields($data, 'update', $id);
		0 ignored issues – show Bug introduced 2017-04-18 11:15 UTC by Report Bug Copy Issue Report It seems like `compactFakeFields()` 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...
28
29	1	$item = $this->model->findOrFail($id);
		0 ignored issues – show Bug introduced 2017-04-18 11:15 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...
30
31	1	$this->createRelations($item, $data, 'update');
		0 ignored issues – show Bug introduced 2018-03-21 17:24 UTC by Report Bug Copy Issue Report It seems like `createRelations()` 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...
32
33		// omit the n-n relationships when updating the eloquent item
34	1	$nn_relationships = array_pluck($this->getRelationFieldsWithPivot('update'), 'name');
		0 ignored issues – show Bug introduced 2017-04-18 11:15 UTC by Report Bug Copy Issue Report It seems like `getRelationFieldsWithPivot()` 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...
35	1	$data = array_except($data, $nn_relationships);
36	1	$updated = $item->update($data);
		0 ignored issues – show Unused Code introduced 2016-12-14 12:01 UTC by Report Bug Copy Issue Report `$updated` is not used, you could remove the assignment. This check looks for variable assignements that are either overwritten by other assignments or where the variable is not used subsequently. $myVar = 'Value'; $higher = false; if (rand(1, 6) > 3) { $higher = true; } else { $higher = false; } Both the `$myVar` assignment in line 1 and the `$higher` assignment in line 2 are dead. The first because `$myVar` is never used and the second because `$higher` is always overwritten for every possible time line. Loading history...
37
38	1	return $item;
39		}
40
41		/**
42		* Get all fields needed for the EDIT ENTRY form.
43		*
44		* @param int $id The id of the entry that is being edited.
45		*
46		* @return array The fields with attributes, fake attributes and values.
47		*/
48	14	public function getUpdateFields($id)
49		{
50	14	$fields = $this->update_fields;
		0 ignored issues – show Bug introduced 2017-04-18 11:15 UTC by Report Bug Copy Issue Report The property `update_fields` 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...
51	14	$entry = $this->getEntry($id);
		0 ignored issues – show Bug introduced 2017-04-18 11:15 UTC by Report Bug Copy Issue Report It seems like `getEntry()` 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...
52
53	8	foreach ($fields as &$field) {
54		// set the value
55	7	if (! isset($field['value'])) {
56	7	if (isset($field['subfields'])) {
57		$field['value'] = [];
58		foreach ($field['subfields'] as $subfield) {
59		$field['value'][] = $entry->{$subfield['name']};
60		}
61		} else {
62	7	$field['value'] = $this->getModelAttributeValue($entry, $field);
63		}
64		}
65		}
66
67		// always have a hidden input for the entry id
68	8	if (! array_key_exists('id', $fields)) {
69	6	$fields['id'] = [
70	6	'name' => $entry->getKeyName(),
71	6	'value' => $entry->getKey(),
72	6	'type' => 'hidden',
73		];
74		}
75
76	8	return $fields;
77		}
78
79		/**
80		* Get the value of the 'name' attribute from the declared relation model in the given field.
81		*
82		* @param \Illuminate\Database\Eloquent\Model $model The current CRUD model.
83		* @param array $field The CRUD field array.
84		*
85		* @return mixed The value of the 'name' attribute from the relation model.
86		*/
87	7	private function getModelAttributeValue($model, $field)
88		{
89	7	if (isset($field['entity'])) {
90		$relationArray = explode('.', $field['entity']);
91		$relatedModel = array_reduce(array_splice($relationArray, 0, -1), function ($obj, $method) {
92		return $obj->{$method} ? $obj->{$method} : $obj;
93		}, $model);
94
95		$relationMethod = end($relationArray);
96		if ($relatedModel->{$relationMethod} && $relatedModel->{$relationMethod}() instanceof HasOne) {
97		return $relatedModel->{$relationMethod}->getKey();
98		} elseif ($relatedModel->{$relationMethod} && $relatedModel->{$relationMethod}() instanceof HasMany) {
99		return $relatedModel->{$relationMethod};
100		} else {
101		return $relatedModel->{$field['name']};
102		}
103		}
104
105	7	return $model->{$field['name']};
106		}
107		}
108

Laravel-Backpack / CRUD

Scrutinizer GitHub App not installed

Pull Request — master (#1453)

Update::getUpdateFields() B

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like