#796 Remove hard coded set type name in the SetsManager.

Author: haogatyp

application/configs/application.ini

@@ -133,9 +133,10 @@ oai.format.xmetadissplus.class = Oai_Model_Prefix_XMetaDissPlus_XMetaDissPlusSer
 oai.format.marc21.class = Oai_Model_Prefix_MarcXml_MarcXmlServer
 
 ; OAI supported set types
-oai.set.collection.class = Oai_Model_Set_CollectionSets
+; The order is important, the collection set type must come last.
 oai.set.bibliography.class = Oai_Model_Set_BibliographySets
 oai.set.doc-type.class = Oai_Model_Set_DocumentTypeSets
+oai.set.collection.class = Oai_Model_Set_CollectionSets
 
 ; ERROR CONTROLLER SETTINGS
 errorController.showException = 0

modules/oai/models/Set/BibliographySets.php

@@ -80,4 +80,15 @@ public function configureFinder($finder, $setName)
 
         $finder->setBelongsToBibliography((int) filter_var($setValue, FILTER_VALIDATE_BOOLEAN));
     }
+
+    /**
+     * Returns if the set type class supports the handling of given set name.
+     *
+     * @param Oai_Model_Set_SetName $setName
+     * @return bool
+     */
+    public function supports($setName)
+    {
+        return $setName->getSetName() === 'bibliography';
+    }
 }

modules/oai/models/Set/CollectionSets.php

@@ -94,22 +94,21 @@ public function getSets($document = null)
      */
     public function configureFinder($finder, $setName)
     {
-        $setTypeName = $setName->getSetName();
-        $subsetName  = $setName->getSubsetName();
-
         if ($setName->getSetPartsCount() < 1 || $setName->getSetPartsCount() > 2) {
             $msg = "Invalid SetSpec: Must be in format 'set:subset'.";
             throw new Oai_Model_Exception($msg);
         }
 
         // Trying to locate collection role and filter documents.
-        $role = CollectionRole::fetchByOaiName($setTypeName);
+        $role = CollectionRole::fetchByOaiName($setName->getSetName());
         if ($role === null) {
             $msg = "Invalid SetSpec: Top level set does not exist.";
             throw new Oai_Model_Exception($msg);
         }
         $finder->setCollectionRoleId($role->getId());
 
+        $subsetName = $setName->getSubsetName();
+
         // Trying to locate given collection and filter documents.
         if ($subsetName !== null) {
             $foundSubsets = array_filter(
@@ -217,4 +216,16 @@ private function getSetsFromCollections($collections)
 
         return $sets;
     }
+
+    /**
+     * Returns if the set type class supports the handling of given set name.
+     *
+     * @param Oai_Model_Set_SetName $setName
+     * @return bool
+     */
+    public function supports($setName)
+    {
+        // TODO Assumes collection set type was configured last in the order.
+        return true;
+    }
 }

modules/oai/models/Set/DocumentTypeSets.php

@@ -96,4 +96,15 @@ public function configureFinder($finder, $setName)
 
         $finder->setDocumentType($subsetName);
     }
+
+    /**
+     * Returns if the set type class supports the handling of given set name.
+     *
+     * @param Oai_Model_Set_SetName $setName
+     * @return bool
+     */
+    public function supports($setName)
+    {
+        return $setName->getSetName() === 'doc-type';
+    }
 }

modules/oai/models/Set/SetTypeInterface.php

@@ -53,5 +53,11 @@ public function getSets($document = null);
      */
     public function configureFinder($finder, $setName);
 
-    //public function supports($setName);
+    /**
+     * Returns if the set type class supports the handling of given set name.
+     *
+     * @param Oai_Model_Set_SetName $setName
+     * @return bool
+     */
+    public function supports($setName);
 }

modules/oai/models/Set/SetsManager.php

@@ -54,18 +54,19 @@ public function getSets($document = null)
     }
 
     /**
+     * Returns the matching set type class for the given set name.
+     *
      * @param Oai_Model_Set_SetName $setName
      * @return Oai_Model_Set_SetTypeInterface|null
      */
     public function getSetType($setName)
     {
-        $setTypes    = $this->getSetTypeObjects();
-        $setTypeName = $setName->getSetName();
+        $setTypes = $this->getSetTypeObjects();
 
-        if (array_key_exists($setTypeName, $setTypes) && $setTypeName !== 'collection') {
-            return $setTypes[$setTypeName];
-        } elseif (array_key_exists('collection', $setTypes)) {
-            return $setTypes['collection'];
+        foreach ($setTypes as $setType) {
+            if ($setType->supports($setName)) {
+                return $setType;
+            }
         }
 
         return null;