Docs For Class atkCache

Home

Documentation home

Atk index

Docs For Class atkCache [ package: atk ]

Class: atkCache

Source Location: /cache/class.atkcache.inc

Class atkCache

Class Overview

Implements interfaces:

ArrayAccess (internal interface)

This file is part of the Achievo ATK distribution.

Detailed copyright and licensing information can be found in the doc/COPYRIGHT and doc/LICENSE files which should be included in the distribution.

Base class for all caching systems that atk supports

Located in /cache/class.atkcache.inc [line 20]

Wiki documentation

Author(s):

Sandy Pleyte <sandy@achievo.org>

API Tags:

Abstract:

Information Tags:

Version:	$Revision: 6309 $ $Id: class.atkcache.inc 6354 2009-04-15 02:41:21Z mvdam $
Copyright:	(c)2008 Sandy Pleyte
License:	ATK Open Source License

Properties

Methods

[ Top ]

Descendants

Child Class	Description
atkCache_apc	This file is part of the Achievo ATK distribution.
atkCache_eaccelerator	This file is part of the Achievo ATK distribution.
atkCache_file	This file is part of the Achievo ATK distribution.
atkCache_memcache	This file is part of the Achievo ATK distribution.
atkCache_var	This file is part of the Achievo ATK distribution.
atkCache_xcache	This file is part of the Achievo ATK distribution.
atkCache_zp_disk	This file is part of the Achievo ATK distribution.
atkCache_zp_output	This file is part of the Achievo ATK distribution.
atkCache_zp_shm	This file is part of the Achievo ATK distribution.

[ Top ]

Property Summary

static array	$m_instances	All cache instances
bool	$m_active	Is the cache still active.
int	$m_lifetime	Lifetime of each cache entry in seconds.
string	$m_namespace	Namespace so atkCache can also be used on shared hosts

[ Top ]

Method Summary

static object atkCache	getInstance()	Get atkCache instance, default when no type is configured it will use var cache.
atkCache	__construct()	Private Constructor so we can only have
boolean	add()	Add cache entry if it not exists allready
void	delete()	delete cache entry
void	deleteAll()	Deletes all cache entries
mixed	get()	get cache entry by key
mixed	getCacheConfig()	Get config values from the cache config
string	getClassname()	Get Classname
int	getLifetime()	Get lifetime of the ache
unknown	getNamespace()	Return current namespace that the cache is using
string	getRealKey()	Get realkey for the cache entry
string	getType()	Get Current cache type
unknown	isActive()	is cache active
boolean	offsetExists()	Whether the offset exists
mixed	offsetGet()	Value at given offset
boolean	offsetSet()	Set value for given offset
void	offsetUnset()	Unset value for given offset
True	set()	Set cache entry, if it not exists then add it to the cache
void	setActive()	Turn cache on/off
void	setLifetime()	Set the lifetime in seconds for the cache
void	setNamespace()	Set the namespace for the current cache

[ Top ]

Properties

static array $m_instances = array() [line 26]

All cache instances

API Tags:

Access:

private

[ Top ]

bool $m_active = true [line 32]

Is the cache still active.

API Tags:

Access:

protected

[ Top ]

int $m_lifetime = 3600 [line 38]

Lifetime of each cache entry in seconds.

API Tags:

Access:

protected

[ Top ]

string $m_namespace = "default" [line 44]

Namespace so atkCache can also be used on shared hosts

API Tags:

Access:

protected

Redefined in descendants as:

atkCache_zp_shm::$m_namespace

[ Top ]

Methods

static method getInstance [line 61]

static object atkCache getInstance(
[string
$types = ""] 
)

Get atkCache instance, default when no type is configured it will use var cache.

Parameters:

string

$types:

Cache type

API Tags:

Return:	object of the request type
Access:	public

[ Top ]

Constructor __construct [line 52]

atkCache __construct(
)

Private Constructor so we can only have

once instance of each cache

API Tags:

Access:

private

Redefined in descendants as:

