Open Journal Systems  3.3.0
Identity Class Reference
Inheritance diagram for Identity:
DataObject PKPAuthor User Author

Public Member Functions

 getAffiliation ($locale)
 
 getBiography ($locale)
 
 getCountry ()
 
 getCountryLocalized ()
 
 getEmail ()
 
 getFamilyName ($locale)
 
 getFullName ($preferred=true, $familyFirst=false, $defaultLocale=null)
 
 getGivenName ($locale)
 
 getLocalizedAffiliation ()
 
 getLocalizedBiography ()
 
getLocalizedData ($key, $preferredLocale=null)
 
 getLocalizedFamilyName ($defaultLocale=null)
 
 getLocalizedGivenName ($defaultLocale=null)
 
 getOrcid ()
 
 getPreferredPublicName ($locale)
 
 getUrl ()
 
 setAffiliation ($affiliation, $locale)
 
 setBiography ($biography, $locale)
 
 setCountry ($country)
 
 setEmail ($email)
 
 setFamilyName ($familyName, $locale)
 
 setGivenName ($givenName, $locale)
 
 setOrcid ($orcid)
 
 setPreferredPublicName ($preferredPublicName, $locale)
 
 setUrl ($url)
 
- Public Member Functions inherited from DataObject
 __construct ()
 
 addSupportedMetadataAdapter ($metadataAdapter)
 
 extractMetadata ($metadataSchema)
 
 getAdditionalMetadataFieldNames ()
 
getAllData ()
 
 getDAO ()
 
getData ($key, $locale=null)
 
 getHasLoadableAdapters ()
 
 getId ()
 
 getLocaleMetadataFieldNames ()
 
 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)
 
 unsetData ($key, $locale=null)
 
 upcastTo ($targetObject)
 

Additional Inherited Members

- Data Fields inherited from DataObject
 $_data = array()
 
 $_extractionAdaptersLoaded = false
 
 $_hasLoadableAdapters = false
 
 $_injectionAdaptersLoaded = false
 
 $_metadataExtractionAdapters = array()
 
 $_metadataInjectionAdapters = array()
 

Detailed Description

Basic class providing common functionality for users and authors in the system.

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

Member Function Documentation

◆ getAffiliation()

Identity::getAffiliation (   $locale)

Get affiliation (position, institution, etc.).

Parameters
$localestring
Returns
string

Definition at line 191 of file Identity.inc.php.

References DataObject\getData().

◆ getBiography()

Identity::getBiography (   $locale)

Get biography.

Parameters
$localestring
Returns
string

Definition at line 300 of file Identity.inc.php.

References DataObject\getData().

◆ getCountry()

Identity::getCountry ( )

Get country code (ISO 3166-1 two-letter codes)

Returns
string

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

References DataObject\getData().

Referenced by getCountryLocalized().

◆ getCountryLocalized()

Identity::getCountryLocalized ( )

Get localized country

Returns
string?

Definition at line 255 of file Identity.inc.php.

References getCountry().

◆ getEmail()

Identity::getEmail ( )

Get email address.

Returns
string

Definition at line 215 of file Identity.inc.php.

References DataObject\getData().

Referenced by User\getContactSignature().

◆ getFamilyName()

Identity::getFamilyName (   $locale)

Get family name.

Parameters
$localestring
Returns
string|array

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

References DataObject\getData().

Referenced by getFullName(), and getLocalizedFamilyName().

◆ getFullName()

Identity::getFullName (   $preferred = true,
  $familyFirst = false,
  $defaultLocale = null 
)

Get the identity's localized complete name. Includes given name and family name.

Parameters
$preferredboolean If the preferred public name should be used, if exist
$familyFirstboolean False / default: Givenname Familyname If true: Familyname, Givenname
$defaultLocalestring
Returns
string

Reimplemented in PKPAuthor.

Definition at line 72 of file Identity.inc.php.

References PKPApplication\get(), getFamilyName(), getGivenName(), AppLocale\getLocale(), and getPreferredPublicName().

Referenced by User\getContactSignature().

◆ getGivenName()

Identity::getGivenName (   $locale)

Get given name.

Parameters
$localestring
Returns
string|array

