add type information to JSON renderer

keep information on whether an item is a class, interface or trait

Author: cebe

CHANGELOG.md

@@ -8,6 +8,7 @@ Yii Framework 2 apidoc extension Change Log
 - Enh #38: Fixed display of default values given as octal or hex notation (hiqsol)
 - Enh: Display TOC only if there is more than one headline (cebe)
 - Enh: Extracted markdown code highlighting to a trait `MarkdownHighlightTrait` (cebe)
+- Enh: Added "type" attribute to JSON renderer to keep information about whether an entry is a class, interface or trait (cebe)
 
 
 2.1.0 November 22, 2016

templates/json/ApiRenderer.php

@@ -7,7 +7,10 @@
 
 namespace yii\apidoc\templates\json;
 
+use yii\apidoc\models\ClassDoc;
 use yii\apidoc\models\Context;
+use yii\apidoc\models\InterfaceDoc;
+use yii\apidoc\models\TraitDoc;
 use yii\apidoc\renderers\ApiRenderer as BaseApiRenderer;
 use yii\base\ViewContextInterface;
 use Yii;
@@ -29,6 +32,16 @@ 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;
+            if ($type instanceof ClassDoc) {
+                $types[$name]['type'] = 'class';
+            } elseif ($type instanceof InterfaceDoc) {
+                $types[$name]['type'] = 'interface';
+            } elseif ($type instanceof TraitDoc) {
+                $types[$name]['type'] = 'trait';
+            }
+        }
         file_put_contents($targetDir . '/types.json', json_encode($types, JSON_PRETTY_PRINT));
     }