Joomla! API

Download
Launch

JCacheStorageFile

Extends \JCacheStorage

File cache storage handler

package

Joomla.Platform
subpackage

Cache
since

11.1

Methods

__construct

Constructor

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

11.1

Arguments

$options

arrayOptional parameters

_checkExpire

Check to make sure cache is still valid, if not, delete it.

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

11.1

Arguments

$id

stringCache key to expire.

$group

stringThe cache data group.

Response

booleanFalse if not 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

booleanTrue on success.

_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

stringThe cache_id string

_getFilePath

Get a cache file path from an id/group pair

_getFilePath(string $id, string $group) : string
since

11.1

Arguments

$id

stringThe cache data id

$group

stringThe cache data group

Response

stringThe cache file path

addIncludePath

Add a directory where JCacheStorage should search for handlers. You may either pass a string or an array of directories.

addIncludePath(string $path = '') : array
inherited static
since

11.1

Arguments

$path

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
since

11.1

Arguments

$group

stringThe cache data group

$mode

stringThe mode for cleaning cache [group|notgroup] group mode : cleans all cache in the group notgroup mode : cleans all cache not in the group

Response

booleanTrue on success, false otherwise

gc

Garbage collect expired cache data

gc() : boolean
inherited
since

11.1

Response

booleanTrue on success, false otherwise.

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, only creating it if it doesn't already exist.

getInstance(string $handler = null, array $options = array()) : \JCacheStorageHandler
inherited static
since

11.1

Arguments

$handler

stringThe cache storage handler to instantiate

$options

arrayArray of handler options

Response

\JCacheStorageHandlerA JCacheStorageHandler object

lock

Lock cached item

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

11.1

Arguments

$id

stringThe cache data id

$group

stringThe cache data group

$locktime

integerCached item max lock time

Response

booleanTrue on success, false otherwise.

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

booleanTrue on success, false otherwise

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

booleanTrue on success, false otherwise

test

Test to see if the storage handler is available.

test() : boolean
inherited static
since

11.1.

Response

booleanTrue on success, false otherwise

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

booleanTrue on success, false otherwise.

Properties

_root

since

11.1

Type(s)

string

rawname

Rawname

inherited
since

11.1

Type(s)

string

_now

Now

inherited
since

11.1

Type(s)

\datetime

_lifetime

Cache lifetime

inherited
since

11.1

Type(s)

integer

_locking

Locking

inherited
since

11.1

Type(s)

boolean

_language

Language

inherited
since

11.1

Type(s)

string

_application

Application name.

inherited
since

11.1

Type(s)

string

_hash

Hash

inherited
since

11.1

Type(s)

string
  • \ \
  • \ JCacheStorageFile