• Home
• Pimcore
• Cache

PHP Class Pimcore\Cache

Show file Open project: pimcore/pimcore Class Usage Examples

Public Properties

Property	Type	Description
$cachePrefix	string	prefix which will be added to every item-key
$clearedTagsStack	array	Contains the tags which were already cleared
$defaultLifetime	null
$ignoredTagsOnClear	array	items having one of the tags in this store are not cleared when calling self::clearTags() or self::clearTag()
$instance	Zend_Cache_Core | Zend_Cache_Frontend	Instance of the used cache-implementation
$logger	Logger	Contains the Logger, this is necessary because otherwise logging doesn't work in shutdown (missing reference)
$maxWriteToCacheItems	integer	How many items should stored to the cache within one process
$saveStack	array	Contains the items which should be written to the cache on shutdown. They are ordered respecting the priority

Protected Properties

Property	Type	Description
$_clearTagsOnShutdown	array	Items having tags which are in this array are cleared on shutdown \Pimcore::shutdown(); This is especially for the output-cache
$blackHoleCache	Zend_Cache_Core
$enabled	boolean
$forceImmediateWrite	boolean	if set to truq items are directly written into the cache, and do not get into the queue
$writeLockTimestamp	integer	contains the timestamp of the writeLockTime from the current process this is to recheck when removing the write lock (if the value is different -> higher) do not remove the lock because then another process has acquired a lock

Public Methods

Method	Description
addClearTagOnShutdown ( $tag ) : void	Adds a tag to the shutdown queue, see clearTagsOnShutdown
addClearedTag ( string $tag )
addIgnoredTagOnClear ( $tag ) : void
clearAll ( ) : void	Empty the cache
clearSaveStack ( )
clearTag ( string $tag ) : void	Removes entries from the cache matching the given tag
clearTags ( array $tags = [] ) : void	Removes entries from the cache matching the given tags
clearTagsOnShutdown ( ) : void	Clears all tags stored in self::$_clearTagsOnShutdown, this function is executed in \Pimcore::shutdown()
disable ( ) : void	Disables the complete pimcore cache
enable ( ) : void
getBlackHoleCache ( ) : Zend_Cache_Core | Zend_Cache_Frontend
getDefaultCache ( ) : Zend_Cache_Core | Zend_Cache_Frontend
getDefaultConfig ( string | null $adapter = null ) : array
getForceImmediateWrite ( ) : boolean
getInstance ( ) : Zend_Cache_Core | Zend_Cache_Frontend	Returns a instance of the cache, if the instance isn't available it creates a new one
hasWriteLock ( ) : boolean
init ( )
initializeCache ( $config ) : Zend_Cache_Core | Zend_Cache_Frontend
load ( string $key, $doNotTestCacheValidity = false ) : mixed	Returns the content of the requested cache entry
maintenance ( )
remove ( $key )
removeIgnoredTagOnClear ( $tag ) : void
removeWriteLock ( )
save ( $data, $key, array $tags = [], null $lifetime = null, integer $priority, boolean $force = false ) : boolean | void
setForceImmediateWrite ( boolean $forceImmediateWrite )
setWriteLock ( $force = false )
setZendFrameworkCaches ( null $cache = null )
test ( string $key ) : integer | boolean	Get the last modified time for the requested cache entry
write ( ) : void	Write the stack to the cache

Protected Methods

Method	Description
normalizeConfig ( $config ) : mixed
storeToCache ( $data, $key, array $tags = [], null $lifetime = null, boolean $force = false ) : boolean | void	Write's an item to the cache // don't use the logger inside here

Method Details

Property Details