MediaWiki  master
SpecialCachedPage Class Reference
Inheritance diagram for SpecialCachedPage:
Collaboration diagram for SpecialCachedPage:

Public Member Functions

 addCachedHTML ( $computeFunction, $args=[], $key=null)
 Add some HTML to be cached. More...
 
 getCachedValue ( $computeFunction, $args=[], $key=null)
 Get a cached value if available or compute it if not and then cache it if possible. More...
 
 onCacheInitialized ( $hasCached)
 Gets called after the cache got initialized. More...
 
 saveCache ()
 Saves the HTML to the cache in case it got recomputed. More...
 
 setCacheEnabled ( $cacheEnabled)
 Sets if the cache should be enabled or not. More...
 
 setExpiry ( $cacheExpiry)
 Sets the time to live for the cache, in seconds or a unix timestamp indicating the point of expiry. More...
 
 startCache ( $cacheExpiry=null, $cacheEnabled=null)
 Initializes the caching. More...
 
- Public Member Functions inherited from SpecialPage
 __construct ( $name='', $restriction='', $listed=true, $function=false, $file='', $includable=false)
 Default constructor for special pages Derivative classes should call this from their constructor Note that if the user does not have the required level, an error message will be displayed by the default execute() method, without the global function ever being called. More...
 
 addHelpLink ( $to, $overrideBaseUrl=false)
 Adds help link with an icon via page indicators. More...
 
 checkPermissions ()
 Checks if userCanExecute, and if not throws a PermissionsError. More...
 
 checkReadOnly ()
 If the wiki is currently in readonly mode, throws a ReadOnlyError. More...
 
 displayRestrictionError ()
 Output an error message telling the user what access level they have to have. More...
 
 doesWrites ()
 Indicates whether this special page may perform database writes. More...
 
 execute ( $subPage)
 Default execute method Checks user permissions. More...
 
 getConfig ()
 Shortcut to get main config object. More...
 
 getContext ()
 Gets the context this SpecialPage is executed in. More...
 
 getDescription ()
 Returns the name that goes in the \<h1\> in the special page itself, and also the name that will be listed in Special:Specialpages. More...
 
 getFinalGroupName ()
 Get the group that the special page belongs in on Special:SpecialPage Use this method, instead of getGroupName to allow customization of the group name from the wiki side. More...
 
 getFullTitle ()
 Return the full title, including $par. More...
 
 getLanguage ()
 Shortcut to get user's language. More...
 
 getLinkRenderer ()
 
 getLocalName ()
 Get the localised name of the special page. More...
 
 getName ()
 Get the name of this Special Page. More...
 
 getOutput ()
 Get the OutputPage being used for this instance. More...
 
 getPageTitle ( $subpage=false)
 Get a self-referential title object. More...
 
 getRequest ()
 Get the WebRequest being used for this instance. More...
 
 getRestriction ()
 Get the permission that a user must have to execute this page. More...
 
 getSkin ()
 Shortcut to get the skin being used for this instance. More...
 
 getTitle ( $subpage=false)
 Get a self-referential title object. More...
 
 getUser ()
 Shortcut to get the User executing this instance. More...
 
 including ( $x=null)
 Whether the special page is being evaluated via transclusion. More...
 
 isCached ()
 Is this page cached? Expensive pages are cached or disabled in miser mode. More...
 
 isExpensive ()
 Is this page expensive (for some definition of expensive)? Expensive pages are disabled or cached in miser mode. More...
 
 isIncludable ()
 Whether it's allowed to transclude the special page via {{Special:Foo/params}}. More...
 
 isListed ()
 Whether this special page is listed in Special:SpecialPages. More...
 
 isRestricted ()
 Can be overridden by subclasses with more complicated permissions schemes. More...
 
 listed ( $x=null)
 Get or set whether this special page is listed in Special:SpecialPages. More...
 
 maxIncludeCacheTime ()
 How long to cache page when it is being included. More...
 
 msg ( $key)
 Wrapper around wfMessage that sets the current context. More...
 
 outputHeader ( $summaryMessageKey='')
 Outputs a summary message on top of special pages Per default the message key is the canonical name of the special page May be overridden, i.e. More...
 
 prefixSearchSubpages ( $search, $limit, $offset)
 Return an array of subpages beginning with $search that this special page will accept. More...
 
 requireLogin ( $reasonMsg='exception-nologin-text', $titleMsg='exception-nologin')
 If the user is not logged in, throws UserNotLoggedIn error. More...
 
 run ( $subPage)
 Entry point. More...
 
 setContext ( $context)
 Sets the context this SpecialPage is executed in. More...
 
 setHeaders ()
 Sets headers - this should be called from the execute() method of all derived classes! More...
 
 setLinkRenderer (LinkRenderer $linkRenderer)
 
 setListed ( $listed)
 Set whether this page is listed in Special:Specialpages, at run-time. More...
 
 userCanExecute (User $user)
 Checks if the given user (identified by an object) can execute this special page (as defined by $mRestriction). More...
 

