| [ Index ] |
PHP Cross Reference of Joomla 4.2.2 documentation |
[Source view] [Print] [Project Stats]
Joomla! Content Management System
| Copyright: | (C) 2007 Open Source Matters, Inc. |
| License: | GNU General Public License version 2 or later; see LICENSE.txt |
| File Size: | 790 lines (18 kb) |
| Included or required: | 0 times |
| Referenced: | 0 times |
| Includes or requires: | 0 files |
FileStorage:: (16 methods):
__construct()
contains()
get()
getAll()
store()
remove()
clean()
gc()
lock()
unlock()
_checkExpire()
_getFilePath()
_deleteFolder()
_cleanPath()
_filesInFolder()
_folders()
Class: FileStorage - X-Ref
File cache storage handler| __construct($options = array() X-Ref |
| Constructor param: array $options Optional parameters |
| contains($id, $group) X-Ref |
| Check if the cache contains data stored by ID and group param: string $id The cache data ID param: string $group The cache data group return: boolean |
| get($id, $group, $checkTime = true) X-Ref |
| Get cached data by ID and group param: string $id The cache data ID param: string $group The cache data group param: boolean $checkTime True to verify cache time expiration threshold return: mixed Boolean false on failure or a cached data object |
| getAll() X-Ref |
| Get all cached data return: mixed Boolean false on failure or a cached data object |
| store($id, $group, $data) X-Ref |
| Store the data to cache by ID and group param: string $id The cache data ID param: string $group The cache data group param: string $data The data to store in cache return: boolean |
| remove($id, $group) X-Ref |
| Remove a cached data entry by ID and group param: string $id The cache data ID param: string $group The cache data group return: boolean |
| clean($group, $mode = null) X-Ref |
| Clean cache for a group given a mode. group mode : cleans all cache in the group notgroup mode : cleans all cache not in the group param: string $group The cache data group param: string $mode The mode for cleaning cache [group|notgroup] return: boolean |
| gc() X-Ref |
| Garbage collect expired cache data return: boolean |
| lock($id, $group, $locktime) X-Ref |
| Lock cached item param: string $id The cache data ID param: string $group The cache data group param: integer $locktime Cached item max lock time return: mixed Boolean false if locking failed or an object containing properties lock and locklooped |
| unlock($id, $group = null) X-Ref |
| Unlock cached item param: string $id The cache data ID param: string $group The cache data group return: boolean |
| _checkExpire($id, $group) X-Ref |
| Check if a cache object has expired 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 param: string $id Cache ID to check param: string $group The cache data group return: boolean True if the cache ID is valid |
| _getFilePath($id, $group) X-Ref |
| Get a cache file path from an ID/group pair param: string $id The cache data ID param: string $group The cache data group return: boolean|string The path to the data object or boolean false if the cache directory does not exist |
| _deleteFolder($path) X-Ref |
| Quickly delete a folder of files param: string $path The path to the folder to delete. return: boolean |
| _cleanPath($path, $ds = DIRECTORY_SEPARATOR) X-Ref |
| Function to strip additional / or \ in a path name param: string $path The path to clean param: string $ds Directory separator (optional) return: string The cleaned path |
| _filesInFolder($path, $filter = '.', $recurse = false, $fullpath = false,$exclude = array('.svn', 'CVS', '.DS_Store', '__MACOSX') X-Ref |
| Utility function to quickly read the files in a folder. param: string $path The path of the folder to read. param: string $filter A filter for file names. param: mixed $recurse True to recursively search into sub-folders, or an integer to specify the maximum depth. param: boolean $fullpath True to return the full path to the file. param: array $exclude Array with names of files which should not be shown in the result. param: array $excludefilter Array of folder names to exclude return: array Files in the given folder. |
| _folders($path, $filter = '.', $recurse = false, $fullpath = false, $exclude = array('.svn', 'CVS', '.DS_Store', '__MACOSX') X-Ref |
| Utility function to read the folders in a folder. param: string $path The path of the folder to read. param: string $filter A filter for folder names. param: mixed $recurse True to recursively search into sub-folders, or an integer to specify the maximum depth. param: boolean $fullpath True to return the full path to the folders. param: array $exclude Array with names of folders which should not be shown in the result. param: array $excludefilter Array with regular expressions matching folders which should not be shown in the result. return: array Folders in the given folder. |
| Generated: Wed Sep 7 05:41:13 2022 | Chilli.vc Blog - For Webmaster,Blog-Writer,System Admin and Domainer |