Passed
Push — main ( 0df40c...ce1342 )
by Michael
04:28 queued 52s
created

ValueObject::__toString()   A

Complexity

Conditions 1
Paths 1

Size

Total Lines 3
Code Lines 1

Duplication

Lines 0
Ratio 0 %

Code Coverage

Tests 2
CRAP Score 1

Importance

Changes 0
Metric Value
eloc 1
c 0
b 0
f 0
dl 0
loc 3
ccs 2
cts 2
cp 1
rs 10
cc 1
nc 1
nop 0
crap 1
1
<?php
2
3
declare(strict_types=1);
4
5
namespace MichaelRubel\ValueObjects;
6
7
use Illuminate\Contracts\Support\Arrayable;
8
use Illuminate\Support\Traits\Conditionable;
9
use Illuminate\Support\Traits\Macroable;
10
11
abstract class ValueObject implements Arrayable
12
{
13
    use Macroable, Conditionable;
0 ignored issues
show
Bug introduced by
The trait Illuminate\Support\Traits\Macroable requires the property $name which is not provided by MichaelRubel\ValueObjects\ValueObject.
Loading history...
14
15
    /**
16
     * Get the object value.
17
     *
18
     * @return mixed
19
     */
20
    abstract public function value();
21
22
    /**
23
     * Convenient method to create a value object statically.
24
     *
25
     * @param  mixed  $values
26
     *
27
     * @return static
28
     */
29 20
    public static function make(mixed ...$values): static
30
    {
31 20
        return new static(...$values);
0 ignored issues
show
Unused Code introduced by
The call to MichaelRubel\ValueObject...ueObject::__construct() has too many arguments starting with $values. ( Ignorable by Annotation )

If this is a false-positive, you can also ignore this issue in your code via the ignore-call  annotation

31
        return /** @scrutinizer ignore-call */ new static(...$values);

This check compares calls to functions or methods with their respective definitions. If the call has more arguments than are defined, it raises an issue.

If a function is defined several times with a different number of parameters, the check may pick up the wrong definition and report false positives. One codebase where this has been known to happen is Wordpress. Please note the @ignore annotation hint above.

Loading history...
32
    }
33
34
    /**
35
     * Check if objects are instances of same class
36
     * and share the same properties and values.
37
     *
38
     * @param  ValueObject  $object
39
     *
40
     * @return bool
41
     */
42 1
    public function equals(ValueObject $object): bool
43
    {
44 1
        return $this == $object;
45
    }
46
47
    /**
48
     * Get the length of the value.
49
     *
50
     * @return int
51
     */
52
    public function length(): int
53
    {
54
        return strlen((string) $this->value());
55
    }
56
57
    /**
58
     * Make sure value object is immutable.
59
     *
60
     * @param  string  $name
61
     * @param  mixed  $value
62
     *
63
     * @return void
64
     */
65 4
    public function __set(string $name, mixed $value): void
66
    {
67 4
        throw new \InvalidArgumentException('Value objects are immutable. You cannot modify properties. Create a new object instead.');
68
    }
69
70
    /**
71
     * Get an array representation of the value object.
72
     *
73
     * @return array
74
     */
75 1
    public function toArray(): array
76
    {
77 1
        return (array) $this->value();
78
    }
79
80
    /**
81
     * Get string representation of the value object.
82
     *
83
     * @return string
84
     */
85 7
    public function __toString(): string
86
    {
87 7
        return (string) $this->value();
88
    }
89
}
90