From 4cd98e62d052a77375adee3e287cfe11857dc996 Mon Sep 17 00:00:00 2001 From: Fabien Potencier Date: Tue, 8 May 2012 08:23:16 +0200 Subject: [PATCH] clarified usage of the dump function (closes #718) --- doc/functions/dump.rst | 18 ++++++++++++------ 1 files changed, 12 insertions(+), 6 deletions(-) diff --git a/doc/functions/dump.rst b/doc/functions/dump.rst index 5f27b4b..8ff0c05 100644 --- a/doc/functions/dump.rst +++ b/doc/functions/dump.rst @@ -14,13 +14,19 @@ introspecting its variables: .. note:: - The ``debug`` function is not available by default. You must load it explicitly:: - - $twig = new Twig_Environment($loader, $config); + The ``dump`` function is not available by default. You must add the + ``Twig_Extension_Debug`` extension explicitly when creating your Twig + environment:: + + $twig = new Twig_Environment($loader, array( + 'debug' => true, + // ... + )); $twig->addExtension(new Twig_Extension_Debug()); - Even when loaded explicitly, it won't do anything if the ``debug`` option - is not enabled. + Even when enabled, the ``dump`` function won't display anything if the + ``debug`` option on the environment is not enabled (to avoid leaking debug + information on a production server). In an HTML context, wrap the output with a ``pre`` tag to make it easier to read: @@ -54,5 +60,5 @@ dumped: Internally, Twig uses the PHP `var_dump`_ function. -.. _`XDebug`: http://xdebug.org/docs/display +.. _`XDebug`: http://xdebug.org/docs/display .. _`var_dump`: http://php.net/var_dump -- 1.7.2.5