Class Cache_Engine_Memcache_Item

Description

The key object for the memcache cache engine.

Located in /cache/lib/Cache/Engine/Memcache.php (line 146)

Cache_ItemBase
   |
   --Cache_Engine_Memcache_Item
Variable Summary
 mixed $engine
 mixed $options
Method Summary
 Cache_Engine_Memcache_Item __construct ( $engine,  $key,  $options)
 boolean exists ()
 void expire_value ( $ttl)
 mixed read ()
 void remove ()
 void write (mixed $data)
Variables
mixed $engine (line 147)
  • access: protected
mixed $options (line 148)
  • access: protected

Inherited Variables

Inherited from Cache_ItemBase

Cache_ItemBase::$key
Methods
Constructor __construct (line 153)

Constructor

  • access: public
Cache_Engine_Memcache_Item __construct ( $engine,  $key,  $options)
  • $engine
  • $key
  • $options

Redefinition of:
Cache_ItemBase::__construct()
Constructor
exists (line 166)

Test for the existence of the key in the cache. Return true if it exists, false otherwise.

  • access: public
boolean exists ()

Redefinition of:
Cache_ItemBase::exists()
Test for the existence of the key in the cache. Return true if it exists, false otherwise.
expire_value (line 235)

Returns the expire time value to use for calls to memcache

  • access: protected
void expire_value ( $ttl)
  • $ttl
read (line 185)

Return the value associated with the key from the cache

If the key does not have a value, this function returns null.

  • access: public
mixed read ()

Redefinition of:
Cache_ItemBase::read()
Return the value associated with the key from the cache
remove (line 222)

Remove the key from the cache

  • access: public
void remove ()

Redefinition of:
Cache_ItemBase::remove()
Remove the key from the cache
write (line 202)

Set the value associated with the key

  • access: public
void write (mixed $data)
  • mixed $data: The value to associate with the key

Redefinition of:
Cache_ItemBase::write()
Set the value associated with the key

Inherited Methods

Inherited From Cache_ItemBase

 Cache_ItemBase::__construct()
 Cache_ItemBase::exists()
 Cache_ItemBase::key()
 Cache_ItemBase::lock()
 Cache_ItemBase::marshall()
 Cache_ItemBase::mtime()
 Cache_ItemBase::read()
 Cache_ItemBase::remove()
 Cache_ItemBase::unlock()
 Cache_ItemBase::unmarshall()
 Cache_ItemBase::write()
Class Constants

Documentation generated on Wed, 25 Apr 2012 09:46:43 -0700 by phpDocumentor 1.4.3