Elgg  Version 2.2
 All Classes Namespaces Files Functions Variables Pages
Public Member Functions | List of all members
Elgg\Cache\SimpleCache Class Reference

WARNING: API IN FLUX. More...

Public Member Functions

 __construct (Config $config, Datalist $datalist, Views $views)
 Constructor. More...
 
 registerView ($view_name)
 Registers a view to simple cache. More...
 
 getUrl ($view, $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...
 
 invalidate ()
 Deletes all cached views in the simplecache and sets the lastcache and lastupdate time to 0 for every valid viewtype. More...
 
 init ()
 Set up config appropriately on engine boot. More...
 

Detailed Description

WARNING: API IN FLUX.

DO NOT USE DIRECTLY.

private

Since
1.10.0

Definition at line 16 of file SimpleCache.php.

Constructor & Destructor Documentation

Elgg\Cache\SimpleCache::__construct ( Config  $config,
Datalist  $datalist,
Views  $views 
)

Constructor.

Parameters
Config$configElgg's global configuration
Datalist$datalistElgg's database config storage
Views$viewsElgg's views registry

Definition at line 34 of file SimpleCache.php.

Member Function Documentation

Elgg\Cache\SimpleCache::disable ( )

Disables the simple cache.

Warning
Simplecache is also purged when disabled.
See Also
elgg_register_simplecache_view()
Returns
void

Definition at line 152 of file SimpleCache.php.

Elgg\Cache\SimpleCache::enable ( )

Enables the simple cache.

See Also
elgg_register_simplecache_view()
Returns
void

Definition at line 138 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. private

Definition at line 111 of file SimpleCache.php.

Elgg\Cache\SimpleCache::getUrl (   $view,
  $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('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$viewThe full view name
string$subviewIf the first arg is "css" or "js", the rest of the view name
Returns
string

Definition at line 86 of file SimpleCache.php.

Elgg\Cache\SimpleCache::init ( )

Set up config appropriately on engine boot.

Returns
void

Definition at line 192 of file SimpleCache.php.

Elgg\Cache\SimpleCache::invalidate ( )

Deletes all cached views in the simplecache and sets the lastcache and lastupdate time to 0 for every valid viewtype.

Returns
bool

Definition at line 177 of file SimpleCache.php.

Elgg\Cache\SimpleCache::isEnabled ( )

Is simple cache enabled.

Returns
bool

Definition at line 128 of file SimpleCache.php.

Elgg\Cache\SimpleCache::registerView (   $view_name)

Registers a view to simple cache.

Simple cache is a caching mechanism that saves the output of a view and its extensions into a file. If the view is called by the engine/handlers/cache_handler.php file, the Elgg engine will not be loaded and the contents of the view will returned from file.

Warning
Simple cached views must take no parameters and return the same content no matter who is logged in.
Parameters
string$view_nameView name
Returns
void
See Also
elgg_get_simplecache_url()

Definition at line 57 of file SimpleCache.php.


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