Docs For Class AwlCache

## AwlCache

Description

A simple Memcached wrapper supporting namespacing of stored values.

- author: Andrew McMillan
- license: LGPL

Located in /AwlCache.php (line 10)

Method Summary
AwlCache __construct ()
void acquireLock ( $something, [ $wait_for = 5])
void delete ($namespace $namespace, $key $key)
void flush ()
void get ($namespace $namespace, $key $key)
void isActive ()
void releaseLock ( $locker)
void set ($namespace $namespace, $key $key, $value $value, [$expiry $expiry = 864000])
Methods
Constructor __construct (line 18)

Initialise the cache connection. We use getpid() to give us a persistent connection.

AwlCache __construct ()
acquireLock (line 147)

Acquire a lock on something

void acquireLock ( $something, [ $wait_for = 5])

- $something
- $wait_for

delete (line 116)

Delete a value from a namespace/key, or for everything in a namespace if a 'null' key is supplied.

void delete ($namespace $namespace, $key $key)

- $namespace $namespace
- $key $key

flush (line 137)

Flush the entire cache

void flush ()
get (line 66)

get a value from the specified namespace / key

void get ($namespace $namespace, $key $key)

- $namespace $namespace
- $key $key

isActive (line 48)

So we can find out if we are actually using the cache.

void isActive ()
releaseLock (line 160)

Release a lock

void releaseLock ( $locker)

- $locker

set (line 82)

Set a value for the specified namespace/key, perhaps with an expiry (default 10 days)

void set ($namespace $namespace, $key $key, $value $value, [$expiry $expiry = 864000])

- $namespace $namespace
- $key $key
- $value $value
- $expiry $expiry

Documentation generated on Fri, 13 Jan 2012 23:40:12 +1300 by phpDocumentor 1.4.3