Cache_ItemBase
Cache_ItemBase is an abstract class for implementing the key object that must be returned by implementors of the Cache_Engine interface. It provides methods for working with the value associated with its key.
It's worth mentioning the lock and unlock methods of this class. Both methods must be implemented, but they do not need to do anything if the associated engine does not support key-level locking. That is to say, derived classes do not need to override these methods if they do not implement locking. Similarly mtime() does not need to be overridden if it is not appropriate. See that method's documentation for more details.
Located in /cache/lib/Cache/ItemBase.php (line 20)
| Class | Description |
|---|---|
Cache_Engine_Apc_Item
|
The key object for the apc cache engine. |
|
Cache_Engine_File_Item
|
The key object for the file cache engine. |
|
Cache_Engine_Memcache_Item
|
The key object for the memcache cache engine. |
|
Cache_Engine_Memory_Item
|
The key object for the memory cache engine. |
Constructor __construct (line 33)
Constructor
- string $key: The item's key
- Cache_Engine_Apc_Item::__construct() : Constructor
- Cache_Engine_File_Item::__construct() : Constructor
- Cache_Engine_Memcache_Item::__construct() : Constructor
- Cache_Engine_Memory_Item::__construct() : Constructor
exists (line 82)
Test for the existence of the key in the cache. Return true if it exists, false otherwise.
- Cache_Engine_Apc_Item::exists() : Test for the existence of the key in the cache. Return true if it exists, false otherwise.
- Cache_Engine_File_Item::exists() : Test for the existence of the key in the cache. Return true if it exists, false otherwise.
- Cache_Engine_Memcache_Item::exists() : Test for the existence of the key in the cache. Return true if it exists, false otherwise.
- Cache_Engine_Memory_Item::exists() : Test for the existence of the key in the cache. Return true if it exists, false otherwise.
key (line 42)
Returns this item's key
lock (line 66)
Acquire a lock on the key. The method is expected to block until the lock is acquired.
As mentioned in the documentation for the class, this method does not need to acquire a lock if the engine does not support it. In that case it should simply return (this is the default implementation).
For engines that implement locking, the create flag may affect the behavior of this method. When the create flag is false, it indicates that the key will not be created if it does not already exist (as in the case of testing for the existence of a key). In this case, it is permissible to not actually lock the key if it does not exist (for example, if in order to lock the key it must first be created). If the create flag is true, engines supporting locking must lock the key and should create the key at this time if needed.
- int $type: The lock type, either LOCK_READ or LOCK_WRITE
- boolean $create: The flag indicating whether to create the key or not (see above)
- Cache_Engine_File_Item::lock() : Acquire a lock on the key. The method blocks until the lock is acquired.
marshall (line 127)
Given any value, returns a string representation of that value, serializing the value if necessary. This is convenient for preparing a value for storage for some engines.
- mixed $value: The data to marshall
mtime (line 93)
Return the last modified time (as a Unix timestamp) of the value
associated with the key. This is used for testing TTL expiration when the underlying engine does not handle it automatically. If the underlying engine handles TTL itself, simply return false. The default implementation always returns false.
- Cache_Engine_File_Item::mtime() : Return the last modified time (as a Unix timestamp) of the value associated with the key.
read (line 105)
Return the value associated with the key from the cache
If the key does not have a value, this function must return null and it must not produce an exception.
- Cache_Engine_Apc_Item::read() : Return the value associated with the key from the cache
- Cache_Engine_File_Item::read() : Return the value associated with the key from the cache
- Cache_Engine_Memcache_Item::read() : Return the value associated with the key from the cache
- Cache_Engine_Memory_Item::read() : Return the value associated with the key from the cache
remove (line 117)
Remove the key from the cache
- Cache_Engine_Apc_Item::remove() : Remove the key from the cache
- Cache_Engine_File_Item::remove() : Remove the key from the cache
- Cache_Engine_Memcache_Item::remove() : Remove the key from the cache
- Cache_Engine_Memory_Item::remove() : Remove the key from the cache
unlock (line 73)
Release any acquired lock for the key. As with lock(), this function should merely return (the default) if locking is not supported.
- Cache_Engine_File_Item::unlock() : Release any acquired lock for the key.
unmarshall (line 142)
This is the inverse of marshall(). Given a string value returned by marshall, returns the original value.
- mixed $value: The data to marshall
write (line 112)
Set the value associated with the key
- mixed $data: The value to associate with the key
- Cache_Engine_Apc_Item::write() : Set the value associated with the key
- Cache_Engine_File_Item::write() : Set the value associated with the key
- Cache_Engine_Memcache_Item::write() : Set the value associated with the key
- Cache_Engine_Memory_Item::write() : Set the value associated with the key
Documentation generated on Wed, 25 Apr 2012 09:46:43 -0700 by phpDocumentor 1.4.3