| [ Index ] |
PHP Cross Reference of phpBB-3.3.14-deutsch |
[Source view] [Print] [Project Stats]
This file is part of the phpBB Forum Software package.
| Copyright: | (c) phpBB Limited |
| License: | GNU General Public License, version 2 (GPL-2.0) |
| File Size: | 198 lines (7 kb) |
| Included or required: | 0 times |
| Referenced: | 0 times |
| Includes or requires: | 0 files |
provider_interface:: (12 methods):
init()
login()
autologin()
acp()
get_acp_template()
get_login_data()
logout()
validate_session()
login_link_has_necessary_data()
link_account()
get_auth_link_data()
unlink_account()
Interface: provider_interface - X-Ref
The interface authentication provider classes have to implement.| init() X-Ref |
| Checks whether the user is currently identified to the authentication provider. Called in acp_board while setting authentication plugins. Changing to an authentication provider will not be permitted in acp_board if there is an error. return: boolean|string False if the user is identified, otherwise an |
| login($username, $password) X-Ref |
| Performs login. param: string $username The name of the user being authenticated. param: string $password The password of the user. return: array An associative array of the format: |
| autologin() X-Ref |
| Autologin function return: array|null containing the user row, empty if no auto login |
| acp() X-Ref |
| This function is used to output any required fields in the authentication admin panel. It also defines any required configuration table fields. return: array|null Returns null if not implemented or an array of the |
| get_acp_template($new_config) X-Ref |
| This function updates the template with variables related to the acp options with whatever configuration values are passed to it as an array. It then returns the name of the acp file related to this authentication provider. param: \phpbb\config\config $new_config Contains the new configuration values return: array|null Returns null if not implemented or an array with |
| get_login_data() X-Ref |
| Returns an array of data necessary to build custom elements on the login form. return: array|null If this function is not implemented on an auth |
| logout($data, $new_session) X-Ref |
| Performs additional actions during logout. param: array $data An array corresponding to param: boolean $new_session True for a new session, false for no new |
| validate_session($user) X-Ref |
| The session validation function checks whether the user is still logged into phpBB. param: array $user return: boolean true if the given user is authenticated, false if the |
| login_link_has_necessary_data(array $login_link_data) X-Ref |
| Checks to see if $login_link_data contains all information except for the user_id of an account needed to successfully link an external account to a forum account. param: array $login_link_data Any data needed to link a phpBB account to return: string|null Returns a string with a language constant if there |
| link_account(array $link_data) X-Ref |
| Links an external account to a phpBB account. param: array $link_data Any data needed to link a phpBB account to |
| get_auth_link_data($user_id = 0) X-Ref |
| Returns an array of data necessary to build the ucp_auth_link page param: int $user_id User ID for whom the data should be retrieved. return: array|null If this function is not implemented on an auth |
| unlink_account(array $link_data) X-Ref |
| Unlinks an external account from a phpBB account. param: array $link_data Any data needed to unlink a phpBB account |
| Generated: Mon Nov 25 19:05:08 2024 | Cross-referenced by PHPXref 0.7.1 |