[ Index ]

PHP Cross Reference of MediaWiki-1.24.0

title

Body

[close]

/includes/parser/ -> CacheTime.php (summary)

Parser cache specific expiry check. This program is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation; either version 2 of the License, or (at your option) any later version.

File Size: 190 lines (6 kb)
Included or required:0 times
Referenced: 0 times
Includes or requires: 0 files

Defines 1 class

CacheTime:: (11 methods):
  getCacheTime()
  containsOldMagic()
  setContainsOldMagic()
  setCacheTime()
  getCacheRevisionId()
  setCacheRevisionId()
  updateCacheExpiry()
  getCacheExpiry()
  isCacheable()
  expired()
  isDifferentRevision()


Class: CacheTime  - X-Ref

Parser cache specific expiry check.

getCacheTime()   X-Ref

return: string TS_MW timestamp

containsOldMagic()   X-Ref

return: bool

setContainsOldMagic( $com )   X-Ref

param: bool $com
return: bool

setCacheTime( $t )   X-Ref
setCacheTime() sets the timestamp expressing when the page has been rendered.
This does not control expiry, see updateCacheExpiry() for that!

param: string $t
return: string

getCacheRevisionId()   X-Ref

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

setCacheRevisionId( $id )   X-Ref

param: int $id Revision id

updateCacheExpiry( $seconds )   X-Ref
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().

param: int $seconds

getCacheExpiry()   X-Ref
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.

return: int|mixed|null

isCacheable()   X-Ref

return: bool

expired( $touched )   X-Ref
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.

param: string $touched The affected article's last touched timestamp
return: bool

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

param: int $id The affected article's current revision id
return: bool



Generated: Fri Nov 28 14:03:12 2014 Cross-referenced by PHPXref 0.7.1