[Fix] Tree PathHash field implementation in the Xml Driver of Tree

Author: Alexandre Blond

CHANGELOG.md

@@ -20,6 +20,7 @@ a release.
 
 ## [Unreleased]
 ### Fixed
+- Tree: Missing support for `tree-path-hash` fields in XML mapping.
 - Tree: Check for affected rows at `ClosureTreeRepository::cleanUpClosure()` and `Closure::updateNode()`.
 - `Gedmo\Mapping\Driver\Xml::_loadMappingFile()` behavior in scenarios where `libxml_disable_entity_loader(true)` was previously
   called.

schemas/orm/doctrine-extensions-mapping-2-2.xsd

@@ -43,6 +43,7 @@
   <xs:element name="tree-parent" type="gedmo:emptyType"/>
   <xs:element name="tree-path-source" type="gedmo:emptyType"/>
   <xs:element name="tree-lock-time" type="gedmo:emptyType"/>
+  <xs:element name="tree-path-hash" type="gedmo:emptyType"/>
   <xs:element name="sortable-group" type="gedmo:emptyType"/>
   <xs:element name="sortable-position" type="gedmo:emptyType"/>
   <xs:element name="uploadable-file-mime-type" type="gedmo:emptyType"/>

src/Tree/Mapping/Driver/Xml.php

@@ -139,6 +139,11 @@ public function readExtendedMetadata($meta, array &$config)
                         throw new InvalidMappingException("Tree PathSource field - [{$field}] type is not valid. It can be any of the integer variants, double, float or string in class - {$meta->name}");
                     }
                     $config['path_source'] = $field;
+                } elseif (isset($mapping->{'tree-path-hash'})) {
+                    if (!$validator->isValidFieldForPathSource($meta, $field)) {
+                        throw new InvalidMappingException("Tree PathHash field - [{$field}] type is not valid and must be 'string' in class - {$meta->name}");
+                    }
+                    $config['path_hash'] = $field;
                 } elseif (isset($mapping->{'tree-lock-time'})) {
                     if (!$validator->isValidFieldForLockTime($meta, $field)) {
                         throw new InvalidMappingException("Tree LockTime field - [{$field}] type is not valid. It must be \"date\" in class - {$meta->name}");

tests/Gedmo/Mapping/Driver/Xml/Gedmo.Tests.Mapping.Fixture.Xml.MaterializedPathTree.dcm.xml

@@ -19,6 +19,9 @@
         <field name="lockTime" type="datetime">
             <gedmo:tree-lock-time/>
         </field>
+        <field name="pathHash" type="string" nullable="true">
+            <gedmo:tree-path-hash/>
+        </field>
         <many-to-one field="parent" target-entity="MaterializedPathTree">
             <join-column name="parent_id" referenced-column-name="id" on-delete="CASCADE"/>
             <gedmo:tree-parent/>

tests/Gedmo/Mapping/Fixture/Xml/MaterializedPathTree.php

@@ -12,6 +12,8 @@ class MaterializedPathTree
 
     private $lockTime;
 
+    private $pathHash;
+
     private $parent;
 
     private $level;

tests/Gedmo/Mapping/Xml/MaterializedPathTreeMappingTest.php

@@ -77,5 +77,7 @@ public function testTreeMetadata()
         static::assertEquals('path', $config['path']);
         static::assertArrayHasKey('lock_time', $config);
         static::assertEquals('lockTime', $config['lock_time']);
+        static::assertArrayHasKey('path_hash', $config);
+        static::assertEquals('pathHash', $config['path_hash']);
     }
 }