All: Improved readability by changing ? type hinting to |null.

valkyrjaio · Feb 19, 2023 · 686beee · 686beee
1 parent b204e64
commit 686beee
Show file tree

Hide file tree

Showing 114 changed files with 297 additions and 297 deletions.
diff --git a/src/Valkyrja/Annotation/Annotation.php b/src/Valkyrja/Annotation/Annotation.php
@@ -27,7 +27,7 @@ interface Annotation extends Dispatch
      *
      * @return string|null
      */
-    public function getType(): ?string;
+    public function getType(): string|null;
 
     /**
      * Set the type.

diff --git a/src/Valkyrja/Annotation/Models/Annotatable.php b/src/Valkyrja/Annotation/Models/Annotatable.php
@@ -25,12 +25,12 @@ trait Annotatable
      *
      * @var string|null
      */
-    public ?string $type;
+    public string|null $type;
 
     /**
      * @inheritDoc
      */
-    public function getType(): ?string
+    public function getType(): string|null
     {
         return $this->type ?? null;
     }

diff --git a/src/Valkyrja/Annotation/Parser.php b/src/Valkyrja/Annotation/Parser.php
@@ -36,7 +36,7 @@ public function getAnnotations(string $docString): array;
      *
      * @return array|null
      */
-    public function getPropertiesAsArray(string $arguments = null): ?array;
+    public function getPropertiesAsArray(string $arguments = null): array|null;
 
     /**
      * Get the annotations regex.

diff --git a/src/Valkyrja/Annotation/Parsers/Parser.php b/src/Valkyrja/Annotation/Parsers/Parser.php
@@ -81,7 +81,7 @@ public function getAnnotations(string $docString): array
      *
      * @throws JsonException
      */
