Commit 4c243f3a authored by Taylor Otwell's avatar Taylor Otwell

Refactor the auth class and its comments.

parent a7cf737b
...@@ -16,7 +16,6 @@ class Auth { ...@@ -16,7 +16,6 @@ class Auth {
* Typically, the user should be accessed via the "user" method. * Typically, the user should be accessed via the "user" method.
* *
* @var object * @var object
* @see user()
*/ */
public static $user; public static $user;
...@@ -31,7 +30,6 @@ class Auth { ...@@ -31,7 +30,6 @@ class Auth {
* Determine if the current user of the application is authenticated. * Determine if the current user of the application is authenticated.
* *
* @return bool * @return bool
* @see login
*/ */
public static function check() public static function check()
{ {
...@@ -59,7 +57,7 @@ class Auth { ...@@ -59,7 +57,7 @@ class Auth {
} }
/** /**
* Attempt to login a user. * Attempt to log a user into your application.
* *
* If the user credentials are valid. The user's ID will be stored in the session and the * If the user credentials are valid. The user's ID will be stored in the session and the
* user will be considered "logged in" on subsequent requests to the application. * user will be considered "logged in" on subsequent requests to the application.
...@@ -70,7 +68,6 @@ class Auth { ...@@ -70,7 +68,6 @@ class Auth {
* @param string $username * @param string $username
* @param string $password * @param string $password
* @return bool * @return bool
* @see Hash::check()
*/ */
public static function login($username, $password) public static function login($username, $password)
{ {
...@@ -88,10 +85,10 @@ class Auth { ...@@ -88,10 +85,10 @@ class Auth {
} }
/** /**
* Log a user into the application without checking credentials. * Log a user into your application.
* *
* The user's ID will be stored in the session and the user will be considered * The user's ID will be stored in the session and the user will be considered
* "logged in" on subsequent requests to the application. * "logged in" on subsequent requests to your application.
* *
* Note: The user given to this method should be an object having an "id" property. * Note: The user given to this method should be an object having an "id" property.
* *
...@@ -106,7 +103,7 @@ class Auth { ...@@ -106,7 +103,7 @@ class Auth {
} }
/** /**
* Log the user out of the application. * Log the user out of your application.
* *
* The user ID will be removed from the session and the user will no longer * The user ID will be removed from the session and the user will no longer
* be considered logged in on subsequent requests. * be considered logged in on subsequent requests.
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment