[ticket/12715] Cleanup comments in \phpbb\avatar\driver\*

PHPBB3-12715
This commit is contained in:
Tristan Darricau 2014-06-14 21:33:26 +02:00
parent d7b9e33b94
commit 569ebd1592
5 changed files with 27 additions and 26 deletions

View file

@ -73,10 +73,9 @@ abstract class driver implements \phpbb\avatar\driver\driver_interface
* Construct a driver object * Construct a driver object
* *
* @param \phpbb\config\config $config phpBB configuration * @param \phpbb\config\config $config phpBB configuration
* @param \phpbb\request\request $request Request object
* @param string $phpbb_root_path Path to the phpBB root * @param string $phpbb_root_path Path to the phpBB root
* @param string $php_ext PHP file extension * @param string $php_ext PHP file extension
* @param \phpbb_path_helper $path_helper phpBB path helper * @param \phpbb\path_helper $path_helper phpBB path helper
* @param \phpbb\cache\driver\driver_interface $cache Cache driver * @param \phpbb\cache\driver\driver_interface $cache Cache driver
*/ */
public function __construct(\phpbb\config\config $config, $phpbb_root_path, $php_ext, \phpbb\path_helper $path_helper, \phpbb\cache\driver\driver_interface $cache = null) public function __construct(\phpbb\config\config $config, $phpbb_root_path, $php_ext, \phpbb\path_helper $path_helper, \phpbb\cache\driver\driver_interface $cache = null)
@ -89,7 +88,7 @@ abstract class driver implements \phpbb\avatar\driver\driver_interface
} }
/** /**
* @inheritdoc * {@inheritdoc}
*/ */
public function get_custom_html($user, $row, $alt = '') public function get_custom_html($user, $row, $alt = '')
{ {
@ -97,7 +96,7 @@ abstract class driver implements \phpbb\avatar\driver\driver_interface
} }
/** /**
* @inheritdoc * {@inheritdoc}
*/ */
public function prepare_form_acp($user) public function prepare_form_acp($user)
{ {
@ -105,7 +104,7 @@ abstract class driver implements \phpbb\avatar\driver\driver_interface
} }
/** /**
* @inheritdoc * {@inheritdoc}
*/ */
public function delete($row) public function delete($row)
{ {
@ -113,7 +112,7 @@ abstract class driver implements \phpbb\avatar\driver\driver_interface
} }
/** /**
* @inheritdoc * {@inheritdoc}
*/ */
public function get_name() public function get_name()
{ {

View file

@ -24,7 +24,7 @@ class gravatar extends \phpbb\avatar\driver\driver
const GRAVATAR_URL = '//secure.gravatar.com/avatar/'; const GRAVATAR_URL = '//secure.gravatar.com/avatar/';
/** /**
* @inheritdoc * {@inheritdoc}
*/ */
public function get_data($row) public function get_data($row)
{ {
@ -36,7 +36,7 @@ class gravatar extends \phpbb\avatar\driver\driver
} }
/** /**
* @inheritdoc * {@inheritdoc}
*/ */
public function get_custom_html($user, $row, $alt = '') public function get_custom_html($user, $row, $alt = '')
{ {
@ -47,7 +47,7 @@ class gravatar extends \phpbb\avatar\driver\driver
} }
/** /**
* @inheritdoc * {@inheritdoc}
*/ */
public function prepare_form($request, $template, $user, $row, &$error) public function prepare_form($request, $template, $user, $row, &$error)
{ {
@ -61,7 +61,7 @@ class gravatar extends \phpbb\avatar\driver\driver
} }
/** /**
* @inheritdoc * {@inheritdoc}
*/ */
public function process_form($request, $template, $user, $row, &$error) public function process_form($request, $template, $user, $row, &$error)
{ {
@ -151,7 +151,7 @@ class gravatar extends \phpbb\avatar\driver\driver
} }
/** /**
* @inheritdoc * {@inheritdoc}
*/ */
public function get_template_name() public function get_template_name()
{ {
@ -161,6 +161,8 @@ class gravatar extends \phpbb\avatar\driver\driver
/** /**
* Build gravatar URL for output on page * Build gravatar URL for output on page
* *
* @param array $row User data or group data that has been cleaned with
* \phpbb\avatar\manager::clean_row
* @return string Gravatar URL * @return string Gravatar URL
*/ */
protected function get_gravatar_url($row) protected function get_gravatar_url($row)

View file

@ -19,7 +19,7 @@ namespace phpbb\avatar\driver;
class local extends \phpbb\avatar\driver\driver class local extends \phpbb\avatar\driver\driver
{ {
/** /**
* @inheritdoc * {@inheritdoc}
*/ */
public function get_data($row) public function get_data($row)
{ {
@ -31,7 +31,7 @@ class local extends \phpbb\avatar\driver\driver
} }
/** /**
* @inheritdoc * {@inheritdoc}
*/ */
public function prepare_form($request, $template, $user, $row, &$error) public function prepare_form($request, $template, $user, $row, &$error)
{ {
@ -99,7 +99,7 @@ class local extends \phpbb\avatar\driver\driver
} }
/** /**
* @inheritdoc * {@inheritdoc}
*/ */
public function prepare_form_acp($user) public function prepare_form_acp($user)
{ {
@ -109,7 +109,7 @@ class local extends \phpbb\avatar\driver\driver
} }
/** /**
* @inheritdoc * {@inheritdoc}
*/ */
public function process_form($request, $template, $user, $row, &$error) public function process_form($request, $template, $user, $row, &$error)
{ {
@ -138,7 +138,7 @@ class local extends \phpbb\avatar\driver\driver
} }
/** /**
* @inheritdoc * {@inheritdoc}
*/ */
public function get_template_name() public function get_template_name()
{ {

View file

@ -19,7 +19,7 @@ namespace phpbb\avatar\driver;
class remote extends \phpbb\avatar\driver\driver class remote extends \phpbb\avatar\driver\driver
{ {
/** /**
* @inheritdoc * {@inheritdoc}
*/ */
public function get_data($row) public function get_data($row)
{ {
@ -31,7 +31,7 @@ class remote extends \phpbb\avatar\driver\driver
} }
/** /**
* @inheritdoc * {@inheritdoc}
*/ */
public function prepare_form($request, $template, $user, $row, &$error) public function prepare_form($request, $template, $user, $row, &$error)
{ {
@ -45,7 +45,7 @@ class remote extends \phpbb\avatar\driver\driver
} }
/** /**
* @inheritdoc * {@inheritdoc}
*/ */
public function process_form($request, $template, $user, $row, &$error) public function process_form($request, $template, $user, $row, &$error)
{ {
@ -191,7 +191,7 @@ class remote extends \phpbb\avatar\driver\driver
} }
/** /**
* @inheritdoc * {@inheritdoc}
*/ */
public function get_template_name() public function get_template_name()
{ {

View file

@ -19,7 +19,7 @@ namespace phpbb\avatar\driver;
class upload extends \phpbb\avatar\driver\driver class upload extends \phpbb\avatar\driver\driver
{ {
/** /**
* @inheritdoc * {@inheritdoc}
*/ */
public function get_data($row, $ignore_config = false) public function get_data($row, $ignore_config = false)
{ {
@ -31,7 +31,7 @@ class upload extends \phpbb\avatar\driver\driver
} }
/** /**
* @inheritdoc * {@inheritdoc}
*/ */
public function prepare_form($request, $template, $user, $row, &$error) public function prepare_form($request, $template, $user, $row, &$error)
{ {
@ -49,7 +49,7 @@ class upload extends \phpbb\avatar\driver\driver
} }
/** /**
* @inheritdoc * {@inheritdoc}
*/ */
public function process_form($request, $template, $user, $row, &$error) public function process_form($request, $template, $user, $row, &$error)
{ {
@ -143,7 +143,7 @@ class upload extends \phpbb\avatar\driver\driver
} }
/** /**
* @inheritdoc * {@inheritdoc}
*/ */
public function prepare_form_acp($user) public function prepare_form_acp($user)
{ {
@ -155,7 +155,7 @@ class upload extends \phpbb\avatar\driver\driver
} }
/** /**
* @inheritdoc * {@inheritdoc}
*/ */
public function delete($row) public function delete($row)
{ {
@ -171,7 +171,7 @@ class upload extends \phpbb\avatar\driver\driver
} }
/** /**
* @inheritdoc * {@inheritdoc}
*/ */
public function get_template_name() public function get_template_name()
{ {