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

Class: GenericMySQLDB

Source Location: /lib/db/GenericMySQLDB.php

Class Overview

GenericDB
   |
   --GenericMySQLDB

Generic MySQL database class.


Author(s):

Variables

Methods


Child classes:

PAPIMySQLDB
MySQL database frontend for the PAPI Authentication Engine.

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 32]
Generic MySQL database class.



Tags:

abstract:  


[ Top ]


Class Variables

$create_sql =

[line 38]



Tags:

access:  protected

Type:   mixed


[ Top ]

$delete_sql =

[line 38]



Tags:

access:  protected

Type:   mixed


[ Top ]

$insert_sql =

[line 38]



Tags:

access:  protected

Type:   mixed


[ Top ]

$mandatory_options = array("DBHost",
                                         "DBUser",
                                         "DBPassword",
                                         "DBName")

[line 34]



Tags:

access:  protected

Type:   mixed
Overrides:   Array


[ Top ]

$prefix =

[line 39]



Tags:

access:  protected

Type:   mixed


[ Top ]

$search_all_sql =

[line 38]



Tags:

access:  protected

Type:   mixed


[ Top ]

$search_sql =

[line 38]



Tags:

access:  protected

Type:   mixed


[ Top ]

$update_sql =

[line 38]



Tags:

access:  protected

Type:   mixed


[ Top ]



Class Methods


method check [line 62]

void check( $key)



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

Parameters:

   $key  

[ Top ]

method close [line 95]

void close( )



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

[ Top ]

method configure [line 41]

void configure( )



Tags:

access:  protected


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

[ Top ]

method delete [line 90]

void delete( $key)



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

Parameters:

   $key  

[ Top ]

method fetch [line 78]

void fetch( $key)



Overridden in child classes as:

PAPIMySQLDB::fetch()

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

Parameters:

   $key  

[ Top ]

method fetch_all [line 84]

void fetch_all( )



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

[ Top ]

method getError [line 58]

void getError( )



[ Top ]

method open [line 48]

void open( )



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

[ Top ]

method replace [line 68]

void replace( $key, $value)



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:30 +0100 by phpDocumentor 1.4.3