FileHandler
extends BaseHandler
in package
File system cache handler
Table of Contents
- MAX_KEY_LENGTH = 255
- Maximum key length.
- RESERVED_CHARACTERS = '{}()/\@:'
- Reserved characters that cannot be used in a key or tag.
- $mode : int
- Mode for the stored files.
- $path : string
- Where to store cached files on the disk.
- $prefix : string
- Prefix to apply to cache keys.
- __construct() : mixed
- Constructor.
- clean() : bool
- Will delete all items in the entire cache.
- decrement() : bool
- Performs atomic decrementation of a raw stored value.
- delete() : bool
- Deletes a specific item from the cache store.
- deleteMatching() : int
- Deletes items from the cache store matching a given pattern.
- get() : mixed
- Attempts to fetch an item from the cache store.
- getCacheInfo() : array<string|int, mixed>|false
- Returns information on the entire cache.
- getMetaData() : array<string|int, mixed>|false|null
- Returns detailed information about the specific item in the cache.
- increment() : bool
- Performs atomic incrementation of a raw stored value.
- initialize() : mixed
- Takes care of any handler-specific setup that must be done.
- isSupported() : bool
- Determines if the driver is supported on this system.
- remember() : mixed
- Get an item from the cache, or execute the given Closure and store the result.
- save() : bool
- Saves an item to the cache store.
- validateKey() : string
- Validates a cache key according to PSR-6.
- deleteFiles() : bool
- Delete Files
- getDirFileInfo() : array<string|int, mixed>|false
- Get Directory File Information
- getFileInfo() : array<string|int, mixed>|false
- Get File Info
- getItem() : bool|mixed
- Does the heavy lifting of actually retrieving the file and verifying it's age.
- writeFile() : bool
- Writes a file to disk, or returns false if not successful.
Constants
MAX_KEY_LENGTH
Maximum key length.
public
mixed
MAX_KEY_LENGTH
= 255
RESERVED_CHARACTERS
Reserved characters that cannot be used in a key or tag.
public
mixed
RESERVED_CHARACTERS
= '{}()/\@:'
From https://github.com/symfony/cache-contracts/blob/c0446463729b89dd4fa62e9aeecc80287323615d/ItemInterface.php#L43
Properties
$mode
Mode for the stored files.
protected
int
$mode
Must be chmod-safe (octal).
Tags
$path
Where to store cached files on the disk.
protected
string
$path
$prefix
Prefix to apply to cache keys.
protected
string
$prefix
May not be used by all handlers.
Methods
__construct()
Constructor.
public
__construct(Cache $config) : mixed
Parameters
- $config : Cache
Tags
Return values
mixed —clean()
Will delete all items in the entire cache.
public
clean() : bool
Return values
bool —Success or failure
decrement()
Performs atomic decrementation of a raw stored value.
public
decrement(string $key[, int $offset = 1 ]) : bool
Parameters
- $key : string
-
Cache ID
- $offset : int = 1
-
Step/value to increase by
Return values
bool —delete()
Deletes a specific item from the cache store.
public
delete(string $key) : bool
Parameters
- $key : string
-
Cache item name
Return values
bool —Success or failure
deleteMatching()
Deletes items from the cache store matching a given pattern.
public
deleteMatching(string $pattern) : int
Parameters
- $pattern : string
-
Cache items glob-style pattern
Return values
int —The number of deleted items
get()
Attempts to fetch an item from the cache store.
public
get(string $key) : mixed
Parameters
- $key : string
-
Cache item name
Return values
mixed —getCacheInfo()
Returns information on the entire cache.
public
getCacheInfo() : array<string|int, mixed>|false
The information returned and the structure of the data varies depending on the handler.
Return values
array<string|int, mixed>|false —getMetaData()
Returns detailed information about the specific item in the cache.
public
getMetaData(string $key) : array<string|int, mixed>|false|null
Parameters
- $key : string
-
Cache item name.
Return values
array<string|int, mixed>|false|null —Returns null if the item does not exist, otherwise array<string, mixed> with at least the 'expire' key for absolute epoch expiry (or null). Some handlers may return false when an item does not exist, which is deprecated.
increment()
Performs atomic incrementation of a raw stored value.
public
increment(string $key[, int $offset = 1 ]) : bool
Parameters
- $key : string
-
Cache ID
- $offset : int = 1
-
Step/value to increase by
Return values
bool —initialize()
Takes care of any handler-specific setup that must be done.
public
initialize() : mixed
Return values
mixed —isSupported()
Determines if the driver is supported on this system.
public
isSupported() : bool
Return values
bool —remember()
Get an item from the cache, or execute the given Closure and store the result.
public
remember(string $key, int $ttl, Closure $callback) : mixed
Parameters
- $key : string
-
Cache item name
- $ttl : int
-
Time to live
- $callback : Closure
-
Callback return value
Return values
mixed —save()
Saves an item to the cache store.
public
save(string $key, mixed $value[, int $ttl = 60 ]) : bool
Parameters
- $key : string
-
Cache item name
- $value : mixed
-
The data to save
- $ttl : int = 60
-
Time To Live, in seconds (default 60)
Return values
bool —Success or failure
validateKey()
Validates a cache key according to PSR-6.
public
static validateKey(string $key[, string $prefix = '' ]) : string
Keys that exceed MAX_KEY_LENGTH are hashed. From https://github.com/symfony/cache/blob/7b024c6726af21fd4984ac8d1eae2b9f3d90de88/CacheItem.php#L158
Parameters
- $key : string
-
The key to validate
- $prefix : string = ''
-
Optional prefix to include in length calculations
Tags
Return values
string —deleteFiles()
Delete Files
protected
deleteFiles(string $path[, bool $delDir = false ][, bool $htdocs = false ], int $_level) : bool
Deletes all files contained in the supplied directory path. Files must be writable or owned by the system in order to be deleted. If the second parameter is set to TRUE, any directories contained within the supplied base directory will be nuked as well.
Parameters
- $path : string
-
File path
- $delDir : bool = false
-
Whether to delete any directories found in the path
- $htdocs : bool = false
-
Whether to skip deleting .htaccess and index page files
- $_level : int
-
Current directory depth level (default: 0; internal use only)
Return values
bool —getDirFileInfo()
Get Directory File Information
protected
getDirFileInfo(string $sourceDir[, bool $topLevelOnly = true ][, bool $_recursion = false ]) : array<string|int, mixed>|false
Reads the specified directory and builds an array containing the filenames, filesize, dates, and permissions
Any sub-folders contained within the specified path are read as well.
Parameters
- $sourceDir : string
-
Path to source
- $topLevelOnly : bool = true
-
Look only at the top level directory specified?
- $_recursion : bool = false
-
Internal variable to determine recursion status - do not use in calls
Return values
array<string|int, mixed>|false —getFileInfo()
Get File Info
protected
getFileInfo(string $file[, mixed $returnedValues = ['name', 'server_path', 'size', 'date'] ]) : array<string|int, mixed>|false
Given a file and path, returns the name, path, size, date modified Second parameter allows you to explicitly declare what information you want returned Options are: name, server_path, size, date, readable, writable, executable, fileperms Returns FALSE if the file cannot be found.
Parameters
- $file : string
-
Path to file
- $returnedValues : mixed = ['name', 'server_path', 'size', 'date']
-
Array or comma separated string of information returned
Return values
array<string|int, mixed>|false —getItem()
Does the heavy lifting of actually retrieving the file and verifying it's age.
protected
getItem(string $filename) : bool|mixed
Parameters
- $filename : string
Return values
bool|mixed —writeFile()
Writes a file to disk, or returns false if not successful.
protected
writeFile(string $path, string $data[, string $mode = 'wb' ]) : bool
Parameters
- $path : string
- $data : string
- $mode : string = 'wb'