wikimedia/mediawiki-extensions-Echo
1
0
Fork 0
mirror of https://gerrit.wikimedia.org/r/mediawiki/extensions/Echo synced 2024-11-27 17:20:40 +00:00
Code Issues Packages Projects Releases Wiki Activity

Improve some parameter docs

Browse source 
Change DB_SLAVE in comments

Change-Id: Idd5787928b87f5af63864dc626cb603f281515d7
This commit is contained in:
Umherirrender 2017-10-14 15:45:13 +02:00
parent e135bb30ae
commit 546e3bdd55
5 changed files with 19 additions and 21 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

12
includes/NotifUser.php
View file

@ -169,7 +169,7 @@ class MWEchoNotifUser {
* Get message count for this user. * Get message count for this user.
* *
* @param bool $cached Set to false to bypass the cache. (Optional. Defaults to true) * @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 * @return int
*/ */
public function getMessageCount( $cached = true, $dbSource = DB_REPLICA ) { public function getMessageCount( $cached = true, $dbSource = DB_REPLICA ) {
@ -180,7 +180,7 @@ class MWEchoNotifUser {
* Get alert count for this user. * Get alert count for this user.
* *
* @param bool $cached Set to false to bypass the cache. (Optional. Defaults to true) * @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 * @return int
*/ */
public function getAlertCount( $cached = true, $dbSource = DB_REPLICA ) { public function getAlertCount( $cached = true, $dbSource = DB_REPLICA ) {
@ -198,7 +198,7 @@ class MWEchoNotifUser {
* If $wgEchoCrossWikiNotifications is disabled, the $global parameter is ignored. * If $wgEchoCrossWikiNotifications is disabled, the $global parameter is ignored.
* *
* @param bool $cached Set to false to bypass the cache. (Optional. Defaults to true) * @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 string $section Notification section
* @param bool|string $global Whether to include foreign notifications. If set to 'preference', uses the user's preference. * @param bool|string $global Whether to include foreign notifications. If set to 'preference', uses the user's preference.
* @return int * @return int
@ -247,7 +247,7 @@ class MWEchoNotifUser {
* Get the timestamp of the latest unread alert * Get the timestamp of the latest unread alert
* *
* @param bool $cached Set to false to bypass the cache. (Optional. Defaults to true) * @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. * @return bool|MWTimestamp Timestamp of latest unread alert, or false if there are no unread alerts.
*/ */
public function getLastUnreadAlertTime( $cached = true, $dbSource = DB_REPLICA ) { public function getLastUnreadAlertTime( $cached = true, $dbSource = DB_REPLICA ) {
@ -258,7 +258,7 @@ class MWEchoNotifUser {
* Get the timestamp of the latest unread message * Get the timestamp of the latest unread message
* *
* @param bool $cached Set to false to bypass the cache. (Optional. Defaults to true) * @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 * @return bool|MWTimestamp
*/ */
public function getLastUnreadMessageTime( $cached = true, $dbSource = DB_REPLICA ) { public function getLastUnreadMessageTime( $cached = true, $dbSource = DB_REPLICA ) {
@ -271,7 +271,7 @@ class MWEchoNotifUser {
* If $wgEchoCrossWikiNotifications is disabled, the $global parameter is ignored. * If $wgEchoCrossWikiNotifications is disabled, the $global parameter is ignored.
* *
* @param bool $cached Set to false to bypass the cache. (Optional. Defaults to true) * @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 string $section Notification section
* @param bool|string $global Whether to include foreign notifications. If set to 'preference', uses the user's preference. * @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. * @return bool|MWTimestamp Timestamp of latest unread message, or false if there are no unread messages.

18
includes/controller/NotificationController.php
View file

@ -49,15 +49,15 @@ class EchoNotificationController {
} }
/** /**
* Format the notification count as a string. This should only be used for an * 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. * 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 * If using it in sentence context, pass the value from getCappedNotificationCount
* into a message and use PLURAL. Example: notification-bundle-header-page-linked * into a message and use PLURAL. Example: notification-bundle-header-page-linked
* *
* @param int $count Notification count * @param int $count Notification count
* @return string Formatted count, after applying cap then formatting to string * @return string Formatted count, after applying cap then formatting to string
*/ */
public static function formatNotificationCount( $count ) { public static function formatNotificationCount( $count ) {
$cappedCount = self::getCappedNotificationCount( $count ); $cappedCount = self::getCappedNotificationCount( $count );

1
includes/mapper/AbstractMapper.php
View file

@ -61,6 +61,7 @@ abstract class EchoAbstractMapper {
/** /**
* Get the listener for a method * Get the listener for a method
* *
* @param string $method
* @return array * @return array
* @throws MWException * @throws MWException
*/ */

7
includes/ooui/LabelIconWidget.php
View file

@ -7,7 +7,6 @@ use OOUI\LabelElement;
use OOUI\TitledElement; use OOUI\TitledElement;
use OOUI\Tag; use OOUI\Tag;
use OOUI\Widget; use OOUI\Widget;
use OOUI\HtmlSnippet;
/** /**
* Widget combining a label and icon * Widget combining a label and icon
@ -19,9 +18,9 @@ class LabelIconWidget extends Widget {
/** /**
* @param array $config Configuration options * @param array $config Configuration options
* @param string|HtmlSnippet $config['label'] Label text * - string|HtmlSnippet $config['label'] Label text
* @param string $config['title'] Title text * - string $config['title'] Title text
* @param string $config['icon'] Icon key * - string $config['icon'] Icon key
*/ */
public function __construct( $config ) { public function __construct( $config ) {
parent::__construct( $config ); parent::__construct( $config );

2
phpcs.xml
View file

@ -5,8 +5,6 @@
<exclude name="Generic.Files.LineLength.TooLong" /> <exclude name="Generic.Files.LineLength.TooLong" />
<exclude name="MediaWiki.Commenting.FunctionComment.ExtraParamComment" /> <exclude name="MediaWiki.Commenting.FunctionComment.ExtraParamComment" />
<exclude name="MediaWiki.Commenting.FunctionComment.MissingParamComment" /> <exclude name="MediaWiki.Commenting.FunctionComment.MissingParamComment" />
<exclude name="MediaWiki.Commenting.FunctionComment.MissingParamName" />
<exclude name="MediaWiki.Commenting.FunctionComment.MissingParamTag" />
<exclude name="MediaWiki.Files.ClassMatchesFilename.NotMatch" /> <exclude name="MediaWiki.Files.ClassMatchesFilename.NotMatch" />
<exclude name="MediaWiki.Files.ClassMatchesFilename.WrongCase" /> <exclude name="MediaWiki.Files.ClassMatchesFilename.WrongCase" />
<exclude name="MediaWiki.Files.OneClassPerFile.MultipleFound" /> <exclude name="MediaWiki.Files.OneClassPerFile.MultipleFound" />