[ Index ]
 

Code source de LifeType 1.2.4

Accédez au Source d'autres logiciels libres

Classes | Fonctions | Variables | Constantes | Tables

title

Body

[fermer]

/class/database/pdb/drivers/ -> pdbdriverbase.class.php (sommaire)

number of SQL queries executed so far. It is up to the driver classes to keep this number updated!!

Poids: 428 lignes (13 kb)
Inclus ou requis:0 fois
Référencé: 1 fois
Nécessite: 0 fichiers

Définit 1 class

PDbDriverBase:: (22 méthodes):
  PDbDriverBase()
  setDriverOpt()
  setDriverOpts()
  Execute()
  Connect()
  PConnect()
  Close()
  ErrorMsg()
  Insert_ID()
  Affected_Rows()
  IsConnected()
  _debugQuery()
  setDebug()
  qstr()
  getDriverDataDictionary()
  MetaTables()
  MetaPrimaryKeys()
  MetaColumns()
  MetaColumnNames()
  getNumQueries()
  getDbCharacterSet()
  isFullTextSupported()


Classe: PDbDriverBase  - X-Ref

\ingroup PDb

This class provides the base methods that all database drivers are expected to implement. Some methods
provide some common functionality that should be called even when the method is overwritten, so please make sure
to call the method of the parent class for those that need it.
PDbDriverBase()   X-Ref
Generates a new instance of the driver. Please use PDb::getDriver() instead


setDriverOpt( $key, $value )   X-Ref
Allows drivers to use custom options

param: key
param: value

setDriverOpts( $opts )   X-Ref
Set the driver options via an array. This method will completely replace any
options that have been set up until this moment via PDbDriverBase::setDriverOpt.

param: opts An associative array containing driver-specific options

Execute( $query, $page = -1, $itemsPerPage = 15 )   X-Ref
Executes a query and returns a PDbResultSet as a result, or false if the query wasn't
successfully executed.

This method must be implemented by database drivers.

param: query A string with the query to execute
param: page Page of records, when using pagination. Leave empty if pagination is not needed.
param: itemsPerPage Amount of record per page, when using pagination.
return: A PDbResultSet object if successful or false otherwise

Connect( $host, $username, $password, $dbname = null )   X-Ref
Starts a new connection to a databse

Database drivers should call this method after providing their own implementation.

param: host The host to which we're initiating the connection
param: username The username used to connecto the database
param: password Password assigned to the user above
param: dbname The name of the database to which we're connecting
return: Returns true if successful or false otherwise

PConnect( $host, $username, $password, $dbname )   X-Ref
Starts a new persistent connection to the database

Database drivers should call this method after providing their own implementation.

param: host The host to which we're initiating the connection
param: username The username used to connecto the database
param: password Password assigned to the user above
param: dbname The name of the database to which we're connecting
return: Returns true if successful or false otherwise

Close()   X-Ref
Closes the current connection to the database

This method must be implemented by database drivers.

return: nothing

ErrorMsg()   X-Ref
Returns the last error message that was generated by the driver

This method must be implemented by database drivers.

return: A string representing an error message, if any.        

Insert_ID()   X-Ref
The row id as generated by the last INSERT operation.

This method must be implemented by database drivers.

return: A row id

Affected_Rows()   X-Ref
Returns the number of rows affected by the last UPDATE, INSERT or DELETE operation.
Use PDbRecordSet::Row_Count() to retrieve the number of rows in a SELECT operation.

This method must be implemented by database drivers.

return: the number of affected rows

IsConnected()   X-Ref
Returns true if the driver is currently connected to a database. Connections usually happen
after Connect or PConnect are called

return: true if the driver is currently conneced or false otherwise

_debugQuery( $query )   X-Ref


setDebug( $debug )   X-Ref
Activates the debug stuff.

param: debug Whether debug should be enabled or not

qstr( $string )   X-Ref
for compatibility with ADOdb. Use Db::qstr() instead


getDriverDataDictionary( $driverName )   X-Ref
Load the correct data dictionary driver. Child classes should overwrite this method
and provide the right driver name so that this method can be called without parameters.

param: driverName the driver name.
param: A reference to the driver-specific PDbBaseDataDict object

MetaTables($ttype=false,$showSchema=false,$mask=false)   X-Ref

param: ttype can either be 'VIEW' or 'TABLE' or false.
param: showSchema returns the schema/user with the table name, eg. USER.TABLE
param: mask  is the input mask - only supported by oci8 and postgresql
return: array of tables for current database.

MetaPrimaryKeys($table, $owner=false)   X-Ref

returns: an array with the primary key columns in it.
param: table
param: owner

MetaColumns($table)   X-Ref
List columns in a database as an array of ADOFieldObjects.
See top of file for definition of object.

param: table table name to query
param: upper uppercase table name (required by some databases)
return: array of ADOFieldObjects for current table.

MetaColumnNames($table, $numIndexes=false)   X-Ref
List columns names in a table as an array.

param: table table name to query
return: array of column names for current table.

getNumQueries()   X-Ref
Returns the number of queries executed so far


getDbCharacterSet()   X-Ref

return: Returns the name of current character set, or 'default' if none has been explicitely selected

isFullTextSupported()   X-Ref
Returns true if the current database supports FULLTEXT searches. This method needs to be
implemented by child classes.

return: true if FULLTEXT is supported



Généré le : Mon Nov 26 21:04:15 2007 par Balluche grâce à PHPXref 0.7
  Clicky Web Analytics