-    public function getPropertiesAsArray(string $arguments = null): ?array
+    public function getPropertiesAsArray(string $arguments = null): array|null
     {
         // If a valid properties list was passed in
         if ($arguments !== null) {
@@ -164,7 +164,7 @@ public function getAnnotationFromMap(string $annotationType): Annotation
      *
      * @return array[]|null
      */
-    protected function getMatches(string $docString): ?array
+    protected function getMatches(string $docString): array|null
     {
         preg_match_all($this->getRegex(), $docString, $matches);
 
@@ -276,7 +276,7 @@ protected function cleanParts(array $parts): array
      *
      * @return string|null
      */
-    protected function cleanPart(string $match = null): ?string
+    protected function cleanPart(string $match = null): string|null
     {
         if (! $match) {
             return $match;

diff --git a/src/Valkyrja/Api/Json.php b/src/Valkyrja/Api/Json.php
@@ -27,7 +27,7 @@ interface Json extends Model
      *
      * @return string|null
      */
-    public function getMessage(): ?string;
+    public function getMessage(): string|null;
 
     /**
      * Set the message.
@@ -93,7 +93,7 @@ public function setWarning(string $warning): static;
      *
      * @return array|null
      */
-    public function getData(): ?array;
+    public function getData(): array|null;
 
     /**
      * Set the data.

diff --git a/src/Valkyrja/Api/JsonData.php b/src/Valkyrja/Api/JsonData.php
@@ -27,7 +27,7 @@ interface JsonData extends Model
      *
      * @return object|null
      */
-    public function getItem(): ?object;
+    public function getItem(): object|null;
 
     /**
      * Set the item.
@@ -59,7 +59,7 @@ public function setItemKey(string $itemKey): static;
      *
      * @return array|null
      */
-    public function getItems(): ?array;
+    public function getItems(): array|null;
 
     /**
      * Set the items.
@@ -91,7 +91,7 @@ public function setItemsKey(string $itemsKey): static;
      *
      * @return int|null
      */
-    public function getTotal(): ?int;
+    public function getTotal(): int|null;
 
     /**
      * Set the total.
@@ -107,7 +107,7 @@ public function setTotal(int $total = null): static;
      *
      * @return array|null
      */
-    public function getMessages(): ?array;
+    public function getMessages(): array|null;
 
     /**
      * Set the messages.
@@ -123,7 +123,7 @@ public function setMessages(array $messages = null): static;
      *
      * @return array|null
      */
-    public function getData(): ?array;
+    public function getData(): array|null;
 
     /**
      * Set the data.

diff --git a/src/Valkyrja/Api/Models/Json.php b/src/Valkyrja/Api/Models/Json.php
@@ -30,14 +30,14 @@ class Json extends Model implements Contract
      *
      * @var string|null
      */
-    public ?string $message = null;
+    public string|null $message = null;
 
     /**
      * The data.
      *
      * @var array|null
      */
-    public ?array $data = null;
+    public array|null $data = null;
 
     /**
      * The errors.
@@ -70,7 +70,7 @@ class Json extends Model implements Contract
     /**
      * @inheritDoc
      */
-    public function getMessage(): ?string
+    public function getMessage(): string|null
     {
         return $this->message;
     }
@@ -144,7 +144,7 @@ public function setWarning(string $warning): static
     /**
      * @inheritDoc
      */
-    public function getData(): ?array
+    public function getData(): array|null
     {
         return $this->data;
     }

diff --git a/src/Valkyrja/Api/Models/JsonData.php b/src/Valkyrja/Api/Models/JsonData.php
@@ -28,7 +28,7 @@ class JsonData extends Model implements Contract
      *
      * @var object|null
      */
-    public ?object $item = null;
+    public object|null $item = null;
 
     /**
      * The item key.
@@ -42,7 +42,7 @@ class JsonData extends Model implements Contract
      *
      * @var object[]|null
      */
-    public ?array $items = null;
+    public array|null $items = null;
 
     /**
      * The items key.
@@ -56,33 +56,33 @@ class JsonData extends Model implements Contract
      *
      * @var int|null
      */
-    public ?int $total = null;
+    public int|null $total = null;
 
     /**
      * The message.
      *
      * @var string|null
      */
-    public ?string $message = null;
+    public string|null $message = null;
 
     /**
      * The messages.
      *
      * @var array|null
      */
-    public ?array $messages = null;
+    public array|null $messages = null;
 
     /**
      * The data.
      *
      * @var array|null
      */
-    public ?array $data = null;
+    public array|null $data = null;
 
     /**
      * @inheritDoc
      */
-    public function getItem(): ?object
+    public function getItem(): object|null
     {
         return $this->item;
     }
@@ -118,7 +118,7 @@ public function setItemKey(string $itemKey): static
     /**
      * @inheritDoc
      */
-    public function getItems(): ?array
+    public function getItems(): array|null
     {
         return $this->items;
     }
@@ -154,7 +154,7 @@ public function setItemsKey(string $itemsKey): static
     /**
      * @inheritDoc
      */
-    public function getTotal(): ?int
+    public function getTotal(): int|null
     {
         return $this->total;
     }
@@ -172,7 +172,7 @@ public function setTotal(int $total = null): static
     /**
      * @inheritDoc
      */
-    public function getMessages(): ?array
+    public function getMessages(): array|null
     {
         return $this->messages;
     }
@@ -190,7 +190,7 @@ public function setMessages(array $messages = null): static
     /**
      * @inheritDoc
      */
-    public function getData(): ?array
+    public function getData(): array|null
     {
         return $this->data;
     }
@@ -208,7 +208,7 @@ public function setData(array $data = null): static
     /**
      * @inheritDoc
      */
-    public function getMessage(): ?string
+    public function getMessage(): string|null
     {
         return $this->message;
     }

diff --git a/src/Valkyrja/Application/Application.php b/src/Valkyrja/Application/Application.php
@@ -60,7 +60,7 @@ public static function env(string $key = null, mixed $default = null): mixed;
      *
      * @return class-string<Env>|null
      */
-    public static function getEnv(): ?string;
+    public static function getEnv(): string|null;
 
     /**
      * Set the environment variables class.

diff --git a/src/Valkyrja/Application/Applications/Valkyrja.php b/src/Valkyrja/Application/Applications/Valkyrja.php
@@ -159,7 +159,7 @@ public static function env(string $key = null, $default = null): mixed
     /**
      * @inheritDoc
      */
-    public static function getEnv(): ?string
+    public static function getEnv(): string|null
     {
         return self::$env;
     }

diff --git a/src/Valkyrja/Auth/Adapter.php b/src/Valkyrja/Auth/Adapter.php
@@ -39,7 +39,7 @@ public function authenticate(User $user): bool;
      *
      * @return User|null
      */
-    public function retrieve(User $user): ?User;
+    public function retrieve(User $user): User|null;
 
     /**
      * Get a user from token.
@@ -49,7 +49,7 @@ public function retrieve(User $user): ?User;
      *
      * @return User|null
      */
-    public function retrieveByResetToken(User $user, string $resetToken): ?User;
+    public function retrieveByResetToken(User $user, string $resetToken): User|null;
 
     /**
      * Refresh a user from the data store.

diff --git a/src/Valkyrja/Auth/Adapters/NullAdapter.php b/src/Valkyrja/Auth/Adapters/NullAdapter.php
@@ -33,15 +33,15 @@ public function authenticate(User $user): bool
     /**
      * @inheritDoc
      */
-    public function retrieve(User $user): ?User
+    public function retrieve(User $user): User|null
     {
         return $user;
     }
 
     /**
      * @inheritDoc
      */
-    public function retrieveByResetToken(User $user, string $resetToken): ?User
+    public function retrieveByResetToken(User $user, string $resetToken): User|null
     {
         return $user;
     }

diff --git a/src/Valkyrja/Auth/Adapters/ORMAdapter.php b/src/Valkyrja/Auth/Adapters/ORMAdapter.php
@@ -62,7 +62,7 @@ public function authenticate(User $user): bool
     /**
      * @inheritDoc
      */
-    public function retrieve(User $user): ?User
+    public function retrieve(User $user): User|null
     {
         $loginFields = $user::getAuthenticationFields();
         $find        = $this->getUserRepository($user)->find();
@@ -82,7 +82,7 @@ public function retrieve(User $user): ?User
     /**
      * @inheritDoc
      */
-    public function retrieveByResetToken(User $user, string $resetToken): ?User
+    public function retrieveByResetToken(User $user, string $resetToken): User|null
     {
         $resetTokenField = $user::getResetTokenField();
 

diff --git a/src/Valkyrja/Auth/AuthenticatedUsers.php b/src/Valkyrja/Auth/AuthenticatedUsers.php
@@ -36,7 +36,7 @@ public function hasCurrent(): bool;
      *
      * @return User|null
      */
-    public function getCurrent(): ?User;
+    public function getCurrent(): User|null;
 
     /**
      * Set the current user.

diff --git a/src/Valkyrja/Auth/Config/Config.php b/src/Valkyrja/Auth/Config/Config.php
@@ -103,7 +103,7 @@ class Config extends Model
      *
      * @var string|null
      */
-    public ?string $authenticateUrl;
+    public string|null $authenticateUrl;
 
     /**
      * The not authenticated route name.
@@ -117,7 +117,7 @@ class Config extends Model
      *
      * @var string|null
      */
-    public ?string $notAuthenticateUrl;
+    public string|null $notAuthenticateUrl;
 
     /**
      * The password confirm route name.

diff --git a/src/Valkyrja/Auth/Entities/TokenizableUserTrait.php b/src/Valkyrja/Auth/Entities/TokenizableUserTrait.php
@@ -49,7 +49,7 @@ public static function setTokenized(string $token): void
     /**
      * @inheritDoc
      */
-    public static function asTokenized(): ?string
+    public static function asTokenized(): string|null
     {
         return static::$token;
     }

diff --git a/src/Valkyrja/Auth/Entities/UserFields.php b/src/Valkyrja/Auth/Entities/UserFields.php
@@ -39,5 +39,5 @@ trait UserFields
      *
      * @var string|null
      */
-    protected ?string $reset_token = null;
+    protected string|null $reset_token = null;
 }
diff --git a/src/Valkyrja/Auth/Entities/UserTrait.php b/src/Valkyrja/Auth/Entities/UserTrait.php
@@ -30,7 +30,7 @@ trait UserTrait
      *
      * @return class-string<Repository>|null
      */
-    public static function getAuthRepository(): ?string
+    public static function getAuthRepository(): string|null
     {
         return null;
     }
@@ -40,7 +40,7 @@ public static function getAuthRepository(): ?string
      *
      * @return class-string<AuthenticatedUsers>|null
      */
-    public static function getAuthCollection(): ?string
+    public static function getAuthCollection(): string|null
     {
         return null;
     }