fix docs and comments.

fix updateHmacTokenExpiration() token refresh.

Author: CosDiabos

docs/references/authentication/hmac.md

@@ -99,9 +99,9 @@ $user->revokeAllHmacTokens();
 
 ## Expiring HMAC Keys
 
-By default, the HMAC keys don't expire unless they meet the HMAC Keys lifetime expiration after their last used date.
+By default, the HMAC keys don't expire unless they reach the HMAC keys' lifetime expiration after their last use date.
 
-HMAC keys can be set to expire through the `generateHmacToken()` method. This takes the expiration date as the `$expiresAt` argument. To update an existing HMAC key expiration date use `updateHmacTokenExpiration($hmacTokenID, $expiresAt)` and to remove `removeHmacTokenExpiration($hmacTokenID)`.
+HMAC keys can be set to expire through the `generateHmacToken()` method. This takes the expiration date as the `$expiresAt` argument. To update an existing HMAC key expiration date, use `updateHmacTokenExpiration($hmacTokenID, $expiresAt)`. To remove it, use `removeHmacTokenExpiration($hmacTokenID)`.
 
 `$expiresAt` [Time](https://codeigniter.com/user_guide/libraries/time.html) object
 
@@ -124,7 +124,7 @@ $user->removeHmacTokenExpiration($token->id);
 
 The following support methods are also available:
 
-`isHmacTokenExpired(AccessToken $HmacToken)` - Checks if the HMAC key is expired. Returns `true` if the HMAC key is expired, `false` if not.
+`isHmacTokenExpired(AccessToken $hmacToken)` - Checks if the HMAC key is expired. Returns `true` if the HMAC key is expired; otherwise, returns `false`.
 
 ```php
 $expiresAt = Time::parse('2024-11-03 12:00:00');
@@ -133,7 +133,7 @@ $token = $this->user->generateHmacToken('foo', ['foo.bar'], $expiresAt);
 $this->user->isHmacTokenExpired($token); // Returns true
 ```
 
-`hasHmacTokenExpiry(AccessToken $HmacToken)` - Checks if HMAC key has an expiration set. Returns `true` or `false` accordingly.
+`hasHmacTokenExpiry(AccessToken $hmacToken)` - Checks if HMAC key has an expiration set. Returns `true` if the HMAC key is expired; otherwise, returns `false`.
 
 ```php
 $expiresAt = Time::parse('2024-11-03 12:00:00');
@@ -287,7 +287,7 @@ public $unusedTokenLifetime = YEAR;
 
 ### HMAC Keys Expiration vs Lifetime
 
-Expiration and Lifetime are different concepts. The lifetime is the maximum time allowed for the HMAC Key to exist since its last use. HMAC Key expiration, on the other hand, is a set date in which the HMAC Key will cease to function.
+Expiration and lifetime are two different concepts. The lifetime is the maximum time allowed for the HMAC Key to exist since its last use. HMAC Key expiration, on the other hand, is a set date in which the HMAC Key will cease to function.
 
 ### Login Attempt Logging
 

docs/references/authentication/tokens.md

@@ -140,9 +140,9 @@ public $unusedTokenLifetime = YEAR;
 
 ## Expiring Access Tokens
 
-By default, the Access Tokens don't expire unless they meet the Access Token lifetime expiration after their last used date.
+By default, the Access Tokens don't expire unless they reach the Access Token's lifetime expiration after their last use date.
 
-Access Tokens can be set to expire through the `generateAccessToken()` method. This takes the expiration date as the `$expiresAt` argument. To update an existing HMAC key expiration date use `updateAcessTokenExpiration($hmacTokenID, $expiresAt)` and to remove `removeAccessTokenExpiration($hmacTokenID)`.
+Access Tokens can be set to expire through the `generateAccessToken()` method. This takes the expiration date as the `$expiresAt` argument. To update an existing HMAC key expiration date, use `updateAcessTokenExpiration($accessTokenID, $expiresAt)`. To remove it, use `removeAccessTokenExpiration($accessTokenID)`.
 
 `$expiresAt` [Time](https://codeigniter.com/user_guide/libraries/time.html) object
 
@@ -165,7 +165,7 @@ $user->removeAccessTokenExpiration($token->id);
 
 The following support methods are also available:
 
-`isAccessTokenExpired(AccessToken $accessToken)` - Checks if Access Token is expired. Returns `true` if the Access Token is expired, `false` if not.
+`isAccessTokenExpired(AccessToken $accessToken)` - Checks if Access Token is expired. Returns `true` if the Access Token is expired; otherwise, returns `false`.
 
 ```php
 $expiresAt = Time::parse('2024-11-03 12:00:00');
@@ -175,7 +175,7 @@ $token = $this->user->generateAccessToken('foo', ['foo.bar'], $expiresAt);
 $this->user->isAccessTokenExpired($token); // Returns true
 ```
 
-`hasAccessTokenExpiry(AccessToken $HmacToken)` - Checks if Access Token has an expiration set. Returns `true` or `false` accordingly.
+`hasAccessTokenExpiry(AccessToken $accessToken)` - Returns `true` if the Access Token has a set expiration date; otherwise, returns `false`.
 
 ```php
 $expiresAt = Time::parse('2024-11-03 12:00:00');
@@ -190,7 +190,7 @@ $this->user->hasAccessTokenExpiry($token); // Returns true
 
 ### Access Token Expiration vs Lifetime
 
-Expiration and Lifetime are different concepts. The lifetime is the maximum time allowed for the token to exist since its last use. Token expiration, on the other hand, is a set date in which the Access Token will cease to function.
+Expiration and lifetime are two different concepts. The lifetime is the maximum time allowed for the token to exist since its last use. Token expiration, on the other hand, is a set date in which the Access Token will cease to function.
 
 ### Login Attempt Logging
 

src/Authentication/Traits/HasHmacTokens.php

@@ -162,17 +162,17 @@ public function setHmacToken(?AccessToken $accessToken): self
     }
 
     /**
-     * Checks if the provided Access Token is expired.
+     * Checks if the provided HMAC Token is expired.
      */
