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

Class: DBADB

Source Location: /lib/db/DBADB.php

Class Overview

GenericDB
   |
   --DBADB

Berkeley DB backend.


Variables

Methods


Child classes:

PAPIDBADB
PAPI binding to a Berkeley DB backend.
AuthorizedDBADB
Authorization lists binding to a Berkeley DB backend.
InviteDBADB
Invites binding to a Berkeley 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 31]
Berkeley DB backend.



[ Top ]


Class Variables

$mandatory_options = array("DBFile")

[line 33]



Tags:

access:  protected

Type:   mixed
Overrides:   Array


[ Top ]



Class Methods


method check [line 47]

void check( $key)



Tags:

access:  public


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

Parameters:

   $key  

[ Top ]

method close [line 78]

void close( )



Tags:

access:  public


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

[ Top ]

method configure [line 35]

void configure( )



Tags:

access:  protected


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

[ Top ]

method delete [line 71]

void delete( $key)



Tags:

access:  public


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

Parameters:

   $key  

[ Top ]

method fetch [line 57]

void fetch( $key)



Tags:

access:  public


Overridden in child classes as:

PAPIDBADB::fetch()
AuthorizedDBADB::fetch()
InviteDBADB::fetch()

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

Parameters:

   $key  

[ Top ]

method fetch_all [line 61]

void fetch_all( )



Tags:

access:  public


Overridden in child classes as:

AuthorizedDBADB::fetch_all()
InviteDBADB::fetch_all()

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

[ Top ]

method open [line 42]

void open( )



Tags:

access:  public


Overridden in child classes as:

AuthorizedDBADB::open()
InviteDBADB::open()

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

[ Top ]

method replace [line 51]

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 Tue, 25 Jan 2011 11:24:29 +0100 by phpDocumentor 1.4.3