| [ Index ] |
PHP Cross Reference of Joomla 4.2.2 documentation |
[Source view] [Print] [Project Stats]
Joomla! Content Management System
| Copyright: | (C) 2005 Open Source Matters, Inc. |
| License: | GNU General Public License version 2 or later; see LICENSE.txt |
| File Size: | 221 lines (7 kb) |
| Included or required: | 0 times |
| Referenced: | 0 times |
| Includes or requires: | 0 files |
Authentication:: (4 methods):
__construct()
getInstance()
authenticate()
authorise()
Class: Authentication - X-Ref
Authentication class, provides an interface for the Joomla authentication system| __construct(string $pluginType = 'authentication', DispatcherInterface $dispatcher = null) X-Ref |
| Constructor param: string $pluginType The plugin type to run authorisation and authentication on param: DispatcherInterface $dispatcher The event dispatcher we're going to use |
| getInstance(string $pluginType = 'authentication') X-Ref |
| Returns the global authentication object, only creating it if it doesn't already exist. param: string $pluginType The plugin type to run authorisation and authentication on return: Authentication The global Authentication object |
| authenticate($credentials, $options = array() X-Ref |
| Finds out if a set of login credentials are valid by asking all observing objects to run their respective authentication routines. param: array $credentials Array holding the user credentials. param: array $options Array holding user options. return: AuthenticationResponse Response object with status variable filled in for last plugin or first successful plugin. |
| authorise($response, $options = array() X-Ref |
| Authorises that a particular user should be able to login param: AuthenticationResponse $response response including username of the user to authorise param: array $options list of options return: AuthenticationResponse[] Array of authentication response objects |
| Generated: Wed Sep 7 05:41:13 2022 | Chilli.vc Blog - For Webmaster,Blog-Writer,System Admin and Domainer |