Open Journal Systems
3.3.0
|
Protected Attributes | |
$_roles = array() | |
Additional Inherited Members | |
Data Fields inherited from DataObject | |
$_data = array() | |
$_extractionAdaptersLoaded = false | |
$_hasLoadableAdapters = false | |
$_injectionAdaptersLoaded = false | |
$_metadataExtractionAdapters = array() | |
$_metadataInjectionAdapters = array() | |
Basic class describing users existing in the system.
Definition at line 23 of file User.inc.php.
User::getAuthId | ( | ) |
Get ID of authentication source for this user.
Definition at line 314 of file User.inc.php.
References DataObject\getData().
User::getAuthStr | ( | ) |
Get implicit auth ID string.
Definition at line 54 of file User.inc.php.
References DataObject\getData().
User::getBillingAddress | ( | ) |
Get billing address.
Definition at line 143 of file User.inc.php.
References DataObject\getData().
User::getContactSignature | ( | ) |
Definition at line 342 of file User.inc.php.
References Identity\getEmail(), Identity\getFullName(), Identity\getLocalizedAffiliation(), getPhone(), and AppLocale\requireComponents().
User::getDateLastEmail | ( | ) |
Get date user last sent an email.
Definition at line 202 of file User.inc.php.
References DataObject\getData().
User::getDateLastLogin | ( | ) |
Get date user last logged in to the site.
Definition at line 250 of file User.inc.php.
References DataObject\getData().
User::getDateRegistered | ( | ) |
Get date user registered with the site.
Definition at line 218 of file User.inc.php.
References DataObject\getData().
User::getDateValidated | ( | ) |
Get date user email was validated with the site.
Definition at line 234 of file User.inc.php.
References DataObject\getData().
User::getDisabled | ( | ) |
Check if user is disabled.
Definition at line 282 of file User.inc.php.
References DataObject\getData().
User::getDisabledReason | ( | ) |
Get the reason the user was disabled.
Definition at line 298 of file User.inc.php.
References DataObject\getData().
User::getGossip | ( | ) |
Get user gossip.
Definition at line 169 of file User.inc.php.
References DataObject\getData().
User::getInlineHelp | ( | ) |
Get the inline help display status for this user.
Definition at line 330 of file User.inc.php.
References DataObject\getData().
User::getInterestString | ( | ) |
Get the user's interests displayed as a comma-separated string
Definition at line 159 of file User.inc.php.
User::getLocales | ( | ) |
Get user's working languages.
Definition at line 185 of file User.inc.php.
References DataObject\getData().
User::getLocalizedSignature | ( | ) |
Get localized user signature.
Definition at line 69 of file User.inc.php.
References Identity\getLocalizedData().
User::getMailingAddress | ( | ) |
Get mailing address.
Definition at line 127 of file User.inc.php.
References DataObject\getData().
User::getMustChangePassword | ( | ) |
Check if user must change their password on their next login.
Definition at line 266 of file User.inc.php.
References DataObject\getData().
User::getPassword | ( | ) |
Get password (encrypted).
Definition at line 95 of file User.inc.php.
References DataObject\getData().
User::getPhone | ( | ) |
Get phone number.
Definition at line 111 of file User.inc.php.
References DataObject\getData().
Referenced by getContactSignature().
User::getRoles | ( | $contextId, | |
$noCache = false |
|||
) |
Get this user's roles in a context
int | $contextId | The context to retrieve roles in. |
bool | $noCache | Force the roles to be retrieved from the database |
Definition at line 386 of file User.inc.php.
References DAORegistry\getDAO(), and setRoles().
Referenced by hasRole().
User::getSetting | ( | $name, | |
$contextId = null |
|||
) |
Retrieve a user setting value.
$name | |
$contextId | int |
Definition at line 423 of file User.inc.php.
References DAORegistry\getDAO(), and DataObject\getId().
User::getSettings | ( | $contextId = null | ) |
Retrieve array of user settings.
contextId | int |
Definition at line 412 of file User.inc.php.
References DAORegistry\getDAO(), and DataObject\getId().
User::getSignature | ( | $locale | ) |
Get email signature.
$locale | string |
Definition at line 78 of file User.inc.php.
References DataObject\getData().
User::getUsername | ( | ) |
Get username.
Definition at line 38 of file User.inc.php.
References DataObject\getData().
User::hasRole | ( | $roles, | |
$contextId | |||
) |
Check if this user has a role in a context
int | array | $roles | Role(s) to check for |
int | $contextId | The context to check for roles in. |
Definition at line 358 of file User.inc.php.
References getRoles().
User::setAuthId | ( | $authId | ) |
Set ID of authentication source for this user.
$authId | int |
Definition at line 322 of file User.inc.php.
References DataObject\setData().
User::setAuthStr | ( | $authStr | ) |
Set Shib ID string for this user.
$authStr | string |
Definition at line 62 of file User.inc.php.
References DataObject\setData().
User::setBillingAddress | ( | $billingAddress | ) |
Set billing address.
$billingAddress | string |
Definition at line 151 of file User.inc.php.
References DataObject\setData().
User::setDateLastEmail | ( | $dateLastEmail | ) |
Set date user last sent an email.
$dateLastEmail | datestamp (YYYY-MM-DD HH:MM:SS) |
Definition at line 210 of file User.inc.php.
References DataObject\setData().
User::setDateLastLogin | ( | $dateLastLogin | ) |
Set date user last logged in to the site.
$dateLastLogin | datestamp |
Definition at line 258 of file User.inc.php.
References DataObject\setData().
User::setDateRegistered | ( | $dateRegistered | ) |
Set date user registered with the site.
$dateRegistered | datestamp (YYYY-MM-DD HH:MM:SS) |
Definition at line 226 of file User.inc.php.
References DataObject\setData().
User::setDateValidated | ( | $dateValidated | ) |
Set date user email was validated with the site.
$dateValidated | datestamp (YYYY-MM-DD HH:MM:SS) |
Definition at line 242 of file User.inc.php.
References DataObject\setData().
User::setDisabled | ( | $disabled | ) |
Set whether or not user is disabled.
$disabled | boolean |
Definition at line 290 of file User.inc.php.
References DataObject\setData().
User::setDisabledReason | ( | $reasonDisabled | ) |
Set the reason the user is disabled.
$reasonDisabled | string |
Definition at line 306 of file User.inc.php.
References DataObject\setData().
User::setGossip | ( | $gossip | ) |
Set user gossip.
$gossip | string |
Definition at line 177 of file User.inc.php.
References DataObject\setData().
User::setInlineHelp | ( | $inlineHelp | ) |
Set the inline help display status for this user.
$inlineHelp | int |
Definition at line 338 of file User.inc.php.
References DataObject\setData().
User::setLocales | ( | $locales | ) |
Set user's working languages.
$locales | array |
Definition at line 194 of file User.inc.php.
References DataObject\setData().
User::setMailingAddress | ( | $mailingAddress | ) |
Set mailing address.
$mailingAddress | string |
Definition at line 135 of file User.inc.php.
References DataObject\setData().
User::setMustChangePassword | ( | $mustChangePassword | ) |
Set whether or not user must change their password on their next login.
$mustChangePassword | boolean |
Definition at line 274 of file User.inc.php.
References DataObject\setData().
User::setPassword | ( | $password | ) |
Set password (assumed to be already encrypted).
$password | string |
Definition at line 103 of file User.inc.php.
References DataObject\setData().
User::setPhone | ( | $phone | ) |
Set phone number.
$phone | string |
Definition at line 119 of file User.inc.php.
References DataObject\setData().
User::setRoles | ( | $roles, | |
$contextId | |||
) |
Set this user's roles in a context
array | $roles | The roles to assign this user |
int | $contextId | The context to assign these roles |
Definition at line 403 of file User.inc.php.
Referenced by getRoles().
User::setSignature | ( | $signature, | |
$locale | |||
) |
Set signature.
$signature | string |
$locale | string |
Definition at line 87 of file User.inc.php.
References DataObject\setData().
User::setUsername | ( | $username | ) |
Set username.
$username | string |
Definition at line 46 of file User.inc.php.
References DataObject\setData().
User::updateSetting | ( | $name, | |
$value, | |||
$type = null , |
|||
$contextId = null |
|||
) |
Set a user setting value.
$name | string |
$value | mixed |
$type | string optional |
$contextId | int optional |
Definition at line 435 of file User.inc.php.
References DAORegistry\getDAO(), and DataObject\getId().
|
protected |
Roles assigned to this user grouped by context
Definition at line 28 of file User.inc.php.