FileStorage
Extends CacheStorageFile cache storage handler
since |
1.7.0 |
---|---|
note |
For performance reasons this class does not use the Filesystem package's API |
package |
Joomla CMS |
Methods
__construct
Constructor
__construct(mixed||string|int options = []) :
since |
1.7.0 |
---|
Arguments
- options
array<string|int, mixed>
Optional parameters
Response
mixed
_checkExpire
Check if a cache object has expired
_checkExpire( id, group) :
Using @ error suppressor here because between if we did a file_exists() and then filemsize() there will be a little time space when another process can delete the file and then you get PHP Warning
since |
1.7.0 |
---|
Arguments
- id
string
Cache ID to check- group
string
The cache data group
Response
bool
True if the cache ID is valid
_cleanPath
Function to strip additional / or \ in a path name
_cleanPath( path, ds = DIRECTORY_SEPARATOR) :
since |
1.7.0 |
---|
Arguments
- path
string
The path to clean- ds
string
Directory separator (optional)
Response
string
The cleaned path
_deleteFolder
Quickly delete a folder of files
_deleteFolder( path) :
since |
1.7.0 |
---|
Arguments
- path
string
The path to the folder to delete.
Response
bool
_filesInFolder
Utility function to quickly read the files in a folder.
_filesInFolder( path, filter = '.', recurse = false, fullpath = false, mixed||string|int exclude = ['.svn', 'CVS', '.DS_Store', '__MACOSX'], mixed||string|int excludefilter = ['^\..*', '.*~']) : mixed||string|int
since |
1.7.0 |
---|
Arguments
- path
string
The path of the folder to read.- filter
string
A filter for file names.- recurse
mixed
True to recursively search into sub-folders, or an integer to specify the maximum depth.- fullpath
bool
True to return the full path to the file.- exclude
array<string|int, mixed>
Array with names of files which should not be shown in the result.- excludefilter
array<string|int, mixed>
Array of folder names to exclude
Response
array<string|int, mixed>
Files in the given folder.
_folders
Utility function to read the folders in a folder.
_folders( path, filter = '.', recurse = false, fullpath = false, mixed||string|int exclude = ['.svn', 'CVS', '.DS_Store', '__MACOSX'], mixed||string|int excludefilter = ['^\..*']) : mixed||string|int
since |
1.7.0 |
---|
Arguments
- path
string
The path of the folder to read.- filter
string
A filter for folder names.- recurse
mixed
True to recursively search into sub-folders, or an integer to specify the maximum depth.- fullpath
bool
True to return the full path to the folders.- exclude
array<string|int, mixed>
Array with names of folders which should not be shown in the result.- excludefilter
array<string|int, mixed>
Array with regular expressions matching folders which should not be shown in the result.
Response
array<string|int, mixed>
Folders in the given folder.
_getCacheId
Get a cache ID string from an ID/group pair
_getCacheId( id, group) :
since |
1.7.0 |
---|
Arguments
- id
string
The cache data ID- group
string
The cache data group
Response
string
_getFilePath
Get a cache file path from an ID/group pair
_getFilePath( id, group) : bool|string
since |
1.7.0 |
---|
Arguments
- id
string
The cache data ID- group
string
The cache data group
Response
bool|string
The path to the data object or boolean false if the cache directory does not exist
addIncludePath
Add a directory where CacheStorage should search for handlers. You may either pass a string or an array of directories.
addIncludePath(array|string path = '') : mixed||string|int
since |
1.7.0 |
---|
Arguments
- path
array<string|int, mixed>|string
A path to search.
Response
array<string|int, mixed>
An array with directory elements
clean
Clean cache for a group given a mode.
clean( group, mode = null) :
group mode : cleans all cache in the group notgroup mode : cleans all cache not in the group
since |
1.7.0 |
---|
Arguments
- group
string
The cache data group- mode
string
The mode for cleaning cache [group|notgroup]
Response
bool
contains
Check if the cache contains data stored by ID and group
contains( id, group) :
since |
3.7.0 |
---|
Arguments
- id
string
The cache data ID- group
string
The cache data group
Response
bool
flush
Flush all existing items in storage.
flush() :
since |
3.6.3 |
---|
Response
bool
gc
Garbage collect expired cache data
gc() :
since |
1.7.0 |
---|
Response
bool
get
Get cached data by ID and group
get( id, group, checkTime = true) :
since |
1.7.0 |
---|
Arguments
- id
string
The cache data ID- group
string
The cache data group- checkTime
bool
True to verify cache time expiration threshold
Response
mixed
Boolean false on failure or a cached data object
getAll
Get all cached data
getAll() :
since |
1.7.0 |
---|
Response
mixed
Boolean false on failure or a cached data object
getInstance
Returns a cache storage handler object.
getInstance( handler = null, mixed||string|int options = []) : \Joomla\CMS\Cache\CacheStorage
since |
1.7.0 |
---|---|
throws |
|
Arguments
- handler
string
The cache storage handler to instantiate- options
array<string|int, mixed>
Array of handler options
Response
isSupported
Test to see if the storage handler is available.
isSupported() :
since |
3.0.0 |
---|
Response
bool
lock
Lock cached item
lock( id, group, locktime) :
since |
1.7.0 |
---|
Arguments
- id
string
The cache data ID- group
string
The cache data group- locktime
int
Cached item max lock time
Response
mixed
Boolean false if locking failed or an object containing properties lock and locklooped
remove
Remove a cached data entry by ID and group
remove( id, group) :
since |
1.7.0 |
---|
Arguments
- id
string
The cache data ID- group
string
The cache data group
Response
bool
store
Store the data to cache by ID and group
store( id, group, data) :
since |
1.7.0 |
---|
Arguments
- id
string
The cache data ID- group
string
The cache data group- data
string
The data to store in cache
Response
bool
unlock
Unlock cached item
unlock( id, group = null) :
since |
1.7.0 |
---|
Arguments
- id
string
The cache data ID- group
string
The cache data group
Response
bool
Properties
rawname
The raw object name
since |
1.7.0 |
---|
Type(s)
string
_now
Time that the cache storage handler was instantiated
since |
1.7.0 |
---|
Type(s)
int
_lifetime
Cache lifetime
since |
1.7.0 |
---|
Type(s)
int
_locking
Flag if locking is enabled
since |
1.7.0 |
---|
Type(s)
bool
_language
Language code
since |
1.7.0 |
---|
Type(s)
string
_application
Application name
since |
1.7.0 |
---|
Type(s)
string
_hash
Object hash
since |
1.7.0 |
---|
Type(s)
string
_threshold
The threshold
since |
4.3.0 |
---|
Type(s)
int
_root
Root path
since |
1.7.0 |
---|
Type(s)
string
_locked_files
Locked resources
since |
3.7.0 |
---|
Type(s)
array<string|int, mixed>