/usr/share/doc/php-twig/manual/functions/include.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 | <!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>include — 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="max" href="max.html" />
<link rel="prev" title="dump" href="dump.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="max.html" title="max"
accesskey="N">next</a> |</li>
<li class="right" >
<a href="dump.html" title="dump"
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">Functions</a> »</li>
</ul>
</div>
<div class="document">
<div class="documentwrapper">
<div class="bodywrapper">
<div class="body" role="main">
<div class="section" id="include">
<h1><code class="docutils literal"><span class="pre">include</span></code><a class="headerlink" href="#include" title="Permalink to this headline">¶</a></h1>
<p>The <code class="docutils literal"><span class="pre">include</span></code> function returns the rendered content of a template:</p>
<div class="highlight-jinja"><div class="highlight"><pre><span></span><span class="cp">{{</span> <span class="nv">include</span><span class="o">(</span><span class="s1">'template.html'</span><span class="o">)</span> <span class="cp">}}</span><span class="x"></span>
<span class="cp">{{</span> <span class="nv">include</span><span class="o">(</span><span class="nv">some_var</span><span class="o">)</span> <span class="cp">}}</span><span class="x"></span>
</pre></div>
</div>
<p>Included templates have access to the variables of the active context.</p>
<p>If you are using the filesystem loader, the templates are looked for in the
paths defined by it.</p>
<p>The context is passed by default to the template but you can also pass
additional variables:</p>
<div class="highlight-jinja"><div class="highlight"><pre><span></span><span class="c">{# template.html will have access to the variables from the current context and the additional ones provided #}</span><span class="x"></span>
<span class="cp">{{</span> <span class="nv">include</span><span class="o">(</span><span class="s1">'template.html'</span><span class="o">,</span> <span class="o">{</span><span class="nv">foo</span><span class="o">:</span> <span class="s1">'bar'</span><span class="o">})</span> <span class="cp">}}</span><span class="x"></span>
</pre></div>
</div>
<p>You can disable access to the context by setting <code class="docutils literal"><span class="pre">with_context</span></code> to
<code class="docutils literal"><span class="pre">false</span></code>:</p>
<div class="highlight-jinja"><div class="highlight"><pre><span></span><span class="c">{# only the foo variable will be accessible #}</span><span class="x"></span>
<span class="cp">{{</span> <span class="nv">include</span><span class="o">(</span><span class="s1">'template.html'</span><span class="o">,</span> <span class="o">{</span><span class="nv">foo</span><span class="o">:</span> <span class="s1">'bar'</span><span class="o">},</span> <span class="nv">with_context</span> <span class="o">=</span> <span class="kp">false</span><span class="o">)</span> <span class="cp">}}</span><span class="x"></span>
</pre></div>
</div>
<div class="highlight-jinja"><div class="highlight"><pre><span></span><span class="c">{# no variables will be accessible #}</span><span class="x"></span>
<span class="cp">{{</span> <span class="nv">include</span><span class="o">(</span><span class="s1">'template.html'</span><span class="o">,</span> <span class="nv">with_context</span> <span class="o">=</span> <span class="kp">false</span><span class="o">)</span> <span class="cp">}}</span><span class="x"></span>
</pre></div>
</div>
<p>And if the expression evaluates to a <code class="docutils literal"><span class="pre">Twig_Template</span></code> or a
<code class="docutils literal"><span class="pre">Twig_TemplateWrapper</span></code> instance, Twig will use it directly:</p>
<div class="highlight-default"><div class="highlight"><pre><span></span>// {{ include(template) }}
$template = $twig->load('some_template.twig');
$twig->display('template.twig', array('template' => $template));
</pre></div>
</div>
<p>When you set the <code class="docutils literal"><span class="pre">ignore_missing</span></code> flag, Twig will return an empty string if
the template does not exist:</p>
<div class="highlight-jinja"><div class="highlight"><pre><span></span><span class="cp">{{</span> <span class="nv">include</span><span class="o">(</span><span class="s1">'sidebar.html'</span><span class="o">,</span> <span class="nv">ignore_missing</span> <span class="o">=</span> <span class="kp">true</span><span class="o">)</span> <span class="cp">}}</span><span class="x"></span>
</pre></div>
</div>
<p>You can also provide a list of templates that are checked for existence before
inclusion. The first template that exists will be rendered:</p>
<div class="highlight-jinja"><div class="highlight"><pre><span></span><span class="cp">{{</span> <span class="nv">include</span><span class="o">([</span><span class="s1">'page_detailed.html'</span><span class="o">,</span> <span class="s1">'page.html'</span><span class="o">])</span> <span class="cp">}}</span><span class="x"></span>
</pre></div>
</div>
<p>If <code class="docutils literal"><span class="pre">ignore_missing</span></code> is set, it will fall back to rendering nothing if none
of the templates exist, otherwise it will throw an exception.</p>
<p>When including a template created by an end user, you should consider
sandboxing it:</p>
<div class="highlight-jinja"><div class="highlight"><pre><span></span><span class="cp">{{</span> <span class="nv">include</span><span class="o">(</span><span class="s1">'page.html'</span><span class="o">,</span> <span class="nv">sandboxed</span> <span class="o">=</span> <span class="kp">true</span><span class="o">)</span> <span class="cp">}}</span><span class="x"></span>
</pre></div>
</div>
<div class="section" id="arguments">
<h2>Arguments<a class="headerlink" href="#arguments" title="Permalink to this headline">¶</a></h2>
<ul class="simple">
<li><code class="docutils literal"><span class="pre">template</span></code>: The template to render</li>
<li><code class="docutils literal"><span class="pre">variables</span></code>: The variables to pass to the template</li>
<li><code class="docutils literal"><span class="pre">with_context</span></code>: Whether to pass the current context variables or not</li>
<li><code class="docutils literal"><span class="pre">ignore_missing</span></code>: Whether to ignore missing templates or not</li>
<li><code class="docutils literal"><span class="pre">sandboxed</span></code>: Whether to sandbox the template or not</li>
</ul>
</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">include</span></code></a><ul>
<li><a class="reference internal" href="#arguments">Arguments</a></li>
</ul>
</li>
</ul>
<h4>Previous topic</h4>
<p class="topless"><a href="dump.html"
title="previous chapter"><code class="docutils literal"><span class="pre">dump</span></code></a></p>
<h4>Next topic</h4>
<p class="topless"><a href="max.html"
title="next chapter"><code class="docutils literal"><span class="pre">max</span></code></a></p>
<div role="note" aria-label="source link">
<h3>This Page</h3>
<ul class="this-page-menu">
<li><a href="../_sources/functions/include.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="max.html" title="max"
>next</a> |</li>
<li class="right" >
<a href="dump.html" title="dump"
>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" >Functions</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>
|