Inheritance diagram for db_abstract:

Public Member Functions
	getInstanceCfg ()

	getConnection ()

	query ($sql, array $bind=array())

	beginTransaction ()

	commit ()

	rollBack ()

	insert (array $prm)

	replace (array $prm)

	update (array $prm)

	delete (array $prm)

	makeWhere ($where, $whereOp='AND', $incWhere=true)

	getFetchMode ()

	setFetchMode ($mode)

	selectQuery (array $prm)

	select ($prm)

	count (array $prm)

	fetchAssoc (array $prm)

	fetchPairs (array $prm)

	fetchRow (array $prm)

	quoteIdentifier ($ident)

	quoteValue ($value)

	optimize ($table)

	getTablesWith (array $prm)

	getI18nTable ($table)

	getWhere (array $prm=array())

	getCache ()

	__sleep ()

	getTables ($unPrefix=true)

	prefixTable ($table)

	fields ($table)

	closeConnection ()

	prepare ($sql)

	lastInsertId ()

	getAttr ($name)

	setAttr ($name, $value)

	getCfg ()

Protected Member Functions
	tableAlias ($query, array $tblAlias)

	_connect ()

	_beginTransaction ()

	_commit ()

	_rollBack ()

	beforeInit ()

	afterInit ()

Protected Attributes
	$connection

	$cfg

Detailed Description

Abstract class db classes

Definition at line 10 of file db/abstract.class.php.

Member Function Documentation

◆ __sleep()

__sleep ( )

Magic function to allow serialisation

Returns: array

Definition at line 629 of file db/abstract.class.php.

◆ _beginTransaction()

_beginTransaction ( )

abstractprotected

Begin a transaction.

◆ _commit()

_commit ( )

abstractprotected

Commit a transaction.

◆ _connect()

_connect ( )

abstractprotected

Creates a connection to the database.

◆ _rollBack()

_rollBack ( )

abstractprotected

Roll-back a transaction.

◆ afterInit()

afterInit ( )

protectedinherited

Call just after the configuration initialisation

Definition at line 40 of file object.class.php.

◆ beforeInit()

beforeInit ( )

protectedinherited

Call just before the configuration initialisation

Definition at line 35 of file object.class.php.

◆ beginTransaction()

beginTransaction ( )

Leave autocommit mode and begin a transaction.

Returns: bool True

Definition at line 58 of file db/abstract.class.php.

◆ closeConnection()

closeConnection ( )

abstract

Force the connection to close.

Returns: void

◆ commit()

commit ( )

Commit a transaction and return to autocommit mode.

Returns: bool True

Definition at line 69 of file db/abstract.class.php.

◆ count()

count ( array $prm )

Count the number of result

Parameters

array $prm Same option than selectQuery

Returns: int

See also: selectQuery

Definition at line 462 of file db/abstract.class.php.

◆ delete()

delete ( array $prm )

Deletes table rows based on a WHERE clause.

Parameters

array

$prm

The parameter for the replace query :

string table (required) : The table to work in
db_where|array|string where : The where clause. If array, they are used with AND. (default: none)
string whereOp : The operator for the where clause if it's an array (default: AND)
bool optim : Make an optimization after the delete (default: true)

Returns: int Deleted rows

Definition at line 180 of file db/abstract.class.php.

◆ fetchAssoc()

fetchAssoc ( array $prm )

Fetches all SQL result rows as an associative array. Same parameter as select.

The first column is the key, the entire row array is the value. You should construct the query to be sure that the first column contains unique values, or else rows with duplicate values in the first column will overwrite previous data.

Parameters

array $prm, same as select

Returns: array

See also: select

Definition at line 487 of file db/abstract.class.php.

◆ fetchPairs()

fetchPairs ( array $prm )

Fetches all SQL result rows as an array of key-value pairs.

The first column is the key, the second column is the value.

Parameters

array $prm, same as select.

Returns: array

See also: select

Definition at line 502 of file db/abstract.class.php.

◆ fetchRow()

fetchRow ( array $prm )

Fetches the first row of the SQL result. Uses the current fetchMode for the adapter.

Parameters

array $prm, same as select.

Returns: array

See also: select

Definition at line 515 of file db/abstract.class.php.

◆ fields()

