Adding more documentation.

cakephp · Feb 4, 2011 · 23db2f0 · 23db2f0
1 parent e155e6a
commit 23db2f0
Showing 1 changed file with 3 additions and 1 deletion.
diff --git a/cake/libs/controller/components/auth.php b/cake/libs/controller/components/auth.php
@@ -582,7 +582,9 @@ public function user($key = null) {
 	}
 
 /**
- * If no parameter is passed, gets the authentication redirect URL.
+ * If no parameter is passed, gets the authentication redirect URL.  Pass a url in to 
+ * set the destination a user should be redirected to upon logging in.  Will fallback to 
+ * AuthComponent::$loginRedirect if there is no stored redirect value.
  *
  * @param mixed $url Optional URL to write as the login redirect URL.
  * @return string Redirect URL