Merge pull request #18 from beatrycze-volk/related-item

Make `RelatedItem` to extend `ModsReader`
slub · Jun 17, 2024 · e3e49eb · e3e49eb
2 parents a2335db + 4e7e6dc
commit e3e49eb
Show file tree

Hide file tree

Showing 5 changed files with 102 additions and 57 deletions.
diff --git a/src/Mods/Attribute/Common/Attribute.php b/src/Mods/Attribute/Common/Attribute.php
@@ -0,0 +1,62 @@
+<?php
+
+/**
+ * Copyright (C) 2024 Saxon State and University Library Dresden
+ *
+ * This file is part of the php-mods-reader.
+ *
+ * @license GNU General Public License version 3 or later.
+ * For the full copyright and license information, please read the
+ * LICENSE.txt file that was distributed with this source code.
+ */
+
+namespace Slub\Mods\Attribute\Common;
+
+/**
+ * Trait for two general types of attributes
+ */
+trait Attribute
+{
+
+    /**
+     * Get the string value of attribute.
+     *
+     * @access protected
+     *
+     * @param string $attribute name
+     *
+     * @return string
+     */
+    protected function getStringAttribute($attribute): string
+    {
+        if ($this->xml->attributes() != null) {
+            $value = $this->xml->attributes()->$attribute;
+
+            if (!empty($value)) {
+                return $value;
+            }
+        }
+        return '';
+    }
+
+    /**
+     * Get the int value of attribute.
+     *
+     * @access protected
+     *
+     * @param string $attribute name
+     *
+     * @return int
+     */
+    protected function getIntAttribute($attribute): int
+    {
+        if ($this->xml->attributes() != null) {
+            $value = $this->xml->attributes()->$attribute;
+
+            if (!empty($value)) {
+                return (int) $value;
+            }
+        }
+        return 0;
+    }
+}
diff --git a/src/Mods/Element/Common/BaseElement.php b/src/Mods/Element/Common/BaseElement.php
@@ -12,6 +12,7 @@
 
 namespace Slub\Mods\Element\Common;
 
