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

Public Member Functions

 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

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

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

Member Function Documentation

Identity::getAffiliation (   $locale)

Get affiliation (position, institution, etc.).

Parameters
$localestring
Returns
string

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

References DataObject\getData().

Identity::getBiography (   $locale)

Get author biography.

Parameters
$localestring
Returns
string

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

References DataObject\getData().

Identity::getCountry ( )

Get country code

Returns
string

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

References DataObject\getData().

Referenced by getCountryLocalized().

Identity::getCountryLocalized ( )

Get localized country

Returns
string

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

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

Identity::getEmail ( )

Get email address.

Returns
string

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

References DataObject\getData().

Identity::getFirstName ( )

Get first name.

Returns
string

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

References DataObject\getData().

Identity::getFullName (   $lastFirst = false)

Get the identity'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 36 of file Identity.inc.php.

References DataObject\getData().

Identity::getInitials ( )

Get initials.

Returns
string

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

References DataObject\getData().

Identity::getLastName ( )

Get last name.

Returns
string

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

References DataObject\getData().

Identity::getLocalizedAffiliation ( )

Get the localized affiliation for this author

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

References DataObject\getLocalizedData().

Identity::getLocalizedBiography ( )

Get the localized biography for this author

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

References DataObject\getLocalizedData().

Identity::getMiddleName ( )

Get middle name.

Returns
string

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

References DataObject\getData().

Identity::getSalutation ( )

Get user salutation.

Returns
string

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

References DataObject\getData().

Identity::getSuffix ( )

Get name suffix.

Returns
string

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

References DataObject\getData().

Identity::getUrl ( )

Get URL.

Returns
string

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

References DataObject\getData().

Identity::Identity ( )

Constructor

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

Identity::setAffiliation (   $affiliation,
  $locale 
)

Set affiliation.

Parameters
$affiliationstring
$localestring

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

References DataObject\setData().

Identity::setBiography (   $biography,
  $locale 
)

Set author biography.

Parameters
$biographystring
$localestring

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

References DataObject\setData().

Identity::setCountry (   $country)

Set country code.

Parameters
$countrystring

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

References DataObject\setData().

Identity::setEmail (   $email)

Set email address.

Parameters
$emailstring

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

References DataObject\setData().

Identity::setFirstName (   $firstName)

Set first name.

Parameters
$firstNamestring

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

References DataObject\setData().

Identity::setInitials (   $initials)

Set initials.

Parameters
$initialsstring

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

References DataObject\setData().

Identity::setLastName (   $lastName)

Set last name.

Parameters
$lastNamestring

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

References DataObject\setData().

Identity::setMiddleName (   $middleName)

Set middle name.

Parameters
$middleNamestring

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

References DataObject\setData().

Identity::setSalutation (   $salutation)

Set user salutation.

Parameters
$salutationstring

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

References DataObject\setData().

Identity::setSuffix (   $suffix)

Set suffix.

Parameters
$suffixstring

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

References DataObject\setData().

Identity::setUrl (   $url)

Set URL.

Parameters
$urlstring

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

References DataObject\setData().


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