atkCache_apc::__construct() : constructor
atkCache_eaccelerator::__construct() : constructor
atkCache_file::__construct() : Constructor
atkCache_memcache::__construct() : Constructor
atkCache_var::__construct() : constructor
atkCache_xcache::__construct() : constructor
atkCache_zp_disk::__construct() : constructor
atkCache_zp_output::__construct() : constructor
atkCache_zp_shm::__construct() : constructor

[ Top ]

add [line 215]

boolean add(
string
$key, mixed
$data, [int
$lifetime = false] 
)

Add cache entry if it not exists allready

Parameters:

string	$key:	Entry Id
mixed	$data:	The data we want to add
int	$lifetime:	give a specific lifetime for this cache entry. When $lifetime is false the default lifetime is used.

API Tags:

Return:	True on success, false on failure.
Abstract:
Access:	public

Redefined in descendants as:

atkCache_apc::add() : Inserts cache entry data, but only if the entry does not already exist.
atkCache_eaccelerator::add() : Inserts cache entry data, but only if the entry does not already exist.
atkCache_file::add() : Inserts cache entry data, but only if the entry does not already exist.
atkCache_memcache::add() : Inserts cache entry data, but only if the entry does not already exist.
atkCache_var::add() : Inserts cache entry data, but only if the entry does not already exist.
atkCache_xcache::add() : Inserts cache entry data, but only if the entry does not already exist.
atkCache_zp_disk::add() : Inserts cache entry data, but only if the entry does not already exist.
atkCache_zp_output::add() : Inserts cache entry data, but only if the entry does not already exist.
atkCache_zp_shm::add() : Inserts cache entry data, but only if the entry does not already exist.

[ Top ]

delete [line 242]

void delete(
string
$key 
)

delete cache entry

Parameters:

string

$key:

Entry ID

API Tags:

Abstract:
Access:	public

Redefined in descendants as:

atkCache_apc::delete() : Deletes a cache entry.
atkCache_eaccelerator::delete() : Deletes a cache entry.
atkCache_file::delete() : Deletes all cache entries
atkCache_memcache::delete() : Deletes a cache entry.
atkCache_var::delete() : Deletes a cache entry.
atkCache_xcache::delete() : Deletes a cache entry.
atkCache_zp_disk::delete() : Deletes a cache entry.
atkCache_zp_output::delete() : Deletes a cache entry.
atkCache_zp_shm::delete() : Deletes a cache entry.

[ Top ]

deleteAll [line 248]

void deleteAll(
)

Deletes all cache entries

API Tags:

Abstract:
Access:	public

Redefined in descendants as:

atkCache_apc::deleteAll() : Removes all cache entries.
atkCache_eaccelerator::deleteAll() : Removes all cache entries.
atkCache_file::deleteAll() : Removes all cache entries for the current namespace
atkCache_memcache::deleteAll() : Removes all cache entries.
atkCache_var::deleteAll() : Removes all cache entries.
atkCache_xcache::deleteAll() : Removes all cache entries.
atkCache_zp_disk::deleteAll() : Removes all cache entries.
atkCache_zp_output::deleteAll() : Removes all cache entries.
atkCache_zp_shm::deleteAll() : Removes all cache entries.

[ Top ]

get [line 234]

mixed get(
string
$key 
)

get cache entry by key

Parameters:

string

$key:

Entry id

API Tags:

Return:	Boolean false on failure, cache data on success.
Abstract:
Access:	public

Redefined in descendants as:

atkCache_apc::get() : Gets cache entry data.
atkCache_eaccelerator::get() : Gets cache entry data.
atkCache_file::get() : Gets cache entry data.
atkCache_memcache::get() : Gets cache entry data.
atkCache_var::get() : Gets cache entry data.
atkCache_xcache::get() : Gets cache entry data.
atkCache_zp_disk::get() : Gets cache entry data.
atkCache_zp_output::get() : Gets cache entry data.
atkCache_zp_shm::get() : Gets cache entry data.

[ Top ]

getCacheConfig [line 110]

mixed getCacheConfig(
string
$key, [mixed
$default = ""] 
)

Get config values from the cache config

Parameters:

string	$key:	Key
mixed	$default:	Default value

API Tags:

Access:

public

[ Top ]

getClassname [line 133]

