Merge #54 - Support @category tags

Pull-request: #54

Author: williamdes

src/Reflection/Reflection.php

@@ -323,11 +323,24 @@ public function isInternal(): bool
         return ! empty($this->getTags('internal'));
     }
 
+    public function hasCategories(): bool
+    {
+        return ! empty($this->getCategories());
+    }
+
     public function hasExamples(): bool
     {
         return ! empty($this->getExamples());
     }
 
+    /**
+     * @return array[]
+     */
+    public function getCategories(): array
+    {
+        return $this->getTags('category');
+    }
+
     /**
      * @return array[]
      */

src/Resources/themes/default/class.twig

@@ -1,5 +1,5 @@
 {% extends "layout/layout.twig" %}
-{% from "macros.twig" import render_classes, breadcrumbs, namespace_link, class_link, property_link, method_link, hint_link, source_link, method_source_link, deprecated, deprecations, internals, todo, todos, class_category_name %}
+{% from "macros.twig" import render_classes, breadcrumbs, namespace_link, class_link, property_link, method_link, hint_link, source_link, method_source_link, deprecated, deprecations, internals, categories, todo, todos, class_category_name %}
 {% block title %}{{ class|raw }} | {{ parent() }}{% endblock %}
 {% block body_class 'class' %}
 {% block page_id 'class:' ~ (class.name|replace({'\\': '_'})) %}
@@ -33,6 +33,7 @@
 
     <p>{{ block('class_signature') }}</p>
 
+    {{ categories(class) }}
     {{ deprecations(class) }}
     {{ internals(class) }}
 
@@ -284,6 +285,7 @@
             <i>{{ 'Since:'|trans }} {{ method.getSince() }}</i>
             <br>
         {%- endif -%}
+        {{ categories(method) }}
         {{ deprecations(method) }}
         {{ internals(method) }}
 

src/Resources/themes/default/macros.twig

@@ -159,6 +159,18 @@
     {% endif %}
 {% endmacro %}
 
+{% macro categories(reflection) %}
+    {% if reflection.hasCategories() %}
+        <p>
+            {% for categoryTag in reflection.getCategories() %}
+                {% for category in categoryTag %}
+                    <span class="label label-default">{{ category }}</span>
+                {% endfor %}
+            {% endfor %}
+        </p>
+    {% endif %}
+{% endmacro %}
+
 {% macro todo(reflection) %}
         {% if project.config('insert_todos') == true %}
             {% if reflection.todo %}<small><span class="label label-info">{% trans 'todo' %}</span></small>{% endif %}

tests/phar/data/src/ElloquentBuilder.php

@@ -7,6 +7,9 @@
  * @source https://github.com/netpok/larastan/blob/master/stubs/EloquentBuilder.stub
  * @license MIT
  * @copyright Nuno Maduro enunomaduro@gmail.com
+ *
+ * @category laravel
+ * @category builder
  */
 class Builder
 {
@@ -42,6 +45,7 @@ public function fromQuery($query, $bindings = []);
      * @param  mixed  $id
      * @param  array<int, (model-property<TModelClass>|'*')>|model-property<TModelClass>|'*'  $columns
      * @phpstan-return TModelClass|\Illuminate\Database\Eloquent\Collection<TModelClass>|null
+     * @category find
      */
     public function find($id, $columns = ['*']);
 
@@ -51,6 +55,7 @@ public function find($id, $columns = ['*']);
      * @param  \Illuminate\Contracts\Support\Arrayable|array<mixed>  $ids
      * @param  array<int, (model-property<TModelClass>|'*')>|model-property<TModelClass>|'*'  $columns
      * @phpstan-return \Illuminate\Database\Eloquent\Collection<TModelClass>
+     * @category find
      */
     public function findMany($ids, $columns = ['*']);
 
@@ -60,6 +65,7 @@ public function findMany($ids, $columns = ['*']);
      * @param  mixed  $id
      * @param  array<int, (model-property<TModelClass>|'*')>|model-property<TModelClass>|'*'  $columns
      * @phpstan-return TModelClass|\Illuminate\Database\Eloquent\Collection<TModelClass>
+     * @category find
      *
      * @throws \Illuminate\Database\Eloquent\ModelNotFoundException
      */
@@ -71,6 +77,7 @@ public function findOrFail($id, $columns = ['*']);
      * @param  mixed  $id
      * @param  array<int, (model-property<TModelClass>|'*')>|model-property<TModelClass>|'*'  $columns
      * @phpstan-return TModelClass
+     * @category find
      */
     public function findOrNew($id, $columns = ['*']);