Parser cache specific expiry check. More...

Inherits MediaWiki\Parser\ParserCacheMetadata, and MediaWiki\Json\JsonUnserializable.

Inherited by MediaWiki\Parser\ParserOutput.

Collaboration diagram for CacheTime:

[legend]

Public Member Functions
	__get ( $name)

	__set ( $name, $value)

	__wakeup ()

	expired ( $touched)
	Return true if this cached output object predates the global or per-article cache invalidation timestamps, or if it comes from an incompatible older version.

	getCacheExpiry ()
	Returns the number of seconds after which this object should expire.

	getCacheRevisionId ()

	getCacheTime ()

	getUsedOptions ()
	Returns the options from its ParserOptions which have been taken into account to produce the output.

	hasCacheTime ()

	isCacheable ()

	isDifferentRevision ( $id)
	Return true if this cached output object is for a different revision of the page.

	recordOption (string $option)
	Tags a parser option for use in the cache key for this parser output.

	recordOptions (array $options)
	Tags a list of parser option names for use in the cache key for this parser output.

	setCacheRevisionId ( $id)

	setCacheTime ( $t)
	setCacheTime() sets the timestamp expressing when the page has been rendered.

	updateCacheExpiry ( $seconds)
	Sets the number of seconds after which this object should expire.

Static Public Member Functions
static	newFromJsonArray (JsonUnserializer $unserializer, array $json)
	Creates a new instance of the class and initialized it from the $json array.

Protected Member Functions
	initFromJson (JsonUnserializer $unserializer, array $jsonData)
	Initialize member fields from an array returned by jsonSerialize().

	toJsonArray ()
	Returns a JSON serializable structure representing this CacheTime instance.

Protected Attributes
int null	$mCacheExpiry = null
	Seconds after which the object should expire, use 0 for not cacheable.

int null	$mCacheRevisionId = null
	Revision ID that was parsed.

string int	$mCacheTime = ''
	TS_MW timestamp when this object was generated, or -1 for not cacheable.

true[]	$mParseUsedOptions = []
	ParserOptions which have been taken into account to produce output, option names stored in array keys.

Detailed Description

Parser cache specific expiry check.

Definition at line 38 of file CacheTime.php.

Member Function Documentation

◆ __get()

CacheTime::__get ( $name )

Reimplemented in MediaWiki\Parser\ParserOutput.

Definition at line 302 of file CacheTime.php.

References wfDeprecatedMsg().

◆ __set()

CacheTime::__set	(		$name,
			$value )

Reimplemented in MediaWiki\Parser\ParserOutput.

Definition at line 317 of file CacheTime.php.

References wfDeprecatedMsg().

◆ __wakeup()

CacheTime::__wakeup ( )

Reimplemented in MediaWiki\Parser\ParserOutput.

Definition at line 294 of file CacheTime.php.

◆ expired()

CacheTime::expired ( $touched )

Return true if this cached output object predates the global or per-article cache invalidation timestamps, or if it comes from an incompatible older version.

Parameters

string $touched The affected article's last touched timestamp

Returns: bool

Definition at line 180 of file CacheTime.php.

◆ getCacheExpiry()

CacheTime::getCacheExpiry ( )

Returns the number of seconds after which this object should expire.

This method is used by ParserCache to determine how long the ParserOutput can be cached. The timestamp of expiry can be calculated by adding getCacheExpiry() to getCacheTime(). The value returned by getCacheExpiry is smaller or equal to the smallest number that was provided to a call of updateCacheExpiry(), and smaller or equal to the value of $wgParserCacheExpireTime.

Returns: int

Implements MediaWiki\Parser\ParserCacheMetadata.

Definition at line 152 of file CacheTime.php.

Referenced by MediaWiki\Parser\Parsoid\ParsoidParser\makeLimitReport(), MediaWiki\Parser\RevisionOutputCache\save(), ParserCache\save(), and WikiPage\triggerOpportunisticLinksUpdate().

◆ getCacheRevisionId()

CacheTime::getCacheRevisionId ( )

Since: 1.23

Returns: int|null Revision id, if any was set

Implements MediaWiki\Parser\ParserCacheMetadata.

Definition at line 106 of file CacheTime.php.

Referenced by MediaWiki\Parser\RevisionOutputCache\save(), and ParserCache\save().

◆ getCacheTime()

CacheTime::getCacheTime ( )

Returns: string|int TS_MW timestamp

Implements MediaWiki\Parser\ParserCacheMetadata.

Definition at line 68 of file CacheTime.php.

Referenced by MediaWiki\Parser\Parsoid\ParsoidParser\makeLimitReport(), MediaWiki\Parser\RevisionOutputCache\save(), ParserCache\save(), and WikiPage\triggerOpportunisticLinksUpdate().

◆ getUsedOptions()

CacheTime::getUsedOptions ( )

Returns the options from its ParserOptions which have been taken into account to produce the output.

Since: 1.36

Returns: string[]

Implements MediaWiki\Parser\ParserCacheMetadata.

Definition at line 214 of file CacheTime.php.

Referenced by MediaWiki\Parser\ParserObserver\notifyParse(), and ParserCache\save().

◆ hasCacheTime()

CacheTime::hasCacheTime ( )

Returns: bool true if a cache time has been set

Definition at line 79 of file CacheTime.php.

Referenced by ParserCache\save().

◆ initFromJson()

CacheTime::initFromJson	(	JsonUnserializer	$unserializer,
		array	$jsonData )

protected

Initialize member fields from an array returned by jsonSerialize().

Parameters

