Fixing docblock to reflect change from '*' to 'all'. Adding note abou…

…t constant.
cakephp · Feb 4, 2011 · 2f91767 · 2f91767
1 parent 8285189
commit 2f91767
Showing 1 changed file with 8 additions and 4 deletions.
diff --git a/cake/libs/controller/components/auth.php b/cake/libs/controller/components/auth.php
@@ -65,11 +65,11 @@ class AuthComponent extends Component {
  *
  * Using the class name without 'Authenticate' as the key, you can pass in an array of settings for each
  * authentication object.  Additionally you can define settings that should be set to all authentications objects
- * using the '*' key:
+ * using the 'all' key:
  *
  * {{{
  *	$this->Auth->authenticate = array(
- *		'*' => array(
+ *		'all' => array(
  *			'userModel' => 'Users.User',
  *			'scope' => array('User.active' => 1)
  *		),
@@ -78,6 +78,8 @@ class AuthComponent extends Component {
  *	);
  * }}}
  *
+ * You can also use AuthComponent::ALL instead of the string 'all'.
+ *
  * @var array
  * @link http://book.cakephp.org/view/1278/authenticate
  */
@@ -104,18 +106,20 @@ class AuthComponent extends Component {
  *
  * Using the class name without 'Authorize' as the key, you can pass in an array of settings for each
  * authorization object.  Additionally you can define settings that should be set to all authorization objects
- * using the '*' key:
+ * using the 'all' key:
  *
  * {{{
  *	$this->Auth->authorize = array(
- *		'*' => array(
+ *		'all' => array(
  *			'actionPath' => 'controllers/'
  *		),
  *		'Crud',
  *		'CustomAuth'
  *	);
  * }}}
  *
+ * You can also use AuthComponent::ALL instead of the string 'all'
+ *
  * @var mixed
  * @link http://book.cakephp.org/view/1275/authorize
  */