phpPoA2
[ class tree: phpPoA2 ] [ index: phpPoA2 ] [ all elements ]

Class: MemcachedDB

Source Location: /lib/db/MemcachedDB.php

Class Overview

GenericDB
   |
   --MemcachedDB

Memcached NOSQL database backend.


Variables

Methods


Child classes:

PAPIMemcachedDB
PAPI binding to a Memcached DB backend.

Inherited Variables

Inherited Methods

Class: GenericDB

GenericDB::__construct()
Main constructor.
GenericDB::check()
Checks if the specified key exists in the database.
GenericDB::close()
Closes the database.
GenericDB::configure()
Configure the database handler.
GenericDB::delete()
Removes the specified key from the database.
GenericDB::fetch()
Gets the value of the specified key.
GenericDB::fetch_all()
Gets all the contents stored in the database.
GenericDB::open()
Opens the database.
GenericDB::replace()
Replaces the specified key with a new value. If the key does not exist previously, it will be created.

Class Details

[line 37]
Memcached NOSQL database backend.



[ Top ]


Class Variables

$expire_time =  0

[line 43]



Tags:

access:  protected

Type:   mixed


[ Top ]

$mandatory_options = array("DBServers",
                                         "DBPrefix")

[line 39]



Tags:

access:  protected

Type:   mixed
Overrides:   Array


[ Top ]

$mc =

[line 42]



Tags:

access:  protected

Type:   mixed


[ Top ]



Class Methods


method check [line 64]

void check( $key)



Tags:

access:  public


Overrides GenericDB::check() (Checks if the specified key exists in the database.)

Parameters:

   $key  

[ Top ]

method close [line 112]

void close( )



Tags:

access:  public


Overrides GenericDB::close() (Closes the database.)

[ Top ]

method configure [line 45]

void configure( )



Tags:

access:  protected


Overridden in child classes as:

PAPIMemcachedDB::configure()

Overrides GenericDB::configure() (Configure the database handler.)

[ Top ]

method delete [line 102]

void delete( $key)



Tags:

access:  public


Overrides GenericDB::delete() (Removes the specified key from the database.)

Parameters:

   $key  

[ Top ]

method fetch [line 79]

void fetch( $key)



Tags:

access:  public


Overrides GenericDB::fetch() (Gets the value of the specified key.)

Parameters:

   $key  

[ Top ]

method fetch_all [line 83]

void fetch_all( )



Tags:

access:  public


Overrides GenericDB::fetch_all() (Gets all the contents stored in the database.)

[ Top ]

method open [line 52]

void open( )



Tags:

access:  public


Overrides GenericDB::open() (Opens the database.)

[ Top ]

method replace [line 69]

void replace( $key, $value)



Tags:

access:  public


Overrides GenericDB::replace() (Replaces the specified key with a new value. If the key does not exist previously, it will be created.)

Parameters:

   $key  
   $value  

[ Top ]


Documentation generated on Mon, 20 Feb 2012 12:07:06 +0100 by phpDocumentor 1.4.3