JsonUnserializer	$unserializer
array	$jsonData

Reimplemented in MediaWiki\Parser\ParserOutput.

Definition at line 276 of file CacheTime.php.

◆ isCacheable()

CacheTime::isCacheable ( )

Returns: bool

Definition at line 168 of file CacheTime.php.

Referenced by MediaWiki\Output\OutputPage\addParserOutputMetadata().

◆ isDifferentRevision()

CacheTime::isDifferentRevision ( $id )

Return true if this cached output object is for a different revision of the page.

Todo: We always return false if $this->getCacheRevisionId() is null; this prevents invalidating the whole parser cache when this change is deployed. Someday that should probably be changed.

Since: 1.23

Parameters

int $id The affected article's current revision id

Returns: bool

Definition at line 203 of file CacheTime.php.

◆ newFromJsonArray()

static CacheTime::newFromJsonArray	(	JsonUnserializer	$unserializer,
		array	$json )

static

Creates a new instance of the class and initialized it from the $json array.

Parameters

JsonUnserializer	$unserializer	an instance of JsonUnserializer to use for nested properties if they need special care.
array	$json

Returns: JsonUnserializable

Implements MediaWiki\Json\JsonUnserializable.

Reimplemented in MediaWiki\Parser\ParserOutput.

Definition at line 265 of file CacheTime.php.

◆ recordOption()

CacheTime::recordOption ( string $option )

Tags a parser option for use in the cache key for this parser output.

Registered as a watcher at ParserOptions::registerWatcher() by Parser::clearState(). The information gathered here is available via getUsedOptions(), and is used by ParserCache::save().

See also: ParserCache::getMetadata; ParserCache::save; ParserOptions::addExtraKey; ParserOptions::optionsHash

Parameters

string $option

Definition at line 230 of file CacheTime.php.

◆ recordOptions()

CacheTime::recordOptions ( array $options )

Tags a list of parser option names for use in the cache key for this parser output.

See also: recordOption()

Parameters

string[] $options

Definition at line 240 of file CacheTime.php.

Referenced by ParserCache\save().

◆ setCacheRevisionId()

CacheTime::setCacheRevisionId ( $id )

Since: 1.23

Parameters

int | null $id Revision ID

Definition at line 114 of file CacheTime.php.

Referenced by MediaWiki\Parser\RevisionOutputCache\save(), and ParserCache\save().

◆ setCacheTime()

CacheTime::setCacheTime ( $t )

setCacheTime() sets the timestamp expressing when the page has been rendered.

This does not control expiry, see updateCacheExpiry() for that!

Parameters

string $t TS_MW timestamp

Returns: string

Definition at line 89 of file CacheTime.php.

References wfDeprecatedMsg(), and wfSetVar().

Referenced by MediaWiki\Parser\RevisionOutputCache\save(), and ParserCache\save().

◆ toJsonArray()

CacheTime::toJsonArray ( )

protected

Returns a JSON serializable structure representing this CacheTime instance.

See also: newFromJson()

Returns: array

Reimplemented in MediaWiki\Parser\ParserOutput.

Definition at line 253 of file CacheTime.php.

◆ updateCacheExpiry()

CacheTime::updateCacheExpiry ( $seconds )

Sets the number of seconds after which this object should expire.

This value is used with the ParserCache. If called with a value greater than the value provided at any previous call, the new call has no effect. The value returned by getCacheExpiry is smaller or equal to the smallest number that was provided as an argument to updateCacheExpiry().

Avoid using 0 if at all possible. Consider JavaScript for highly dynamic content.

NOTE: Beware that reducing the TTL for reasons that do not relate to "dynamic content", may have the side-effect of incurring more RefreshLinksJob executions. See also WikiPage::triggerOpportunisticLinksUpdate.

Parameters

int $seconds

Definition at line 135 of file CacheTime.php.

Referenced by MediaWiki\Parser\RevisionOutputCache\save().

Member Data Documentation

◆ $mCacheExpiry

int null CacheTime::$mCacheExpiry = null

protected

Seconds after which the object should expire, use 0 for not cacheable.

Used in ParserCache.

Definition at line 58 of file CacheTime.php.

◆ $mCacheRevisionId

int null CacheTime::$mCacheRevisionId = null

protected

Revision ID that was parsed.

Definition at line 63 of file CacheTime.php.

◆ $mCacheTime

string int CacheTime::$mCacheTime = ''

protected

TS_MW timestamp when this object was generated, or -1 for not cacheable.

Used in ParserCache.

Definition at line 52 of file CacheTime.php.

◆ $mParseUsedOptions

true [] CacheTime::$mParseUsedOptions = []

protected

ParserOptions which have been taken into account to produce output, option names stored in array keys.

Definition at line 46 of file CacheTime.php.

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

includes/parser/CacheTime.php

Public Member Functions

Static Public Member Functions

Protected Member Functions

Protected Attributes

Detailed Description

Member Function Documentation

◆ __get()

◆ __set()

◆ __wakeup()

◆ expired()

◆ getCacheExpiry()

◆ getCacheRevisionId()

◆ getCacheTime()

◆ getUsedOptions()

◆ hasCacheTime()

◆ initFromJson()

◆ isCacheable()

◆ isDifferentRevision()

◆ newFromJsonArray()

◆ recordOption()

◆ recordOptions()

◆ setCacheRevisionId()

◆ setCacheTime()

◆ toJsonArray()

◆ updateCacheExpiry()

Member Data Documentation

◆ $mCacheExpiry

◆ $mCacheRevisionId

◆ $mCacheTime

◆ $mParseUsedOptions