class oauth extends base
OAuth authentication provider for phpBB3
Methods
boolean|string |
init()
Checks whether the user is currently identified to the authentication provider. |
|
array|null |
autologin()
Autologin function |
from base |
acp()
This function is used to output any required fields in the authentication admin panel. |
||
get_acp_template($new_config)
This function updates the template with variables related to the acp options with whatever configuraton values are passed to it as an array. |
||
get_login_data()
Returns an array of data necessary to build custom elements on the login form. |
||
get_auth_link_data(int $user_id)
Returns an array of data necessary to build the ucpauthlink page |
||
logout(array $data, boolean $new_session)
Performs additional actions during logout. |
||
boolean |
validate_session(array $user)
The session validation function checks whether the user is still logged into phpBB. |
from base |
login_link_has_necessary_data($login_link_data)
Checks to see if $loginlinkdata contains all information except for the user_id of an account needed to successfully link an external account to a forum account. |
||
link_account(array $link_data)
Links an external account to a phpBB account. |
||
unlink_account(array $link_data)
Unlinks an external account from a phpBB account. |
||
__construct(driver_interface $db, config $config, manager $passwords_manager, request_interface $request, user $user, $auth_provider_oauth_token_storage_table, $auth_provider_oauth_state_table, $auth_provider_oauth_token_account_assoc, service_collection $service_providers, $users_table, ContainerInterface $phpbb_container, dispatcher_interface $dispatcher, $phpbb_root_path, $php_ext)
OAuth Authentication Constructor |
||
login($username, $password)
Performs login. |
Details
at line 167
public boolean|string
init()
Checks whether the user is currently identified to the authentication provider.
Called in acpboard while setting authentication plugins. Changing to an authentication provider will not be permitted in acpboard if there is an error.
in base at line 32
public array|null
autologin()
Autologin function
at line 409
public
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 426
public
get_acp_template($new_config)
This function updates the template with variables related to the acp options with whatever configuraton values are passed to it as an array.
It then returns the name of the acp file related to this authentication provider.
at line 380
public
get_login_data()
Returns an array of data necessary to build custom elements on the login form.
at line 638
public
get_auth_link_data(int $user_id)
Returns an array of data necessary to build the ucpauthlink page
at line 626
public
logout(array $data, boolean $new_session)
Performs additional actions during logout.
in base at line 80
public boolean
validate_session(array $user)
The session validation function checks whether the user is still logged into phpBB.
at line 452
public
login_link_has_necessary_data($login_link_data)
Checks to see if $loginlinkdata contains all information except for the user_id of an account needed to successfully link an external account to a forum account.
at line 471
public
link_account(array $link_data)
Links an external account to a phpBB account.
at line 694
public
unlink_account(array $link_data)
Unlinks an external account from a phpBB account.
at line 146
public
__construct(driver_interface $db, config $config, manager $passwords_manager, request_interface $request, user $user, $auth_provider_oauth_token_storage_table, $auth_provider_oauth_state_table, $auth_provider_oauth_token_account_assoc, service_collection $service_providers, $users_table, ContainerInterface $phpbb_container, dispatcher_interface $dispatcher, $phpbb_root_path, $php_ext)
OAuth Authentication Constructor
at line 185
public
login($username, $password)
Performs login.