ModelConfiguration::newInstance()   A
last analyzed

Complexity

Conditions 2
Paths 2

Size

Total Lines 9

Duplication

Lines 0
Ratio 0 %

Importance

Changes 0
Metric Value
dl 0
loc 9
rs 9.9666
c 0
b 0
f 0
cc 2
nc 2
nop 2
1
<?php
2
3
namespace MaksimM\MultiUnitModels\Traits;
4
5
use MaksimM\MultiUnitModels\Exceptions\NotSupportedMultiUnitField;
6
7
trait ModelConfiguration
8
{
9
    /**
10
     * @return array
11
     */
12
    public function getFillable()
13
    {
14
        return array_merge($this->getUnitConversionDataColumns(), parent::getFillable());
0 ignored issues
show
Bug introduced by
It seems like getUnitConversionDataColumns() 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...
15
    }
16
17
    /**
18
     * @return mixed
19
     */
20
    public function getHidden()
21
    {
22
        return array_merge(parent::getHidden(), $this->getUnitConversionDataColumns());
0 ignored issues
show
Bug introduced by
It seems like getUnitConversionDataColumns() 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
    }
24
25
    public function scopeSelectedUnits($query, $units)
26
    {
27
        foreach ($units as $unitBasedColumn => $unit) {
28
            $query->getModel()->setMultiUnitFieldSelectedUnit($unitBasedColumn, $unit);
29
        }
30
    }
31
32
    /**
33
     * Create a new instance of the given model.
34
     *
35
     * @param array $attributes
36
     * @param bool  $exists
37
     *
38
     * @throws NotSupportedMultiUnitField
39
     *
40
     * @return static
41
     */
42
    public function newInstance($attributes = [], $exists = false)
43
    {
44
        $model = parent::newInstance($attributes, $exists);
45
        foreach ($this->getMultiUnitColumns() as $unitBasedColumn => $options) {
0 ignored issues
show
Bug introduced by
It seems like getMultiUnitColumns() 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...
46
            $model->setMultiUnitFieldSelectedUnit($unitBasedColumn, $this->getMultiUnitFieldSelectedUnit($unitBasedColumn)->getId());
0 ignored issues
show
Bug introduced by
It seems like getMultiUnitFieldSelectedUnit() 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...
47
        }
48
49
        return $model;
50
    }
51
52
    /**
53
     * Determine if a get mutator exists for an attribute.
54
     *coo.
55
     *
56
     * @param string $key
57
     *
58
     * @return bool
59
     */
60
    public function hasGetMutator($key)
61
    {
62
        if ($this->isMultiUnitField($key) && isset($this->{$key})) {
0 ignored issues
show
Bug introduced by
It seems like isMultiUnitField() 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...
63
            return true;
64
        }
65
66
        return parent::hasGetMutator($key);
67
    }
68
69
    /**
70
     * Get the value of an attribute using its mutator.
71
     *
72
     * @param string $key
73
     * @param mixed  $value
74
     *
75
     * @throws NotSupportedMultiUnitField
76
     *
77
     * @return mixed
78
     */
79
    public function mutateAttribute($key, $value)
80
    {
81
        if ($this->isMultiUnitField($key)) {
0 ignored issues
show
Bug introduced by
It seems like isMultiUnitField() 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...
82
            $requestedUnit = $this->getMultiUnitFieldUnit($key);
0 ignored issues
show
Bug introduced by
It seems like getMultiUnitFieldUnit() 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
84
            $value = $this->getMultiUnitFieldValue($key, new $requestedUnit());
0 ignored issues
show
Bug introduced by
It seems like getMultiUnitFieldValue() 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...
85
            if (parent::hasGetMutator($key)) {
0 ignored issues
show
Comprehensibility Bug introduced by
It seems like you call parent on a different method (hasGetMutator() instead of mutateAttribute()). Are you sure this is correct? If so, you might want to change this to $this->hasGetMutator().

This check looks for a call to a parent method whose name is different than the method from which it is called.

Consider the following code:

class Daddy
{
    protected function getFirstName()
    {
        return "Eidur";
    }

    protected function getSurName()
    {
        return "Gudjohnsen";
    }
}

class Son
{
    public function getFirstName()
    {
        return parent::getSurname();
    }
}

The getFirstName() method in the Son calls the wrong method in the parent class.

Loading history...
86
                return parent::mutateAttribute($key, $value);
87
            }
88
89
            return $value;
90
        }
91
92
        return parent::mutateAttribute($key, $value);
93
    }
94
95
    /**
96
     * Allows to set input units and process them before multi-unit field.
97
     *
98
     * @param array $attributes
99
     *
100
     * @return array
101
     */
102
    protected function fillableFromArray(array $attributes)
103
    {
104
        return array_merge($attributes, parent::fillableFromArray($attributes));
105
    }
106
107
    /**
108
     * Detect changes and set proper database value.
109
     *
110
     * @param $field
111
     * @param $value
112
     *
113
     * @throws NotSupportedMultiUnitField
114
     *
115
     * @return mixed
116
     */
117
    private function processMultiUnitFieldChanges($field, $value)
118
    {
119
        if (!is_null($value)) {
120
            $existingConversionData = $this->getMultiUnitExistingConversionData($field);
0 ignored issues
show
Bug introduced by
It seems like getMultiUnitExistingConversionData() 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...
121
            if (!is_null($existingConversionData)) {
122
                $inputUnit = $this->getMultiUnitFieldUnit($field);
0 ignored issues
show
Bug introduced by
It seems like getMultiUnitFieldUnit() 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...
123
                //change existing value only in case if new value doesn't match with stored conversion table or not exists
124
                if (!isset(
125
                        $existingConversionData->{$inputUnit->getId()}
126
                    ) || $value != $existingConversionData->{$inputUnit->getId()}) {
127
                    $defaultUnitValue = (new $inputUnit($value))->as($this->getMultiUnitFieldDefaultUnit($field));
0 ignored issues
show
Bug introduced by
It seems like getMultiUnitFieldDefaultUnit() 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...
128
                    $this->attributes[$field] = $defaultUnitValue;
0 ignored issues
show
Bug introduced by
The property attributes 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
                } elseif ($value == $existingConversionData->{$inputUnit->getId()}) {
130
                    //forget changes if value actually isn't changed
131
                    $defaultUnitValue = $existingConversionData->{$this->getMultiUnitFieldDefaultUnit($field)->getId()};
0 ignored issues
show
Bug introduced by
It seems like getMultiUnitFieldDefaultUnit() 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...
132
                    $this->attributes[$field] = $defaultUnitValue;
133
                    $this->syncOriginalAttribute($field);
0 ignored issues
show
Bug introduced by
It seems like syncOriginalAttribute() 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...
134
                }
135
136
                return $defaultUnitValue;
0 ignored issues
show
Bug introduced by
The variable $defaultUnitValue does not seem to be defined for all execution paths leading up to this point.

If you define a variable conditionally, it can happen that it is not defined for all execution paths.

Let’s take a look at an example:

function myFunction($a) {
    switch ($a) {
        case 'foo':
            $x = 1;
            break;

        case 'bar':
            $x = 2;
            break;
    }

    // $x is potentially undefined here.
    echo $x;
}

In the above example, the variable $x is defined if you pass “foo” or “bar” as argument for $a. However, since the switch statement has no default case statement, if you pass any other value, the variable $x would be undefined.

Available Fixes

  1. Check for existence of the variable explicitly:

    function myFunction($a) {
        switch ($a) {
            case 'foo':
                $x = 1;
                break;
    
            case 'bar':
                $x = 2;
                break;
        }
    
        if (isset($x)) { // Make sure it's always set.
            echo $x;
        }
    }
    
  2. Define a default value for the variable:

    function myFunction($a) {
        $x = ''; // Set a default which gets overridden for certain paths.
        switch ($a) {
            case 'foo':
                $x = 1;
                break;
    
            case 'bar':
                $x = 2;
                break;
        }
    
        echo $x;
    }
    
  3. Add a value for the missing path:

    function myFunction($a) {
        switch ($a) {
            case 'foo':
                $x = 1;
                break;
    
            case 'bar':
                $x = 2;
                break;
    
            // We add support for the missing case.
            default:
                $x = '';
                break;
        }
    
        echo $x;
    }
    
Loading history...
137
            }
138
        }
139
140
        $this->attributes[$field] = $value;
141
142
        return $value;
143
    }
144
}
145