fix test for lower PHP version and PHPDoc blocks

Author: CosDiabos

phpstan-baseline.php

@@ -258,8 +258,7 @@
 ];
 $ignoreErrors[] = [
 	'message' => '#^Call to function model with CodeIgniter\\\\Shield\\\\Models\\\\UserIdentityModel\\:\\:class is discouraged\\.$#',
-	'identifier' => 'codeigniter.factoriesClassConstFetch',
-	'count' => 19,
+	'count' => 21,
 	'path' => __DIR__ . '/src/Entities/User.php',
 ];
 $ignoreErrors[] = [

src/Authentication/Authenticators/AccessTokens.php

@@ -156,7 +156,7 @@ public function check(array $credentials): Result
 
         // Is expired ?
         if (
-            $token->expires
+            $token->expires !== null
             && $token->expires->isBefore(
                 Time::now()
             )

src/Authentication/Traits/HasAccessTokens.php

@@ -175,24 +175,20 @@ public function setAccessToken(?AccessToken $accessToken): self
     /**
      * Checks if the provided Access Token has expired.
      *
-     * @return false|true|null Returns true if Access Token has expired, false if not, and null if the expire field is null
+     * @return bool|null Returns true if Access Token has expired, false if not, and null if the expire field is null
      */
     public function hasAccessTokenExpired(?AccessToken $accessToken): bool|null
     {
-        if (null === $accessToken->expires) {
-            return null;
-        }
-
-        return $accessToken->expires->isBefore(Time::now());
+        return $accessToken->expires !== null ? $accessToken->expires->isBefore(Time::now()) : null;
     }
 
     /**
      * Returns formatted date to expiration for provided AccessToken
      *
-     * @param AcessToken $accessToken AccessToken
-     * @param string     $format      The return format - "date" or "human".  Date is 'Y-m-d h:i:s', human is 'in 2 weeks'
+     * @param AccessToken $accessToken AccessToken
+     * @param string      $format      The return format - "date" or "human".  Date is 'Y-m-d h:i:s', human is 'in 2 weeks'
      *
-     * @return false|true|null Returns true if Access Token has expired, false if not and null if the expire field is null
+     * @return string|null Returns a formatted expiration date or null if the expire field is not set.
      *
      * @throws InvalidArgumentException
      */
@@ -219,6 +215,8 @@ public function getAccessTokenTimeToExpire(?AccessToken $accessToken, string $fo
      *
      * @param int    $id        AccessTokens ID
      * @param string $expiresAt Expiration date. Accepts DateTime string formatted as 'Y-m-d h:i:s' or DateTime relative formats (1 day, 2 weeks, 6 months, 1 year) to be added to DateTime 'now'
+     *
+     * @return bool Returns true if expiration date is set or updated.
      */
     public function setAccessTokenExpirationById(int $id, string $expiresAt): bool
     {

src/Authentication/Traits/HasHmacTokens.php

@@ -165,24 +165,20 @@ public function setHmacToken(?AccessToken $accessToken): self
     /**
      * Checks if the provided Access Token has expired.
      *
-     * @return false|true|null Returns true if Access Token has expired, false if not, and null if the expire field is null
+     * @return bool|null Returns true if Access Token has expired, false if not, and null if the expire field is null
      */
     public function hasHmacTokenExpired(?AccessToken $accessToken): bool|null
     {
-        if (null === $accessToken->expires) {
-            return null;
-        }
-
-        return $accessToken->expires->isBefore(Time::now());
+        return $accessToken->expires !== null ? $accessToken->expires->isBefore(Time::now()) : null;
     }
 
     /**
      * Returns formatted date to expiration for provided Hmac Key/Token.
      *
-     * @param AcessToken $accessToken AccessToken
-     * @param string     $format      The return format - "date" or "human".  Date is 'Y-m-d h:i:s', human is 'in 2 weeks'
+     * @param AccessToken $accessToken AccessToken
+     * @param string      $format      The return format - "date" or "human".  Date is 'Y-m-d h:i:s', human is 'in 2 weeks'
      *
-     * @return false|true|null Returns true if Access Token has expired, false if not and null if the expire field is null
+     * @return string|null Returns a formatted expiration date or null if the expire field is not set.
      *
      * @throws InvalidArgumentException
      */
@@ -207,10 +203,10 @@ public function getHmacTokenTimeToExpire(?AccessToken $accessToken, string $form
     /**
      * Sets an expiration for Hmac Key/Token by ID.
      *
-     * @param int    $id        AccessTokens ID
+     * @param int    $id        AccessToken ID
      * @param string $expiresAt Expiration date. Accepts DateTime string formatted as 'Y-m-d h:i:s' or DateTime relative formats (1 day, 2 weeks, 6 months, 1 year) to be added to DateTime 'now'
      *
-     * @return false|true|null Returns true if token is updated, false if not.
+     * @return bool Returns true if expiration date is set or updated.
      */
     public function setHmacTokenExpirationById(int $id, string $expiresAt): bool
     {

src/Entities/AccessToken.php

@@ -22,6 +22,7 @@
  * Represents a single Personal Access Token, used
  * for authenticating users for an API.
  *
+ * @property string|Time|null $expires
  * @property string|Time|null $last_used_at
  */
 class AccessToken extends Entity

src/Models/UserIdentityModel.php

@@ -106,10 +106,6 @@ private function checkUserId(User $user): void
 
     private function checkExpiresAtFormat(string $expiresAt): string
     {
-        if (! is_string($expiresAt)) {
-            throw new InvalidArgumentException('$expiresAt should be a string.');
-        }
-
         $expireMatch = [];
 
         // Check Y-m-d h:i:s format.
@@ -277,30 +273,26 @@ public function getAllAccessTokens(User $user): array
      *
      * @param string $expiresAt Expiration date. Accepts DateTime string formatted as 'Y-m-d h:i:s' or DateTime relative formats (1 day, 2 weeks, 6 months, 1 year) to be added to 'Time::now()'
      * @param mixed  $id
+     *
+     * @return bool Returns true if expiration date was set or updated.
      */
     public function setIdentityExpirationById($id, User $user, ?string $expiresAt = null, ?string $type_token = null): bool
     {
         $this->checkUserId($user);
 
-        if (! $expiresAt) {
-            throw new InvalidArgumentException("setIdentityExpirationById(): expiresAt argument can't be null.");
-        }
-
         $expiresAt = $this->checkExpiresAtFormat($expiresAt);
 
-        $currentExpiration = $this->asObject(AccessToken::class)->find($id);
+        $currentExpiration = $this->where('user_id', $user->id)->where('id', $id)->asObject(AccessToken::class)->first();
 
-        // d($currentExpiration);
-        if ($currentExpiration->expires !== $expiresAt) {
-            // throw new InvalidArgumentException(sprintf("User-id: %d type: %s id: %d expires:%s", $user->id,$type_token,$id,$expiresAt));
+        if ($currentExpiration->expires !== null && $currentExpiration->expires !== $expiresAt) {
             return $this->where('user_id', $user->id)
                 ->where('type', $type_token)
                 ->where('id', $id)
                 ->set(['expires' => $expiresAt])
                 ->update();
         }
 
-        throw new InvalidArgumentException('setIdentityExpirationById(): No data to update. ID:' . $id . ' Expires at: ' . $expiresAt . ' curr_expires:' . $currentExpiration->expires . ' Result: ' . ($currentExpiration->expires !== $expiresAt));
+        return false;
     }
 
     // HMAC

tests/Commands/HmacTest.php

@@ -148,7 +148,7 @@ public function testExpireAll(): void
     {
         /** @var User $user */
         $user = fake(UserModel::class);
-        $user->generateHmacToken('foo', expiresAt: '2024-10-01 12:20:00');
+        $user->generateHmacToken('foo', ['*'], '2024-10-01 12:20:00');
         $user->generateHmacToken('bar');
 
         $this->setMockIo([]);