Merge pull request #875 from ApiGen/menu-list-feature

[Generator] add reflection lists
ApiGen · Jun 5, 2017 · a2f6889 · a2f6889
2 parents f4a3f44 + 9c67857
commit a2f6889
Show file tree

Hide file tree

Showing 53 changed files with 795 additions and 424 deletions.
diff --git a/packages/Annotation/src/AnnotationDecorator.php b/packages/Annotation/src/AnnotationDecorator.php
@@ -6,8 +6,9 @@
 use ApiGen\Reflection\Contract\Reflection\AbstractReflectionInterface;
 use phpDocumentor\Reflection\DocBlock\Tag;
 
-# see: https://github.com/phpDocumentor/TypeResolver#resolving-an-fqsen
-
+/**
+ * @link https://github.com/phpDocumentor/TypeResolver#resolving-an-fqsen
+ */
 final class AnnotationDecorator
 {
     /**

diff --git a/packages/Element/src/ReflectionCollector/AnnotationReflectionCollector.php b/packages/Element/src/ReflectionCollector/AnnotationReflectionCollector.php
@@ -2,7 +2,7 @@
 
 namespace ApiGen\Element\ReflectionCollector;
 
-use ApiGen\Contract\Configuration\ConfigurationInterface;
+use ApiGen\Configuration\Configuration;
 use ApiGen\Reflection\Contract\Reflection\AbstractReflectionInterface;
 use ApiGen\Reflection\Contract\Reflection\Class_\ClassConstantReflectionInterface;
 use ApiGen\Reflection\Contract\Reflection\Class_\ClassMethodReflectionInterface;
@@ -20,7 +20,7 @@
 final class AnnotationReflectionCollector extends AbstractReflectionCollector
 {
     /**
-     * @var ConfigurationInterface
+     * @var Configuration
      */
     private $configuration;
 
@@ -29,7 +29,7 @@ final class AnnotationReflectionCollector extends AbstractReflectionCollector
      */
     private $activeAnnotation;
 
-    public function __construct(ConfigurationInterface $configuration)
+    public function __construct(Configuration $configuration)
     {
         $this->configuration = $configuration;
     }

diff --git a/packages/Element/tests/ReflectionCollector/AnnotationReflectionCollectorTest.php b/packages/Element/tests/ReflectionCollector/AnnotationReflectionCollectorTest.php
@@ -3,7 +3,7 @@
 namespace ApiGen\Element\Tests\ReflectionCollector;
 
 use ApiGen\Annotation\AnnotationList;
-use ApiGen\Contract\Configuration\ConfigurationInterface;
+use ApiGen\Configuration\Configuration;
 use ApiGen\Element\ReflectionCollector\AnnotationReflectionCollector;
 use ApiGen\ModularConfiguration\Option\AnnotationGroupsOption;
 use ApiGen\ModularConfiguration\Option\DestinationOption;
@@ -20,8 +20,8 @@ final class AnnotationReflectionCollectorTest extends AbstractContainerAwareTest
 
     protected function setUp(): void
     {
-        /** @var ConfigurationInterface $configuration */
-        $configuration = $this->container->getByType(ConfigurationInterface::class);
+        /** @var Configuration $configuration */
+        $configuration = $this->container->getByType(Configuration::class);
         $configuration->resolveOptions([
            SourceOption::NAME => [__DIR__],
            DestinationOption::NAME => TEMP_DIR,

diff --git a/packages/Reflection/src/Reflection/Class_/ClassReflection.php b/packages/Reflection/src/Reflection/Class_/ClassReflection.php
@@ -128,12 +128,13 @@ public function getInheritedDescription(): ?string
 
     public function getParentClass(): ?ClassReflectionInterface
     {
-        if (! $this->betterClassReflection->getParentClass()) {
+        $parentClassName = get_parent_class($this->getName());
+        if ($parentClassName === false) {
             return null;
         }
 
         return $this->transformerCollector->transformSingle(
-            $this->betterClassReflection->getParentClass()
+            ReflectionClass::createFromName($parentClassName)
         );
     }
 

diff --git a/packages/Reflection/src/TransformerCollector.php b/packages/Reflection/src/TransformerCollector.php
@@ -94,7 +94,7 @@ private function hasAllowedAccessLevel($transformedReflection): bool
             return true;
         }
 
-        // hardcoded @todo make service-like and using ConfigurationInterface
+        // hardcoded @todo make service-like and using Configuration
         if ($transformedReflection->isPublic() || $transformedReflection->isProtected()) {
             return true;
         }

diff --git a/packages/StringRouting/tests/Route/SourceCodeRouteTest.php b/packages/StringRouting/tests/Route/SourceCodeRouteTest.php
@@ -2,7 +2,7 @@
 
 namespace ApiGen\StringRouting\Tests\Route;
 
-use ApiGen\Contract\Configuration\ConfigurationInterface;
+use ApiGen\Configuration\Configuration;
 use ApiGen\ModularConfiguration\Option\DestinationOption;
 use ApiGen\ModularConfiguration\Option\SourceOption;
 use ApiGen\Reflection\Contract\Reflection\Class_\ClassConstantReflectionInterface;
@@ -30,8 +30,8 @@ final class SourceCodeRouteTest extends AbstractContainerAwareTestCase
     protected function setUp(): void
     {
         $this->stringRouter = $this->container->getByType(StringRouter::class);
-        /** @var ConfigurationInterface $configuration */
-        $configuration = $this->container->getByType(ConfigurationInterface::class);
+        /** @var Configuration $configuration */
+        $configuration = $this->container->getByType(Configuration::class);
         $configuration->resolveOptions([
             SourceOption::NAME => [__DIR__],
             DestinationOption::NAME => TEMP_DIR

diff --git a/packages/ThemeDefault/src/404.latte b/packages/ThemeDefault/src/404.latte
@@ -3,10 +3,8 @@
 {block title}Page not found{/block}
 
 {block content}
-<div id="content">
     <h1>{include title}</h1>
     <p>The requested page could not be found.</p>
     <p>You have probably clicked on a link that is outdated and points to a page that does not exist any more or you have made an typing error in the address.</p>
     <p>To continue please try to find requested page in the menu or use search field on the top.</p>
-</div>
 {/block}
diff --git a/packages/ThemeDefault/src/@layout.latte b/packages/ThemeDefault/src/@layout.latte
@@ -16,11 +16,11 @@
     </head>
 
     <body>
+        {include "partial/menu.latte"}
+
         <div class="container">
             <div class="row">
                 <div class="col-md-12">
-                    {include searchForm}
-                    {include "partial/menu.latte"}
                     {include content}
                     {include footer}
                 </div>
@@ -37,13 +37,6 @@
 </html>
 
 
-{define searchForm}
-    <form id="search">
-        <input type="text" name="q" class="form-control text" placeholder="Search class, function or namespace" autofocus>
-    </form>
-{/define}
-
-
 {define footer}
     <div id="footer">
         Generated by <a href="https://github.com/apigen/apigen">ApiGen</a>

diff --git a/packages/ThemeDefault/src/annotation-group.latte b/packages/ThemeDefault/src/annotation-group.latte
@@ -1,10 +1,8 @@
 {layout '@layout.latte'}
-{var $activePage = 'annotation-group-' . $annotation}
 
 {block title}{$annotation|firstUpper}{/block}
 
 {block content}
-<div id="content">
     <h1>{include title}</h1>
 
     {if $hasElements}
@@ -81,7 +79,6 @@
     {else}
         <p>No elements with <code>@{$annotation}</code> annotation found.</p>
     {/if}
-</div>
 {/block}
 
 

diff --git a/packages/ThemeDefault/src/class.latte b/packages/ThemeDefault/src/class.latte
@@ -1,10 +1,8 @@
 {layout '@layout.latte'}
-{var $activePage = 'class'}
 
 {block title}Class {$class->getName()}{/block}
 
 {block content}
-<div id="content" class="class">
     <h1 n:class="$class->isDeprecated() ? deprecated">
         Class {if $class->getNamespaceName()}{$class->getNamespaceName()|linkAllNamespaceParts|noescape}\{/if}{$class->getShortName()}
     </h1>
@@ -15,32 +13,34 @@
         </div>
     {/if}
 
-    <dl class="tree" n:ifcontent>
-        <dd>
-            {if $class->getParentClass()}
-                extends
-                <a href="{$class->getParentClass()|linkReflection}" n:class="$class->getParentClass()->isDeprecated() ? deprecated">
-                    {$class->getParentClass()->getName()}
-                </a>
-            {/if}
-
-            {if $class->getOwnInterfaces()}
-                implements
-                {foreach $class->getOwnInterfaces() as $ownInterface}
-                    <a href="{$ownInterface|linkReflection}" n:class="$ownInterface->isDeprecated() ? deprecated">
-                        {$ownInterface->getName()}
-                    </a>{sep}, {/sep}
-                {/foreach}
-            {/if}
-
-            {if $class->getTraits()}
-                uses
-                {foreach $class->getTraits() as $ownTrait}
-                    <a href="{$ownTrait|linkReflection}" n:class="$ownTrait->isDeprecated() ? deprecated">{$ownTrait->getName()}</a>{sep}, {/sep}
-                {/foreach}
-            {/if}
-        </dd>
-    </dl>
+    {if $class->getParentClass() || $class->getOwnInterfaces() || $class->getTraits()}
+        <dl class="tree">
+            <dd>
+                {if $class->getParentClass()}
+                    extends
+                    <a href="{$class->getParentClass()|linkReflection}" n:class="$class->getParentClass()->isDeprecated() ? deprecated">
+                        {$class->getParentClass()->getName()}
+                    </a>
+                {/if}
+
+                {if $class->getOwnInterfaces()}
+                    implements
+                    {foreach $class->getOwnInterfaces() as $ownInterface}
+                        <a href="{$ownInterface|linkReflection}" n:class="$ownInterface->isDeprecated() ? deprecated">
+                            {$ownInterface->getName()}
+                        </a>{sep}, {/sep}
+                    {/foreach}
+                {/if}
+
+                {if $class->getTraits()}
+                    uses
+                    {foreach $class->getTraits() as $ownTrait}
+                        <a href="{$ownTrait|linkReflection}" n:class="$ownTrait->isDeprecated() ? deprecated">{$ownTrait->getName()}</a>{sep}, {/sep}
+                    {/foreach}
+                {/if}
+            </dd>
+        </dl>
+    {/if}
 
     {define children}
         {foreach $children as $child}
@@ -92,7 +92,7 @@
         </table>
     {/foreach}
 
-    <table n:foreach="$class->getTraits() as $traitName => $trait" class="summary used table table-bordered table-responsive table-striped">
+    <table n:foreach="$class->getTraits() as $traitName => $trait" class="summary table table-bordered table-responsive table-striped">
         <tr><th>Methods used from <a href="{$traitName|linkReflection}#methods">{$traitName}</a> trait</th></tr>
         <tr>
             <td>
@@ -156,7 +156,7 @@
         </table>
     {/foreach}
 
-    <table n:foreach="$class->getTraits() as $traitName => $trait" class="summary used table table-bordered table-responsive table-striped">
+    <table n:foreach="$class->getTraits() as $traitName => $trait" class="summary table table-bordered table-responsive table-striped">
         <tr><th>Properties used from <a href="{$traitName|linkReflection}#properties">{$traitName}</a></th></tr>
         <tr>
             <td>
@@ -170,5 +170,4 @@
             </td>
         </tr>
     </table>
-</div>
 {/block}
diff --git a/packages/ThemeDefault/src/classes.latte b/packages/ThemeDefault/src/classes.latte
@@ -0,0 +1,17 @@
+{layout '@layout.latte'}
+
+{block title}{$pageTitle}{/block}
+
+{block content}
+    <h1>{$pageTitle}</h1>
+
+    <table class="summary table table-bordered table-responsive table-striped">
+        {foreach $classes as $class}
+            <tr>
+                <td class="name">
+                    <a href="{$class|linkReflection}">{$class->getName()}</a>
+                </td>
+            </tr>
+        {/foreach}
+    </table>
+{/block}
diff --git a/packages/ThemeDefault/src/function.latte b/packages/ThemeDefault/src/function.latte
@@ -1,64 +1,61 @@
 {layout '@layout.latte'}
-{var $activePage = 'function'}
 
 {block title}
     {if $function->isDeprecated()}Deprecated {/if}Function {$function->getName()}
 {/block}
 
 {block content}
-    <div id="content" class="function">
-        <h1 n:class="$function->isDeprecated() ? deprecated">Function {$function->getShortName()}</h1>
+    <h1 n:class="$function->isDeprecated() ? deprecated">Function {$function->getShortName()}</h1>
 
-        {if $function->getDescription()}
-            <div class="description">
-                {$function|description}
-            </div>
-        {/if}
+    {if $function->getDescription()}
+        <div class="description">
+            {$function|description}
+        </div>
+    {/if}
 
-        <div class="info">
-            {if $function->getNamespaceName()}<b>Namespace:</b> {$function->getNamespaceName()|linkAllNamespaceParts|noescape}<br>{/if}
-            {var $filteredAnnotations = ($function->getAnnotations()|annotationFilter: ['param', 'return', 'throws'])}
-            {foreach $filteredAnnotations as $annotation => $values}
-                {foreach $values as $value}
-                    <b>{$annotation}{if $value}:{/if}</b>
-                    {$value|annotation:$function|noescape}<br>
-                {/foreach}
+    <div class="info">
+        {if $function->getNamespaceName()}<b>Namespace:</b> {$function->getNamespaceName()|linkAllNamespaceParts|noescape}<br>{/if}
+        {var $filteredAnnotations = ($function->getAnnotations()|annotationFilter: ['param', 'return', 'throws'])}
+        {foreach $filteredAnnotations as $annotation => $values}
+            {foreach $values as $value}
+                <b>{$annotation}{if $value}:{/if}</b>
+                {$value|annotation:$function|noescape}<br>
             {/foreach}
-            <a href="{$function|linkSource}" class="open-source-code">Open source code</a>
-            <br>
-        </div>
+        {/foreach}
+        <a href="{$function|linkSource}" class="open-source-code">Open source code</a>
+        <br>
+    </div>
 
-        {var $annotations = $function->getAnnotations()}
+    {var $annotations = $function->getAnnotations()}
 
-        <table class="summary table table-responsive table-bordered table-striped" id="parameters" n:if="count($function->getParameters())">
-            <tr><th>Parameters Summary</th></tr>
-            <tr n:foreach="$function->getParameters() as $parameter" id="${$parameter->getName()}">
+    <table class="summary table table-responsive table-bordered table-striped" id="parameters" n:if="count($function->getParameters())">
+        <tr><th>Parameters Summary</th></tr>
+        <tr n:foreach="$function->getParameters() as $parameter" id="${$parameter->getName()}">
+            <td class="name">
+                <code>
+                    {if $parameter->getTypeHintClassOrInterfaceReflection()}
+                        {$parameter->getTypeHintClassOrInterfaceReflection()|linkReflection}
+                    {else}
+                        {$parameter->getTypeHint()}
+                    {/if}
+                </code>
+            </td>
+            <td class="value"><code>{block|strip}
+                <span class="property-name">{if $parameter->isPassedByReference()}&amp; {/if}${$parameter->getName()}</span>
+                {if $parameter->isDefaultValueAvailable()} = {$parameter->getDefaultValueDefinition()|highlightValue:$function|noescape}{elseif $parameter->isVariadic()},…{/if}
+            {/block}</code></td>
+            <td>{$parameter|description}</td>
+        </tr>
+    </table>
+
+    {if isset($annotations['return']) && $annotations['return'][0] !== 'void'}
+        <table class="summary table table-responsive table-bordered table-striped" id="returns">
+            <tr><th>Return value Summary</th></tr>
+            <tr>
                 <td class="name">
-                    <code>
-                        {if $parameter->getTypeHintClassOrInterfaceReflection()}
-                            {$parameter->getTypeHintClassOrInterfaceReflection()|linkReflection}
-                        {else}
-                            {$parameter->getTypeHint()}
-                        {/if}
-                    </code>
+                    {$annotations['return'][0]|annotation:$function|noescape}
                 </td>
-                <td class="value"><code>{block|strip}
-                    <span class="property-name">{if $parameter->isPassedByReference()}&amp; {/if}${$parameter->getName()}</span>
-                    {if $parameter->isDefaultValueAvailable()} = {$parameter->getDefaultValueDefinition()|highlightValue:$function|noescape}{elseif $parameter->isVariadic()},…{/if}
-                {/block}</code></td>
-                <td>{$parameter|description}</td>
             </tr>
         </table>
-
-        {if isset($annotations['return']) && $annotations['return'][0] !== 'void'}
-            <table class="summary table table-responsive table-bordered table-striped" id="returns">
-                <tr><th>Return value Summary</th></tr>
-                <tr>
-                    <td class="name">
-                        {$annotations['return'][0]|annotation:$function|noescape}
-                    </td>
-                </tr>
-            </table>
-        {/if}
-    </div>
+    {/if}
 {/block}