DOMElement -> DOMNode, few cleanup items

dcarbone · Apr 25, 2024 · 0b72b94 · 0b72b94
1 parent 0fa01f6
commit 0b72b94
Show file tree

Hide file tree

Showing 8 changed files with 58 additions and 42 deletions.
diff --git a/template/core/interfaces/interface_xml_serializable.php b/template/core/interfaces/interface_xml_serializable.php
@@ -66,18 +66,18 @@ public function _setFHIRXMLNamespace(string $xmlNamespace): self;
     public function _getFHIRXMLElementDefinition(string $elementName): string;
 
     /**
-     * @param null|string|\DOMElement $element
+     * @param null|string|\DOMNode $element
      * @param null|static $type
      * @param null|int|\<?php echo ('' === $namespace ? '' : "{$namespace}\\") . PHPFHIR_INTERFACE_XML_SERIALIZALE_CONFIG; ?> $config XML serialization config.  Supports an integer value interpreted as libxml opts for backwards compatibility.
      * @return null|static
      */
-    public static function xmlUnserialize(null|string|\DOMElement $element, <?php echo PHPFHIR_INTERFACE_XML_SERIALIZABLE; ?> $type = null, null|int|<?php echo PHPFHIR_INTERFACE_XML_SERIALIZALE_CONFIG ?> $config = null): null|self;
+    public static function xmlUnserialize(null|string|\DOMNode $element, <?php echo PHPFHIR_INTERFACE_XML_SERIALIZABLE; ?> $type = null, null|int|<?php echo PHPFHIR_INTERFACE_XML_SERIALIZALE_CONFIG ?> $config = null): null|self;
 
     /**
-     * @param null|\DOMElement $element
+     * @param null|\DOMNode $element
      * @param null|int|\<?php echo ('' === $namespace ? '' : "{$namespace}\\") . PHPFHIR_INTERFACE_XML_SERIALIZALE_CONFIG; ?> $config XML serialization config.  Supports an integer value interpreted as libxml opts for backwards compatibility.
-     * @return \DOMElement
+     * @return \DOMNode
      */
-    public function xmlSerialize(null|\DOMElement $element = null, null|int|<?php echo PHPFHIR_INTERFACE_XML_SERIALIZALE_CONFIG ?> $config = null): \DOMElement;
+    public function xmlSerialize(null|\DOMNode $element = null, null|int|<?php echo PHPFHIR_INTERFACE_XML_SERIALIZALE_CONFIG ?> $config = null): \DOMNode;
 }
 <?php return ob_get_clean();
diff --git a/template/types/class_xhtml.php b/template/types/class_xhtml.php
@@ -57,6 +57,8 @@ class <?php echo $type->getClassName(); ?> implements <?php echo PHPFHIR_INTERFA
     use <?php echo PHPFHIR_TRAIT_CHANGE_TRACKING; ?>,
         <?php echo PHPFHIR_TRAIT_XMLNS; ?>;
 
+    const _NOISE_NODES = ['html', 'head', 'body'];
+
     /** @var null|\DOMNode */
     private null|\DOMNode $_node = null;
 
@@ -97,7 +99,14 @@ public function setNode(null|string|\DOMNode $node): self
             $dom->appendChild($dom->importNode($node, true));
         }
         $newNode = $dom->documentElement;
-        if ('' !== ($ens = (string)$newNode->namespaceURI)) {
+        while (null !== $newNode) {
+            if (in_array(strtolower($newNode->nodeName), self::_NOISE_NODES, true)) {
+                $newNode = $newNode->firstChild;
+            } else {
+                break;
+            }
+        }
+        if ('' !== ($ens = (string)$newNode?->namespaceURI)) {
             $this->_setFHIRXMLNamespace($ens);
         }
         $this->_trackValueSet($this->_node, $newNode);
@@ -123,11 +132,11 @@ public function setNode(null|string|\DOMNode $node): self
     }
 
     /**
-     * @param \DOMElement|null $element
+     * @param \DOMNode|null $element
      * @param null|int|\<?php echo ('' === $namespace ? '' : "{$namespace}\\") . PHPFHIR_INTERFACE_XML_SERIALIZALE_CONFIG; ?> $config XML serialization config.  Supports an integer value interpreted as libxml opts for backwards compatibility.
-     * @return \DOMElement
+     * @return \DOMNode
      */
