[ Index ]

PHP Cross Reference of MediaWiki-1.24.0

title

Body

[close]

/includes/cache/ -> HTMLFileCache.php (summary)

Page view caching in the file system. 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: 231 lines (6 kb)
Included or required:0 times
Referenced: 1 time
Includes or requires: 0 files

Defines 1 class

HTMLFileCache:: (9 methods):
  newFromTitle()
  __construct()
  cacheablePageActions()
  cacheDirectory()
  typeSubdirectory()
  useFileCache()
  loadFromFileCache()
  saveToFileCache()
  clearFileCache()


Class: HTMLFileCache  - X-Ref

Page view caching in the file system.
The only cacheable actions are "view" and "history". Also special pages
will not be cached.

newFromTitle( $title, $action )   X-Ref
Construct an ObjectFileCache from a Title and an action

param: Title|string $title Title object or prefixed DB key string
param: string $action
return: HTMLFileCache

__construct( $title, $action )   X-Ref

param: Title|string $title Title object or prefixed DB key string
param: string $action

cacheablePageActions()   X-Ref
Cacheable actions

return: array

cacheDirectory()   X-Ref
Get the base file cache directory

return: string

typeSubdirectory()   X-Ref
Get the cache type subdirectory (with the trailing slash) or the empty string
Alter the type -> directory mapping to put action=view cache at the root.

return: string

useFileCache( IContextSource $context )   X-Ref
Check if pages can be cached for this request/user

param: IContextSource $context
return: bool

loadFromFileCache( IContextSource $context )   X-Ref
Read from cache to context output

param: IContextSource $context
return: void

saveToFileCache( $text )   X-Ref
Save this cache object with the given text.
Use this as an ob_start() handler.

param: string $text
return: bool Whether $wgUseFileCache is enabled

clearFileCache( Title $title )   X-Ref
Clear the file caches for a page for all actions

param: Title $title
return: bool Whether $wgUseFileCache is enabled



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