Context.inc.php

<?php
 
 // Constant used to distinguish whether metadata is enabled and whether it
 // should be requested or required during submission
 define('METADATA_DISABLE', 0);
 define('METADATA_ENABLE', 'enable');
 define('METADATA_REQUEST', 'request');
 define('METADATA_REQUIRE', 'require');
 
abstract class Context extends DataObject {
 
   function getLocalizedName($preferredLocale = null) {
      return $this->getLocalizedData('name', $preferredLocale);
   }
 
   function setName($name, $locale = null) {
      $this->setData('name', $name, $locale);
   }
 
   function getName($locale = null) {
      return $this->getData('name', $locale);
   }
 
   function getContactName() {
      return $this->getData('contactName');
   }
 
   function setContactName($contactName) {
      $this->setData('contactName', $contactName);
   }
 
   function getContactEmail() {
      return $this->getData('contactEmail');
   }
 
   function setContactEmail($contactEmail) {
      $this->setData('contactEmail', $contactEmail);
   }
 
   function getDescription($locale = null) {
      return $this->getData('description', $locale);
   }
 
   function setDescription($description, $locale = null) {
      $this->setData('description', $description, $locale);
   }
 
   function getPath() {
      return $this->getData('urlPath');
   }
 
   function setPath($path) {
      $this->setData('urlPath', $path);
   }
 
   function getEnabled() {
      return $this->getData('enabled');
   }
 
   function setEnabled($enabled) {
      $this->setData('enabled', $enabled);
   }
 
   function getPrimaryLocale() {
      return $this->getData('primaryLocale');
   }
 
   function setPrimaryLocale($primaryLocale) {
      $this->setData('primaryLocale', $primaryLocale);
   }
   function getSequence() {
      return $this->getData('seq');
   }
 
   function setSequence($sequence) {
      $this->setData('seq', $sequence);
   }
 
   function getLocalizedDescription() {
      return $this->getLocalizedData('description');
   }
 
   function getLocalizedAcronym() {
      return $this->getLocalizedData('acronym');
   }
 
   function getAcronym($locale) {
      return $this->getData('acronym', $locale);
   }
 
   function getLocalizedFavicon() {
      $faviconArray = $this->getData('favicon');
      foreach (array(AppLocale::getLocale(), AppLocale::getPrimaryLocale()) as $locale) {
         if (isset($faviconArray[$locale])) return $faviconArray[$locale];
      }
      return null;
   }
 
   function getSupportedFormLocales() {
      return $this->getData('supportedFormLocales');
   }
 
   function getSupportedFormLocaleNames() {
      $supportedLocales =& $this->getData('supportedFormLocaleNames');
 
      if (!isset($supportedLocales)) {
         $supportedLocales = array();
         $localeNames =& AppLocale::getAllLocales();
 
         $locales = $this->getSupportedFormLocales();
         if (!isset($locales) || !is_array($locales)) {
            $locales = array();
         }
 
         foreach ($locales as $localeKey) {
            $supportedLocales[$localeKey] = $localeNames[$localeKey];
         }
      }
 
      return $supportedLocales;
   }
 
   function getSupportedSubmissionLocales() {
      return $this->getData('supportedSubmissionLocales');
   }
 
   function getSupportedSubmissionLocaleNames() {
      $supportedLocales =& $this->getData('supportedSubmissionLocaleNames');
 
      if (!isset($supportedLocales)) {
         $supportedLocales = array();
         $localeNames =& AppLocale::getAllLocales();
 
         $locales = $this->getSupportedSubmissionLocales();
         if (!isset($locales) || !is_array($locales)) {
            $locales = array();
         }
 
         foreach ($locales as $localeKey) {
            $supportedLocales[$localeKey] = $localeNames[$localeKey];
         }
      }
 
      return $supportedLocales;
   }
 
   function getSupportedLocales() {
      return $this->getData('supportedLocales');
   }
 
   function getSupportedLocaleNames() {
      $supportedLocales =& $this->getData('supportedLocaleNames');
 
      if (!isset($supportedLocales)) {
         $supportedLocales = array();
         $localeNames =& AppLocale::getAllLocales();
 
         $locales = $this->getSupportedLocales();
         if (!isset($locales) || !is_array($locales)) {
            $locales = array();
         }
 
         foreach ($locales as $localeKey) {
            $supportedLocales[$localeKey] = $localeNames[$localeKey];
         }
      }
 
      return $supportedLocales;
   }
 
