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

Public Member Functions

 _setShowTitle ($showTitle)
 
 getFullName ($preferred=true, $familyFirst=false, $defaultLocale=null)
 
 getIncludeInBrowse ()
 
getLocalizedData ($key, $preferredLocale=null)
 
 getLocalizedFamilyName ($defaultLocale=null)
 
 getLocalizedGivenName ($defaultLocale=null)
 
 getLocalizedUserGroupName ()
 
 getPrimaryContact ()
 
 getSequence ()
 
 getShowTitle ()
 
 getSubmissionId ()
 
 getSubmissionLocale ()
 
 getUserGroup ()
 
 getUserGroupId ()
 
 setIncludeInBrowse ($include)
 
 setPrimaryContact ($primaryContact)
 
 setSequence ($sequence)
 
 setSubmissionId ($submissionId)
 
 setSubmissionLocale ($submissionLocale)
 
 setUserGroupId ($userGroupId)
 
- Public Member Functions inherited from Identity
 getAffiliation ($locale)
 
 getBiography ($locale)
 
 getCountry ()
 
 getCountryLocalized ()
 
 getEmail ()
 
 getFamilyName ($locale)
 
 getGivenName ($locale)
 
 getLocalizedAffiliation ()
 
 getLocalizedBiography ()
 
 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

Author metadata class.

See also
PKPAuthorDAO

Definition at line 19 of file PKPAuthor.inc.php.

Member Function Documentation

◆ _setShowTitle()

PKPAuthor::_setShowTitle (   $showTitle)

Set the "show title" flag. This attribute belongs to the user group, NOT the author; fetched for performance reasons only.

Parameters
$isDefaultboolean

Definition at line 164 of file PKPAuthor.inc.php.

References DataObject\setData().

◆ getFullName()

PKPAuthor::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 from Identity.

Definition at line 76 of file PKPAuthor.inc.php.

References getSubmissionLocale().

◆ getIncludeInBrowse()

PKPAuthor::getIncludeInBrowse ( )

Get whether or not to include in browse lists.

Returns
boolean

Definition at line 145 of file PKPAuthor.inc.php.

References DataObject\getData().

◆ getLocalizedData()

& PKPAuthor::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 Identity.

Definition at line 28 of file PKPAuthor.inc.php.

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

◆ getLocalizedFamilyName()

PKPAuthor::getLocalizedFamilyName (   $defaultLocale = null)

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

Parameters
$defaultLocalestring
Returns
string

Reimplemented from Identity.

Definition at line 67 of file PKPAuthor.inc.php.

References getSubmissionLocale().

◆ getLocalizedGivenName()

PKPAuthor::getLocalizedGivenName (   $defaultLocale = null)

Get the localized given name

Returns
string

Reimplemented from Identity.

Definition at line 58 of file PKPAuthor.inc.php.

References getSubmissionLocale().

◆ getLocalizedUserGroupName()

PKPAuthor::getLocalizedUserGroupName ( )

Get a localized version of the User Group

Returns
string

Definition at line 217 of file PKPAuthor.inc.php.

References getUserGroup().

◆ getPrimaryContact()

PKPAuthor::getPrimaryContact ( )

Get primary contact.

Returns
boolean

Definition at line 172 of file PKPAuthor.inc.php.

References DataObject\getData().

◆ getSequence()

PKPAuthor::getSequence ( )

Get sequence of author in submissions' author list.

Returns
float

Definition at line 188 of file PKPAuthor.inc.php.

References DataObject\getData().

◆ getShowTitle()

PKPAuthor::getShowTitle ( )

Get the "show title" flag (whether or not the title of the role should be included in the list of submission contributor names). This is fetched from the user group for performance reasons.

Returns
boolean

Definition at line 155 of file PKPAuthor.inc.php.

References DataObject\getData().

◆ getSubmissionId()

PKPAuthor::getSubmissionId ( )

Get ID of submission.

Returns
int

Definition at line 89 of file PKPAuthor.inc.php.

References DataObject\getData().

◆ getSubmissionLocale()

PKPAuthor::getSubmissionLocale ( )

Get submission locale.

Returns
string

Definition at line 105 of file PKPAuthor.inc.php.

References DataObject\getData().

Referenced by getFullName(), getLocalizedData(), getLocalizedFamilyName(), and getLocalizedGivenName().

◆ getUserGroup()

PKPAuthor::getUserGroup ( )

Get the user group for this contributor.

Definition at line 203 of file PKPAuthor.inc.php.

References DAORegistry\getDAO(), and getUserGroupId().

Referenced by getLocalizedUserGroupName().

◆ getUserGroupId()

PKPAuthor::getUserGroupId ( )

Get the user group id

Returns
int

Definition at line 129 of file PKPAuthor.inc.php.

References DataObject\getData().

Referenced by getUserGroup().

◆ setIncludeInBrowse()

PKPAuthor::setIncludeInBrowse (   $include)

Set whether or not to include in browse lists.

Parameters
$includeboolean

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

References DataObject\setData().

◆ setPrimaryContact()

PKPAuthor::setPrimaryContact (   $primaryContact)

Set primary contact.

Parameters
$primaryContactboolean

Definition at line 180 of file PKPAuthor.inc.php.

References DataObject\setData().

◆ setSequence()

PKPAuthor::setSequence (   $sequence)

Set sequence of author in submissions' author list.

Parameters
$sequencefloat

Definition at line 196 of file PKPAuthor.inc.php.

References DataObject\setData().

◆ setSubmissionId()

PKPAuthor::setSubmissionId (   $submissionId)

Set ID of submission.

Parameters
$submissionIdint

Definition at line 97 of file PKPAuthor.inc.php.

References DataObject\setData().

◆ setSubmissionLocale()

PKPAuthor::setSubmissionLocale (   $submissionLocale)

Set submission locale.

Parameters
$submissionLocalestring

Definition at line 113 of file PKPAuthor.inc.php.

References DataObject\setData().

◆ setUserGroupId()

PKPAuthor::setUserGroupId (   $userGroupId)

Set the user group id

Parameters
$userGroupIdint

Definition at line 121 of file PKPAuthor.inc.php.

References DataObject\setData().


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