kernel/private/interfaces/ezpstaticcache.php

Show:

inherited

Table of Contents

File containing the ezpStaticCache interface

Copyright: Copyright (C) 1999-2011 eZ Systems AS. All rights reserved.
License: eZ Business Use License Agreement Version 2.0
Package: kernel
Version: 4.6.0

\ezpStaticCache
jump to top

Package: kernel

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

Children: \eZStaticCache

Methods

cacheURL(
          string $url, int | false $nodeID
              =
              false, bool $skipExisting
              =
              false,  $delay
              =
              true
          )
        
        :
          bool

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

Parameters

Name	Type	Description
$url	string	The URL to cache, e.g /news
$nodeID	int \| false	The ID of the node to cache, if supplied it will also cache content/view/full/xxx.
$skipExisting	bool	If true it will not unlink existing cache files.
$delay

Returns

Type	Description
bool

executeActions(
          
          )
        
        :
          void

static

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

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

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

Parameters

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

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

Generates the static cache from the configured INI settings.

Parameters

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

generateNodeListCache(
          array $nodeList
          )
        
        :
          bool

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

Parameters

Name	Type	Description
$nodeList	array	Node list

Returns

Type	Description
bool	True if the operation succeed.

removeURL(
          string $url
          )
        
        :
          void

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

Name	Type	Description
$url	string	The URL for the current item, e.g /news

kernel/private/interfaces/ezpstaticcache.php

\ezpStaticCachejump to top

Methods

\ezpStaticCache
jump to top