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

Public Member Functions

getSetting ($name, $journalId=null)
 
getSettings ($journalId=null)
 
 updateSetting ($name, $value, $type=null, $journalId=null)
 
- Public Member Functions inherited from PKPUser
 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 19 of file User.inc.php.

Member Function Documentation

& User::getSetting (   $name,
  $journalId = null 
)

Retrieve a user setting value.

Parameters
$name
$journalIdint
Returns
mixed

Definition at line 42 of file User.inc.php.

References DAORegistry\getDAO(), and DataObject\getId().

& User::getSettings (   $journalId = null)

Retrieve array of user settings.

Parameters
journalIdint
Returns
array

Definition at line 30 of file User.inc.php.

References DAORegistry\getDAO(), and DataObject\getId().

User::updateSetting (   $name,
  $value,
  $type = null,
  $journalId = null 
)

Set a user setting value.

Parameters
$namestring
$valuemixed
$typestring optional

Definition at line 54 of file User.inc.php.

References DAORegistry\getDAO(), and DataObject\getId().


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