/usr/share/doc/php-twig/manual/functions/dump.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 | <!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>dump — 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="include" href="include.html" />
<link rel="prev" title="date" href="date.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="include.html" title="include"
accesskey="N">next</a> |</li>
<li class="right" >
<a href="date.html" title="date"
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="dump">
<h1><code class="docutils literal"><span class="pre">dump</span></code><a class="headerlink" href="#dump" title="Permalink to this headline">¶</a></h1>
<p>The <code class="docutils literal"><span class="pre">dump</span></code> function dumps information about a template variable. This is
mostly useful to debug a template that does not behave as expected by
introspecting its variables:</p>
<div class="highlight-jinja"><div class="highlight"><pre><span></span><span class="cp">{{</span> <span class="nv">dump</span><span class="o">(</span><span class="nv">user</span><span class="o">)</span> <span class="cp">}}</span><span class="x"></span>
</pre></div>
</div>
<div class="admonition note">
<p class="first admonition-title">Note</p>
<p>The <code class="docutils literal"><span class="pre">dump</span></code> function is not available by default. You must add the
<code class="docutils literal"><span class="pre">Twig_Extension_Debug</span></code> extension explicitly when creating your Twig
environment:</p>
<div class="highlight-default"><div class="highlight"><pre><span></span>$twig = new Twig_Environment($loader, array(
'debug' => true,
// ...
));
$twig->addExtension(new Twig_Extension_Debug());
</pre></div>
</div>
<p class="last">Even when enabled, the <code class="docutils literal"><span class="pre">dump</span></code> function won’t display anything if the
<code class="docutils literal"><span class="pre">debug</span></code> option on the environment is not enabled (to avoid leaking debug
information on a production server).</p>
</div>
<p>In an HTML context, wrap the output with a <code class="docutils literal"><span class="pre">pre</span></code> tag to make it easier to
read:</p>
<div class="highlight-jinja"><div class="highlight"><pre><span></span><span class="x"><pre></span>
<span class="x"> </span><span class="cp">{{</span> <span class="nv">dump</span><span class="o">(</span><span class="nv">user</span><span class="o">)</span> <span class="cp">}}</span><span class="x"></span>
<span class="x"></pre></span>
</pre></div>
</div>
<div class="admonition tip">
<p class="first admonition-title">Tip</p>
<p class="last">Using a <code class="docutils literal"><span class="pre">pre</span></code> tag is not needed when <a class="reference external" href="http://xdebug.org/docs/display">XDebug</a> is enabled and
<code class="docutils literal"><span class="pre">html_errors</span></code> is <code class="docutils literal"><span class="pre">on</span></code>; as a bonus, the output is also nicer with
XDebug enabled.</p>
</div>
<p>You can debug several variables by passing them as additional arguments:</p>
<div class="highlight-jinja"><div class="highlight"><pre><span></span><span class="cp">{{</span> <span class="nv">dump</span><span class="o">(</span><span class="nv">user</span><span class="o">,</span> <span class="nv">categories</span><span class="o">)</span> <span class="cp">}}</span><span class="x"></span>
</pre></div>
</div>
<p>If you don’t pass any value, all variables from the current context are
dumped:</p>
<div class="highlight-jinja"><div class="highlight"><pre><span></span><span class="cp">{{</span> <span class="nv">dump</span><span class="o">()</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">Internally, Twig uses the PHP <a class="reference external" href="http://php.net/var_dump">var_dump</a> function.</p>
</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">context</span></code>: The context to dump</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">dump</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="date.html"
title="previous chapter"><code class="docutils literal"><span class="pre">date</span></code></a></p>
<h4>Next topic</h4>
<p class="topless"><a href="include.html"
title="next chapter"><code class="docutils literal"><span class="pre">include</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/dump.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="include.html" title="include"
>next</a> |</li>
<li class="right" >
<a href="date.html" title="date"
>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>
|