[ Index ]

PHP Cross Reference of phpBB-3.2.8-deutsch

title

Body

[close]

/phpbb/avatar/driver/ -> driver_interface.php (summary)

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: 127 lines (4 kb)
Included or required:0 times
Referenced: 0 times
Includes or requires: 0 files

Defines 1 class

driver_interface:: (10 methods):
  get_name()
  get_config_name()
  get_data()
  get_custom_html()
  prepare_form()
  prepare_form_acp()
  process_form()
  delete()
  get_template_name()
  get_acp_template_name()


Interface: driver_interface  - X-Ref

Interface for avatar drivers

get_name()   X-Ref
Returns the name of the driver.

return: string    Name of driver.

get_config_name()   X-Ref
Returns the config name of the driver. To be used in accessing the CONFIG variables.

return: string    Config name of driver.

get_data($row)   X-Ref
Get the avatar url and dimensions

param: array    $row User data or group data that has been cleaned with
return: array Avatar data, must have keys src, width and height, e.g.

get_custom_html($user, $row, $alt = '')   X-Ref
Returns custom html if it is needed for displaying this avatar

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

prepare_form($request, $template, $user, $row, &$error)   X-Ref
Prepare form for changing the settings of this avatar

param: \phpbb\request\request $request Request object
param: \phpbb\template\template    $template Template object
param: \phpbb\user $user User object
param: array    $row User data or group data that has been cleaned with
param: array    &$error Reference to an error array that is filled by this
return: bool True if form has been successfully prepared

prepare_form_acp($user)   X-Ref
Prepare form for changing the acp settings of this avatar

param: \phpbb\user $user phpBB user object
return: array Array of configuration options as consumed by acp_board.

process_form($request, $template, $user, $row, &$error)   X-Ref
Process form data

param: \phpbb\request\request $request Request object
param: \phpbb\template\template    $template Template object
param: \phpbb\user $user User object
param: array    $row User data or group data that has been cleaned with
param: array    &$error Reference to an error array that is filled by this
return: array Array containing the avatar data as follows:

delete($row)   X-Ref
Delete avatar

param: array $row User data or group data that has been cleaned with
return: bool True if avatar has been deleted or there is no need to delete,

get_template_name()   X-Ref
Get the avatar driver's template name

return: string Avatar driver's template name

get_acp_template_name()   X-Ref
Get the avatar driver's template name (ACP)

return: string Avatar driver's template name



Generated: Tue Apr 7 19:42:26 2020 Cross-referenced by PHPXref 0.7.1