SchemalessAttributes::set() - Code Metrics - Inspection of "Allow associative array setter for schemaless-attr..." - spatie/laravel-schemaless-attributes - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Pull Request — master (#37)

unknown

created 2018-10-29 12:32 UTC

SchemalessAttributes::set() A

↳ Parent: SchemalessAttributes

Complexity

Conditions	1
Paths	1

Size

Total Lines

Duplication

Lines	0
Ratio	0 %

Importance

Changes

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

<?php

namespace Spatie\SchemalessAttributes;

use Countable;
use ArrayAccess;
use Illuminate\Database\Eloquent\Model;
use Illuminate\Database\Eloquent\Builder;
use Illuminate\Contracts\Support\Arrayable;

class SchemalessAttributes implements ArrayAccess, Countable, Arrayable
{
    /** @var \Illuminate\Database\Eloquent\Model */
    protected $model;

    /** @var string */
    protected $sourceAttributeName;

    /** @var array */
    protected $schemalessAttributes = [];

    public static function createForModel(Model $model, string $sourceAttributeName): self
    {
        return new static($model, $sourceAttributeName);
    }

    public function __construct(Model $model, string $sourceAttributeName)
    {
        $this->model = $model;

        $this->sourceAttributeName = $sourceAttributeName;

        $this->schemalessAttributes = $this->getRawSchemalessAttributes();
    }

    public function __get(string $name)
    {
        return $this->get($name);
    }

    public function get(string $name, $default = null)
    {
        return data_get($this->schemalessAttributes, $name, $default);
    }

    public function __set(string $name, $value)
    {
        $this->set($name, $value);
    }

    public function set(string $name, $value)
    {
        data_set($this->schemalessAttributes, $name, $value);

        $this->model->{$this->sourceAttributeName} = $this->schemalessAttributes;
    }

    public function setMany($attributes = [])
    {
        array_map(function($key, $item) {
            $this->set($key, $item);
        }, array_keys($attributes), $attributes);
    }

    public function has(string $name): bool
    {
        return array_has($this->schemalessAttributes, $name);
    }

    public function forget(string $name): self
    {
        $this->model->{$this->sourceAttributeName} = array_except($this->schemalessAttributes, $name);

        return $this;
    }

    public function all(): array
    {
        return $this->getRawSchemalessAttributes();
    }

    public function offsetExists($offset)
    {
        return $this->has($offset);
    }

    public function offsetGet($offset)
    {
        return $this->$offset;
    }

    public function offsetSet($offset, $value)
    {
        $this->{$offset} = $value;
    }

    public function offsetUnset($offset)
    {
        $this->forget($offset);
    }

    public function count()
    {
        return count($this->schemalessAttributes);
    }

    public function toArray(): array
    {
        return $this->all();
    }

    public static function scopeWithSchemalessAttributes(string $attributeName): Builder
    {
        $arguments = debug_backtrace()[1]['args'];

        if (count($arguments) === 1) {
            [$builder] = $arguments;

            $schemalessAttributes = [];
        }

        if (count($arguments) === 2) {
            [$builder, $schemalessAttributes] = $arguments;
function myFunction($a) {
    switch ($a) {
        case 'foo':
            $x = 1;
            break;

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

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

        if (count($arguments) >= 3) {
            [$builder, $name, $value] = $arguments;
function someFunction() {
    $x = 5;
    echo $x;
}
            $schemalessAttributes = [$name => $value];
function someFunction() {
    $x = 5;
    echo $x;
}
        }

        foreach ($schemalessAttributes as $name => $value) {
            $builder->where("{$attributeName}->{$name}", $value);
        }

        return $builder;
    }

    protected function getRawSchemalessAttributes(): array
    {
        return json_decode($this->model->getAttributes()[$this->sourceAttributeName] ?? '{}', true);
    }
}


1			<?php
2
3			namespace Spatie\SchemalessAttributes;
4
5			use Countable;
6			use ArrayAccess;
7			use Illuminate\Database\Eloquent\Model;
8			use Illuminate\Database\Eloquent\Builder;
9			use Illuminate\Contracts\Support\Arrayable;
10
11			class SchemalessAttributes implements ArrayAccess, Countable, Arrayable
12			{
13			/** @var \Illuminate\Database\Eloquent\Model */
14			protected $model;
15
16			/** @var string */
17			protected $sourceAttributeName;
18
19			/** @var array */
20			protected $schemalessAttributes = [];
21
22			public static function createForModel(Model $model, string $sourceAttributeName): self
23			{
24			return new static($model, $sourceAttributeName);
25			}
26
27			public function __construct(Model $model, string $sourceAttributeName)
28			{
29			$this->model = $model;
30
31			$this->sourceAttributeName = $sourceAttributeName;
32
33			$this->schemalessAttributes = $this->getRawSchemalessAttributes();
34			}
35
36			public function __get(string $name)
37			{
38			return $this->get($name);
39			}
40
41			public function get(string $name, $default = null)
42			{
43			return data_get($this->schemalessAttributes, $name, $default);
44			}
45
46			public function __set(string $name, $value)
47			{
48			$this->set($name, $value);
49			}
50
51			public function set(string $name, $value)
52			{
53			data_set($this->schemalessAttributes, $name, $value);
54
55			$this->model->{$this->sourceAttributeName} = $this->schemalessAttributes;
56			}
57
58			public function setMany($attributes = [])
59			{
60			array_map(function($key, $item) {
61			$this->set($key, $item);
62			}, array_keys($attributes), $attributes);
63			}
64
65			public function has(string $name): bool
66			{
67			return array_has($this->schemalessAttributes, $name);
68			}
69
70			public function forget(string $name): self
71			{
72			$this->model->{$this->sourceAttributeName} = array_except($this->schemalessAttributes, $name);
73
74			return $this;
75			}
76
77			public function all(): array
78			{
79			return $this->getRawSchemalessAttributes();
80			}
81
82			public function offsetExists($offset)
83			{
84			return $this->has($offset);
85			}
86
87			public function offsetGet($offset)
88			{
89			return $this->$offset;
90			}
91
92			public function offsetSet($offset, $value)
93			{
94			$this->{$offset} = $value;
95			}
96
97			public function offsetUnset($offset)
98			{
99			$this->forget($offset);
100			}
101
102			public function count()
103			{
104			return count($this->schemalessAttributes);
105			}
106
107			public function toArray(): array
108			{
109			return $this->all();
110			}
111
112			public static function scopeWithSchemalessAttributes(string $attributeName): Builder
113			{
114			$arguments = debug_backtrace()[1]['args'];
115
116			if (count($arguments) === 1) {
117			[$builder] = $arguments;
			0 ignored issues – show Bug introduced 2018-05-08 18:55 UTC by Report Bug Copy Issue Report The variable `$builder` does not exist. Did you forget to declare it? This check marks access to variables or properties that have not been declared yet. While PHP has no explicit notion of declaring a variable, accessing it before a value is assigned to it is most likely a bug. Loading history...
118			$schemalessAttributes = [];
119			}
120
121			if (count($arguments) === 2) {
122			[$builder, $schemalessAttributes] = $arguments;
			0 ignored issues – show Bug introduced 2018-05-08 18:55 UTC by Report Bug Copy Issue Report The variable `$schemalessAttributes` 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...
123			}
124
125			if (count($arguments) >= 3) {
126			[$builder, $name, $value] = $arguments;
			0 ignored issues – show Bug introduced 2018-05-08 18:55 UTC by Report Bug Copy Issue Report The variable `$name` seems only to be defined at a later point. Did you maybe move this code here without moving the variable definition? This error can happen if you refactor code and forget to move the variable initialization. Let’s take a look at a simple example: function someFunction() { $x = 5; echo $x; } The above code is perfectly fine. Now imagine that we re-order the statements: function someFunction() { echo $x; $x = 5; } In that case, `$x` would be read before it is initialized. This was a very basic example, however the principle is the same for the found issue. Loading history... Bug introduced 2018-05-08 18:55 UTC by Report Bug Copy Issue Report The variable `$value` seems only to be defined at a later point. Did you maybe move this code here without moving the variable definition? This error can happen if you refactor code and forget to move the variable initialization. Let’s take a look at a simple example: function someFunction() { $x = 5; echo $x; } The above code is perfectly fine. Now imagine that we re-order the statements: function someFunction() { echo $x; $x = 5; } In that case, `$x` would be read before it is initialized. This was a very basic example, however the principle is the same for the found issue. Loading history...
127			$schemalessAttributes = [$name => $value];
			0 ignored issues – show Bug introduced 2018-05-08 18:55 UTC by Report Bug Copy Issue Report The variable `$name` seems only to be defined at a later point. Did you maybe move this code here without moving the variable definition? This error can happen if you refactor code and forget to move the variable initialization. Let’s take a look at a simple example: function someFunction() { $x = 5; echo $x; } The above code is perfectly fine. Now imagine that we re-order the statements: function someFunction() { echo $x; $x = 5; } In that case, `$x` would be read before it is initialized. This was a very basic example, however the principle is the same for the found issue. Loading history... Bug introduced 2018-05-08 18:55 UTC by Report Bug Copy Issue Report The variable `$value` seems only to be defined at a later point. Did you maybe move this code here without moving the variable definition? This error can happen if you refactor code and forget to move the variable initialization. Let’s take a look at a simple example: function someFunction() { $x = 5; echo $x; } The above code is perfectly fine. Now imagine that we re-order the statements: function someFunction() { echo $x; $x = 5; } In that case, `$x` would be read before it is initialized. This was a very basic example, however the principle is the same for the found issue. Loading history...
128			}
129
130			foreach ($schemalessAttributes as $name => $value) {
131			$builder->where("{$attributeName}->{$name}", $value);
132			}
133
134			return $builder;
135			}
136
137			protected function getRawSchemalessAttributes(): array
138			{
139			return json_decode($this->model->getAttributes()[$this->sourceAttributeName] ?? '{}', true);
140			}
141			}
142

spatie / laravel-schemaless-attributes

Pull Request — master (#37)

SchemalessAttributes::set() A

Complexity

Size

Duplication

Importance

Available Fixes

Duplication Side-by-Side

Filter issues like