Open Monograph Press  1.1
 All Classes Namespaces Functions Variables Groups Pages
PKPAuthor Class Reference
Inheritance diagram for PKPAuthor:
Identity DataObject Author Author ChapterAuthor ChapterAuthor

Public Member Functions

 _setShowTitle ($showTitle)
 
 getLocalizedUserGroupName ()
 
 getPrimaryContact ()
 
 getSequence ()
 
 getShowTitle ()
 
 getSubmissionId ()
 
 getUserGroup ()
 
 getUserGroupId ()
 
 PKPAuthor ()
 
 setPrimaryContact ($primaryContact)
 
 setSequence ($sequence)
 
 setSubmissionId ($submissionId)
 
 setUserGroupId ($userGroupId)
 
- 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

Author metadata class.

See Also
PKPAuthorDAO

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

Member Function Documentation

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 78 of file PKPAuthor.inc.php.

References DataObject\setData().

PKPAuthor::getLocalizedUserGroupName ( )

Get a localized version of the User Group

Returns
string

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

References getUserGroup().

PKPAuthor::getPrimaryContact ( )

Get primary contact.

Returns
boolean

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

References DataObject\getData().

PKPAuthor::getSequence ( )

Get sequence of author in submissions' author list.

Returns
float

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

References DataObject\getData().

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 69 of file PKPAuthor.inc.php.

References DataObject\getData().

PKPAuthor::getSubmissionId ( )

Get ID of submission.

Returns
int

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

References DataObject\getData().

PKPAuthor::getUserGroup ( )

Get the user group for this contributor.

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

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

Referenced by getLocalizedUserGroupName().

PKPAuthor::getUserGroupId ( )

Get the user group id

Returns
int

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

References DataObject\getData().

Referenced by getUserGroup().

PKPAuthor::PKPAuthor ( )

Constructor.

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

PKPAuthor::setPrimaryContact (   $primaryContact)

Set primary contact.

Parameters
$primaryContactboolean

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

References DataObject\setData().

PKPAuthor::setSequence (   $sequence)

Set sequence of author in submissions' author list.

Parameters
$sequencefloat

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

References DataObject\setData().

PKPAuthor::setSubmissionId (   $submissionId)

Set ID of submission.

Parameters
$submissionIdint

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

References DataObject\setData().

PKPAuthor::setUserGroupId (   $userGroupId)

Set the user group id

Parameters
$userGroupIdint

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

References DataObject\setData().


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