phpBB API Documentation
Class

phpbb\auth\provider\apache

class apache extends base

Apache authentication provider for phpBB3

Methods

boolean|string init()

Checks whether the user is currently identified to the authentication provider.

array|null autologin()

Autologin function

acp()

This function is used to output any required fields in the authentication admin panel.

from base
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.

from base
get_login_data()

Returns an array of data necessary to build custom elements on the login form.

from base
get_auth_link_data()

Returns an array of data necessary to build the ucpauthlink page

from base
logout(array $data, boolean $new_session)

Performs additional actions during logout.

from base
boolean validate_session(array $user)

The session validation function checks whether the user is still logged into phpBB.

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.

from base
link_account(array $link_data)

Links an external account to a phpBB account.

from base
unlink_account(array $link_data)

Unlinks an external account from a phpBB account.

from base
__construct(driver_interface $db, config $config, manager $passwords_manager, request $request, user $user, $phpbb_root_path, $php_ext)

Apache Authentication Constructor

login($username, $password)

Performs login.

Details

at line 53
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.

Return Value

boolean|string False if the user is identified, otherwise an error message, or null if not implemented.

at line 155
public array|null autologin()

Autologin function

Return Value

array|null containing the user row, empty if no auto login should take place, or null if not impletmented.

in base at line 40
public acp()

This function is used to output any required fields in the authentication admin panel.

It also defines any required configuration table fields.

in base at line 48
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.

Parameters

$new_config

in base at line 56
public get_login_data()

Returns an array of data necessary to build custom elements on the login form.

Returns an array of data necessary to build the ucpauthlink page

in base at line 72
public logout(array $data, boolean $new_session)

Performs additional actions during logout.

Parameters

array $data An array corresponding to \phpbb\session::data
boolean $new_session True for a new session, false for no new session.

at line 246
public boolean validate_session(array $user)

The session validation function checks whether the user is still logged into phpBB.

Parameters

array $user

Return Value

boolean true if the given user is authenticated, false if the session should be closed, or null if not implemented.

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.

Parameters

$login_link_data

Links an external account to a phpBB account.

Parameters

array $link_data

Unlinks an external account from a phpBB account.

Parameters

array $link_data

at line 39
public __construct(driver_interface $db, config $config, manager $passwords_manager, request $request, user $user, $phpbb_root_path, $php_ext)

Apache Authentication Constructor

Parameters

driver_interface $db
config $config
manager $passwords_manager
request $request
user $user
$phpbb_root_path
$php_ext

at line 65
public login($username, $password)

Performs login.

Parameters

$username
$password