diff options
| author | Marc Alexander <admin@m-a-styles.de> | 2012-11-19 00:30:18 +0100 |
|---|---|---|
| committer | Marc Alexander <admin@m-a-styles.de> | 2012-11-19 00:30:18 +0100 |
| commit | 8d0c667dcec08fb506dcf19203ded3c699339d6e (patch) | |
| tree | 94a9469a7145a1a2743d2426df385409fa467d2d /phpBB/includes/avatar/driver/interface.php | |
| parent | bea6e845d3c0c25f5f84ad13fcf22f42f1249561 (diff) | |
| download | forums-8d0c667dcec08fb506dcf19203ded3c699339d6e.tar forums-8d0c667dcec08fb506dcf19203ded3c699339d6e.tar.gz forums-8d0c667dcec08fb506dcf19203ded3c699339d6e.tar.bz2 forums-8d0c667dcec08fb506dcf19203ded3c699339d6e.tar.xz forums-8d0c667dcec08fb506dcf19203ded3c699339d6e.zip | |
[feature/avatars] Fix the docs and small naming fixes
PHPBB3-10018
Diffstat (limited to 'phpBB/includes/avatar/driver/interface.php')
| -rw-r--r-- | phpBB/includes/avatar/driver/interface.php | 34 |
1 files changed, 29 insertions, 5 deletions
diff --git a/phpBB/includes/avatar/driver/interface.php b/phpBB/includes/avatar/driver/interface.php index f066470174..11dbffa65d 100644 --- a/phpBB/includes/avatar/driver/interface.php +++ b/phpBB/includes/avatar/driver/interface.php @@ -51,27 +51,51 @@ interface phpbb_avatar_driver_interface public function get_custom_html($row, $ignore_config = false, $alt = ''); /** - * @TODO + * Prepare form for changing the settings of this avatar + * + * @param object $template The template object + * @param array $row The user data or group data that has been cleaned with + * phpbb_avatar_manager::clean_row + * @param array &$error The reference to an error array + * + * @return bool Returns true if form has been successfully prepared **/ public function prepare_form($template, $row, &$error); /** - * @TODO + * Process form data + * + * @param object $template The template object + * @param array $row The user data or group data that has been cleaned with + * phpbb_avatar_manager::clean_row + * @param array &$error The reference to an error array + * + * @return array An array containing the avatar data as follows: + * ['avatar'], ['avatar_width'], ['avatar_height'] **/ public function process_form($template, $row, &$error); /** - * @TODO + * Delete avatar + * + * @param array $row The 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 **/ public function delete($row); /** - * @TODO + * Check if avatar is enabled + * + * @return bool True if avatar is enabled, false if it's disabled **/ public function is_enabled(); /** - * @TODO + * Get the avatars template name + * + * @return string The avatars template name **/ public function get_template_name(); } |