Joomla! API

Constructor

__construct(array $options = array())

inherited

since	1.7.0

Arguments

$options: arrayOptional parameters

Check if a cache object has expired

_checkExpire(string $id, string $group) : boolean

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

booleanTrue if the cache ID is valid

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

Quickly delete a folder of files

_deleteFolder(string $path) : boolean

since	1.7.0

Arguments

$path: stringThe path to the folder to delete.

Response

boolean

Utility function to quickly read the files in a folder.

_filesInFolder(string $path, string $filter = '.', mixed $recurse = false, boolean $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: booleanTrue 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.

Utility function to read the folders in a folder.

_folders(string $path, string $filter = '.', mixed $recurse = false, boolean $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: booleanTrue 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.

Get a cache ID string from an ID/group pair

_getCacheId(string $id, string $group) : string

inherited

since	1.7.0

Arguments

$id: stringThe cache data ID
$group: stringThe cache data group

Response

string

Get a cache file path from an ID/group pair

_getFilePath(string $id, string $group) : boolean|string

since	1.7.0

Arguments

$id: stringThe cache data ID
$group: stringThe cache data group

Response

boolean|stringThe path to the data object or boolean false if the cache directory does not exist

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

inherited static

since	1.7.0

Arguments

$path: array|stringA path to search.

Response

arrayAn array with directory elements

Clean cache for a group given a mode.

clean(string $group, string $mode = null) : boolean

inherited

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

boolean

Check if the cache contains data stored by ID and group

contains(string $id, string $group) : boolean

inherited

since	3.7.0

Arguments

$id: stringThe cache data ID
$group: stringThe cache data group

Response

boolean

Flush all existing items in storage.

flush() : boolean

inherited

since	3.6.3

Response

boolean

Garbage collect expired cache data

gc() : boolean

inherited

since	1.7.0

Response

boolean

Get cached data by ID and group

get(string $id, string $group, boolean $checkTime = true) : mixed

inherited

since	1.7.0

Arguments

$id: stringThe cache data ID
$group: stringThe cache data group
$checkTime: booleanTrue to verify cache time expiration threshold

Response

mixedBoolean false on failure or a cached data object

Get all cached data

getAll() : mixed

inherited

since	1.7.0

Response

mixedBoolean false on failure or a cached data object

Returns a cache storage handler object.

getInstance(string $handler = null, array $options = array()) : \Joomla\CMS\Cache\CacheStorage

inherited static

since

1.7.0

throws

\UnexpectedValueException

\Joomla\CMS\Cache\Exception\UnsupportedCacheException

Arguments

$handler: stringThe cache storage handler to instantiate
$options: arrayArray of handler options

Response

\Joomla\CMS\Cache\CacheStorage

Test to see if the storage handler is available.

isSupported() : boolean

inherited static

since	3.0.0

Response

boolean

Lock cached item

lock(string $id, string $group, integer $locktime) : mixed

inherited

since	1.7.0

Arguments

$id: stringThe cache data ID
$group: stringThe cache data group
$locktime: integerCached item max lock time

Response

mixedBoolean false if locking failed or an object containing properties lock and locklooped

Remove a cached data entry by ID and group

remove(string $id, string $group) : boolean

inherited

since	1.7.0

Arguments

$id: stringThe cache data ID
$group: stringThe cache data group

Response

boolean

Store the data to cache by ID and group

store(string $id, string $group, string $data) : boolean

inherited

since	1.7.0

Arguments

$id: stringThe cache data ID
$group: stringThe cache data group
$data: stringThe data to store in cache

Response

boolean

Test to see if the storage handler is available.

test() : boolean

inherited static deprecated

since	1.7.0
deprecated	4.0

Response

boolean

Unlock cached item

unlock(string $id, string $group = null) : boolean

inherited

since	1.7.0

Arguments

$id: stringThe cache data ID
$group: stringThe cache data group

Response

boolean

Root path

since	1.7.0

Type(s)

string

Locked resources

since	3.7.0

Type(s)

array

The raw object name

inherited

since	1.7.0

Type(s)

string

Time that the cache storage handler was instantiated

inherited

since	1.7.0

Type(s)

integer

Cache lifetime

inherited

since	1.7.0

Type(s)

integer

Flag if locking is enabled

inherited

since	1.7.0

Type(s)

boolean

Language code

inherited

since	1.7.0

Type(s)

string

Application name

inherited

since	1.7.0

Type(s)

string

Object hash

inherited

since	1.7.0

Type(s)

string

since	1.7.0
note	For performance reasons this class does not use the Filesystem package's API

FileStorage

Methods

__construct

Arguments

_checkExpire

Arguments

Response

_cleanPath

Arguments

Response

_deleteFolder

Arguments

Response

_filesInFolder

Arguments

Response

_folders

Arguments

Response

_getCacheId

Arguments

Response

_getFilePath

Arguments

Response

addIncludePath

Arguments

Response

clean

Arguments

Response

contains

Arguments

Response

flush

Response

gc

Response

get

Arguments

Response

getAll

Response

getInstance

Arguments

Response

isSupported

Response

lock

Arguments

Response

remove

Arguments

Response

store

Arguments

Response

test

Response

unlock

Arguments

Response

Properties

_root

Type(s)

_locked_files

Type(s)

rawname

Type(s)

_now

Type(s)

_lifetime

Type(s)

_locking

Type(s)

_language

Type(s)

_application

Type(s)

_hash