Completed
Pull Request — master (#65)
by
unknown
01:03
created

SchemalessAttributesTrait::__get()   A

Complexity

Conditions 2
Paths 2

Size

Total Lines 8

Duplication

Lines 0
Ratio 0 %

Importance

Changes 0
Metric Value
dl 0
loc 8
rs 10
c 0
b 0
f 0
cc 2
nc 2
nop 1
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
        foreach ($this->getSchemalessAttributes() as $attribute) {
21
            $this->casts[$attribute] = 'array';
0 ignored issues
show
Documentation introduced by
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...
22
        }
23
    }
24
25
    /**
26
     * @return array
27
     */
28
    public function getSchemalessAttributes()
29
    {
30
        return $this->schemalessAttributes ?? [];
31
    }
32
33
    /**
34
     * @param $key
35
     * @return mixed|SchemalessAttributes
36
     */
37
    public function __get($key)
38
    {
39
        if (in_array($key, $this->getSchemalessAttributes())) {
40
            return SchemalessAttributes::createForModel($this, $key);
41
        }
42
43
        return parent::__get($key);
44
    }
45
}
46