Identity.inc.php

<?php
 
define('IDENTITY_SETTING_GIVENNAME', 'givenName');
define('IDENTITY_SETTING_FAMILYNAME', 'familyName');
 
class Identity extends DataObject {
 
   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;
   }
 
   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" :'');
      }
   }
 
   function getGivenName($locale) {
      return $this->getData(IDENTITY_SETTING_GIVENNAME, $locale);
   }
 
   function setGivenName($givenName, $locale) {
      $this->setData(IDENTITY_SETTING_GIVENNAME, $givenName, $locale);
   }
 
   function getLocalizedGivenName($defaultLocale = null) {
      return $this->getLocalizedData(IDENTITY_SETTING_GIVENNAME, $defaultLocale);
   }
 
   function getFamilyName($locale) {
      return $this->getData(IDENTITY_SETTING_FAMILYNAME, $locale);
   }
 
   function setFamilyName($familyName, $locale) {
      $this->setData(IDENTITY_SETTING_FAMILYNAME, $familyName, $locale);
   }
 
   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);
   }
 
   function getPreferredPublicName($locale) {
      return $this->getData('preferredPublicName', $locale);
   }
 
   function setPreferredPublicName($preferredPublicName, $locale) {
      $this->setData('preferredPublicName', $preferredPublicName, $locale);
   }
 
   function getAffiliation($locale) {
      return $this->getData('affiliation', $locale);
   }
 
   function setAffiliation($affiliation, $locale) {
      $this->setData('affiliation', $affiliation, $locale);
   }
 
   function getLocalizedAffiliation() {
      return $this->getLocalizedData('affiliation');
   }
 
   function getEmail() {
      return $this->getData('email');
   }
 
   function setEmail($email) {
      $this->setData('email', $email);
   }
 
   function getOrcid() {
      return $this->getData('orcid');
   }
 
   function setOrcid($orcid) {
      $this->setData('orcid', $orcid);
   }
 
   function getCountry() {
      return $this->getData('country');
   }
 
   function getCountryLocalized() {
      $countryCode = $this->getCountry();
      if (!$countryCode) return null;
      $isoCodes = new \Sokil\IsoCodes\IsoCodesFactory();
      $country = $isoCodes->getCountries()->getByAlpha2($countryCode);
      return $country?$country->getLocalName():null;
   }
 
   function setCountry($country) {
      $this->setData('country', $country);
   }
 
   function getUrl() {
      return $this->getData('url');
   }
 
   function setUrl($url) {
      $this->setData('url', $url);
   }
 
   function getLocalizedBiography() {
      return $this->getLocalizedData('biography');
   }
 
   function getBiography($locale) {
      return $this->getData('biography', $locale);
   }
 
   function setBiography($biography, $locale) {
      $this->setData('biography', $biography, $locale);
   }
 
}