Twig¶

Variables¶

Support variables parser: - Twig_Environment:addGlobal of container file

Templates¶

{% include '<template.html.twig>' %}
{% from '<template.html.twig>' %}
{% extends '<template.html.twig>' %}
{{ include('<template.html.twig>') }}

based on BundleInterface, addPath of container and custom path of settings

goto - open file
complete - template names
annotator - Notice missing template and create action

{% string '<template.html.twig>' %}
{{ your_function('<template.html.twig>') }}

all string ending with .twig provides goto

Blocks¶

{% extends 'parent_blocks.html.twig' %}
{% block <block> %}
{% endblock %}

based on extends tag upwards

goto - Parent block
complete - All parent blocks

Functions / Macros¶

{% from 'Macro:File:file.html.twig' import <widget_panel> %}

{% from '::widgets.html.twig' import widget_panel %}
{{ widget_panel() }}

{% from '::widgets.html.twig' import widget_panel %}
{{ <widget_panel>() }}

{% import '::widgets.html.twig' as widget %}
{{ <widget.widget_panel()> }}

{% set var_name = 'Foo' %}
{{ <var_name> }}

Extension¶

{{ <Twig_Function_Method()> }}
{{ <Twig_Function_Node()> }}
{{ <Twig_SimpleFunction()> }}

based on Twig_ExtensionInterface and simple regular expression

goto - Php function or method
complete - twig extension name

Filter¶

{{ 'name'|<filter> }}

goto - Method or function of filter
complete - Twig_SimpleFilter, Twig_Filter_Function, Twig_Filter_Method inside Twig_ExtensionInterface::getFilters

Note

not fully supported by PhpStorm, autocomplete dialog is a char type event

Assets¶

{% javascripts
  'assets/jquery.min.js'
  '@FooBundle/Resources/public/build-config.js'
%}

{% stylesheets
  'assets/css/style.css'
  '@FooBundle/Resources/public/style.css'
%}

{{ asset('assets/css/style.css') }}

goto - Open file
complete - Bundle or asset file
annotator - Mark missing file or for wildcards folder

Translation¶

{{ 'translation.key'|trans({}, '<Domain>') }}
{{ 'translation.key'|transchoice({}, 2, '<Domain>') }}

goto - Domain file like yaml or other, from container file
complete - Domain file like yaml or other, from container file
annotator - Mark missing domain files

{{ '<translation.key>'|trans({}, 'Domain') }}
{{ '<translation.key>'|transchoice({}, 2, 'Domain') }}

goto - Yaml Key-Value of Domain, default messages or trans_default_domain of current file
complete - All known translation key filtered by domain name
annotator - Mark missing translation and provide quick fix, which create key inside domain file

../../_images/phpstorm_translation_fix.png

{% trans_default_domain <Domain> %}

goto - Translation domain file
complete - Registered translation domains

Routing¶

{{ path('_profiler') }}

goto - Controller action method
complete - Routing name out of eg. appDevUrlGenerator.php
annotator - Mark missing routing name

{{ path('_profiler', {'parameter': '') }}

goto - Method parameter of matching controller method
complete - Method parameter

{{ controller('FooBundle:Bar:index') }}

goto - Controller action method
complete - Controller names of Bundle structure or controller services

PhpTypes¶

../../_images/twig_phptype_completion.png

{# @var variable_name \Foo\Bar #}
{{ variable_name.method.subMethod }}

goto - Class name or method
complete - class name or method with twig shortcut name and inside class name inside comment

Possible Variables Scopes

// block
{% block test %}
  {# @var variable_name \Foo\Bar #}
{% endblock %}

// foreach
{% for ... %}
  {# @var variable_name \Foo\Bar #}
{% endfor %}

// file
{% extends ... %}
{# @var variable_name \Foo\Bar #}

// macro
{% macro ... %}
{# @var variable_name \Foo\Bar #}

Variable parser support controller as source, just define it in root tree of twig file eg under extends tag

{# @controller FooBundle:Bar:index #}
{# @Controller FooBundle:BarFood:index #}

Controller also detect on twig path

// FooBundle/Resources/views/BarFood/index.html.twig
// FooBundle\BarFoodController\indexAction

Valid template variable detection in controller method

return $this->render('foo...', array(
  'form' => $editForm->createView(),
));

// and all other template render calls ...
return $this->renderView('foo...', array(
  'form' => $editForm->createView(),
));

$foo = array(
  'form' => $editForm->createView();
);

$foo['form'] = $editForm->createView();

return $foo;
return $this->render('foo...', $foo);

Array values

{# entities \Foo\Bar[]
{% for entity in entities %}
  {{ entity.completeMe }}
{% endfor %}

Whitelist for variable pattern

{{ "entity" }}
{% for entity in "entities" %}
{% if "entity" > "entity" %}
{% set var = "entity" %}

Include-Statement Context Variables

Pipes variable context from original include statement position

{% include 'template.html.twig' with {'foo': 'bar'} only %}
{% include 'template.html.twig' with {'foo': 'bar'} %}
{% include 'template.html.twig' %}
{% include 'template.html.twig' only %}

{% for entity in entities %}
  {% include 'template.html.twig' %}
{% endfor %}

{# template.html.twig #}
{{ foo.method }}
{{ entity.method }}

Implements and Overwrites¶

Macros from import
Twig include file
Block overwrites
Block implementations