Class: Auth_OpenID_SQLStore - X-Ref
This is the parent class for the SQL stores, which contains the
logic common to all of the SQL stores.
The table names used are determined by the class variables
associations_table_name and nonces_table_name. To change the name
of the tables used, pass new table names into the constructor.
To create the tables with the proper schema, see the createTables
method.
This class shouldn't be used directly. Use one of its subclasses
instead, as those contain the code necessary to use a specific
database. If you're an OpenID integrator and you'd like to create
an SQL-driven store that wraps an application's database
abstraction, be sure to create a subclass of
{@link Auth_OpenID_DatabaseConnection} that calls the application's
database abstraction calls. Then, pass an instance of your new
database connection class to your SQLStore subclass constructor.
All methods other than the constructor and createTables should be
considered implementation details.
|
Auth_OpenID_SQLStore($connection,$associations_table = null,$nonces_table = null)
X-Ref
|
This creates a new SQLStore instance. It requires an
established database connection be given to it, and it allows
overriding the default table names.
param: connection $connection This must be an established
param: associations_table: This is an optional parameter to
param: nonces_table: This is an optional parameter to specify
|
|
isError($value)
X-Ref
|
Returns true if $value constitutes a database error; returns
false otherwise.
|
|
resultToBool($obj)
X-Ref
|
Converts a query result to a boolean. If the result is a
database error according to $this->isError(), this returns
false; otherwise, this returns true.
|
|
setSQL()
X-Ref
|
This method should be overridden by subclasses. This method is
called by the constructor to set values in $this->sql, which is
an array keyed on sql name.
|
|
reset()
X-Ref
|
Resets the store by removing all records from the store's
tables.
|
|
_octify($str)
X-Ref
|
"Octifies" a binary string by returning a string with escaped
octal bytes. This is used for preparing binary data for
PostgreSQL BYTEA fields.
|
|
_unoctify($str)
X-Ref
|
"Unoctifies" octal-escaped data from PostgreSQL and returns the
resulting ASCII (possibly binary) string.
|