HasBinaryUuid::toArray() - Code Metrics - Inspection of "Support for scout" - spatie/laravel-binary-uuid - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Pull Request — master (#72)

unknown

created 2018-10-04 13:51 UTC

HasBinaryUuid::toArray() B

↳ Parent: HasBinaryUuid

Complexity

Conditions	8
Paths	10

Size

Total Lines

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
dl	0
loc	35
rs	8.1155
c	0
b	0
f	0
cc	8
nc	10
nop	0

<?php

namespace Spatie\BinaryUuid;

use Exception;
use Ramsey\Uuid\Uuid;
use Illuminate\Database\Eloquent\Model;

trait HasBinaryUuid
{
    protected static function bootHasBinaryUuid()
    {
        static::creating(function (Model $model) {
            $uuidAttributes = $model->getUuidAttributes();

            foreach ($uuidAttributes as $key) {
                if ($model->{$key}) {
                    continue;
                }

                $model->{$key} = static::encodeUuid(static::generateUuid());
            }
        });
    }

    public static function scopeWithUuid(Builder $builder, $uuid, $field = null): Builder
    {
        if ($field) {
            return static::scopeWithUuidRelation($builder, $uuid, $field);
        }

        if ($uuid instanceof Uuid) {
            $uuid = (string) $uuid;
        }

        $uuid = (array) $uuid;

        return $builder->whereKey(array_map(function (string $modelUuid) {
            return static::encodeUuid($modelUuid);
        }, $uuid));
    }

    public static function scopeWithUuidRelation(Builder $builder, $uuid, string $field): Builder
    {
        if ($uuid instanceof Uuid) {
            $uuid = (string) $uuid;
        }

        $uuid = (array) $uuid;

        return $builder->whereIn($field, array_map(function (string $modelUuid) {
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 static::encodeUuid($modelUuid);
        }, $uuid));
    }

    public static function generateUuid() : string
    {
        return Uuid::uuid1();
    }

    public static function encodeUuid($uuid): string
    {
        if (! Uuid::isValid($uuid)) {
            return $uuid;
        }

        if (! $uuid instanceof Uuid) {
            $uuid = Uuid::fromString($uuid);
        }

        return $uuid->getBytes();
    }

    public static function decodeUuid(string $binaryUuid): string
    {
        if (Uuid::isValid($binaryUuid)) {
            return $binaryUuid;
        }

        return Uuid::fromBytes($binaryUuid)->toString();
    }

    public function getUuidKeys()
    {
        return (property_exists($this, 'uuids') && is_array($this->uuids)) ? $this->uuids : [];
class MyClass { }

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

    public function toArray()
    {
        $uuidAttributes = $this->getUuidAttributes();

        $array = parent::toArray();
        $pivotUuids = [];
$myVar = 'Value';
$higher = false;

if (rand(1, 6) > 3) {
    $higher = true;
} else {
    $higher = false;
}

        if (! $this->exists || ! is_array($uuidAttributes)) {
class MyClass { }

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

        foreach ($uuidAttributes as $attributeKey) {
            if (! array_key_exists($attributeKey, $array)) {
                continue;
            }
            $uuidKey = $this->getRelatedBinaryKeyName($attributeKey);
            $array[$attributeKey] = $this->{$uuidKey};
        }

        if (isset($array['pivot'])) {
            $pivotUuids = $array['pivot'];

            if (! is_array($pivotUuids)) {
                $pivotUuids = get_object_vars($pivotUuids);
            }

            foreach ($pivotUuids as $key => $uuid) {
                $pivotUuids[$key] = $this->decodeUuid($uuid);
            }

            $array['pivot'] = $pivotUuids;
        }

        return $array;
    }

    public function getRelatedBinaryKeyName($attribute): string
    {
        $suffix = $this->getUuidSuffix();

        return preg_match('/(?:[a-zA-Z_]+)?id/i', $attribute) ? "{$attribute}{$suffix}" : $attribute;
    }

    public function getAttribute($key)
    {
        $uuidKey = $this->uuidTextAttribute($key);

        if ($uuidKey && $this->{$uuidKey} !== null) {
''   == false // true
''   == null  // true
'ab' == false // false
'ab' == null  // false

// It is often better to use strict comparison
'' === false // false
'' === null  // false
            return static::decodeUuid($this->{$uuidKey});
        }

        return parent::getAttribute($key);
    }

    public function setAttribute($key, $value)
    {
        if ($this->uuidTextAttribute($key)) {
''   == false // true
''   == null  // true
'ab' == false // false
'ab' == null  // false

// It is often better to use strict comparison
'' === false // false
'' === null  // false
            $value = static::encodeUuid($value);
        }

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

    protected function getUuidSuffix()
    {
        return (property_exists($this, 'uuidSuffix')) ? $this->uuidSuffix : '_text';
class MyClass { }

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

    protected function uuidTextAttribute($key)
    {
        $uuidAttributes = $this->getUuidAttributes();
        $suffix = $this->getUuidSuffix();
        $offset = -(strlen($suffix));

        if (substr($key, $offset) == $suffix && in_array(($uuidKey = substr($key, 0, $offset)), $uuidAttributes)) {
            return $uuidKey;
        }

        return false;
    }

    public function getUuidAttributes()
    {
        $uuidKeys = $this->getUuidKeys();

        // non composite primary keys will return a string so casting required
        $key = (array) $this->getKeyName();

        $uuidAttributes = array_unique(array_merge($uuidKeys, $key));

        return $uuidAttributes;
    }

    public function getUuidTextAttribute(): ?string
    {
        $key = $this->getKeyName();

        if (! $this->exists || is_array($key)) {
            return null;
        }

        return static::decodeUuid($this->{$key});
    }

    public function setUuidTextAttribute(string $uuid)
    {
        $key = $this->getKeyName();

        if (! is_string($key)) {
            throw new Exception('composite keys not allowed for attribute mutation');
        }

        $this->{$key} = static::encodeUuid($uuid);
    }

    public function getQueueableId()
    {
        return base64_encode($this->{$this->getKeyName()});
    }

    public function newQueryForRestoration($id)
    {
        //return $this->newQueryWithoutScopes()->whereKey(base64_decode($id));
        return is_array($id)
                ? $this->newQueryWithoutScopes()->whereIn($this->getQualifiedKeyName(), $this->decodeIdArray($id))
trait Idable {
    public function equalIds(Idable $other) {
        return $this->getId() === $other->getId();
    }
}
                : $this->newQueryWithoutScopes()->whereKey(base64_decode($id));
trait Idable {
    public function equalIds(Idable $other) {
        return $this->getId() === $other->getId();
    }
}
    }

    public function newEloquentBuilder($query)
    {
        return new Builder($query);
    }

    public function getRouteKeyName()
    {
        $keyName = $this->getKeyName();

        $routeKeyName = is_string($keyName) ? $this->strUuidSuffix($keyName) : array_map([&$this, 'strUuidSuffix'], $keyName);

        return $routeKeyName;
    }

    public function getKeyName()
    {
        return (! property_exists($this, 'primaryKey') || $this->primaryKey === 'id') ? 'uuid' : $this->primaryKey;
class MyClass { }

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

    public function getIncrementing()
    {
        return false;
    }

    public function resolveRouteBinding($value)
    {
        $keyName = $this->getKeyName();

        if (is_array($keyName)) {
            $parsed = explode(':', strval($value), count($keyName));

            $value = array_combine($keyName, $parsed);
        }

        return $this->withUuid($value)->first();

    }

    public function strUuidSuffix($str)
    {
        $suffix = $this->getUuidSuffix();

        return "{$str}{$suffix}";
    }

    private function decodeIdArray($ids)
    {
        foreach ($ids as $key => $id) {
            $ids[$key] = base64_decode($id);
        }

        return $ids;
    }
}


1			<?php
2
3			namespace Spatie\BinaryUuid;
4
5			use Exception;
6			use Ramsey\Uuid\Uuid;
7			use Illuminate\Database\Eloquent\Model;
8
9			trait HasBinaryUuid
10			{
11			protected static function bootHasBinaryUuid()
12			{
13			static::creating(function (Model $model) {
14			$uuidAttributes = $model->getUuidAttributes();
15
16			foreach ($uuidAttributes as $key) {
17			if ($model->{$key}) {
18			continue;
19			}
20
21			$model->{$key} = static::encodeUuid(static::generateUuid());
22			}
23			});
24			}
25
26			public static function scopeWithUuid(Builder $builder, $uuid, $field = null): Builder
27			{
28			if ($field) {
29			return static::scopeWithUuidRelation($builder, $uuid, $field);
30			}
31
32			if ($uuid instanceof Uuid) {
33			$uuid = (string) $uuid;
34			}
35
36			$uuid = (array) $uuid;
37
38			return $builder->whereKey(array_map(function (string $modelUuid) {
39			return static::encodeUuid($modelUuid);
40			}, $uuid));
41			}
42
43			public static function scopeWithUuidRelation(Builder $builder, $uuid, string $field): Builder
44			{
45			if ($uuid instanceof Uuid) {
46			$uuid = (string) $uuid;
47			}
48
49			$uuid = (array) $uuid;
50
51			return $builder->whereIn($field, array_map(function (string $modelUuid) {
			0 ignored issues – show Documentation Bug introduced 2018-09-19 06:52 UTC by Report Bug Copy Issue Report The method `whereIn` does not exist on `object<Spatie\BinaryUuid\Builder>`? 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...
52			return static::encodeUuid($modelUuid);
53			}, $uuid));
54			}
55
56			public static function generateUuid() : string
57			{
58			return Uuid::uuid1();
59			}
60
61			public static function encodeUuid($uuid): string
62			{
63			if (! Uuid::isValid($uuid)) {
64			return $uuid;
65			}
66
67			if (! $uuid instanceof Uuid) {
68			$uuid = Uuid::fromString($uuid);
69			}
70
71			return $uuid->getBytes();
72			}
73
74			public static function decodeUuid(string $binaryUuid): string
75			{
76			if (Uuid::isValid($binaryUuid)) {
77			return $binaryUuid;
78			}
79
80			return Uuid::fromBytes($binaryUuid)->toString();
81			}
82
83			public function getUuidKeys()
84			{
85			return (property_exists($this, 'uuids') && is_array($this->uuids)) ? $this->uuids : [];
			0 ignored issues – show Bug introduced 2018-09-26 13:38 UTC by Report Bug Copy Issue Report The property `uuids` 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...
86			}
87
88			public function toArray()
89			{
90			$uuidAttributes = $this->getUuidAttributes();
91
92			$array = parent::toArray();
93			$pivotUuids = [];
			0 ignored issues – show Unused Code introduced 2018-09-26 13:38 UTC by Report Bug Copy Issue Report `$pivotUuids` is not used, you could remove the assignment. This check looks for variable assignements that are either overwritten by other assignments or where the variable is not used subsequently. $myVar = 'Value'; $higher = false; if (rand(1, 6) > 3) { $higher = true; } else { $higher = false; } Both the `$myVar` assignment in line 1 and the `$higher` assignment in line 2 are dead. The first because `$myVar` is never used and the second because `$higher` is always overwritten for every possible time line. Loading history...
94
95			if (! $this->exists \|\| ! is_array($uuidAttributes)) {
			0 ignored issues – show Bug introduced 2018-08-07 13:08 UTC by Report Bug Copy Issue Report The property `exists` 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...
96			return $array;
97			}
98
99			foreach ($uuidAttributes as $attributeKey) {
100			if (! array_key_exists($attributeKey, $array)) {
101			continue;
102			}
103			$uuidKey = $this->getRelatedBinaryKeyName($attributeKey);
104			$array[$attributeKey] = $this->{$uuidKey};
105			}
106
107			if (isset($array['pivot'])) {
108			$pivotUuids = $array['pivot'];
109
110			if (! is_array($pivotUuids)) {
111			$pivotUuids = get_object_vars($pivotUuids);
112			}
113
114			foreach ($pivotUuids as $key => $uuid) {
115			$pivotUuids[$key] = $this->decodeUuid($uuid);
116			}
117
118			$array['pivot'] = $pivotUuids;
119			}
120
121			return $array;
122			}
123
124			public function getRelatedBinaryKeyName($attribute): string
125			{
126			$suffix = $this->getUuidSuffix();
127
128			return preg_match('/(?:[a-zA-Z_]+)?id/i', $attribute) ? "{$attribute}{$suffix}" : $attribute;
129			}
130
131			public function getAttribute($key)
132			{
133			$uuidKey = $this->uuidTextAttribute($key);
134
135			if ($uuidKey && $this->{$uuidKey} !== null) {
			0 ignored issues – show Bug Best Practice introduced 2018-08-07 13:31 UTC by Report Bug Copy Issue Report The expression `$uuidKey` of type `string\|false` is loosely compared to `true`; this is ambiguous if the string can be empty. You might want to explicitly use `!== false` instead. In PHP, under loose comparison (like `==`, or `!=`, or `switch` conditions), values of different types might be equal. For `string` values, the empty string `''` is a special case, in particular the following results might be unexpected: '' == false // true '' == null // true 'ab' == false // false 'ab' == null // false // It is often better to use strict comparison '' === false // false '' === null // false Loading history...
136			return static::decodeUuid($this->{$uuidKey});
137			}
138
139			return parent::getAttribute($key);
140			}
141
142			public function setAttribute($key, $value)
143			{
144			if ($this->uuidTextAttribute($key)) {
			0 ignored issues – show Bug Best Practice introduced 2018-08-07 13:31 UTC by Report Bug Copy Issue Report The expression `$this->uuidTextAttribute($key)` of type `string\|false` is loosely compared to `true`; this is ambiguous if the string can be empty. You might want to explicitly use `!== false` instead. In PHP, under loose comparison (like `==`, or `!=`, or `switch` conditions), values of different types might be equal. For `string` values, the empty string `''` is a special case, in particular the following results might be unexpected: '' == false // true '' == null // true 'ab' == false // false 'ab' == null // false // It is often better to use strict comparison '' === false // false '' === null // false Loading history...
145			$value = static::encodeUuid($value);
146			}
147
148			return parent::setAttribute($key, $value);
149			}
150
151			protected function getUuidSuffix()
152			{
153			return (property_exists($this, 'uuidSuffix')) ? $this->uuidSuffix : '_text';
			0 ignored issues – show Bug introduced 2018-08-07 13:08 UTC by Report Bug Copy Issue Report The property `uuidSuffix` 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...
154			}
155
156			protected function uuidTextAttribute($key)
157			{
158			$uuidAttributes = $this->getUuidAttributes();
159			$suffix = $this->getUuidSuffix();
160			$offset = -(strlen($suffix));
161
162			if (substr($key, $offset) == $suffix && in_array(($uuidKey = substr($key, 0, $offset)), $uuidAttributes)) {
163			return $uuidKey;
164			}
165
166			return false;
167			}
168
169			public function getUuidAttributes()
170			{
171			$uuidKeys = $this->getUuidKeys();
172
173			// non composite primary keys will return a string so casting required
174			$key = (array) $this->getKeyName();
175
176			$uuidAttributes = array_unique(array_merge($uuidKeys, $key));
177
178			return $uuidAttributes;
179			}
180
181			public function getUuidTextAttribute(): ?string
182			{
183			$key = $this->getKeyName();
184
185			if (! $this->exists \|\| is_array($key)) {
186			return null;
187			}
188
189			return static::decodeUuid($this->{$key});
190			}
191
192			public function setUuidTextAttribute(string $uuid)
193			{
194			$key = $this->getKeyName();
195
196			if (! is_string($key)) {
197			throw new Exception('composite keys not allowed for attribute mutation');
198			}
199
200			$this->{$key} = static::encodeUuid($uuid);
201			}
202
203			public function getQueueableId()
204			{
205			return base64_encode($this->{$this->getKeyName()});
206			}
207
208			public function newQueryForRestoration($id)
209			{
210			//return $this->newQueryWithoutScopes()->whereKey(base64_decode($id));
211			return is_array($id)
212			? $this->newQueryWithoutScopes()->whereIn($this->getQualifiedKeyName(), $this->decodeIdArray($id))
			0 ignored issues – show Bug introduced 2018-09-13 00:10 UTC by Report Bug Copy Issue Report It seems like `newQueryWithoutScopes()` 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... Bug introduced 2018-09-13 00:10 UTC by Report Bug Copy Issue Report It seems like `getQualifiedKeyName()` 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...
213			: $this->newQueryWithoutScopes()->whereKey(base64_decode($id));
			0 ignored issues – show Bug introduced 2017-11-21 08:01 UTC by Report Bug Copy Issue Report It seems like `newQueryWithoutScopes()` 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...
214			}
215
216			public function newEloquentBuilder($query)
217			{
218			return new Builder($query);
219			}
220
221			public function getRouteKeyName()
222			{
223			$keyName = $this->getKeyName();
224
225			$routeKeyName = is_string($keyName) ? $this->strUuidSuffix($keyName) : array_map([&$this, 'strUuidSuffix'], $keyName);
226
227			return $routeKeyName;
228			}
229
230			public function getKeyName()
231			{
232			return (! property_exists($this, 'primaryKey') \|\| $this->primaryKey === 'id') ? 'uuid' : $this->primaryKey;
			0 ignored issues – show Bug introduced 2018-09-29 17:46 UTC by Report Bug Copy Issue Report The property `primaryKey` 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...
233			}
234
235			public function getIncrementing()
236			{
237			return false;
238			}
239
240			public function resolveRouteBinding($value)
241			{
242			$keyName = $this->getKeyName();
243
244			if (is_array($keyName)) {
245			$parsed = explode(':', strval($value), count($keyName));
246
247			$value = array_combine($keyName, $parsed);
248			}
249
250			return $this->withUuid($value)->first();
			0 ignored issues – show Bug introduced 2018-02-12 09:15 UTC by Report Bug Copy Issue Report The method `withUuid()` does not exist on `Spatie\BinaryUuid\HasBinaryUuid`. Did you maybe mean `scopeWithUuid()`? This check marks calls to methods that do not seem to exist on an object. This is most likely the result of a method being renamed without all references to it being renamed likewise. Loading history...
251			}
252
253			public function strUuidSuffix($str)
254			{
255			$suffix = $this->getUuidSuffix();
256
257			return "{$str}{$suffix}";
258			}
259
260			private function decodeIdArray($ids)
261			{
262			foreach ($ids as $key => $id) {
263			$ids[$key] = base64_decode($id);
264			}
265
266			return $ids;
267			}
268			}
269

spatie / laravel-binary-uuid

Pull Request — master (#72)

HasBinaryUuid::toArray() B

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like