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(array options = array()) : mixed
| since |
1.7.0 |
|---|
Arguments
- options
arrayOptional parameters
Response
mixed
_checkExpire
Check if a cache object has expired
_checkExpire(string id, string group) : bool
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
stringCache ID to check- group
stringThe cache data group
Response
boolTrue if the cache ID is valid
_cleanPath
Function to strip additional / or \ in a path name
_cleanPath(string path, string ds = DIRECTORY_SEPARATOR) : string
| since |
1.7.0 |
|---|
Arguments
- path
stringThe path to clean- ds
stringDirectory separator (optional)
Response
stringThe cleaned path
_deleteFolder
Quickly delete a folder of files
_deleteFolder(string path) : bool
| since |
1.7.0 |
|---|
Arguments
- path
stringThe path to the folder to delete.
Response
bool
_filesInFolder
Utility function to quickly read the files in a folder.
_filesInFolder(string path, string filter = '.', mixed recurse = false, bool fullpath = false, array exclude = array('.svn', 'CVS', '.DS_Store', '__MACOSX'), array excludefilter = array('^\..*', '.*~')) : array
| since |
1.7.0 |
|---|
Arguments
- path
stringThe path of the folder to read.- filter
stringA filter for file names.- recurse
mixedTrue to recursively search into sub-folders, or an integer to specify the maximum depth.- fullpath
boolTrue to return the full path to the file.- exclude
arrayArray with names of files which should not be shown in the result.- excludefilter
arrayArray of folder names to exclude
Response
arrayFiles in the given folder.
_folders
Utility function to read the folders in a folder.
_folders(string path, string filter = '.', mixed recurse = false, bool fullpath = false, array exclude = array('.svn', 'CVS', '.DS_Store', '__MACOSX'), array excludefilter = array('^\..*')) : array
| since |
1.7.0 |
|---|
Arguments
- path
stringThe path of the folder to read.- filter
stringA filter for folder names.- recurse
mixedTrue to recursively search into sub-folders, or an integer to specify the maximum depth.- fullpath
boolTrue to return the full path to the folders.- exclude
arrayArray with names of folders which should not be shown in the result.- excludefilter
arrayArray with regular expressions matching folders which should not be shown in the result.
Response
arrayFolders in the given folder.
_getCacheId
Get a cache ID string from an ID/group pair
_getCacheId(string id, string group) : string
| since |
1.7.0 |
|---|
Arguments
- id
stringThe cache data ID- group
stringThe cache data group
Response
string
_getFilePath
Get a cache file path from an ID/group pair
_getFilePath(string id, string group) : bool|string
| since |
1.7.0 |
|---|
Arguments
- id
stringThe cache data ID- group
stringThe cache data group
Response
bool|stringThe 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 = '') : array
| since |
1.7.0 |
|---|
Arguments
- path
array|stringA path to search.
Response
arrayAn array with directory elements
clean
Clean cache for a group given a mode.
clean(string group, string mode = null) : bool
group mode : cleans all cache in the group notgroup mode : cleans all cache not in the group
| since |
1.7.0 |
|---|
Arguments
- group
stringThe cache data group- mode
stringThe mode for cleaning cache [group|notgroup]
Response
bool
contains
Check if the cache contains data stored by ID and group
contains(string id, string group) : bool
| since |
3.7.0 |
|---|
Arguments
- id
stringThe cache data ID- group
stringThe cache data group
Response
bool
flush
Flush all existing items in storage.
flush() : bool
| since |
3.6.3 |
|---|
Response
bool
gc
Garbage collect expired cache data
gc() : bool
| since |
1.7.0 |
|---|
Response
bool
get
Get cached data by ID and group
get(string id, string group, bool checkTime = true) : mixed
| since |
1.7.0 |
|---|
Arguments
- id
stringThe cache data ID- group
stringThe cache data group- checkTime
boolTrue to verify cache time expiration threshold
Response
mixedBoolean false on failure or a cached data object
getAll
Get all cached data
getAll() : mixed
| since |
1.7.0 |
|---|
Response
mixedBoolean false on failure or a cached data object
getInstance
Returns a cache storage handler object.
getInstance(string handler = null, array options = array()) : \Joomla\CMS\Cache\CacheStorage
| since |
1.7.0 |
|---|---|
| throws |
|
Arguments
- handler
stringThe cache storage handler to instantiate- options
arrayArray of handler options
Response
\Joomla\CMS\Cache\CacheStorage
isSupported
Test to see if the storage handler is available.
isSupported() : bool
| since |
3.0.0 |
|---|
Response
bool
lock
Lock cached item
lock(string id, string group, int locktime) : mixed
| since |
1.7.0 |
|---|
Arguments
- id
stringThe cache data ID- group
stringThe cache data group- locktime
intCached item max lock time
Response
mixedBoolean false if locking failed or an object containing properties lock and locklooped
remove
Remove a cached data entry by ID and group
remove(string id, string group) : bool
| since |
1.7.0 |
|---|
Arguments
- id
stringThe cache data ID- group
stringThe cache data group
Response
bool
store
Store the data to cache by ID and group
store(string id, string group, string data) : bool
| since |
1.7.0 |
|---|
Arguments
- id
stringThe cache data ID- group
stringThe cache data group- data
stringThe data to store in cache
Response
bool
unlock
Unlock cached item
unlock(string id, string group = null) : bool
| since |
1.7.0 |
|---|
Arguments
- id
stringThe cache data ID- group
stringThe cache data group
Response
bool