phpBB API Documentation
Interface

phpbb\avatar\driver\driver_interface

interface driver_interface

Interface for avatar drivers

Methods

string get_name()

Returns the name of the driver.
string get_config_name()

Returns the config name of the driver.
array get_data(array $row)

Get the avatar url and dimensions
string get_custom_html(user $user, array $row, string $alt = '')

Returns custom html if it is needed for displaying this avatar
bool prepare_form(request $request, template $template, user $user, array $row, array $error)

Prepare form for changing the settings of this avatar
array prepare_form_acp(user $user)

Prepare form for changing the acp settings of this avatar
array process_form(request $request, template $template, user $user, array $row, array $error)

Process form data
bool delete(array $row)

Delete avatar
string get_template_name()

Get the avatar driver's template name
string get_acp_template_name()

Get the avatar driver's template name (ACP)

Details

at line 26
public string get_name()

Returns the name of the driver.

Return Value

string Name of driver.

at line 33
public string get_config_name()

Returns the config name of the driver.

To be used in accessing the CONFIG variables.

Return Value

string Config name of driver.

at line 43
public array get_data(array $row)

Get the avatar url and dimensions

Parameters

array $row User data or group data that has been cleaned with \phpbb\avatar\manager::clean_row

Return Value

array Avatar data, must have keys src, width and height, e.g. ['src' => '', 'width' => 0, 'height' => 0]

at line 55
public string get_custom_html(user $user, array $row, string $alt = '')

Returns custom html if it is needed for displaying this avatar

Parameters

user $user phpBB user object
array $row User data or group data that has been cleaned with \phpbb\avatar\manager::clean_row
string $alt Alternate text for avatar image

Return Value

string HTML

at line 72
public bool prepare_form(request $request, template $template, user $user, array $row, array $error)

Prepare form for changing the settings of this avatar

Parameters

request $request Request object
template $template Template object
user $user User object
array $row User data or group data that has been cleaned with \phpbb\avatar\manager::clean_row
array $error Reference to an error array that is filled by this function. Key values can either be a string with a language key or an array that will be passed to vsprintf() with the language key in the first array key.

Return Value

bool True if form has been successfully prepared

at line 83
public array prepare_form_acp(user $user)

Prepare form for changing the acp settings of this avatar

Parameters

user $user phpBB user object

Return Value

array Array of configuration options as consumed by acp_board. The setting for enabling/disabling the avatar will be handled by the avatar manager.

at line 101
public array process_form(request $request, template $template, user $user, array $row, array $error)

Process form data

Parameters

request $request Request object
template $template Template object
user $user User object
array $row User data or group data that has been cleaned with \phpbb\avatar\manager::clean_row
array $error Reference to an error array that is filled by this function. Key values can either be a string with a language key or an array that will be passed to vsprintf() with the language key in the first array key.

Return Value

array Array containing the avatar data as follows: ['avatar'], ['avatarwidth'], ['avatarheight']

at line 112
public bool delete(array $row)

Delete avatar

Parameters

array $row User data or group data that has been cleaned with \phpbb\avatar\manager::clean_row

Return Value

bool True if avatar has been deleted or there is no need to delete, i.e. when the avatar is not hosted locally.

at line 119
public string get_template_name()

Get the avatar driver's template name

Return Value

string Avatar driver's template name

at line 126
public string get_acp_template_name()

Get the avatar driver's template name (ACP)

Return Value

string Avatar driver's template name