Improved handling of nested templates, and fix issue with frames that have a $ in their name (besides $parent)

Author: Numynum

src/Frame.php

@@ -39,7 +39,15 @@ public function getRootNode(): self
     public function getName(): string
     {
         if ($this->parent && str_contains($this->name, '$parent')) {
-            return str_replace('$parent', $this->parent->getName(), $this->name);
+            $parent = $this;
+            $parentName = '';
+            while ($parent = $parent->getParent()) {
+                $parentName = $parent->getName();
+                if ($parentName) {
+                    break;
+                }
+            }
+            return str_replace('$parent', $parentName, $this->name);
         }
 
         return $this->name;
@@ -53,7 +61,11 @@ public function getClassName(): ?string
             return null;
         }
 
-        return $prefix === '' ? $name : $prefix . '_' . $name;
+        return str_replace(
+            ['$', ' ', '-', '.'],
+            ['', '_', '_', '_'],
+            $prefix === '' ? $name : $prefix . '_' . $name,
+        );
     }
 
     public function getParent(): ?self

src/XmlFileParser.php

@@ -172,7 +172,7 @@ private function childHasInterestingData(Frame $child): bool
 
     private function writeFrame(Frame $frame, ?string $linkPrefix, ?string $typeOverride = null): string
     {
-        $shouldWriteGlobal = $frame->getName() && $frame->getRootNode()::class === Frame::class;
+        $shouldWriteGlobal = $frame->getRootNode()->getName() && $frame->getRootNode()::class === Frame::class;
         $data = '';
         $globalChildrenWithParentKey = [];
         $inheritedKeyValues = [];
@@ -185,31 +185,12 @@ private function writeFrame(Frame $frame, ?string $linkPrefix, ?string $typeOver
             }
         }
         if ($shouldWriteGlobal) {
-            foreach ($frame->getInherits() as $templateName) {
-                $template = $this->templateRegistry->get($templateName);
-                if (!$template) {
-                    continue;
-                }
-                foreach ($template->getKeyValues() as $key => $value) {
-                    $inheritedKeyValues[$key] = $value;
-                }
-                foreach ($template->getChildren() as $child) {
-                    $clone = $child->withParent($frame);
-                    if (!empty($clone->getName())) { // will create a global
-                        $data .= $this->writeFrame(
-                            $clone,
-                            $linkPrefix,
-                            // this must be $child rather than $clone
-                            $this->childHasInterestingData($child)
-                                ? $child->getClassName()
-                                : $child->getType(),
-                        );
-                        if ($clone->getParentKey()) {
-                            $inheritedKeyValues[$clone->getParentKey()] = [$clone->getName()];
-                        }
-                    }
-                }
-            }
+            $this->handleInherits(
+                $frame,
+                $inheritedKeyValues,
+                $linkPrefix,
+                $data
+            );
         }
 
         if ($linkPrefix) {
@@ -252,8 +233,12 @@ private function writeFrame(Frame $frame, ?string $linkPrefix, ?string $typeOver
                 }
             }
         }
-        if ($shouldWriteGlobal) {
-            $data .= $frame->getName() . " = {}\n";
+        if ($shouldWriteGlobal && $frame->getName()) {
+            $name = $frame->getName();
+            if (str_contains($name, '$')) {
+                $name = '_G["' . $name . '"]';
+            }
+            $data .= $name . " = {}\n";
             foreach ($globalChildrenWithParentKey as $key => $value) {
                 $data .= $frame->getName() . '["' . $key . '"] = ' . $value . "\n";
             }
@@ -267,4 +252,39 @@ private function writeFrame(Frame $frame, ?string $linkPrefix, ?string $typeOver
 
         return $data . "\n";
     }
+
+    private function handleInherits(Frame $frame, array &$inheritedKeyValues, ?string $linkPrefix, string &$data): void
+    {
+        foreach ($frame->getInherits() as $templateName) {
+            $template = $this->templateRegistry->get($templateName);
+            if (!$template) {
+                continue;
+            }
+            $template = $template->withParent($frame);
+            $this->handleInherits($template, $inheritedKeyValues, $linkPrefix, $data);
+            foreach ($template->getKeyValues() as $key => $value) {
+                $inheritedKeyValues[$key] = $value;
+            }
+            foreach ($template->getChildren() as $child) {
+                $clone = $child->withParent($frame);
+                if (!empty($clone->getName())) { // will create a global
+                    $data .= $this->writeFrame(
+                        $clone,
+                        $linkPrefix,
+                        // this must be $child rather than $clone
+                        $this->childHasInterestingData($child)
+                            ? $child->getClassName()
+                            : $child->getType(),
+                    );
+                    if ($clone->getParentKey()) {
+                        $name = $clone->getName();
+                        if (str_contains($name, '$')) {
+                            $name = '_G["' . $name . '"]';
+                        }
+                        $inheritedKeyValues[$clone->getParentKey()] = [$name];
+                    }
+                }
+            }
+        }
+    }
 }