Public Member Functions | |
| & | _returnAccessKeyFromRow ($row) |
| deleteAccessKeyById ($accessKeyId) | |
| deleteExpiredKeys () | |
| deleteObject (&$accessKey) | |
| & | getAccessKey ($accessKeyId) |
| & | getAccessKeyByKeyHash ($context, $userId, $keyHash, $assocId=null) |
| & | getAccessKeyByUserId ($context, $userId) |
| getInsertId () | |
| insertObject ($accessKey) | |
| newDataObject () | |
| transferAccessKeys ($oldUserId, $newUserId) | |
| updateObject (&$accessKey) | |
 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) | |
Additional Inherited Members | |
| Static Public Member Functions inherited from DAO | |
| static | getDataChangedEvent ($elementId=null, $parentElementId=null, $content='') |
| Data Fields inherited from DAO | |
| $_dataSource | |
| Protected Member Functions inherited from DAO | |
| _getInsertId ($table='', $id='') | |
Detailed Description
Operations for retrieving and modifying AccessKey objects.
- See also
- AccessKey
Definition at line 20 of file AccessKeyDAO.inc.php.
Member Function Documentation
◆ _returnAccessKeyFromRow()
| & AccessKeyDAO::_returnAccessKeyFromRow | ( | $row | ) |
Internal function to return an AccessKey object from a row.
- Parameters
-
$row array
- Returns
- AccessKey
Definition at line 107 of file AccessKeyDAO.inc.php.
References HookRegistry\call(), DAO\datetimeFromDB(), and newDataObject().
Referenced by getAccessKey(), getAccessKeyByKeyHash(), and getAccessKeyByUserId().
◆ deleteAccessKeyById()
| AccessKeyDAO::deleteAccessKeyById | ( | $accessKeyId | ) |
Delete an accessKey by ID.
- Parameters
-
$accessKeyId int
Definition at line 181 of file AccessKeyDAO.inc.php.
References DAO\update().
Referenced by deleteObject().
◆ deleteExpiredKeys()
| AccessKeyDAO::deleteExpiredKeys | ( | ) |
Delete expired access keys.
Definition at line 203 of file AccessKeyDAO.inc.php.
References DAO\datetimeToDB(), Core\getCurrentDate(), and DAO\update().
◆ deleteObject()
| AccessKeyDAO::deleteObject | ( | & | $accessKey | ) |
Delete an accessKey.
- Parameters
-
$accessKey AccessKey
Definition at line 173 of file AccessKeyDAO.inc.php.
References deleteAccessKeyById().
◆ getAccessKey()
| & AccessKeyDAO::getAccessKey | ( | $accessKeyId | ) |
Retrieve an accessKey by ID.
- Parameters
-
$accessKeyId int
- Returns
- AccessKey
Definition at line 27 of file AccessKeyDAO.inc.php.
References _returnAccessKeyFromRow(), DAO\datetimeToDB(), Core\getCurrentDate(), and DAO\retrieve().
◆ getAccessKeyByKeyHash()
| & AccessKeyDAO::getAccessKeyByKeyHash | ( | $context, | |
| $userId, | |||
| $keyHash, | |||
$assocId = null |
|||
| ) |
Retrieve a accessKey object by key.
- Parameters
-
$context string $userId int $keyHash string $assocId int
- Returns
- AccessKey
Definition at line 75 of file AccessKeyDAO.inc.php.
References _returnAccessKeyFromRow(), DAO\datetimeToDB(), Core\getCurrentDate(), and DAO\retrieve().
◆ getAccessKeyByUserId()
| & AccessKeyDAO::getAccessKeyByUserId | ( | $context, | |
| $userId | |||
| ) |
Retrieve a accessKey object user ID.
- Parameters
-
$context string $userId int
- Returns
- AccessKey
Definition at line 50 of file AccessKeyDAO.inc.php.
References _returnAccessKeyFromRow(), DAO\datetimeToDB(), Core\getCurrentDate(), and DAO\retrieve().
◆ getInsertId()
| AccessKeyDAO::getInsertId | ( | ) |
Get the ID of the last inserted accessKey.
- Returns
- int
Definition at line 216 of file AccessKeyDAO.inc.php.
References DAO\_getInsertId().
Referenced by insertObject().
◆ insertObject()
| AccessKeyDAO::insertObject | ( | $accessKey | ) |
Insert a new accessKey.
- Parameters
-
$accessKey AccessKey
Definition at line 125 of file AccessKeyDAO.inc.php.
References DAO\datetimeToDB(), getInsertId(), and DAO\update().
◆ newDataObject()
| AccessKeyDAO::newDataObject | ( | ) |
Instantiate and return a new data object.
- Returns
- AccessKey
Definition at line 98 of file AccessKeyDAO.inc.php.
Referenced by _returnAccessKeyFromRow().
◆ transferAccessKeys()
| AccessKeyDAO::transferAccessKeys | ( | $oldUserId, | |
| $newUserId | |||
| ) |
Transfer access keys to another user ID.
- Parameters
-
$oldUserId int $newUserId int
Definition at line 193 of file AccessKeyDAO.inc.php.
References DAO\update().
◆ updateObject()
| AccessKeyDAO::updateObject | ( | & | $accessKey | ) |
Update an existing accessKey.
- Parameters
-
$accessKey AccessKey
Definition at line 148 of file AccessKeyDAO.inc.php.
References DAO\datetimeToDB(), and DAO\update().
The documentation for this class was generated from the following file:
