\JCacheStorageFile

File cache storage handler

Synopsis

class JCacheStorageFile extends JCacheStorage {

• // members
• protected  $_root;
• // Inherited members from JCacheStorage
• protected  $rawname;
• public datetime  $_now;
• public  $_lifetime;
• public  $_locking;
• public  $_language;
• public  $_application;
• public  $_hash;
• // methods
• public void __construct()
• public mixed get()
• public array getAll()
• public boolean store()
• public boolean remove()
• public boolean clean()
• public boolean gc()
• public static boolean isSupported()
• public boolean lock()
• public boolean unlock()
• protected boolean _checkExpire()
• protected string _getFilePath()
• protected boolean _deleteFolder()
• protected string _cleanPath()
• protected array _filesInFolder()
• protected array _folders()
• // Inherited methods from JCacheStorage
• public void __construct()
• public static JCacheStorage getInstance()
• public mixed get()
• public mixed getAll()
• public boolean store()
• public boolean remove()
• public boolean clean()
• public boolean gc()
• public static boolean isSupported()
• public static boolean test()
• public boolean lock()
• public boolean unlock()
• protected string _getCacheId()
• public static array addIncludePath()
}


Hierarchy

Extends

• JCacheStorage

Tasks

Tasks

Line	Task
175+	Review this method. The docblock doesn't fit what it actually does.

Members

protected

• $_root — string
  Root path
• $rawname — string

public

• $_application — string
• $_hash — string
• $_language — string
• $_lifetime — integer
• $_locking — boolean
• $_now — datetime

Methods

protected

• _checkExpire() — Check to make sure cache is still valid, if not, delete it.
• _cleanPath() — Function to strip additional / or \ in a path name
• _deleteFolder() — Quickly delete a folder of files
• _filesInFolder() — Utility function to quickly read the files in a folder.
• _folders() — Utility function to read the folders in a folder.
• _getFilePath() — Get a cache file path from an id/group pair

public

• __construct() — Constructor
• clean() — Clean cache for a group given a mode.
• gc() — Garbage collect expired cache data
• get() — Get cached data from a file by id and group
• getAll() — Get all cached data
• isSupported() — Test to see if the cache storage is available.
• lock() — Lock cached item
• remove() — Remove a cached data file by id and group
• store() — Store the data to a file by id and group
• unlock() — Unlock cached item

Inherited from JCacheStorage

protected

• _getCacheId() — Get a cache_id string from an id/group pair

public

• addIncludePath() — Add a directory where JCacheStorage should search for handlers. You may either pass a string or an array of directories.
• clean() — Clean cache for a group given a mode.
• gc() — Garbage collect expired cache data
• get() — Get cached data by id and group
• getAll() — Get all cached data
• getInstance() — Returns a cache storage handler object, only creating it if it doesn't already exist.
• isSupported() — Test to see if the storage handler is available.
• lock() — Lock cached item
• remove() — Remove a cached data entry by id and group
• store() — Store the data to cache by id and group
• test() — Test to see if the storage handler is available.
• unlock() — Unlock cached item