Server : Apache/2.4.41 (Ubuntu) System : Linux journalup 5.4.0-198-generic #218-Ubuntu SMP Fri Sep 27 20:18:53 UTC 2024 x86_64 User : www-data ( 33) PHP Version : 7.4.33 Disable Function : pcntl_alarm,pcntl_fork,pcntl_waitpid,pcntl_wait,pcntl_wifexited,pcntl_wifstopped,pcntl_wifsignaled,pcntl_wifcontinued,pcntl_wexitstatus,pcntl_wtermsig,pcntl_wstopsig,pcntl_signal,pcntl_signal_get_handler,pcntl_signal_dispatch,pcntl_get_last_error,pcntl_strerror,pcntl_sigprocmask,pcntl_sigwaitinfo,pcntl_sigtimedwait,pcntl_exec,pcntl_getpriority,pcntl_setpriority,pcntl_async_signals,pcntl_unshare, Directory : /var/www/html/lib/pkp/classes/identity/
Upload File :
Current File : /var/www/html/lib/pkp/classes/identity/Identity.inc.php
<?php
/**
* @defgroup identity Identity
* Implements an abstract identity underlying e.g. User and Author records.
*/
/**
* @file classes/identity/Identity.inc.php
*
* Copyright (c) 2014-2020 Simon Fraser University
* Copyright (c) 2000-2020 John Willinsky
* Distributed under the GNU GPL v3. For full terms see the file docs/COPYING.
*
* @class Identity
* @ingroup identity
*
* @brief Basic class providing common functionality for users and authors in the system.
*/
define('IDENTITY_SETTING_GIVENNAME', 'givenName');
define('IDENTITY_SETTING_FAMILYNAME', 'familyName');
class Identity extends DataObject {
/**
* Get a piece of data for this object, localized to the current
* locale if possible.
* @param $key string
* @param $preferredLocale string
* @return mixed
*/
function &getLocalizedData($key, $preferredLocale = null) {
if (is_null($preferredLocale)) $preferredLocale = AppLocale::getLocale();
$localePrecedence = array($preferredLocale);
// the users register for the site, thus
// the site primary locale is the default locale
$site = Application::get()->getRequest()->getSite();
if (!in_array($site->getPrimaryLocale(), $localePrecedence)) $localePrecedence[] = $site->getPrimaryLocale();
// for settings other than givenName, familyName and affiliation (that are required for registration)
// consider also the context primary locale
if (!in_array(AppLocale::getPrimaryLocale(), $localePrecedence)) $localePrecedence[] = AppLocale::getPrimaryLocale();
foreach ($localePrecedence as $locale) {
if (empty($locale)) continue;
$value =& $this->getData($key, $locale);
if (!empty($value)) return $value;
unset($value);
}
// Fallback: Get the first available piece of data.
$data =& $this->getData($key, null);
foreach ((array) $data as $dataValue) {
if (!empty($dataValue)) return $dataValue;
}
// No data available; return null.
unset($data);
$data = null;
return $data;
}
/**
* Get the identity's localized complete name.
* Includes given name and family name.
* @param $preferred boolean If the preferred public name should be used, if exist
* @param $familyFirst boolean False / default: Givenname Familyname
* If true: Familyname, Givenname
* @param $defaultLocale string
* @return string
*/
function getFullName($preferred = true, $familyFirst = false, $defaultLocale = null) {
$locale = AppLocale::getLocale();
if ($preferred) {
$preferredPublicName = $this->getPreferredPublicName($locale);
if (!empty($preferredPublicName)) return $preferredPublicName;
}
$givenName = $this->getGivenName($locale);
if (empty($givenName)) {
if (is_null($defaultLocale)) {
// the users register for the site, thus
// the site primary locale is the default locale
$site = Application::get()->getRequest()->getSite();
$defaultLocale = $site->getPrimaryLocale();
}
$locale = $defaultLocale;
$givenName = $this->getGivenName($locale);
}
$familyName = $this->getFamilyName($locale);
if ($familyFirst) {
return ($familyName != ''?"$familyName, " :'') . $givenName;
} else {
return $givenName . ($familyName != ''?" $familyName" :'');
}
}
/**
* Get given name.
* @param $locale string
* @return string|array
*/
function getGivenName($locale) {
return $this->getData(IDENTITY_SETTING_GIVENNAME, $locale);
}
/**
* Set given name.
* @param $givenName string
* @param $locale string
*/
function setGivenName($givenName, $locale) {
$this->setData(IDENTITY_SETTING_GIVENNAME, $givenName, $locale);
}
/**
* Get the localized given name
* @return string
*/
function getLocalizedGivenName($defaultLocale = null) {
return $this->getLocalizedData(IDENTITY_SETTING_GIVENNAME, $defaultLocale);
}
/**
* Get family name.
* @param $locale string
* @return string|array
*/
function getFamilyName($locale) {
return $this->getData(IDENTITY_SETTING_FAMILYNAME, $locale);
}
/**
* Set family name.
* @param $familyName string
* @param $locale string
*/
function setFamilyName($familyName, $locale) {
$this->setData(IDENTITY_SETTING_FAMILYNAME, $familyName, $locale);
}
/**
* Get the localized family name
* Return family name for the locale first name exists in
* @param $defaultLocale string
* @return string
*/
function getLocalizedFamilyName($defaultLocale = null) {
$localePriorityList = array();
if (!is_null($defaultLocale)) {
$localePriorityList[] = $defaultLocale;
}
$localePriorityList[] = AppLocale::getLocale();
foreach ($localePriorityList as $locale) {
$givenName = $this->getGivenName($locale);
if (!empty($givenName)) {
return $this->getFamilyName($locale);
}
}
$site = Application::get()->getRequest()->getSite();
$locale = $site->getPrimaryLocale();
return $this->getFamilyName($locale);
}
/**
* Get preferred public name.
* @param $locale string
* @return string
*/
function getPreferredPublicName($locale) {
return $this->getData('preferredPublicName', $locale);
}
/**
* Set preferred public name.
* @param $preferredPublicName string
* @param $locale string
*/
function setPreferredPublicName($preferredPublicName, $locale) {
$this->setData('preferredPublicName', $preferredPublicName, $locale);
}
/**
* Get affiliation (position, institution, etc.).
* @param $locale string
* @return string
*/
function getAffiliation($locale) {
return $this->getData('affiliation', $locale);
}
/**
* Set affiliation.
* @param $affiliation string
* @param $locale string
*/
function setAffiliation($affiliation, $locale) {
$this->setData('affiliation', $affiliation, $locale);
}
/**
* Get the localized affiliation
*/
function getLocalizedAffiliation() {
return $this->getLocalizedData('affiliation');
}
/**
* Get email address.
* @return string
*/
function getEmail() {
return $this->getData('email');
}
/**
* Set email address.
* @param $email string
*/
function setEmail($email) {
$this->setData('email', $email);
}
/**
* Get ORCID identifier
* @return string
*/
function getOrcid() {
return $this->getData('orcid');
}
/**
* Set ORCID identifier.
* @param $orcid string
*/
function setOrcid($orcid) {
$this->setData('orcid', $orcid);
}
/**
* Get country code (ISO 3166-1 two-letter codes)
* @return string
*/
function getCountry() {
return $this->getData('country');
}
/**
* Get localized country
* @return string?
*/
function getCountryLocalized() {
$countryCode = $this->getCountry();
if (!$countryCode) return null;
$isoCodes = new \Sokil\IsoCodes\IsoCodesFactory();
$country = $isoCodes->getCountries()->getByAlpha2($countryCode);
return $country?$country->getLocalName():null;
}
/**
* Set country code (ISO 3166-1 two-letter codes)
* @param $country string
*/
function setCountry($country) {
$this->setData('country', $country);
}
/**
* Get URL.
* @return string
*/
function getUrl() {
return $this->getData('url');
}
/**
* Set URL.
* @param $url string
*/
function setUrl($url) {
$this->setData('url', $url);
}
/**
* Get the localized biography
* @return string
*/
function getLocalizedBiography() {
return $this->getLocalizedData('biography');
}
/**
* Get biography.
* @param $locale string
* @return string
*/
function getBiography($locale) {
return $this->getData('biography', $locale);
}
/**
* Set biography.
* @param $biography string
* @param $locale string
*/
function setBiography($biography, $locale) {
$this->setData('biography', $biography, $locale);
}
}
