From 546e3bdd552bc1012b4b0190bf8e42f0583159cf Mon Sep 17 00:00:00 2001 From: Umherirrender Date: Sat, 14 Oct 2017 15:45:13 +0200 Subject: [PATCH] Improve some parameter docs Change DB_SLAVE in comments Change-Id: Idd5787928b87f5af63864dc626cb603f281515d7 --- includes/NotifUser.php | 12 ++++++------ includes/controller/NotificationController.php | 18 +++++++++--------- includes/mapper/AbstractMapper.php | 1 + includes/ooui/LabelIconWidget.php | 7 +++---- phpcs.xml | 2 -- 5 files changed, 19 insertions(+), 21 deletions(-) diff --git a/includes/NotifUser.php b/includes/NotifUser.php index 129b97d9b..563ebfaf0 100644 --- a/includes/NotifUser.php +++ b/includes/NotifUser.php @@ -169,7 +169,7 @@ class MWEchoNotifUser { * Get message count for this user. * * @param bool $cached Set to false to bypass the cache. (Optional. Defaults to true) - * @param int $dbSource Use master or slave database to pull count (Optional. Defaults to DB_SLAVE) + * @param int $dbSource Use master or slave database to pull count (Optional. Defaults to DB_REPLICA) * @return int */ public function getMessageCount( $cached = true, $dbSource = DB_REPLICA ) { @@ -180,7 +180,7 @@ class MWEchoNotifUser { * Get alert count for this user. * * @param bool $cached Set to false to bypass the cache. (Optional. Defaults to true) - * @param int $dbSource Use master or slave database to pull count (Optional. Defaults to DB_SLAVE) + * @param int $dbSource Use master or slave database to pull count (Optional. Defaults to DB_REPLICA) * @return int */ public function getAlertCount( $cached = true, $dbSource = DB_REPLICA ) { @@ -198,7 +198,7 @@ class MWEchoNotifUser { * If $wgEchoCrossWikiNotifications is disabled, the $global parameter is ignored. * * @param bool $cached Set to false to bypass the cache. (Optional. Defaults to true) - * @param int $dbSource Use master or slave database to pull count (Optional. Defaults to DB_SLAVE) + * @param int $dbSource Use master or slave database to pull count (Optional. Defaults to DB_REPLICA) * @param string $section Notification section * @param bool|string $global Whether to include foreign notifications. If set to 'preference', uses the user's preference. * @return int @@ -247,7 +247,7 @@ class MWEchoNotifUser { * Get the timestamp of the latest unread alert * * @param bool $cached Set to false to bypass the cache. (Optional. Defaults to true) - * @param int $dbSource Use master or slave database to pull count (Optional. Defaults to DB_SLAVE) + * @param int $dbSource Use master or slave database to pull count (Optional. Defaults to DB_REPLICA) * @return bool|MWTimestamp Timestamp of latest unread alert, or false if there are no unread alerts. */ public function getLastUnreadAlertTime( $cached = true, $dbSource = DB_REPLICA ) { @@ -258,7 +258,7 @@ class MWEchoNotifUser { * Get the timestamp of the latest unread message * * @param bool $cached Set to false to bypass the cache. (Optional. Defaults to true) - * @param int $dbSource Use master or slave database to pull count (Optional. Defaults to DB_SLAVE) + * @param int $dbSource Use master or slave database to pull count (Optional. Defaults to DB_REPLICA) * @return bool|MWTimestamp */ public function getLastUnreadMessageTime( $cached = true, $dbSource = DB_REPLICA ) { @@ -271,7 +271,7 @@ class MWEchoNotifUser { * If $wgEchoCrossWikiNotifications is disabled, the $global parameter is ignored. * * @param bool $cached Set to false to bypass the cache. (Optional. Defaults to true) - * @param int $dbSource Use master or slave database to pull count (Optional. Defaults to DB_SLAVE) + * @param int $dbSource Use master or slave database to pull count (Optional. Defaults to DB_REPLICA) * @param string $section Notification section * @param bool|string $global Whether to include foreign notifications. If set to 'preference', uses the user's preference. * @return bool|MWTimestamp Timestamp of latest unread message, or false if there are no unread messages. diff --git a/includes/controller/NotificationController.php b/includes/controller/NotificationController.php index ca142d26d..670a25cb0 100644 --- a/includes/controller/NotificationController.php +++ b/includes/controller/NotificationController.php @@ -49,15 +49,15 @@ class EchoNotificationController { } /** - * Format the notification count as a string. This should only be used for an - * isolated string count, e.g. as displayed in personal tools or returned by the API. - * - * If using it in sentence context, pass the value from getCappedNotificationCount - * into a message and use PLURAL. Example: notification-bundle-header-page-linked - * - * @param int $count Notification count - * @return string Formatted count, after applying cap then formatting to string - */ + * Format the notification count as a string. This should only be used for an + * isolated string count, e.g. as displayed in personal tools or returned by the API. + * + * If using it in sentence context, pass the value from getCappedNotificationCount + * into a message and use PLURAL. Example: notification-bundle-header-page-linked + * + * @param int $count Notification count + * @return string Formatted count, after applying cap then formatting to string + */ public static function formatNotificationCount( $count ) { $cappedCount = self::getCappedNotificationCount( $count ); diff --git a/includes/mapper/AbstractMapper.php b/includes/mapper/AbstractMapper.php index d9603e0d1..b5a9d227c 100644 --- a/includes/mapper/AbstractMapper.php +++ b/includes/mapper/AbstractMapper.php @@ -61,6 +61,7 @@ abstract class EchoAbstractMapper { /** * Get the listener for a method * + * @param string $method * @return array * @throws MWException */ diff --git a/includes/ooui/LabelIconWidget.php b/includes/ooui/LabelIconWidget.php index a430fed39..6cceec2d3 100644 --- a/includes/ooui/LabelIconWidget.php +++ b/includes/ooui/LabelIconWidget.php @@ -7,7 +7,6 @@ use OOUI\LabelElement; use OOUI\TitledElement; use OOUI\Tag; use OOUI\Widget; -use OOUI\HtmlSnippet; /** * Widget combining a label and icon @@ -19,9 +18,9 @@ class LabelIconWidget extends Widget { /** * @param array $config Configuration options - * @param string|HtmlSnippet $config['label'] Label text - * @param string $config['title'] Title text - * @param string $config['icon'] Icon key + * - string|HtmlSnippet $config['label'] Label text + * - string $config['title'] Title text + * - string $config['icon'] Icon key */ public function __construct( $config ) { parent::__construct( $config ); diff --git a/phpcs.xml b/phpcs.xml index 6b290479e..6bf4fd643 100644 --- a/phpcs.xml +++ b/phpcs.xml @@ -5,8 +5,6 @@ - -