Open Journal Systems  2.4.4
 All Classes Namespaces Functions Variables Groups Pages
PKPUser Class Reference
Inheritance diagram for PKPUser:
DataObject User

Public Member Functions

 getAffiliation ($locale)
 
 getAuthId ()
 
 getAuthStr ()
 
 getBillingAddress ()
 
 getBiography ($locale)
 
 getCountry ()
 
 getDateLastEmail ()
 
 getDateLastLogin ()
 
 getDateRegistered ()
 
 getDateValidated ()
 
 getDisabled ()
 
 getDisabledReason ()
 
 getEmail ()
 
 getFax ()
 
 getFirstName ()
 
 getFullName ($lastFirst=false)
 
 getGender ()
 
 getGossip ($locale)
 
 getInitials ()
 
 getInlineHelp ()
 
 getInterestString ()
 
 getLastName ()
 
 getLocales ()
 
 getLocalizedAffiliation ()
 
 getLocalizedBiography ()
 
 getLocalizedGossip ()
 
 getLocalizedSignature ()
 
 getMailingAddress ()
 
 getMiddleName ()
 
 getMustChangePassword ()
 
 getPassword ()
 
 getPhone ()
 
 getSalutation ()
 
 getSignature ($locale)
 
 getSuffix ()
 
 getUrl ()
 
 getUserId ()
 
 getUserInterests ()
 
 getUsername ()
 
 PKPUser ()
 
 setAffiliation ($affiliation, $locale)
 
 setAuthId ($authId)
 
 setAuthStr ($authStr)
 
 setBillingAddress ($billingAddress)
 
 setBiography ($biography, $locale)
 
 setCountry ($country)
 
 setDateLastEmail ($dateLastEmail)
 
 setDateLastLogin ($dateLastLogin)
 
 setDateRegistered ($dateRegistered)
 
 setDateValidated ($dateValidated)
 
 setDisabled ($disabled)
 
 setDisabledReason ($reasonDisabled)
 
 setEmail ($email)
 
 setFax ($fax)
 
 setFirstName ($firstName)
 
 setGender ($gender)
 
 setGossip ($gossip, $locale)
 
 setInitials ($initials)
 
 setInlineHelp ($inlineHelp)
 
 setLastName ($lastName)
 
 setLocales ($locales)
 
 setMailingAddress ($mailingAddress)
 
 setMiddleName ($middleName)
 
 setMustChangePassword ($mustChangePassword)
 
 setPassword ($password)
 
 setPhone ($phone)
 
 setSalutation ($salutation)
 
 setSignature ($signature, $locale)
 
 setSuffix ($suffix)
 
 setUrl ($url)
 
 setUserId ($userId)
 
 setUsername ($username)
 
- Public Member Functions inherited from DataObject
 addSupportedMetadataAdapter (&$metadataAdapter)
 
 DataObject ($callHooks=true)
 
extractMetadata (&$metadataSchema)
 
 getAdditionalMetadataFieldNames ()
 
getAllData ()
 
getData ($key, $locale=null)
 
 getHasLoadableAdapters ()
 
 getId ()
 
 getLocaleMetadataFieldNames ()
 
getLocalizedData ($key)
 
 getMetadataFieldNames ($translated=true)
 
 getSetMetadataFieldNames ($translated=true)
 
getSupportedExtractionAdapters ()
 
getSupportedInjectionAdapters ()
 
getSupportedMetadataSchemas ()
 
 hasData ($key, $locale=null)
 
 injectMetadata (&$metadataDescription)
 
 removeSupportedMetadataAdapter ($metadataSchemaName)
 
 setAllData (&$data)
 
 setData ($key, $value, $locale=null)
 
 setHasLoadableAdapters ($hasLoadableAdapters)
 
 setId ($id)
 
upcastTo (&$targetObject)
 

Additional Inherited Members

- Public Attributes inherited from DataObject
 $_data = array()
 

Detailed Description

Basic class describing users existing in the system.

See Also
UserDAO

Definition at line 21 of file PKPUser.inc.php.

Member Function Documentation

PKPUser::getAffiliation (   $locale)

Get affiliation (position, institution, etc.).

Parameters
$localestring
Returns
string

Definition at line 247 of file PKPUser.inc.php.

References DataObject\getData().

PKPUser::getAuthId ( )

