DMCollection.php

<?php
#
# dmBridge: a data access framework for CONTENTdm(R)
#
# Copyright © 2009, 2010, 2011 Board of Regents of the Nevada System of Higher
# Education, on behalf of the University of Nevada, Las Vegas
#

class DMCollection extends DMModel implements DMURIAddressable {

   private static $authorized = array();

   private $alias;
   private $date_search_begin_year;
   private $date_search_end_year;
   private $description;
   private $facets = array();
   private $fields = array();
   private $grid_view_fields = array();
   private $has_been_loaded = false;
   private $has_custom_object_view_prefs = false;
   private $has_custom_results_view_prefs = false;
   private $has_custom_search_view_prefs = false;
   private $image_uri_512;
   private $is_redirecting_reference_urls;
   private $name;
   private $template_set_is_default = false;
   private $overview_uri;
   private $template_set_id;
   private $viewer_defs = array();

   public static function getAuthorized() {
      if (count(self::$authorized) < 1) {
         foreach (dmGetCollectionList() as $c) {
            self::$authorized[] = DMCollectionFactory::getCollection($c['alias']);
         }
         usort(self::$authorized,
               array("DMCollection", "compareCollectionNames"));
      }
      return self::$authorized;
   }

   private static function compareCollectionNames(DMCollection $a,
         DMCollection $b) {
      return strcasecmp($a->getName(), $b->getName());
   }

   public static final function exists($alias) {
      foreach (dmGetCollectionList() as $c) {
         if ($c['alias'] == $alias) {
            return true;
         }
      }
      return false;
   }

   public static function getSanitizedAlias($alias) {
      return "/" . DMString::paranoid(trim($alias, "/"), array("-", "_"));
   }

   public function __construct($alias) {
      $this->setAlias($alias);
      $this->load();
   }

   public function __toString() {
      return $this->getAlias();
   }

   public function equals($obj) {
      return (is_object($obj) && $obj instanceof DMCollection
            && $this->getAlias() == $obj->getAlias());
   }

   public function getAlias() {
      return $this->alias;
   }

   private function setAlias($alias) {
      // @todo externalize this validation
      if (strlen($alias) < 1) {
         throw new DMUnavailableModelException(
            DMLocalizedString::getString("NO_ALIAS_SUPPLIED"));
      }
      else if (strlen($alias) < 2 or strlen($alias) > 30) {
         throw new DMUnavailableModelException(
            DMLocalizedString::getString("INVALID_ALIAS"));
      }
      $this->alias = $alias;
   }

   public function hasCustomObjectViewPrefs() {
      return $this->has_custom_object_view_prefs;
   }

   public function setHasCustomObjectViewPrefs($bool) {
      $this->has_custom_object_view_prefs = (bool) $bool;
   }

   public function hasCustomResultsViewPrefs() {
      return $this->has_custom_results_view_prefs;
   }

   public function setHasCustomResultsViewPrefs($bool) {
      $this->has_custom_results_view_prefs = (bool) $bool;
   }

   public function hasCustomSearchViewPrefs() {
      return $this->has_custom_search_view_prefs;
   }

   public function setHasCustomSearchViewPrefs($bool) {
      $this->has_custom_search_view_prefs = (bool) $bool;
   }

   public function getDateSearchBeginYear() {
      return $this->date_search_begin_year;
   }

   public function getDateSearchEndYear() {
      return $this->date_search_end_year;
   }

   public function setDateSearchRange($begin_year, $end_year) {
      if ($begin_year > $end_year) {
         throw new DMIllegalArgumentException(
               DMLocalizedString::getString("INVALID_DATE_RANGE"));
      }
      $this->date_search_begin_year = $begin_year;
      $this->date_search_end_year = $end_year;
   }

   public function unsetDateSearchRange() {
      $this->date_search_begin_year = null;
      $this->date_search_end_year = null;
   }

   public function getDateSearchField() {
      foreach ($this->getFields() as $f) {
         if ($f->getType() == "DATE") {
            return $f;
         }
      }
   }

   public function getDescription() {
      return $this->description;
   }

   public function setDescription($desc) {
      $this->description = (string) $desc;
   }

   public function isDefault() {
      return ($this->getAlias() == "/dmdefault");
   }

   public function addFacet(DMFacetTerm $term) {
      $this->facets[] = $term;
   }

   public function getFacets() {
      return $this->facets;
   }

   public function unsetFacets() {
      $this->facets = array();
   }

