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; |
|
|
|
|
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
|
7 |
|
public static function make(mixed ...$values): static |
30
|
|
|
{ |
31
|
7 |
|
return new static(...$values); |
|
|
|
|
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
|
2 |
|
public function equals(ValueObject $object): bool |
43
|
|
|
{ |
44
|
2 |
|
return $this == $object; |
45
|
|
|
} |
46
|
|
|
|
47
|
|
|
/** |
48
|
|
|
* Inversion to `equals` method. |
49
|
|
|
* |
50
|
|
|
* @param ValueObject $object |
51
|
|
|
* |
52
|
|
|
* @return bool |
53
|
|
|
*/ |
54
|
1 |
|
public function notEquals(ValueObject $object): bool |
55
|
|
|
{ |
56
|
1 |
|
return ! $this->equals($object); |
57
|
|
|
} |
58
|
|
|
|
59
|
|
|
/** |
60
|
|
|
* Get the length of the value. |
61
|
|
|
* |
62
|
|
|
* @return int |
63
|
|
|
*/ |
64
|
1 |
|
public function length(): int |
65
|
|
|
{ |
66
|
1 |
|
return strlen((string) $this->value()); |
67
|
|
|
} |
68
|
|
|
|
69
|
|
|
/** |
70
|
|
|
* Make sure value object is immutable. |
71
|
|
|
* |
72
|
|
|
* @param string $name |
73
|
|
|
* @param mixed $value |
74
|
|
|
* |
75
|
|
|
* @return void |
76
|
|
|
*/ |
77
|
4 |
|
public function __set(string $name, mixed $value): void |
78
|
|
|
{ |
79
|
4 |
|
throw new \InvalidArgumentException('Value objects are immutable. You cannot modify properties. Create a new object instead.'); |
80
|
|
|
} |
81
|
|
|
|
82
|
|
|
/** |
83
|
|
|
* Get an array representation of the value object. |
84
|
|
|
* |
85
|
|
|
* @return array |
86
|
|
|
*/ |
87
|
4 |
|
public function toArray(): array |
88
|
|
|
{ |
89
|
4 |
|
return (array) $this->value(); |
90
|
|
|
} |
91
|
|
|
|
92
|
|
|
/** |
93
|
|
|
* Get string representation of the value object. |
94
|
|
|
* |
95
|
|
|
* @return string |
96
|
|
|
*/ |
97
|
14 |
|
public function __toString(): string |
98
|
|
|
{ |
99
|
14 |
|
return (string) $this->value(); |
100
|
|
|
} |
101
|
|
|
} |
102
|
|
|
|