Docs For Class vB_Datastore

Description

Class for fetching and initializing the vBulletin datastore from a Memcache Server

version: $Revision: 32878 $
date: $Date: 2009-10-28 13:38:49 -0500 (Wed, 28 Oct 2009) $

Located in /includes/class_datastore.php (line 141)

vB_Datastore
   |
   --vB_Datastore_Memcached

Variable Summary

Memcache $memcache

boolean $memcache_connected

boolean $memcache_set

boolean $store_result

Method Summary

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

void build (string $title, $data)

void close ()

integer connect ()

boolean do_fetch (string $title, array &$unfetched_items)

void fetch (array $items)

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

Variables

Memcache $memcache = null (line 148)

The Memcache object

boolean $memcache_connected = false (line 162)

To verify a connection is still active

boolean $memcache_set = true (line 155)

To prevent locking when the memcached has been restarted we want to use add rather than set

boolean $store_result = false (line 169)

Indicates if the result of a call to the register function should store the value in memory

Inherited Variables

Inherited from vB_Datastore

vB_Datastore::$checked_options
vB_Datastore::$dbobject
vB_Datastore::$defaultitems
vB_Datastore::$prefix
vB_Datastore::$registered
vB_Datastore::$registry

Methods

Constructor vB_Datastore_Memcached (line 177)

Constructor - establishes the database object to use for datastore queries

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

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

build (line 329)

Updates the appropriate cache file

void build (string $title, $data)

string $title: title of the datastore item
$data

close (line 232)

Close Wrapper for Memcache

void close ()

connect (line 194)

Connect Wrapper for Memcache

return: When a new connection is made 1 is returned, 2 if a connection already existed

integer connect ()

do_fetch (line 291)

Fetches the data from shared memory and detects errors

boolean do_fetch (string $title, array &$unfetched_items)

string $title: title of the datastore item
array &$unfetched_items: A reference to an array of items that failed and need to fetched from the database

fetch (line 248)

Fetches the contents of the datastore from a Memcache Server

void fetch (array $items)

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

Redefinition of:

vB_Datastore::fetch(): Fetches the contents of the datastore from the database

register (line 313)

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

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

string $title: The name of the data item to be processed
mixed $data: The data associated with the title
$unserialize_detect

Redefinition of:

vB_Datastore::register(): Sorts the data returned from the cache and places it into appropriate places

Inherited Methods

Inherited From vB_Datastore

vB_Datastore::vB_Datastore()
vB_Datastore::check_options()
vB_Datastore::do_db_fetch()
vB_Datastore::fetch()
vB_Datastore::prepare_itemarray()
vB_Datastore::prepare_itemlist()
vB_Datastore::register()