-    public function xmlSerialize(\DOMElement $element = null, null|int|<?php echo PHPFHIR_INTERFACE_XML_SERIALIZALE_CONFIG ?> $config = null): \DOMElement
+    public function xmlSerialize(\DOMNode $element = null, null|int|<?php echo PHPFHIR_INTERFACE_XML_SERIALIZALE_CONFIG ?> $config = null): \DOMNode
     {
         if (is_int($config)) {
             $libxmlOpts = $config;
@@ -139,6 +148,8 @@ public function xmlSerialize(\DOMElement $element = null, null|int|<?php echo PH
             $dom = new \DOMDocument();
             $dom->loadXML($this->_getFHIRXMLElementDefinition('<?php echo $xmlName; ?>'), $libxmlOpts);
             $element = $dom->documentElement;
+        } else if ('' !== ($ns = $this->_getFHIRXMLNamespace())) {
+            $element->setAttribute('xmlns', $ns);
         }
         $node = $this->getNode();
         if (null === $node) {

diff --git a/template/types/serialization/xml/serialize/header.php b/template/types/serialization/xml/serialize/header.php
@@ -29,14 +29,14 @@
 
 ob_start(); ?>
     /**
-     * @param null|\DOMElement $element
+     * @param null|\DOMNode $element
      * @param null|int|\<?php echo ('' === $namespace ? '' : "{$namespace}\\") . PHPFHIR_INTERFACE_XML_SERIALIZALE_CONFIG; ?> $config XML serialization config.  Supports an integer value interpreted as libxml opts for backwards compatibility.
-     * @return \DOMElement<?php if ($typeKind !== TypeKind::PRIMITIVE) : ?>
+     * @return \DOMNode<?php if ($typeKind !== TypeKind::PRIMITIVE) : ?>
 
      * @throws \DOMException<?php endif; ?>
 
      */
-    public function xmlSerialize(\DOMElement $element = null, null|int|<?php echo PHPFHIR_INTERFACE_XML_SERIALIZALE_CONFIG ?> $config = null): \DOMElement
+    public function xmlSerialize(\DOMNode $element = null, null|int|<?php echo PHPFHIR_INTERFACE_XML_SERIALIZALE_CONFIG ?> $config = null): \DOMNode
     {
         if (is_int($config)) {
             $libxmlOpts = $config;

diff --git a/template/types/serialization/xml/serialize/resource_container.php b/template/types/serialization/xml/serialize/resource_container.php
@@ -26,11 +26,11 @@
 
 ob_start(); ?>
     /**
-     * @param null|\DOMElement $element
+     * @param null|\DOMNode $element
      * @param null|int|\<?php echo ('' === $namespace ? '' : "{$namespace}\\") . PHPFHIR_INTERFACE_XML_SERIALIZALE_CONFIG; ?> $config XML serialization config.  Supports an integer value interpreted as libxml opts for backwards compatibility.
-     * @return \DOMElement
+     * @return \DOMNode
      */
-    public function xmlSerialize(null|\DOMElement $element = null, null|int|<?php echo PHPFHIR_INTERFACE_XML_SERIALIZALE_CONFIG ?> $config = null): \DOMElement
+    public function xmlSerialize(null|\DOMNode $element = null, null|int|<?php echo PHPFHIR_INTERFACE_XML_SERIALIZALE_CONFIG ?> $config = null): \DOMNode
     {
         if (is_int($config)) {
             $libxmlOpts = $config;

diff --git a/template/types/serialization/xml/unserialize/header.php b/template/types/serialization/xml/unserialize/header.php
@@ -27,13 +27,13 @@
 
 ob_start(); ?>
     /**
-     * @param null|string|\DOMElement $element
+     * @param null|string|\DOMNode $element
      * @param null|<?php echo $type->getFullyQualifiedClassName(true); ?> $type
      * @param null|int|\<?php echo ('' === $namespace ? '' : "{$namespace}\\") . PHPFHIR_INTERFACE_XML_SERIALIZALE_CONFIG; ?> $config XML serialization config.  Supports an integer value interpreted as libxml opts for backwards compatibility.
      * @return null|<?php echo $type->getFullyQualifiedClassName(true); ?>
 
      */
-    public static function xmlUnserialize(null|string|\DOMElement $element, null|<?php echo PHPFHIR_INTERFACE_XML_SERIALIZABLE; ?> $type = null, null|int|<?php echo PHPFHIR_INTERFACE_XML_SERIALIZALE_CONFIG ?> $config = null): null|self
+    public static function xmlUnserialize(null|string|\DOMNode $element, null|<?php echo PHPFHIR_INTERFACE_XML_SERIALIZABLE; ?> $type = null, null|int|<?php echo PHPFHIR_INTERFACE_XML_SERIALIZALE_CONFIG ?> $config = null): null|self
     {
         if (null === $element) {
             return null;
@@ -58,7 +58,8 @@ public static function xmlUnserialize(null|string|\DOMElement $element, null|<?p
             throw new \RuntimeException('<?php echo $typeClassName; ?>::xmlUnserialize: Cannot unserialize directly into root type');
         } else if (!($type instanceof <?php echo $typeClassName; ?>)) {
             throw new \RuntimeException(sprintf(
-                '<?php echo $typeClassName; ?>::xmlUnserialize - $type must be child instance of <?php echo $type->getFullyQualifiedClassName(true); ?> or null, %s seen.',
+                '<?php echo $typeClassName; ?>::xmlUnserialize - $type must be child instance of %s or null, %s seen.',
+                static::class,
                 get_class($type)
             ));
         }
@@ -67,7 +68,8 @@ public static function xmlUnserialize(null|string|\DOMElement $element, null|<?p
             $type = new <?php echo $typeClassName; ?>(null);
         } else if (!($type instanceof <?php echo $typeClassName; ?>)) {
             throw new \RuntimeException(sprintf(
-                '<?php echo $typeClassName; ?>::xmlUnserialize - $type must be instance of <?php echo $type->getFullyQualifiedClassName(true); ?> or null, %s seen.',
+                '<?php echo $typeClassName; ?>::xmlUnserialize - $type must be instance of %s or null, %s seen.',
+                static::class,
                 get_class($type)
             ));
         }

diff --git a/template/types/tests/integration/body_domain_resource.php b/template/types/tests/integration/body_domain_resource.php
@@ -139,7 +139,7 @@ public function testXML(): void
                 $e
             );
         }
-        $this->assertInstanceOf('<?php echo $bundleType->getFullyQualifiedClassName(true); ?>', $bundle);
+        $this->assertInstanceOf(<?php echo $bundleType->getClassName(); ?>::class, $bundle);
         $entry = $bundle->getEntry();
 <?php if ($bundleEntryProperty->isCollection()) : ?>
         if (0 === count($entry)) {
@@ -172,7 +172,7 @@ public function testXML(): void
                 $e
             );
         }
-        $this->assertInstanceOf('<?php echo $type->getFullyQualifiedClassName(true); ?>', $type);
+        $this->assertInstanceOf(<?php echo $type->getClassName(); ?>::class, $type);
         $typeElement = $type->xmlSerialize();
         $this->assertEquals($resourceXML, $typeElement->ownerDocument->saveXML($typeElement));
         $bundleElement = $bundle->xmlSerialize();

diff --git a/template/types/tests/integration/class_default.php b/template/types/tests/integration/class_default.php
@@ -54,7 +54,7 @@
 
 ob_start();
 
-if ($type->isDomainResource()) :
+if ($type->isDomainResource()) {
     echo require_with(
         PHPFHIR_TEMPLATE_TYPE_TESTS_DIR . DIRECTORY_SEPARATOR . $testType . DIRECTORY_SEPARATOR . 'header_domain_resource.php',
         [
@@ -73,7 +73,7 @@
             'bundleEntryProperty' => $bundleEntryProperty,
         ]
     );
-endif;
+}
 
 echo "}\n";
 return ob_get_clean();
diff --git a/template/types/validation/methods.php b/template/types/validation/methods.php
@@ -19,6 +19,8 @@
 /** @var \DCarbone\PHPFHIR\Config\VersionConfig $config */
 /** @var \DCarbone\PHPFHIR\Definition\Type $type */
 
+use DCarbone\PHPFHIR\Enum\TypeKind;
+
 $typeNameConst = $type->getTypeNameConst(true);
 $typeKind = $type->getKind();
 
@@ -54,34 +56,35 @@ public function _getValidationErrors(): array
         $errs = [];
 <?php endif; ?>
         $validationRules = $this->_getValidationRules();
-<?php foreach ($type->getLocalProperties()->localPropertiesIterator() as $property) :
+<?php foreach ($type->getLocalProperties()->localPropertiesIterator() as $property) {
     $propertyType = $property->getValueFHIRType();
-    if (null === $propertyType) :
-        if ($property->isCollection()) :
+    if (null === $propertyType) {
+        if ($property->isCollection()) {
             echo require_with(
                 PHPFHIR_TEMPLATE_TYPES_VALIDATION_DIR . DIRECTORY_SEPARATOR . 'methods' . DIRECTORY_SEPARATOR . 'collection_typed.php',
                 $requireArgs + ['property' => $property]
             );
-        else :
+        } else {
             echo require_with(
                 PHPFHIR_TEMPLATE_TYPES_VALIDATION_DIR . DIRECTORY_SEPARATOR . 'methods' . DIRECTORY_SEPARATOR . 'primitive.php',
                 $requireArgs + ['property' => $property]
             );
-        endif;
-    else :
-        if ($property->isCollection()) :
-            echo require_with(
-                PHPFHIR_TEMPLATE_TYPES_VALIDATION_DIR . DIRECTORY_SEPARATOR . 'methods' . DIRECTORY_SEPARATOR . 'collection_typed.php',
-                $requireArgs + ['property' => $property]
-            );
-        else :
-            echo require_with(
-                PHPFHIR_TEMPLATE_TYPES_VALIDATION_DIR . DIRECTORY_SEPARATOR . 'methods' . DIRECTORY_SEPARATOR . 'typed.php',
-                $requireArgs + ['property' => $property]
-            );
-        endif;
-    endif;
-endforeach;
+        }
+    } else if ($propertyType->getKind() === TypeKind::PHPFHIR_XHTML) {
+        // TODO(@dcarbone): better way to omit validation
+        continue;
+    } else if ($property->isCollection()) {
+        echo require_with(
+            PHPFHIR_TEMPLATE_TYPES_VALIDATION_DIR . DIRECTORY_SEPARATOR . 'methods' . DIRECTORY_SEPARATOR . 'collection_typed.php',
+            $requireArgs + ['property' => $property]
+        );
+    } else {
+        echo require_with(
+            PHPFHIR_TEMPLATE_TYPES_VALIDATION_DIR . DIRECTORY_SEPARATOR . 'methods' . DIRECTORY_SEPARATOR . 'typed.php',
+            $requireArgs + ['property' => $property]
+        );
+    }
+}
 if (null !== $type->getParentType()) :
     $ptype = $type;
     while (null !== $ptype) :