mirror/php-phpbb
1
0
Fork 0
mirror of https://github.com/phpbb/phpbb.git synced 2025-08-07 17:27:16 +02:00
Code Issues Releases Wiki Activity

[feature/avatars] Even more fixes to docblocks

Browse Source 
PHPBB3-10018
This commit is contained in:
Marc Alexander
2012-11-25 21:14:05 +01:00
parent 6522190ff1
commit f851d763f9
7 changed files with 65 additions and 61 deletions
Download Patch File Download Diff File Expand all files Collapse all files

38
phpBB/includes/avatar/driver/interface.php
View File

@@ -24,7 +24,7 @@ interface phpbb_avatar_driver_interface
/**
* Returns the name of the driver.
*
* @return string Name of wrapped driver.
* @return string Name of wrapped driver.
*/
public function get_name();
@@ -43,7 +43,7 @@ interface phpbb_avatar_driver_interface
* Returns custom html for displaying this avatar.
* Only called if $custom_html is true.
*
* @param $ignore_config Whether this function should respect the users prefs
* @param bool $ignore_config Whether this function should respect the users prefs
* and board configuration configuration option, or should just render
* the avatar anyways. Useful for the ACP.
* @return string HTML
@@ -53,56 +53,56 @@ interface phpbb_avatar_driver_interface
/**
* 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
* @param object $template Template object
* @param array $row User data or group data that has been cleaned with
* phpbb_avatar_manager::clean_row
* @param array &$error The reference to an error array
* @param array &$error Reference to an error array
*
* @return bool Returns true if form has been successfully prepared
**/
* @return bool True if form has been successfully prepared
*/
public function prepare_form($template, $row, &$error);
/**
* Prepare form for changing the acp settings of this avatar
*
* @return array Return the array containing the acp settings
**/
* @return array Array containing the acp settings
*/
public function prepare_form_acp();
/**
* Process form data
*
* @param object $template The template object
* @param array $row The user data or group data that has been cleaned with
* @param object $template Template object
* @param array $row User data or group data that has been cleaned with
* phpbb_avatar_manager::clean_row
* @param array &$error The reference to an error array
* @param array &$error Reference to an error array
*
* @return array An array containing the avatar data as follows:
* @return array Array containing the avatar data as follows:
* ['avatar'], ['avatar_width'], ['avatar_height']
**/
*/
public function process_form($template, $row, &$error);
/**
* Delete avatar
*
* @param array $row The user data or group data that has been cleaned with
* @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
**/
*/
public function delete($row);
/**
* Check if avatar is enabled
*
* @return bool True if avatar is enabled, false if it's disabled
**/
*/
public function is_enabled();
/**
* Get the avatars template name
*
* @return string The avatars template name
**/
* @return string Avatar's template name
*/
public function get_template_name();
}