Refactoring: move image-region-related classes to dedicated files

Author: lourot

src/Metadata/Xmp.php

@@ -1,7 +1,9 @@
 <?php
 namespace CSD\Image\Metadata;
 
-use CSD\Image\Metadata\UnsupportedException;
+use CSD\Image\Metadata\Xmp\ImageRegion;
+use CSD\Image\Metadata\Xmp\RoleFilter;
+use CSD\Image\Metadata\Xmp\ShapeFilter;
 
 /**
  * Class to read XMP metadata from an image.
@@ -1403,11 +1405,10 @@ public function setFeaturedOrganisationCode($featuredOrganisationCode)
      * @param string $roleFilter
      *
      * @return array
-     * @throws UnsupportedException
      */
     public function getImageRegions(
-        $shapeFilter = XmpShapeFilter::ANY,
-        $roleFilter = XmpRoleFilter::ANY)
+        $shapeFilter = ShapeFilter::ANY,
+        $roleFilter = RoleFilter::ANY)
     {
         $imageRegionNode = $this->getNode(
             'Iptc4xmpExt:ImageRegion',
@@ -1426,7 +1427,7 @@ public function getImageRegions(
 
         $results = [];
         foreach ($imageRegionBag->childNodes as $imageRegionItem) {
-            $imageRegion = new XmpImageRegion($this->xpath, $imageRegionItem);
+            $imageRegion = new ImageRegion($this->xpath, $imageRegionItem);
             array_push($results, $imageRegion);
         }
 
@@ -1451,322 +1452,3 @@ public function hasChanges()
         return $this->hasChanges;
     }
 }
-
-/**
- * PHP5 enum.
- */
-abstract class XmpShapeFilter
-{
-    const ANY = '';
-    const RECTANGLE = 'rectangle';
-    const CIRCLE = 'circle';
-    const POLYGON = 'polygon';
-
-    /**
-     * @param string $value RECTANGLE, CIRCLE or POLYGON.
-     *
-     * @return string The corresponding value of the <Iptc4xmpExt:rbShape>
-     *                element.
-     * @throws UnsupportedException
-     */
-    public static function getXmlRbShape($value)
-    {
-        switch ($value) {
-            case self::RECTANGLE:
-            case self::CIRCLE:
-            case self::POLYGON:
-                return $value;
-        }
-        throw new UnsupportedException('Unsupported region shape');
-    }
-}
-
-/**
- * PHP5 enum.
- */
-abstract class XmpRoleFilter
-{
-    const ANY = '';
-    const CROP = 'crop';
-
-    /**
-     * @param string $value CROP.
-     *
-     * @return array The list of <Iptc4xmpExt:rRole><Iptc4xmpExt:Name> or
-     *               <Iptc4xmpExt:rRole><Iptc4xmpExt:Identifier> values
-     *               that would match the filter.
-     * @throws UnsupportedException
-     */
-    public static function getMatchingXmlRoles($value)
-    {
-        switch ($value) {
-            case self::CROP:
-                // See https://cv.iptc.org/newscodes/imageregionrole/
-                return [
-                    'cropping',
-                    'recommended cropping',
-                    'landscape format cropping',
-                    'portrait format cropping',
-                    'square format cropping',
-                    'http://cv.iptc.org/newscodes/imageregionrole/cropping',
-                    'http://cv.iptc.org/newscodes/imageregionrole/recomCropping',
-                    'http://cv.iptc.org/newscodes/imageregionrole/landscapeCropping',
-                    'http://cv.iptc.org/newscodes/imageregionrole/portraitCropping',
-                    'http://cv.iptc.org/newscodes/imageregionrole/squareCropping',
-                ];
-        }
-        throw new UnsupportedException('Unsupported region role filter');
-    }
-}
-
-/**
- * Represents an Image Region read from XMP metadata.
- * See https://iptc.org/std/photometadata/specification/IPTC-PhotoMetadata#image-region
- */
-class XmpImageRegion
-{
-    /**
-     * @var string|null
-     */
-    public $id;
-
-    /**
-     * @var array|null
-     */
-    public $names;
-
-    /**
-     * @var array|null
-     */
-    public $types;
-
-    /**
-     * @var array|null
-     */
-    public $roles;
-
-    /**
-     * 'rectangle', 'circle' or 'polygon'.
-     *
-     * @var string|null
-     */
-    public $rbShape;
-
-    /**
-     * E.g. 'relative'.
-     *
-     * @var string|null
-     */
-    public $rbUnit;
-
-    /**
-     * Rectangle or circle's coordinates.
-     *
-     * @var XmpImageRegionPoint
-     */
-    public $rbXY;
-
-    /**
-     * Rectangle's height.
-     *
-     * @var string|null
-     */
-    public $rbH;
-
-    /**
-     * Rectangle's width.
-     *
-     * @var string|null
-     */
-    public $rbW;
-
-    /**
-     * Circle's radius.
-     *
-     * @var string|null
-     */
-    public $rbRx;
-
-    /**
-     * Polygon's vertices.
-     *
-     * @var array|null
-     */
-    public $rbVertices;
-
-    /**
-     * @param \DOMXPath $xpath
-     * @param \DOMNode $node <rdf:li> node.
-     */
-    public function __construct($xpath, $node)
-    {
-        $this->id = self::getNodeValue($xpath, 'Iptc4xmpExt:rId', $node);
-        $this->names = self::getNodeValues(
-            $xpath,
-            'Iptc4xmpExt:Name/rdf:Alt/rdf:li',
-            $node
-        );
-        $this->types = self::getEntityOrConceptValues(
-            $xpath,
-            'Iptc4xmpExt:rCtype',
-            $node
-        );
-        $this->roles = self::getEntityOrConceptValues(
-            $xpath,
-            'Iptc4xmpExt:rRole',
-            $node
-        );
-
-        $xpathToRb = 'Iptc4xmpExt:RegionBoundary';
-
-        foreach ([
-            'rbShape',
-            'rbUnit',
-            'rbH',
-            'rbW',
-            'rbRx',
-        ] as $property) {
-            $this->$property = self::getNodeValue(
-                $xpath,
-                "$xpathToRb/Iptc4xmpExt:$property",
-                $node
-            );
-        }
-
-        $this->rbXY = new XmpImageRegionPoint(
-            self::getNodeValue($xpath, "$xpathToRb/Iptc4xmpExt:rbX", $node),
-            self::getNodeValue($xpath, "$xpathToRb/Iptc4xmpExt:rbY", $node)
-        );
-
-        $verticesNodes = $xpath->query(
-            "$xpathToRb/Iptc4xmpExt:rbVertices/rdf:Seq/rdf:li",
-            $node
-        );
-        if ($verticesNodes->length) {
-            $this->rbVertices = [];
-            foreach ($verticesNodes as $verticesNode) {
-                $point = new XmpImageRegionPoint(
-                    self::getNodeValue($xpath, "Iptc4xmpExt:rbX", $verticesNode),
-                    self::getNodeValue($xpath, "Iptc4xmpExt:rbY", $verticesNode)
-                );
-                array_push($this->rbVertices, $point);
-            }
-        }
-    }
-
-    /**
-     * @param string $filter One of the XmpShapeFilter constants.
-     *
-     * @return bool
-     */
-    public function matchesShapeFilter($filter) {
-        return (
-            $filter === XmpShapeFilter::ANY ||
-            XmpShapeFilter::getXmlRbShape($filter) === $this->rbShape
-        );
-    }
-
-    /**
-     * @param string $filter One of the XmpRoleFilter constants.
-     *
-     * @return bool
-     */
-    public function matchesRoleFilter($filter) {
-        return (
-            $filter === XmpRoleFilter::ANY ||
-            count(array_intersect(
-                XmpRoleFilter::getMatchingXmlRoles($filter),
-                $this->roles
-            )) > 0
-        );
-    }
-
-    /**
-     * @param \DOMXPath $xpath
-     * @param string $expression XPath expression leading to one single node.
-     * @param \DOMNode $contextNode
-     *
-     * @return string|null
-     */
-    private static function getNodeValue($xpath, $expression, $contextNode) {
-        $node = $xpath->query($expression, $contextNode)->item(0);
-        return $node ? $node->nodeValue : null;
-    }
-
-    /**
-     * @param \DOMXPath $xpath
-     * @param string $expression XPath expression leading to several nodes.
-     * @param \DOMNode $contextNode
-     *
-     * @return array|null
-     */
-    private static function getNodeValues($xpath, $expression, $contextNode) {
-        $nodes = $xpath->query($expression, $contextNode);
-        if (!$nodes->length) {
-            return null;
-        }
-
-        $result = [];
-        foreach ($nodes as $node) {
-            array_push($result, $node->nodeValue);
-        }
-        return $result;
-    }
-
-    /**
-     * See https://iptc.org/std/photometadata/specification/IPTC-PhotoMetadata#entity-or-concept-structure
-     *
-     * @param \DOMXPath $xpath
-     * @param string $expression XPath expression leading to the parent of an
-     *                           <rdf:Bag> of an Identity or Concept structure.
-     * @param \DOMNode $contextNode
-     *
-     * @return array|null
-     */
-    private static function getEntityOrConceptValues(
-        $xpath,
-        $expression,
-        $contextNode
-    ) {
-        $names = self::getNodeValues(
-            $xpath,
-            "$expression/rdf:Bag/rdf:li/Iptc4xmpExt:Name/rdf:Alt/rdf:li",
-            $contextNode
-        );
-        $identifiers = self::getNodeValues(
-            $xpath,
-            "$expression/rdf:Bag/rdf:li/xmp:Identifier/rdf:Bag/rdf:li",
-            $contextNode
-        );
-
-        if (!$names) {
-            return $identifiers;
-        }
-        if (!$identifiers) {
-            return $names;
-        }
-        return array_merge($names, $identifiers);
-    }
-}
-
-/**
- * (X, Y) pair of coordinates.
- */
-class XmpImageRegionPoint
-{
-    /**
-     * @var string|null
-     */
-    public $rbX;
-
-    /**
-     * @var string|null
-     */
-    public $rbY;
-
-    public function __construct($x, $y)
-    {
-        $this->rbX = $x;
-        $this->rbY = $y;
-    }
-}