\Doctrine\Common\CacheFilesystemCache

__construct()

__construct(string  $directory, string  $extension = self::EXTENSION,   $umask = 2) 

Constructor.

Parameters

getDirectory()

getDirectory() : string

Gets the cache directory.

Returns

getExtension()

getExtension() : string|null

Gets the cache file extension.

Returns

setNamespace()

setNamespace(string  $namespace) : void

Sets the namespace to prefix all cache ids with.

Parameters

getNamespace()

getNamespace() : string

Retrieves the namespace that prefixes all cache ids.

Returns

fetch()

fetch(string  $id) : mixed

Fetches an entry from the cache.

Parameters

Returns

The cached data or FALSE, if no cache entry exists for the given id.

fetchMultiple()

fetchMultiple(array  $keys) : array<mixed,mixed>

Returns an associative array of values for keys is found in cache.

Parameters

Returns

Array of retrieved values, indexed by the specified keys. Values that couldn't be retrieved are not contained in this array.

contains()

contains(string  $id) : boolean

Tests if an entry exists in the cache.

Parameters

Returns

TRUE if a cache entry exists for the given cache id, FALSE otherwise.

save()

save(string  $id, mixed  $data, integer  $lifeTime) : boolean

Puts data into the cache.

If a cache entry with the given id already exists, its data will be replaced.

Parameters

Returns

TRUE if the entry was successfully stored in the cache, FALSE otherwise.

delete()

delete(string  $id) : boolean

Deletes a cache entry.

Parameters

Returns

TRUE if the cache entry was successfully deleted, FALSE otherwise. Deleting a non-existing entry is considered successful.

getStats()

getStats() : array|null

Retrieves cached information from the data store.

The server's statistics array has the following values:

• hits Number of keys that have been requested and found present.

• misses Number of items that have been requested and not found.

• uptime Time that the server is running.

• memory_usage Memory used by this server to store items.

• memory_available Memory allowed to use for storage.

Returns

An associative array with server's statistics if available, NULL otherwise.

flushAll()

flushAll() : boolean

Flushes all cache entries, globally.

Returns

TRUE if the cache entries were successfully flushed, FALSE otherwise.

deleteAll()

deleteAll() : boolean

Deletes all cache entries in the current cache namespace.

Returns

TRUE if the cache entries were successfully deleted, FALSE otherwise.

getFilename()

getFilename(string  $id) : string

Parameters

Returns

doDelete()

doDelete(string  $id) : boolean

Deletes a cache entry.

Parameters

Returns

TRUE if the cache entry was successfully deleted, FALSE otherwise.

doFlush()

doFlush() : boolean

Flushes all cache entries.

Returns

TRUE if the cache entries were successfully flushed, FALSE otherwise.

doGetStats()

doGetStats() : array|null

Retrieves cached information from the data store.

Returns

An associative array with server's statistics if available, NULL otherwise.

writeFile()

writeFile(string  $filename, string  $content) : boolean

Writes a string content to file in an atomic way.

Parameters

Returns

TRUE on success, FALSE if path cannot be created, if path is not writable or an any other error.

doFetchMultiple()

doFetchMultiple(array  $keys) : array

Default implementation of doFetchMultiple. Each driver that supports multi-get should owerwrite it.

Parameters

Returns

Array of values retrieved for the given keys.

doFetch()

doFetch(  $id) 

{@inheritdoc}

Parameters

doContains()

doContains(  $id) 

{@inheritdoc}

Parameters

doSave()

doSave(  $id,   $data,   $lifeTime) 

{@inheritdoc}

Parameters

createPathIfNeeded()

createPathIfNeeded(string  $path) : boolean

Create path if needed.

Parameters

Returns

TRUE on success or if path already exists, FALSE if path cannot be created.

getIterator()

getIterator() : \Iterator

Returns

isFilenameEndingWithExtension()

isFilenameEndingWithExtension(string  $name) : boolean

Parameters

Returns

getNamespacedId()

getNamespacedId(string  $id) : string

Prefixes the passed id with the configured namespace value.

Parameters

Returns

The namespaced id.

getNamespaceCacheKey()

getNamespaceCacheKey() : string

Returns the namespace cache key.

Returns

getNamespaceVersion()

getNamespaceVersion() : integer

Returns the namespace version.

Returns