-    public function isHmacTokenExpired(AccessToken $accessToken): bool
+    public function isHmacTokenExpired(AccessToken $hmacToken): bool
     {
-        return $accessToken->expires !== null && $accessToken->expires->isBefore(Time::now());
+        return $hmacToken->expires !== null && $hmacToken->expires->isBefore(Time::now());
     }
 
     /**
      * Sets an expiration for HMAC token by ID.
      *
-     * @param int  $id        AccessToken ID
+     * @param int  $id        HMAC Token ID
      * @param Time $expiresAt Expiration date
      *
      * @return bool Returns true if expiration date is set or updated.
@@ -184,8 +184,8 @@ public function updateHmacTokenExpiration(int $id, Time $expiresAt): bool
         $result        = $identityModel->setIdentityExpirationById($id, $this, $expiresAt);
 
         if ($result) {
-            // refresh currentAccessToken with updated data
-            $this->currentAccessToken = $identityModel->getHmacTokenById($id, $this);
+            // refresh currentHmacToken with updated data
+            $this->currentHmacToken = $identityModel->getHmacTokenById($id, $this);
         }
 
         return $result;
@@ -194,7 +194,7 @@ public function updateHmacTokenExpiration(int $id, Time $expiresAt): bool
     /**
      * Removes the expiration date for HMAC token by ID.
      *
-     * @param int $id AccessToken ID
+     * @param int $id HMAC Token ID
      *
      * @return bool Returns true if expiration date is removed
      */
@@ -205,7 +205,7 @@ public function removeHmacTokenExpiration(int $id): bool
         $result        = $identityModel->setIdentityExpirationById($id, $this);
 
         if ($result) {
-            // refresh currentAccessToken with updated data
+            // refresh currentHmacToken with updated data
             $this->currentHmacToken = $identityModel->getHmacTokenById($id, $this);
         }
 
@@ -215,8 +215,8 @@ public function removeHmacTokenExpiration(int $id): bool
     /**
      * Checks if the current HMAC token has a set expiration date
      */
-    public function hasHmacTokenExpiry(AccessToken $accessToken): bool
+    public function hasHmacTokenExpiry(AccessToken $hmacToken): bool
     {
-        return $accessToken->expires !== null;
+        return $hmacToken->expires !== null;
     }
 }