Class XFCache

Description

XFCache provides an abstraction for caching organized in pools

Located in /class.cache.php (line 26)


	
			
Class Constant Summary
Variable Summary
static string $dir
static boolean $enable
Method Summary
static mixed get (string $a, [string $b = ''], [string $c = 'read'])
static integer lastpost ( &$a, [boolean $b = false], array $a)
static boolean purge (string $a, [string $b = ''])
static boolean put (string $a, [string $b = ''], [array $d = ''])
static boolean setdir (string $a)
static array statistic (string $a, [string $b = ''])
static mixed topic (integer $a, [string $b = ''])
Variables
static string $dir = '' (line 38)
  • var: absolute path to cache directory
  • access: protected
static boolean $enable = false (line 34)
  • var: cache enabled?
  • access: protected
Methods
static method get (line 87)

get a resource from cache

  • since: 1.0.0
  • access: public
static mixed get (string $a, [string $b = ''], [string $c = 'read'])
  • string $a: resource class
  • string $b: resource identifier
  • string $c: 'read' the content or return modification time 'mtime'
static method lastpost (line 330)

fetch last postid from topic

  • since: 1.0.0
  • access: public
static integer lastpost ( &$a, [boolean $b = false], array $a)
  • array $a: resource array from XFCache::topic()
  • boolean $b: if false, skips unapproved postings
  • &$a
static method purge (line 156)

remove a resource from cache

  • since: 1.0.0
  • access: public
static boolean purge (string $a, [string $b = ''])
  • string $a: resource class
  • string $b: resource identifier
static method put (line 121)

put content to cache

  • since: 1.0.0
  • access: public
static boolean put (string $a, [string $b = ''], [array $d = ''])
  • string $a: resource class
  • string $b: resource identifier
  • array $d: input stream
static method setdir (line 49)

set a directory for cache. obviously it has to be writeable...

  • since: 1.0.0
  • access: public
static boolean setdir (string $a)
  • string $a: full path
static method statistic (line 199)

calculate forum statistics and cache it

  • since: 1.0.0
  • access: public
static array statistic (string $a, [string $b = ''])
  • string $a: select section: 'post' or 'user'
  • string $b: options: 'force_recount'
static method topic (line 242)

fetches topic data from cache pool

  • since: 1.0.0
  • access: public
static mixed topic (integer $a, [string $b = ''])
  • integer $a: topic id, single or multiple separated by comma
  • string $b: options: 'force_recount' or 'purge'
Class Constants
TOPIC_CACHE_VERSION = 0x01 (line 30)
  • var: revision id for topic cache

Documentation generated on Tue, 21 Oct 2008 20:57:46 +0200 by phpDocumentor 1.4.1