Open Journal Systems  3.3.0
UserDAO Class Reference
Inheritance diagram for UserDAO:
DAO UserStageAssignmentDAO

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='')
 

Detailed Description

Operations for retrieving and modifying User objects.

See also
User

Definition at line 28 of file UserDAO.inc.php.

Member Function Documentation

◆ _returnUserFromRow()

UserDAO::_returnUserFromRow (   $row,
  $callHook = true 
)

Internal function to return a User object from a row.

Parameters
$rowarray
$callHookboolean
Returns
User

Definition at line 286 of file UserDAO.inc.php.

◆ _returnUserFromRowWithData()

UserDAO::_returnUserFromRowWithData (   $row,
  $callHook = true 
)

Create and return a complete User object from a given row.

Parameters
$rowarray
$callHookboolean
Returns
User

Definition at line 270 of file UserDAO.inc.php.

Referenced by UserStageAssignmentDAO\_getUsersByIds(), getById(), getBySetting(), getByUsername(), getReviewersNotAssignedToSubmission(), getUserByAuthStr(), getUserByCredentials(), and getUserByEmail().

◆ _returnUserFromRowWithReviewerStats()

UserDAO::_returnUserFromRowWithReviewerStats (   $row)

Return a user object from a DB row, including dependent data and reviewer stats.

Parameters
$rowarray
Returns
User

Definition at line 245 of file UserDAO.inc.php.

◆ changeSitePrimaryLocale()

UserDAO::changeSitePrimaryLocale (   $oldLocale,
  $newLocale 
)

Update user names when the site primary locale changes.

Parameters
$oldLocalestring
$newLocalestring

Definition at line 569 of file UserDAO.inc.php.

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

◆ deleteObject()

UserDAO::deleteObject (   $user)

Delete a user.

Parameters
$userUser

Definition at line 445 of file UserDAO.inc.php.

◆ deleteUserById()

UserDAO::deleteUserById (   $userId)

Delete a user by ID.

Parameters
$userIdint

Definition at line 453 of file UserDAO.inc.php.

◆ getAdditionalFieldNames()

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.

Returns
array List of strings representing field names.

Reimplemented from DAO.

Definition at line 368 of file UserDAO.inc.php.

◆ getById()

UserDAO::getById (   $userId,
  $allowDisabled = true 
)

Retrieve a user by ID.

Parameters
$userIdint
$allowDisabledboolean
Returns
User?

Definition at line 44 of file UserDAO.inc.php.

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

◆ getBySetting()

UserDAO::getBySetting (   $settingName,
  $settingValue,
  $allowDisabled = true 
)

Retrieve a user by setting.

Parameters
$settingNamestring
$settingValuestring
$allowDisabledboolean
Returns
User?

Definition at line 85 of file UserDAO.inc.php.

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

◆ getByUsername()

UserDAO::getByUsername (   $username,
  $allowDisabled = true 
)

Retrieve a user by username.

Parameters
$usernamestring
$allowDisabledboolean
Returns
User?

Definition at line 64 of file UserDAO.inc.php.

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

◆ getFetchColumns()

UserDAO::getFetchColumns ( )

Return a SQL snippet of extra columns to fetch during user fetch queries.

Returns
string

Definition at line 652 of file UserDAO.inc.php.

Referenced by getReviewersForSubmission().

◆ getFetchJoins()

UserDAO::getFetchJoins ( )

Return a SQL snippet of extra joins to include during user fetch queries.

Returns
string

Definition at line 661 of file UserDAO.inc.php.

Referenced by getReviewersForSubmission().

◆ getFetchParameters()

UserDAO::getFetchParameters ( )

Return a list of extra parameters to bind to the user fetch queries.

Returns
array

Definition at line 634 of file UserDAO.inc.php.

References PKPApplication\get(), and AppLocale\getLocale().

Referenced by getReviewersForSubmission(), and getReviewersNotAssignedToSubmission().

◆ getInsertId()

UserDAO::getInsertId ( )

Get the ID of the last inserted user.

Returns
int

Definition at line 626 of file UserDAO.inc.php.

References DAO\_getInsertId().

◆ getLocaleFieldNames()

UserDAO::getLocaleFieldNames ( )

Get locale field names. Like getAdditionalFieldNames, but for localized (multilingual) fields.

See also
getAdditionalFieldNames
Returns
array Array of string field names.

Reimplemented from DAO.

Definition at line 360 of file UserDAO.inc.php.

◆ getOrderBy()

UserDAO::getOrderBy ( )

Return a default sorting.

Returns
string

Definition at line 672 of file UserDAO.inc.php.

