vB_FastDS_APC
extends vB_FastDS
in package
Table of Contents
- TYPE_DATASTORE = 'ds'
- TYPE_PHRASES = 'ph'
- TYPE_TEMPLATES = 'tm'
- $building : mixed
- $dsCached : mixed
- $dsRebuilt : mixed
- $enabled : mixed
- $fastInstance : mixed
- $language : mixed
- $phrasesCached : mixed
- $phRebuilt : mixed
- $prefix : mixed
- $rebuilt : mixed
- $skipDSCache : mixed
- $styleid : mixed
- $templatesCached : mixed
- $tmRebuilt : mixed
- __serialize() : mixed
- __sleep() : mixed
- __unserialize() : mixed
- __wakeup() : mixed
- buildFastDS() : mixed
- reBuilds the fastDS data. This is called if the cached value is lost, or after upgrade.
- getDS() : mixed
- gets a datastore value
- getPhrases() : string
- gets a phrase, or set of phrases, from the default language
- getTemplates() : mixed
- gets a template from the default style
- instance() : mixed
- Returns a reference to the current fastDS object, or false
- setDS() : bool
- sets a datastore value
- setDsChanged() : mixed
- __construct() : a
- standard constructor
- buildDatastore() : int
- reBuilds the fastDS data. This is called if the cached value is lost, or after upgrade.
- buildPhrases() : int
- reBuilds the fastDS data. This is called if the cached value is lost, or after upgrade.
- buildTemplates() : int
- reBuilds the fastDS data. This is called if the cached value is lost, or after upgrade.
- clearValue() : bool
- clears a value
- getValue() : mixed
- gets a value
- restoreSettings() : mixed
- Restores the settings from APC
- saveSettings() : mixed
- setPhrase() : bool
- sets a default language phrase
- setTemplate() : bool
- sets a template value
- setValue() : bool
- sets a value
Constants
TYPE_DATASTORE
public
mixed
TYPE_DATASTORE
= 'ds'
TYPE_PHRASES
public
mixed
TYPE_PHRASES
= 'ph'
TYPE_TEMPLATES
public
mixed
TYPE_TEMPLATES
= 'tm'
Properties
$building
protected
static mixed
$building
= alse
$dsCached
protected
mixed
$dsCached
$dsRebuilt
protected
mixed
$dsRebuilt
$enabled
protected
static mixed
$enabled
$fastInstance
protected
static mixed
$fastInstance
$language
protected
mixed
$language
$phrasesCached
protected
mixed
$phrasesCached
$phRebuilt
protected
mixed
$phRebuilt
$prefix
protected
mixed
$prefix
$rebuilt
protected
mixed
$rebuilt
$skipDSCache
protected
mixed
$skipDSCache
= array('wol' => 1, 'cron' => '1', 'miscoptions' => 1)
$styleid
protected
mixed
$styleid
$templatesCached
protected
mixed
$templatesCached
$tmRebuilt
protected
mixed
$tmRebuilt
Methods
__serialize()
public
__serialize() : mixed
Return values
mixed —__sleep()
public
__sleep() : mixed
Return values
mixed —__unserialize()
public
__unserialize(mixed $serialized) : mixed
Parameters
- $serialized : mixed
Return values
mixed —__wakeup()
public
__wakeup() : mixed
Return values
mixed —buildFastDS()
reBuilds the fastDS data. This is called if the cached value is lost, or after upgrade.
public
buildFastDS() : mixed
Return values
mixed —getDS()
gets a datastore value
public
getDS(mixed $dsKeys) : mixed
@param mixed string or array of string
Parameters
- $dsKeys : mixed
Return values
mixed —the datastore value
getPhrases()
gets a phrase, or set of phrases, from the default language
public
getPhrases(mixed $varnames, mixed $languageid) : string
@param mixed string or array of strings
Parameters
- $varnames : mixed
- $languageid : mixed
Return values
string —getTemplates()
gets a template from the default style
public
getTemplates(mixed $templateNames, mixed $styleid) : mixed
@param mixed string or array of string
Parameters
- $templateNames : mixed
- $styleid : mixed
Return values
mixed —instance()
Returns a reference to the current fastDS object, or false
public
static instance() : mixed
Return values
mixed —either a fastDS instance or false
setDS()
sets a datastore value
public
setDS(mixed $dsKey, mixed $value) : bool
@param string key
Parameters
- $dsKey : mixed
- $value : mixed
Return values
bool —true if it succeeded, otherwise false
setDsChanged()
public
setDsChanged(mixed $title) : mixed
Parameters
- $title : mixed
Return values
mixed —__construct()
standard constructor
protected
__construct(mixed $config) : a
@param mixed The config object from vB::getConfig()
Parameters
- $config : mixed
Return values
a —fastDS object
buildDatastore()
reBuilds the fastDS data. This is called if the cached value is lost, or after upgrade.
protected
buildDatastore(mixed $maxSize) : int
Parameters
- $maxSize : mixed
Return values
int —estimate of the space used. Note that we can't be exact.
buildPhrases()
reBuilds the fastDS data. This is called if the cached value is lost, or after upgrade.
protected
buildPhrases(mixed $maxSize) : int
Parameters
- $maxSize : mixed
Return values
int —estimate of the space used. Note that we can't be exact.
buildTemplates()
reBuilds the fastDS data. This is called if the cached value is lost, or after upgrade.
protected
buildTemplates(mixed $maxSize) : int
Parameters
- $maxSize : mixed
Return values
int —estimate of the space used. Note that we can't be exact.
clearValue()
clears a value
protected
clearValue(mixed $key) : bool
@param string key
Parameters
- $key : mixed
Return values
bool —true if it succeeded, otherwise false
getValue()
gets a value
protected
getValue(mixed $prefix, mixed $keys) : mixed
@param string
Parameters
- $prefix : mixed
- $keys : mixed
Return values
mixed —the value from fastDS
restoreSettings()
Restores the settings from APC
protected
restoreSettings(mixed $settings) : mixed
@param mixed the cached summary read from APC
Parameters
- $settings : mixed
Return values
mixed —saveSettings()
protected
saveSettings() : mixed
Return values
mixed —setPhrase()
sets a default language phrase
protected
setPhrase(mixed $varname, mixed $value) : bool
@param string key
Parameters
- $varname : mixed
- $value : mixed
Return values
bool —true if it succeeded, otherwise false
setTemplate()
sets a template value
protected
setTemplate(mixed $title, mixed $value) : bool
@param string key
Parameters
- $title : mixed
- $value : mixed
Return values
bool —true if it succeeded, otherwise false
setValue()
sets a value
protected
setValue(mixed $key, mixed $value) : bool
@param string key
Parameters
- $key : mixed
- $value : mixed
Return values
bool —true if it succeeded, otherwise false