+use Slub\Mods\Attribute\Common\Attribute;
 use Slub\Mods\Element\Xml\Element;
 
 /**
@@ -21,6 +22,7 @@
  */
 class BaseElement
 {
+    use Attribute;
 
     /**
      * @access protected
@@ -54,48 +56,6 @@ public function getValue(): string
         return $this->xml[0];
     }
 
-    /**
-     * Get the string value of attribute.
-     *
-     * @access protected
-     *
-     * @param string $attribute name
-     *
-     * @return string
-     */
-    protected function getStringAttribute($attribute): string
-    {
-        if ($this->xml->attributes() != null) {
-            $value = $this->xml->attributes()->$attribute;
-
-            if (!empty($value)) {
-                return $value;
-            }
-        }
-        return '';
-    }
-
-    /**
-     * Get the int value of attribute.
-     *
-     * @access protected
-     *
-     * @param string $attribute name
-     *
-     * @return int
-     */
-    protected function getIntAttribute($attribute): int
-    {
-        if ($this->xml->attributes() != null) {
-            $value = $this->xml->attributes()->$attribute;
-
-            if (!empty($value)) {
-                return (int) $value;
-            }
-        }
-        return 0;
-    }
-
     /**
      * Get the array of the matching elements.
      *

diff --git a/src/Mods/Element/RelatedItem.php b/src/Mods/Element/RelatedItem.php
@@ -12,23 +12,22 @@
 
 namespace Slub\Mods\Element;
 
+use Slub\Mods\Attribute\Common\Attribute;
 use Slub\Mods\Attribute\Common\Linking\IdAttribute;
 use Slub\Mods\Attribute\Common\Linking\XlinkHrefAttribute;
 use Slub\Mods\Attribute\Common\Miscellaneous\DisplayLabelAttribute;
 use Slub\Mods\Attribute\Specific\OtherTypeAttribute;
-use Slub\Mods\Element\Common\BaseElement;
 use Slub\Mods\Exception\IncorrectValueInAttributeException;
+use Slub\Mods\ModsReader;
 
 /**
  * RelatedItem MODS metadata element class for the 'php-mods-reader' library.
  *
  * @access public
  */
-class RelatedItem extends BaseElement
+class RelatedItem extends ModsReader
 {
-    use IdAttribute, XlinkHrefAttribute, DisplayLabelAttribute, OtherTypeAttribute;
-
-    //TODO: all elements can appear
+    use Attribute, IdAttribute, XlinkHrefAttribute, DisplayLabelAttribute, OtherTypeAttribute;
 
         /**
      * @access private

diff --git a/src/Mods/ModsReader.php b/src/Mods/ModsReader.php
@@ -43,10 +43,10 @@
 class ModsReader
 {
     /**
-     * @access private
+     * @access protected
      * @var \SimpleXMLElement The metadata XML
      **/
-    private $xml;
+    protected $xml;
 
     /**
      * This creates the MODS Reader for given XML

diff --git a/tests/Mods/ModsReaderTest.php b/tests/Mods/ModsReaderTest.php
@@ -1075,23 +1075,47 @@ public function testGetRelatedItemsForSerialDocument()
         $relatedItems = $this->serialReader->getRelatedItems();
         self::assertNotEmpty($relatedItems);
         self::assertEquals(1, count($relatedItems));
-        self::assertNotEmpty($relatedItems[0]->getValue());
-        self::assertNotEmpty($relatedItems[0]->getType());
-        self::assertEquals('preceding', $relatedItems[0]->getType());
 
-        // TODO: implement reading of elements
+        $relatedItem = $relatedItems[0];
+        self::assertNotEmpty($relatedItem->getType());
+        self::assertEquals('preceding', $relatedItem->getType());
+        self::assertNotEmpty($relatedItem->getTitleInfos());
+        self::assertEquals('Journal of southern academic and special librarianship', $relatedItem->getTitleInfos()[0]->getTitle()->getValue());
+        self::assertNotEmpty($relatedItem->getOriginInfos());
+        //TODO: implement back compatibility for 'publisher' element
+        //self::assertEquals('Journal of southern academic and special librarianship', $relatedItem->getOriginInfos()[0]->getPublisher());
+        self::assertNotEmpty($relatedItem->getIdentifiers());
+        self::assertEquals(4, count($relatedItem->getIdentifiers()));
+        self::assertEquals('1525-321X', $relatedItem->getIdentifiers()[0]->getValue());
+
+        $localIdentifiers = $relatedItem->getIdentifiers('[@type="local"]');
+        self::assertNotEmpty($localIdentifiers);
+        self::assertEquals(3, count($localIdentifiers));
+        self::assertEquals('(OCoLC)41477508', $localIdentifiers[0]->getValue());
     }
 
     public function testGetRelatedItemsByQueryForSerialDocument()
     {
         $relatedItems = $this->serialReader->getRelatedItems('[./mods:identifier="1525-321X"]');
         self::assertNotEmpty($relatedItems);
         self::assertEquals(1, count($relatedItems));
-        self::assertNotEmpty($relatedItems[0]->getValue());
-        self::assertNotEmpty($relatedItems[0]->getType());
-        self::assertEquals('preceding', $relatedItems[0]->getType());
 
-        // TODO: implement reading of elements
+        $relatedItem = $relatedItems[0];
+        self::assertNotEmpty($relatedItem->getType());
+        self::assertEquals('preceding', $relatedItem->getType());
+        self::assertNotEmpty($relatedItem->getTitleInfos());
+        self::assertEquals('Journal of southern academic and special librarianship', $relatedItem->getTitleInfos()[0]->getTitle()->getValue());
+        self::assertNotEmpty($relatedItem->getOriginInfos());
+        //TODO: implement back compatibility for 'publisher' element
+        //self::assertEquals('Journal of southern academic and special librarianship', $relatedItem->getOriginInfos()[0]->getPublisher());
+        self::assertNotEmpty($relatedItem->getIdentifiers());
+        self::assertEquals(4, count($relatedItem->getIdentifiers()));
+        self::assertEquals('1525-321X', $relatedItem->getIdentifiers()[0]->getValue());
+
+        $localIdentifiers = $relatedItem->getIdentifiers('[@type="local"]');
+        self::assertNotEmpty($localIdentifiers);
+        self::assertEquals(3, count($localIdentifiers));
+        self::assertEquals('(OCoLC)41477508', $localIdentifiers[0]->getValue());
     }
 
     public function testGetNoRelatedItemsByQueryForSerialDocument()