HasRevaluableAttributes::getRevaluableAttributePrefix() - Code Metrics - Inspection of "Fixed the same prefix with mutator methods bug." - overtrue/laravel-revaluation - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( 6c51d8...c6abd6 )

by Carlos

created 2017-10-19 03:24 UTC

getRevaluableAttributePrefix() A

↳ Parent: HasRevaluableAttributes

Complexity

Conditions	1
Paths	1

Size

Total Lines	4
Code Lines	2

Duplication

Lines	0
Ratio	0 %

Importance

Changes

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

<?php

/*
 * This file is part of the overtrue/laravel-revaluation.
 *
 * (c) overtrue <[email protected]>
 *
 * This source file is subject to the MIT license that is bundled
 * with this source code in the file LICENSE.
 */

namespace Overtrue\LaravelRevaluation\Traits;

/**
 * Trait HasRevaluableAttributes.
 */
trait HasRevaluableAttributes
{
    /**
     * Revaluated attributes append to array.
     *
     * @var bool
     */
    //protected $appendRevaluatedAttributesToArray = true;


    /**
     * @var bool
     */
    //protected $replaceRawAttributesToArray = false;


    /**
     * Prefix of revaluated attribute getter.
     *
     * <pre>
     *      $model->revaluated_price;
     * </pre>
     *
     * @var string
     */
    //protected $revaluatedAttributePrefix = 'revaluated';


