Open Journal Systems  2.4.3
 All Classes Namespaces Functions Variables Groups Pages
AuthSourceDAO Class Reference
Inheritance diagram for AuthSourceDAO:
DAO

Public Member Functions

_returnAuthSourceFromRow (&$row)
 
 AuthSourceDAO ()
 
 deleteObject ($authId)
 
getDefaultPlugin ()
 
getDefaultSource ()
 
getPlugin ($authId)
 
getSource ($authId)
 
getSources ($rangeInfo=null)
 
 insertSource (&$auth)
 
 newDataObject ()
 
 setDefault ($authId)
 
 updateObject (&$auth)
 
- Public Member Functions inherited from DAO
 concat ()
 
 convertFromDB ($value, $type)
 
 convertToDB ($value, &$type)
 
 DAO ($dataSource=null, $callHooks=true)
 
 dateFromDB ($d)
 
 datetimeFromDB ($dt)
 
 datetimeToDB ($dt)
 
 dateToDB ($d)
 
 flushCache ()
 
 formatDateToDB ($date, $defaultNumWeeks=null, $acceptPastDate=true)
 
 getAffectedRows ()
 
 getDataChangedEvent ($elementId=null, $parentElementId=null)
 
getDataSource ()
 
 getDirectionMapping ($direction)
 
 getDriver ()
 
 getInsertId ($table= '', $id= '', $callHooks=true)
 
 getType ($value)
 
 replace ($table, $arrFields, $keyCols)
 
retrieve ($sql, $params=false, $callHooks=true)
 
retrieveCached ($sql, $params=false, $secsToCache=3600, $callHooks=true)
 
retrieveLimit ($sql, $params=false, $numRows=false, $offset=false, $callHooks=true)
 
retrieveRange ($sql, $params=false, $dbResultRange=null, $callHooks=true)
 
 setCacheDir ()
 
 setDataSource (&$dataSource)
 
 update ($sql, $params=false, $callHooks=true, $dieOnError=true)
 
 updateDataObjectSettings ($tableName, &$dataObject, $idArray)
 

Additional Inherited Members

- Public Attributes inherited from DAO
 $_dataSource
 

Detailed Description

Operations for retrieving and modifying AuthSource objects.

See Also
AuthSource

Definition at line 20 of file AuthSourceDAO.inc.php.

Member Function Documentation

& AuthSourceDAO::_returnAuthSourceFromRow ( $row)

Internal function to return an AuthSource object from a row.

Parameters
$rowarray
Returns
AuthSource

Definition at line 119 of file AuthSourceDAO.inc.php.

References newDataObject().

Referenced by getDefaultSource(), and getSource().

AuthSourceDAO::AuthSourceDAO ( )

Constructor.

Definition at line 26 of file AuthSourceDAO.inc.php.

References PluginRegistry\loadCategory().

AuthSourceDAO::deleteObject (   $authId)

Delete a source.

Parameters
$authIdint

Definition at line 180 of file AuthSourceDAO.inc.php.

References DAO\update().

& AuthSourceDAO::getDefaultPlugin ( )

Get plugin instance for the default authentication source.

Returns
AuthPlugin

Definition at line 52 of file AuthSourceDAO.inc.php.

References getDefaultSource().

& AuthSourceDAO::getDefaultSource ( )

Retrieve the default authentication source.

Returns
AuthSource

Definition at line 90 of file AuthSourceDAO.inc.php.

References _returnAuthSourceFromRow(), and DAO\retrieve().

Referenced by getDefaultPlugin().

& AuthSourceDAO::getPlugin (   $authId)

Get plugin instance corresponding to the ID.

Parameters
$authIdint
Returns
AuthPlugin

Definition at line 36 of file AuthSourceDAO.inc.php.

References getSource().

& AuthSourceDAO::getSource (   $authId)

Retrieve a source.

Parameters
$authIdint
Returns
AuthSource

Definition at line 69 of file AuthSourceDAO.inc.php.

References _returnAuthSourceFromRow(), and DAO\retrieve().

Referenced by getPlugin().

& AuthSourceDAO::getSources (   $rangeInfo = null)

Retrieve a list of all auth sources for the site.

Returns
array AuthSource

Definition at line 209 of file AuthSourceDAO.inc.php.

References DAO\retrieveRange().

AuthSourceDAO::insertSource ( $auth)

Insert a new source.

Parameters
$authAuthSource

Definition at line 134 of file AuthSourceDAO.inc.php.

References DAO\getInsertId(), and DAO\update().

AuthSourceDAO::newDataObject ( )

Instantiate and return a new data object.

Returns
AuthSource

Definition at line 110 of file AuthSourceDAO.inc.php.

Referenced by _returnAuthSourceFromRow().

AuthSourceDAO::setDefault (   $authId)

Set the default authentication source.

Parameters
$authIdint

Definition at line 195 of file AuthSourceDAO.inc.php.

References DAO\update().

AuthSourceDAO::updateObject ( $auth)

Update a source.

Parameters
$authAuthSource

Definition at line 157 of file AuthSourceDAO.inc.php.

References DAO\update().


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