Elgg\CacheHandler Class Reference

Public Member Functions
	__construct ($config)
	Constructor. More...
	handleRequest ($get_vars, $server_vars)
	Handle a request for a cached view. More...
	parseRequestVar ($request_var)
	Parse a request. More...

Protected Member Functions
	setupSimplecache ()
	Do a minimal engine load. More...
	sendCacheHeaders ($etag)
	Send cache headers. More...
	sendContentType ($view)
	Send content type. More...
	getProcessedView ($view, $viewtype)
	Get the contents of a view for caching. More...
	renderView ($view, $viewtype)
	Render a view for caching. More...
	loadEngine ()
	Load the complete Elgg engine. More...
	send403 ($msg= 'Cache error:bad request')
	Send an error message to requestor. More...

Protected Attributes
	$config

Detailed Description

Definition at line 11 of file CacheHandler.php.

Constructor & Destructor Documentation

Elgg\CacheHandler::__construct

(

$config

)

Constructor.

Parameters

\stdClass

$config

Elgg config object

Definition at line 20 of file CacheHandler.php.

Member Function Documentation

Elgg\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

See also

CacheHandler::renderView()

Definition at line 210 of file CacheHandler.php.

Elgg\CacheHandler::handleRequest	(		$get_vars,
			$server_vars
	)

Handle a request for a cached view.

Parameters

array	$get_vars	$_GET variables
array	$server_vars	$_SERVER variables

Returns

void

Definition at line 31 of file CacheHandler.php.

Elgg\CacheHandler::loadEngine ( )

protected

Load the complete Elgg engine.

Returns

void

Definition at line 255 of file CacheHandler.php.

Elgg\CacheHandler::parseRequestVar

(

$request_var

)

Parse a request.

Parameters

string

$request_var

Request URL

Returns

array Cache parameters (empty array if failure)

Definition at line 107 of file CacheHandler.php.

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

protected

Render a view for caching.

Parameters

string	$view	The view name
string	$viewtype	The viewtype

Returns

string

Definition at line 229 of file CacheHandler.php.

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

protected

Send an error message to requestor.

Parameters

string

$msg

Optional message text

Returns

void

Definition at line 265 of file CacheHandler.php.

Elgg\CacheHandler::sendCacheHeaders (   $etag )

protected

Send cache headers.

Parameters

string

$etag

ETag value

Returns

void

Definition at line 177 of file CacheHandler.php.

Elgg\CacheHandler::sendContentType (   $view )

protected

Send content type.

Parameters

string

$view

The view name

Returns

void

Definition at line 190 of file CacheHandler.php.

Elgg\CacheHandler::setupSimplecache ( )

protected

Do a minimal engine load.

Returns

void

Definition at line 136 of file CacheHandler.php.

Member Data Documentation

Elgg\CacheHandler::$config

protected

Definition at line 13 of file CacheHandler.php.

---

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

• engine/classes/Elgg/CacheHandler.php