fields ( $table )

abstract

Returns the fields

Parameters

string $table TableName

Returns: array

◆ getAttr()

getAttr ( $name )

inherited

Get an attribute

Parameters

string $name Attribute name

Returns: mixed|null The attribute or null if not set

Definition at line 48 of file object.class.php.

◆ getCache()

getCache ( )

Get a cache instance

Returns: cache_abstract

Definition at line 620 of file db/abstract.class.php.

◆ getCfg()

getCfg ( )

inherited

Get the configuration object

Returns: config

Definition at line 67 of file object.class.php.

◆ getConnection()

getConnection ( )

Returns the connection object, ressource. Initialize the connection if need.

Returns: object|resource|null

Definition at line 34 of file db/abstract.class.php.

◆ getFetchMode()

getFetchMode ( )

Get the fetch mode.

Returns: int

Definition at line 236 of file db/abstract.class.php.

◆ getI18nTable()

getI18nTable ( $table )

Get the i18n tablename

Parameters

string $table table name

Returns: string|null The i18n tablename or null if not found

Definition at line 594 of file db/abstract.class.php.

◆ getInstanceCfg()

getInstanceCfg ( )

Get the configuration parameter used to create this object

Returns: string|array

Definition at line 24 of file db/abstract.class.php.

◆ getTables()

getTables ( $unPrefix = true )

abstract

Abstract Methods Returns a list of the tables in the database.

Parameters

boolean $unPrefix Indicate if the table name shold remove paramettred prefix

Returns: array

◆ getTablesWith()

getTablesWith ( array $prm )

Returns a list of the tables with the parameters provided

Parameters

array

$prm

The parameters for the search:

string start
string contains
string end

Returns: array

Definition at line 570 of file db/abstract.class.php.

◆ getWhere()

getWhere ( array $prm = array() )

Get a where object

Parameters

array $prm The configuration for the where object

Returns: db_where

Definition at line 609 of file db/abstract.class.php.

◆ insert()

insert ( array $prm )

Insert on the database

Parameters

array

$prm

The parameter for the insert query :

string table (required) : The table to work in
array values (required) : The values to insert. The key are the identifier

Returns: mixed the inserted id

Definition at line 94 of file db/abstract.class.php.

◆ lastInsertId()

lastInsertId ( )

abstract

Gets the last ID generated automatically by an IDENTITY/AUTOINCREMENT column.

Returns: string

◆ makeWhere()

makeWhere	(	$where,
		$whereOp = `'AND'`,
		$incWhere = `true`
	)

Make a where clause from a where parameter (select, update or delete)

Parameters

string \| array	$where
string	$whereOp	Operator (AND or OR)
bool	$incWhere	Indicates if the WHERE keywords should be included at the beginning

Returns: null|string the where string, starting with WHERE

Definition at line 210 of file db/abstract.class.php.

◆ optimize()

optimize ( $table )

Optimize a table

Parameters

string $table The table name

Definition at line 557 of file db/abstract.class.php.

◆ prefixTable()

prefixTable ( $table )

abstract

Add a prefix that was previsouly removed for a table name

Parameters

string $table Table name

Returns: string Table name with it's prefix, if existing

◆ prepare()

prepare ( $sql )

abstract

Prepare a statement and return a PDOStatement.

Parameters

string | Zend_Db_Select $sql SQL query

Returns: PDOStatement

◆ query()

query	(		$sql,
		array	$bind = `array()`
	)

Prepare and execute a query, with binding if provided

Parameters

string $sql The query to execute

Returns: PDOStatement

Definition at line 45 of file db/abstract.class.php.

◆ quoteIdentifier()

quoteIdentifier ( $ident )

Quotes an identifier.

Parameters

string $ident The identifier.

Returns: string The quoted identifier.

Definition at line 527 of file db/abstract.class.php.

◆ quoteValue()

quoteValue ( $value )

Quotes a value.

Parameters

string $value The value.

Returns: string The quoted value.

Definition at line 548 of file db/abstract.class.php.

◆ replace()

replace ( array $prm )

Replace on the database

Parameters

array

$prm

The parameter for the replace query :

string table (required) : The table to work in
array values (required) : The values to replace. The key are the identifier

