Property | Type | Description | |
---|---|---|---|
$baseDirectory | string | If not given this will be determined by the EnvironmentConfiguration | |
$cacheDirectory | string | Directory where the files are stored. | |
$cacheEntryFileExtension | string | A file extension to use for each cache entry. | |
$cacheEntryIdentifiers | array | ||
$cacheFilesIterator | DirectoryIterator | ||
$frozen | boolean | ||
$useIgBinary | boolean | Caching the result of extension_loaded() here is faster than calling extension_loaded() multiple times. |
Method | Description | |
---|---|---|
__construct ( |
||
collectGarbage ( ) : void | Not necessary | |
current ( ) : mixed | Returns the data of the current cache entry pointed to by the cache entry iterator. | |
flush ( ) : void | Removes all cache entries of this cache. | |
get ( string $entryIdentifier ) : mixed | Loads data from a cache file. | |
getBaseDirectory ( ) : string | ||
getCacheDirectory ( ) : string | Returns the directory where the cache files are stored | |
has ( string $entryIdentifier ) : boolean | Checks if a cache entry with the specified identifier exists. | |
key ( ) : string | Returns the identifier of the current cache entry pointed to by the cache entry iterator. | |
next ( ) : void | Move forward to the next cache entry | |
remove ( string $entryIdentifier ) : boolean | Removes all cache entries matching the specified identifier. | |
requireOnce ( string $entryIdentifier ) : mixed | Loads PHP code from the cache and include_onces it right away. | |
rewind ( ) : void | Rewinds the cache entry iterator to the first element | |
set ( string $entryIdentifier, string $data, array $tags = [], integer $lifetime = null ) : void | Saves data in a cache file. | |
setBaseDirectory ( string $baseDirectory ) | ||
setCache ( Neos\Cache\Frontend\FrontendInterface $cache ) : void | Sets a reference to the cache frontend which uses this backend and initializes the default cache directory. | |
setCacheDirectory ( string $cacheDirectory ) : void | Sets the directory where the cache files are stored | |
valid ( ) : boolean | Checks if the current position of the cache entry iterator is valid |
Method | Description | |
---|---|---|
configureCacheDirectory ( ) | ||
findCacheFilesByIdentifier ( string $entryIdentifier ) : mixed | Tries to find the cache entry for the specified identifier. | |
isCacheFileExpired ( string $cacheEntryPathAndFilename ) : boolean | Checks if the given cache entry files are still valid or if their lifetime has exceeded. | |
readCacheFile ( string $cacheEntryPathAndFilename, integer | null $offset = null, integer | null $maxlen = null ) : boolean | string | Reads the cache data from the given cache file, using locking. | |
throwExceptionIfPathExceedsMaximumLength ( string $cacheEntryPathAndFilename ) : void | ||
writeCacheFile ( string $cacheEntryPathAndFilename, string $data ) : boolean | integer | Writes the cache data into the given cache file, using locking. |
public __construct ( |
||
$environmentConfiguration | ||
$options | array |
protected findCacheFilesByIdentifier ( string $entryIdentifier ) : mixed | ||
$entryIdentifier | string | The cache entry identifier |
return | mixed | The filenames (including path) as an array if one or more entries could be found, otherwise FALSE |
public getCacheDirectory ( ) : string | ||
return | string | Full path of the cache directory |
protected isCacheFileExpired ( string $cacheEntryPathAndFilename ) : boolean | ||
$cacheEntryPathAndFilename | string | |
return | boolean |
public requireOnce ( string $entryIdentifier ) : mixed | ||
$entryIdentifier | string | An identifier which describes the cache entry to load |
return | mixed | Potential return value from the include operation |
public set ( string $entryIdentifier, string $data, array $tags = [], integer $lifetime = null ) : void | ||
$entryIdentifier | string | An identifier for this specific cache entry |
$data | string | The data to be stored |
$tags | array | Ignored in this type of cache backend |
$lifetime | integer | Ignored in this type of cache backend |
return | void |
public setBaseDirectory ( string $baseDirectory ) | ||
$baseDirectory | string |
public setCacheDirectory ( string $cacheDirectory ) : void | ||
$cacheDirectory | string | Full path of the cache directory |
return | void |
protected throwExceptionIfPathExceedsMaximumLength ( string $cacheEntryPathAndFilename ) : void | ||
$cacheEntryPathAndFilename | string | |
return | void |
protected string $baseDirectory | ||
return | string |
protected string $cacheDirectory | ||
return | string |
protected string $cacheEntryFileExtension | ||
return | string |
protected DirectoryIterator $cacheFilesIterator | ||
return | DirectoryIterator |
protected bool $useIgBinary | ||
return | boolean |