Clarified Return statements

codeigniter4 · Aug 24, 2023 · df13005 · df13005
1 parent 33a07c9
commit df13005
Show file tree

Hide file tree

Showing 2 changed files with 7 additions and 7 deletions.
diff --git a/src/Authentication/Authenticators/HMAC_SHA256.php b/src/Authentication/Authenticators/HMAC_SHA256.php
@@ -195,7 +195,7 @@ public function login(User $user): void
     /**
      * Logs a user in based on their ID.
      *
-     * @param int|string $userId
+     * @param int|string $userId User ID
      *
      * @throws AuthenticationException
      */
@@ -233,7 +233,7 @@ public function getUser(): ?User
     /**
      * Returns the Full Authorization token from the Authorization header
      *
-     * @return ?string
+     * @return ?string Trimmed Authorization Token from Header
      */
     public function getFullAuthToken(): ?string
     {
@@ -272,7 +272,7 @@ public function getHMACAuthTokens(?string $fullToken = null): ?array
     /**
      * Retrieve the key from the Auth token
      *
-     * @return ?string
+     * @return ?string HMAC token key
      */
     public function getAuthKeyFromToken(): ?string
     {
@@ -284,7 +284,7 @@ public function getAuthKeyFromToken(): ?string
     /**
      * Retrieve the HMAC Hash from the Auth token
      *
-     * @return ?string
+     * @return ?string HMAC signature
      */
     public function getHMACHashFromToken(): ?string
     {

diff --git a/src/Models/UserIdentityModel.php b/src/Models/UserIdentityModel.php
@@ -218,7 +218,7 @@ public function getAllAccessTokens(User $user): array
     /**
      * Find and Retrieve the HMAC AccessToken based on Token alone
      *
-     * @return ?AccessToken
+     * @return ?AccessToken Full HMAC Access Token object
      */
     public function getHmacTokenByKey(string $key): ?AccessToken
     {
@@ -267,7 +267,7 @@ public function generateHmacToken(User $user, string $name, array $scopes = ['*'
      * @param User   $user User Object
      * @param string $key  HMAC Key String
      *
-     * @return ?AccessToken
+     * @return ?AccessToken Full HMAC Access Token
      */
     public function getHmacToken(User $user, string $key): ?AccessToken
     {
@@ -286,7 +286,7 @@ public function getHmacToken(User $user, string $key): ?AccessToken
      * @param int|string $id
      * @param User       $user User Object
      *
-     * @return ?AccessToken
+     * @return ?AccessToken Full HMAC Access Token
      */
     public function getHmacTokenById($id, User $user): ?AccessToken
     {