/usr/share/doc/php-twig/manual/tags/for.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 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 | <!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>for — 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="from" href="from.html" />
<link rel="prev" title="flush" href="flush.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="from.html" title="from"
accesskey="N">next</a> |</li>
<li class="right" >
<a href="flush.html" title="flush"
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="for">
<h1><code class="docutils literal"><span class="pre">for</span></code><a class="headerlink" href="#for" title="Permalink to this headline">¶</a></h1>
<p>Loop over each item in a sequence. For example, to display a list of users
provided in a variable called <code class="docutils literal"><span class="pre">users</span></code>:</p>
<div class="highlight-jinja"><div class="highlight"><pre><span></span><span class="x"><h1>Members</h1></span>
<span class="x"><ul></span>
<span class="x"> </span><span class="cp">{%</span> <span class="k">for</span> <span class="nv">user</span> <span class="k">in</span> <span class="nv">users</span> <span class="cp">%}</span><span class="x"></span>
<span class="x"> <li></span><span class="cp">{{</span> <span class="nv">user.username</span><span class="o">|</span><span class="nf">e</span> <span class="cp">}}</span><span class="x"></li></span>
<span class="x"> </span><span class="cp">{%</span> <span class="k">endfor</span> <span class="cp">%}</span><span class="x"></span>
<span class="x"></ul></span>
</pre></div>
</div>
<div class="admonition note">
<p class="first admonition-title">Note</p>
<p class="last">A sequence can be either an array or an object implementing the
<code class="docutils literal"><span class="pre">Traversable</span></code> interface.</p>
</div>
<p>If you do need to iterate over a sequence of numbers, you can use the <code class="docutils literal"><span class="pre">..</span></code>
operator:</p>
<div class="highlight-jinja"><div class="highlight"><pre><span></span><span class="cp">{%</span> <span class="k">for</span> <span class="nv">i</span> <span class="k">in</span> <span class="m">0.</span><span class="nv">.10</span> <span class="cp">%}</span><span class="x"></span>
<span class="x"> * </span><span class="cp">{{</span> <span class="nv">i</span> <span class="cp">}}</span><span class="x"></span>
<span class="cp">{%</span> <span class="k">endfor</span> <span class="cp">%}</span><span class="x"></span>
</pre></div>
</div>
<p>The above snippet of code would print all numbers from 0 to 10.</p>
<p>It can be also useful with letters:</p>
<div class="highlight-jinja"><div class="highlight"><pre><span></span><span class="cp">{%</span> <span class="k">for</span> <span class="nv">letter</span> <span class="k">in</span> <span class="s1">'a'</span><span class="p">..</span><span class="s1">'z'</span> <span class="cp">%}</span><span class="x"></span>
<span class="x"> * </span><span class="cp">{{</span> <span class="nv">letter</span> <span class="cp">}}</span><span class="x"></span>
<span class="cp">{%</span> <span class="k">endfor</span> <span class="cp">%}</span><span class="x"></span>
</pre></div>
</div>
<p>The <code class="docutils literal"><span class="pre">..</span></code> operator can take any expression at both sides:</p>
<div class="highlight-jinja"><div class="highlight"><pre><span></span><span class="cp">{%</span> <span class="k">for</span> <span class="nv">letter</span> <span class="k">in</span> <span class="s1">'a'</span><span class="o">|</span><span class="nf">upper</span><span class="p">..</span><span class="s1">'z'</span><span class="o">|</span><span class="nf">upper</span> <span class="cp">%}</span><span class="x"></span>
<span class="x"> * </span><span class="cp">{{</span> <span class="nv">letter</span> <span class="cp">}}</span><span class="x"></span>
<span class="cp">{%</span> <span class="k">endfor</span> <span class="cp">%}</span><span class="x"></span>
</pre></div>
</div>
<div class="section" id="the-loop-variable">
<h2>The <cite>loop</cite> variable<a class="headerlink" href="#the-loop-variable" title="Permalink to this headline">¶</a></h2>
<p>Inside of a <code class="docutils literal"><span class="pre">for</span></code> loop block you can access some special variables:</p>
<table border="1" class="docutils">
<colgroup>
<col width="26%" />
<col width="74%" />
</colgroup>
<thead valign="bottom">
<tr class="row-odd"><th class="head">Variable</th>
<th class="head">Description</th>
</tr>
</thead>
<tbody valign="top">
<tr class="row-even"><td><code class="docutils literal"><span class="pre">loop.index</span></code></td>
<td>The current iteration of the loop. (1 indexed)</td>
</tr>
<tr class="row-odd"><td><code class="docutils literal"><span class="pre">loop.index0</span></code></td>
<td>The current iteration of the loop. (0 indexed)</td>
</tr>
<tr class="row-even"><td><code class="docutils literal"><span class="pre">loop.revindex</span></code></td>
<td>The number of iterations from the end of the loop (1 indexed)</td>
</tr>
<tr class="row-odd"><td><code class="docutils literal"><span class="pre">loop.revindex0</span></code></td>
<td>The number of iterations from the end of the loop (0 indexed)</td>
</tr>
<tr class="row-even"><td><code class="docutils literal"><span class="pre">loop.first</span></code></td>
<td>True if first iteration</td>
</tr>
<tr class="row-odd"><td><code class="docutils literal"><span class="pre">loop.last</span></code></td>
<td>True if last iteration</td>
</tr>
<tr class="row-even"><td><code class="docutils literal"><span class="pre">loop.length</span></code></td>
<td>The number of items in the sequence</td>
</tr>
<tr class="row-odd"><td><code class="docutils literal"><span class="pre">loop.parent</span></code></td>
<td>The parent context</td>
</tr>
</tbody>
</table>
<div class="highlight-jinja"><div class="highlight"><pre><span></span><span class="cp">{%</span> <span class="k">for</span> <span class="nv">user</span> <span class="k">in</span> <span class="nv">users</span> <span class="cp">%}</span><span class="x"></span>
<span class="x"> </span><span class="cp">{{</span> <span class="nb">loop</span><span class="nv">.index</span> <span class="cp">}}</span><span class="x"> - </span><span class="cp">{{</span> <span class="nv">user.username</span> <span class="cp">}}</span><span class="x"></span>
<span class="cp">{%</span> <span class="k">endfor</span> <span class="cp">%}</span><span class="x"></span>
</pre></div>
</div>
<div class="admonition note">
<p class="first admonition-title">Note</p>
<p class="last">The <code class="docutils literal"><span class="pre">loop.length</span></code>, <code class="docutils literal"><span class="pre">loop.revindex</span></code>, <code class="docutils literal"><span class="pre">loop.revindex0</span></code>, and
<code class="docutils literal"><span class="pre">loop.last</span></code> variables are only available for PHP arrays, or objects that
implement the <code class="docutils literal"><span class="pre">Countable</span></code> interface. They are also not available when
looping with a condition.</p>
</div>
</div>
<div class="section" id="adding-a-condition">
<h2>Adding a condition<a class="headerlink" href="#adding-a-condition" title="Permalink to this headline">¶</a></h2>
<p>Unlike in PHP, it’s not possible to <code class="docutils literal"><span class="pre">break</span></code> or <code class="docutils literal"><span class="pre">continue</span></code> in a loop. You
can however filter the sequence during iteration which allows you to skip
items. The following example skips all the users which are not active:</p>
<div class="highlight-jinja"><div class="highlight"><pre><span></span><span class="x"><ul></span>
<span class="x"> </span><span class="cp">{%</span> <span class="k">for</span> <span class="nv">user</span> <span class="k">in</span> <span class="nv">users</span> <span class="k">if</span> <span class="nv">user.active</span> <span class="cp">%}</span><span class="x"></span>
<span class="x"> <li></span><span class="cp">{{</span> <span class="nv">user.username</span><span class="o">|</span><span class="nf">e</span> <span class="cp">}}</span><span class="x"></li></span>
<span class="x"> </span><span class="cp">{%</span> <span class="k">endfor</span> <span class="cp">%}</span><span class="x"></span>
<span class="x"></ul></span>
</pre></div>
</div>
<p>The advantage is that the special loop variable will count correctly thus not
counting the users not iterated over. Keep in mind that properties like
<code class="docutils literal"><span class="pre">loop.last</span></code> will not be defined when using loop conditions.</p>
<div class="admonition note">
<p class="first admonition-title">Note</p>
<p class="last">Using the <code class="docutils literal"><span class="pre">loop</span></code> variable within the condition is not recommended as it
will probably not be doing what you expect it to. For instance, adding a
condition like <code class="docutils literal"><span class="pre">loop.index</span> <span class="pre">></span> <span class="pre">4</span></code> won’t work as the index is only
incremented when the condition is true (so the condition will never
match).</p>
</div>
</div>
<div class="section" id="the-else-clause">
<h2>The <cite>else</cite> Clause<a class="headerlink" href="#the-else-clause" title="Permalink to this headline">¶</a></h2>
<p>If no iteration took place because the sequence was empty, you can render a
replacement block by using <code class="docutils literal"><span class="pre">else</span></code>:</p>
<div class="highlight-jinja"><div class="highlight"><pre><span></span><span class="x"><ul></span>
<span class="x"> </span><span class="cp">{%</span> <span class="k">for</span> <span class="nv">user</span> <span class="k">in</span> <span class="nv">users</span> <span class="cp">%}</span><span class="x"></span>
<span class="x"> <li></span><span class="cp">{{</span> <span class="nv">user.username</span><span class="o">|</span><span class="nf">e</span> <span class="cp">}}</span><span class="x"></li></span>
<span class="x"> </span><span class="cp">{%</span> <span class="k">else</span> <span class="cp">%}</span><span class="x"></span>
<span class="x"> <li><em>no user found</em></li></span>
<span class="x"> </span><span class="cp">{%</span> <span class="k">endfor</span> <span class="cp">%}</span><span class="x"></span>
<span class="x"></ul></span>
</pre></div>
</div>
</div>
<div class="section" id="iterating-over-keys">
<h2>Iterating over Keys<a class="headerlink" href="#iterating-over-keys" title="Permalink to this headline">¶</a></h2>
<p>By default, a loop iterates over the values of the sequence. You can iterate
on keys by using the <code class="docutils literal"><span class="pre">keys</span></code> filter:</p>
<div class="highlight-jinja"><div class="highlight"><pre><span></span><span class="x"><h1>Members</h1></span>
<span class="x"><ul></span>
<span class="x"> </span><span class="cp">{%</span> <span class="k">for</span> <span class="nv">key</span> <span class="k">in</span> <span class="nv">users</span><span class="o">|</span><span class="nf">keys</span> <span class="cp">%}</span><span class="x"></span>
<span class="x"> <li></span><span class="cp">{{</span> <span class="nv">key</span> <span class="cp">}}</span><span class="x"></li></span>
<span class="x"> </span><span class="cp">{%</span> <span class="k">endfor</span> <span class="cp">%}</span><span class="x"></span>
<span class="x"></ul></span>
</pre></div>
</div>
</div>
<div class="section" id="iterating-over-keys-and-values">
<h2>Iterating over Keys and Values<a class="headerlink" href="#iterating-over-keys-and-values" title="Permalink to this headline">¶</a></h2>
<p>You can also access both keys and values:</p>
<div class="highlight-jinja"><div class="highlight"><pre><span></span><span class="x"><h1>Members</h1></span>
<span class="x"><ul></span>
<span class="x"> </span><span class="cp">{%</span> <span class="k">for</span> <span class="nv">key</span><span class="o">,</span> <span class="nv">user</span> <span class="k">in</span> <span class="nv">users</span> <span class="cp">%}</span><span class="x"></span>
<span class="x"> <li></span><span class="cp">{{</span> <span class="nv">key</span> <span class="cp">}}</span><span class="x">: </span><span class="cp">{{</span> <span class="nv">user.username</span><span class="o">|</span><span class="nf">e</span> <span class="cp">}}</span><span class="x"></li></span>
<span class="x"> </span><span class="cp">{%</span> <span class="k">endfor</span> <span class="cp">%}</span><span class="x"></span>
<span class="x"></ul></span>
</pre></div>
</div>
</div>
<div class="section" id="iterating-over-a-subset">
<h2>Iterating over a Subset<a class="headerlink" href="#iterating-over-a-subset" title="Permalink to this headline">¶</a></h2>
<p>You might want to iterate over a subset of values. This can be achieved using
the <a class="reference internal" href="../filters/slice.html"><span class="doc">slice</span></a> filter:</p>
<div class="highlight-jinja"><div class="highlight"><pre><span></span><span class="x"><h1>Top Ten Members</h1></span>
<span class="x"><ul></span>
<span class="x"> </span><span class="cp">{%</span> <span class="k">for</span> <span class="nv">user</span> <span class="k">in</span> <span class="nv">users</span><span class="o">|</span><span class="nf">slice</span><span class="o">(</span><span class="m">0</span><span class="o">,</span> <span class="m">10</span><span class="o">)</span> <span class="cp">%}</span><span class="x"></span>
<span class="x"> <li></span><span class="cp">{{</span> <span class="nv">user.username</span><span class="o">|</span><span class="nf">e</span> <span class="cp">}}</span><span class="x"></li></span>
<span class="x"> </span><span class="cp">{%</span> <span class="k">endfor</span> <span class="cp">%}</span><span class="x"></span>
<span class="x"></ul></span>
</pre></div>
</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">for</span></code></a><ul>
<li><a class="reference internal" href="#the-loop-variable">The <cite>loop</cite> variable</a></li>
<li><a class="reference internal" href="#adding-a-condition">Adding a condition</a></li>
<li><a class="reference internal" href="#the-else-clause">The <cite>else</cite> Clause</a></li>
<li><a class="reference internal" href="#iterating-over-keys">Iterating over Keys</a></li>
<li><a class="reference internal" href="#iterating-over-keys-and-values">Iterating over Keys and Values</a></li>
<li><a class="reference internal" href="#iterating-over-a-subset">Iterating over a Subset</a></li>
</ul>
</li>
</ul>
<h4>Previous topic</h4>
<p class="topless"><a href="flush.html"
title="previous chapter"><code class="docutils literal"><span class="pre">flush</span></code></a></p>
<h4>Next topic</h4>
<p class="topless"><a href="from.html"
title="next chapter"><code class="docutils literal"><span class="pre">from</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/for.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="from.html" title="from"
>next</a> |</li>
<li class="right" >
<a href="flush.html" title="flush"
>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>
|