[cache] element index

Package indexes

All elements
a b c e f g h i k l m o p r s t u v w _
_
top
Method __construct
Cache_Store::__construct() in Store.php
Constructor
Method __construct
Cache_Engine_Memcache_Item::__construct() in Memcache.php
Constructor
Method __construct
Cache_Provider::__construct() in Provider.php
Constructor
Method __construct
Cache_ItemBase::__construct() in ItemBase.php
Constructor
Method __construct
Cache_Engine_File_Item::__construct() in File.php
Constructor
Method __construct
Cache_Engine_Apc_Item::__construct() in Apc.php
Constructor
Method __construct
Cache_UnsupportedEngineError::__construct() in UnsupportedEngineError.php
Method __construct
Cache_Engine_Memory_Item::__construct() in Memory.php
Constructor
Method __constructor
Cache_Engine_Memcache::__constructor() in Memcache.php
Constructor
Method __constructor
Cache_Engine_File::__constructor() in File.php
Constructor
Method __constructor
Cache_Engine_Apc::__constructor() in Apc.php
Constructor
Method __constructor
Cache_Engine_Memory::__constructor() in Memory.php
Constructor
a
top
Page Apc.php
Apc.php in Apc.php
b
top
Page block.cache.php
block.cache.php in block.cache.php
c
top
Variable $cache
Cache_Engine_Memory::$cache in Memory.php
Variable $cache
Cache_Engine_Memory_Item::$cache in Memory.php
Variable $cacheStore
Cache_Provider::$cacheStore in Provider.php
Method cache_directory
Cache_Engine_File::cache_directory() in File.php
Returns the name of the cache directory to use for a given set of options
Class Cache_Engine
Cache_Engine in Engine.php
Cache_Engine defines the interface that cache implementations must conform to.
Class Cache_Engine_Apc
Cache_Engine_Apc in Apc.php
The APC cache engine. This engine requires the APC extension to be installed. Items stored with the APC engine use the APC-provided variable cache mechanism for storage.
Class Cache_Engine_Apc_Item
Cache_Engine_Apc_Item in Apc.php
The key object for the apc cache engine.
Class Cache_Engine_File
Cache_Engine_File in File.php
The file system cache engine. Items stored in the file system cache are each stored in separate files and persist between requests. They are dependent on the default expiration mechanism of Cache_Store to clean up unused files.
Class Cache_Engine_File_Item
Cache_Engine_File_Item in File.php
The key object for the file cache engine.
Class Cache_Engine_Memcache
Cache_Engine_Memcache in Memcache.php
The memcache cache engine. This engine requires the Memcache extension to be installed. Items stored with the memcache engine use memcached for storage.
Class Cache_Engine_Memcache_Item
Cache_Engine_Memcache_Item in Memcache.php
The key object for the memcache cache engine.
Class Cache_Engine_Memory
Cache_Engine_Memory in Memory.php
The in-memory cache engine. Items stored in the in-memory cache are lost at the end of the current request.
Class Cache_Engine_Memory_Item
Cache_Engine_Memory_Item in Memory.php
The key object for the memory cache engine.
Method cache_file_path
Cache_Engine_File::cache_file_path() in File.php
Returns the full cache file path for a given set of options and keys
Class Cache_ItemBase
Cache_ItemBase in ItemBase.php
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.
Class Cache_Provider
Cache_Provider in Provider.php
A cache store provider for use with Support_Resources
Class Cache_Store
Cache_Store in Store.php
Cache_Store provides the public interface for working with the cache system. Internally it uses one or more engines to service requests.
Class Cache_UnsupportedEngineError
Cache_UnsupportedEngineError in UnsupportedEngineError.php
Indicates a request for an unsupported cache engine
Method cleanup
Cache_Engine_File::cleanup() in File.php
Clean up locks at shutdown
Method clear
Cache_Store::clear() in Store.php
Remove all items from the cache.
Method clear
Cache_Engine_Apc::clear() in Apc.php
Clear all items from the cache
Method clear
Cache_Engine_Memory::clear() in Memory.php
Clear all items from the cache
Method clear
Cache_Engine_Memcache::clear() in Memcache.php
Clear all items from the cache
Method clear
Cache_Engine_File::clear() in File.php
Clear all items from the cache
Method clear
Cache_Engine::clear() in Engine.php
Clear all items from the cache
Method conditionally_remove
Cache_Store::conditionally_remove() in Store.php
Conditionally removes an item based on it being unchanged
e
top
Variable $engine
Cache_Engine_Apc_Item::$engine in Apc.php
Variable $engine
Cache_Engine_File_Item::$engine in File.php
Variable $engine
Cache_Engine_Memcache_Item::$engine in Memcache.php
Variable $engines
Cache_Store::$engines in Store.php
Page Engine.php
Engine.php in Engine.php
Method engine
Cache_Store::engine() in Store.php
Return the engine specified in the options.
Method escape_file_character
Cache_Engine_File::escape_file_character() in File.php
Escape a value for use in a filename
Method exists
Cache_Store::exists() in Store.php
Test for the existence of key in the cache.
Method exists
Cache_Engine_Memory_Item::exists() in Memory.php
Test for the existence of the key in the cache. Return true if it exists, false otherwise.
Method exists
Cache_Engine_Memcache_Item::exists() in Memcache.php
Test for the existence of the key in the cache. Return true if it exists, false otherwise.
Method exists
Cache_Engine_File_Item::exists() in File.php
Test for the existence of the key in the cache. Return true if it exists, false otherwise.
Method exists
Cache_ItemBase::exists() in ItemBase.php
Test for the existence of the key in the cache. Return true if it exists, false otherwise.
Method exists
Cache_Engine_Apc_Item::exists() in Apc.php
Test for the existence of the key in the cache. Return true if it exists, false otherwise.
Method expire
Cache_Store::expire() in Store.php
Remove key and its data from the cache.
Method expire_value
Cache_Engine_Memcache_Item::expire_value() in Memcache.php
Returns the expire time value to use for calls to memcache
f
top
Page File.php
File.php in File.php
Class Constant FILE_SAMPLE_SIZE
Cache_Engine_File::FILE_SAMPLE_SIZE in File.php
g
top
Method get
Cache_Provider::get() in Provider.php
Return a cache store instance.
Method get
Cache_Store::get() in Store.php
Return the value for key.
Method get_connection_options
Cache_Engine_Memcache::get_connection_options() in Memcache.php
Return host and port connection values for a given set of options
Method get_memcache
Cache_Engine_Memcache::get_memcache() in Memcache.php
Returns the Memcache instance for a given set of options
Method get_server_description
Cache_Engine_Memcache::get_server_description() in Memcache.php
Returns the server description for a given set of options
h
top
Method has_locking
Cache_Engine_Memory::has_locking() in Memory.php
Returns false to indicate this engine's items do not provide locking
Method has_locking
Cache_Engine_Memcache::has_locking() in Memcache.php
Returns false to indicate this engine's item do not provide locking
Method has_locking
Cache_Engine_File::has_locking() in File.php
Returns true to indicate this engine's items provide locking
Method has_locking
Cache_Engine::has_locking() in Engine.php
Return true if this Engine's items provide locking
Method has_locking
Cache_Engine_Apc::has_locking() in Apc.php
Returns false to indicate this engine's item do not provide locking
i
top
Page Init.php
Init.php in Init.php
Page ItemBase.php
ItemBase.php in ItemBase.php
Method is_supported
Cache_Engine_Memcache::is_supported() in Memcache.php
Called statically to ensure this engine is supported before constructing it. The memcache engine is only supported when the memcache extension is also present.
Method is_supported
Cache_Engine_Memory::is_supported() in Memory.php
Called statically to ensure this engine is supported before constructing it. The memory engine is always supported.
Method is_supported
Cache_Engine_Apc::is_supported() in Apc.php
Called statically to ensure this engine is supported before constructing it. The apc engine is only supported when the APC extension is also present.
Method is_supported
Cache_Engine::is_supported() in Engine.php
Called statically to ensure this engine is supported before constructing it. Most engines will want to always return true, but in some cases it may be a good place to check that all needed extensions are present.
Method is_supported
Cache_Engine_File::is_supported() in File.php
Called statically to ensure this engine is supported before constructing it. The file engine is always supported.
Method is_valid
Cache_Store::is_valid() in Store.php
Tests if an item is considered valid (has not yet expired)
Method item_for_key
Cache_Engine_Memory::item_for_key() in Memory.php
Return the cache item object for the provided key.
Method item_for_key
Cache_Engine::item_for_key() in Engine.php
Return the cache item object for the provided key.
Method item_for_key
Cache_Engine_Apc::item_for_key() in Apc.php
Return the cache item object for the provided key.
Method item_for_key
Cache_Engine_File::item_for_key() in File.php
Return the cache item object for the provided key.
Method item_for_key
Cache_Engine_Memcache::item_for_key() in Memcache.php
Return the cache item object for the provided key.
k
top
Variable $key
Cache_ItemBase::$key in ItemBase.php
Method key
Cache_ItemBase::key() in ItemBase.php
Returns this item's key
Method key_value
Cache_Store::key_value() in Store.php
Returns a clean key value
l
top
Variable $lock
Cache_Engine_File_Item::$lock in File.php
Variable $lockCount
Cache_Engine_File::$lockCount in File.php
Variable $locked
Cache_Engine_File_Item::$locked in File.php
Variable $locks
Cache_Engine_File::$locks in File.php
Variable $logger
Cache_Engine_Apc::$logger in Apc.php
Variable $logger
Cache_Engine_Memcache::$logger in Memcache.php
Variable $logger
Cache_Store::$logger in Store.php
Variable $logger
Cache_Engine_File::$logger in File.php
Method lock
Cache_ItemBase::lock() in ItemBase.php
Acquire a lock on the key. The method is expected to block until the lock is acquired.
Method lock
Cache_Engine_File_Item::lock() in File.php
Acquire a lock on the key. The method blocks until the lock is acquired.
Class Constant LOCK_READ
Cache_ItemBase::LOCK_READ in ItemBase.php
A read, or shared lock type
Class Constant LOCK_WRITE
Cache_ItemBase::LOCK_WRITE in ItemBase.php
A write, or exclusive lock type
Method logger
Cache_Store::logger() in Store.php
Return a logger instance
Method logger
Cache_Engine_File::logger() in File.php
Return a logger instance for the class
Method logger
Cache_Engine_Apc::logger() in Apc.php
Return a logger instance for the class
Method logger
Cache_Engine_Memcache::logger() in Memcache.php
Return a logger instance for the class
m
top
Variable $memcaches
Cache_Engine_Memcache::$memcaches in Memcache.php
Page Memcache.php
Memcache.php in Memcache.php
Page Memory.php
Memory.php in Memory.php
Method make_directory
Cache_Engine_File_Item::make_directory() in File.php
Creates a directory (and any parent directories) as needed
Method marshall
Cache_ItemBase::marshall() in ItemBase.php
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.
Class Constant MAX_FILENAME
Cache_Engine_File::MAX_FILENAME in File.php
Method mtime
Cache_Engine_File_Item::mtime() in File.php
Return the last modified time (as a Unix timestamp) of the value associated with the key.
Method mtime
Cache_ItemBase::mtime() in ItemBase.php
Return the last modified time (as a Unix timestamp) of the value
o
top
Variable $options
Cache_Engine_Memcache_Item::$options in Memcache.php
Variable $options
Cache_Engine_File_Item::$options in File.php
Variable $options
Cache_Engine_Apc_Item::$options in Apc.php
p
top
Page Provider.php
Provider.php in Provider.php
r
top
Method read
Cache_Engine_Memcache_Item::read() in Memcache.php
Return the value associated with the key from the cache
Method read
Cache_Engine_Memory_Item::read() in Memory.php
Return the value associated with the key from the cache
Method read
Cache_Engine_Apc_Item::read() in Apc.php
Return the value associated with the key from the cache
Method read
Cache_ItemBase::read() in ItemBase.php
Return the value associated with the key from the cache
Method read
Cache_Engine_File_Item::read() in File.php
Return the value associated with the key from the cache
Method register_lock
Cache_Engine_File::register_lock() in File.php
Register a lock for cleanup at shutdown
Method remove
Cache_Engine_Memory_Item::remove() in Memory.php
Remove the key from the cache
Method remove
Cache_Engine_Apc_Item::remove() in Apc.php
Remove the key from the cache
Method remove
Cache_Engine_Memcache_Item::remove() in Memcache.php
Remove the key from the cache
Method remove
Cache_Engine_File_Item::remove() in File.php
Remove the key from the cache
Method remove
Cache_ItemBase::remove() in ItemBase.php
Remove the key from the cache
s
top
Page Store.php
Store.php in Store.php
Method safe_file_name
Cache_Engine_File::safe_file_name() in File.php
Sanitize a string value for use as a filename
Method set
Cache_Store::set() in Store.php
Store a value for key.
Function smarty_block_cache
smarty_block_cache() in block.cache.php
cache Smarty function
t
top
Variable $token
Cache_Engine_File_Item::$token in File.php
u
top
Page UnsupportedEngineError.php
UnsupportedEngineError.php in UnsupportedEngineError.php
Method unlock
Cache_ItemBase::unlock() in ItemBase.php
Release any acquired lock for the key. As with lock(), this function should merely return (the default) if locking is not supported.
Method unlock
Cache_Engine_File_Item::unlock() in File.php
Release any acquired lock for the key.
Method unmarshall
Cache_ItemBase::unmarshall() in ItemBase.php
This is the inverse of marshall(). Given a string value returned by marshall, returns the original value.
Method unregister_lock
Cache_Engine_File::unregister_lock() in File.php
Unregister a released lock passed to register_lock()
v
top
Method valid_options
Cache_Store::valid_options() in Store.php
Return the correct set of options to use for a provided options argument
w
top
Method write
Cache_Engine_Memory_Item::write() in Memory.php
Set the value associated with the key
Method write
Cache_Engine_Memcache_Item::write() in Memcache.php
Set the value associated with the key
Method write
Cache_ItemBase::write() in ItemBase.php
Set the value associated with the key
Method write
Cache_Engine_File_Item::write() in File.php
Set the value associated with the key
Method write
Cache_Engine_Apc_Item::write() in Apc.php
Set the value associated with the key
a b c e f g h i k l m o p r s t u v w _