Parser cache specific expiry check. More...

Inheritance diagram for CacheTime:

Public Member Functions
	__get ( $name)
	Deprecate access to all public properties. More...

	__set ( $name, $value)
	Deprecate access to all public properties. More...

	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. More...

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

	getCacheRevisionId ()

	getCacheTime ()

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

	isCacheable ()

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

	setCacheRevisionId ( $id)

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

	setUsedOptions (array $options)
	Sets the list of accessed ParserOptions which have been taken into account to produce the output stored under this key. More...

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

Protected Attributes
true[]	$mAccessedOptions = []
	List of ParserOptions (stored in the keys). More...

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

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

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

string[]	$mUsedOptions
	ParserOptions which have been taken into account to produce output. More...

string	$mVersion = Parser::VERSION
	Compatibility check. More...

Detailed Description

Parser cache specific expiry check.

Definition at line 29 of file CacheTime.php.

Member Function Documentation

◆ __get()

CacheTime::__get ( $name )

Deprecate access to all public properties.

Do not use deprecation helper to avoid serializaing the list of deprecated methods.

Parameters

string $name

Returns: mixed

Definition at line 69 of file CacheTime.php.

References wfDeprecatedMsg().

◆ __set()

CacheTime::__set	(	$name,
		$value
	)

Deprecate access to all public properties.

Do not use deprecation helper to avoid serializaing the list of deprecated methods.

Parameters

string	$name
mixed	$value

Definition at line 92 of file CacheTime.php.

References wfDeprecatedMsg().

◆ 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 220 of file CacheTime.php.

References $wgCacheEpoch, getCacheExpiry(), getCacheTime(), isCacheable(), and Parser\VERSION.

◆ 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

Definition at line 182 of file CacheTime.php.

References $mCacheExpiry, and $wgParserCacheExpireTime.

Referenced by expired(), ParserOutput\hasDynamicContent(), isCacheable(), ParserCache\save(), MediaWiki\Storage\PageEditStash\storeStashValue(), and WikiPage\triggerOpportunisticLinksUpdate().

◆ getCacheRevisionId()

CacheTime::getCacheRevisionId ( )

Since: 1.23

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

Definition at line 140 of file CacheTime.php.

References $mCacheRevisionId.

Referenced by isDifferentRevision().

◆ getCacheTime()

CacheTime::getCacheTime ( )

Returns: string TS_MW timestamp

Definition at line 109 of file CacheTime.php.

References $mCacheTime.

Referenced by expired(), MediaWiki\Storage\PageEditStash\storeStashValue(), and WikiPage\triggerOpportunisticLinksUpdate().

◆ getUsedOptions()

CacheTime::getUsedOptions ( )

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

Returns: string[]

Definition at line 255 of file CacheTime.php.

References $mUsedOptions.

Referenced by ParserCache\save().

◆ isCacheable()

CacheTime::isCacheable ( )

Returns: bool

Definition at line 208 of file CacheTime.php.

References getCacheExpiry().

Referenced by OutputPage\addParserOutputMetadata(), and expired().

◆ 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 245 of file CacheTime.php.

References getCacheRevisionId().

◆ setCacheRevisionId()

CacheTime::setCacheRevisionId ( $id )

Since: 1.23

Parameters

int | null $id Revision ID

Definition at line 148 of file CacheTime.php.

Referenced by 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 123 of file CacheTime.php.

References $t, wfDeprecatedMsg(), and wfSetVar().

Referenced by ParserCache\save().

◆ setUsedOptions()

CacheTime::setUsedOptions ( array $options )

Sets the list of accessed ParserOptions which have been taken into account to produce the output stored under this key.

Parameters

array $options the list of options

Definition at line 273 of file CacheTime.php.

Referenced by ParserCache\save().

◆ 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.

Parameters

int $seconds

Definition at line 165 of file CacheTime.php.

Referenced by ParserOutput\finalizeAdaptiveCacheExpiry(), and ParserOutput\updateRuntimeAdaptiveExpiry().

Member Data Documentation

◆ $mAccessedOptions

true [] CacheTime::$mAccessedOptions = []

protected

List of ParserOptions (stored in the keys).

Definition at line 38 of file CacheTime.php.

◆ $mCacheExpiry

int null CacheTime::$mCacheExpiry = null

private

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

Used in ParserCache.

Definition at line 55 of file CacheTime.php.

Referenced by getCacheExpiry().

◆ $mCacheRevisionId

int null CacheTime::$mCacheRevisionId = null

private

Revision ID that was parsed.

Definition at line 60 of file CacheTime.php.

Referenced by getCacheRevisionId().

◆ $mCacheTime

string int CacheTime::$mCacheTime = ''

private

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

Used in ParserCache.

Definition at line 49 of file CacheTime.php.

Referenced by getCacheTime().

◆ $mUsedOptions

string [] CacheTime::$mUsedOptions

private

ParserOptions which have been taken into account to produce output.

Definition at line 33 of file CacheTime.php.

Referenced by getUsedOptions().

◆ $mVersion

string CacheTime::$mVersion = Parser::VERSION

private

Compatibility check.

Definition at line 43 of file CacheTime.php.

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

includes/parser/CacheTime.php

Public Member Functions

Protected Attributes

Private Attributes

Detailed Description

Member Function Documentation

◆ __get()

◆ __set()

◆ expired()

◆ getCacheExpiry()

◆ getCacheRevisionId()

◆ getCacheTime()

◆ getUsedOptions()

◆ isCacheable()

◆ isDifferentRevision()

◆ setCacheRevisionId()

◆ setCacheTime()

◆ setUsedOptions()

◆ updateCacheExpiry()

Member Data Documentation

◆ $mAccessedOptions

◆ $mCacheExpiry

◆ $mCacheRevisionId

◆ $mCacheTime

◆ $mUsedOptions

◆ $mVersion