35         'logout' => true, // can the user logout again? (eg. not possible with HTTP auth)
89                 // can at least one of the user's properties be changed?
115      * example for enforcing a user name schema.
119      * 'modify' it is a single user name (string), but for 'delete' it is the list of
120      * user names to remove (string[]). Event handlers calling getUserData() on
153      * Log off the current user [ OPTIONAL ]
171      * authenticate a user - all other DokuWiki internals
186      * the function needs to check if the user is logged in
195      * @param   string $user Username
201     public function trustExternal($user, $pass, $sticky = false)  argument
215         $_SERVER['REMOTE_USER'] = $user;
216         $_SESSION[DOKU_COOKIE]['auth']['user'] = $user;
225      * Check user+password [ MUST BE OVERRIDDEN ]
227      * Checks if the given user exists and the given
233      * @param   string $user the user name
237     public function checkPass($user, $pass)  argument
244      * Return user info [ MUST BE OVERRIDDEN ]
246      * Returns info about the given user needs to contain
249      * name string  full name of the user
250      * mail string  email address of the user
251      * grps array   list of groups the user is in
254      * @param   string $user the user name
256      * @return  false|array containing user data or false
258     public function getUserData($user, $requireGroups = true)  argument
265      * Create a new User [implement only where required/possible]
267      * Returns false if the user already exists, null when an error
270      * The new user HAS TO be added to the default group by this
276      * @param  string $user
283     public function createUser($user, $pass, $name, $mail, $grps = null)  argument
290      * Modify user data [implement only where required/possible]
295      * @param   string $user nick of the user to be changed
299     public function modifyUser($user, $changes)  argument
301         msg("authorisation method does not allow modifying of user data", -1);
321      * Return a count of the number of user which meet $filter criteria
332         msg("authorisation method does not provide user counts", -1);
337      * Bulk retrieval of user data [implement only where required/possible]
342      * @param   int $start index of first user to be returned
349         msg("authorisation method does not support mass retrieval of user data", -1);
387      * When your backend is caseinsensitive (eg. you can login with USER and
388      * user) then you need to overwrite this method and return false
400      * This function is applied to any user name that is given to
401      * the backend and should also be applied to any user name within
407      * @param string $user username
410     public function cleanUser($user)  argument
412         return $user;
438      * DokuWiki caches user info in the user's session for the timespan defined
442      * This also means that changes to the user database will not be reflected
445      * To accommodate for this, the user manager plugin will touch a reference
450      * the backend's database through other means than the user manager plugin.
456      * @param  string $user - The username
460     public function useSessionCache($user)  argument