jasny / auth

src/Jasny/Auth.php

Doc Comments +6 added lines, -4 removed lines

@@ -56,7 +56,7 @@ 
     /**
      * Get current authenticated user id
      * 
-     * @return mixed
+     * @return integer
      */
     protected static function getCurrentUserId()
     {
@@ -79,7 +79,9 @@ 
     /**
      * Fetch user and verify password
      * 
-     * @return User|false
+     * @param string $username
+     * @param string $password
+     * @return User
      */
     public static function verify($username, $password)
     {
@@ -94,7 +96,7 @@ 
      * 
      * @param string $username
      * @param string $password
-     * @return boolean
+     * @return null|boolean
      */
     public static function login($username, $password)
     {
@@ -186,7 +188,7 @@ 
     /**
      * Generate a confirmation hash
      * 
-     * @param User|int $user
+     * @param string $user
      * @return string
      */
     public static function generateConfirmationHash($user)

Braces +32 added lines, -10 removed lines

@@ -85,7 +85,9 @@ 
     {
         $user = static::fetchUserByUsername($username);
         
-        if (!$user || $user->getPassword() !== static::password($password, $user->getPassword())) return false;
+        if (!$user || $user->getPassword() !== static::password($password, $user->getPassword())) {
+         return false;
+        }
         return $user;
     }
     
@@ -99,7 +101,9 @@ 
     public static function login($username, $password)
     {
         $user = static::verify($username, $password);
-        if (!$user) return null;
+        if (!$user) {
+         return null;
+        }
         
         return static::setUser($user);
     }
@@ -112,7 +116,9 @@ 
      */
     public static function setUser(User $user)
     {
-        if ($user->onLogin() === false) return false;
+        if ($user->onLogin() === false) {
+         return false;
+        }
         
         self::$user = $user;
         static::persistCurrentUser();
@@ -126,7 +132,9 @@ 
     public static function logout()
     {
         $user = static::user();
-        if (!$user) return;
+        if (!$user) {
+         return;
+        }
         
         $user->onLogout();
         
@@ -143,7 +151,9 @@ 
     {
         if (!isset(static::$user)) {
             $uid = static::getCurrentUserId();
-            if ($uid) static::$user = static::fetchUserById($uid);
+            if ($uid) {
+             static::$user = static::fetchUserById($uid);
+            }
         }
         
         return static::$user;
@@ -165,8 +175,12 @@ 
      */
     public static function access($role = null)
     {
-        if (!static::user()) return false;
-        if (!isset($role)) return true;
+        if (!static::user()) {
+         return false;
+        }
+        if (!isset($role)) {
+         return true;
+        }
 
         return static::user() instanceof Authz\User && static::user()->hasRole($role);
     }
@@ -179,7 +193,9 @@ 
      */
     protected static function getSecret()
     {
-        if (!isset(static::$secret)) throw new \Exception("Auth secret isn't set");
+        if (!isset(static::$secret)) {
+         throw new \Exception("Auth secret isn't set");
+        }
         return static::$secret;
     }
     
@@ -206,7 +222,10 @@ 
     public static function fetchForConfirmation($hash)
     {
         $id = base_convert(substr($hash, 10), 36, 10);
-        if (static::generateConfirmationHash($id) != $hash) return null; // invalid hash
+        if (static::generateConfirmationHash($id) != $hash) {
+         return null;
+        }
+        // invalid hash
         
         return static::fetchUserById($id);
     }
@@ -237,7 +256,10 @@ 
         $id = base_convert(substr($hash, 10), 36, 10);
         
         $user = static::fetchUserById($id);
-        if (!$user || static::generatePasswordResetHash($user) != $hash) return null; // invalid hash
+        if (!$user || static::generatePasswordResetHash($user) != $hash) {
+         return null;
+        }
+        // invalid hash
         
         return $user;
     }