From 22c1353ceaa2dd3af2b6c1dae282e7c5bc44c392 Mon Sep 17 00:00:00 2001 From: Taylor Otwell Date: Thu, 7 Jul 2011 23:01:44 -0500 Subject: [PATCH] added comment to auth class. --- system/auth.php | 5 ++++- 1 file changed, 4 insertions(+), 1 deletion(-) diff --git a/system/auth.php b/system/auth.php index 4fd8fcc8..b06dcc7f 100644 --- a/system/auth.php +++ b/system/auth.php @@ -53,6 +53,9 @@ public static function 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 $password */ @@ -78,7 +81,7 @@ public static function login($username, $password) } /** - * Logout the current user of the application. + * Logout the user of the application. * * @return void */