SchemalessAttributes::__call() - Code Metrics - Inspection of "extend collection" - spatie/laravel-schemaless-attributes - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Pull Request — master (#48)

by Tom

created 2019-08-21 15:28 UTC

SchemalessAttributes::__call() A

↳ Parent: SchemalessAttributes

Complexity

Conditions	1
Paths	1

Size

Total Lines

Duplication

Lines	0
Ratio	0 %

Importance

Changes

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

<?php

namespace Spatie\SchemalessAttributes;

use Countable;
use ArrayAccess;
use JsonSerializable;
use IteratorAggregate;
use Illuminate\Support\Arr;
use Illuminate\Support\Collection;
use Illuminate\Database\Eloquent\Model;
use Illuminate\Database\Eloquent\Builder;
use Illuminate\Contracts\Support\Jsonable;
use Illuminate\Contracts\Support\Arrayable;

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

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

    /** @var Collection */
    protected $collection;

    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->collection = new Collection($this->getRawSchemalessAttributes());
    }

    public function __call($name, $arguments)
    {
        $result = call_user_func_array([$this->collection, $name], $arguments);

        $this->override($this->collection->toArray());

        return $result;
    }

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

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

    /**
     * @see Collection::get()
     *
     * @param $key
     * @param null $default
     *
     * @return mixed
     */
    public function get($key, $default = null)
    {
        return data_get($this->collection, $key, $default);
    }

    /**
     * @see Collection::set()
     *
     * @param $key
     * @param $value
     *
     * @return mixed
     */
    public function set($key, $value = null)
    {
        if (is_iterable($key)) {
            return $this->override($this->collection->merge($key));
        }

        $items = $this->collection->toArray();

        return $this->override(data_set($items, $key, $value));
    }

    /**
     * @see Collection::forget()
     *
     * @param $keys
     *
     * @return SchemalessAttributes
     */
    public function forget($keys)
    {
        $items = $this->collection->toArray();

        foreach ((array) $keys as $key) {
            Arr::forget($items, $key);
        }

        return $this->override($items);
    }

    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;
    }

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

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

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

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

    public function toArray()
    {
        return $this->collection->toArray();
    }

    public function toJson($options = 0)
    {
        return $this->collection->toJson($options);
    }

    public function jsonSerialize()
    {
        return $this->collection->jsonSerialize();
    }

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

    public function getIterator()
    {
        return $this->collection->getIterator();
    }

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

    protected function override(iterable $collection)
    {
        $this->collection = new Collection($collection);
        $this->model->{$this->sourceAttributeName} = $this->collection->toArray();

        return $this;
    }
}


1			<?php
2
3			namespace Spatie\SchemalessAttributes;
4
5			use Countable;
6			use ArrayAccess;
7			use JsonSerializable;
8			use IteratorAggregate;
9			use Illuminate\Support\Arr;
10			use Illuminate\Support\Collection;
11			use Illuminate\Database\Eloquent\Model;
12			use Illuminate\Database\Eloquent\Builder;
13			use Illuminate\Contracts\Support\Jsonable;
14			use Illuminate\Contracts\Support\Arrayable;
15
16			/**
17			* @mixin Collection
18			*/
19			class SchemalessAttributes implements ArrayAccess, Arrayable, Countable, IteratorAggregate, Jsonable, JsonSerializable
20			{
21			/** @var \Illuminate\Database\Eloquent\Model */
22			protected $model;
23
24			/** @var string */
25			protected $sourceAttributeName;
26
27			/** @var Collection */
28			protected $collection;
29
30			public static function createForModel(Model $model, string $sourceAttributeName): self
31			{
32			return new static($model, $sourceAttributeName);
33			}
34
35			public function __construct(Model $model, string $sourceAttributeName)
36			{
37			$this->model = $model;
38
39			$this->sourceAttributeName = $sourceAttributeName;
40
41			$this->collection = new Collection($this->getRawSchemalessAttributes());
42			}
43
44			public function __call($name, $arguments)
45			{
46			$result = call_user_func_array([$this->collection, $name], $arguments);
47
48			$this->override($this->collection->toArray());
49
50			return $result;
51			}
52
53			public function __get($name)
54			{
55			return $this->get($name);
56			}
57
58			public function __set($name, $value)
59			{
60			$this->set($name, $value);
61			}
62
63			/**
64			* @see Collection::get()
65			*
66			* @param $key
67			* @param null $default
68			*
69			* @return mixed
70			*/
71			public function get($key, $default = null)
72			{
73			return data_get($this->collection, $key, $default);
74			}
75
76			/**
77			* @see Collection::set()
78			*
79			* @param $key
80			* @param $value
81			*
82			* @return mixed
83			*/
84			public function set($key, $value = null)
85			{
86			if (is_iterable($key)) {
87			return $this->override($this->collection->merge($key));
88			}
89
90			$items = $this->collection->toArray();
91
92			return $this->override(data_set($items, $key, $value));
93			}
94
95			/**
96			* @see Collection::forget()
97			*
98			* @param $keys
99			*
100			* @return SchemalessAttributes
101			*/
102			public function forget($keys)
103			{
104			$items = $this->collection->toArray();
105
106			foreach ((array) $keys as $key) {
107			Arr::forget($items, $key);
108			}
109
110			return $this->override($items);
111			}
112
113			public static function scopeWithSchemalessAttributes(string $attributeName): Builder
114			{
115			$arguments = debug_backtrace()[1]['args'];
116
117			if (count($arguments) === 1) {
118			[$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...
119			$schemalessAttributes = [];
120			}
121
122			if (count($arguments) === 2) {
123			[$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...
124			}
125
126			if (count($arguments) >= 3) {
127			[$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...
128			$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...
129			}
130
131			foreach ($schemalessAttributes as $name => $value) {
132			$builder->where("{$attributeName}->{$name}", $value);
133			}
134
135			return $builder;
136			}
137
138			public function offsetGet($offset)
139			{
140			return $this->get($offset);
141			}
142
143			public function offsetExists($offset)
144			{
145			return $this->collection->offsetExists($offset);
146			}
147
148			public function offsetSet($offset, $value)
149			{
150			$this->set($offset, $value);
151			}
152
153			public function offsetUnset($offset)
154			{
155			$this->forget($offset);
156			}
157
158			public function toArray()
159			{
160			return $this->collection->toArray();
161			}
162
163			public function toJson($options = 0)
164			{
165			return $this->collection->toJson($options);
166			}
167
168			public function jsonSerialize()
169			{
170			return $this->collection->jsonSerialize();
171			}
172
173			public function count()
174			{
175			return $this->collection->count();
176			}
177
178			public function getIterator()
179			{
180			return $this->collection->getIterator();
181			}
182
183			protected function getRawSchemalessAttributes(): array
184			{
185			return $this->model->fromJson($this->model->getAttributes()[$this->sourceAttributeName] ?? '{}');
186			}
187
188			protected function override(iterable $collection)
189			{
190			$this->collection = new Collection($collection);
191			$this->model->{$this->sourceAttributeName} = $this->collection->toArray();
192
193			return $this;
194			}
195			}
196

spatie / laravel-schemaless-attributes

Pull Request — master (#48)

SchemalessAttributes::__call() A

Complexity

Size

Duplication

Importance

Available Fixes

Duplication Side-by-Side

Filter issues like