Fix types.json generation

Author: mspirkov

templates/json/ApiRenderer.php

@@ -1,4 +1,5 @@
 <?php
+
 /**
  * @link https://www.yiiframework.com/
  * @copyright Copyright (c) 2008 Yii Software LLC
@@ -13,7 +14,6 @@
 use yii\apidoc\models\TraitDoc;
 use yii\apidoc\renderers\ApiRenderer as BaseApiRenderer;
 use yii\base\ViewContextInterface;
-use Yii;
 
 /**
  * The class for outputting documentation data structures as a JSON text.
@@ -32,8 +32,8 @@ class ApiRenderer extends BaseApiRenderer implements ViewContextInterface
     public function render($context, $targetDir)
     {
         $types = array_merge($context->classes, $context->interfaces, $context->traits);
-        foreach($types as $name => $type) {
-            $types[$name] = (array) $type;
+        foreach ($types as $name => $type) {
+            $types[$name] = (array) $this->removeParentFieldsRecursive($type);
             if ($type instanceof ClassDoc) {
                 $types[$name]['type'] = 'class';
             } elseif ($type instanceof InterfaceDoc) {
@@ -42,7 +42,41 @@ public function render($context, $targetDir)
                 $types[$name]['type'] = 'trait';
             }
         }
-        file_put_contents($targetDir . '/types.json', json_encode($types, JSON_PRETTY_PRINT));
+        file_put_contents($targetDir . '/types.json', json_encode($types, JSON_PRETTY_PRINT | JSON_THROW_ON_ERROR));
+    }
+
+    /**
+     * Removes the `parent` fields recursively so that the data could be converted to JSON format..
+     * @param array|object $data
+     * @return array|object
+     */
+    private function removeParentFieldsRecursive($data)
+    {
+        if (!is_array($data) && !is_object($data)) {
+            return $data;
+        }
+
+        if (is_array($data)) {
+            foreach ($data as $key => $value) {
+                if ($key === 'parent') {
+                    unset($data[$key]);
+                } elseif (is_object($value) || is_array($value)) {
+                    $data[$key] = $this->removeParentFieldsRecursive($value);
+                }
+            }
+
+            return $data;
+        }
+
+        foreach (get_object_vars($data) as $key => $value) {
+            if ($key === 'parent') {
+                unset($data->$key);
+            } elseif (is_object($value) || is_array($value)) {
+                $data->$key = $this->removeParentFieldsRecursive($value);
+            }
+        }
+
+        return $data;
     }
 
     /**

tests/commands/ApiControllerTest.php

@@ -56,15 +56,15 @@ protected function generateApi($sourceDirs, $targetDir = '@runtime', array $args
 
     // Tests :
 
-    public function testNoFiles()
+    public function testNoFiles(): void
     {
         $output = $this->generateApi(Yii::getAlias('@yiiunit/apidoc/data/guide'));
 
         $this->assertNotEmpty($output);
         $this->assertStringContainsString('Error: No files found to process', $output);
     }
 
-    public function testGenerateBootstrap()
+    public function testGenerateBootstrap(): void
     {
         $sourceFilesDir = Yii::getAlias('@yiiunit/apidoc/data/api');
         $output = $this->generateApi($sourceFilesDir, '@runtime', ['template' => 'bootstrap']);
@@ -111,4 +111,15 @@ public function testGenerateBootstrap()
         $errorsContent = preg_replace('/(\s*\[file\] => ).*(\/tests\/.*\.php)/', '$1$2', $errorsContent);
         $this->assertMatchesTextSnapshot($errorsContent);
     }
+
+    public function testGenerateJson(): void
+    {
+        $sourceFilesDir = Yii::getAlias('@yiiunit/apidoc/data/api');
+        $output = $this->generateApi($sourceFilesDir, '@runtime', ['template' => 'json']);
+
+        $this->assertNotEmpty($output);
+        $this->assertStringContainsString('Updating cross references and backlinks... done.', $output);
+
+        $this->assertMatchesJsonSnapshot(file_get_contents(Yii::getAlias('@runtime') . '/types.json'));
+    }
 }