Joomla! API

Download
Demo

FileStorage

Extends \Joomla\CMS\Cache\CacheStorage

File cache storage handler

since

11.1
note

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

Methods

__construct

Constructor

__construct(array $options = array())
inherited
since

11.1

Arguments

$options

arrayOptional parameters

_checkExpire

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

11.1

Arguments

$id

stringCache ID to check

$group

stringThe cache data group

Response

booleanTrue 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

11.1

Arguments

$path

stringThe path to clean

$ds

stringDirectory separator (optional)

Response

stringThe cleaned path

_deleteFolder

Quickly delete a folder of files

_deleteFolder(string $path) : boolean
since

11.1

Arguments

$path

stringThe path to the folder to delete.

Response

boolean

_filesInFolder

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

11.1

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.

_folders

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

11.1

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.

_getCacheId

Get a cache ID string from an ID/group pair

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

11.1

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) : boolean|string
since

11.1

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

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
inherited static
since

11.1

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) : boolean
inherited

group mode : cleans all cache in the group notgroup mode : cleans all cache not in the group

since

11.1

Arguments

$group

stringThe cache data group

$mode

stringThe mode for cleaning cache [group|notgroup]

Response

boolean

contains

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

Flush all existing items in storage.

flush() : boolean
inherited
since

3.6.3

Response

boolean

gc

Garbage collect expired cache data

gc() : boolean
inherited
since

11.1

Response

boolean

get

Get cached data by ID and group

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

11.1

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

getAll

Get all cached data

getAll() : mixed
inherited
since

11.1

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
inherited static
since

11.1
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

isSupported

Test to see if the storage handler is available.

isSupported() : boolean
inherited static
since

12.1

Response

boolean

lock

Lock cached item

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

11.1

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

Remove a cached data entry by ID and group

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

11.1

Arguments

$id

stringThe cache data ID

$group

stringThe cache data group

Response

boolean

store

Store the data to cache by ID and group

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

11.1

Arguments

$id

stringThe cache data ID

$group

stringThe cache data group

$data

stringThe data to store in cache

Response

boolean

test

Test to see if the storage handler is available.

test() : boolean
inherited static deprecated
since

11.1
deprecated

12.3 (Platform) & 4.0 (CMS)

Response

boolean

unlock

Unlock cached item

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

11.1

Arguments

$id

stringThe cache data ID

$group

stringThe cache data group

Response

boolean

Properties

_root

Root path

Type(s)

string

_locked_files

Locked resources

Type(s)

array

rawname

The raw object name

inherited

Type(s)

string

_now

Time that the cache storage handler was instantiated

inherited

Type(s)

integer

_lifetime

Cache lifetime

inherited

Type(s)

integer

_locking

Flag if locking is enabled

inherited

Type(s)

boolean

_language

Language code

inherited

Type(s)

string

_application

Application name

inherited

Type(s)

string

_hash

Object hash

inherited

Type(s)

string