{% extends 'layout.html.twig' %} {% import 'base/macros.html.twig' as macros %} {% use 'base/class.sidebar.html.twig' %} {% block title %} {{ parent() }} » {{ node.FullyQualifiedStructuralElementName }} {% endblock %} {% block content %}
{{ block('sidebar') }}

{{ node.name }}

{% if node.parent %} Extends {{ node.parent|route|join(', ')|raw }} {% endif %} {% if node.interfaces|length %} Implements {{ node.interfaces|route|join(', ')|raw }} {% endif %}

{{ node.summary }}

{{ node.description|markdown|raw }}
{% for tagList in node.tags %} {% for tag in tagList if tag.name not in ['method', 'property']%} {% endfor %} {% endfor %}
{{ tag.name }} {% if tag.type %} {{ tag.type|route|join('|')|raw }} {% endif %} {% if (tag.name == "since" or "deprecated") %} {{ tag.version }} {% endif %} {{ tag.description|markdown|raw }}

Methods

{% set specialMethods = node.magicMethods ? node.inheritedMethods.merge(node.magicMethods) : node.inheritedMethods %} {% for method in node.methods.merge(specialMethods)|sort_asc %}

{{ method.summary ?: method.name }}

{{ method.hasReturnByReference ? '& '~'' }}{{ method.name }}({% for argument in method.arguments %}{{ argument.type ? argument.type }}{{ argument.byReference ? '&' }}{{ argument.name }}{{ argument.default is not null ? ' = '~argument.default }}{% if not loop.last %}, {% endif %}{% endfor %}) {{ method.response.type ? ': '~method.response.type }}
{% if method.parent.name != node.name %}inherited{% endif %} {% if method.static %}static{% endif %} {% if method.final %}final{% endif %} {% if method.abstract %}abstract{% endif %} {% if method.tags.api is defined %}api{% endif %}
{% include 'method.html.twig' with {'method': method} %}
{% endfor %} {% if node.constants.merge(node.inheritedConstants)|length > 0 %}

Constants

{% for constant in node.constants.merge(node.inheritedConstants) %}

{{ constant.summary ?: constant.name }}

{{ constant.name }}
{% if constant.parent.name != node.name %}inherited{% endif %}
{{ constant.description|markdown|raw }}
{% for tagList in constant.tags %} {% endfor %}
{{ tagList.0.name }} {% for tag in tagList %} {{ tag.description|markdown|raw }} {% endfor %}
{% endfor %} {% endif %} {% set specialProperties = node.magicProperties ? node.inheritedProperties.merge(node.magicProperties) : node.inheritedProperties %} {% if node.properties.merge(specialProperties)|length > 0 %}

Properties

{% for property in node.properties.merge(specialProperties) %}

{{ property.summary ?: property.var.0.description ?: property.name }}

{{ property.name }} : {{ property.type }}
{% if property.parent.name != node.name %}inherited{% endif %} {% if property.static %}static{% endif %}
{{ property.description|markdown|raw }}
{% for tagList in property.tags %} {% endfor %}
{{ tagList.0.name }} {% for tag in tagList %} {{ tag.description|markdown|raw }} {% endfor %}
{% if property.type and property.type != 'void' %}

Type(s)

{{ property.type|route|join('|')|raw }} {% endif %}
{% endfor %} {% endif %}
{% endblock %}