Get ID of authentication source for this user.

Returns
int

Definition at line 588 of file PKPUser.inc.php.

References DataObject\getData().

PKPUser::getAuthStr ( )

Get implicit auth ID string.

Returns
String

Definition at line 71 of file PKPUser.inc.php.

References DataObject\getData().

PKPUser::getBillingAddress ( )

Get billing address.

Returns
string

Definition at line 351 of file PKPUser.inc.php.

References DataObject\getData().

PKPUser::getBiography (   $locale)

Get user biography.

Parameters
$localestring
Returns
string

Definition at line 396 of file PKPUser.inc.php.

References DataObject\getData().

PKPUser::getCountry ( )

Get country.

Returns
string

Definition at line 367 of file PKPUser.inc.php.

References DataObject\getData().

PKPUser::getDateLastEmail ( )

Get date user last sent an email.

Returns
datestamp (YYYY-MM-DD HH:MM:SS)

Definition at line 476 of file PKPUser.inc.php.

References DataObject\getData().

PKPUser::getDateLastLogin ( )

Get date user last logged in to the site.

Returns
datestamp

Definition at line 524 of file PKPUser.inc.php.

References DataObject\getData().

PKPUser::getDateRegistered ( )

Get date user registered with the site.

Returns
datestamp (YYYY-MM-DD HH:MM:SS)

Definition at line 492 of file PKPUser.inc.php.

References DataObject\getData().

PKPUser::getDateValidated ( )

Get date user email was validated with the site.

Returns
datestamp (YYYY-MM-DD HH:MM:SS)

Definition at line 508 of file PKPUser.inc.php.

References DataObject\getData().

PKPUser::getDisabled ( )

Check if user is disabled.

Returns
boolean

Definition at line 556 of file PKPUser.inc.php.

References DataObject\getData().

PKPUser::getDisabledReason ( )

Get the reason the user was disabled.

Returns
string

Definition at line 572 of file PKPUser.inc.php.

References DataObject\getData().

PKPUser::getEmail ( )

Get email address.

Returns
string

Definition at line 271 of file PKPUser.inc.php.

References DataObject\getData().

PKPUser::getFax ( )

Get fax number.

Returns
string

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

References DataObject\getData().

PKPUser::getFirstName ( )

Get first name.

Returns
string

Definition at line 133 of file PKPUser.inc.php.

References DataObject\getData().

PKPUser::getFullName (   $lastFirst = false)

Get the user's complete name. Includes first name, middle name (if applicable), and last name. The suffix is only included when the name is not reversed with $lastFirst

Parameters
$lastFirstboolean return in "LastName, FirstName" format
Returns
string

Definition at line 623 of file PKPUser.inc.php.

References DataObject\getData().

PKPUser::getGender ( )

Get user gender.

Returns
string

Definition at line 230 of file PKPUser.inc.php.

References DataObject\getData().

PKPUser::getGossip (   $locale)

Get user gossip.

Parameters
$localestring
Returns
string

Definition at line 442 of file PKPUser.inc.php.

References DataObject\getData().

PKPUser::getInitials ( )

Get initials.

Returns
string

Definition at line 166 of file PKPUser.inc.php.

References DataObject\getData().

PKPUser::getInlineHelp ( )

Get the inline help display status for this user.

Returns
int

Definition at line 604 of file PKPUser.inc.php.

References DataObject\getData().

PKPUser::getInterestString ( )

Get the user's interests displayed as a comma-separated string

Returns
string

Definition at line 424 of file PKPUser.inc.php.

PKPUser::getLastName ( )

Get last name.

Returns
string

Definition at line 182 of file PKPUser.inc.php.

References DataObject\getData().

PKPUser::getLocales ( )

Get user's working languages.

Returns
array

Definition at line 459 of file PKPUser.inc.php.

References DataObject\getData().

PKPUser::getLocalizedAffiliation ( )

Get localized user affiliation.

Definition at line 263 of file PKPUser.inc.php.

References DataObject\getLocalizedData().

PKPUser::getLocalizedBiography ( )

Get localized user biography.

Definition at line 382 of file PKPUser.inc.php.

References DataObject\getLocalizedData().

PKPUser::getLocalizedGossip ( )

Get localized user gossip.

Definition at line 433 of file PKPUser.inc.php.

