Class XOAD_Cache_Storage_Files

Description

XOAD_Cache Storage Files Class.

This class is a XOAD_Cache_Storage successor.

  • version: 0.6.0.0
  • author: Stanimir Angeloff

Located in /extensions/cache/classes/storage/Files.class.php (line 33)

XOAD_Cache_Storage
   |
   --XOAD_Cache_Storage_Files
Variable Summary
 string $container
Method Summary
 XOAD_Cache_Storage_Files XOAD_Cache_Storage_Files (string $dsn)
 bool collectGarbage ()
 string getFileName (string $id)
 mixed load (string $id)
 bool save (mixed $id, int $expires, mixed $data)
Variables
string $container = 'cache' (line 43)

Holds the directory where the cached data is saved.

  • access: protected
Methods
Constructor XOAD_Cache_Storage_Files (line 54)

Creates a new instance of the XOAD_Cache_Storage_Files class.

  • access: public
XOAD_Cache_Storage_Files XOAD_Cache_Storage_Files (string $dsn)
  • string $dsn: The data source name and parameters to use when creating the instance.
collectGarbage (line 100)

Deletes old data from the cache.

This method is called before calling load to delete all expired data from the cache.

  • return: true on success, false otherwise.
  • access: public
bool collectGarbage ()

Redefinition of:
XOAD_Cache_Storage::collectGarbage()
Abstract base class method.
getFileName (line 69)

Gets the absolute path to the cache file.

  • access: private
string getFileName (string $id)
  • string $id: The ID of the cached data.
load (line 163)

Loads data from the cache with a given ID.

  • return: The data in the cache with the given ID or null.
  • access: public
mixed load (string $id)
  • string $id: The ID of the cached data.

Redefinition of:
XOAD_Cache_Storage::load()
Abstract base class method.
save (line 216)

Saves data in the cache with a given ID and lifetime.

  • return: True on success, false otherwise.
  • access: public
bool save (mixed $id, int $expires, mixed $data)
  • mixed $id: The ID to use when saving the data.
  • int $expires: The lifetime time in seconds for the cached data.
  • mixed $data: The data to cache.

Redefinition of:
XOAD_Cache_Storage::save()
Abstract base class method.

Inherited Methods

Inherited From XOAD_Cache_Storage

 XOAD_Cache_Storage::XOAD_Cache_Storage()
 XOAD_Cache_Storage::collectGarbage()
 XOAD_Cache_Storage::generateID()
 XOAD_Cache_Storage::load()
 XOAD_Cache_Storage::save()

Documentation generated on Sat, 12 Nov 2005 20:24:10 +0200 by phpDocumentor 1.3.0RC3