Definition at line 102 of file Identity.inc.php.

References DataObject\getData().

Referenced by getFullName(), and getLocalizedFamilyName().

◆ getLocalizedAffiliation()

Identity::getLocalizedAffiliation ( )

Get the localized affiliation

Definition at line 207 of file Identity.inc.php.

References getLocalizedData().

Referenced by User\getContactSignature().

◆ getLocalizedBiography()

Identity::getLocalizedBiography ( )

Get the localized biography

Returns
string

Definition at line 291 of file Identity.inc.php.

References getLocalizedData().

◆ getLocalizedData()

& Identity::getLocalizedData (   $key,
  $preferredLocale = null 
)

Get a piece of data for this object, localized to the current locale if possible.

Parameters
$keystring
$preferredLocalestring
Returns
mixed

Reimplemented from DataObject.

Reimplemented in PKPAuthor.

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

References PKPApplication\get(), DataObject\getData(), AppLocale\getLocale(), and AppLocale\getPrimaryLocale().

Referenced by getLocalizedAffiliation(), getLocalizedBiography(), getLocalizedGivenName(), and User\getLocalizedSignature().

◆ getLocalizedFamilyName()

Identity::getLocalizedFamilyName (   $defaultLocale = null)

Get the localized family name Return family name for the locale first name exists in

Parameters
$defaultLocalestring
Returns
string

Reimplemented in PKPAuthor.

Definition at line 147 of file Identity.inc.php.

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

◆ getLocalizedGivenName()

Identity::getLocalizedGivenName (   $defaultLocale = null)

Get the localized given name

Returns
string

Reimplemented in PKPAuthor.

Definition at line 119 of file Identity.inc.php.

References getLocalizedData().

◆ getOrcid()

Identity::getOrcid ( )

Get ORCID identifier

Returns
string

Definition at line 231 of file Identity.inc.php.

References DataObject\getData().

◆ getPreferredPublicName()

Identity::getPreferredPublicName (   $locale)

Get preferred public name.

Parameters
$localestring
Returns
string

Definition at line 173 of file Identity.inc.php.

References DataObject\getData().

Referenced by getFullName().

◆ getUrl()

Identity::getUrl ( )

Get URL.

Returns
string

Definition at line 275 of file Identity.inc.php.

References DataObject\getData().

◆ setAffiliation()

Identity::setAffiliation (   $affiliation,
  $locale 
)

Set affiliation.

Parameters
$affiliationstring
$localestring

Definition at line 200 of file Identity.inc.php.

References DataObject\setData().

◆ setBiography()

Identity::setBiography (   $biography,
  $locale 
)

Set biography.

Parameters
$biographystring
$localestring

Definition at line 309 of file Identity.inc.php.

References DataObject\setData().

◆ setCountry()

Identity::setCountry (   $country)

Set country code (ISO 3166-1 two-letter codes)

Parameters
$countrystring

Definition at line 267 of file Identity.inc.php.

References DataObject\setData().

◆ setEmail()

Identity::setEmail (   $email)

Set email address.

Parameters
$emailstring

Definition at line 223 of file Identity.inc.php.

References DataObject\setData().

◆ setFamilyName()

Identity::setFamilyName (   $familyName,
  $locale 
)

Set family name.

Parameters
$familyNamestring
$localestring

Definition at line 137 of file Identity.inc.php.

References DataObject\setData().

◆ setGivenName()

Identity::setGivenName (   $givenName,
  $locale 
)

Set given name.

Parameters
$givenNamestring
$localestring

Definition at line 111 of file Identity.inc.php.

References DataObject\setData().

◆ setOrcid()

Identity::setOrcid (   $orcid)

Set ORCID identifier.

Parameters
$orcidstring

Definition at line 239 of file Identity.inc.php.

References DataObject\setData().

◆ setPreferredPublicName()

Identity::setPreferredPublicName (   $preferredPublicName,
  $locale 
)

Set preferred public name.

Parameters
$preferredPublicNamestring
$localestring

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

References DataObject\setData().

◆ setUrl()

Identity::setUrl (   $url)

Set URL.

Parameters
$urlstring

Definition at line 283 of file Identity.inc.php.

References DataObject\setData().


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