Open Monograph Press  1.1
 All Classes Namespaces Functions Variables Groups Pages
PKPUser Class Reference
Inheritance diagram for PKPUser:
Identity DataObject User

Public Member Functions

 getAuthId ()
 
 getAuthStr ()
 
 getBillingAddress ()
 
 getDateLastEmail ()
 
 getDateLastLogin ()
 
 getDateRegistered ()
 
 getDateValidated ()
 
 getDisabled ()
 
 getDisabledReason ()
 
 getFax ()
 
 getGender ()
 
 getGossip ($locale)
 
 getInlineHelp ()
 
 getInterestString ()
 
 getLocales ()
 
 getLocalizedGossip ()
 
 getLocalizedSignature ()
 
 getMailingAddress ()
 
 getMustChangePassword ()
 
 getPassword ()
 
 getPhone ()
 
 getSignature ($locale)
 
 getUserInterests ()
 
 getUsername ()
 
 PKPUser ()
 
 setAuthId ($authId)
 
 setAuthStr ($authStr)
 
 setBillingAddress ($billingAddress)
 
 setDateLastEmail ($dateLastEmail)
 
 setDateLastLogin ($dateLastLogin)
 
 setDateRegistered ($dateRegistered)
 
 setDateValidated ($dateValidated)
 
 setDisabled ($disabled)
 
 setDisabledReason ($reasonDisabled)
 
 setFax ($fax)
 
 setGender ($gender)
 
 setGossip ($gossip, $locale)
 
 setInlineHelp ($inlineHelp)
 
 setLocales ($locales)
 
 setMailingAddress ($mailingAddress)
 
 setMustChangePassword ($mustChangePassword)
 
 setPassword ($password)
 
 setPhone ($phone)
 
 setSignature ($signature, $locale)
 
 setUsername ($username)
 
- Public Member Functions inherited from Identity
 getAffiliation ($locale)
 
 getBiography ($locale)
 
 getCountry ()
 
 getCountryLocalized ()
 
 getEmail ()
 
 getFirstName ()
 
 getFullName ($lastFirst=false)
 
 getInitials ()
 
 getLastName ()
 
 getLocalizedAffiliation ()
 
 getLocalizedBiography ()
 
 getMiddleName ()
 
 getSalutation ()
 
 getSuffix ()
 
 getUrl ()
 
 Identity ()
 
 setAffiliation ($affiliation, $locale)
 
 setBiography ($biography, $locale)
 
 setCountry ($country)
 
 setEmail ($email)
 
 setFirstName ($firstName)
 
 setInitials ($initials)
 
 setLastName ($lastName)
 
 setMiddleName ($middleName)
 
 setSalutation ($salutation)
 
 setSuffix ($suffix)
 
 setUrl ($url)
 
- Public Member Functions inherited from DataObject
 addSupportedMetadataAdapter ($metadataAdapter)
 
 DataObject ()
 
 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()
 
 $_extractionAdaptersLoaded = false
 
 $_hasLoadableAdapters = false
 
 $_injectionAdaptersLoaded = false
 
 $_metadataExtractionAdapters = array()
 
 $_metadataInjectionAdapters = array()
 

Detailed Description

Basic class describing users existing in the system.

See Also
UserDAO

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

Member Function Documentation

PKPUser::getAuthId ( )

Get ID of authentication source for this user.

Returns
int

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

References DataObject\getData().

PKPUser::getAuthStr ( )

Get implicit auth ID string.

Returns
String

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

References DataObject\getData().

PKPUser::getBillingAddress ( )

Get billing address.

Returns
string

Definition at line 176 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 255 of file PKPUser.inc.php.

References DataObject\getData().

PKPUser::getDateLastLogin ( )

Get date user last logged in to the site.

Returns
datestamp

Definition at line 303 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 271 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 287 of file PKPUser.inc.php.

References DataObject\getData().

PKPUser::getDisabled ( )

