*/
class CoreParserFunctions {
/**
- * @param $parser Parser
+ * @param Parser $parser
* @return void
*/
static function register( $parser ) {
$parser->setFunctionHook( 'displaytitle', array( __CLASS__, 'displaytitle' ), SFH_NO_HASH );
}
if ( $wgAllowSlowParserFunctions ) {
- $parser->setFunctionHook( 'pagesinnamespace', array( __CLASS__, 'pagesinnamespace' ), SFH_NO_HASH );
+ $parser->setFunctionHook(
+ 'pagesinnamespace',
+ array( __CLASS__, 'pagesinnamespace' ),
+ SFH_NO_HASH
+ );
}
}
/**
- * @param $parser Parser
+ * @param Parser $parser
* @param string $part1
* @return array
*/
static function intFunction( $parser, $part1 = '' /*, ... */ ) {
if ( strval( $part1 ) !== '' ) {
$args = array_slice( func_get_args(), 2 );
- $message = wfMessage( $part1, $args )->inLanguage( $parser->getOptions()->getUserLangObj() )->plain();
+ $message = wfMessage( $part1, $args )
+ ->inLanguage( $parser->getOptions()->getUserLangObj() )->plain();
+
return array( $message, 'noparse' => false );
} else {
return array( 'found' => false );
* Or to encode a value for the HTTP "path", spaces are encoded as '%20'.
* For links to "wiki"s, or similar software, spaces are encoded as '_',
*
- * @param $parser Parser object
+ * @param Parser $parser
* @param string $s The text to encode.
* @param string $arg (optional): The type of encoding.
* @return string
}
/**
- * @param $parser Parser
+ * @param Parser $parser
* @param string $s
- * @return
+ * @return string
*/
static function lc( $parser, $s = '' ) {
global $wgContLang;
}
/**
- * @param $parser Parser
+ * @param Parser $parser
* @param string $s
- * @return
+ * @return string
*/
static function uc( $parser, $s = '' ) {
global $wgContLang;
}
/**
- * @param $parser Parser
+ * @param Parser $parser
* @param string $num
* @param string $arg
* @return string
}
/**
- * @param $parser Parser
+ * @param Parser $parser
* @param string $case
* @param string $word
- * @return
+ * @return string
*/
static function grammar( $parser, $case = '', $word = '' ) {
$word = $parser->killMarkers( $word );
}
/**
- * @param $parser Parser
- * @param $username string
- * @return
+ * @param Parser $parser
+ * @param string $username
+ * @return string
*/
static function gender( $parser, $username ) {
wfProfileIn( __METHOD__ );
}
/**
- * @param $parser Parser
+ * @param Parser $parser
* @param string $text
- * @return
+ * @return string
*/
static function plural( $parser, $text = '' ) {
$forms = array_slice( func_get_args(), 2 );
* Override the title of the page when viewed, provided we've been given a
* title which will normalise to the canonical title
*
- * @param $parser Parser: parent parser
- * @param string $text desired title text
- * @return String
+ * @param Parser $parser Parent parser
+ * @param string $text Desired title text
+ * @return string
*/
static function displaytitle( $parser, $text = '' ) {
global $wgRestrictDisplayTitle;
// only requested titles that normalize to the actual title are allowed through
// if $wgRestrictDisplayTitle is true (it is by default)
// mimic the escaping process that occurs in OutputPage::setPageTitle
- $text = Sanitizer::normalizeCharReferences( Sanitizer::removeHTMLtags( $text, $htmlTagsCallback, array(), array(), $bad ) );
+ $text = Sanitizer::normalizeCharReferences( Sanitizer::removeHTMLtags(
+ $text,
+ $htmlTagsCallback,
+ array(),
+ array(),
+ $bad
+ ) );
$title = Title::newFromText( Sanitizer::stripAllTags( $text ) );
if ( !$wgRestrictDisplayTitle ) {
$parser->mOutput->setDisplayTitle( $text );
- } elseif ( $title instanceof Title && !$title->hasFragment() && $title->equals( $parser->mTitle ) ) {
+ } elseif ( $title instanceof Title
+ && !$title->hasFragment()
+ && $title->equals( $parser->mTitle )
+ ) {
$parser->mOutput->setDisplayTitle( $text );
}
/**
* Matches the given value against the value of given magic word
*
- * @param string $magicword magic word key
- * @param mixed $value value to match
- * @return boolean true on successful match
+ * @param string $magicword Magic word key
+ * @param string $value Value to match
+ * @return bool True on successful match
*/
private static function matchAgainstMagicword( $magicword, $value ) {
$value = trim( strval( $value ) );
* corresponding magic word
* Note: function name changed to "mwnamespace" rather than "namespace"
* to not break PHP 5.3
+ * @param Parser $parser
+ * @param string $title
* @return mixed|string
*/
static function mwnamespace( $parser, $title = null ) {
/**
* Functions to get and normalize pagenames, corresponding to the magic words
* of the same names
- * @return String
+ * @param Parser $parser
+ * @param string $title
+ * @return string
*/
static function pagename( $parser, $title = null ) {
$t = Title::newFromText( $title );
* Return the number of pages, files or subcats in the given category,
* or 0 if it's nonexistent. This is an expensive parser function and
* can't be called too many times per page.
+ * @param Parser $parser
+ * @param string $name
+ * @param string $arg1
+ * @param string $arg2
* @return string
*/
static function pagesincategory( $parser, $name = '', $arg1 = null, $arg2 = null ) {
* Return the size of the given page, or 0 if it's nonexistent. This is an
* expensive parser function and can't be called too many times per page.
*
- * @param $parser Parser
- * @param $page String Name of page to check (Default: empty string)
- * @param $raw String Should number be human readable with commas or just number
+ * @param Parser $parser
+ * @param string $page Name of page to check (Default: empty string)
+ * @param string $raw Should number be human readable with commas or just number
* @return string
*/
static function pagesize( $parser, $page = '', $raw = null ) {
/**
* Gives language names.
- * @param $parser Parser
- * @param string $code Language code (of which to get name)
- * @param string $inLanguage Language code (in which to get name)
- * @return String
+ * @param Parser $parser
+ * @param string $code Language code (of which to get name)
+ * @param string $inLanguage Language code (in which to get name)
+ * @return string
*/
static function language( $parser, $code = '', $inLanguage = '' ) {
$code = strtolower( $code );
/**
* Unicode-safe str_pad with the restriction that $length is forced to be <= 500
+ * @param Parser $parser
+ * @param string $string
+ * @param int $length
+ * @param string $padding
+ * @param int $direction
* @return string
*/
static function pad( $parser, $string, $length, $padding = '0', $direction = STR_PAD_RIGHT ) {
}
/**
- * @param $parser Parser
- * @param $text
+ * @param Parser $parser
+ * @param string $text
* @return string
*/
static function anchorencode( $parser, $text ) {
}
/**
- * @param $parser Parser
+ * @param Parser $parser
* @param string $text The sortkey to use
* @param string $uarg Either "noreplace" or "noerror" (in en)
* both suppress errors, and noreplace does nothing if
}
}
- // Usage {{filepath|300}}, {{filepath|nowiki}}, {{filepath|nowiki|300}} or {{filepath|300|nowiki}}
- // or {{filepath|300px}}, {{filepath|200x300px}}, {{filepath|nowiki|200x300px}}, {{filepath|200x300px|nowiki}}
+ // Usage {{filepath|300}}, {{filepath|nowiki}}, {{filepath|nowiki|300}}
+ // or {{filepath|300|nowiki}} or {{filepath|300px}}, {{filepath|200x300px}},
+ // {{filepath|nowiki|200x300px}}, {{filepath|200x300px|nowiki}}.
public static function filepath( $parser, $name = '', $argA = '', $argB = '' ) {
$file = wfFindFile( $name );
/**
* Parser function to extension tag adaptor
+ * @param Parser $parser
+ * @param PPFrame $frame
+ * @param array $args
* @return string
*/
public static function tagObj( $parser, $frame, $args ) {
* For a given title, which is equal to the current parser title,
* the revision object from the parser is used, when that is the current one
*
- * @param $parser Parser
- * @param $title Title
+ * @param Parser $parser
+ * @param Title $title
* @return Revision
* @since 1.23
*/
/**
* Get the pageid of a specified page
- * @param $parser Parser
- * @param $title string Title to get the pageid from
+ * @param Parser $parser
+ * @param string $title Title to get the pageid from
+ * @return int|null|string
* @since 1.23
*/
public static function pageid( $parser, $title = null ) {
/**
* Get the id from the last revision of a specified page.
- * @param $parser Parser
- * @param $title string Title to get the id from
+ * @param Parser $parser
+ * @param string $title Title to get the id from
+ * @return int|null|string
* @since 1.23
*/
public static function revisionid( $parser, $title = null ) {
/**
* Get the day from the last revision of a specified page.
- * @param $parser Parser
- * @param $title string Title to get the day from
+ * @param Parser $parser
+ * @param string $title Title to get the day from
+ * @return string
* @since 1.23
*/
public static function revisionday( $parser, $title = null ) {
/**
* Get the day with leading zeros from the last revision of a specified page.
- * @param $parser Parser
- * @param $title string Title to get the day from
+ * @param Parser $parser
+ * @param string $title Title to get the day from
+ * @return string
* @since 1.23
*/
public static function revisionday2( $parser, $title = null ) {
/**
* Get the month with leading zeros from the last revision of a specified page.
- * @param $parser Parser
- * @param $title string Title to get the month from
+ * @param Parser $parser
+ * @param string $title Title to get the month from
+ * @return string
* @since 1.23
*/
public static function revisionmonth( $parser, $title = null ) {
/**
* Get the month from the last revision of a specified page.
- * @param $parser Parser
- * @param $title string Title to get the month from
+ * @param Parser $parser
+ * @param string $title Title to get the month from
+ * @return string
* @since 1.23
*/
public static function revisionmonth1( $parser, $title = null ) {
/**
* Get the year from the last revision of a specified page.
- * @param $parser Parser
- * @param $title string Title to get the year from
+ * @param Parser $parser
+ * @param string $title Title to get the year from
+ * @return string
* @since 1.23
*/
public static function revisionyear( $parser, $title = null ) {
/**
* Get the timestamp from the last revision of a specified page.
- * @param $parser Parser
- * @param $title string Title to get the timestamp from
+ * @param Parser $parser
+ * @param string $title Title to get the timestamp from
+ * @return string
* @since 1.23
*/
public static function revisiontimestamp( $parser, $title = null ) {
/**
* Get the user from the last revision of a specified page.
- * @param $parser Parser
- * @param $title string Title to get the user from
+ * @param Parser $parser
+ * @param string $title Title to get the user from
+ * @return string
* @since 1.23
*/
public static function revisionuser( $parser, $title = null ) {
dépôts / lhc / web / wiklou.git / blobdiff