DboPear Class Reference

Inheritance diagram for DboPear:

DboSource DataSource Object

List of all members.


Public Member Functions

 connect ($config)
 disconnect ()
 execute ($sql)
 fetchRow ($sql=null)
 fields ($tableName)
 insertMulti ($table, $fields, $values)
 lastAffected ()
 lastError ()
 lastInsertId ($table)
 lastNumRows ()
 prepareValue ($data)
 selectLimit ($limit, $offset= '0')
 tablesList ()

Public Attributes

 $_pear = null

Detailed Description

Definition at line 45 of file dbo_pear.php.

Member Function Documentation

DboPear::connect ( $  config  ) 

Connects to the database using options in the given configuration array.

Parameters:
array $config Configuration array for connecting
Returns:
boolean True if the database could be connected, else false

Definition at line 61 of file dbo_pear.php.

References DataSource::$config, and Configure::read().

DboPear::disconnect (  ) 

Disconnects from database.

Returns:
boolean True if the database could be disconnected, else false

Definition at line 78 of file dbo_pear.php.

DboPear::execute ( $  sql  ) 

Executes given SQL statement.

Parameters:
string $sql SQL statement
Returns:
resource Result resource identifier

Reimplemented from DboSource.

Definition at line 88 of file dbo_pear.php.

Referenced by fetchRow().

DboPear::fetchRow ( $  sql = null  ) 

Returns a row from given resultset as an array .

Returns:
array The fetched row as an array

Reimplemented from DboSource.

Definition at line 97 of file dbo_pear.php.

References execute().

DboPear::fields ( $  tableName  ) 

Returns an array of the fields in given table name.

Parameters:
string $tableName Name of database table to inspect
Returns:
array Fields in table. Keys are name and type

Definition at line 153 of file dbo_pear.php.

References $data, and DboSource::name().

DboPear::insertMulti ( $  table,
$  fields,
$  values 
)

Inserts multiple values into a join table

Parameters:
string $table
string $fields
array $values

Reimplemented from DboSource.

Definition at line 234 of file dbo_pear.php.

References DboSource::query().

DboPear::lastAffected (  ) 

Returns number of affected rows in previous database operation. If no previous operation exists, this returns false.

Returns:
int Number of affected rows

Definition at line 189 of file dbo_pear.php.

DboPear::lastError (  ) 

Returns a formatted error message from previous database operation.

Returns:
string Error message

Definition at line 180 of file dbo_pear.php.

DboPear::lastInsertId ( $  table  ) 

Returns the ID generated from the previous INSERT operation.

Parameters:
string $table Name of the database table
Returns:
int

Reimplemented from DataSource.

Definition at line 213 of file dbo_pear.php.

References DboSource::field().

DboPear::lastNumRows (  ) 

Returns number of rows in previous resultset. If no previous resultset exists, this returns false.

Returns:
int Number of rows in resultset

Definition at line 199 of file dbo_pear.php.

DboPear::prepareValue ( $  data  ) 

Returns a quoted and escaped string of $data for use in an SQL statement.

Parameters:
string $data String to be prepared for use in an SQL statement
Returns:
string Quoted and escaped

Definition at line 171 of file dbo_pear.php.

References $data.

DboPear::selectLimit ( $  limit,
$  offset = '0' 
)

Returns a limit statement in the correct format for the particular database.

Parameters:
int $limit Limit of results returned
int $offset Offset from which to start results
Returns:
string SQL limit/offset statement

Definition at line 224 of file dbo_pear.php.

DboPear::tablesList (  ) 

Returns an array of tables in the database. If there are no tables, an error is raised and the application exits. :WARNING: :TODO: POSTGRESQL & MYSQL ONLY! PEAR::DB doesn't support universal table listing.

Returns:
array Array of tablenames in the database

Definition at line 112 of file dbo_pear.php.

References DboSource::name().

Member Data Documentation

DboPear::$_pear = null

Definition at line 53 of file dbo_pear.php.

The documentation for this class was generated from the following file: