🆕 Properties sections for classes and traits

🆕 Property templates

🎨 Increase header for Methods for sidebar

Author: nelson6e65

data/templates/vuepress/class.md.twig

@@ -93,7 +93,7 @@
 {% endif %}{# class.tags.see || class.tags.link #}
 
 {% set methodsList = [] %}
-#### <span style="display: none;">{{ class }}</span> Methods:
+### <span style="display: none;">{{ class }}</span> Methods
 {# Lista de métodos públicos y protegidos #}
 {% for method in class.methods|sort_asc %}
 {% set methodsList = methodsList|merge([method.name]) %}
@@ -104,7 +104,7 @@
 > This class has not methods.
 {% endfor %}
 
-#### <span style="display: none;">{{ class }}</span> Inherited methods:
+#### <span style="display: none;">{{ class }}</span> Inherited methods
 {# Lista de métodos públicos y protegidos #}
 {% for method in class.inheritedMethods if method.name not in methodsList -%}
   {%- if method.parent in project.indexes.classes %}
@@ -125,3 +125,33 @@
 {% else %}
 > This class has not inherited methods.
 {% endfor %}
+
+{% set propertiesList = [] %}
+### <span style="display: none;">{{ class }}</span> Properties
+{# Lista de propiedades públicas y protegidas #}
+{% for property in class.properties|merge(class.magicProperties|default([]))|sort_asc if property.visibility != 'private' %}
+{% set propertiesList = propertiesList|merge([property.name]) %}
+{% include 'property.md.twig' %}
+{% else %}
+> This class has not properties.
+{% endfor %}
+
+#### <span style="display: none;">{{ class }}</span> Inherited properties
+{# Lista de métodos públicos y protegidos #}
+{% for property in class.inheritedProperties if property.name not in propertiesList and property.visibility != 'private'-%}
+  {%- if property.parent in project.indexes.classes %}
+    {%- set parent_location = 'classes' %}
+  {%- elseif property.parent in project.indexes.interfaces %}
+    {%- set parent_location = 'interfaces' %}
+  {%- else %}
+    {%- set parent_location = 'traits' %}
+  {%- endif %}
+
+- [{{ property.parent.namespace|trim('\\') -}}\\<span style="font-weight: bold;">{{ property.parent.name }}</span>](/api/{{ parent_location }}.html#
+  {{- property.parent|trim('\\')|lower|replace('\\', '-') -}}
+  )::
+  {{- include('property-anchor-link.md.twig', { text: '$' ~ property.name  }) -}}
+  {{ include('badges.md.twig', { elem: property }) }}
+{% else %}
+> This class has not inherited properties.
+{% endfor %}

data/templates/vuepress/interface.md.twig

@@ -55,7 +55,7 @@
 
 {% endif %}{# class.tags.see || class.tags.link #}
 
-#### <span style="display: none;">{{ class.FullyQualifiedStructuralElementName }}</span> Methods:
+### <span style="display: none;">{{ interface }}</span> Methods
 {# Lista de métodos públicos y protegidos #}
 {% for method in interface.methods|sort_asc %}
 {% if method.visibility != 'private' %}

data/templates/vuepress/property-anchor-link.md.twig

@@ -0,0 +1,11 @@
+{% if property.parent in project.indexes.classes %}
+    {%- set parent_location = 'classes' %}
+{%- elseif property.parent in project.indexes.interfaces %}
+    {%- set parent_location = 'interfaces' %}
+{%- else %}
+    {%- set parent_location = 'traits' %}
+{%- endif -%}
+
+<a href="{{ parent_location }}.html#{{ property.parent|trim('\\')|replace('\\', '-') }}::${{ property.name }}">
+    {{- text|default(property.name|default(property))|raw -}}
+</a> {{ '' -}}

data/templates/vuepress/property-anchor-ref.md.twig

@@ -0,0 +1 @@
+<a id="{{ property.parent|trim('\\')|replace('\\', '-') }}::${{ property.name }}" style="display: block; position: relative; top: -5rem; visibility: hidden;"></a> {{ ''-}}

data/templates/vuepress/property.md.twig

@@ -0,0 +1,50 @@
+
+:::
+{%- if property.visibility == 'protected' %}
+    {{- 'warning ' -}}
+{% elseif property.visibility == 'public' %}
+    {{- 'tip ' -}}
+{% else %}
+    {{- 'danger ' -}}
+{% endif -%}
+
+    {{ include('property-anchor-ref.md.twig') }}
+    {{- '$' ~ property.name }} {{ include('badges.md.twig', { elem: property }) }}
+-----
+
+{# property signature #}
+```php
+{{ property.visibility }}{% if property.static %} static{% endif %} {{ property.types|default(['mixed'])|join('|')}} ${{ property.name }}
+{%- if property.default %} = {{ property.default|raw }}{% endif %};
+```
+
+{{ property.summary|replace({'#### ': '- ', '### ': '- ', '## ': '- ', '# ': '- ',}) }}
+
+{% if property.description is not empty %}
+***Description:***
+
+{{ property.description|replace({'#### ': '- ', '### ': '- ', '## ': '- ', '# ': '- ',}) }}
+{% endif %}
+
+{% if method.response.description %}
+***Return Value:***
+
+{{ method.response.description|raw }}
+
+{% endif %}
+
+
+{% if method.tags.see is not empty or method.tags.link is not empty %}
+***See Also:***
+
+{% for see in method.tags.see %}
+* `{{ see.reference }}` {% if see.description %}-{% endif %} {{ see.description }}
+{% endfor %}
+
+{% for link in class.tags.link %}
+* [{{ link.description|default(link.link) }}]({{ link.link }})
+{% endfor %}
+
+{% endif %}{# class.tags.see || class.tags.link #}
+
+:::

data/templates/vuepress/trait.md.twig

@@ -57,7 +57,7 @@
 
 {% endif %}{# class.tags.see || class.tags.link #}
 
-#### <span style="display: none;">{{ trait }}</span> Methods:
+### <span style="display: none;">{{ trait }}</span> Methods
 {# Lista de métodos públicos y protegidos #}
 {% for method in trait.methods|sort_asc %}
 {% if method.visibility != 'private' %}
@@ -67,7 +67,7 @@
 > This trait has not methods.
 {% endfor %}
 
-#### <span style="display: none;">{{ trait }}</span> Inherited methods:
+#### <span style="display: none;">{{ trait }}</span> Inherited methods
 {# Lista de métodos públicos y protegidos #}
 {% for method in trait.inheritedMethods -%}
 {%- if method.visibility != 'private' %}
@@ -79,3 +79,13 @@
 {% else %}
 > This trait has not inherited methods.
 {% endfor %}
+
+{% set propertiesList = [] %}
+### <span style="display: none;">{{ trait }}</span> Properties
+{# Lista de propiedades públicas y protegidas #}
+{% for property in trait.properties|merge(trait.magicProperties)|sort_asc if property.visibility != 'private' %}
+{% set propertiesList = propertiesList|merge([property.name]) %}
+{% include 'property.md.twig' %}
+{% else %}
+> This trait has not properties.
+{% endfor %}