Elgg\Cache\SimpleCache Class Reference

Simple cache service. More...

Public Member Functions
	__construct (Config $config, ViewsService $views)
	Constructor. More...
	getUrl (string $view, string $subview= '')
	Get the URL for the cached view. More...
	getRoot ()
	Get the base url for simple cache requests. More...
	isEnabled ()
	Is simple cache enabled. More...
	enable ()
	Enables the simple cache. More...
	disable ()
	Disables the simple cache. More...
	clear ()
	Deletes all cached views in the simplecache. More...
	purge ()
	Purge old/stale cache content. More...
	cachedAssetExists (int $cache_time, string $viewtype, string $view)
	Check if a asset exists in the cache. More...
	getCachedAssetLocation (int $cache_time, string $viewtype, string $view)
	Get the cache location of an existing cached asset. More...
	cacheAsset (string $viewtype, string $view, string $contents)
	Store an asset for caching. More...

Protected Member Functions
	getPath ()
	Returns the path to where views are simplecached. More...
	getCacheFilename (string $viewtype, string $view, int $cache_time=null)
	Get the cache file location. More...

Protected Attributes
	$config
	$views

Detailed Description

Simple cache service.

Definition at line 15 of file SimpleCache.php.

Constructor & Destructor Documentation

Elgg\Cache\SimpleCache::__construct	(	Config	$config,
		ViewsService	$views
	)

Constructor.

Parameters

Config	$config	Elgg's global configuration
ViewsService	$views	Views service

Definition at line 33 of file SimpleCache.php.

Member Function Documentation

Elgg\Cache\SimpleCache::cacheAsset	(	string	$viewtype,
		string	$view,
		string	$contents
	)

Store an asset for caching.

Parameters

string	$viewtype	view type
string	$view	view to cache
string	$contents	view contents

Returns

int

Definition at line 226 of file SimpleCache.php.

Elgg\Cache\SimpleCache::cachedAssetExists	(	int	$cache_time,
		string	$viewtype,
		string	$view
	)

Check if a asset exists in the cache.

Parameters

int	$cache_time	time the asset was cached
string	$viewtype	view type
string	$view	cached view name

Returns

bool

Since

4.1

Definition at line 193 of file SimpleCache.php.

Elgg\Cache\SimpleCache::clear

(

)

Deletes all cached views in the simplecache.

Returns

bool

Since

3.3

Definition at line 149 of file SimpleCache.php.

Elgg\Cache\SimpleCache::disable

(

)

Disables the simple cache.

Returns

void

See also

elgg_register_simplecache_view()

Definition at line 126 of file SimpleCache.php.

Elgg\Cache\SimpleCache::enable

(

)

Enables the simple cache.

Returns

void

See also

elgg_register_simplecache_view()

Definition at line 116 of file SimpleCache.php.

Elgg\Cache\SimpleCache::getCachedAssetLocation	(	int	$cache_time,
		string	$viewtype,
		string	$view
	)

Get the cache location of an existing cached asset.

Parameters

int	$cache_time	time the asset was cached
string	$viewtype	view type
string	$view	cached view name

Returns

string|null null if asset doesn't exist

Since

4.1

Definition at line 209 of file SimpleCache.php.

Elgg\Cache\SimpleCache::getCacheFilename ( string  $viewtype, string  $view, int  $cache_time = null  )

protected

Get the cache file location.

Parameters

string	$viewtype	view type
string	$view	cached view
int	$cache_time	(optional) cache time (default ->lastcache;

Returns

string

Definition at line 251 of file SimpleCache.php.

Elgg\Cache\SimpleCache::getPath ( )

protected

Returns the path to where views are simplecached.

Returns

string

Definition at line 139 of file SimpleCache.php.

Elgg\Cache\SimpleCache::getRoot

(

)

Get the base url for simple cache requests.

Returns

string The simplecache root url for the current viewtype

Definition at line 90 of file SimpleCache.php.

Elgg\Cache\SimpleCache::getUrl	(	string	$view,
		string	$subview = ''
	)

Get the URL for the cached view.

Recommended usage is to just pass the entire view name as the first and only arg:

$blog_js = $simpleCache->getUrl('blog/save_draft.js');
$favicon = $simpleCache->getUrl('graphics/favicon.ico');

For backwards compatibility with older versions of Elgg, you can also pass "js" or "css" as the first arg, with the rest of the view name as the second arg:

$blog_js = $simpleCache->getUrl('js', 'blog/save_draft.js');

This automatically registers the view with Elgg's simplecache.

Parameters

string	$view	The full view name
string	$subview	If the first arg is "css" or "js", the rest of the view name

Returns

string

Definition at line 65 of file SimpleCache.php.

Elgg\Cache\SimpleCache::isEnabled

(

)

Is simple cache enabled.

Returns

bool

Definition at line 106 of file SimpleCache.php.

Elgg\Cache\SimpleCache::purge

(

)

Purge old/stale cache content.

Returns

void

Definition at line 160 of file SimpleCache.php.

Member Data Documentation

Elgg\Cache\SimpleCache::$config

protected

Definition at line 20 of file SimpleCache.php.

Elgg\Cache\SimpleCache::$views

protected

Definition at line 25 of file SimpleCache.php.

---

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

• engine/classes/Elgg/Cache/SimpleCache.php