.
Gyro-PHP > Documentation

ICachePersister Interface Reference
[Interfaces]

Interface for classes that persist cache items. More...

Inheritance diagram for ICachePersister:
CacheDBImpl

List of all members.

Public Member Functions
  clear ($cache_keys=NULL)
  Clear the cache.
  is_cached ($cache_keys)
  Returns true, if item is cached.
  read ($cache_keys)
  Read from cache.
  remove_expired ()
  Removes expired cache entries.
  store ($cache_keys, $content, $cache_life_time, $data= '', $is_compressed=false)
  Store content in cache.

Detailed Description

Interface for classes that persist cache items.

Author:
Gerd Riesselmann

Definition at line 8 of file icachepersister.cls.php.

Member Function Documentation

ICachePersister::clear ( $  cache_keys = NULL  ) 

Clear the cache.

Parameters:
mixed  $cache_keys A set of key params, may be an array or a string, or an ICachable instance. If NULL, all is cleared

Implemented in CacheDBImpl.

ICachePersister::is_cached ( $  cache_keys  ) 

Returns true, if item is cached.

Parameters:
$cache_keys  mixed A set of key params, may be an array or a string
Returns:
bool

Implemented in CacheDBImpl.

ICachePersister::read ( $  cache_keys  ) 

Read from cache.

Parameters:
Mixed  A set of key params, may be an array or a string
Returns:
ICacheItem False if cache is not found

Implemented in CacheDBImpl.

ICachePersister::remove_expired (  ) 

Removes expired cache entries.

Implemented in CacheDBImpl.

ICachePersister::store ( $  cache_keys,
$  content,
$  cache_life_time,
$  data = '',
$  is_compressed = false  
)

Store content in cache.

Parameters:
mixed  $cache_keys A set of key params, may be an array or a string
string  $content The cache
int  $cache_life_time Cache life time in seconds
mixed  $data Any data assoziated with this item
bool  $is_compressed True, if $content is already gzip compressed

Implemented in CacheDBImpl.

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