/usr/share/doc/php-twig/manual/tags/macro.html is in php-twig-doc 2.4.6-1.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 | <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<title>macro — php-twig-doc 2.4.6 documentation</title>
<link rel="stylesheet" href="../_static/classic.css" type="text/css" />
<link rel="stylesheet" href="../_static/pygments.css" type="text/css" />
<script type="text/javascript">
var DOCUMENTATION_OPTIONS = {
URL_ROOT: '../',
VERSION: '2.4.6',
COLLAPSE_INDEX: false,
FILE_SUFFIX: '.html',
HAS_SOURCE: true,
SOURCELINK_SUFFIX: '.txt'
};
</script>
<script type="text/javascript" src="../_static/jquery.js"></script>
<script type="text/javascript" src="../_static/underscore.js"></script>
<script type="text/javascript" src="../_static/doctools.js"></script>
<link rel="index" title="Index" href="../genindex.html" />
<link rel="search" title="Search" href="../search.html" />
<link rel="next" title="sandbox" href="sandbox.html" />
<link rel="prev" title="include" href="include.html" />
</head>
<body>
<div class="related" role="navigation" aria-label="related navigation">
<h3>Navigation</h3>
<ul>
<li class="right" style="margin-right: 10px">
<a href="../genindex.html" title="General Index"
accesskey="I">index</a></li>
<li class="right" >
<a href="sandbox.html" title="sandbox"
accesskey="N">next</a> |</li>
<li class="right" >
<a href="include.html" title="include"
accesskey="P">previous</a> |</li>
<li class="nav-item nav-item-0"><a href="../index.html">php-twig-doc 2.4.6 documentation</a> »</li>
<li class="nav-item nav-item-1"><a href="index.html" accesskey="U">Tags</a> »</li>
</ul>
</div>
<div class="document">
<div class="documentwrapper">
<div class="bodywrapper">
<div class="body" role="main">
<div class="section" id="macro">
<h1><code class="docutils literal"><span class="pre">macro</span></code><a class="headerlink" href="#macro" title="Permalink to this headline">¶</a></h1>
<p>Macros are comparable with functions in regular programming languages. They
are useful to put often used HTML idioms into reusable elements to not repeat
yourself.</p>
<p>Here is a small example of a macro that renders a form element:</p>
<div class="highlight-jinja"><div class="highlight"><pre><span></span><span class="cp">{%</span> <span class="k">macro</span> <span class="nv">input</span><span class="o">(</span><span class="nv">name</span><span class="o">,</span> <span class="nv">value</span><span class="o">,</span> <span class="nv">type</span><span class="o">,</span> <span class="nv">size</span><span class="o">)</span> <span class="cp">%}</span><span class="x"></span>
<span class="x"> <input type="</span><span class="cp">{{</span> <span class="nv">type</span><span class="o">|</span><span class="nf">default</span><span class="o">(</span><span class="s1">'text'</span><span class="o">)</span> <span class="cp">}}</span><span class="x">" name="</span><span class="cp">{{</span> <span class="nv">name</span> <span class="cp">}}</span><span class="x">" value="</span><span class="cp">{{</span> <span class="nv">value</span><span class="o">|</span><span class="nf">e</span> <span class="cp">}}</span><span class="x">" size="</span><span class="cp">{{</span> <span class="nv">size</span><span class="o">|</span><span class="nf">default</span><span class="o">(</span><span class="m">20</span><span class="o">)</span> <span class="cp">}}</span><span class="x">" /></span>
<span class="cp">{%</span> <span class="k">endmacro</span> <span class="cp">%}</span><span class="x"></span>
</pre></div>
</div>
<p>Macros differ from native PHP functions in a few ways:</p>
<ul class="simple">
<li>Default argument values are defined by using the <code class="docutils literal"><span class="pre">default</span></code> filter in the
macro body;</li>
<li>Arguments of a macro are always optional.</li>
<li>If extra positional arguments are passed to a macro, they end up in the
special <code class="docutils literal"><span class="pre">varargs</span></code> variable as a list of values.</li>
</ul>
<p>But as with PHP functions, macros don’t have access to the current template
variables.</p>
<div class="admonition tip">
<p class="first admonition-title">Tip</p>
<p class="last">You can pass the whole context as an argument by using the special
<code class="docutils literal"><span class="pre">_context</span></code> variable.</p>
</div>
<div class="section" id="import">
<h2>Import<a class="headerlink" href="#import" title="Permalink to this headline">¶</a></h2>
<p>Macros can be defined in any template, and need to be “imported” before being
used (see the documentation for the <a class="reference internal" href="import.html"><span class="doc">import</span></a> tag for more
information):</p>
<div class="highlight-jinja"><div class="highlight"><pre><span></span><span class="cp">{%</span> <span class="k">import</span> <span class="s2">"forms.html"</span> <span class="k">as</span> <span class="nv">forms</span> <span class="cp">%}</span><span class="x"></span>
</pre></div>
</div>
<p>The above <code class="docutils literal"><span class="pre">import</span></code> call imports the “forms.html” file (which can contain only
macros, or a template and some macros), and import the functions as items of
the <code class="docutils literal"><span class="pre">forms</span></code> variable.</p>
<p>The macro can then be called at will:</p>
<div class="highlight-jinja"><div class="highlight"><pre><span></span><span class="x"><p></span><span class="cp">{{</span> <span class="nv">forms.input</span><span class="o">(</span><span class="s1">'username'</span><span class="o">)</span> <span class="cp">}}</span><span class="x"></p></span>
<span class="x"><p></span><span class="cp">{{</span> <span class="nv">forms.input</span><span class="o">(</span><span class="s1">'password'</span><span class="o">,</span> <span class="nv">null</span><span class="o">,</span> <span class="s1">'password'</span><span class="o">)</span> <span class="cp">}}</span><span class="x"></p></span>
</pre></div>
</div>
<p>If macros are defined and used in the same template, you can use the
special <code class="docutils literal"><span class="pre">_self</span></code> variable to import them:</p>
<div class="highlight-jinja"><div class="highlight"><pre><span></span><span class="cp">{%</span> <span class="k">import</span> <span class="nv">_self</span> <span class="k">as</span> <span class="nv">forms</span> <span class="cp">%}</span><span class="x"></span>
<span class="x"><p></span><span class="cp">{{</span> <span class="nv">forms.input</span><span class="o">(</span><span class="s1">'username'</span><span class="o">)</span> <span class="cp">}}</span><span class="x"></p></span>
</pre></div>
</div>
<p>When you want to use a macro in another macro from the same file, you need to
import it locally:</p>
<div class="highlight-jinja"><div class="highlight"><pre><span></span><span class="cp">{%</span> <span class="k">macro</span> <span class="nv">input</span><span class="o">(</span><span class="nv">name</span><span class="o">,</span> <span class="nv">value</span><span class="o">,</span> <span class="nv">type</span><span class="o">,</span> <span class="nv">size</span><span class="o">)</span> <span class="cp">%}</span><span class="x"></span>
<span class="x"> <input type="</span><span class="cp">{{</span> <span class="nv">type</span><span class="o">|</span><span class="nf">default</span><span class="o">(</span><span class="s1">'text'</span><span class="o">)</span> <span class="cp">}}</span><span class="x">" name="</span><span class="cp">{{</span> <span class="nv">name</span> <span class="cp">}}</span><span class="x">" value="</span><span class="cp">{{</span> <span class="nv">value</span><span class="o">|</span><span class="nf">e</span> <span class="cp">}}</span><span class="x">" size="</span><span class="cp">{{</span> <span class="nv">size</span><span class="o">|</span><span class="nf">default</span><span class="o">(</span><span class="m">20</span><span class="o">)</span> <span class="cp">}}</span><span class="x">" /></span>
<span class="cp">{%</span> <span class="k">endmacro</span> <span class="cp">%}</span><span class="x"></span>
<span class="cp">{%</span> <span class="k">macro</span> <span class="nv">wrapped_input</span><span class="o">(</span><span class="nv">name</span><span class="o">,</span> <span class="nv">value</span><span class="o">,</span> <span class="nv">type</span><span class="o">,</span> <span class="nv">size</span><span class="o">)</span> <span class="cp">%}</span><span class="x"></span>
<span class="x"> </span><span class="cp">{%</span> <span class="k">import</span> <span class="nv">_self</span> <span class="k">as</span> <span class="nv">forms</span> <span class="cp">%}</span><span class="x"></span>
<span class="x"> <div class="field"></span>
<span class="x"> </span><span class="cp">{{</span> <span class="nv">forms.input</span><span class="o">(</span><span class="nv">name</span><span class="o">,</span> <span class="nv">value</span><span class="o">,</span> <span class="nv">type</span><span class="o">,</span> <span class="nv">size</span><span class="o">)</span> <span class="cp">}}</span><span class="x"></span>
<span class="x"> </div></span>
<span class="cp">{%</span> <span class="k">endmacro</span> <span class="cp">%}</span><span class="x"></span>
</pre></div>
</div>
</div>
<div class="section" id="named-macro-end-tags">
<h2>Named Macro End-Tags<a class="headerlink" href="#named-macro-end-tags" title="Permalink to this headline">¶</a></h2>
<p>Twig allows you to put the name of the macro after the end tag for better
readability:</p>
<div class="highlight-jinja"><div class="highlight"><pre><span></span><span class="cp">{%</span> <span class="k">macro</span> <span class="nv">input</span><span class="o">()</span> <span class="cp">%}</span><span class="x"></span>
<span class="x"> ...</span>
<span class="cp">{%</span> <span class="k">endmacro</span> <span class="nv">input</span> <span class="cp">%}</span><span class="x"></span>
</pre></div>
</div>
<p>Of course, the name after the <code class="docutils literal"><span class="pre">endmacro</span></code> word must match the macro name.</p>
<div class="admonition seealso">
<p class="first admonition-title">See also</p>
<p class="last"><a class="reference internal" href="from.html"><span class="doc">from</span></a>, <a class="reference internal" href="import.html"><span class="doc">import</span></a></p>
</div>
</div>
</div>
</div>
</div>
</div>
<div class="sphinxsidebar" role="navigation" aria-label="main navigation">
<div class="sphinxsidebarwrapper">
<h3><a href="../index.html">Table Of Contents</a></h3>
<ul>
<li><a class="reference internal" href="#"><code class="docutils literal"><span class="pre">macro</span></code></a><ul>
<li><a class="reference internal" href="#import">Import</a></li>
<li><a class="reference internal" href="#named-macro-end-tags">Named Macro End-Tags</a></li>
</ul>
</li>
</ul>
<h4>Previous topic</h4>
<p class="topless"><a href="include.html"
title="previous chapter"><code class="docutils literal"><span class="pre">include</span></code></a></p>
<h4>Next topic</h4>
<p class="topless"><a href="sandbox.html"
title="next chapter"><code class="docutils literal"><span class="pre">sandbox</span></code></a></p>
<div role="note" aria-label="source link">
<h3>This Page</h3>
<ul class="this-page-menu">
<li><a href="../_sources/tags/macro.rst.txt"
rel="nofollow">Show Source</a></li>
</ul>
</div>
<div id="searchbox" style="display: none" role="search">
<h3>Quick search</h3>
<form class="search" action="../search.html" method="get">
<div><input type="text" name="q" /></div>
<div><input type="submit" value="Go" /></div>
<input type="hidden" name="check_keywords" value="yes" />
<input type="hidden" name="area" value="default" />
</form>
</div>
<script type="text/javascript">$('#searchbox').show(0);</script>
</div>
</div>
<div class="clearer"></div>
</div>
<div class="related" role="navigation" aria-label="related navigation">
<h3>Navigation</h3>
<ul>
<li class="right" style="margin-right: 10px">
<a href="../genindex.html" title="General Index"
>index</a></li>
<li class="right" >
<a href="sandbox.html" title="sandbox"
>next</a> |</li>
<li class="right" >
<a href="include.html" title="include"
>previous</a> |</li>
<li class="nav-item nav-item-0"><a href="../index.html">php-twig-doc 2.4.6 documentation</a> »</li>
<li class="nav-item nav-item-1"><a href="index.html" >Tags</a> »</li>
</ul>
</div>
<div class="footer" role="contentinfo">
© Copyright by the Twig Team.
Created using <a href="http://sphinx-doc.org/">Sphinx</a> 1.6.7.
</div>
</body>
</html>
|