Commit 22c1353c authored by Taylor Otwell's avatar Taylor Otwell

added comment to auth class.

parent 70e35fb3
...@@ -53,6 +53,9 @@ class Auth { ...@@ -53,6 +53,9 @@ class Auth {
/** /**
* Attempt to login a user. * Attempt to login a user.
* *
* If the user credentials are valid. The user ID will be stored in the session
* and will be considered "logged in" on subsequent requests to the application.
*
* @param string $username * @param string $username
* @param string $password * @param string $password
*/ */
...@@ -78,7 +81,7 @@ class Auth { ...@@ -78,7 +81,7 @@ class Auth {
} }
/** /**
* Logout the current user of the application. * Logout the user of the application.
* *
* @return void * @return void
*/ */
......
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