Docs For Class vB

Description

Class for fetching and initializing the vBulletin datastore from the database

version: $Revision: 26512 $
date: $Date: 2008-04-29 11:12:48 -0500 (Tue, 29 Apr 2008) $

Located in /includes/class_core.php (line 1235)

Direct descendents

Class	Description
vB_Datastore_eAccelerator	Class for fetching and initializing the vBulletin datastore from eAccelerator
vB_Datastore_Memcached	Class for fetching and initializing the vBulletin datastore from a Memcache Server
vB_Datastore_APC	Class for fetching and initializing the vBulletin datastore from APC
vB_Datastore_XCache	Class for fetching and initializing the vBulletin datastore from XCache
vB_Datastore_Filecache	Class for fetching and initializing the vBulletin datastore from files

Variable Summary

vB_Database $dbobject

array $defaultitems

array $itemarray

string $prefix

vB_Registry $registry

Method Summary

vB_Datastore vB_Datastore (vB_Registry &$registry, vB_Database &$dbobject)

void check_options ()

void do_db_fetch (string $itemlist)

void fetch (array $itemarray)

boolean register (string $title, mixed $data, [integer $unserialize_detect = 2])

Variables

vB_Database $dbobject = null (line 1277)

This variable should be set to be a reference to the database object

array $defaultitems = array(
'options',
'bitfields',
'attachmentcache',
'forumcache',
'usergroupcache',
'stylecache',
'languagecache',
'products',
'pluginlist',
'cron',
'profilefield',
'loadcache',
'noticecache'
) (line 1242)

Default items that are always loaded by fetch();

array $itemarray = array() (line 1263)

This variable contains a list of all items to be returned from the datastore

string $prefix = '' (line 1284)

Unique prefix for item's title, required for multiple forums on the same server using the same classes that read/write to memory

vB_Registry $registry = null (line 1270)

This variable should be set to be a reference to the registry object

Methods

Constructor vB_Datastore (line 1292)

Constructor - establishes the database object to use for datastore queries

vB_Datastore vB_Datastore (vB_Registry &$registry, vB_Database &$dbobject)

vB_Registry &$registry: The registry object
vB_Database &$dbobject: The database object

check_options (line 1423)

Checks that the options item has come out of the datastore correctly

and sets the 'versionnumber' variable

void check_options ()

do_db_fetch (line 1403)

Performs the actual fetching of the datastore items for the database, child classes may use this

void do_db_fetch (string $itemlist)

string $itemlist: title of the datastore item

fetch (line 1369)

Fetches the contents of the datastore from the database

void fetch (array $itemarray)

array $itemarray: Array of items to fetch from the datastore

Redefined in descendants as:

vB_Datastore_eAccelerator::fetch() : Fetches the contents of the datastore from eAccelerator
vB_Datastore_Memcached::fetch() : Fetches the contents of the datastore from a Memcache Server
vB_Datastore_APC::fetch() : Fetches the contents of the datastore from APC
vB_Datastore_XCache::fetch() : Fetches the contents of the datastore from XCache
vB_Datastore_Filecache::fetch() : Fetches the contents of the datastore from cache files

register (line 1323)

Sorts the data returned from the cache and places it into appropriate places

boolean register (string $title, mixed $data, [integer $unserialize_detect = 2])

string $title: The name of the data item to be processed
mixed $data: The data associated with the title
integer $unserialize_detect: If the data needs to be unserialized, 0 = no, 1 = yes, 2 = auto detect

Redefined in descendants as:

vB_Datastore_eAccelerator::register() : Sorts the data returned from the cache and places it into appropriate places
vB_Datastore_Memcached::register() : Sorts the data returned from the cache and places it into appropriate places
vB_Datastore_APC::register() : Sorts the data returned from the cache and places it into appropriate places
vB_Datastore_XCache::register() : Sorts the data returned from the cache and places it into appropriate places