   function getDateTimeFormats($format) {
      $data = $this->getData($format);
      $fallbackConfigVar = strtolower(preg_replace('/([A-Z])/', '_$1', $format));
      foreach ($this->getSupportedFormLocales() as $supportedLocale) {
         if (!array_key_exists($supportedLocale, $data)) $data[$supportedLocale] = Config::getVar('general', $fallbackConfigVar);
      }
 
      return $data;
   }
 
   function getLocalizedDateFormatShort($locale = null) {
      if (is_null($locale)) {
         $locale = AppLocale::getLocale();
      }
      $localizedData = $this->getData('dateFormatShort', $locale);
      if (empty($localizedData)) {
         $localizedData = Config::getVar('general', 'date_format_short');
      }
 
      return $localizedData;
   }
 
   function getLocalizedDateFormatLong($locale = null) {
      if (is_null($locale)) {
         $locale = AppLocale::getLocale();
      }
      $localizedData = $this->getData('dateFormatLong', $locale);
      if (empty($localizedData)) {
         $localizedData = Config::getVar('general', 'date_format_long');
      }
 
      return $localizedData;
   }
 
   function getLocalizedTimeFormat($locale = null) {
      if (is_null($locale)) {
         $locale = AppLocale::getLocale();
      }
      $localizedData = $this->getData('timeFormat', $locale);
      if (empty($localizedData)) {
         $localizedData = Config::getVar('general', 'time_format');
      }
 
      return $localizedData;
   }
 
   function getLocalizedDateTimeFormatShort($locale = null) {
      if (is_null($locale)) {
         $locale = AppLocale::getLocale();
      }
      $localizedData = $this->getData('datetimeFormatShort', $locale);
      if (empty($localizedData)) {
         $localizedData = Config::getVar('general', 'datetime_format_short');
      }
 
      return $localizedData;
   }
 
   function getLocalizedDateTimeFormatLong($locale = null) {
      if (is_null($locale)) {
         $locale = AppLocale::getLocale();
      }
      $localizedData = $this->getData('datetimeFormatLong', $locale);
      if (empty($localizedData)) {
         $localizedData = Config::getVar('general', 'datetime_format_long');
      }
 
      return $localizedData;
   }
 
   public abstract function getAssocType();
 
   function getSetting($name, $locale = null) {
      return $this->getData($name, $locale);
   }
 
   function getLocalizedSetting($name, $locale = null) {
      return $this->getLocalizedData($name, $locale);
   }
 
   function updateSetting($name, $value, $type = null, $isLocalized = false) {
      $settingsDao = Application::getContextSettingsDAO();
      return $settingsDao->updateSetting($this->getId(), $name, $value, $type, $isLocalized);
   }
 
   function getViews() {
      $application = Application::get();
      return $application->getPrimaryMetricByAssoc(Application::getContextAssocType(), $this->getId());
   }
 
 
   //
   // Statistics API
   //
   function getMetricTypes($withDisplayNames = false) {
      // Retrieve report plugins enabled for this journal.
      $reportPlugins = PluginRegistry::loadCategory('reports', true, $this->getId());
      if (empty($reportPlugins)) return array();
 
      // Run through all report plugins and retrieve all supported metrics.
      $metricTypes = array();
      foreach ($reportPlugins as $reportPlugin) {
         $pluginMetricTypes = $reportPlugin->getMetricTypes();
         if ($withDisplayNames) {
            foreach ($pluginMetricTypes as $metricType) {
               $metricTypes[$metricType] = $reportPlugin->getMetricDisplayType($metricType);
            }
         } else {
            $metricTypes = array_merge($metricTypes, $pluginMetricTypes);
         }
      }
 
      return $metricTypes;
   }
 
   function getDefaultMetricType() {
      $defaultMetricType = $this->getData('defaultMetricType');
 
      // Check whether the selected metric type is valid.
      $availableMetrics = $this->getMetricTypes();
      if (empty($defaultMetricType)) {
         if (count($availableMetrics) === 1) {
            // If there is only a single available metric then use it.
            $defaultMetricType = $availableMetrics[0];
         } else {
            // Use the site-wide default metric.
            $application = Application::get();
            $defaultMetricType = $application->getDefaultMetricType();
         }
      } else {
         if (!in_array($defaultMetricType, $availableMetrics)) return null;
      }
 
      return $defaultMetricType;
   }
 
   function getMetrics($metricType = null, $columns = array(), $filter = array(), $orderBy = array(), $range = null) {
      // Add a context filter and run the report.
      $filter[STATISTICS_DIMENSION_CONTEXT_ID] = $this->getId();
      $application = Application::get();
      return $application->getMetrics($metricType, $columns, $filter, $orderBy, $range);
   }
}