Chore: Add Override attribute to all overriding methods

Unleash · May 20, 2024 · 8758393 · 8758393
1 parent 477bb2f
commit 8758393
Show file tree

Hide file tree

Showing 68 changed files with 252 additions and 2 deletions.
diff --git a/.php-cs-fixer.dist.php b/.php-cs-fixer.dist.php
@@ -89,5 +89,6 @@
         'phpdoc_order' => true,
         'phpdoc_scalar' => true,
         'phpdoc_separation' => true,
+        'global_namespace_import' => true,
     ])
     ->setFinder($finder);
diff --git a/src/Bootstrap/CompoundBootstrapProvider.php b/src/Bootstrap/CompoundBootstrapProvider.php
@@ -4,6 +4,7 @@
 
 use Exception;
 use JsonSerializable;
+use Override;
 use Traversable;
 use Unleash\Client\Exception\CompoundException;
 
@@ -23,6 +24,7 @@ public function __construct(
     /**
      * @return array<mixed>|JsonSerializable|Traversable<mixed>|null
      */
+    #[Override]
     public function getBootstrap(): array|JsonSerializable|Traversable|null
     {
         $exceptions = [];

diff --git a/src/Bootstrap/DefaultBootstrapHandler.php b/src/Bootstrap/DefaultBootstrapHandler.php
@@ -3,13 +3,15 @@
 namespace Unleash\Client\Bootstrap;
 
 use JsonException;
+use Override;
 use Traversable;
 
 final readonly class DefaultBootstrapHandler implements BootstrapHandler
 {
     /**
      * @throws JsonException
      */
+    #[Override]
     public function getBootstrapContents(BootstrapProvider $provider): ?string
     {
         $bootstrap = $provider->getBootstrap();

diff --git a/src/Bootstrap/EmptyBootstrapProvider.php b/src/Bootstrap/EmptyBootstrapProvider.php
@@ -3,10 +3,12 @@
 namespace Unleash\Client\Bootstrap;
 
 use JsonSerializable;
+use Override;
 use Traversable;
 
 final readonly class EmptyBootstrapProvider implements BootstrapProvider
 {
+    #[Override]
     public function getBootstrap(): array|JsonSerializable|Traversable|null
     {
         return null;

diff --git a/src/Bootstrap/FileBootstrapProvider.php b/src/Bootstrap/FileBootstrapProvider.php
@@ -4,6 +4,7 @@
 
 use InvalidArgumentException;
 use JsonException;
+use Override;
 use RuntimeException;
 use SplFileInfo;
 use Throwable;
@@ -22,6 +23,7 @@ public function __construct(
      *
      * @return array<mixed>
      */
+    #[Override]
     public function getBootstrap(): array
     {
         $filePath = $this->getFilePath($this->file);

diff --git a/src/Bootstrap/JsonBootstrapProvider.php b/src/Bootstrap/JsonBootstrapProvider.php
@@ -3,6 +3,7 @@
 namespace Unleash\Client\Bootstrap;
 
 use JsonException;
+use Override;
 use Unleash\Client\Exception\InvalidValueException;
 
 final readonly class JsonBootstrapProvider implements BootstrapProvider
@@ -17,6 +18,7 @@ public function __construct(
      *
      * @return array<mixed>
      */
+    #[Override]
     public function getBootstrap(): array
     {
         $result = @json_decode($this->json, true);

diff --git a/src/Bootstrap/JsonSerializableBootstrapProvider.php b/src/Bootstrap/JsonSerializableBootstrapProvider.php
@@ -3,6 +3,7 @@
 namespace Unleash\Client\Bootstrap;
 
 use JsonSerializable;
+use Override;
 use Traversable;
 
 final readonly class JsonSerializableBootstrapProvider implements BootstrapProvider
@@ -18,6 +19,7 @@ public function __construct(
     /**
      * @return array<mixed>|JsonSerializable|Traversable<mixed>
      */
+    #[Override]
     public function getBootstrap(): array|JsonSerializable|Traversable
     {
         return $this->data;

diff --git a/src/Client/DefaultRegistrationService.php b/src/Client/DefaultRegistrationService.php
@@ -5,6 +5,7 @@
 use DateTimeImmutable;
 use Exception;
 use JsonException;
+use Override;
 use Psr\Http\Client\ClientExceptionInterface;
 use Psr\Http\Client\ClientInterface;
 use Psr\Http\Message\RequestFactoryInterface;
@@ -33,6 +34,7 @@ public function __construct(
      * @throws JsonException
      * @throws ClientExceptionInterface
      */
+    #[Override]
     public function register(iterable $strategyHandlers): bool
     {
         if (!$this->configuration->isFetchingEnabled()) {

diff --git a/src/Configuration/UnleashContext.php b/src/Configuration/UnleashContext.php
@@ -4,6 +4,7 @@
 
 use DateTimeImmutable;
 use DateTimeInterface;
+use Override;
 use Unleash\Client\Enum\ContextField;
 use Unleash\Client\Enum\Stickiness;
 use Unleash\Client\Exception\InvalidValueException;
@@ -26,26 +27,31 @@ public function __construct(
         $this->setCurrentTime($currentTime);
     }
 
+    #[Override]
     public function getCurrentUserId(): ?string
     {
         return $this->currentUserId;
     }
 
+    #[Override]
     public function getEnvironment(): ?string
     {
         return $this->environment;
     }
 
+    #[Override]
     public function getIpAddress(): ?string
     {
         return $this->ipAddress ?? $_SERVER['REMOTE_ADDR'] ?? null;
     }
 
+    #[Override]
     public function getSessionId(): ?string
     {
         return $this->sessionId ?? (session_id() ?: null);
     }
 
+    #[Override]
     public function getCustomProperty(string $name): string
     {
         if (!array_key_exists($name, $this->customContext)) {
@@ -55,18 +61,21 @@ public function getCustomProperty(string $name): string
         return $this->customContext[$name];
     }
 
+    #[Override]
     public function setCustomProperty(string $name, ?string $value): self
     {
         $this->customContext[$name] = $value ?? '';
 
         return $this;
     }
 
+    #[Override]
     public function hasCustomProperty(string $name): bool
     {
         return array_key_exists($name, $this->customContext);
     }
 
+    #[Override]
     public function removeCustomProperty(string $name, bool $silent = true): self
     {
         if (!$this->hasCustomProperty($name) && !$silent) {
@@ -78,39 +87,45 @@ public function removeCustomProperty(string $name, bool $silent = true): self
         return $this;
     }
 
+    #[Override]
     public function setCurrentUserId(?string $currentUserId): self
     {
         $this->currentUserId = $currentUserId;
 
         return $this;
     }
 
+    #[Override]
     public function setIpAddress(?string $ipAddress): self
     {
         $this->ipAddress = $ipAddress;
 
         return $this;
     }
 
+    #[Override]
     public function setSessionId(?string $sessionId): self
     {
         $this->sessionId = $sessionId;
 
         return $this;
     }
 
+    #[Override]
     public function setEnvironment(?string $environment): self
     {
         $this->environment = $environment;
 
         return $this;
     }
 
+    #[Override]
     public function getHostname(): ?string
     {
         return $this->findContextValue(ContextField::HOSTNAME) ?? (gethostname() ?: null);
     }
 
+    #[Override]
     public function setHostname(?string $hostname): self
     {
         if ($hostname === null) {
@@ -125,6 +140,7 @@ public function setHostname(?string $hostname): self
     /**
      * @param array<string> $values
      */
+    #[Override]
     public function hasMatchingFieldValue(string $fieldName, array $values): bool
     {
         $fieldValue = $this->findContextValue($fieldName);
@@ -135,6 +151,7 @@ public function hasMatchingFieldValue(string $fieldName, array $values): bool
         return in_array($fieldValue, $values, true);
     }
 
+    #[Override]
     public function findContextValue(string $fieldName): ?string
     {
         return match ($fieldName) {
@@ -147,6 +164,7 @@ public function findContextValue(string $fieldName): ?string
         };
     }
 
+    #[Override]
     public function getCurrentTime(): DateTimeInterface
     {
         if (!$this->hasCustomProperty('currentTime')) {
@@ -156,6 +174,7 @@ public function getCurrentTime(): DateTimeInterface
         return new DateTimeImmutable($this->getCustomProperty('currentTime'));
     }
 
+    #[Override]
     public function setCurrentTime(DateTimeInterface|string|null $time): self
     {
         if ($time === null) {
@@ -171,6 +190,7 @@ public function setCurrentTime(DateTimeInterface|string|null $time): self
     /**
      * @return array<string, string>
      */
+    #[Override]
     public function getCustomProperties(): array
     {
         return $this->customContext;

diff --git a/src/ConstraintValidator/DefaultConstraintValidator.php b/src/ConstraintValidator/DefaultConstraintValidator.php
@@ -2,6 +2,7 @@
 
 namespace Unleash\Client\ConstraintValidator;
 
+use Override;
 use Unleash\Client\Configuration\Context;
 use Unleash\Client\ConstraintValidator\Operator\Date\DateAfterOperatorValidator;
 use Unleash\Client\ConstraintValidator\Operator\Date\DateBeforeOperatorValidator;
@@ -24,6 +25,7 @@
 
 final class DefaultConstraintValidator implements ConstraintValidator
 {
+    #[Override]
     public function validateConstraint(Constraint $constraint, Context $context): bool
     {
         $field = $constraint->getContextName();

diff --git a/src/ConstraintValidator/Operator/AbstractOperatorValidator.php b/src/ConstraintValidator/Operator/AbstractOperatorValidator.php
@@ -2,6 +2,7 @@
 
 namespace Unleash\Client\ConstraintValidator\Operator;
 
+use Override;
 use Unleash\Client\Exception\OperatorValidatorException;
 
 /**
@@ -12,6 +13,7 @@ abstract class AbstractOperatorValidator implements OperatorValidator
     /**
      * @param array<mixed>|string|null $allowedValues
      */
+    #[Override]
     public function __invoke(string $currentValue, array|string|null $allowedValues): bool
     {
         if ($allowedValues === null) {

diff --git a/src/ConstraintValidator/Operator/Date/AbstractDateOperatorValidator.php b/src/ConstraintValidator/Operator/Date/AbstractDateOperatorValidator.php
@@ -5,13 +5,15 @@
 use DateTimeImmutable;
 use DateTimeInterface;
 use Exception;
+use Override;
 use Unleash\Client\ConstraintValidator\Operator\AbstractOperatorValidator;
 
 /**
  * @internal
  */
 abstract class AbstractDateOperatorValidator extends AbstractOperatorValidator
 {
+    #[Override]
     protected function acceptsValues(array|string $values): bool
     {
         if (!is_string($values)) {

diff --git a/src/ConstraintValidator/Operator/Date/DateAfterOperatorValidator.php b/src/ConstraintValidator/Operator/Date/DateAfterOperatorValidator.php
@@ -2,11 +2,14 @@
 
 namespace Unleash\Client\ConstraintValidator\Operator\Date;
 
+use Override;
+
 /**
  * @internal
  */
 final class DateAfterOperatorValidator extends AbstractDateOperatorValidator
 {
+    #[Override]
     protected function validate(string $currentValue, array|string $searchInValue): bool
     {
         assert(is_string($searchInValue));

diff --git a/src/ConstraintValidator/Operator/Date/DateBeforeOperatorValidator.php b/src/ConstraintValidator/Operator/Date/DateBeforeOperatorValidator.php
@@ -2,11 +2,14 @@
 
 namespace Unleash\Client\ConstraintValidator\Operator\Date;
 
+use Override;
+
 /**
  * @internal
  */
 final class DateBeforeOperatorValidator extends AbstractDateOperatorValidator
 {
+    #[Override]
     protected function validate(string $currentValue, array|string $searchInValue): bool
     {
         assert(is_string($searchInValue));

diff --git a/src/ConstraintValidator/Operator/Lists/AbstractListOperatorValidator.php b/src/ConstraintValidator/Operator/Lists/AbstractListOperatorValidator.php
@@ -2,13 +2,15 @@
 
 namespace Unleash\Client\ConstraintValidator\Operator\Lists;
 
+use Override;
 use Unleash\Client\ConstraintValidator\Operator\AbstractOperatorValidator;
 
 /**
  * @internal
  */
 abstract class AbstractListOperatorValidator extends AbstractOperatorValidator
 {
+    #[Override]
     protected function acceptsValues(array|string $values): bool
     {
         return is_array($values) && array_is_list($values);

diff --git a/src/ConstraintValidator/Operator/Lists/InListOperatorValidator.php b/src/ConstraintValidator/Operator/Lists/InListOperatorValidator.php
@@ -2,11 +2,14 @@
 
 namespace Unleash\Client\ConstraintValidator\Operator\Lists;
 
+use Override;
+
 /**
  * @internal
  */
 final class InListOperatorValidator extends AbstractListOperatorValidator
 {
+    #[Override]
     protected function validate(string $currentValue, array|string $searchInValue): bool
     {
         assert(is_array($searchInValue));

diff --git a/src/ConstraintValidator/Operator/Lists/NotInListOperatorValidator.php b/src/ConstraintValidator/Operator/Lists/NotInListOperatorValidator.php
@@ -2,11 +2,14 @@
 
 namespace Unleash\Client\ConstraintValidator\Operator\Lists;
 
+use Override;
+
 /**
  * @internal
  */
 final class NotInListOperatorValidator extends AbstractListOperatorValidator
 {
+    #[Override]
     protected function validate(string $currentValue, array|string $searchInValue): bool
     {
         assert(is_array($searchInValue));