References DataObject\getLocalizedData().

PKPUser::getLocalizedSignature ( )

Get localized user signature.

Definition at line 86 of file PKPUser.inc.php.

References DataObject\getLocalizedData().

PKPUser::getMailingAddress ( )

Get mailing address.

Returns
string

Definition at line 335 of file PKPUser.inc.php.

References DataObject\getData().

PKPUser::getMiddleName ( )

Get middle name.

Returns
string

Definition at line 150 of file PKPUser.inc.php.

References DataObject\getData().

PKPUser::getMustChangePassword ( )

Check if user must change their password on their next login.

Returns
boolean

Definition at line 540 of file PKPUser.inc.php.

References DataObject\getData().

PKPUser::getPassword ( )

Get password (encrypted).

Returns
string

Definition at line 117 of file PKPUser.inc.php.

References DataObject\getData().

PKPUser::getPhone ( )

Get phone number.

Returns
string

Definition at line 303 of file PKPUser.inc.php.

References DataObject\getData().

PKPUser::getSalutation ( )

Get user salutation.

Returns
string

Definition at line 214 of file PKPUser.inc.php.

References DataObject\getData().

PKPUser::getSignature (   $locale)

Get email signature.

Parameters
$localestring
Returns
string

Definition at line 100 of file PKPUser.inc.php.

References DataObject\getData().

PKPUser::getSuffix ( )

Get name suffix.

Returns
string

Definition at line 198 of file PKPUser.inc.php.

References DataObject\getData().

PKPUser::getUrl ( )

Get URL.

Returns
string

Definition at line 287 of file PKPUser.inc.php.

References DataObject\getData().

PKPUser::getUserId ( )

Get the ID of the user. DEPRECATED in favour of getId.

Returns
int

Definition at line 37 of file PKPUser.inc.php.

References DataObject\getId(), and Config\getVar().

PKPUser::getUserInterests ( )

Get the user's reviewing interests as an array. DEPRECATED in favour of direct interaction with the InterestManager.

Returns
array

Definition at line 413 of file PKPUser.inc.php.

References Config\getVar().

PKPUser::getUsername ( )

Get username.

Returns
string

Definition at line 55 of file PKPUser.inc.php.

References DataObject\getData().

PKPUser::PKPUser ( )

Constructor

Definition at line 25 of file PKPUser.inc.php.

PKPUser::setAffiliation (   $affiliation,
  $locale 
)

Set affiliation.

Parameters
$affiliationstring
$localestring

Definition at line 256 of file PKPUser.inc.php.

References DataObject\setData().

PKPUser::setAuthId (   $authId)

Set ID of authentication source for this user.

Parameters
$authIdint

Definition at line 596 of file PKPUser.inc.php.

References DataObject\setData().

PKPUser::setAuthStr (   $authStr)

Set Shib ID string for this user.

Parameters
$authStrstring

Definition at line 79 of file PKPUser.inc.php.

References DataObject\setData().

PKPUser::setBillingAddress (   $billingAddress)

Set billing address.

Parameters
$billingAddressstring

Definition at line 359 of file PKPUser.inc.php.

References DataObject\setData().

PKPUser::setBiography (   $biography,
  $locale 
)

Set user biography.

Parameters
$biographystring
$localestring

Definition at line 405 of file PKPUser.inc.php.

References DataObject\setData().

PKPUser::setCountry (   $country)

Set country.

Parameters
$countrystring

Definition at line 375 of file PKPUser.inc.php.

References DataObject\setData().

PKPUser::setDateLastEmail (   $dateLastEmail)

Set date user last sent an email.

Parameters
$dateLastEmaildatestamp (YYYY-MM-DD HH:MM:SS)

Definition at line 484 of file PKPUser.inc.php.

References DataObject\setData().

PKPUser::setDateLastLogin (   $dateLastLogin)

Set date user last logged in to the site.

Parameters
$dateLastLogindatestamp

Definition at line 532 of file PKPUser.inc.php.

References DataObject\setData().

PKPUser::setDateRegistered (   $dateRegistered)

Set date user registered with the site.

Parameters
$dateRegistereddatestamp (YYYY-MM-DD HH:MM:SS)

Definition at line 500 of file PKPUser.inc.php.

References DataObject\setData().

PKPUser::setDateValidated (   $dateValidated)

