Browse Source

Update docblocks.

ADmad 10 years ago
parent
commit
65f09aeeaf
2 changed files with 4 additions and 1 deletions
  1. 3 0
      src/Auth/BaseAuthenticate.php
  2. 1 1
      src/Auth/FormAuthenticate.php

+ 3 - 0
src/Auth/BaseAuthenticate.php

@@ -35,6 +35,9 @@ abstract class BaseAuthenticate implements EventListenerInterface
      * - `fields` The fields to use to identify a user by.
      * - `userModel` The alias for users table, defaults to Users.
      * - `finder` The finder method to use to fetch user record. Defaults to 'all'.
+     *   You can set finder name as string or an array where key is finder name and value
+     *   is an array passed to `Table::find()` options.
+     *   E.g. ['finderName' => ['some_finder_option' => 'some_value']]
      * - `passwordHasher` Password hasher class. Can be a string specifying class name
      *    or an array containing `className` key, any other keys will be passed as
      *    config to the class. Defaults to 'Default'.

+ 1 - 1
src/Auth/FormAuthenticate.php

@@ -25,7 +25,7 @@ use Cake\Network\Response;
  * ```
  *  $this->Auth->authenticate = [
  *      'Form' => [
- *          'scope' => ['Users.active' => 1]
+ *          'finder' => ['auth' => ['some_finder_option' => 'some_value']]
  *      ]
  *  ]
  * ```