Docs For Class atkCache

Docs For Class atkCache_var

Home

Documentation home

Atk index

Docs For Class atkCache_var [ package: atk ]

Class: atkCache_var

Source Location: /cache/class.atkcache_var.inc

Class atkCache_var

Class Overview

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.

Cache class for variable (in-memory)

Located in /cache/class.atkcache_var.inc [line 22]

Wiki documentation

atkCache
   |
   --atkCache_var

Author(s):

Sandy Pleyte <sandy@achievo.org>

Information Tags:

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

Properties

Methods

[ Top ]

Inherited from parent

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

Inherited Properties

Inherited Methods

Inherited From atkCache

atkCache::$m_active

atkCache::$m_instances

atkCache::$m_lifetime

atkCache::$m_namespace

Inherited From atkCache

atkCache::__construct()

Private Constructor so we can only have

atkCache::add()

Add cache entry if it not exists allready

atkCache::delete()

delete cache entry

atkCache::deleteAll()

Deletes all cache entries

atkCache::get()

get cache entry by key

atkCache::getCacheConfig()

Get config values from the cache config

atkCache::getClassname()

Get Classname

atkCache::getInstance()

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

atkCache::getLifetime()

Get lifetime of the ache

atkCache::getNamespace()

Return current namespace that the cache is using

atkCache::getRealKey()

Get realkey for the cache entry

atkCache::getType()

Get Current cache type

atkCache::isActive()

is cache active

atkCache::offsetExists()

Whether the offset exists

atkCache::offsetGet()

Value at given offset

atkCache::offsetSet()

Set value for given offset

atkCache::offsetUnset()

Unset value for given offset

atkCache::set()

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

atkCache::setActive()

Turn cache on/off

atkCache::setLifetime()

Set the lifetime in seconds for the cache

atkCache::setNamespace()

Set the namespace for the current cache

[ Top ]

Property Summary

array	$m_entry	Cache entries.
array	$m_expires	Expiration timestamps for each cache entry.

[ Top ]

Method Summary

atkCache_var	__construct()	constructor
bool	add()	Inserts cache entry data, but only if the entry does not already exist.
boolean	delete()	Deletes a cache entry.
boolean	deleteAll()	Removes all cache entries.
mixed	get()	Gets cache entry data.
string	getType()	Get the current cache type
bool	set()	Sets cache entry data.

[ Top ]

Properties

array $m_entry = array() [line 34]

Cache entries.

API Tags:

Access:

protected

[ Top ]

array $m_expires = array() [line 28]

Expiration timestamps for each cache entry.

API Tags:

Access:

protected

[ Top ]

Methods

Constructor __construct [line 40]

atkCache_var __construct(
)

constructor

API Tags:

Access:

public

Redefinition of:

atkCache::__construct(): Private Constructor so we can only have

[ Top ]

add [line 74]

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

Inserts cache entry data, but only if the entry does not already exist.

Parameters:

string	$key:	The entry ID.
mixed	$data:	The data to write into the entry.
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.
Access:	public

Redefinition of:

atkCache::add(): Add cache entry if it not exists allready

[ Top ]

delete [line 124]

boolean delete(
string
$key 
)

Deletes a cache entry.

Parameters:

string

$key:

The entry ID.

API Tags:

Return:	Succes
Access:	public

Redefinition of:

atkCache::delete(): delete cache entry

[ Top ]

deleteAll [line 141]

boolean deleteAll(
)

Removes all cache entries.

API Tags:

Return:	Succes
Access:	public

Redefinition of:

atkCache::deleteAll(): Deletes all cache entries

[ Top ]

get [line 97]

mixed get(
string
$key 
)

Gets cache entry data.

Parameters:

string

$key:

The entry ID.

API Tags:

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

Redefinition of:

atkCache::get(): get cache entry by key

[ Top ]

getType [line 157]

string getType(
)

Get the current cache type

API Tags:

Return:	atkConfig type
Access:	public

Redefinition of:

atkCache::getType(): Get Current cache type

[ Top ]

set [line 53]

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

Sets cache entry data.

Parameters:

string	$key:	The entry ID.
mixed	$data:	The data to write into the entry.
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.
Access:	public

Redefinition of:

atkCache::set(): Set cache entry, if it not exists then add it to the cache

[ Top ]