Check if user is disabled.

Returns
boolean

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

References DataObject\getData().

PKPUser::getDisabledReason ( )

Get the reason the user was disabled.

Returns
string

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

References DataObject\getData().

PKPUser::getFax ( )

Get fax number.

Returns
string

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

References DataObject\getData().

PKPUser::getGender ( )

Get user gender.

Returns
string

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

References DataObject\getData().

PKPUser::getGossip (   $locale)

Get user gossip.

Parameters
$localestring
Returns
string

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

References DataObject\getData().

PKPUser::getInlineHelp ( )

Get the inline help display status for this user.

Returns
int

Definition at line 383 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 203 of file PKPUser.inc.php.

PKPUser::getLocales ( )

Get user's working languages.

Returns
array

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

References DataObject\getData().

PKPUser::getLocalizedGossip ( )

Get localized user gossip.

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

References DataObject\getLocalizedData().

PKPUser::getLocalizedSignature ( )

Get localized user signature.

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

References DataObject\getLocalizedData().

PKPUser::getMailingAddress ( )

Get mailing address.

Returns
string

Definition at line 160 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 319 of file PKPUser.inc.php.

References DataObject\getData().

PKPUser::getPassword ( )

Get password (encrypted).

Returns
string

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

References DataObject\getData().

PKPUser::getPhone ( )

Get phone number.

Returns
string

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

References DataObject\getData().

PKPUser::getSignature (   $locale)

Get email signature.

Parameters
$localestring
Returns
string

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

References DataObject\getData().

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 192 of file PKPUser.inc.php.

References Config\getVar().

PKPUser::getUsername ( )

Get username.

Returns
string

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

References DataObject\getData().

PKPUser::PKPUser ( )

Constructor

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

PKPUser::setAuthId (   $authId)

Set ID of authentication source for this user.

Parameters
$authIdint

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

References DataObject\setData().

PKPUser::setAuthStr (   $authStr)

Set Shib ID string for this user.

Parameters
$authStrstring

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

References DataObject\setData().

PKPUser::setBillingAddress (   $billingAddress)

Set billing address.

Parameters
$billingAddressstring

Definition at line 184 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 263 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 311 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 279 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 295 of file PKPUser.inc.php.

References DataObject\setData().

PKPUser::setDisabled (   $disabled)

Set whether or not user is disabled.

Parameters
$disabledboolean

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

References DataObject\setData().

PKPUser::setDisabledReason (   $reasonDisabled)

Set the reason the user is disabled.

Parameters
$reasonDisabledstring

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

References DataObject\setData().

PKPUser::setFax (   $fax)

Set fax number.

Parameters
$faxstring

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

References DataObject\setData().

PKPUser::setGender (   $gender)

Set user gender.

Parameters
$genderstring

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

References DataObject\setData().

PKPUser::setGossip (   $gossip,
  $locale 
)

Set user gossip.

Parameters
$gossipstring
$localestring

Definition at line 230 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 391 of file PKPUser.inc.php.

References DataObject\setData().

PKPUser::setLocales (   $locales)

Set user's working languages.

Parameters
$localesarray

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

References DataObject\setData().

PKPUser::setMailingAddress (   $mailingAddress)

Set mailing address.

Parameters
$mailingAddressstring

Definition at line 168 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 327 of file PKPUser.inc.php.

References DataObject\setData().

PKPUser::setPassword (   $password)

Set password (assumed to be already encrypted).

Parameters
$passwordstring

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

References DataObject\setData().

PKPUser::setPhone (   $phone)

Set phone number.

Parameters
$phonestring

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

References DataObject\setData().

PKPUser::setSignature (   $signature,
  $locale 
)

Set signature.

Parameters
$signaturestring
$localestring

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

References DataObject\setData().

PKPUser::setUsername (   $username)

Set username.

Parameters
$usernamestring

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

References DataObject\setData().


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