    /**
     * Return valuator instance of attribute.
     *
     * @param string $attribute
     *
     * @return \Overtrue\LaravelRevaluation\Revaluable
     */
    public function getRevaluatedAttribute($attribute)
    {
        $attribute = snake_case($attribute);

        if ($valuator = $this->getAttributeValuator($attribute)) {
            return new $valuator(parent::getAttribute($attribute), $attribute, $this);
class Daddy
{
    protected function getFirstName()
    {
        return "Eidur";
    }

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

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

        return false;
    }

    /**
     * Return revaluable attributes.
     *
     * @example
     *
     * <pre>
     * // 1. Using default valuator:
     * protected $revaluable = [
     *     'foo', 'bar', 'baz'
     * ];
     *
     * // 2. Use the specified valuator:
     * protected $revaluable = [
     *     'foo' => '\Foo\Support\Valuator\Foo',
     *     'bar' => '\Foo\Support\Valuator\Bar',
     *     'baz',
     * ];
     * </pre>
     *
     * @return array
     */
    public function getRevaluableAttributes()
    {
        if (!property_exists($this, 'revaluable') || !is_array($this->revaluable)) {
class MyClass { }

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

        $revaluable = [];

        foreach ($this->revaluable as $key => $valuator) {
            if (is_int($key)) {
                $revaluable[$valuator] = config('revaluation.default_valuator');
            } else {
                $revaluable[$valuator] = $valuator;
            }
        }

        return $revaluable;
    }

    /**
     * Return the additional attribute revaluate mutators.
     *
     * @return array
     */
    public function getRevaluateMutators()
    {
        return property_exists($this, 'revaluateMutators') ? (array) $this->revaluateMutators : [];
    }

    /**
     * @return string
     */
    public function getRevaluableAttributePrefix()
    {
        return rtrim($this->revaluatedAttributePrefix ?? 'revaluated', '_');
class MyClass { }

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

    /**
     * @example
     * <pre>
     * $object->revaluated_price;
     * $object->raw_price;
     * </pre>
     *
     * @param string $attribute
     *
     * @return mixed
     *
     * @throws \Exception
     */
    public function getAttribute($attribute)
    {
        if ($this->hasGetMutator($attribute)) {
class ParentClass {
    private $data = array();

    public function __call($method, array $args) {
        if (0 === strpos($method, 'get')) {
            return $this->data[strtolower(substr($method, 3))];
        }

        throw new \LogicException(sprintf('Unsupported method: %s', $method));
    }
}

/**
 * If this class knows which fields exist, you can specify the methods here:
 *
 * @method string getName()
 */
class SomeClass extends ParentClass { }
            return parent::getAttribute($attribute);
        }

        if (starts_with($attribute, 'raw_')) {
            return $this->getRevaluatedAttribute(substr($attribute, strlen('raw_')))->getRaw();
        }

        $prefix = $this->getRevaluableAttributePrefix();

        if (starts_with($attribute, $prefix)) {
            return $this->getRevaluatedAttribute(substr($attribute, strlen($prefix) + 1));
        }

        if ($valuator = $this->getRevaluatedAttribute($attribute)) {
            return $valuator->toDefaultFormat();
        }

        /**
         * <pre>
         * $revaluateMutators = [
         *     'display_price' => ['price', 'asCurrency'],
         * ];
         * </pre>.
         *
         * @var array
         */
        $revaluateMutators = $this->getRevaluateMutators();

        if (isset($revaluateMutators[$attribute])) {
            list($sourceAttribute, $method) = $revaluateMutators[$attribute];
            $revaluated = $this->getRevaluatedAttribute($sourceAttribute);

            if (!is_callable([$revaluated, $method])) {
                throw new \Exception("$method not an callable method.");
            }

            return call_user_func([$revaluated, $method]);
        }

        return parent::getAttribute($attribute);
    }

    /**
     * Set attribute.
     *
     * @param string $attribute
     * @param mixed  $value
     *
     * @return $this
     */
    public function setAttribute($attribute, $value)
    {
        if ($valuator = $this->getAttributeValuator($attribute)) {
            $value = forward_static_call([$valuator, 'toStorableValue'], $value);
        }

        return parent::setAttribute($attribute, $value);
    }

    /**
     * Override HasAttributes::attributesToArray.
     *
     * @return array
     */
    public function attributesToArray()
    {
        $attributes = parent::attributesToArray();

        if ($this->shouldAppendRevaluatedAttributesToArray()) {
            foreach (array_keys($this->getRevaluableAttributes()) as $attribute) {
                if ($valuator = $this->getRevaluatedAttribute($attribute)) {
                    $attribute = $this->shouldReplaceRawAttributesToArray() ? $attribute : $this->getRevaluablePrefixedAttributeName($attribute);
                    $attributes[$attribute] = $valuator->toDefaultFormat();
                }
            }
        }

        return $attributes;
    }

    /**
     * @param string $attribute
     *
     * @return string
     */
    public function getRevaluablePrefixedAttributeName($attribute)
    {
        return $this->getRevaluableAttributePrefix().'_'.$attribute;
    }

    /**
     * Fetch attribute.
     *
     * @example
     * <pre>
     * $object->getRevaluatedPriceAttribute();
     * $object->getRevaluatedXXXAttribute();
     * </pre>
     *
     * @param string $method
     *
     * @return mixed
     */
    public function __call($method, $args)
    {
        $prefix = studly_case($this->getRevaluableAttributePrefix());
        if (preg_match("/get{$prefix}(?<attribute>\\w+)Attribute/i", $method, $matches)) {
            return $this->getRevaluatedAttribute($matches['attribute']);
        }

        return parent::__call($method, $args);
    }

    /**
     * @return bool
     */
    protected function shouldAppendRevaluatedAttributesToArray()
    {
        return property_exists($this, 'appendRevaluatedAttributesToArray') ? $this->appendRevaluatedAttributesToArray : true;
class MyClass { }

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

    /**
     * @return bool
     */
    protected function shouldReplaceRawAttributesToArray()
    {
        return property_exists($this, 'replaceRawAttributesToArray') ? $this->replaceRawAttributesToArray : false;
class MyClass { }

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

    /**
     * Return revaluated value of attribute.
     *
     * @param string $attribute
     *
     * @return mixed
     */
    protected function getStorableValue($attribute)
    {
        if ($valuator = $this->getAttributeValuator($attribute)) {
            if (is_callable($valuator, 'toStorableValue')) {
                $value = forward_static_call([$valuator, 'toStorableValue'], $this->attributes[$attribute]);

            }
        }

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

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

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

    /**
     * Get attribute valuator.
     *
     * @param string $attribute
     *
     * @return string
     */
    protected function getAttributeValuator($attribute)
    {
        return array_get($this->getRevaluableAttributes(), $attribute);
    }
}


1			<?php
2
3			/*
4			* This file is part of the overtrue/laravel-revaluation.
5			*
6			* (c) overtrue <[email protected]>
7			*
8			* This source file is subject to the MIT license that is bundled
9			* with this source code in the file LICENSE.
10			*/
11
12			namespace Overtrue\LaravelRevaluation\Traits;
13
14			/**
15			* Trait HasRevaluableAttributes.
16			*/
17			trait HasRevaluableAttributes
18			{
19			/**
20			* Revaluated attributes append to array.
21			*
22			* @var bool
23			*/
24			//protected $appendRevaluatedAttributesToArray = true;
			0 ignored issues – show Unused Code Comprehensibility introduced 2017-07-05 11:40 UTC by Report Bug Copy Issue Report `50%` of this comment could be valid code. Did you maybe forget this after debugging? Sometimes obsolete code just ends up commented out instead of removed. In this case it is better to remove the code once you have checked you do not need it. The code might also have been commented out for debugging purposes. In this case it is vital that someone uncomments it again or your project may behave in very unexpected ways in production. This check looks for comments that seem to be mostly valid code and reports them. Loading history...
25
26			/**
27			* @var bool
28			*/
29			//protected $replaceRawAttributesToArray = false;
			0 ignored issues – show Unused Code Comprehensibility introduced 2017-07-05 11:40 UTC by Report Bug Copy Issue Report `50%` of this comment could be valid code. Did you maybe forget this after debugging? Sometimes obsolete code just ends up commented out instead of removed. In this case it is better to remove the code once you have checked you do not need it. The code might also have been commented out for debugging purposes. In this case it is vital that someone uncomments it again or your project may behave in very unexpected ways in production. This check looks for comments that seem to be mostly valid code and reports them. Loading history...
30
31			/**
32			* Prefix of revaluated attribute getter.
33			*
34			* <pre>
35			* $model->revaluated_price;
36			* </pre>
37			*
38			* @var string
39			*/
40			//protected $revaluatedAttributePrefix = 'revaluated';
			0 ignored issues – show Unused Code Comprehensibility introduced 2017-07-05 11:40 UTC by Report Bug Copy Issue Report `50%` of this comment could be valid code. Did you maybe forget this after debugging? Sometimes obsolete code just ends up commented out instead of removed. In this case it is better to remove the code once you have checked you do not need it. The code might also have been commented out for debugging purposes. In this case it is vital that someone uncomments it again or your project may behave in very unexpected ways in production. This check looks for comments that seem to be mostly valid code and reports them. Loading history...
41
42			/**
43			* Return valuator instance of attribute.
44			*
45			* @param string $attribute
46			*
47			* @return \Overtrue\LaravelRevaluation\Revaluable
48			*/
49			public function getRevaluatedAttribute($attribute)
50			{
51			$attribute = snake_case($attribute);
52
53			if ($valuator = $this->getAttributeValuator($attribute)) {
54			return new $valuator(parent::getAttribute($attribute), $attribute, $this);
			0 ignored issues – show Comprehensibility Bug introduced 2017-07-05 11:40 UTC by Report Bug Copy Issue Report It seems like you call parent on a different method (`getAttribute()` instead of `getRevaluatedAttribute()`). Are you sure this is correct? If so, you might want to change this to `$this->getAttribute()`. 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...
55			}
56
57			return false;
58			}
59
60			/**
61			* Return revaluable attributes.
62			*
63			* @example
64			*
65			* <pre>
66			* // 1. Using default valuator:
67			* protected $revaluable = [
68			* 'foo', 'bar', 'baz'
69			* ];
70			*
71			* // 2. Use the specified valuator:
72			* protected $revaluable = [
73			* 'foo' => '\Foo\Support\Valuator\Foo',
74			* 'bar' => '\Foo\Support\Valuator\Bar',
75			* 'baz',
76			* ];
77			* </pre>
78			*
79			* @return array
80			*/
81			public function getRevaluableAttributes()
82			{
83			if (!property_exists($this, 'revaluable') \|\| !is_array($this->revaluable)) {
			0 ignored issues – show Bug introduced 2017-07-05 11:40 UTC by Report Bug Copy Issue Report The property `revaluable` 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...
84			return [];
85			}
86
87			$revaluable = [];
88
89			foreach ($this->revaluable as $key => $valuator) {
90			if (is_int($key)) {
91			$revaluable[$valuator] = config('revaluation.default_valuator');
92			} else {
93			$revaluable[$valuator] = $valuator;
94			}
95			}
96
97			return $revaluable;
98			}
99
100			/**
101			* Return the additional attribute revaluate mutators.
102			*
103			* @return array
104			*/
105			public function getRevaluateMutators()
106			{
107			return property_exists($this, 'revaluateMutators') ? (array) $this->revaluateMutators : [];
108			}
109
110			/**
111			* @return string
112			*/
113			public function getRevaluableAttributePrefix()
114			{
115			return rtrim($this->revaluatedAttributePrefix ?? 'revaluated', '_');
			0 ignored issues – show Bug introduced 2017-07-05 11:40 UTC by Report Bug Copy Issue Report The property `revaluatedAttributePrefix` 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...
116			}
117
118			/**
119			* @example
120			* <pre>
121			* $object->revaluated_price;
122			* $object->raw_price;
123			* </pre>
124			*
125			* @param string $attribute
126			*
127			* @return mixed
128			*
129			* @throws \Exception
130			*/
131			public function getAttribute($attribute)
132			{
133			if ($this->hasGetMutator($attribute)) {
			0 ignored issues – show Documentation Bug introduced 2017-10-19 03:26 UTC by Report Bug Copy Issue Report The method `hasGetMutator` does not exist on `object<Overtrue\LaravelR...asRevaluableAttributes>`? Since you implemented `__call`, maybe consider adding a @method annotation. If you implement `__call` and you know which methods are available, you can improve IDE auto-completion and static analysis by adding a @method annotation to the class. This is often the case, when `__call` is implemented by a parent class and only the child class knows which methods exist: class ParentClass { private $data = array(); public function __call($method, array $args) { if (0 === strpos($method, 'get')) { return $this->data[strtolower(substr($method, 3))]; } throw new \LogicException(sprintf('Unsupported method: %s', $method)); } } /** * If this class knows which fields exist, you can specify the methods here: * * @method string getName() */ class SomeClass extends ParentClass { } Loading history...
134			return parent::getAttribute($attribute);
135			}
136
137			if (starts_with($attribute, 'raw_')) {
138			return $this->getRevaluatedAttribute(substr($attribute, strlen('raw_')))->getRaw();
139			}
140
141			$prefix = $this->getRevaluableAttributePrefix();
142
143			if (starts_with($attribute, $prefix)) {
144			return $this->getRevaluatedAttribute(substr($attribute, strlen($prefix) + 1));
145			}
146
147			if ($valuator = $this->getRevaluatedAttribute($attribute)) {
148			return $valuator->toDefaultFormat();
149			}
150
151			/**
152			* <pre>
153			* $revaluateMutators = [
154			* 'display_price' => ['price', 'asCurrency'],
155			* ];
156			* </pre>.
157			*
158			* @var array
159			*/
160			$revaluateMutators = $this->getRevaluateMutators();
161
162			if (isset($revaluateMutators[$attribute])) {
163			list($sourceAttribute, $method) = $revaluateMutators[$attribute];
164			$revaluated = $this->getRevaluatedAttribute($sourceAttribute);
165
166			if (!is_callable([$revaluated, $method])) {
167			throw new \Exception("$method not an callable method.");
168			}
169
170			return call_user_func([$revaluated, $method]);
171			}
172
173			return parent::getAttribute($attribute);
174			}
175
176			/**
177			* Set attribute.
178			*
179			* @param string $attribute
180			* @param mixed $value
181			*
182			* @return $this
183			*/
184			public function setAttribute($attribute, $value)
185			{
186			if ($valuator = $this->getAttributeValuator($attribute)) {
187			$value = forward_static_call([$valuator, 'toStorableValue'], $value);
188			}
189
190			return parent::setAttribute($attribute, $value);
191			}
192
193			/**
194			* Override HasAttributes::attributesToArray.
195			*
196			* @return array
197			*/
198			public function attributesToArray()
199			{
200			$attributes = parent::attributesToArray();
201
202			if ($this->shouldAppendRevaluatedAttributesToArray()) {
203			foreach (array_keys($this->getRevaluableAttributes()) as $attribute) {
204			if ($valuator = $this->getRevaluatedAttribute($attribute)) {
205			$attribute = $this->shouldReplaceRawAttributesToArray() ? $attribute : $this->getRevaluablePrefixedAttributeName($attribute);
206			$attributes[$attribute] = $valuator->toDefaultFormat();
207			}
208			}
209			}
210
211			return $attributes;
212			}
213
214			/**
215			* @param string $attribute
216			*
217			* @return string
218			*/
219			public function getRevaluablePrefixedAttributeName($attribute)
220			{
221			return $this->getRevaluableAttributePrefix().'_'.$attribute;
222			}
223
224			/**
225			* Fetch attribute.
226			*
227			* @example
228			* <pre>
229			* $object->getRevaluatedPriceAttribute();
230			* $object->getRevaluatedXXXAttribute();
231			* </pre>
232			*
233			* @param string $method
234			*
235			* @return mixed
236			*/
237			public function __call($method, $args)
238			{
239			$prefix = studly_case($this->getRevaluableAttributePrefix());
240			if (preg_match("/get{$prefix}(?<attribute>\\w+)Attribute/i", $method, $matches)) {
241			return $this->getRevaluatedAttribute($matches['attribute']);
242			}
243
244			return parent::__call($method, $args);
245			}
246
247			/**
248			* @return bool
249			*/
250			protected function shouldAppendRevaluatedAttributesToArray()
251			{
252			return property_exists($this, 'appendRevaluatedAttributesToArray') ? $this->appendRevaluatedAttributesToArray : true;
			0 ignored issues – show Bug introduced 2017-07-05 11:40 UTC by Report Bug Copy Issue Report The property `appendRevaluatedAttributesToArray` 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...
253			}
254
255			/**
256			* @return bool
257			*/
258			protected function shouldReplaceRawAttributesToArray()
259			{
260			return property_exists($this, 'replaceRawAttributesToArray') ? $this->replaceRawAttributesToArray : false;
			0 ignored issues – show Bug introduced 2017-07-05 11:40 UTC by Report Bug Copy Issue Report The property `replaceRawAttributesToArray` 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...
261			}
262
263			/**
264			* Return revaluated value of attribute.
265			*
266			* @param string $attribute
267			*
268			* @return mixed
269			*/
270			protected function getStorableValue($attribute)
271			{
272			if ($valuator = $this->getAttributeValuator($attribute)) {
273			if (is_callable($valuator, 'toStorableValue')) {
274			$value = forward_static_call([$valuator, 'toStorableValue'], $this->attributes[$attribute]);
			0 ignored issues – show Bug introduced 2017-07-05 11:40 UTC by Report Bug Copy Issue Report The property `attributes` does not seem to exist. Did you mean `appendRevaluatedAttributesToArray`? An attempt at access to an undefined property has been detected. This may either be a typographical error or the property has been renamed but there are still references to its old name. If you really want to allow access to undefined properties, you can define magic methods to allow access. See the php core documentation on Overloading. Loading history...
275			}
276			}
277
278			return $value;
			0 ignored issues – show Bug introduced 2017-07-05 11:40 UTC by Report Bug Copy Issue Report The variable `$value` 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 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; } } 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; } 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...
279			}
280
281			/**
282			* Get attribute valuator.
283			*
284			* @param string $attribute
285			*
286			* @return string
287			*/
288			protected function getAttributeValuator($attribute)
289			{
290			return array_get($this->getRevaluableAttributes(), $attribute);
291			}
292			}
293

overtrue / laravel-revaluation

Push — master ( 6c51d8...c6abd6 )

getRevaluableAttributePrefix() A

Complexity

Size

Duplication

Importance

Available Fixes

Duplication Side-by-Side

Filter issues like