Open Journal Systems
3.3.0
|
Public Member Functions | |
__construct () | |
_performPeriodicCleanup () | |
createKey ($context, $userId, $assocId, $expiryDays) | |
generateKeyHash ($key) | |
validateKey ($context, $userId, $keyHash, $assocId=null) | |
Data Fields | |
$accessKeyDao | |
Class defining operations for AccessKey management.
Definition at line 18 of file AccessKeyManager.inc.php.
AccessKeyManager::__construct | ( | ) |
Constructor. Create a manager for access keys.
Definition at line 25 of file AccessKeyManager.inc.php.
References _performPeriodicCleanup(), and DAORegistry\getDAO().
AccessKeyManager::_performPeriodicCleanup | ( | ) |
Periodically clean up expired keys.
Definition at line 79 of file AccessKeyManager.inc.php.
References $accessKeyDao, and DAORegistry\getDAO().
Referenced by __construct().
AccessKeyManager::createKey | ( | $context, | |
$userId, | |||
$assocId, | |||
$expiryDays | |||
) |
Create an access key with the given information.
$context | string The context of the access key |
$userId | int The ID of the effective user for this access key |
$assocId | int The associated ID of the key |
$expiryDays | int The number of days before this key expires |
Definition at line 61 of file AccessKeyManager.inc.php.
References generateKeyHash(), Validation\generatePassword(), and Core\getCurrentDate().
AccessKeyManager::generateKeyHash | ( | $key | ) |
Generate a key hash from a key.
$key | string |
Definition at line 35 of file AccessKeyManager.inc.php.
Referenced by ReviewerHandler\_validateAccessKey(), RegistrationHandler\activateUser(), createKey(), and MarkupConversionHelper\validateAccessToken().
AccessKeyManager::validateKey | ( | $context, | |
$userId, | |||
$keyHash, | |||
$assocId = null |
|||
) |
Validate an access key based on the supplied credentials. If $assocId is specified, it must match the associated ID of the key exactly.
$context | string The context of the access key |
$userId | int |
$keyHash | string The access key "passcode" |
$assocId | string optional assoc ID to check against the keys in the database |
Definition at line 49 of file AccessKeyManager.inc.php.
AccessKeyManager::$accessKeyDao |
Definition at line 19 of file AccessKeyManager.inc.php.
Referenced by _performPeriodicCleanup().