{% 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, todo, todos %} {% block title %}{{ class|raw }} | {{ parent() }}{% endblock %} {% block body_class 'class' %} {% block page_id 'class:' ~ (class.name|replace({'\\': '_'})) %} {% block below_menu %} {% if class.namespace %}
{% endif %} {% endblock %} {% block page_content %}

{{ block('class_signature') }}

{{ deprecations(class) }} {% if class.shortdesc or class.longdesc %}
{% if class.shortdesc -%}

{{ class.shortdesc|desc(class) }}

{%- endif %} {% if class.longdesc -%}

{{ class.longdesc|desc(class) }}

{%- endif %} {% if project.config('insert_todos') == true %} {{ todos(class) }} {% endif %}
{% endif %} {#{% if traits %}

Traits

{{ render_classes(traits) }} {% endif %}#} {% if properties %}

Properties

{{ block('properties') }} {% endif %} {% if methods %}

Methods

{{ block('methods') }}

Details

{{ block('methods_details') }} {% endif %} {% if constants %}

Constants

{{ block('constants') }} {% endif %} {% endblock %} {% block class_signature -%} {% if not class.interface and class.abstract %}abstract {% endif %} {{ class.categoryName|raw }} {{ class.shortname|raw }} {%- if class.parent %} extends {{ class_link(class.parent) }} {%- endif %} {%- if class.interfaces|length > 0 %} implements {% for interface in class.interfaces %} {{- class_link(interface) }} {%- if not loop.last %}, {% endif %} {%- endfor %} {%- endif %} {{- source_link(project, class) }} {% endblock %} {% block method_signature -%} {% if method.final %}final{% endif %} {% if method.abstract %}abstract{% endif %} {% if method.static %}static{% endif %} {% if method.protected %}protected{% endif %} {% if method.private %}private{% endif %} {{ hint_link(method.hint) }} {{ method.name|raw }}{{ block('method_parameters_signature') }} {%- endblock %} {% block method_parameters_signature -%} {%- from "macros.twig" import method_parameters_signature -%} {{ method_parameters_signature(method) }} {{ deprecated(method) }} {%- endblock %} {% block parameters %} {% for parameter in method.parameters %} {% endfor %}
Name Type Description
{%- if parameter.variadic %}...{% endif %}${{ parameter.name|raw }} {% if parameter.hint %}{{ hint_link(parameter.hint) }}{% endif %} {{ parameter.shortdesc|desc(class) }}
{% endblock %} {% block return %}
{{ hint_link(method.hint) }} {{ method.hintDesc|desc(class) }}
{% endblock %} {% block exceptions %} {% for exception in method.exceptions %} {% endfor %}
{{ class_link(exception[0]) }} {{ exception[1]|desc(class) }}
{% endblock %} {% block see %} {% for see in method.see %} {% endfor %}
{% if see[4] %} {{see[4]}} {% elseif see[3] %} {{ method_link(see[3], false, false) }} {% elseif see[2] %} {{ class_link(see[2]) }} {% else %} {{ see[0]|raw }} {% endif %} {{ see[1]|raw }}
{% endblock %} {% block constants %} {% for constant in constants %} {% endfor %}
{{ constant.name|raw }}

{{ constant.shortdesc|desc(class) }}

{{ constant.longdesc|desc(class) }}

{% endblock %} {% block properties %} {% for property in properties %} {% endfor %}
{% if property.static %}static{% endif %} {% if property.protected %}protected{% endif %} {% if property.private %}private{% endif %} {{ hint_link(property.hint) }} ${{ property.name|raw }} {{ property.shortdesc|desc(class) }} {%- if property.class is not same as(class) -%} from {{ property_link(property, false, true) }} {%- endif -%}
{% endblock %} {% block methods %}
{% for method in methods %}
{{ method.name|raw }}{{ block('method_parameters_signature') }} {% if not method.shortdesc %}

No description

{% else %}

{{ method.shortdesc|desc(class) }}

{%- endif %}
{#
{% if method.static %}static {% endif %}{{ hint_link(method.hint) }}
{%- if method.class is not same as(class) -%} from {{ method_link(method, false, true) }} {%- endif -%}
#}
{% endfor %}
{% endblock %} {% block methods_details %}
{% for method in methods %}
{{ block('method') }}
{% endfor %}
{% endblock %} {% block method %}

{#
{% if method.class is not same as(class) %}in {{ method_link(method, false, true) }} {% endif %}at {{ method_source_link(method) }}
#} {{ block('method_signature') }}

{{ deprecations(method) }} {% if method.shortdesc or method.longdesc %}
{% if not method.shortdesc and not method.longdesc %}

No description

{% else %} {% if method.shortdesc -%}

{{ method.shortdesc|desc(class) }}

{%- endif %} {% if method.longdesc -%}

{{ method.longdesc|desc(class) }}

{%- endif %} {%- endif %} {% if project.config('insert_todos') == true %} {{ todos(method) }} {% endif %}
{% endif %}
{% if method.parameters %}

Parameters

{{ block('parameters') }} {% endif %} {% if method.hintDesc or method.hint %}

Return Value

{{ block('return') }} {% endif %} {% if method.exceptions %}

Exceptions

{{ block('exceptions') }} {% endif %} {% if method.tags('see') %}

See also

{{ block('see') }} {% endif %}
{% endblock %}