SchemalessAttributesTrait - Code Metrics - Inspection of "add trait with multi-column support" - spatie/laravel-schemaless-attributes - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Pull Request — master (#64)

unknown

created 2020-06-19 18:27 UTC

SchemalessAttributesTrait A

↳ Parent: Project

Complexity

Total Complexity

Size/Duplication

Total Lines	37
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	1

Importance

Changes

Metric	Value
wmc	5
lcom	1
cbo	1
dl	0
loc	37
rs	10
c	0
b	0
f	0

3 Methods

Rating	Name	Size	Complexity
A	initializeSchemalessAttributesTrait()	10	2
A	getSchemalessAttributes()	4	1
A	__get()	8	2

<?php

namespace Spatie\SchemalessAttributes;


use Illuminate\Support\Collection;

/**
 * @property array $schemalessAttributes
 *
 * @mixin Collection
 */
trait SchemalessAttributesTrait
{
    /**
     * Register schemalessAttributes attributes as array(cast)
     */
    public function initializeSchemalessAttributesTrait()
    {
        $casts = [];

        foreach ($this->getSchemalessAttributes() as $attribute) {
            $this->casts[$attribute] = 'array';
<?php

/**
 * @property int $x
 * @property int $y
 * @property string $text
 */
class MyLabel
{
    private $properties;

    private $allowedProperties = array('x', 'y', 'text');

    public function __get($name)
    {
        if (isset($properties[$name]) && in_array($name, $this->allowedProperties)) {
            return $properties[$name];
        } else {
            return null;
        }
    }

    public function __set($name, $value)
    {
        if (in_array($name, $this->allowedProperties)) {
            $properties[$name] = $value;
        } else {
            throw new \LogicException("Property $name is not defined.");
        }
    }

}
        }

        $this->mergeCasts($casts);
trait Idable {
    public function equalIds(Idable $other) {
        return $this->getId() === $other->getId();
    }
}
    }

    /**
     * @return array
     */
    public function getSchemalessAttributes()
    {
        return $this->schemalessAttributes ?? [];
    }

    /**
     * @param $key
     * @return mixed|SchemalessAttributes
     */
    public function __get($key)
    {
        if (in_array($key, $this->getSchemalessAttributes())) {
            return SchemalessAttributes::createForModel($this, $key);
        }

        return parent::__get($key);
    }
}


1			<?php
2
3			namespace Spatie\SchemalessAttributes;
4
5
6			use Illuminate\Support\Collection;
7
8			/**
9			* @property array $schemalessAttributes
10			*
11			* @mixin Collection
12			*/
13			trait SchemalessAttributesTrait
14			{
15			/**
16			* Register schemalessAttributes attributes as array(cast)
17			*/
18			public function initializeSchemalessAttributesTrait()
19			{
20			$casts = [];
21
22			foreach ($this->getSchemalessAttributes() as $attribute) {
23			$this->casts[$attribute] = 'array';
			0 ignored issues – show Documentation introduced 2020-06-19 18:29 UTC by Report Bug Copy Issue Report The property `casts` does not exist on `object<Spatie\Schemaless...emalessAttributesTrait>`. Since you implemented `__get`, maybe consider adding a @property annotation. Since your code implements the magic getter `_get`, this function will be called for any read access on an undefined variable. You can add the `@property` annotation to your class or interface to document the existence of this variable. <?php /** * @property int $x * @property int $y * @property string $text */ class MyLabel { private $properties; private $allowedProperties = array('x', 'y', 'text'); public function __get($name) { if (isset($properties[$name]) && in_array($name, $this->allowedProperties)) { return $properties[$name]; } else { return null; } } public function __set($name, $value) { if (in_array($name, $this->allowedProperties)) { $properties[$name] = $value; } else { throw new \LogicException("Property $name is not defined."); } } } If the property has read access only, you can use the @property-read annotation instead. Of course, you may also just have mistyped another name, in which case you should fix the error. See also the PhpDoc documentation for @property. Loading history...
24			}
25
26			$this->mergeCasts($casts);
			0 ignored issues – show Bug introduced 2020-06-18 22:41 UTC by Report Bug Copy Issue Report It seems like `mergeCasts()` 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			}
28
29			/**
30			* @return array
31			*/
32			public function getSchemalessAttributes()
33			{
34			return $this->schemalessAttributes ?? [];
35			}
36
37			/**
38			* @param $key
39			* @return mixed\|SchemalessAttributes
40			*/
41			public function __get($key)
42			{
43			if (in_array($key, $this->getSchemalessAttributes())) {
44			return SchemalessAttributes::createForModel($this, $key);
45			}
46
47			return parent::__get($key);
48			}
49			}
50

spatie / laravel-schemaless-attributes

Pull Request — master (#64)

SchemalessAttributesTrait A

Complexity

Size/Duplication

Coupling/Cohesion

Importance

3 Methods

Duplication Side-by-Side

Filter issues like