PHP Class Horde_Db_Adapter_Pdo_Base, horde

Author: Mike Naberezny ([email protected])

Author: Derek DeVries ([email protected])

Author: Chuck Hagenbuch ([email protected])

Inheritance: extends Horde_Db_Adapter_Base

Show file Open project: horde/horde Class Usage Examples

Public Methods

Method	Description
beginDbTransaction ( )	Begins the transaction (and turns off auto-committing).
commitDbTransaction ( )	Commits the transaction (and turns on auto-committing).
connect ( )	Connect to the db
execute ( string $sql, mixed $arg1 = null, string $arg2 = null ) : PDOStatement	Executes the SQL statement in the context of this connection.
insert ( string $sql, array \| string $arg1 = null, string $arg2 = null, string $pk = null, integer $idValue = null, string $sequenceName = null ) : integer	Inserts a row into a table.
isActive ( ) : boolean	Check if the connection is active
quoteString ( string $string ) : string	Quotes a string, escaping any ' (single quote) and \ (backslash) characters.
rollbackDbTransaction ( )	Rolls back the transaction (and turns on auto-committing). Must be done if the transaction block raises an exception or returns false.
select ( string $sql, mixed $arg1 = null, string $arg2 = null ) : Horde_Db_Adapter_Pdo_Result	Returns an array of records with the column names as keys, and column values as values.
selectAll ( string $sql, mixed $arg1 = null, string $arg2 = null )	Returns an array of record hashes with the column names as keys and column values as values.
selectAssoc ( string $sql, mixed $arg1 = null, string $arg2 = null )	Returns an array where the keys are the first column of a select, and the values are the second column:
selectOne ( string $sql, mixed $arg1 = null, string $arg2 = null ) : array \| boolean	Returns a record hash with the column names as keys and column values as values.
selectValue ( string $sql, mixed $arg1 = null, string $arg2 = null ) : string	Returns a single value from a record
selectValues ( string $sql, mixed $arg1 = null, string $arg2 = null )	Returns an array of the values of the first column in a select: selectValues("SELECT id FROM companies LIMIT 3") => [1,2,3]

Protected Methods

Method	Description
_buildDsnString ( $params )
_normalizeConfig ( $params )	*########################################################################## # Protected ##########################################################################
_parseConfig ( ) : array	Parse configuration array into options for PDO constructor.

Method Details

_buildDsnString() protected method

protected _buildDsnString ( $params )

_normalizeConfig() protected method

*########################################################################## # Protected ##########################################################################

protected _normalizeConfig ( $params )

_parseConfig() protected method

Parse configuration array into options for PDO constructor.

protected _parseConfig ( ) : array
return	array	[dsn, username, password]

beginDbTransaction() public method

Begins the transaction (and turns off auto-committing).

public beginDbTransaction ( )

commitDbTransaction() public method

Commits the transaction (and turns on auto-committing).

public commitDbTransaction ( )

connect() public method

Connect to the db

public connect ( )

execute() public method

Executes the SQL statement in the context of this connection.

Deprecation: Deprecated for external usage. Use select() instead.

public execute ( string $sql, mixed $arg1 = null, string $arg2 = null ) : PDOStatement
$sql	string	SQL statement.
$arg1	mixed	Either an array of bound parameters or a query name.
$arg2	string	If $arg1 contains bound parameters, the query name.
return	PDOStatement

insert() public method

Inserts a row into a table.

public insert ( string $sql, array \| string $arg1 = null, string $arg2 = null, string $pk = null, integer $idValue = null, string $sequenceName = null ) : integer
$sql	string	SQL statement.
$arg1	array \| string	Either an array of bound parameters or a query name.
$arg2	string	If $arg1 contains bound parameters, the query name.
$pk	string	The primary key column.
$idValue	integer	The primary key value. This parameter is required if the primary key is inserted manually.
$sequenceName	string	The sequence name.
return	integer	Last inserted ID.

isActive() public method

Check if the connection is active

public isActive ( ) : boolean
return	boolean

quoteString() public method

public quoteString ( string $string ) : string
$string	string
return	string

rollbackDbTransaction() public method

Rolls back the transaction (and turns on auto-committing). Must be done if the transaction block raises an exception or returns false.

public rollbackDbTransaction ( )

select() public method

Returns an array of records with the column names as keys, and column values as values.

public select ( string $sql, mixed $arg1 = null, string $arg2 = null ) : Horde_Db_Adapter_Pdo_Result
$sql	string	SQL statement.
$arg1	mixed	Either an array of bound parameters or a query name.
$arg2	string	If $arg1 contains bound parameters, the query name.
return	Horde_Db_Adapter_Pdo_Result

selectAll() public method

Returns an array of record hashes with the column names as keys and column values as values.

public selectAll ( string $sql, mixed $arg1 = null, string $arg2 = null )
$sql	string
$arg1	mixed	Either an array of bound parameters or a query name.
$arg2	string	If $arg1 contains bound parameters, the query name.

selectAssoc() public method

selectAssoc("SELECT id, name FROM companies LIMIT 3") => [1 => 'Ford', 2 => 'GM', 3 => 'Chrysler']

public selectAssoc ( string $sql, mixed $arg1 = null, string $arg2 = null )
$sql	string
$arg1	mixed	Either an array of bound parameters or a query name.
$arg2	string	If $arg1 contains bound parameters, the query name.

selectOne() public method

Returns a record hash with the column names as keys and column values as values.

public selectOne ( string $sql, mixed $arg1 = null, string $arg2 = null ) : array \| boolean
$sql	string	A query.
$arg1	mixed	Either an array of bound parameters or a query name.
$arg2	string	If $arg1 contains bound parameters, the query name.
return	array \| boolean	A record hash or false if no record found.

selectValue() public method

Returns a single value from a record

public selectValue ( string $sql, mixed $arg1 = null, string $arg2 = null ) : string
$sql	string
$arg1	mixed	Either an array of bound parameters or a query name.
$arg2	string	If $arg1 contains bound parameters, the query name.
return	string

selectValues() public method

Returns an array of the values of the first column in a select: selectValues("SELECT id FROM companies LIMIT 3") => [1,2,3]

public selectValues ( string $sql, mixed $arg1 = null, string $arg2 = null )
$sql	string
$arg1	mixed	Either an array of bound parameters or a query name.
$arg2	string	If $arg1 contains bound parameters, the query name.