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 10 of file CacheHandler.php.

Constructor & Destructor Documentation

__construct()

Elgg_CacheHandler::__construct

(

$config

)

Constructor.

Parameters

stdClass

$config

Elgg config object

Definition at line 19 of file CacheHandler.php.

Member Function Documentation

getProcessedView()

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 205 of file CacheHandler.php.

handleRequest()

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 30 of file CacheHandler.php.

loadEngine()

Elgg_CacheHandler::loadEngine ( )

protected

Load the complete Elgg engine.

Returns

void

Definition at line 250 of file CacheHandler.php.

parseRequestVar()

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 106 of file CacheHandler.php.

renderView()

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 224 of file CacheHandler.php.

send403()

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 260 of file CacheHandler.php.

sendCacheHeaders()

Elgg_CacheHandler::sendCacheHeaders (   $etag )

protected

Send cache headers.

Parameters

string

$etag

ETag value

Returns

void

Definition at line 172 of file CacheHandler.php.

sendContentType()

Elgg_CacheHandler::sendContentType (   $view )

protected

Send content type.

Parameters

string

$view

The view name

Returns

void

Definition at line 185 of file CacheHandler.php.

setupSimplecache()

Elgg_CacheHandler::setupSimplecache ( )

protected

Do a minimal engine load.

Returns

void

Definition at line 135 of file CacheHandler.php.

Member Data Documentation

$config

Elgg_CacheHandler::$config

protected

Definition at line 12 of file CacheHandler.php.

---

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

• engine/classes/Elgg/CacheHandler.php