Interface

ezpStaticCache

interface ezpStaticCache

This interface is used as the basis for the different StaticCache engine implementation

Methods

generateAlwaysUpdatedCache(bool $quiet = false, eZCLI|false $cli = false, bool $delay = true)

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

bool generateNodeListCache(array $nodeList)

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

generateCache(bool $force = false, bool $quiet = false, eZCLI|false $cli = false, bool $delay = true)

Generates the static cache from the configured INI settings.

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

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

removeURL(string $url)

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

Details

at line 24
public generateAlwaysUpdatedCache(bool $quiet = false, eZCLI|false $cli = false, bool $delay = true)

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

Parameters

bool $quiet If true then the function will not output anything.
eZCLI|false $cli The eZCLI object or false if no output can be done.
bool $delay

at line 32
public bool generateNodeListCache(array $nodeList)

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

Parameters

array $nodeList Node list

Return Value

bool True if the operation succeed.

at line 42
public generateCache(bool $force = false, bool $quiet = false, eZCLI|false $cli = false, bool $delay = true)

Generates the static cache from the configured INI settings.

Parameters

bool $force If true then it will create all static caches even if it is not outdated.
bool $quiet If true then the function will not output anything.
eZCLI|false $cli The eZCLI object or false if no output can be done.
bool $delay

at line 52
public bool cacheURL($url, $nodeID = false, $skipExisting = false, $delay = true)

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

Parameters

$url
$nodeID
$skipExisting
$delay

Return Value

bool

at line 60
public removeURL(string $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 $url The URL for the current item, e.g /news