Auth_OpenID_DatabaseConnection Class Reference

List of all members.

---

Detailed Description

The Auth_OpenID_DatabaseConnection class, which is used to emulate a PEAR database connection.

Author:

JanRain, Inc. <[email protected]> 2005-2008 Janrain, Inc. http://www.apache.org/licenses/LICENSE-2.0 Apache An empty base class intended to emulate PEAR connection functionality in applications that supply their own database abstraction mechanisms. See Auth_OpenID_SQLStore for more information. You should subclass this class if you need to create an SQL store that needs to access its database using an application's database abstraction layer instead of a PEAR database connection. Any subclass of Auth_OpenID_DatabaseConnection MUST adhere to the interface specified here.

Definition at line 25 of file DatabaseConnection.php.

Public Member Functions
	autoCommit ($mode)
	query ($sql, $params=array())
	begin ()
	commit ()
	rollback ()
	getOne ($sql, $params=array())
	getRow ($sql, $params=array())
	getAll ($sql, $params=array())

---

Member Function Documentation

Auth_OpenID_DatabaseConnection.autoCommit

(

$

mode

)

Sets auto-commit mode on this database connection.

Parameters:

bool

$mode True if auto-commit is to be used; false if not.

Definition at line 32 of file DatabaseConnection.php.

Auth_OpenID_DatabaseConnection.query	(	$	sql,
		$	params = array()
	)

Run an SQL query with the specified parameters, if any.

Parameters:

	string	$sql An SQL string with placeholders. The placeholders are assumed to be specific to the database engine for this connection.
	array	$params An array of parameters to insert into the SQL string using this connection's escaping mechanism.

Returns:

mixed $result The result of calling this connection's internal query function. The type of result depends on the underlying database engine. This method is usually used when the result of a query is not important, like a DDL query.

Definition at line 51 of file DatabaseConnection.php.

Auth_OpenID_DatabaseConnection.begin

(

)

Starts a transaction on this connection, if supported.

Definition at line 58 of file DatabaseConnection.php.

Auth_OpenID_DatabaseConnection.commit

(

)

Commits a transaction on this connection, if supported.

Definition at line 65 of file DatabaseConnection.php.

Auth_OpenID_DatabaseConnection.rollback

(

)

Performs a rollback on this connection, if supported.

Definition at line 72 of file DatabaseConnection.php.

Auth_OpenID_DatabaseConnection.getOne	(	$	sql,
		$	params = array()
	)

Run an SQL query and return the first column of the first row of the result set, if any.

Parameters:

	string	$sql An SQL string with placeholders. The placeholders are assumed to be specific to the database engine for this connection.
	array	$params An array of parameters to insert into the SQL string using this connection's escaping mechanism.

Returns:

mixed $result The value of the first column of the first row of the result set. False if no such result was found.

Definition at line 91 of file DatabaseConnection.php.

Auth_OpenID_DatabaseConnection.getRow	(	$	sql,
		$	params = array()
	)

Run an SQL query and return the first row of the result set, if any.

Parameters:

	string	$sql An SQL string with placeholders. The placeholders are assumed to be specific to the database engine for this connection.
	array	$params An array of parameters to insert into the SQL string using this connection's escaping mechanism.

Returns:

array $result The first row of the result set, if any, keyed on column name. False if no such result was found.

Definition at line 109 of file DatabaseConnection.php.

Auth_OpenID_DatabaseConnection.getAll	(	$	sql,
		$	params = array()
	)

Run an SQL query with the specified parameters, if any.

Parameters:

	string	$sql An SQL string with placeholders. The placeholders are assumed to be specific to the database engine for this connection.
	array	$params An array of parameters to insert into the SQL string using this connection's escaping mechanism.

Returns:

array $result An array of arrays representing the result of the query; each array is keyed on column name.

Definition at line 126 of file DatabaseConnection.php.

---

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

• core/openid/Auth/OpenID/DatabaseConnection.php