Elgg\Application\CacheHandler Class Reference

Simplecache handler. More...

Public Member Functions
	__construct (protected Config $config, protected Request $request, protected SimpleCache $simplecache, ConfigTable $config_table)
	Constructor. More...
	handleRequest (Request $request, Application $app)
	Handle a request for a cached view. More...
	parsePath ($path)
	Parse a request. More...
	getContentType ($view)
	Get the content type. More...
	getViewFileType ($view)
	Returns the type of output expected from the view. More...

Static Public Attributes
static	$extensions
static	$utf8_content_types

Protected Member Functions
	isCacheableView ($view)
	Is the view cacheable. More...
	sendCacheHeaders ($etag, Response $response)
	Sets cache headers. More...
	setRevalidateHeaders ($etag, Response $response)
	Set revalidate cache headers. More...
	is304 ($etag)
	Send a 304 and exit() if the ETag matches the request. More...
	getProcessedView ($view, $viewtype)
	Get the contents of a view for caching. More...
	renderView ($view, $viewtype)
	Render a view for caching. More...
	send403 ($msg='Cache error:bad request')
	Send an error message to requestor. More...

Protected Attributes
bool	$simplecache_enabled

Detailed Description

Simplecache handler.

Definition at line 18 of file CacheHandler.php.

Constructor & Destructor Documentation

__construct()

Elgg\Application\CacheHandler::__construct	(	protected Config	$config,
		protected Request	$request,
		protected SimpleCache	$simplecache,
		ConfigTable	$config_table
	)

Constructor.

Parameters

Config	$config	Elgg configuration
Request	$request	HTTP request
SimpleCache	$simplecache	Simplecache
ConfigTable	$config_table	Config table

Definition at line 64 of file CacheHandler.php.

Member Function Documentation

getContentType()

Elgg\Application\CacheHandler::getContentType

(

$view

)

Get the content type.

Parameters

string

$view

The view name

Returns

string|null

Definition at line 293 of file CacheHandler.php.

getProcessedView()

Elgg\Application\CacheHandler::getProcessedView (   $view,   $viewtype  )

protected

Get the contents of a view for caching.

Parameters

string	$view	The view name
string	$viewtype	The viewtype

Returns

string|false

See also

CacheHandler::renderView()

Definition at line 334 of file CacheHandler.php.

getViewFileType()

Elgg\Application\CacheHandler::getViewFileType

(

$view

)

Returns the type of output expected from the view.

• view/name.extension returns "extension" if "extension" is valid
• css/view return "css"
• js/view return "js"
• Otherwise, returns "unknown"

Parameters

string

$view

The view name

Returns

string

Definition at line 311 of file CacheHandler.php.

handleRequest()

Elgg\Application\CacheHandler::handleRequest	(	Request	$request,
		Application	$app
	)

Handle a request for a cached view.

Parameters

Request	$request	Elgg request
Application	$app	Elgg application

Returns

Response (unprepared)

Definition at line 87 of file CacheHandler.php.

is304()

Elgg\Application\CacheHandler::is304 (   $etag )

protected

Send a 304 and exit() if the ETag matches the request.

Parameters

string

$etag

ETag value

Returns

bool

Definition at line 268 of file CacheHandler.php.

isCacheableView()

Elgg\Application\CacheHandler::isCacheableView (   $view )

protected

Is the view cacheable.

Language views are handled specially.

Parameters

string

$view

View name

Returns

bool

Definition at line 225 of file CacheHandler.php.

parsePath()

Elgg\Application\CacheHandler::parsePath

(

$path

)

Parse a request.

Parameters

string

$path

Request URL path

Returns

array Cache parameters (empty array if failure)

Definition at line 192 of file CacheHandler.php.

renderView()

Elgg\Application\CacheHandler::renderView (   $view,   $viewtype  )

protected

Render a view for caching.

Language views are handled specially.

Parameters

string	$view	The view name
string	$viewtype	The viewtype

Returns

string|false

Definition at line 364 of file CacheHandler.php.

send403()

Elgg\Application\CacheHandler::send403 (   $msg = 'Cache error: bad request' )

protected

Send an error message to requestor.

Parameters

string

$msg

Optional message text

Returns

Response

Definition at line 392 of file CacheHandler.php.

sendCacheHeaders()

Elgg\Application\CacheHandler::sendCacheHeaders (   $etag, Response  $response  )

protected

Sets cache headers.

Parameters

string	$etag	ETag value
Response	$response	the response to set the headers on

Returns

void

Definition at line 242 of file CacheHandler.php.

setRevalidateHeaders()

Elgg\Application\CacheHandler::setRevalidateHeaders (   $etag, Response  $response  )

protected

Set revalidate cache headers.

Parameters

string	$etag	ETag value
Response	$response	the response to set the headers on

Returns

void

Definition at line 256 of file CacheHandler.php.

Member Data Documentation

$extensions

Elgg\Application\CacheHandler::$extensions

static

Initial value:

= [
        'bmp' => 'image/bmp',
        'css' => 'text/css',
        'eot' => 'application/vnd.ms-fontobject',
        'gif' => 'image/gif',
        'html' => 'text/html',
        'ico' => 'image/x-icon',
        'jpeg' => 'image/jpeg',
        'jpg' => 'image/jpeg',
        'js' => 'text/javascript',
        'json' => 'application/json',
        'map' => 'application/json',
        'mjs' => 'text/javascript',
        'otf' => 'application/font-otf',
        'png' => 'image/png',
        'svg' => 'image/svg+xml',
        'swf' => 'application/x-shockwave-flash',
        'tiff' => 'image/tiff',
        'ttf' => 'application/font-ttf',
        'webp' => 'image/webp',
        'woff' => 'application/font-woff',
        'woff2' => 'application/font-woff2',
        'xml' => 'text/xml',
    ]

Definition at line 20 of file CacheHandler.php.

$simplecache_enabled

bool Elgg\Application\CacheHandler::$simplecache_enabled

protected

Definition at line 54 of file CacheHandler.php.

$utf8_content_types

Elgg\Application\CacheHandler::$utf8_content_types

static

Initial value:

= [
        'text/css',
        'text/html',
        'text/javascript',
        'application/json',
        'image/svg+xml',
        'text/xml',
    ]

Definition at line 45 of file CacheHandler.php.

---

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

• engine/classes/Elgg/Application/CacheHandler.php