diff options
| author | Nathaniel Guse <nathaniel.guse@gmail.com> | 2013-03-04 13:33:42 -0600 |
|---|---|---|
| committer | Nathaniel Guse <nathaniel.guse@gmail.com> | 2013-03-04 13:33:42 -0600 |
| commit | 941b7287b7dd3477d5ebce8d15a83cdde49e9dd7 (patch) | |
| tree | c8a8873e9419a25e03f70802cac00742ae4f1fd0 /phpBB/includes/avatar/driver/interface.php | |
| parent | 029f096411f620f2066608cd0a1e8711f88da9e1 (diff) | |
| parent | 2e2ddd7e85034f747d5dd312803aadfc47ac80e2 (diff) | |
| download | forums-941b7287b7dd3477d5ebce8d15a83cdde49e9dd7.tar forums-941b7287b7dd3477d5ebce8d15a83cdde49e9dd7.tar.gz forums-941b7287b7dd3477d5ebce8d15a83cdde49e9dd7.tar.bz2 forums-941b7287b7dd3477d5ebce8d15a83cdde49e9dd7.tar.xz forums-941b7287b7dd3477d5ebce8d15a83cdde49e9dd7.zip | |
Merge remote-tracking branch 'remotes/marc/feature/avatars' into develop
# By Marc Alexander (100) and others
# Via Marc Alexander (8) and Igor Wiedler (3)
* remotes/marc/feature/avatars: (138 commits)
[feature/avatars] Update module_auth of ucp module and fix small issues
[feature/avatars] Add migrations data file for avatars
[feature/avatars] Reduce module auth of ucp avatar settings
[feature/avatars] Auto-clear avatar dimensions when first changing avatars
[feature/avatars] Use "Main" as category for avatars in root of gallery
[feature/avatars] Remove trailing whitespace from avatar code
[feature/avatars] Pass phpbb_user to prepare and process form functions
[feature/avatars] Document the use of the allowed extensions array
[feature/avatars] Use array for allowed extensions and implode if needed
[feature/avatars] Use deprecated for compatibility function
[feature/avatars] Correct license, copyright and package info
[feature/avatars] Move list of supported formats to avatar driver class
[feature/avatars] Add include of functions_display.php in BC function
[feature/avatars] Add note about when compatibility function was added
[feature/avatars] Add compatibility function for get_user_avatar()
[feature/avatars] Move definition of driver_collection to avatars.yml
[feature/avatars] Remove the obsolete request argument for avatar drivers
[feature/avatars] Add missing @var to docblocks in avatar manager
[feature/avatars] Remove not needed inline style
[feature/avatars] Differentiate tests for get drivers functions
...
Diffstat (limited to 'phpBB/includes/avatar/driver/interface.php')
| -rw-r--r-- | phpBB/includes/avatar/driver/interface.php | 116 |
1 files changed, 116 insertions, 0 deletions
diff --git a/phpBB/includes/avatar/driver/interface.php b/phpBB/includes/avatar/driver/interface.php new file mode 100644 index 0000000000..3d62969aef --- /dev/null +++ b/phpBB/includes/avatar/driver/interface.php @@ -0,0 +1,116 @@ +<?php +/** +* +* @package phpBB3 +* @copyright (c) 2011 phpBB Group +* @license http://opensource.org/licenses/gpl-2.0.php GNU General Public License v2 +* +*/ + +/** +* @ignore +*/ +if (!defined('IN_PHPBB')) +{ + exit; +} + +/** +* Interface for avatar drivers +* @package phpBB3 +*/ +interface phpbb_avatar_driver_interface +{ + /** + * Returns the name of the driver. + * + * @return string Name of driver. + */ + public function get_name(); + + /** + * Get the avatar url and dimensions + * + * @param array $row User data or group data that has been cleaned with + * phpbb_avatar_manager::clean_row + * @return array Avatar data, must have keys src, width and height, e.g. + * ['src' => '', 'width' => 0, 'height' => 0] + */ + public function get_data($row); + + /** + * 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 + * phpbb_avatar_manager::clean_row + * @param string $alt Alternate text for avatar image + * + * @return string HTML + */ + public function get_custom_html($user, $row, $alt = ''); + + /** + * Prepare form for changing the settings of this avatar + * + * @param phpbb_request $request Request object + * @param phpbb_template $template Template object + * @param phpbb_user $user User object + * @param array $row User data or group data that has been cleaned with + * phpbb_avatar_manager::clean_row + * @param 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 bool True if form has been successfully prepared + */ + public function prepare_form($request, $template, $user, $row, &$error); + + /** + * 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. + * The setting for enabling/disabling the avatar will be handled by + * the avatar manager. + */ + public function prepare_form_acp($user); + + /** + * Process form data + * + * @param phpbb_request $request Request object + * @param phpbb_template $template Template object + * @param phpbb_user $user User object + * @param array $row User data or group data that has been cleaned with + * phpbb_avatar_manager::clean_row + * @param 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 array Array containing the avatar data as follows: + * ['avatar'], ['avatar_width'], ['avatar_height'] + */ + public function process_form($request, $template, $user, $row, &$error); + + /** + * Delete avatar + * + * @param array $row User data or group data that has been cleaned with + * phpbb_avatar_manager::clean_row + * + * @return bool True if avatar has been deleted or there is no need to delete, + * i.e. when the avatar is not hosted locally. + */ + public function delete($row); + + /** + * Get the avatar driver's template name + * + * @return string Avatar driver's template name + */ + public function get_template_name(); +} |