Referenced by getReviewersForSubmission().

◆ getReviewersForSubmission()

UserDAO::getReviewersForSubmission (   $contextId,
  $submissionId,
  $round 
)

Retrieve a list of all reviewers assigned to a submission.

Parameters
$contextIdint
$submissionIdint
$roundint
Returns
DAOResultFactory containing matching Users

Definition at line 167 of file UserDAO.inc.php.

References getFetchColumns(), getFetchJoins(), getFetchParameters(), getOrderBy(), and DAO\retrieve().

◆ getReviewersNotAssignedToSubmission()

UserDAO::getReviewersNotAssignedToSubmission (   $contextId,
  $submissionId,
$reviewRound,
  $name = '' 
)

Retrieve a list of all reviewers not assigned to the specified submission.

Parameters
$contextIdint
$submissionIdint
$reviewRoundReviewRound
$namestring
Returns
array matching Users

Definition at line 203 of file UserDAO.inc.php.

References _returnUserFromRowWithData(), DAORegistry\getDAO(), and getFetchParameters().

◆ getUserByAuthStr()

UserDAO::getUserByAuthStr (   $authstr,
  $allowDisabled = true 
)

Get the user by the TDL ID (implicit authentication).

Parameters
$authstrstring
$allowDisabledboolean
Returns
User?

Definition at line 105 of file UserDAO.inc.php.

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

◆ getUserByCredentials()

UserDAO::getUserByCredentials (   $username,
  $password,
  $allowDisabled = true 
)

Retrieve a user by username and (encrypted) password.

Parameters
$usernamestring
$passwordstring encrypted password
$allowDisabledboolean
Returns
User?

Definition at line 146 of file UserDAO.inc.php.

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

◆ getUserByEmail()

UserDAO::getUserByEmail (   $email,
  $allowDisabled = true 
)

Retrieve a user by email address.

Parameters
$emailstring
$allowDisabledboolean
Returns
User?

Definition at line 125 of file UserDAO.inc.php.

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

◆ getUserEmail()

UserDAO::getUserEmail (   $userId,
  $allowDisabled = true 
)

Retrieve a user's email address.

Parameters
$userIdint
$allowDisabledboolean
Returns
string

Definition at line 475 of file UserDAO.inc.php.

◆ getUserFullName()

UserDAO::getUserFullName (   $userId,
  $allowDisabled = true 
)

Retrieve a user's name.

Parameters
$userIdint
$allowDisabledboolean
Returns
string|null

Definition at line 464 of file UserDAO.inc.php.

◆ getUsersWithNoRole()

UserDAO::getUsersWithNoRole (   $allowDisabled = true,
  $dbResultRange = null 
)

Retrieve an array of users with no role defined.

Parameters
$allowDisabledboolean
$dbResultRangeobject The desired range of results to return
Returns
DAOResultFactory

Definition at line 496 of file UserDAO.inc.php.

◆ insertObject()

UserDAO::insertObject (   $user)

Insert a new user.

Parameters
$userUser

Definition at line 319 of file UserDAO.inc.php.

◆ newDataObject()

UserDAO::newDataObject ( )

Construct a new User object.

Returns
User

Definition at line 34 of file UserDAO.inc.php.

◆ updateLocaleFields()

UserDAO::updateLocaleFields (   $user)

Definition at line 379 of file UserDAO.inc.php.

◆ updateObject()

UserDAO::updateObject (   $user)

Update an existing user.

Parameters
$userUser

Definition at line 389 of file UserDAO.inc.php.

◆ userExistsByEmail()

UserDAO::userExistsByEmail (   $email,
  $userId = null,
  $allowDisabled = true 
)

Check if a user exists with the specified email address.

Parameters
$emailstring
$userIdint optional, ignore matches with this user ID
$allowDisabledboolean
Returns
boolean

Definition at line 553 of file UserDAO.inc.php.

References DAO\retrieve().

◆ userExistsById()

UserDAO::userExistsById (   $userId,
  $allowDisabled = true 
)

Check if a user exists with the specified user ID.

Parameters
$userIdint
$allowDisabledboolean
Returns
boolean

Definition at line 517 of file UserDAO.inc.php.

◆ userExistsByUsername()

UserDAO::userExistsByUsername (   $username,
  $userId = null,
  $allowDisabled = true 
)

Check if a user exists with the specified username.

Parameters
$usernamestring
$userIdint optional, ignore matches with this user ID
$allowDisabledboolean
Returns
boolean

Definition at line 535 of file UserDAO.inc.php.

References DAO\retrieve().


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