Set date user email was validated with the site.

Parameters
$dateValidateddatestamp (YYYY-MM-DD HH:MM:SS)

Definition at line 516 of file PKPUser.inc.php.

References DataObject\setData().

PKPUser::setDisabled (   $disabled)

Set whether or not user is disabled.

Parameters
$disabledboolean

Definition at line 564 of file PKPUser.inc.php.

References DataObject\setData().

PKPUser::setDisabledReason (   $reasonDisabled)

Set the reason the user is disabled.

Parameters
$reasonDisabledstring

Definition at line 580 of file PKPUser.inc.php.

References DataObject\setData().

PKPUser::setEmail (   $email)

Set email address.

Parameters
$emailstring

Definition at line 279 of file PKPUser.inc.php.

References DataObject\setData().

PKPUser::setFax (   $fax)

Set fax number.

Parameters
$faxstring

Definition at line 327 of file PKPUser.inc.php.

References DataObject\setData().

PKPUser::setFirstName (   $firstName)

Set first name.

Parameters
$firstNamestring

Definition at line 141 of file PKPUser.inc.php.

References DataObject\setData().

PKPUser::setGender (   $gender)

Set user gender.

Parameters
$genderstring

Definition at line 238 of file PKPUser.inc.php.

References DataObject\setData().

PKPUser::setGossip (   $gossip,
  $locale 
)

Set user gossip.

Parameters
$gossipstring
$localestring

Definition at line 451 of file PKPUser.inc.php.

References DataObject\setData().

PKPUser::setInitials (   $initials)

Set initials.

Parameters
$initialsstring

Definition at line 174 of file PKPUser.inc.php.

References DataObject\setData().

PKPUser::setInlineHelp (   $inlineHelp)

Set the inline help display status for this user.

Parameters
$inlineHelpint

Definition at line 612 of file PKPUser.inc.php.

References DataObject\setData().

PKPUser::setLastName (   $lastName)

Set last name.

Parameters
$lastNamestring

Definition at line 190 of file PKPUser.inc.php.

References DataObject\setData().

PKPUser::setLocales (   $locales)

Set user's working languages.

Parameters
$localesarray

Definition at line 468 of file PKPUser.inc.php.

References DataObject\setData().

PKPUser::setMailingAddress (   $mailingAddress)

Set mailing address.

Parameters
$mailingAddressstring

Definition at line 343 of file PKPUser.inc.php.

References DataObject\setData().

PKPUser::setMiddleName (   $middleName)

Set middle name.

Parameters
$middleNamestring

Definition at line 158 of file PKPUser.inc.php.

References DataObject\setData().

PKPUser::setMustChangePassword (   $mustChangePassword)

Set whether or not user must change their password on their next login.

Parameters
$mustChangePasswordboolean

Definition at line 548 of file PKPUser.inc.php.

References DataObject\setData().

PKPUser::setPassword (   $password)

Set password (assumed to be already encrypted).

Parameters
$passwordstring

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

References DataObject\setData().

PKPUser::setPhone (   $phone)

Set phone number.

Parameters
$phonestring

Definition at line 311 of file PKPUser.inc.php.

References DataObject\setData().

PKPUser::setSalutation (   $salutation)

Set user salutation.

Parameters
$salutationstring

Definition at line 222 of file PKPUser.inc.php.

References DataObject\setData().

PKPUser::setSignature (   $signature,
  $locale 
)

Set signature.

Parameters
$signaturestring
$localestring

Definition at line 109 of file PKPUser.inc.php.

References DataObject\setData().

PKPUser::setSuffix (   $suffix)

Set suffix.

Parameters
$suffixstring

Definition at line 206 of file PKPUser.inc.php.

References DataObject\setData().

PKPUser::setUrl (   $url)

Set URL.

Parameters
$urlstring

Definition at line 295 of file PKPUser.inc.php.

References DataObject\setData().

PKPUser::setUserId (   $userId)

Set the ID of the user. DEPRECATED in favour of setId.

Parameters
$userIdint

Definition at line 46 of file PKPUser.inc.php.

References Config\getVar(), and DataObject\setId().

PKPUser::setUsername (   $username)

Set username.

Parameters
$usernamestring

Definition at line 63 of file PKPUser.inc.php.

References DataObject\setData().


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