wikimedia/mediawiki-extensions-LoginNotify
1
0
Fork 0
mirror of https://gerrit.wikimedia.org/r/mediawiki/extensions/LoginNotify synced 2024-11-30 17:54:24 +00:00
Code Issues Packages Projects Releases Wiki Activity

Add missing @var and improve documentation

Browse source 
Change-Id: Iee58d1ac85939290c341568ebb10dc757e664425
This commit is contained in:
Umherirrender 2020-12-17 20:55:01 +01:00
parent 14f35b2324
commit 674c24f807
3 changed files with 4 additions and 6 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

5
.phpcs.xml
View file

@ -1,9 +1,6 @@
<?xml version="1.0"?> <?xml version="1.0"?>
<ruleset> <ruleset>
<rule ref="./vendor/mediawiki/mediawiki-codesniffer/MediaWiki"> <rule ref="./vendor/mediawiki/mediawiki-codesniffer/MediaWiki" />
<exclude name="MediaWiki.Commenting.FunctionComment.ObjectTypeHintParam" />
<exclude name="MediaWiki.Commenting.PropertyDocumentation.MissingDocumentationPrivate" />
</rule>
<file>.</file> <file>.</file>
<arg name="extensions" value="php" /> <arg name="extensions" value="php" />
<arg name="encoding" value="UTF-8" /> <arg name="encoding" value="UTF-8" />

2
includes/LoginNotify.php
View file

@ -732,7 +732,7 @@ class LoginNotify implements LoggerAwareInterface {
* @param string $key cache key * @param string $key cache key
* @param int $interval The interval of one to send notice * @param int $interval The interval of one to send notice
* @param int $expiry When to expire cache key. * @param int $expiry When to expire cache key.
* @return bool|int false to not send notice, or number of hits * @return false|int false to not send notice, or number of hits
*/ */
private function checkAndIncKey( $key, $interval, $expiry ) { private function checkAndIncKey( $key, $interval, $expiry ) {
$cache = $this->cache; $cache = $this->cache;

3
maintenance/migratePreferences.php
View file

@ -24,6 +24,7 @@ class MigratePreferences extends LoggedUpdateMaintenance {
private const OPTIONS_FAKE_TRUTH = 2; private const OPTIONS_FAKE_TRUTH = 2;
private const OPTIONS_FAKE_FALSE = 'fake-false'; private const OPTIONS_FAKE_FALSE = 'fake-false';
/** @var bool[] */
private static $mapping = [ private static $mapping = [
self::OPTIONS_FAKE_FALSE => false, self::OPTIONS_FAKE_FALSE => false,
self::OPTIONS_FAKE_TRUTH => true, self::OPTIONS_FAKE_TRUTH => true,
@ -100,7 +101,7 @@ class MigratePreferences extends LoggedUpdateMaintenance {
/** /**
* Update one user's preferences * Update one user's preferences
* *
* @param object $userRow Row from the user table * @param \stdClass $userRow Row from the user table
* @param array &$options Associative array of preference => value * @param array &$options Associative array of preference => value
* @return int Number of options updated * @return int Number of options updated
*/ */