PHP Class Horde_Db_Adapter, horde

Author: Mike Naberezny ([email protected])

Author: Derek DeVries ([email protected])

Author: Chuck Hagenbuch ([email protected])

Show file Open project: horde/horde Class Usage Examples

Public Methods

Method	Description
adapterName ( ) : string	Returns the human-readable name of the adapter. Use mixed case - one can always use downcase if needed.
addLimitOffset ( string $sql, array $options ) : string	Appends +LIMIT+ and +OFFSET+ options to a SQL statement.
addLock ( &$sql, array $options = [] )	Appends a locking clause to an SQL statement.
beginDbTransaction ( )	Begins the transaction (and turns off auto-committing).
commitDbTransaction ( )	Commits the transaction (and turns on auto-committing).
connect ( )	Connect to the db.
delete ( string $sql, mixed $arg1 = null, string $arg2 = null ) : integer	Executes the delete statement and returns the number of rows affected.
disconnect ( )	Disconnect from db.
execute ( string $sql, mixed $arg1 = null, string $arg2 = null ) : mixed	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.
insertBlob ( string $table, array $fields, string $pk = null, integer $idValue = null ) : integer	Inserts a row including BLOBs into a table.
isActive ( ) : boolean	Is the connection active?
prefetchPrimaryKey ( $tableName = null ) : boolean	Should primary key values be selected from their corresponding sequence before the insert statement? If true, next_sequence_value is called before each insert to set the record's primary key.
quoteString ( string $string ) : string	Quotes a string, escaping any special characters.
rawConnection ( ) : resource	Provides access to the underlying database connection. Useful for when you need to call a proprietary method such as postgresql's lo_* methods.
reconnect ( )	Reconnect to the db.
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_Base_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 ) : array	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 ) : array	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	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 ) : array	Returns an array of the values of the first column in a select: selectValues("SELECT id FROM companies LIMIT 3") => [1,2,3]
supportsCountDistinct ( ) : boolean	Does this adapter support using DISTINCT within COUNT? This is +true+ for all adapters except sqlite.
supportsMigrations ( ) : boolean	Does this adapter support migrations? Backend specific, as the abstract adapter always returns +false+.
transactionStarted ( ) : boolean	Check if a transaction has been started.
update ( string $sql, mixed $arg1 = null, string $arg2 = null ) : integer	Executes the update statement and returns the number of rows affected.
updateBlob ( string $table, array $fields, string $where = '' )	Updates rows including BLOBs into a table.

Method Details

adapterName() public method

Returns the human-readable name of the adapter. Use mixed case - one can always use downcase if needed.

public adapterName ( ) : string
return	string

addLimitOffset() public method

Appends +LIMIT+ and +OFFSET+ options to a SQL statement.

public addLimitOffset ( string $sql, array $options ) : string
$sql	string	SQL statement.
$options	array	TODO
return	string

addLock() public method

This method *modifies* the +sql+ parameter. # SELECT * FROM suppliers FOR UPDATE add_lock! 'SELECT * FROM suppliers', :lock => true add_lock! 'SELECT * FROM suppliers', :lock => ' FOR UPDATE'

public addLock ( &$sql, array $options = [] )
$options	array	TODO.

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 ( )

delete() public method

Executes the delete statement and returns the number of rows affected.

public delete ( string $sql, mixed $arg1 = null, string $arg2 = null ) : integer
$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	integer	Number of rows affected.

disconnect() public method

Disconnect from db.

public disconnect ( )

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 ) : mixed
$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	mixed

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.

insertBlob() public method

Inserts a row including BLOBs into a table.

public insertBlob ( string $table, array $fields, string $pk = null, integer $idValue = null ) : integer
$table	string	The table name.
$fields	array	A hash of column names and values. BLOB columns must be provided as Horde_Db_Value_Binary objects.
$pk	string	The primary key column.
$idValue	integer	The primary key value. This parameter is required if the primary key is inserted manually.
return	integer	Last inserted ID.

isActive() public method

Is the connection active?

public isActive ( ) : boolean
return	boolean

prefetchPrimaryKey() public method

This is false for all adapters but Firebird.

public prefetchPrimaryKey ( $tableName = null ) : boolean
return	boolean

quoteString() public method

Quotes a string, escaping any special characters.

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

rawConnection() public method

Provides access to the underlying database connection. Useful for when you need to call a proprietary method such as postgresql's lo_* methods.

public rawConnection ( ) : resource
return	resource

reconnect() public method

Reconnect to the db.

public reconnect ( )

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_Base_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_Base_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 ) : array
$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	array

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 ) : array
$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	array

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
$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	array

selectValue() public method

Returns a single value from a record

public selectValue ( string $sql, mixed $arg1 = null, string $arg2 = null ) : string
$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	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 ) : array
$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	array

supportsCountDistinct() public method

Does this adapter support using DISTINCT within COUNT? This is +true+ for all adapters except sqlite.

public supportsCountDistinct ( ) : boolean
return	boolean

supportsMigrations() public method

Does this adapter support migrations? Backend specific, as the abstract adapter always returns +false+.

public supportsMigrations ( ) : boolean
return	boolean

transactionStarted() public method

Check if a transaction has been started.

public transactionStarted ( ) : boolean
return	boolean	True if transaction has been started.

update() public method

Executes the update statement and returns the number of rows affected.

public update ( string $sql, mixed $arg1 = null, string $arg2 = null ) : integer
$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	integer	Number of rows affected.

updateBlob() public method

Updates rows including BLOBs into a table.

public updateBlob ( string $table, array $fields, string $where = '' )
$table	string	The table name.
$fields	array	A hash of column names and values. BLOB columns must be provided as Horde_Db_Value_Binary objects.
$where	string	A WHERE clause.