Methods summary
private the |
# _getPdo( )
This method returns the PDO object to use for database
interactions.
This method returns the PDO object to use for database
interactions.
Returns
the
PDO object
|
private the |
# _getTable( )
This method returns the table to use when storing/retrieving
PGT's
This method returns the table to use when storing/retrieving
PGT's
Returns
the
name of the pgt storage table.
|
public an |
# getStorageType( )
This method returns an informational string giving the type of
storage used by the object (used for debugging purposes).
This method returns an informational string giving the type of
storage used by the object (used for debugging purposes).
Returns
an
informational string.
Overrides
|
public an |
# getStorageInfo( )
This method returns an informational string giving informations
on the parameters of the storage.(used for debugging purposes).
This method returns an informational string giving informations
on the parameters of the storage.(used for debugging purposes).
Returns
an
informational string.
Public
Overrides
|
public |
# __construct( CAS_Client
$cas_parent, string
$dsn_or_pdo, string $username =
'', string
$password = '',
string $table = '', string
$driver_options = null )
The class constructor.
Parameters
- $cas_parent
-
the CAS_Client instance that creates the object.
- $dsn_or_pdo
-
a dsn string to use for creating a PDO object or a PDO
object
- $username
-
the username to use when connecting to the database
- $password
-
the password to use when connecting to the database
- $table
-
the table to use for storing and retrieving PGT's
- $driver_options
-
any driver options to use when connecting to the database
Overrides
|
public |
# init( )
This method is used to initialize the storage. Halts on
error.
This method is used to initialize the storage. Halts on
error.
Overrides
|
private |
# _setErrorMode( )
This method will enable the Exception error mode on the PDO
object
This method will enable the Exception error mode on the PDO
object
|
private |
#
_resetErrorMode( )
this method will reset the error mode on the PDO object
this method will reset the error mode on the PDO object
|
protected the |
# createTableSql( )
This method returns the query used to create a pgt storage
table
This method returns the query used to create a pgt storage
table
Returns
the
create table SQL, no bind params in query
|
protected the |
# storePgtSql( )
This method returns the query used to store a pgt
This method returns the query used to store a pgt
Returns
the
store PGT SQL, :pgt and :pgt_iou are the bind params contained
in the query
|
protected the |
# retrievePgtSql( )
This method returns the query used to retrieve a pgt. the first
column of the first row should contain the pgt
This method returns the query used to retrieve a pgt. the first
column of the first row should contain the pgt
Returns
the
retrieve PGT SQL, :pgt_iou is the only bind param contained in
the query
|
protected the |
# deletePgtSql( )
This method returns the query used to delete a pgt.
This method returns the query used to delete a pgt.
Returns
the
delete PGT SQL, :pgt_iou is the only bind param contained in the
query
|
public |
# createTable( )
This method creates the database table used to store pgt's and
pgtiou's
This method creates the database table used to store pgt's and
pgtiou's
|
public |
# write( string
$pgt, string $pgt_iou
)
This method stores a PGT and its corresponding PGT Iou in the
database. Echoes a warning on error.
This method stores a PGT and its corresponding PGT Iou in the
database. Echoes a warning on error.
Parameters
- $pgt
- the PGT
- $pgt_iou
- the PGT iou
Overrides
|
public the |
# read( string
$pgt_iou )
This method reads a PGT corresponding to a PGT Iou and deletes
the corresponding db entry.
This method reads a PGT corresponding to a PGT Iou and deletes
the corresponding db entry.
Parameters
Returns
the
corresponding PGT, or FALSE on error
Overrides
|
CAS_PGTStorage_Db