Skip to content

Commit b021d6c

Browse files
committed
Docblock tweaks
Signed-off-by: Matt Friedman <maf675@gmail.com>
1 parent 37521ba commit b021d6c

1 file changed

Lines changed: 9 additions & 7 deletions

File tree

notification/method/webpush.php

Lines changed: 9 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -59,13 +59,14 @@ class webpush extends messenger_base implements extended_method_interface
5959
* @param log_interface $log
6060
* @param user_loader $user_loader
6161
* @param user $user
62+
* @param path_helper $path_helper
6263
* @param string $phpbb_root_path
6364
* @param string $php_ext
6465
* @param string $notification_webpush_table
6566
* @param string $push_subscriptions_table
6667
*/
67-
public function __construct(config $config, driver_interface $db, log_interface $log, user_loader $user_loader, user $user, path_helper $path_helper, string $phpbb_root_path,
68-
string $php_ext, string $notification_webpush_table, string $push_subscriptions_table)
68+
public function __construct(config $config, driver_interface $db, log_interface $log, user_loader $user_loader, user $user, path_helper $path_helper,
69+
string $phpbb_root_path, string $php_ext, string $notification_webpush_table, string $push_subscriptions_table)
6970
{
7071
parent::__construct($user_loader, $phpbb_root_path, $php_ext);
7172

@@ -435,13 +436,12 @@ protected function clean_expired_subscriptions(array $user_subscription_map, arr
435436
}
436437

437438
/**
438-
* Takes an avatar string (usually they are in full html format already) and
439-
* extracts the image src tag url code. Then, if the avatar string is a relative
440-
* path, it's converted to absolute path.
439+
* Takes an avatar string (usually in full html format already) and extracts the url.
440+
* If the avatar url is a relative path, it's converted to an absolute path.
441441
*
442442
* Converts:
443-
* <img class="avatar" src="./path/to/avatar=123456789.gif" width="123" height="123" alt="User avatar" />
444-
* or <img class="avatar" src="./styles/prosilver/theme/images/no_avatar.gif" data-src="./path/to/avatar=123456789.gif" width="123" height="123" alt="User avatar" />
443+
* <img class="avatar" src="./path/to/avatar=123456789.gif" width="123" height="123" alt="User avatar" />
444+
* or <img class="avatar" src="./styles/prosilver/theme/images/no_avatar.gif" data-src="./path/to/avatar=123456789.gif" width="123" height="123" alt="User avatar" />
445445
* into https://myboard.url/path/to/avatar=123456789.gif
446446
*
447447
* @param string $avatar
@@ -460,6 +460,8 @@ protected function prepare_avatar($avatar)
460460

461461
/**
462462
* Returns the board url (and caches it in the function)
463+
*
464+
* @return string the generated board url
463465
*/
464466
protected function get_board_url()
465467
{

0 commit comments

Comments
 (0)