HasBinaryUuid::newQueryForRestoration() - Code Metrics - Inspection of "Added dynamic accessor and mutators from $uuidAttr..." - spatie/laravel-binary-uuid - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Pull Request — master (#35)

unknown

created 2018-01-18 10:53 UTC

HasBinaryUuid::newQueryForRestoration() A

↳ Parent: HasBinaryUuid

Complexity

Conditions	1
Paths	1

Size

Total Lines	4
Code Lines	2

Duplication

Lines	0
Ratio	0 %

Importance

Changes

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

<?php

namespace Spatie\BinaryUuid;

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

trait HasBinaryUuid
{
    protected static function bootHasBinaryUuid()
    {
        static::creating(function (Model $model) {
            if ($model->{$model->getKeyName()}) {
                return;
            }

            $model->{$model->getKeyName()} = static::encodeUuid(Uuid::uuid1());
        });
    }

    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) {
            return static::encodeUuid($modelUuid);
        }, $uuid));
    }

    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 toArray()
    {
        $uuidAttributes = $this->getUuidAttributes();

        $array = parent::toArray();
        foreach ($uuidAttributes as $attributeKey) {
            if (array_key_exists($attributeKey, $array)) {
                $array[$attributeKey] = $this->{"{$attributeKey}_text"};
            }
        }

        return $array;
    }

    public function getUuidAttributes()
    {
        $uuidAttributes = [$this->getKeyName()];
trait Idable {
    public function equalIds(Idable $other) {
        return $this->getId() === $other->getId();
    }
}
        if (property_exists($this, 'uuidAttributes')) {
            $uuidAttributes = $this->uuidAttributes === null ? [] : $this->uuidAttributes;
class MyClass { }

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

        return $uuidAttributes;
    }

    public function getAttribute($key)
    {
        if (($uuidKey = $this->uuidTextAttribute($key)) && $this->{$uuidKey} !== null) {
            return static::decodeUuid($this->{$uuidKey});
        }

        return parent::getAttribute($key);
    }

    public function setAttribute($key, $value)
    {
        if ($uuidKey = $this->uuidTextAttribute($key)) {
$myVar = 'Value';
$higher = false;

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

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

    protected function uuidTextAttribute($key)
    {
        if (substr($key, -5) == '_text' &&
            in_array(($uuidKey = substr($key, 0, -5)), $this->getUuidAttributes())) {
            return $uuidKey;
        }

        return false;
    }

    public function getUuidTextAttribute(): string
    {
        return static::decodeUuid($this->{$this->getKeyName()});
trait Idable {
    public function equalIds(Idable $other) {
        return $this->getId() === $other->getId();
    }
}
    }

    public function setUuidTextAttribute(string $uuid)
    {
        $this->{$this->getKeyName()} = static::encodeUuid($uuid);
trait Idable {
    public function equalIds(Idable $other) {
        return $this->getId() === $other->getId();
    }
}
    }

    public function getQueueableId()
    {
        return base64_encode($this->{$this->getKeyName()});
trait Idable {
    public function equalIds(Idable $other) {
        return $this->getId() === $other->getId();
    }
}
    }

    public function newQueryForRestoration($id)
    {
        return $this->newQueryWithoutScopes()->whereKey(base64_decode($id));
trait Idable {
    public function equalIds(Idable $other) {
        return $this->getId() === $other->getId();
    }
}
    }

    public function getRouteKeyName()
    {
        return 'uuid_text';
    }
}


1			<?php
2
3			namespace Spatie\BinaryUuid;
4
5			use Ramsey\Uuid\Uuid;
6			use Illuminate\Database\Eloquent\Model;
7			use Illuminate\Database\Eloquent\Builder;
8
9			trait HasBinaryUuid
10			{
11			protected static function bootHasBinaryUuid()
12			{
13			static::creating(function (Model $model) {
14			if ($model->{$model->getKeyName()}) {
15			return;
16			}
17
18			$model->{$model->getKeyName()} = static::encodeUuid(Uuid::uuid1());
19			});
20			}
21
22			public static function scopeWithUuid(Builder $builder, $uuid, $field = null): Builder
23			{
24			if ($field) {
25			return static::scopeWithUuidRelation($builder, $uuid, $field);
26			}
27
28			if ($uuid instanceof Uuid) {
29			$uuid = (string) $uuid;
30			}
31
32			$uuid = (array) $uuid;
33
34			return $builder->whereKey(array_map(function (string $modelUuid) {
35			return static::encodeUuid($modelUuid);
36			}, $uuid));
37			}
38
39			public static function scopeWithUuidRelation(Builder $builder, $uuid, string $field): Builder
40			{
41			if ($uuid instanceof Uuid) {
42			$uuid = (string) $uuid;
43			}
44
45			$uuid = (array) $uuid;
46
47			return $builder->whereIn($field, array_map(function (string $modelUuid) {
48			return static::encodeUuid($modelUuid);
49			}, $uuid));
50			}
51
52			public static function encodeUuid($uuid): string
53			{
54			if (! Uuid::isValid($uuid)) {
55			return $uuid;
56			}
57
58			if (! $uuid instanceof Uuid) {
59			$uuid = Uuid::fromString($uuid);
60			}
61
62			return $uuid->getBytes();
63			}
64
65			public static function decodeUuid(string $binaryUuid): string
66			{
67			if (Uuid::isValid($binaryUuid)) {
68			return $binaryUuid;
69			}
70
71			return Uuid::fromBytes($binaryUuid)->toString();
72			}
73
74			public function toArray()
75			{
76			$uuidAttributes = $this->getUuidAttributes();
77
78			$array = parent::toArray();
79			foreach ($uuidAttributes as $attributeKey) {
80			if (array_key_exists($attributeKey, $array)) {
81			$array[$attributeKey] = $this->{"{$attributeKey}_text"};
82			}
83			}
84
85			return $array;
86			}
87
88			public function getUuidAttributes()
89			{
90			$uuidAttributes = [$this->getKeyName()];
			0 ignored issues – show Bug introduced 2018-01-18 10:55 UTC by Report Bug Copy Issue Report It seems like `getKeyName()` 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...
91			if (property_exists($this, 'uuidAttributes')) {
92			$uuidAttributes = $this->uuidAttributes === null ? [] : $this->uuidAttributes;
			0 ignored issues – show Bug introduced 2018-01-18 10:55 UTC by Report Bug Copy Issue Report The property `uuidAttributes` 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...
93			}
94
95			return $uuidAttributes;
96			}
97
98			public function getAttribute($key)
99			{
100			if (($uuidKey = $this->uuidTextAttribute($key)) && $this->{$uuidKey} !== null) {
101			return static::decodeUuid($this->{$uuidKey});
102			}
103
104			return parent::getAttribute($key);
105			}
106
107			public function setAttribute($key, $value)
108			{
109			if ($uuidKey = $this->uuidTextAttribute($key)) {
			0 ignored issues – show Unused Code introduced 2018-01-18 10:55 UTC by Report Bug Copy Issue Report `$uuidKey` 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...
110			$value = static::encodeUuid($value);
111			}
112
113			return parent::setAttribute($key, $value);
114			}
115
116			protected function uuidTextAttribute($key)
117			{
118			if (substr($key, -5) == '_text' &&
119			in_array(($uuidKey = substr($key, 0, -5)), $this->getUuidAttributes())) {
120			return $uuidKey;
121			}
122
123			return false;
124			}
125
126			public function getUuidTextAttribute(): string
127			{
128			return static::decodeUuid($this->{$this->getKeyName()});
			0 ignored issues – show Bug introduced 2017-11-19 19:42 UTC by Report Bug Copy Issue Report It seems like `getKeyName()` 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...
129			}
130
131			public function setUuidTextAttribute(string $uuid)
132			{
133			$this->{$this->getKeyName()} = static::encodeUuid($uuid);
			0 ignored issues – show Bug introduced 2017-11-19 19:42 UTC by Report Bug Copy Issue Report It seems like `getKeyName()` 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...
134			}
135
136			public function getQueueableId()
137			{
138			return base64_encode($this->{$this->getKeyName()});
			0 ignored issues – show Bug introduced 2017-11-21 08:07 UTC by Report Bug Copy Issue Report It seems like `getKeyName()` 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...
139			}
140
141			public function newQueryForRestoration($id)
142			{
143			return $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...
144			}
145
146			public function getRouteKeyName()
147			{
148			return 'uuid_text';
149			}
150			}
151

spatie / laravel-binary-uuid

Pull Request — master (#35)

HasBinaryUuid::newQueryForRestoration() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like