| [ Index ] |
PHP Cross Reference of Joomla 4.2.2 documentation |
[Source view] [Print] [Project Stats]
(no description)
| Copyright: | (C) 2020 Open Source Matters, Inc. |
| License: | GNU General Public License version 2 or later; see LICENSE.txt |
| File Size: | 388 lines (13 kb) |
| Included or required: | 0 times |
| Referenced: | 0 times |
| Includes or requires: | 0 files |
| __construct(DispatcherInterface $dispatcher, array $config, UserFactoryInterface $userFactory, InputFilter $filter) X-Ref |
| Constructor. param: DispatcherInterface $dispatcher The dispatcher param: array $config An optional associative array of configuration settings param: UserFactoryInterface $userFactory The user factory param: InputFilter $filter The input filter |
| onUserAuthenticate($credentials, $options, &$response) X-Ref |
| This method should handle any authentication and report back to the subject param: array $credentials Array holding the user credentials param: array $options Array of extra options param: object $response Authentication response object return: void |
| getTokenSeedForUser(int $userId) X-Ref |
| Retrieve the token seed string for the given user ID. param: int $userId The numeric user ID to return the token seed string for. return: string|null Null if there is no token configured or the user doesn't exist. |
| isTokenEnabledForUser(int $userId) X-Ref |
| Is the token enabled for a given user ID? If the user does not exist or has no token it returns false. param: int $userId The User ID to check whether the token is enabled on their account. return: boolean |
| getPluginParameter(string $folder, string $plugin, string $param, $default = null) X-Ref |
| Retrieves a configuration parameter of a different plugin than the current one. param: string $folder Plugin folder param: string $plugin Plugin name param: string $param Parameter name param: null $default Default value, in case the parameter is missing return: mixed |
| getAllowedUserGroups() X-Ref |
| Get the configured user groups which are allowed to have access to tokens. return: int[] |
| isInAllowedUserGroup($userId) X-Ref |
| Is the user with the given ID in the allowed User Groups with access to tokens? param: int $userId The user ID to check return: boolean False when doesn't belong to allowed user groups, user not found, or guest |
| Generated: Wed Sep 7 05:41:13 2022 | Chilli.vc Blog - For Webmaster,Blog-Writer,System Admin and Domainer |