• Home
• Gdn_Cache

PHP Class Gdn_Cache, vanilla

All cache objects should extend this to ensure a consistent public api for caching. ファイルを表示 Open project: vanilla/vanilla Class Usage Examples

Public Properties

Property	Type	Description
$trace	boolean
$trackGet	array
$trackGets	integer
$trackSet	array
$trackSets	integer
$trackTime	integer

Protected Properties

Property	Type	Description
$cacheType		Type of cache this this: one of CACHE_TYPE_MEMORY, CACHE_TYPE_FILE, CACHE_TYPE_NULL.
$containers		List of cache containers.
$features		List of features this cache system supports.
$localCache		Local in-memory cache of fetched data. This prevents duplicate gets to memcache.
$stores		Memory copy of store containers.

Public Methods

Method	Description
__construct ( )
activeCache ( ) : string	Gets the short name of the currently active cache.
activeEnabled ( type $ForceEnable = false ) : boolean	Get the status of the active cache.
activeStore ( type $ForceMethod = null ) : mixed	Returns the storage data for the active cache.
add ( string $Key, mixed $Value, array $Options = [] ) : boolean	Add a value to the cache.
addContainer ( array $Options ) : boolean	Add a container to the cache pool.
config ( $Key = null, $Default = null )	* Get the value of a store-specific config
decrement ( string $Key, integer $Amount = 1, $Options = [] ) : integer	Decrement the value of the provided key by {@link $Amount}.
exists ( string $Key ) : array	Check if a value exists in the cache.
fail ( string $server )	Register a temporary server connection failure.
flush ( ) : boolean	Invalidate all items in the cache.
get ( string $Key, array $Options = [] ) : mixed	Retrieve a key's value from the cache.
getPrefix ( $ForcePrefix = null, $WithRevision = true )
getRevision ( $ForcePrefix = null, $Force = false )
hasFeature ( integer $Feature ) : mixed	Check whether this cache supports the specified feature.
increment ( string $Key, integer $Amount = 1, $Options = [] ) : integer	Increment the value of the provided key by {@link $Amount}.
incrementRevision ( )
initialize ( $ForceEnable = false, $ForceMethod = false ) : Gdn_Cache	Determines the currently installed cache solution and returns a fresh instance of its object.
makeKey ( $Key, $Options )
online ( ) : boolean	Is the current cache available?
option ( $Option = null, $Default = null )	* Get the value of a store-specific option.
registerFeature ( integer $Feature, mixed $Meta = true )	Flag this cache as being capable of performing a feature.
remove ( string $Key, array $Options = [] ) : boolean	Remove a key/value pair from the cache.
replace ( string $Key, mixed $Value, array $Options = [] ) : boolean	Replace an existing key's value with the provided value.
store ( string $Key, mixed $Value, array $Options = [] ) : boolean	Store a value in the cache.
stripKey ( $Key, $Options )
trace ( $trace = null )
type ( ) : string	Returns a constant describing the type of cache implementation this object represents.
unregisterFeature ( integer $Feature )	Remove feature flag from this cache, for the specific feature.

Protected Methods

Method	Description
failure ( $Message )
fallback ( string $Key, array $Options ) : mixed
localClear ( )	Clear local cache (process memory cache).
localGet ( $key )
localSet ( $key, $value = null )

Method Details

Property Details