Path

ez components / documentation / api reference / 2008.1 / cache

Cache: ezcCacheStorageApcPlain

[ Tutorial ] [ Class tree ] [ Element index ] [ ChangeLog ] [ Credits ]

Class: ezcCacheStorageApcPlain

This storage implementation stores data in an APC cache. [source]
This storage acan also be used with ezcCacheStack. However, APC version 3.0.16 or newer is required for that.

Parents

ezcCacheStorage
   |
   --ezcCacheStorageMemory
      |
      --ezcCacheStorageApc
         |
         --ezcCacheStorageApcPlain

Inherited Constants

From ezcCacheStorageApc:
ezcCacheStorageApc::BACKEND_NAME    The backend name.
ezcCacheStorageApc::REGISTRY_NAME    The registry name.

Inherited Member Variables

From ezcCacheStorageMemory:
protected  ezcCacheStorageMemory::$backend
protected  ezcCacheStorageMemory::$backendName
protected  ezcCacheStorageMemory::$registry
protected  ezcCacheStorageMemory::$registryName
protected  ezcCacheStorageMemory::$searchRegistry
From ezcCacheStorage:
protected  ezcCacheStorage::$properties

Method Summary

protected mixed fetchData( $identifier, [$object = false] )
Fetches data from the cache.
protected ezcCacheStorageMemoryDataStruct prepareData( $data )
Wraps the data in an ezcCacheStorageMemoryDataStruct structure in order to store it.

Inherited Methods

From ezcCacheStorageApc :
public ezcCacheStorageApc ezcCacheStorageApc::__construct()
Creates a new cache storage in the given location.
protected abstract mixed ezcCacheStorageApc::fetchData()
Fetches data from the cache.
protected abstract mixed ezcCacheStorageApc::prepareData()
Prepares the data for storing.
public void ezcCacheStorageApc::setOptions()
Return the currently set options.
From ezcCacheStorageMemory :
public ezcCacheStorageMemory ezcCacheStorageMemory::__construct()
Creates a new cache storage in the given location.
protected int ezcCacheStorageMemory::calcLifetime()
Calculates the lifetime remaining for a cache object.
public int ezcCacheStorageMemory::countDataItems()
Returns the number of items in the cache matching a certain criteria.
public void ezcCacheStorageMemory::delete()
Deletes the data associated with $id or $attributes from the cache.
protected void ezcCacheStorageMemory::fetchSearchRegistry()
Fetches the search registry from the backend or creates it if empty.
protected string ezcCacheStorageMemory::generateAttrStr()
Generates a string from the $attributes array.
public string ezcCacheStorageMemory::generateIdentifier()
Generates the storage internal identifier from ID and attributes.
public int ezcCacheStorageMemory::getRemainingLifetime()
Returns the time in seconds which remains for a cache object, before it gets outdated. In case the cache object is already outdated or does not exists, this method returns 0.
public void ezcCacheStorageMemory::lock()
Acquire a lock on the storage.
public array(string) ezcCacheStorageMemory::purge()
Purge outdated data from the storage.
protected void ezcCacheStorageMemory::registerIdentifier()
Registers an identifier to facilitate searching.
public void ezcCacheStorageMemory::reset()
Reset the complete storage.
public mixed ezcCacheStorageMemory::restore()
Restores the data from the cache.
public ezcCacheStackMetaData ezcCacheStorageMemory::restoreMetaData()
Restores and returns the meta data struct.
protected array(mixed) ezcCacheStorageMemory::search()
Searches the storage for data defined by ID and/or attributes.
public string ezcCacheStorageMemory::store()
Stores data to the cache storage under the key $id.
public void ezcCacheStorageMemory::storeMetaData()
Stores the given meta data struct.
protected void ezcCacheStorageMemory::storeSearchRegistry()
Stores the search registry in the backend.
public void ezcCacheStorageMemory::unlock()
Release a lock on the storage.
protected void ezcCacheStorageMemory::unRegisterIdentifier()
Un-registers a previously registered identifier.
protected void ezcCacheStorageMemory::validateLocation()
Checks if the location property is valid.
From ezcCacheStorage :
public ezcCacheStorage ezcCacheStorage::__construct()
Creates a new cache storage in the given location.
public abstract int ezcCacheStorage::countDataItems()
Return the number of items in the cache matching a certain criteria.
public abstract void ezcCacheStorage::delete()
Delete data from the cache.
public string ezcCacheStorage::getLocation()
Returns the location.
public ezcCacheStorageOptions ezcCacheStorage::getOptions()
Return the currently set options.
public abstract int ezcCacheStorage::getRemainingLifetime()
Returns the time ( in seconds ) that remains for a cache object, before it gets outdated. In case the cache object is already outdated or does not exists, this method returns 0.
public abstract mixed ezcCacheStorage::restore()
Restore data from the cache.
public void ezcCacheStorage::setOptions()
Set new options.
public abstract string ezcCacheStorage::store()
Store data to the cache storage.
protected abstract void ezcCacheStorage::validateLocation()
Checks if the location property is valid.

Methods

fetchData

mixed fetchData( string $identifier, [bool $object = false] )
Fetches data from the cache.

Parameters

Name Type Description
$identifier string The file to fetch data from
$object bool return the object and not the clean data

Redefinition of

Method Description
ezcCacheStorageApc::fetchData() Fetches data from the cache.

prepareData

ezcCacheStorageMemoryDataStruct prepareData( mixed $data )
Wraps the data in an ezcCacheStorageMemoryDataStruct structure in order to store it.

Parameters

Name Type Description
$data mixed Simple type or array

Throws

ClassDescription
ezcCacheInvalidDataException If the data submitted can not be handled by this storage (resource).

Redefinition of

Method Description
ezcCacheStorageApc::prepareData() Prepares the data for storing.

Last updated: Wed, 18 Jun 2008