Returns: mixed the inserted id

Definition at line 120 of file db/abstract.class.php.

◆ rollBack()

rollBack ( )

Roll back a transaction and return to autocommit mode.

Returns: bool True

Definition at line 80 of file db/abstract.class.php.

◆ select()

select ( $prm )

Create a Select Query

Parameters

array | string $prm Query as string or array: The parameter for the select query (

See also

selectQuery) and plus:

int result : The result type MYSQL_ASSOC, MYSQL_NUM or MYSQL_BOTH (default: MYSQL_BOTH)

Returns: array Numeric array. Each line is one result

Definition at line 422 of file db/abstract.class.php.

◆ selectQuery()

selectQuery ( array $prm )

Create a Select Query

Parameters

array

$prm

The parameter for the select query :

array|string fields : The fields to select (default: *)
string table (required) : The table to work in
string moreTables : More table to select (string or array, if array, keys will be used as alias if non numeric)
array join : tables to join. Keys are:
- string table (required) : table to join
- string dir: how to join (default: 'left')
- string on: on Clause to join the table (default: 1)
- string alias: table alias (default: none)
array bind : Data to bind
bool bindData : Bind the data inside the query
db_where|array|string where : The where clause. If array, they are used with AND. (default: none)
string whereOp : The operator for the where clause if it's an array (default: AND)
string order : The order clause (default: none)
int start : The select start (default: 0)
int nb : The select limit (default: unlimited)
string group : The group clause (default: none)
string groupAfter : The group clause to be done after everything else (useful for order grouping queries) (default: none)
string having : The having clause (default: none)

Returns: string The select query

Exceptions

nException if no table provided

Definition at line 274 of file db/abstract.class.php.

◆ setAttr()

setAttr	(	$name,
		$value
	)

inherited

Set an attribute

Parameters

string	$name	Attribute name
mixed	$value	Attribute value

Definition at line 58 of file object.class.php.

◆ setFetchMode()

setFetchMode ( $mode )

Set the fetch mode.

Parameters

int $mode

Definition at line 245 of file db/abstract.class.php.

◆ tableAlias()

tableAlias	(		$query,
		array	$tblAlias
	)

protected

Apply the table alias to a query

Parameters

string	$query	The query
array	$tblAlias	The alias (keys: tablenames, values: aliases)

Returns: string The query with the aliases applied

Definition at line 397 of file db/abstract.class.php.

◆ update()

update ( array $prm )

Update on the database

Parameters

array

$prm

The parameter for the replace query :

string table (required) : The table to work in
array values (required) : The values to update. A string index array: index are the field
db_where|array|string where : The where clause. If array, they are used with AND. (default: none)
string whereOp : The operator for the where clause if it's an array (default: AND)

Returns: int Affected rows (Can return 0 if no change)

Exceptions

nException

Definition at line 149 of file db/abstract.class.php.

Field Documentation

◆ $cfg

$cfg

protectedinherited

Definition at line 17 of file object.class.php.

◆ $connection

$connection

protected

Definition at line 17 of file db/abstract.class.php.

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

db/abstract.class.php

Public Member Functions

Protected Member Functions

Protected Attributes

Detailed Description

Member Function Documentation

◆ __sleep()

◆ _beginTransaction()

◆ _commit()

◆ _connect()

◆ _rollBack()

◆ afterInit()

◆ beforeInit()

◆ beginTransaction()

◆ closeConnection()

◆ commit()

◆ count()

◆ delete()

◆ fetchAssoc()

◆ fetchPairs()

◆ fetchRow()

◆ fields()

◆ getAttr()

◆ getCache()

◆ getCfg()

◆ getConnection()

◆ getFetchMode()

◆ getI18nTable()

◆ getInstanceCfg()

◆ getTables()

◆ getTablesWith()

◆ getWhere()

◆ insert()

◆ lastInsertId()

◆ makeWhere()

◆ optimize()

◆ prefixTable()

◆ prepare()

◆ query()

◆ quoteIdentifier()

◆ quoteValue()

◆ replace()

◆ rollBack()

◆ select()

◆ selectQuery()

◆ setAttr()

◆ setFetchMode()

◆ tableAlias()

◆ update()

Field Documentation

◆ $cfg

◆ $connection