   public function addField(DMDCElement $element) {
      $this->fields[] = $element;
   }

   public function getField($nick) {
      if (count($this->getFields()) < 1) {
         $this->instantiateFields();
      }
      foreach ($this->getFields() as $field) {
         if ($field->getNick() == $nick) {
            return $field;
         }
      }
      return null;
   }

   public function getFields() {
      return $this->fields;
   }

   public function unsetFields() {
      $this->fields = array();
   }

   public function addGridViewField(DMDCElement $field) {
      $this->grid_view_fields[] = $field;
   }

   public function getGridViewFields() {
      return $this->grid_view_fields;
   }

   public function unsetGridViewFields() {
      $this->grid_view_fields = array();
   }

   public function getImage512URI() {
      return $this->image_uri_512;
   }

   public function setImage512URI(DMURI $uri) {
      $this->image_uri_512 = $uri;
   }

   private function load() {
      if ($this->has_been_loaded) {
         return;
      }
      if ($this->getAlias() == "/dmdefault") {
         foreach (DMDCElement::getAll() as $f) {
            $this->addField($f);
         }
      } else {
         $cdm_defs = dmGetCollectionFieldInfo($this->getAlias());
         if (!is_array($cdm_defs)) {
            throw new DMUnavailableModelException(
               DMLocalizedString::getString("INSTANTIATE_NONEXISTENT_COLLECTION"));
         }
         foreach ($cdm_defs as $a) {
            $f = new DMDCElement($a['nick']);
            $f->setName($a['name']);
            $f->setControlled(($a['vocab'] > 0));
            $f->setCollection($this);
            $f->setSearchable(($a['search'] > 0));
            $f->setHidden(($a['hide'] > 0));
            $f->setDCNick($a['dc']);
            $f->setType($a['type']);
            $this->fields[] = $f;
         }
      }
      DMConfigXML::getInstance()->loadCollection($this);
      $this->has_been_loaded = true;
   }

   public function getName() {
      if (empty($this->name)) {
         foreach (dmGetCollectionList() as $c) {
            if ($c['alias'] == $this->getAlias()) {
               $this->name = $c['name'];
            }
         }
         if (empty($this->name)) {
            $this->name = DMLocalizedString::getString(
                  "DEFAULT_COLLECTION_NAME");
         }
      }
      return $this->name;
   }

   public function getNumObjects() {
      $aliases = array($this->getAlias());
      $terms = array();
      $fields = array('title');
      $sort_fields = array();
      $limit = 1;
      $start = 1;
      $num_results = 0;
      dmQuery($aliases, $terms, $fields, $sort_fields, $limit,
         $start, $num_results, 1);
      return $num_results;
   }

   public function getOverviewURI() {
      return $this->overview_uri;
   }

   public function setOverviewURI(DMURI $uri) {
      $this->overview_uri = $uri;
   }

   public function isRedirectingReferenceURLs() {
      return $this->is_redirecting_reference_urls;
   }

   public function setRedirectingReferenceURLs($bool) {
      $this->is_redirecting_reference_urls = ($bool);
   }

   public function getResultsViewFields() {
      return $this->grid_view_fields;
   }

   public function getTemplateSet() {
      if ($this->template_set_id) {
         return new DMTemplateSet($this->template_set_id);
      }
      return null;
   }

   public function setTemplateSetID($id) {
      $this->setUsingDefaultTemplateSet(false);
      $this->template_set_id = $id;
   }

   public function getURI() {
      return DMInternalURI::getResourceURI(
            DMBridgeComponent::HTTPAPI,
            "collections" . $this->getAlias());
   }

   public function isUsingDefaultTemplateSet() {
      return $this->template_set_is_default;
   }

   public function setUsingDefaultTemplateSet($bool) {
      if ($bool) {
         $this->template_set_id = null;
      }
      $this->template_set_is_default = ($bool);
   }

   public function addViewerDefinition(DMObjectViewerDefinition $vd) {
      $this->viewer_defs[] = $vd;
   }


   public function getViewerDefinitionForMediaType(DMMediaType $type) {
      foreach ($this->viewer_defs as $def) {
         if ($def->getMediaType()->equals($type)) {
            return $def;
         }
      }
      return null;
   }

   public function getViewerDefinitions() {
      return $this->viewer_defs;
   }

   public function unsetViewerDefinitions() {
      $this->viewer_defs = array();
   }

}