Expansions of core magic variables, used by the parser. More...

Static Public Member Functions
static	applyCacheExpiry (Parser $parser, int $ttl, ?int $stagger=null, ?string $source=null)
	Apply the given $ttl to the cache expiry of the parser output, adjusting slightly to ensure a minimum TTL and avoid cache stampede.

static	applyUnitTimestampDeadline (Parser $parser, ?ConvertibleTimestamp $ts, string $unit, ?string $source=null)
	Adjust the cache expiry to account for a dynamic timestamp displayed in output.

static	expand (Parser $parser, string $id, ConvertibleTimestamp $ts, ServiceOptions $svcOptions, LoggerInterface $logger, $frame=false)
	Expand the magic variable given by $index.

Detailed Description

Expansions of core magic variables, used by the parser.

Definition at line 26 of file CoreMagicVariables.php.

Member Function Documentation

static MediaWiki\Parser\CoreMagicVariables::applyCacheExpiry	(	Parser	$parser,
		int	$ttl,
		?int	$stagger = null,
		?string	$source = null )

static

Apply the given $ttl to the cache expiry of the parser output, adjusting slightly to ensure a minimum TTL and avoid cache stampede.

Parameters

Parser	$parser
int	$ttl	The desired time-to-live, in seconds
?int	$stagger	An optional random value used to avoid stampede
string \| null	$source	Cache-expiry attribution label

Definition at line 353 of file CoreMagicVariables.php.

static MediaWiki\Parser\CoreMagicVariables::applyUnitTimestampDeadline	(	Parser	$parser,
		?ConvertibleTimestamp	$ts,
		string	$unit,
		?string	$source = null )

static

Adjust the cache expiry to account for a dynamic timestamp displayed in output.

Parameters

Parser	$parser
?ConvertibleTimestamp	$ts	Current timestamp with the display timezone. If missing (null) the timestamp will be fetched from the ParserOptions.
string	$unit	The unit the timestamp is expressed in; one of ("Y", "M", "D", "H")
string \| null	$source	Cache-expiry attribution label

Definition at line 333 of file CoreMagicVariables.php.

static MediaWiki\Parser\CoreMagicVariables::expand	(	Parser	$parser,
		string	$id,
		ConvertibleTimestamp	$ts,
		ServiceOptions	$svcOptions,
		LoggerInterface	$logger,
			$frame = false )

static

Expand the magic variable given by $index.

Parameters

Parser	$parser
string	$id	The name of the variable, and equivalently, the magic word ID which was used to match the variable
ConvertibleTimestamp	$ts	Timestamp to use when expanding magic variable
ServiceOptions	$svcOptions	Service options for the parser
LoggerInterface	$logger
PPFrame \| false	$frame	The current parser frame, used to attribute cache-expiry changes to the page/template that triggered them.

Returns: string|null The expanded value, as wikitext, or null to indicate the given index wasn't a known magic variable.

Definition at line 68 of file CoreMagicVariables.php.

The documentation for this class was generated from the following file: