Open Journal Systems
3.3.0
|
Public Member Functions | |
_returnUserFromRow ($row, $callHook=true) | |
_returnUserFromRowWithData ($row, $callHook=true) | |
_returnUserFromRowWithReviewerStats ($row) | |
changeSitePrimaryLocale ($oldLocale, $newLocale) | |
deleteObject ($user) | |
deleteUserById ($userId) | |
getAdditionalFieldNames () | |
getById ($userId, $allowDisabled=true) | |
getBySetting ($settingName, $settingValue, $allowDisabled=true) | |
getByUsername ($username, $allowDisabled=true) | |
getFetchColumns () | |
getFetchJoins () | |
getFetchParameters () | |
getInsertId () | |
getLocaleFieldNames () | |
getOrderBy () | |
getReviewersForSubmission ($contextId, $submissionId, $round) | |
getReviewersNotAssignedToSubmission ($contextId, $submissionId, &$reviewRound, $name='') | |
getUserByAuthStr ($authstr, $allowDisabled=true) | |
getUserByCredentials ($username, $password, $allowDisabled=true) | |
getUserByEmail ($email, $allowDisabled=true) | |
getUserEmail ($userId, $allowDisabled=true) | |
getUserFullName ($userId, $allowDisabled=true) | |
getUsersWithNoRole ($allowDisabled=true, $dbResultRange=null) | |
insertObject ($user) | |
newDataObject () | |
updateLocaleFields ($user) | |
updateObject ($user) | |
userExistsByEmail ($email, $userId=null, $allowDisabled=true) | |
userExistsById ($userId, $allowDisabled=true) | |
userExistsByUsername ($username, $userId=null, $allowDisabled=true) | |
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) | |
getAffectedRows () | |
getDataObjectSettings ($tableName, $idFieldName, $idFieldValue, $dataObject) | |
getDataSource () | |
getDirectionMapping ($direction) | |
getDriver () | |
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='') | |
Operations for retrieving and modifying User objects.
Definition at line 28 of file UserDAO.inc.php.
UserDAO::_returnUserFromRow | ( | $row, | |
$callHook = true |
|||
) |
Internal function to return a User object from a row.
$row | array |
$callHook | boolean |
Definition at line 286 of file UserDAO.inc.php.
UserDAO::_returnUserFromRowWithData | ( | $row, | |
$callHook = true |
|||
) |
Create and return a complete User object from a given row.
$row | array |
$callHook | boolean |
Definition at line 270 of file UserDAO.inc.php.
Referenced by UserStageAssignmentDAO\_getUsersByIds(), getById(), getBySetting(), getByUsername(), getReviewersNotAssignedToSubmission(), getUserByAuthStr(), getUserByCredentials(), and getUserByEmail().
UserDAO::_returnUserFromRowWithReviewerStats | ( | $row | ) |
Return a user object from a DB row, including dependent data and reviewer stats.
$row | array |
Definition at line 245 of file UserDAO.inc.php.
UserDAO::changeSitePrimaryLocale | ( | $oldLocale, | |
$newLocale | |||
) |
Update user names when the site primary locale changes.
$oldLocale | string |
$newLocale | string |
Definition at line 569 of file UserDAO.inc.php.
References DAO\retrieve(), and DAO\update().
UserDAO::deleteObject | ( | $user | ) |
UserDAO::deleteUserById | ( | $userId | ) |
UserDAO::getAdditionalFieldNames | ( | ) |
Get a list of additional field names to store in this DAO. This can be used to extend the table with virtual "columns", typically using the ..._settings table.
Reimplemented from DAO.
Definition at line 368 of file UserDAO.inc.php.
UserDAO::getById | ( | $userId, | |
$allowDisabled = true |
|||
) |
Retrieve a user by ID.
$userId | int |
$allowDisabled | boolean |
Definition at line 44 of file UserDAO.inc.php.
References _returnUserFromRowWithData(), and DAO\retrieve().
UserDAO::getBySetting | ( | $settingName, | |
$settingValue, | |||
$allowDisabled = true |
|||
) |
Retrieve a user by setting.
$settingName | string |
$settingValue | string |
$allowDisabled | boolean |
Definition at line 85 of file UserDAO.inc.php.
References _returnUserFromRowWithData(), and DAO\retrieve().
UserDAO::getByUsername | ( | $username, | |
$allowDisabled = true |
|||
) |
Retrieve a user by username.
$username | string |
$allowDisabled | boolean |
Definition at line 64 of file UserDAO.inc.php.
References _returnUserFromRowWithData(), and DAO\retrieve().
UserDAO::getFetchColumns | ( | ) |
Return a SQL snippet of extra columns to fetch during user fetch queries.
Definition at line 652 of file UserDAO.inc.php.
Referenced by getReviewersForSubmission().
UserDAO::getFetchJoins | ( | ) |
Return a SQL snippet of extra joins to include during user fetch queries.
Definition at line 661 of file UserDAO.inc.php.
Referenced by getReviewersForSubmission().
UserDAO::getFetchParameters | ( | ) |
Return a list of extra parameters to bind to the user fetch queries.
Definition at line 634 of file UserDAO.inc.php.
References PKPApplication\get(), and AppLocale\getLocale().
Referenced by getReviewersForSubmission(), and getReviewersNotAssignedToSubmission().
UserDAO::getInsertId | ( | ) |
Get the ID of the last inserted user.
Definition at line 626 of file UserDAO.inc.php.
References DAO\_getInsertId().
UserDAO::getLocaleFieldNames | ( | ) |
Get locale field names. Like getAdditionalFieldNames, but for localized (multilingual) fields.
Reimplemented from DAO.
Definition at line 360 of file UserDAO.inc.php.
UserDAO::getOrderBy | ( | ) |
Return a default sorting.
Definition at line 672 of file UserDAO.inc.php.
Referenced by getReviewersForSubmission().
UserDAO::getReviewersForSubmission | ( | $contextId, | |
$submissionId, | |||
$round | |||
) |
Retrieve a list of all reviewers assigned to a submission.
$contextId | int |
$submissionId | int |
$round | int |
Definition at line 167 of file UserDAO.inc.php.
References getFetchColumns(), getFetchJoins(), getFetchParameters(), getOrderBy(), and DAO\retrieve().
UserDAO::getReviewersNotAssignedToSubmission | ( | $contextId, | |
$submissionId, | |||
& | $reviewRound, | ||
$name = '' |
|||
) |
Retrieve a list of all reviewers not assigned to the specified submission.
$contextId | int |
$submissionId | int |
$reviewRound | ReviewRound |
$name | string |
Definition at line 203 of file UserDAO.inc.php.
References _returnUserFromRowWithData(), DAORegistry\getDAO(), and getFetchParameters().
UserDAO::getUserByAuthStr | ( | $authstr, | |
$allowDisabled = true |
|||
) |
Get the user by the TDL ID (implicit authentication).
$authstr | string |
$allowDisabled | boolean |
Definition at line 105 of file UserDAO.inc.php.
References _returnUserFromRowWithData(), and DAO\retrieve().
UserDAO::getUserByCredentials | ( | $username, | |
$password, | |||
$allowDisabled = true |
|||
) |
Retrieve a user by username and (encrypted) password.
$username | string |
$password | string encrypted password |
$allowDisabled | boolean |
Definition at line 146 of file UserDAO.inc.php.
References _returnUserFromRowWithData(), and DAO\retrieve().
UserDAO::getUserByEmail | ( | $email, | |
$allowDisabled = true |
|||
) |
Retrieve a user by email address.
string | |
$allowDisabled | boolean |
Definition at line 125 of file UserDAO.inc.php.
References _returnUserFromRowWithData(), and DAO\retrieve().
UserDAO::getUserEmail | ( | $userId, | |
$allowDisabled = true |
|||
) |
Retrieve a user's email address.
$userId | int |
$allowDisabled | boolean |
Definition at line 475 of file UserDAO.inc.php.
UserDAO::getUserFullName | ( | $userId, | |
$allowDisabled = true |
|||
) |
Retrieve a user's name.
$userId | int |
$allowDisabled | boolean |
Definition at line 464 of file UserDAO.inc.php.
UserDAO::getUsersWithNoRole | ( | $allowDisabled = true , |
|
$dbResultRange = null |
|||
) |
Retrieve an array of users with no role defined.
$allowDisabled | boolean |
$dbResultRange | object The desired range of results to return |
Definition at line 496 of file UserDAO.inc.php.
UserDAO::insertObject | ( | $user | ) |
UserDAO::newDataObject | ( | ) |
UserDAO::updateLocaleFields | ( | $user | ) |
Definition at line 379 of file UserDAO.inc.php.
UserDAO::updateObject | ( | $user | ) |
UserDAO::userExistsByEmail | ( | $email, | |
$userId = null , |
|||
$allowDisabled = true |
|||
) |
Check if a user exists with the specified email address.
string | |
$userId | int optional, ignore matches with this user ID |
$allowDisabled | boolean |
Definition at line 553 of file UserDAO.inc.php.
References DAO\retrieve().
UserDAO::userExistsById | ( | $userId, | |
$allowDisabled = true |
|||
) |
Check if a user exists with the specified user ID.
$userId | int |
$allowDisabled | boolean |
Definition at line 517 of file UserDAO.inc.php.
UserDAO::userExistsByUsername | ( | $username, | |
$userId = null , |
|||
$allowDisabled = true |
|||
) |
Check if a user exists with the specified username.
$username | string |
$userId | int optional, ignore matches with this user ID |
$allowDisabled | boolean |
Definition at line 535 of file UserDAO.inc.php.
References DAO\retrieve().