<?php
/**
* File for magic words
- * @addtogroup Parser
+ * See docs/magicword.txt
+ *
+ * @file
+ * @ingroup Parser
*/
/**
* Please avoid reading the data out of one of these objects and then writing
* special case code. If possible, add another match()-like function here.
*
- * To add magic words in an extension, use the LanguageGetMagic hook. For
+ * To add magic words in an extension, use the LanguageGetMagic hook. For
* magic words which are also Parser variables, add a MagicWordwgVariableIDs
* hook. Use string keys.
*
+ * @ingroup Parser
*/
class MagicWord {
/**#@+
'pagesinnamespace',
'numberofadmins',
'defaultsort',
+ 'pagesincategory',
);
-
+
/* Array of caching hints for ParserCache */
static public $mCacheTTLs = array (
'currentmonth' => 86400,
}
return self::$mVariableIDs;
}
-
+
/* Allow external reads of TTL array */
static function getCacheTTL($id) {
if (array_key_exists($id,self::$mCacheTTLs)) {
}
return self::$mDoubleUnderscoreArray;
}
-
+
# Initialises this object with an ID
function load( $id ) {
global $wgContLang;
# This was used for matching "$1" variables, but different uses of the feature will have
# different restrictions, which should be checked *after* the MagicWord has been matched,
# not here. - IMSoP
-
+
$escSyn = array();
foreach ( $this->mSynonyms as $synonym )
// In case a magic word contains /, like that's going to happen;)
$escSyn[] = preg_quote( $synonym, '/' );
$this->mBaseRegex = implode( '|', $escSyn );
-
+
$case = $this->mCaseSensitive ? '' : 'iu';
$this->mRegex = "/{$this->mBaseRegex}/{$case}";
$this->mRegexStart = "/^(?:{$this->mBaseRegex})/{$case}";
/**
* Class for handling an array of magic words
+ * @ingroup Parser
*/
class MagicWordArray {
var $names = array();
/**
* Match some text, with parameter capture
- * Returns an array with the magic word name in the first element and the
+ * Returns an array with the magic word name in the first element and the
* parameter in the second element.
* Both elements are false if there was no match.
*/