string getClassname(
string
$type 
)

Get Classname

Parameters:

string

$type:

Cache type

API Tags:

Return:	Classname of the cache type
Access:	private

[ Top ]

getLifetime [line 201]

int getLifetime(
)

Get lifetime of the ache

API Tags:

Return:	The cache lifetime
Access:	public

[ Top ]

getNamespace [line 180]

unknown getNamespace(
)

Return current namespace that the cache is using

API Tags:

Access:

public

[ Top ]

getRealKey [line 256]

string getRealKey(
string
$key 
)

Get realkey for the cache entry

Parameters:

string

$key:

Entry ID

API Tags:

Return:	The real entry id
Access:	public

Redefined in descendants as:

atkCache_file::getRealKey() : Get realkey for the cache entry

[ Top ]

getType [line 266]

string getType(
)

Get Current cache type

API Tags:

Return:	Current cache
Access:	public

Redefined in descendants as:

atkCache_apc::getType() : Get the current cache type
atkCache_eaccelerator::getType() : Get Current cache type
atkCache_file::getType() : Get the current cache type
atkCache_memcache::getType() : Get the current cache type
atkCache_var::getType() : Get the current cache type
atkCache_xcache::getType() : Get the current cache type
atkCache_zp_disk::getType() : Get the current cache type
atkCache_zp_output::getType() : Get the current cache type
atkCache_zp_shm::getType() : Get the current cache type

[ Top ]

isActive [line 160]

unknown isActive(
)

is cache active

API Tags:

Access:

public

[ Top ]

offsetExists [line 282]

boolean offsetExists(
string
$offset 
)

Whether the offset exists

Parameters:

string

$offset:

Key to check

Implementation of:

ArrayAccess::offsetExists

[ Top ]

offsetGet [line 293]

mixed offsetGet(
string
$offset 
)

Value at given offset

Parameters:

string

$offset:

Key to get

Implementation of:

ArrayAccess::offsetGet

[ Top ]

offsetSet [line 305]

boolean offsetSet(
string
$offset, mixed
$value 
)

Set value for given offset

Parameters:

string	$offset:	Key to set
mixed	$value:	Value for key

Implementation of:

ArrayAccess::offsetSet

[ Top ]

offsetUnset [line 316]

void offsetUnset(
string
$offset 
)

Unset value for given offset

Parameters:

string

$offset:

Key to unset

Implementation of:

ArrayAccess::offsetUnset

[ Top ]

set [line 226]

True set(
string
$key, mixed
$data, [int
$lifetime = false] 
)

Set cache entry, if it not exists then add it to the cache

Parameters:

string	$key:	Entry ID
mixed	$data:	The data we want to set
int	$lifetime:	give a specific lifetime for this cache entry. When $lifetime is false the default lifetime is used.

API Tags:

Return:	on success, false on failure.
Abstract:
Access:	public

Redefined in descendants as:

atkCache_apc::set() : Sets cache entry data.
atkCache_eaccelerator::set() : Sets cache entry data.
atkCache_file::set() : Sets cache entry data.
atkCache_memcache::set() : Sets cache entry data.
atkCache_var::set() : Sets cache entry data.
atkCache_xcache::set() : Sets cache entry data.
atkCache_zp_disk::set() : Sets cache entry data.
atkCache_zp_output::set() : Sets cache entry data.
atkCache_zp_shm::set() : Sets cache entry data.

[ Top ]

setActive [line 150]

void setActive(
boolean
$flag 
)

Turn cache on/off

Parameters:

boolean

$flag:

Set cache active or not active

API Tags:

Access:

public

[ Top ]

setLifetime [line 190]

void setLifetime(
int
$lifetime 
)

Set the lifetime in seconds for the cache

Parameters:

int

$lifetime:

Set the lifetime in seconds

API Tags:

Access:

public

[ Top ]

setNamespace [line 170]

void setNamespace(
string
$namespace 
)

Set the namespace for the current cache

Parameters:

string

$namespace:

API Tags:

Access:

public

Redefined in descendants as:

atkCache_file::setNamespace() : Set the namespace for the current cache

[ Top ]