FakeFields::addCompactedField() - Code Metrics - Inspection of "Fix fakes with laravel casts" - Laravel-Backpack/CRUD - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Pull Request — master (#1116)

by Oliver

created 2017-11-18 13:24 UTC

FakeFields::addCompactedField() A

↳ Parent: FakeFields

Complexity

Conditions	1
Paths	1

Size

Total Lines	7
Code Lines	4

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	5
CRAP Score	1

Importance

Changes

Metric	Value
cc	1
eloc	4
nc	1
nop	3
dl	0
loc	7
ccs	5
cts	5
cp	1
crap	1
rs	9.4285
c	0
b	0
f	0

<?php

namespace Backpack\CRUD\PanelTraits;

trait FakeFields
{
    /**
     * Update the request input array to something that can be passed to the model's create or update function.
     * The resulting array will only include the fields that are stored in the database and their values,
     * plus the '_token' and 'redirect_after_save' variables.
     *
     * @param array $requestInput The request input.
     * @param string $form The CRUD form. Can be 'create' or 'update' . Default is 'create'.
     * @param int|bool $id The CRUD entry id in the case of the 'update' form.
     *
     * @see \Illuminate\Http\Request::all() For an example on how to get the request input.
     *
     * @return array The updated request input.
     */
    public function compactFakeFields($requestInput, $form = 'create', $id = false)
    {
        // get the right fields according to the form type (create/update)
        $fields = $this->getFields($form, $id);
trait Idable {
    public function equalIds(Idable $other) {
        return $this->getId() === $other->getId();
    }
}

        $compactedFakeFields = [];
        foreach ($fields as $field) {
            // compact fake fields
            if (isset($field['fake']) && $field['fake'] == true && array_key_exists($field['name'], $requestInput)) {
                $fakeFieldKey = isset($field['store_in']) ? $field['store_in'] : 'extras';
                $this->addCompactedField($requestInput, $field['name'], $fakeFieldKey);

                if (! in_array($fakeFieldKey, $compactedFakeFields)) {
                    $compactedFakeFields[] = $fakeFieldKey;
                }
            }
        }

        // json_encode all fake_value columns if applicable in the database, so they can be properly stored and interpreted

        foreach ($compactedFakeFields as $value) {
            if (! (property_exists($this->model, 'translatable') && in_array($value, $this->model->getTranslatableAttributes(), true)) && $this->model->shouldEncodeFake($value)) {
class MyClass { }

$x = new MyClass();
$x->foo = true;
                $requestInput[$value] = json_encode($requestInput[$value]);
            }
        }

        // if there are no fake fields defined, return the original request input
        return $requestInput;
    }

    /**
     * Compact a fake field in the request input array.
     *
     * @param array $requestInput The request input.
     * @param string $fakeFieldName The fake field name.
     * @param string $fakeFieldKey The fake field key.
     */
    private function addCompactedField(&$requestInput, $fakeFieldName, $fakeFieldKey)
    {
        $fakeField = $requestInput[$fakeFieldName];
        array_pull($requestInput, $fakeFieldName); // remove the fake field from the request

        $requestInput[$fakeFieldKey][$fakeFieldName] = $fakeField;
    }
}


1		<?php
2
3		namespace Backpack\CRUD\PanelTraits;
4
5		trait FakeFields
6		{
7		/**
8		* Update the request input array to something that can be passed to the model's create or update function.
9		* The resulting array will only include the fields that are stored in the database and their values,
10		* plus the '_token' and 'redirect_after_save' variables.
11		*
12		* @param array $requestInput The request input.
13		* @param string $form The CRUD form. Can be 'create' or 'update' . Default is 'create'.
14		* @param int\|bool $id The CRUD entry id in the case of the 'update' form.
15		*
16		* @see \Illuminate\Http\Request::all() For an example on how to get the request input.
17		*
18		* @return array The updated request input.
19		*/
20	11	public function compactFakeFields($requestInput, $form = 'create', $id = false)
21		{
22		// get the right fields according to the form type (create/update)
23	11	$fields = $this->getFields($form, $id);
		0 ignored issues – show Bug introduced 2017-04-18 11:15 UTC by Report Bug Copy Issue Report It seems like `getFields()` 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...
24
25	9	$compactedFakeFields = [];
26	9	foreach ($fields as $field) {
27		// compact fake fields
28	7	if (isset($field['fake']) && $field['fake'] == true && array_key_exists($field['name'], $requestInput)) {
29	2	$fakeFieldKey = isset($field['store_in']) ? $field['store_in'] : 'extras';
30	2	$this->addCompactedField($requestInput, $field['name'], $fakeFieldKey);
31
32	2	if (! in_array($fakeFieldKey, $compactedFakeFields)) {
33	7	$compactedFakeFields[] = $fakeFieldKey;
34		}
35		}
36		}
37
38		// json_encode all fake_value columns if applicable in the database, so they can be properly stored and interpreted
		0 ignored issues – show Coding Style introduced 2017-11-16 18:05 UTC by Report Bug Copy Issue Report This line exceeds maximum limit of 120 characters; contains 123 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...
39	9	foreach ($compactedFakeFields as $value) {
40	2	if (! (property_exists($this->model, 'translatable') && in_array($value, $this->model->getTranslatableAttributes(), true)) && $this->model->shouldEncodeFake($value)) {
		0 ignored issues – show Bug introduced 2017-11-16 18:05 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... Coding Style introduced 2017-11-16 18:05 UTC by Report Bug Copy Issue Report This line exceeds maximum limit of 120 characters; contains 179 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...
41	2	$requestInput[$value] = json_encode($requestInput[$value]);
42		}
43		}
44
45		// if there are no fake fields defined, return the original request input
46	9	return $requestInput;
47		}
48
49		/**
50		* Compact a fake field in the request input array.
51		*
52		* @param array $requestInput The request input.
53		* @param string $fakeFieldName The fake field name.
54		* @param string $fakeFieldKey The fake field key.
55		*/
56	2	private function addCompactedField(&$requestInput, $fakeFieldName, $fakeFieldKey)
57		{
58	2	$fakeField = $requestInput[$fakeFieldName];
59	2	array_pull($requestInput, $fakeFieldName); // remove the fake field from the request
60
61	2	$requestInput[$fakeFieldKey][$fakeFieldName] = $fakeField;
62	2	}
63		}
64

Laravel-Backpack / CRUD

Scrutinizer GitHub App not installed

Pull Request — master (#1116)

FakeFields::addCompactedField() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like