Umherirrender has uploaded a new change for review. (
https://gerrit.wikimedia.org/r/381757 )
Change subject: Updated type and function docs for MagicWord.php
......................................................................
Updated type and function docs for MagicWord.php
Change-Id: I46ebd315a99b1677ff89ba392c0072b41bbeb36d
---
M includes/MagicWord.php
1 file changed, 31 insertions(+), 12 deletions(-)
git pull ssh://gerrit.wikimedia.org:29418/mediawiki/core
refs/changes/57/381757/1
diff --git a/includes/MagicWord.php b/includes/MagicWord.php
index 6e7799a..93c8a71 100644
--- a/includes/MagicWord.php
+++ b/includes/MagicWord.php
@@ -59,10 +59,10 @@
class MagicWord {
/**#@-*/
- /** @var int */
+ /** @var string */
public $mId;
- /** @var array */
+ /** @var string[] */
public $mSynonyms;
/** @var bool */
@@ -92,7 +92,10 @@
/** @var bool */
private $mFound = false;
+ /** @var bool */
public static $mVariableIDsInitialised = false;
+
+ /** @var string[] */
public static $mVariableIDs = [
'!',
'currentmonth',
@@ -174,7 +177,9 @@
'cascadingsources',
];
- /* Array of caching hints for ParserCache */
+ /** Array of caching hints for ParserCache
+ * @var array [ string => int ]
+ */
public static $mCacheTTLs = [
'currentmonth' => 86400,
'currentmonth1' => 86400,
@@ -216,6 +221,7 @@
'numberingroup' => 3600,
];
+ /** @var string[] */
public static $mDoubleUnderscoreIDs = [
'notoc',
'nogallery',
@@ -232,17 +238,30 @@
'nocontentconvert',
];
+ /** @var string[] */
public static $mSubstIDs = [
'subst',
'safesubst',
];
+ /** @var array [ string => MagicWord ] */
public static $mObjects = [];
+
+ /** @var MagicWordArray */
public static $mDoubleUnderscoreArray = null;
/**#@-*/
- public function __construct( $id = 0, $syn = [], $cs = false ) {
+ /**
+ * Create a new MagicWord object
+ *
+ * Use factory instead: MagicWord::get
+ *
+ * @param string $id The internal name of the magic word
+ * @param string[]|string $syn synonyms for the magic word
+ * @param bool $cs If magic word is case sensitive
+ */
+ public function __construct( $id = null, $syn = [], $cs = false ) {
$this->mId = $id;
$this->mSynonyms = (array)$syn;
$this->mCaseSensitive = $cs;
@@ -251,7 +270,7 @@
/**
* Factory: creates an object representing an ID
*
- * @param int $id
+ * @param string $id The internal name of the magic word
*
* @return MagicWord
*/
@@ -267,7 +286,7 @@
/**
* Get an array of parser variable IDs
*
- * @return array
+ * @return string[]
*/
public static function getVariableIDs() {
if ( !self::$mVariableIDsInitialised ) {
@@ -280,7 +299,7 @@
/**
* Get an array of parser substitution modifier IDs
- * @return array
+ * @return string[]
*/
public static function getSubstIDs() {
return self::$mSubstIDs;
@@ -289,7 +308,7 @@
/**
* Allow external reads of TTL array
*
- * @param int $id
+ * @param string $id
* @return int
*/
public static function getCacheTTL( $id ) {
@@ -324,7 +343,7 @@
/**
* Initialises this object with an ID
*
- * @param int $id
+ * @param string $id
* @throws MWException
*/
public function load( $id ) {
@@ -630,7 +649,7 @@
}
/**
- * @return array
+ * @return string[]
*/
public function getSynonyms() {
return $this->mSynonyms;
@@ -650,7 +669,7 @@
* Adds all the synonyms of this MagicWord to an array, to allow quick
* lookup in a list of magic words
*
- * @param array &$array
+ * @param string[] &$array
* @param string $value
*/
public function addToArray( &$array, $value ) {
@@ -668,7 +687,7 @@
}
/**
- * @return int
+ * @return string
*/
public function getId() {
return $this->mId;
--
To view, visit https://gerrit.wikimedia.org/r/381757
To unsubscribe, visit https://gerrit.wikimedia.org/r/settings
Gerrit-MessageType: newchange
Gerrit-Change-Id: I46ebd315a99b1677ff89ba392c0072b41bbeb36d
Gerrit-PatchSet: 1
Gerrit-Project: mediawiki/core
Gerrit-Branch: master
Gerrit-Owner: Umherirrender <[email protected]>
_______________________________________________
MediaWiki-commits mailing list
[email protected]
https://lists.wikimedia.org/mailman/listinfo/mediawiki-commits
