eZPublish(LegacyStack)  5.1
ezpStaticCache Interface Reference
+ Inheritance diagram for ezpStaticCache:

Public Member Functions

 cacheURL ($url, $nodeID=false, $skipExisting=false, $delay=true)
 Generates the caches for the url $url using the currently configured storageDirectory(). More...
 
 generateAlwaysUpdatedCache ($quiet=false, $cli=false, $delay=true)
 Generates the caches for all URLs that must always be generated. More...
 
 generateCache ($force=false, $quiet=false, $cli=false, $delay=true)
 Generates the static cache from the configured INI settings. More...
 
 generateNodeListCache ($nodeList)
 Requests the StaticCache handler to (re-)generate cache for a given node list. More...
 
 removeURL ($url)
 Removes the static cache file (index.html) and its directory if it exists. More...
 

Static Public Member Functions

static executeActions ()
 This function goes over the list of recorded actions and excecutes them. More...
 

Member Function Documentation

ezpStaticCache::cacheURL (   $url,
  $nodeID = false,
  $skipExisting = false,
  $delay = true 
)

Generates the caches for the url $url using the currently configured storageDirectory().

Parameters
string$urlThe URL to cache, e.g /news
int | false$nodeIDThe ID of the node to cache, if supplied it will also cache content/view/full/xxx.
bool$skipExistingIf true it will not unlink existing cache files.
Returns
bool

Implemented in eZStaticCache.

static ezpStaticCache::executeActions ( )
static

This function goes over the list of recorded actions and excecutes them.

Implemented in eZStaticCache.

ezpStaticCache::generateAlwaysUpdatedCache (   $quiet = false,
  $cli = false,
  $delay = true 
)

Generates the caches for all URLs that must always be generated.

Parameters
bool$quietIf true then the function will not output anything.
eZCLI | false$cliThe eZCLI object or false if no output can be done.
bool$delay

Implemented in eZStaticCache.

ezpStaticCache::generateCache (   $force = false,
  $quiet = false,
  $cli = false,
  $delay = true 
)

Generates the static cache from the configured INI settings.

Parameters
bool$forceIf true then it will create all static caches even if it is not outdated.
bool$quietIf true then the function will not output anything.
eZCLI | false$cliThe eZCLI object or false if no output can be done.
bool$delay

Implemented in eZStaticCache.

ezpStaticCache::generateNodeListCache (   $nodeList)

Requests the StaticCache handler to (re-)generate cache for a given node list.

Parameters
array$nodeListNode list
Returns
bool True if the operation succeed.

Implemented in eZStaticCache.

ezpStaticCache::removeURL (   $url)

Removes the static cache file (index.html) and its directory if it exists.

The directory path is based upon the URL $url and the configured static storage dir.

Parameters
string$urlThe URL for the current item, e.g /news

Implemented in eZStaticCache.


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