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

Public Member Functions

 getAffiliation ($locale)
 
 getAuthorId ()
 
 getBiography ($locale)
 
 getCountry ()
 
 getCountryLocalized ()
 
 getEmail ()
 
 getFirstName ()
 
 getFullName ($lastFirst=false)
 
 getInitials ()
 
 getLastName ()
 
 getLocalizedAffiliation ()
 
 getLocalizedBiography ()
 
 getMiddleName ()
 
 getPrimaryContact ()
 
 getSalutation ()
 
 getSequence ()
 
 getSubmissionId ()
 
 getSuffix ()
 
 getUrl ()
 
 getUserGroupId ()
 
 PKPAuthor ()
 
 setAffiliation ($affiliation, $locale)
 
 setAuthorId ($authorId)
 
 setBiography ($biography, $locale)
 
 setCountry ($country)
 
 setEmail ($email)
 
 setFirstName ($firstName)
 
 setInitials ($initials)
 
 setLastName ($lastName)
 
 setMiddleName ($middleName)
 
 setPrimaryContact ($primaryContact)
 
 setSalutation ($salutation)
 
 setSequence ($sequence)
 
 setSubmissionId ($submissionId)
 
 setSuffix ($suffix)
 
 setUrl ($url)
 
 setUserGroupId ($userGroupId)
 
- 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

Author metadata class.

See Also
PKPAuthorDAO

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

Member Function Documentation

PKPAuthor::getAffiliation (   $locale)

Get affiliation (position, institution, etc.).

Parameters
$localestring
Returns
string

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

References DataObject\getData().

PKPAuthor::getAuthorId ( )

Get ID of author.

Returns
int

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

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

PKPAuthor::getBiography (   $locale)

Get author biography.

Parameters
$localestring
Returns
string

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

References DataObject\getData().

PKPAuthor::getCountry ( )

Get country code

Returns
string

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

References DataObject\getData().

Referenced by getCountryLocalized().

PKPAuthor::getCountryLocalized ( )

Get localized country

Returns
string

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

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

PKPAuthor::getEmail ( )

Get email address.

Returns
string

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

References DataObject\getData().

PKPAuthor::getFirstName ( )

Get first name.

Returns
string

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

References DataObject\getData().

PKPAuthor::getFullName (   $lastFirst = false)

Get the author's complete name. Includes first name, middle name (if applicable), and last name.

Parameters
$lastFirstboolean False / default: Firstname Middle Lastname If true: Lastname, Firstname Middlename
Returns
string

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

References DataObject\getData().

PKPAuthor::getInitials ( )

Get initials.

Returns
string

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

References DataObject\getData().

PKPAuthor::getLastName ( )

Get last name.

Returns
string

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

References DataObject\getData().

PKPAuthor::getLocalizedAffiliation ( )

Get the localized affiliation for this author

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

References DataObject\getLocalizedData().

PKPAuthor::getLocalizedBiography ( )

Get the localized biography for this author

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

References DataObject\getLocalizedData().

PKPAuthor::getMiddleName ( )

Get middle name.

Returns
string

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

References DataObject\getData().

PKPAuthor::getPrimaryContact ( )

Get primary contact.

Returns
boolean

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

References DataObject\getData().

PKPAuthor::getSalutation ( )

Get user salutation.

Returns
string

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

References DataObject\getData().

PKPAuthor::getSequence ( )

Get sequence of author in article's author list.

Returns
float

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

References DataObject\getData().

PKPAuthor::getSubmissionId ( )

Get ID of submission.

Returns
int

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

References DataObject\getData().

Referenced by Author\getArticleId().

PKPAuthor::getSuffix ( )

Get suffix.

Returns
string

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

References DataObject\getData().

PKPAuthor::getUrl ( )

Get URL.

Returns
string

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

References DataObject\getData().

PKPAuthor::getUserGroupId ( )

Get the user group id

Returns
int

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

References DataObject\getData().

PKPAuthor::PKPAuthor ( )

Constructor.

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

PKPAuthor::setAffiliation (   $affiliation,
  $locale 
)

Set affiliation.

Parameters
$affiliationstring
$localestring

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

References DataObject\setData().

PKPAuthor::setAuthorId (   $authorId)

Set ID of author.

Parameters
$authorIdint

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

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

PKPAuthor::setBiography (   $biography,
  $locale 
)

Set author biography.

Parameters
$biographystring
$localestring

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

References DataObject\setData().

PKPAuthor::setCountry (   $country)

Set country code.

Parameters
$countrystring

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

References DataObject\setData().

PKPAuthor::setEmail (   $email)

Set email address.

Parameters
$emailstring

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

References DataObject\setData().

PKPAuthor::setFirstName (   $firstName)

Set first name.

Parameters
$firstNamestring

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

References DataObject\setData().

PKPAuthor::setInitials (   $initials)

Set initials.

Parameters
$initialsstring

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

References DataObject\setData().

PKPAuthor::setLastName (   $lastName)

Set last name.

Parameters
$lastNamestring

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

References DataObject\setData().

PKPAuthor::setMiddleName (   $middleName)

Set middle name.

Parameters
$middleNamestring

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

References DataObject\setData().

PKPAuthor::setPrimaryContact (   $primaryContact)

Set primary contact.

Parameters
$primaryContactboolean

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

References DataObject\setData().

PKPAuthor::setSalutation (   $salutation)

Set user salutation.

Parameters
$salutationstring

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

References DataObject\setData().

PKPAuthor::setSequence (   $sequence)

Set sequence of author in article's author list.

Parameters
$sequencefloat

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

References DataObject\setData().

PKPAuthor::setSubmissionId (   $submissionId)

Set ID of submission.

Parameters
$submissionIdint

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

References DataObject\setData().

Referenced by Author\setArticleId().

PKPAuthor::setSuffix (   $suffix)

Set suffix.

Parameters
$suffixstring

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

References DataObject\setData().

PKPAuthor::setUrl (   $url)

Set URL.

Parameters
$urlstring

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

References DataObject\setData().

PKPAuthor::setUserGroupId (   $userGroupId)

Set the user group id

Parameters
$userGroupIdint

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

References DataObject\setData().


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