feat!: make abstract value and trait readonly

Author: lindyhopchris

CHANGELOG.md

@@ -9,6 +9,7 @@ All notable changes to this project will be documented in this file. This projec
 
 - Minimum PHP version is now 8.2.
 - Added generics to the value interface, abstract class and trait. This will be breaking if you are running PHPStan.
+- **BREAKING**: The abstract value and value trait are now both readonly. This is because value objects should always be immutable.
 
 ## [2.2.0] - 2022-03-04
 

src/AbstractValue.php

@@ -16,7 +16,7 @@
  * @template TValue
  * @implements ValueInterface<TValue>
  */
-abstract class AbstractValue implements ValueInterface
+abstract readonly class AbstractValue implements ValueInterface
 {
     /** @use ValueTrait<TValue> */
     use ValueTrait;

src/ValueTrait.php

@@ -23,20 +23,15 @@ trait ValueTrait
     /**
      * @var TValue
      */
-    protected mixed $value;
+    public readonly mixed $value;
 
-    /**
-     * @return string
-     */
     public function __toString(): string
     {
         return $this->toString();
     }
 
     /**
      * Fluent to string method.
-     *
-     * @return string
      */
     public function toString(): string
     {
@@ -58,8 +53,7 @@ public function get(): mixed
     /**
      * Is the value any of the provided values?
      *
-     * @param mixed ...$values
-     * @return bool
+     * @param  mixed  ...$values
      */
     public function is(...$values): bool
     {
@@ -76,20 +70,14 @@ public function is(...$values): bool
         return false;
     }
 
-    /**
-     * @return bool
-     */
     public function isEmpty(): bool
     {
         return empty($this->value);
     }
 
-    /**
-     * @return bool
-     */
     public function isNotEmpty(): bool
     {
-        return !$this->isEmpty();
+        return ! $this->isEmpty();
     }
 
     /**
@@ -102,9 +90,6 @@ public function jsonSerialize(): mixed
 
     /**
      * Does the value match the provided value?
-     *
-     * @param mixed $value
-     * @return bool
      */
     protected function matches(mixed $value): bool
     {
@@ -121,8 +106,6 @@ protected function matches(mixed $value): bool
 
     /**
      * Should strict comparison be used for comparing values?
-     *
-     * @return bool
      */
     protected function useStrict(): bool
     {

tests/IntegerValue.php

@@ -17,7 +17,7 @@
 /**
  * @extends AbstractValue<int>
  */
-class IntegerValue extends AbstractValue
+final readonly class IntegerValue extends AbstractValue
 {
     protected function accept(mixed $value): bool
     {

tests/StringValue.php

@@ -17,7 +17,7 @@
 /**
  * @extends AbstractValue<string>
  */
-class StringValue extends AbstractValue
+final readonly class StringValue extends AbstractValue
 {
     protected function accept(mixed $value): bool
     {