Open Journal Systems  3.3.0
AuthSourceDAO Class Reference
Inheritance diagram for AuthSourceDAO:
DAO

Public Member Functions

 __construct ()
 
 _fromRow ($row)
 
 deleteObject ($authId)
 
 getDefaultPlugin ()
 
 getDefaultSource ()
 
 getPlugin ($authId)
 
 getSource ($authId)
 
 getSources ($rangeInfo=null)
 
 insertObject ($auth)
 
 newDataObject ()
 
 setDefault ($authId)
 
 updateObject ($auth)
 
- Public Member Functions inherited from DAO
 __construct ($dataSource=null, $callHooks=true)
 
 concat ()
 
 convertFromDB ($value, $type)
 
 convertToDB ($value, &$type)
 
 dateFromDB ($d)
 
 datetimeFromDB ($dt)
 
 datetimeToDB ($dt)
 
 dateToDB ($d)
 
 flushCache ()
 
 formatDateToDB ($date, $defaultNumWeeks=null, $acceptPastDate=true)
 
 getAdditionalFieldNames ()
 
 getAffectedRows ()
 
 getDataObjectSettings ($tableName, $idFieldName, $idFieldValue, $dataObject)
 
 getDataSource ()
 
 getDirectionMapping ($direction)
 
 getDriver ()
 
 getLocaleFieldNames ()
 
 getType ($value)
 
 handleError ($dataSource, $sql)
 
 nullOrInt ($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)
 

Data Fields

 $plugins
 
- Data Fields inherited from DAO
 $_dataSource
 

Additional Inherited Members

- Static Public Member Functions inherited from DAO
static getDataChangedEvent ($elementId=null, $parentElementId=null, $content='')
 
- Protected Member Functions inherited from DAO
 _getInsertId ($table='', $id='')
 

Detailed Description

Operations for retrieving and modifying AuthSource objects.

See also
AuthSource

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

Constructor & Destructor Documentation

◆ __construct()

AuthSourceDAO::__construct ( )

Constructor.

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

References PluginRegistry\loadCategory().

Member Function Documentation

◆ _fromRow()

AuthSourceDAO::_fromRow (   $row)

Internal function to return an AuthSource object from a row.

Parameters
$rowarray
Returns
AuthSource

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

References newDataObject().

Referenced by getDefaultSource(), and getSource().

◆ deleteObject()

AuthSourceDAO::deleteObject (   $authId)

Delete a source.

Parameters
$authIdint

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

References DAO\update().

◆ getDefaultPlugin()

AuthSourceDAO::getDefaultPlugin ( )

Get plugin instance for the default authentication source.

Returns
AuthPlugin

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

References getDefaultSource().

◆ getDefaultSource()

AuthSourceDAO::getDefaultSource ( )

Retrieve the default authentication source.

Returns
AuthSource

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

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

Referenced by getDefaultPlugin().

◆ getPlugin()

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

◆ getSource()

AuthSourceDAO::getSource (   $authId)

Retrieve a source.

Parameters
$authIdint
Returns
AuthSource

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

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

Referenced by getPlugin().

◆ getSources()

AuthSourceDAO::getSources (   $rangeInfo = null)

Retrieve a list of all auth sources for the site.

Returns
array AuthSource

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

References DAO\retrieveRange().

◆ insertObject()

AuthSourceDAO::insertObject (   $auth)

Insert a new source.

Parameters
$authAuthSource

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

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

◆ newDataObject()

AuthSourceDAO::newDataObject ( )

Instantiate and return a new data object.

Returns
AuthSource

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

Referenced by _fromRow().

◆ setDefault()

AuthSourceDAO::setDefault (   $authId)

Set the default authentication source.

Parameters
$authIdint

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

References DAO\update().

◆ updateObject()

AuthSourceDAO::updateObject (   $auth)

Update a source.

Parameters
$authAuthSource

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

References DAO\update().

Field Documentation

◆ $plugins

AuthSourceDAO::$plugins

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


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