Protected Member Functions

 afterExecute ( $subPage)
 Gets called after. More...
 
 getCacheKey ()
 Returns the variables used to constructed the cache key in an array. More...
 
- Protected Member Functions inherited from SpecialPage
 addFeedLinks ( $params)
 Adds RSS/atom links. More...
 
 afterExecute ( $subPage)
 Gets called after. More...
 
 beforeExecute ( $subPage)
 Gets called before. More...
 
 buildPrevNextNavigation ( $offset, $limit, array $query=[], $atend=false, $subpage=false)
 Generate (prev x| next x) (20|50|100...) type links for paging. More...
 
 checkLoginSecurityLevel ( $level=null)
 Verifies that the user meets the security level, possibly reauthenticating them in the process. More...
 
 getCacheTTL ()
 
 getGroupName ()
 Under which header this special page is listed in Special:SpecialPages See messages 'specialpages-group-*' for valid names This method defaults to group 'other'. More...
 
 getLoginSecurityLevel ()
 Tells if the special page does something security-sensitive and needs extra defense against a stolen account (e.g. More...
 
 getRobotPolicy ()
 Return the robot policy. More...
 
 getSubpagesForPrefixSearch ()
 Return an array of subpages that this special page will accept for prefix searches. More...
 
 prefixSearchString ( $search, $limit, $offset)
 Perform a regular substring search for prefixSearchSubpages. More...
 
 setReauthPostData (array $data)
 Record preserved POST data after a reauthentication. More...
 
 useTransactionalTimeLimit ()
 Call wfTransactionalTimeLimit() if this request was POSTed. More...
 

Protected Attributes

bool $cacheEnabled = true
 If the cache is enabled or not. More...
 
CacheHelper $cacheHelper
 CacheHelper object to which we forward the non-SpecialPage specific caching work. More...
 
- Protected Attributes inherited from SpecialPage
IContextSource $mContext
 Current request context. More...
 
 $mIncludable
 
 $mIncluding
 
 $mName
 
 $mRestriction
 

Additional Inherited Members

- Static Public Member Functions inherited from SpecialPage
static getSafeTitleFor ( $name, $subpage=false)
 Get a localised Title object for a page name with a possibly unvalidated subpage. More...
 
static getTitleFor ( $name, $subpage=false, $fragment='')
 Get a localised Title object for a specified special page name If you don't need a full Title object, consider using TitleValue through getTitleValueFor() below. More...
 
static getTitleValueFor ( $name, $subpage=false, $fragment='')
 Get a localised TitleValue object for a specified special page name. More...
 
- Static Protected Member Functions inherited from SpecialPage
static prefixSearchArray ( $search, $limit, array $subpages, $offset)
 Helper function for implementations of prefixSearchSubpages() that filter the values in memory (as opposed to making a query). More...
 

Detailed Description

Definition at line 40 of file SpecialCachedPage.php.

Member Function Documentation

◆ addCachedHTML()

SpecialCachedPage::addCachedHTML (   $computeFunction,
  $args = [],
  $key = null 
)

Add some HTML to be cached.

This is done by providing a callback function that should return the HTML to be added. It will only be called if the item is not in the cache yet or when the cache has been invalidated.

Since
1.20
Parameters
callable$computeFunction
array$args
string | null$key

Definition at line 143 of file SpecialCachedPage.php.

References $args, and SpecialPage\getOutput().

◆ afterExecute()

SpecialCachedPage::afterExecute (   $subPage)
protected

Gets called after.

See also
SpecialPage::execute.
Since
1.20
Parameters
string | null$subPage

Definition at line 65 of file SpecialCachedPage.php.

References saveCache().

◆ getCachedValue()

SpecialCachedPage::getCachedValue (   $computeFunction,
  $args = [],
  $key = null 
)

Get a cached value if available or compute it if not and then cache it if possible.

The provided $computeFunction is only called when the computation needs to happen and should return a result value. $args are arguments that will be passed to the compute function when called.

Since
1.20
Parameters
callable$computeFunction
array | mixed$args
string | null$key
Returns
mixed

Implements ICacheHelper.

Definition at line 127 of file SpecialCachedPage.php.

References $args.

◆ getCacheKey()

SpecialCachedPage::getCacheKey ( )
protected

Returns the variables used to constructed the cache key in an array.

Since
1.20
Returns
array

Definition at line 182 of file SpecialCachedPage.php.

References SpecialPage\$mName, and SpecialPage\getLanguage().

Referenced by startCache().

◆ onCacheInitialized()

SpecialCachedPage::onCacheInitialized (   $hasCached)

Gets called after the cache got initialized.

Since
1.20
Parameters
bool$hasCached

Definition at line 196 of file SpecialCachedPage.php.

References SpecialPage\getOutput().

◆ saveCache()

SpecialCachedPage::saveCache ( )

Saves the HTML to the cache in case it got recomputed.

Should be called after the last time anything is added via addCachedHTML.

Since
1.20

Implements ICacheHelper.

Definition at line 157 of file SpecialCachedPage.php.

Referenced by afterExecute().

◆ setCacheEnabled()

SpecialCachedPage::setCacheEnabled (   $cacheEnabled)

Sets if the cache should be enabled or not.

Since
1.20
Parameters
bool$cacheEnabled

Implements ICacheHelper.

Definition at line 77 of file SpecialCachedPage.php.

◆ setExpiry()

SpecialCachedPage::setExpiry (   $cacheExpiry)

Sets the time to live for the cache, in seconds or a unix timestamp indicating the point of expiry.

Since
1.20
Parameters
int$cacheExpiry

Implements ICacheHelper.

Definition at line 171 of file SpecialCachedPage.php.

◆ startCache()

SpecialCachedPage::startCache (   $cacheExpiry = null,
  $cacheEnabled = null 
)

Initializes the caching.

Should be called before the first time anything is added via addCachedHTML.

Since
1.20
Parameters
int | null$cacheExpirySets the cache expiry, either ttl in seconds or unix timestamp.
bool | null$cacheEnabledSets if the cache should be enabled or not.

Implements ICacheHelper.

Definition at line 90 of file SpecialCachedPage.php.

References getCacheKey(), and SpecialPage\getRequest().

Member Data Documentation

◆ $cacheEnabled

bool SpecialCachedPage::$cacheEnabled = true
protected

If the cache is enabled or not.

Since
1.20

Definition at line 56 of file SpecialCachedPage.php.

◆ $cacheHelper

CacheHelper SpecialCachedPage::$cacheHelper
protected

CacheHelper object to which we forward the non-SpecialPage specific caching work.

Initialized in startCache.

Since
1.20

Definition at line 48 of file SpecialCachedPage.php.


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