XpressEngine Core  1.11.2
 All Classes Namespaces Files Functions Variables Pages
Public Member Functions | Public Attributes | List of all members
CacheFile Class Reference
Inheritance diagram for CacheFile:
CacheBase

Public Member Functions

 getInstance ()
 
 __construct ()
 
 getCacheFileName ($key)
 
 isSupport ()
 
 put ($key, $obj, $valid_time=0)
 
 isValid ($key, $modified_time=0)
 
 get ($key, $modified_time=0)
 
 _delete ($_key)
 
 delete ($key)
 
 truncate ()
 
- Public Member Functions inherited from CacheBase
 get ($key, $modified_time=0)
 
 put ($key, $obj, $valid_time=0)
 
 isValid ($key, $modified_time=0)
 
 isSupport ()
 
 truncate ()
 

Public Attributes

 $cache_dir = 'files/cache/store/'
 
- Public Attributes inherited from CacheBase
 $valid_time = 36000
 

Detailed Description

Cache class for file

Filedisk Cache Handler

Author
NAVER (devel.nosp@m.oper.nosp@m.s@xpr.nosp@m.esse.nosp@m.ngine.nosp@m..com)

Definition at line 11 of file CacheFile.class.php.

Constructor & Destructor Documentation

CacheFile::__construct ( )

Constructor

Returns
void

Definition at line 38 of file CacheFile.class.php.

Member Function Documentation

CacheFile::_delete (   $_key)

Delete variable from the cache(private)

Parameters
string$_keyUsed to store the value.
Returns
void

Definition at line 146 of file CacheFile.class.php.

CacheFile::delete (   $key)

Delete variable from the cache

Parameters
string$keyUsed to store the value.
Returns
void

Definition at line 162 of file CacheFile.class.php.

CacheFile::get (   $key,
  $modified_time = 0 
)

Fetch a stored variable from the cache

Parameters
string$keyThe $key used to store the value.
int$modified_timeNot used
Returns
false|mixed Return false on failure. Return the string associated with the $key on success.

Definition at line 122 of file CacheFile.class.php.

CacheFile::getCacheFileName (   $key)

Get cache file name by key

Parameters
string$keyThe key that will be associated with the item.
Returns
string Returns cache file path

Definition at line 50 of file CacheFile.class.php.

CacheFile::getInstance ( )

Get instance of CacheFile

Returns
CacheFile instance of CacheFile

Definition at line 24 of file CacheFile.class.php.

CacheFile::isSupport ( )

Return whether support or not support cache

Returns
true

Definition at line 60 of file CacheFile.class.php.

CacheFile::isValid (   $key,
  $modified_time = 0 
)

Return whether cache is valid or invalid

Parameters
string$keyCache key
int$modified_timeNot used
Returns
bool Return true on valid or false on invalid.

Definition at line 97 of file CacheFile.class.php.

CacheFile::put (   $key,
  $obj,
  $valid_time = 0 
)

Cache a variable in the data store

Parameters
string$keyStore the variable using this name.
mixed$objThe variable to store
int$valid_timeNot used
Returns
void

Definition at line 73 of file CacheFile.class.php.

CacheFile::truncate ( )

Truncate all existing variables at the cache

Returns
bool Returns true on success or false on failure.

Definition at line 172 of file CacheFile.class.php.

Member Data Documentation

CacheFile::$cache_dir = 'files/cache/store/'

Definition at line 17 of file CacheFile.class.php.


The documentation for this class was generated from the following file: