xmlns improvements, template file hierarchy improvements

dcarbone · Apr 22, 2024 · 5dfdc26 · 5dfdc26
1 parent 0070f93
commit 5dfdc26
Show file tree

Hide file tree

Showing 18 changed files with 36 additions and 23 deletions.
diff --git a/files/constants.php b/files/constants.php
@@ -59,10 +59,15 @@
 const PHPFHIR_DOCBLOC_MAX_LENGTH = 80;
 const PHPFHIR_NAMESPACE_TRIM_CUTSET = " \t\n\r\0\x0b\\/";
 define('PHPFHIR_TEMPLATE_DIR', realpath(__DIR__ . DIRECTORY_SEPARATOR . '..' . DIRECTORY_SEPARATOR . 'template'));
-const PHPFHIR_TEMPLATE_INTERFACES_DIR = PHPFHIR_TEMPLATE_DIR . DIRECTORY_SEPARATOR . 'interfaces';
-const PHPFHIR_TEMPLATE_TRAITS_DIR = PHPFHIR_TEMPLATE_DIR . DIRECTORY_SEPARATOR . 'traits';
+
+// "file" directory.  will move at some point.
 const PHPFHIR_TEMPLATE_FILE_DIR = PHPFHIR_TEMPLATE_DIR . DIRECTORY_SEPARATOR . 'file';
-const PHPFHIR_TEMPLATE_UTILITIES_DIR = PHPFHIR_TEMPLATE_DIR . DIRECTORY_SEPARATOR . 'utilities';
+
+// Core interfaces, traits, and classes
+const PHPFHIR_TEMPLATE_CORE_DIR = PHPFHIR_TEMPLATE_DIR . DIRECTORY_SEPARATOR . 'core';
+const PHPFHIR_TEMPLATE_CORE_INTERFACES_DIR = PHPFHIR_TEMPLATE_CORE_DIR . DIRECTORY_SEPARATOR . 'interfaces';
+const PHPFHIR_TEMPLATE_CORE_TRAITS_DIR = PHPFHIR_TEMPLATE_CORE_DIR . DIRECTORY_SEPARATOR . 'traits';
+const PHPFHIR_TEMPLATE_CORE_CLASSES_DIR = PHPFHIR_TEMPLATE_CORE_DIR . DIRECTORY_SEPARATOR . 'classes';
 
 // Type rendering
 const PHPFHIR_TEMPLATE_TYPES_DIR = PHPFHIR_TEMPLATE_DIR . DIRECTORY_SEPARATOR . 'types';

diff --git a/files/funcs.php b/files/funcs.php
@@ -1,7 +1,7 @@
-<?php
+<?php declare(strict_types=1);
 
 /*
- * Copyright 2016-2022 Daniel Carbone ([email protected])
+ * Copyright 2016-2024 Daniel Carbone ([email protected])
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -25,7 +25,7 @@
  * @param array $vars
  * @return mixed
  */
-function require_with(string $requiredFile, array $vars)
+function require_with(string $requiredFile, array $vars): mixed
 {
     $num = extract($vars, EXTR_OVERWRITE);
     if ($num !== count($vars)) {

diff --git a/src/Render/Templates.php b/src/Render/Templates.php
@@ -35,7 +35,7 @@ abstract class Templates
      */
     public static function renderPhpFhirTypeInterface(VersionConfig $config, Types $types): string
     {
-        return require PHPFHIR_TEMPLATE_INTERFACES_DIR . DIRECTORY_SEPARATOR . 'phpfhir_type.php';
+        return require PHPFHIR_TEMPLATE_CORE_INTERFACES_DIR . DIRECTORY_SEPARATOR . 'interface_type.php';
     }
 
     /**
@@ -45,7 +45,7 @@ public static function renderPhpFhirTypeInterface(VersionConfig $config, Types $
      */
     public static function renderPhpFhirXmlSerializableInterface(VersionConfig $config, Types $types): string
     {
-        return require PHPFHIR_TEMPLATE_INTERFACES_DIR . DIRECTORY_SEPARATOR . 'phpfhir_xml_serializable.php';
+        return require PHPFHIR_TEMPLATE_CORE_INTERFACES_DIR . DIRECTORY_SEPARATOR . 'interface_xml_serializable.php';
     }
 
     /**
@@ -55,7 +55,7 @@ public static function renderPhpFhirXmlSerializableInterface(VersionConfig $conf
      */
     public static function renderPhpFhirCommentContainerInterface(VersionConfig $config, Types $types): string
     {
-        return require PHPFHIR_TEMPLATE_INTERFACES_DIR . DIRECTORY_SEPARATOR .'phpfhir_comment_container.php';
+        return require PHPFHIR_TEMPLATE_CORE_INTERFACES_DIR . DIRECTORY_SEPARATOR .'interface_comment_container.php';
     }
 
     /**
@@ -65,7 +65,7 @@ public static function renderPhpFhirCommentContainerInterface(VersionConfig $con
      */
     public static function renderPhpFhirCommentContainerTrait(VersionConfig $config, Types $types): string
     {
-        return require PHPFHIR_TEMPLATE_TRAITS_DIR . DIRECTORY_SEPARATOR . 'phpfhir_comment_container.php';
+        return require PHPFHIR_TEMPLATE_CORE_TRAITS_DIR . DIRECTORY_SEPARATOR . 'trait_comment_container.php';
     }
 
     /**
@@ -75,7 +75,7 @@ public static function renderPhpFhirCommentContainerTrait(VersionConfig $config,
      */
     public static function renderPhpFhirValidationAssertionsTrait(VersionConfig $config, Types $types): string
     {
-        return require PHPFHIR_TEMPLATE_TRAITS_DIR . DIRECTORY_SEPARATOR .'phpfhir_validation_assertions.php';
+        return require PHPFHIR_TEMPLATE_CORE_TRAITS_DIR . DIRECTORY_SEPARATOR .'trait_validation_assertions.php';
     }
 
     /**
@@ -85,12 +85,12 @@ public static function renderPhpFhirValidationAssertionsTrait(VersionConfig $con
      */
     public static function renderPhpFhirChangeTrackingTrait(VersionConfig $config, Types $types): string
     {
-        return require PHPFHIR_TEMPLATE_TRAITS_DIR . DIRECTORY_SEPARATOR . 'phpfhir_change_tracking.php';
+        return require PHPFHIR_TEMPLATE_CORE_TRAITS_DIR . DIRECTORY_SEPARATOR . 'trait_change_tracking.php';
     }
 
     public static function renderPhpFhirXhtmlNamespaceTrait(VersionConfig $config, Types $types): string
     {
-        return require PHPFHIR_TEMPLATE_TRAITS_DIR . DIRECTORY_SEPARATOR . 'phpfhir_xml_namespace.php';
+        return require PHPFHIR_TEMPLATE_CORE_TRAITS_DIR . DIRECTORY_SEPARATOR . 'trait_xml_namespace.php';
     }
 
     /**
@@ -100,7 +100,7 @@ public static function renderPhpFhirXhtmlNamespaceTrait(VersionConfig $config, T
      */
     public static function renderPhpFhirContainedTypeInterface(VersionConfig $config, Types $types): string
     {
-        return require PHPFHIR_TEMPLATE_INTERFACES_DIR . DIRECTORY_SEPARATOR . 'phpfhir_contained_type.php';
+        return require PHPFHIR_TEMPLATE_CORE_INTERFACES_DIR . DIRECTORY_SEPARATOR . 'interface_contained_type.php';
     }
 
     /**
@@ -110,7 +110,7 @@ public static function renderPhpFhirContainedTypeInterface(VersionConfig $config
      */
     public static function renderPhpFhirResponseParserConfigClass(VersionConfig $config, Types $types): string
     {
-        return require PHPFHIR_TEMPLATE_UTILITIES_DIR . DIRECTORY_SEPARATOR .'class_response_parser_config.php';
+        return require PHPFHIR_TEMPLATE_CORE_CLASSES_DIR . DIRECTORY_SEPARATOR .'class_response_parser_config.php';
     }
 
     /**
@@ -120,7 +120,7 @@ public static function renderPhpFhirResponseParserConfigClass(VersionConfig $con
      */
     public static function renderPhpFhirResponseParserClass(VersionConfig $config, Types $types): string
     {
-        return require PHPFHIR_TEMPLATE_UTILITIES_DIR . DIRECTORY_SEPARATOR .'class_response_parser.php';
+        return require PHPFHIR_TEMPLATE_CORE_CLASSES_DIR . DIRECTORY_SEPARATOR .'class_response_parser.php';
     }
 
     /**
@@ -152,7 +152,7 @@ public static function renderXhtmlTypeClass(VersionConfig $config, Types $types,
      */
     public static function renderConstants(VersionConfig $config, Types $types): string
     {
-        return require PHPFHIR_TEMPLATE_UTILITIES_DIR . DIRECTORY_SEPARATOR .'class_constants.php';
+        return require PHPFHIR_TEMPLATE_CORE_CLASSES_DIR . DIRECTORY_SEPARATOR .'class_constants.php';
     }
 
     /**
@@ -162,7 +162,7 @@ public static function renderConstants(VersionConfig $config, Types $types): str
      */
     public static function renderTypeMapClass(VersionConfig $config, Types $types): string
     {
-        return require PHPFHIR_TEMPLATE_UTILITIES_DIR . DIRECTORY_SEPARATOR . 'class_typemap.php';
+        return require PHPFHIR_TEMPLATE_CORE_CLASSES_DIR . DIRECTORY_SEPARATOR . 'class_typemap.php';
     }
 
     /**
@@ -172,7 +172,7 @@ public static function renderTypeMapClass(VersionConfig $config, Types $types):
      */
     public static function renderAutoloaderClass(VersionConfig $config, Types $types): string
     {
-        return require PHPFHIR_TEMPLATE_UTILITIES_DIR . DIRECTORY_SEPARATOR . 'class_autoloader.php';
+        return require PHPFHIR_TEMPLATE_CORE_CLASSES_DIR . DIRECTORY_SEPARATOR . 'class_autoloader.php';
     }
 
     /**

diff --git a/template/utilities/class_autoloader.php → template/core/classes/class_autoloader.php b/template/utilities/class_autoloader.php → template/core/classes/class_autoloader.php
@@ -48,6 +48,9 @@
 if (!interface_exists('\<?php echo $nsPrefix . PHPFHIR_INTERFACE_COMMENT_CONTAINER; ?>', false)) {
     require __DIR__ . DIRECTORY_SEPARATOR . '<?php echo PHPFHIR_INTERFACE_COMMENT_CONTAINER; ?>.php';
 }
+if (!interface_exists('\<?php echo $nsPrefix . PHPFHIR_INTERFACE_XML_SERIALIZABLE; ?>', false)) {
+    require __DIR__ . DIRECTORY_SEPARATOR . '<?php echo PHPFHIR_INTERFACE_XML_SERIALIZABLE; ?>.php';
+}
 
 // traits
 if (!trait_exists('\<?php echo $nsPrefix . PHPFHIR_TRAIT_COMMENT_CONTAINER; ?>', false)) {

diff --git a/template/utilities/class_constants.php → template/core/classes/class_constants.php b/template/utilities/class_constants.php → template/core/classes/class_constants.php
diff --git a/template/utilities/class_response_parser.php → ...te/core/classes/class_response_parser.php b/template/utilities/class_response_parser.php → ...te/core/classes/class_response_parser.php
diff --git a/...tilities/class_response_parser_config.php → .../classes/class_response_parser_config.php b/...tilities/class_response_parser_config.php → .../classes/class_response_parser_config.php
diff --git a/template/utilities/class_typemap.php → template/core/classes/class_typemap.php b/template/utilities/class_typemap.php → template/core/classes/class_typemap.php
diff --git a/.../interfaces/phpfhir_comment_container.php → ...nterfaces/interface_comment_container.php b/.../interfaces/phpfhir_comment_container.php → ...nterfaces/interface_comment_container.php
diff --git a/...ate/interfaces/phpfhir_contained_type.php → ...e/interfaces/interface_contained_type.php b/...ate/interfaces/phpfhir_contained_type.php → ...e/interfaces/interface_contained_type.php
diff --git a/template/interfaces/phpfhir_type.php → template/core/interfaces/interface_type.php b/template/interfaces/phpfhir_type.php → template/core/interfaces/interface_type.php
diff --git a/...e/interfaces/phpfhir_xml_serializable.php → ...interfaces/interface_xml_serializable.php b/...e/interfaces/phpfhir_xml_serializable.php → ...interfaces/interface_xml_serializable.php
diff --git a/template/traits/phpfhir_change_tracking.php → ...ate/core/traits/trait_change_tracking.php b/template/traits/phpfhir_change_tracking.php → ...ate/core/traits/trait_change_tracking.php
diff --git a/...late/traits/phpfhir_comment_container.php → ...e/core/traits/trait_comment_container.php b/...late/traits/phpfhir_comment_container.php → ...e/core/traits/trait_comment_container.php
diff --git a/.../traits/phpfhir_validation_assertions.php → ...re/traits/trait_validation_assertions.php b/.../traits/phpfhir_validation_assertions.php → ...re/traits/trait_validation_assertions.php
diff --git a/template/traits/phpfhir_xml_namespace.php → template/core/traits/trait_xml_namespace.php b/template/traits/phpfhir_xml_namespace.php → template/core/traits/trait_xml_namespace.php
@@ -40,15 +40,15 @@
 <?php endif; ?>
 
     */
-    trait <?php echo PHPFHIR_TRAIT_XMLNS; ?>
+trait <?php echo PHPFHIR_TRAIT_XMLNS; ?>
 
 {
     /** @var string */
     protected string $_xmlns = '';
 
     /**
      * @param null|string $xmlNamespace
-     * @return self
+     * @return static
      */
     public function _setFHIRXMLNamespace(null|string $xmlNamespace): self
     {
@@ -65,10 +65,15 @@ public function _getFHIRXMLNamespace(): string
     }
 
     /**
+     * @param string $elementName Name to use for the element
      * @return string
+     * @throws \InvalidArgumentException
      */
     public function _getFHIRXMLElementDefinition(string $elementName): string
     {
+        if ('' === $elementName) {
+            throw new \InvalidArgumentException(sprintf('%s::_getFHIRXMLElementDefinition - $elementName is required', get_called_class()));
+        }
         $xmlns = $this->_getFHIRXMLNamespace();
         if ('' !==  $xmlns) {
             $xmlns = sprintf(' xmlns="%s"', $xmlns);

diff --git a/template/file/header_type.php b/template/file/header_type.php
@@ -34,7 +34,7 @@
 echo "<?php declare(strict_types=1);\n\n";
 
 if ('' !== $namespace) {
-    echo "namespace {$namespace};\n\n";
+    echo sprintf("namespace %s;\n\n", $namespace);
 }
 
 // print out huge copyright block

diff --git a/template/types/serialization/xml/unserialize/header.php b/template/types/serialization/xml/unserialize/header.php
@@ -65,7 +65,7 @@ public static function xmlUnserialize(null|string|\DOMElement $element, null|<?p
             ));
         }
 <?php endif; ?>
-        if ('' === $type->_getFHIRXMLNamespace() && (null === $element->parentNode || $element->namespaceURI !== $element->parentNode->namespaceURI)) {
+        if ('' === $type->_getFHIRXMLNamespace() && $element->namespaceURI) {
             $type->_setFHIRXMLNamespace($element->namespaceURI);
         }
 <?php return ob_get_clean();