base
abstract class base implements provider_interface
Base authentication provider class that all other providers should implement
Methods
Checks whether the user is currently identified to the authentication provider.
Autologin function
This function is used to output any required fields in the authentication admin panel. It also defines any required configuration table fields.
This function updates the template with variables related to the acp options with whatever configuration values are passed to it as an array.
Returns an array of data necessary to build custom elements on the login form.
Returns an array of data necessary to build the ucp_auth_link page
Performs additional actions during logout.
The session validation function checks whether the user is still logged into phpBB.
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.
Links an external account to a phpBB account.
Unlinks an external account from a phpBB account.
Details
at line 24
bool|string
init()
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.
at line 32
array|null
autologin()
Autologin function
at line 40
array|null
acp()
This function is used to output any required fields in the authentication admin panel. It also defines any required configuration table fields.
at line 48
array|null
get_acp_template(config $new_config)
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.
at line 56
array|null
get_login_data()
Returns an array of data necessary to build custom elements on the login form.
at line 64
array|null
get_auth_link_data(int $user_id = 0)
Returns an array of data necessary to build the ucp_auth_link page
at line 72
logout(array $data, bool $new_session)
Performs additional actions during logout.
at line 80
bool
validate_session(array $user)
The session validation function checks whether the user is still logged into phpBB.
at line 88
string|null
login_link_has_necessary_data(array $login_link_data)
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.
at line 96
link_account(array $link_data)
Links an external account to a phpBB account.
at line 104
unlink_account(array $link_data)
Unlinks an external account from a phpBB account.