Create::getRelationFieldsWithPivot() - Code Metrics - Inspection of "Multilanguage Feature for Spatie/LaravelTranslatab..." - Laravel-Backpack/CRUD - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Pull Request — master (#382)

by Cristian

created 2017-01-23 12:11 UTC

Create::getRelationFieldsWithPivot() A

↳ Parent: Create

Complexity

Conditions	2
Paths	1

Size

Total Lines	8
Code Lines	4

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
cc	2
eloc	4
nc	1
nop	1
dl	0
loc	8
rs	9.4285
c	0
b	0
f	0

<?php

namespace Backpack\CRUD\PanelTraits;

trait Create
{
    /*
    |--------------------------------------------------------------------------
    |                                   CREATE
    |--------------------------------------------------------------------------
    */

    /**
     * Insert a row in the database.
     *
     * @param  [Request] All input values to be inserted.
     *
     * @return [Eloquent Collection]

     */
    public function create($data)

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

        // ommit the n-n relationships when updating the eloquent item
        $nn_relationships = array_pluck($this->getRelationFieldsWithPivot('update'), 'name');
        $item = $this->model->create(array_except($data, $nn_relationships));
class MyClass { }

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

        // if there are any relationships available, also sync those
        $this->syncPivot($item, $data);

        return $item;
    }

    /**
     * Get all fields needed for the ADD NEW ENTRY form.
     *
     * @return [array] The fields with attributes and fake attributes.

     */
    public function getCreateFields()

    {
        return $this->create_fields;
class MyClass { }

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

    /**
     * Get all fields with relation set (model key set on field).
     *
     * @param [string: create/update/both]
     *
     * @return [array] The fields with model key set.

     */
    public function getRelationFields($form = 'create')
    {
        if ($form == 'create') {
            $fields = $this->create_fields;
        } else {
            $fields = $this->update_fields;
class MyClass { }

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

        $relationFields = [];

        foreach ($fields as $field) {
            if (isset($field['model'])) {
                array_push($relationFields, $field);
            }

            if (isset($field['subfields']) &&
                is_array($field['subfields']) &&
                count($field['subfields'])) {
                foreach ($field['subfields'] as $subfield) {
                    array_push($relationFields, $subfield);
                }
            }
        }

        return $relationFields;
    }

    /**
     * Get all fields with n-n relation set (pivot table is true).
     *
     * @param [string: create/update/both]
     *
     * @return [array] The fields with n-n relationships.

     */
    public function getRelationFieldsWithPivot($form = 'create')
    {
        $all_relation_fields = $this->getRelationFields($form);

        return array_where($all_relation_fields, function ($value, $key) {

            return isset($value['pivot']) && $value['pivot'];
        });
    }

    public function syncPivot($model, $data, $form = 'create')
    {
        $fields_with_relationships = $this->getRelationFields($form);

        foreach ($fields_with_relationships as $key => $field) {
            if (isset($field['pivot']) && $field['pivot']) {
                $values = isset($data[$field['name']]) ? $data[$field['name']] : [];
                $model->{$field['name']}()->sync($values);

                if (isset($field['pivotFields'])) {
                    foreach ($field['pivotFields'] as $pivotField) {
                        foreach ($data[$pivotField] as $pivot_id =>  $field) {
                            $model->{$field['name']}()->updateExistingPivot($pivot_id, [$pivotField => $field]);
                        }
                    }
                }
            }

            if (isset($field['morph']) && $field['morph']) {
                $values = isset($data[$field['name']]) ? $data[$field['name']] : [];
                if ($model->{$field['name']}) {
                    $model->{$field['name']}()->update($values);
                } else {
                    $model->{$field['name']}()->create($values);
                }
            }
        }
    }
}


1			<?php
2
3			namespace Backpack\CRUD\PanelTraits;
4
5			trait Create
6			{
7			/*
8			\|--------------------------------------------------------------------------
9			\| CREATE
10			\|--------------------------------------------------------------------------
11			*/
12
13			/**
14			* Insert a row in the database.
15			*
16			* @param [Request] All input values to be inserted.
17			*
18			* @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...
19			*/
20			public function create($data)
			0 ignored issues – show Documentation introduced 2016-06-16 14:52 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			$data = $this->decodeJsonCastedAttributes($data, 'create');
			0 ignored issues – show Bug introduced 2016-12-14 12:01 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...
23			$data = $this->compactFakeFields($data, 'create');
			0 ignored issues – show Bug introduced 2016-06-16 14:52 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...
24
25			// ommit the n-n relationships when updating the eloquent item
26			$nn_relationships = array_pluck($this->getRelationFieldsWithPivot('update'), 'name');
27			$item = $this->model->create(array_except($data, $nn_relationships));
			0 ignored issues – show Bug introduced 2016-12-23 13:37 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...
28
29			// if there are any relationships available, also sync those
30			$this->syncPivot($item, $data);
31
32			return $item;
33			}
34
35			/**
36			* Get all fields needed for the ADD NEW ENTRY form.
37			*
38			* @return [array] The fields with attributes and fake attributes.
			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...
39			*/
40			public function getCreateFields()
			0 ignored issues – show Documentation introduced 2016-06-16 14:52 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...
41			{
42			return $this->create_fields;
			0 ignored issues – show Bug introduced 2016-06-16 14:52 UTC by Report Bug Copy Issue Report The property `create_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...
43			}
44
45			/**
46			* Get all fields with relation set (model key set on field).
47			*
48			* @param [string: create/update/both]
49			*
50			* @return [array] The fields with model key set.
			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...
51			*/
52			public function getRelationFields($form = 'create')
53			{
54			if ($form == 'create') {
55			$fields = $this->create_fields;
56			} else {
57			$fields = $this->update_fields;
			0 ignored issues – show Bug introduced 2016-06-16 14:52 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...
58			}
59
60			$relationFields = [];
61
62			foreach ($fields as $field) {
63			if (isset($field['model'])) {
64			array_push($relationFields, $field);
65			}
66
67			if (isset($field['subfields']) &&
68			is_array($field['subfields']) &&
69			count($field['subfields'])) {
70			foreach ($field['subfields'] as $subfield) {
71			array_push($relationFields, $subfield);
72			}
73			}
74			}
75
76			return $relationFields;
77			}
78
79			/**
80			* Get all fields with n-n relation set (pivot table is true).
81			*
82			* @param [string: create/update/both]
83			*
84			* @return [array] The fields with n-n relationships.
			0 ignored issues – show Documentation introduced 2016-12-23 13:37 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...
85			*/
86			public function getRelationFieldsWithPivot($form = 'create')
87			{
88			$all_relation_fields = $this->getRelationFields($form);
89
90			return array_where($all_relation_fields, function ($value, $key) {
			0 ignored issues – show Unused Code introduced 2016-12-23 13:37 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...
91			return isset($value['pivot']) && $value['pivot'];
92			});
93			}
94
95			public function syncPivot($model, $data, $form = 'create')
96			{
97			$fields_with_relationships = $this->getRelationFields($form);
98
99			foreach ($fields_with_relationships as $key => $field) {
100			if (isset($field['pivot']) && $field['pivot']) {
101			$values = isset($data[$field['name']]) ? $data[$field['name']] : [];
102			$model->{$field['name']}()->sync($values);
103
104			if (isset($field['pivotFields'])) {
105			foreach ($field['pivotFields'] as $pivotField) {
106			foreach ($data[$pivotField] as $pivot_id => $field) {
107			$model->{$field['name']}()->updateExistingPivot($pivot_id, [$pivotField => $field]);
108			}
109			}
110			}
111			}
112
113			if (isset($field['morph']) && $field['morph']) {
114			$values = isset($data[$field['name']]) ? $data[$field['name']] : [];
115			if ($model->{$field['name']}) {
116			$model->{$field['name']}()->update($values);
117			} else {
118			$model->{$field['name']}()->create($values);
119			}
120			}
121			}
122			}
123			}
124

Laravel-Backpack / CRUD

Scrutinizer GitHub App not installed

Pull Request — master (#382)

Create::getRelationFieldsWithPivot() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like