Merge pull request #11 from beatrycze-volk/implment-part

Implement functions in Part class and its child element classes

src/Mods/Element/Part.php

@@ -21,40 +21,18 @@
 use Slub\Mods\Element\Specific\Part\Detail;
 use Slub\Mods\Element\Specific\Part\Extent;
 use Slub\Mods\Element\Specific\Part\Text;
+use Slub\Mods\Element\Xml\Element;
 
 /**
  * Part MODS metadata element class for the 'php-mods-reader' library.
+ * @see https://www.loc.gov/standards/mods/userguide/part.html
  *
  * @access public
  */
 class Part extends BaseElement
 {
     use LanguageAttribute, IdAttribute, AltRepGroupAttribute, DisplayLabelAttribute;
 
-    /**
-     * @access private
-     * @var Detail
-     */
-    private Detail $detail;
-
-    /**
-     * @access private
-     * @var Extent
-     */
-    private Extent $extent;
-
-    /**
-     * @access private
-     * @var DateElement
-     */
-    private DateElement $date;
-
-    /**
-     * @access private
-     * @var Text
-     */
-    private Text $text;
-
     /**
      * This extracts the essential MODS metadata from XML
      *
@@ -70,7 +48,8 @@ public function __construct(\SimpleXMLElement $xml)
     }
 
     /**
-     * Get the value of type
+     * Get the value of the 'type' attribute.
+     * @see https://www.loc.gov/standards/mods/userguide/part.html#type
      *
      * @access public
      *
@@ -82,7 +61,8 @@ public function getType(): string
     }
 
     /**
-     * Get the value of order
+     * Get the value of the 'order' attribute.
+     * @see https://www.loc.gov/standards/mods/userguide/part.html#order
      *
      * @access public
      *
@@ -94,50 +74,86 @@ public function getOrder(): int
     }
 
     /**
-     * Get the value of detail
+     * Get the array of the <detail> elements.
+     * @see https://www.loc.gov/standards/mods/userguide/part.html#detail
      *
      * @access public
      *
-     * @return Detail
+     * @param string $query The XPath query for metadata search
+     *
+     * @return Detail[]
      */
-    public function getDetail(): Detail
+    public function getDetails(string $query = ''): array
     {
-        return $this->detail;
+        $details = [];
+        $xpath = './mods:detail' . $query;
+        $element = new Element($this->xml, $xpath);
+        if ($element->exists()) {
+            foreach ($element->getValues() as $value) {
+                $details[] = new Detail($value);
+            }
+        }
+        return $details;
     }
 
     /**
-     * Get the value of extent
+     * Get the array of the <extent> elements.
+     * @see https://www.loc.gov/standards/mods/userguide/part.html#extent
      *
      * @access public
      *
-     * @return Extent
+     * @param string $query The XPath query for metadata search
+     *
+     * @return Extent[]
      */
-    public function getExtent(): Extent
+    public function getExtents(string $query = ''): array
     {
-        return $this->extent;
+        $extents = [];
+        $xpath = './mods:extent' . $query;
+        $element = new Element($this->xml, $xpath);
+        if ($element->exists()) {
+            foreach ($element->getValues() as $value) {
+                $extents[] = new Extent($value);
+            }
+        }
+        return $extents;
     }
 
     /**
-     * Get the value of date
+     * Get the array of the <date> elements.
+     * @see https://www.loc.gov/standards/mods/userguide/part.html#date
      *
      * @access public
      *
-     * @return DateElement
+     * @param string $query The XPath query for metadata search
+     *
+     * @return DateElement[]
      */
-    public function getDate(): DateElement
+    public function getDates(string $query = ''): array
     {
-        return $this->date;
+        return $this->getDateElements('./mods:date' . $query);
     }
 
     /**
-     * Get the value of text
+     * Get the array of the <text> elements.
+     * @see https://www.loc.gov/standards/mods/userguide/part.html#text
      *
      * @access public
      *
-     * @return Text
+     * @param string $query The XPath query for metadata search
+     *
+     * @return Text[]
      */
-    public function getText(): Text
+    public function getTexts(string $query = ''): array
     {
-        return $this->text;
+        $texts = [];
+        $xpath = './mods:text' . $query;
+        $element = new Element($this->xml, $xpath);
+        if ($element->exists()) {
+            foreach ($element->getValues() as $value) {
+                $texts[] = new Text($value);
+            }
+        }
+        return $texts;
     }
 }

src/Mods/Element/Specific/Part/Detail.php

@@ -17,30 +17,13 @@
 
 /**
  * Detail MODS metadata element class for the 'php-mods-reader' library.
+ * @see https://www.loc.gov/standards/mods/userguide/part.html#detail
  *
  * @access public
  */
 class Detail extends BaseElement
 {
 
-    /**
-     * @access private
-     * @var LanguageElement
-     */
-    private LanguageElement $number;
-
-    /**
-     * @access private
-     * @var LanguageElement
-     */
-    private LanguageElement $caption;
-
-    /**
-     * @access private
-     * @var LanguageElement
-     */
-    private LanguageElement $title;
-
     /**
      * This extracts the essential MODS metadata from XML
      *
@@ -56,7 +39,8 @@ public function __construct(\SimpleXMLElement $xml)
     }
 
     /**
-     * Get the value of type
+     * Get the value of the 'type' attribute.
+     * @see https://www.loc.gov/standards/mods/userguide/part.html#detailtype
      *
      * @access public
      *
@@ -68,7 +52,8 @@ public function getType(): string
     }
 
     /**
-     * Get the value of level
+     * Get the value of the 'level' attribute.
+     * @see https://www.loc.gov/standards/mods/userguide/part.html#level
      *
      * @access public
      *
@@ -80,38 +65,47 @@ public function getLevel(): int
     }
 
     /**
-     * Get the value of number
+     * Get the array of the <number> elements.
+     * @see https://www.loc.gov/standards/mods/userguide/part.html#number
      *
      * @access public
      *
+     * @param string $query The XPath query for metadata search
+     *
      * @return LanguageElement
      */
-    public function getNumber(): LanguageElement
+    public function getNumbers(string $query = ''): array
     {
-        return $this->number;
+        return $this->getLanguageElements('./mods:number' . $query);
     }
 
     /**
-     * Get the value of caption
+     * Get the array of the <caption> elements.
+     * @see https://www.loc.gov/standards/mods/userguide/part.html#caption
      *
      * @access public
      *
+     * @param string $query The XPath query for metadata search
+     *
      * @return LanguageElement
      */
-    public function getCaption(): LanguageElement
+    public function getCaptions(string $query = ''): array
     {
-        return $this->caption;
+        return $this->getLanguageElements('./mods:caption' . $query);
     }
 
     /**
-     * Get the value of title
+     * Get the array of the <title> elements.
+     * @see https://www.loc.gov/standards/mods/userguide/part.html#title
      *
      * @access public
      *
+     * @param string $query The XPath query for metadata search
+     *
      * @return LanguageElement
      */
-    public function getTitle(): LanguageElement
+    public function getTitles(string $query = ''): array
     {
-        return $this->title;
+        return $this->getLanguageElements('./mods:title' . $query);
     }
 }