[DebugBundle] dump() + better Symfony glue

symfony · fabpot · Sep 23, 2014 · Mar 7, 2014 · Mar 20, 2014 · Apr 5, 2014
commit eb98c8175465a30b5758a67ee92f802a8f8b7652
diff --git a/composer.json b/composer.json
@@ -87,7 +87,7 @@
         ],
         "files": [
             "src/Symfony/Component/Intl/Resources/stubs/functions.php",
-            "src/Symfony/Bundle/DebugBundle/Resources/functions/debug.php"
+            "src/Symfony/Bundle/DebugBundle/Resources/functions/dump.php"
         ]
     },
     "minimum-stability": "dev",

diff --git a/src/Symfony/Bridge/Twig/Extension/DumpExtension.php b/src/Symfony/Bridge/Twig/Extension/DumpExtension.php
@@ -0,0 +1,32 @@
+<?php
+
+/*
+ * This file is part of the Symfony package.
+ *
+ * (c) Fabien Potencier <[email protected]>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+namespace Symfony\Bridge\Twig\Extension;
+
+use Symfony\Bridge\Twig\TokenParser\DumpTokenParser;
+
+/**
+ * Provides integration of the dump() function with Twig.
+ *
+ * @author Nicolas Grekas <[email protected]>
+ */
+class DumpExtension extends \Twig_Extension
+{
+    public function getTokenParsers()
+    {
+        return array(new DumpTokenParser());
+    }
+
+    public function getName()
+    {
+        return 'dump';
+    }
+}
diff --git a/src/Symfony/Bridge/Twig/Node/DumpNode.php b/src/Symfony/Bridge/Twig/Node/DumpNode.php
@@ -0,0 +1,89 @@
+<?php
+
+/*
+ * This file is part of the Symfony package.
+ *
+ * (c) Fabien Potencier <[email protected]>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+namespace Symfony\Bridge\Twig\Node;
+
+/**
+ * @author Julien Galenski <[email protected]>
+ */
+class DumpNode extends \Twig_Node
+{
+    public function __construct(\Twig_NodeInterface $values = null, $lineno, $tag = null)
+    {
+        parent::__construct(array('values' => $values), array(), $lineno, $tag);
+    }
+
+    /**
+     * {@inheritdoc}
+     */
+    public function compile(\Twig_Compiler $compiler)
+    {
+        $compiler
+            ->write("if (\$this->env->isDebug()) {\n")
+            ->indent()
+        ;
+
+        $values = $this->getNode('values');
+
+        if (null === $values) {
+            // remove embedded templates (macros) from the context
+            $compiler
+                ->write("\$vars = array();\n")
+                ->write("foreach (\$context as \$key => \$value) {\n")
+                ->indent()
+                ->write("if (!\$value instanceof Twig_Template) {\n")
+                ->indent()
+                ->write("\$vars[\$key] = \$value;\n")
+                ->outdent()
+                ->write("}\n")
+                ->outdent()
+                ->write("}\n")
+                ->addDebugInfo($this)
+                ->write('\Symfony\Component\Debug\Debug::dump($vars);'."\n")
+            ;
+        } elseif (1 === $values->count()) {
+            $compiler
+                ->addDebugInfo($this)
+                ->write('\Symfony\Component\Debug\Debug::dump(')
+                ->subcompile($values->getNode(0))
+                ->raw(");\n")
+            ;
+        } else {
+            $compiler
+                ->addDebugInfo($this)
+                ->write('\Symfony\Component\Debug\Debug::dump(array(')
+                ->indent()
+            ;
+            foreach ($values as $node) {
+                $compiler->addIndentation();
+                if ($node->hasAttribute('name')) {
+                    $compiler
+                        ->string($node->getAttribute('name'))
+                        ->raw(' => ')
+                    ;
+                }
+                $compiler
+                    ->subcompile($node)
+                    ->raw(",\n")
+                ;
+            }
+            $compiler
+                ->outdent()
+                ->raw("));\n")
+            ;
+        }
+
+        $compiler
+            ->outdent()
+            ->write("}\n")
+        ;
+    }
+}
diff --git a/src/Symfony/Bridge/Twig/TokenParser/DumpTokenParser.php b/src/Symfony/Bridge/Twig/TokenParser/DumpTokenParser.php
@@ -0,0 +1,51 @@
+<?php
+
+/*
+ * This file is part of the Symfony package.
+ *
+ * (c) Fabien Potencier <[email protected]>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+namespace Symfony\Bridge\Twig\TokenParser;
+
+use Symfony\Bridge\Twig\Node\DumpNode;
+
+/**
+ * Token Parser for the 'dump' tag.
+ *
+ * Dump variables with:
+ * <pre>
+ *  {% dump %}
+ *  {% dump foo %}
+ *  {% dump foo, bar %}
+ * </pre>
+ *
+ * @author Julien Galenski <[email protected]>
+ */
+class DumpTokenParser extends \Twig_TokenParser
+{
+    /**
+     * {@inheritdoc}
+     */
+    public function parse(\Twig_Token $token)
+    {
+        $values = null;
+        if (!$this->parser->getStream()->test(\Twig_Token::BLOCK_END_TYPE)) {
+            $values = $this->parser->getExpressionParser()->parseMultitargetExpression();
+        }
+        $this->parser->getStream()->expect(\Twig_Token::BLOCK_END_TYPE);
+
+        return new DumpNode($values, $token->getLine(), $this->getTag());
+    }
+
+    /**
+     * {@inheritdoc}
+     */
+    public function getTag()
+    {
+        return 'dump';
+    }
+}
diff --git a/src/Symfony/Bridge/Twig/composer.json b/src/Symfony/Bridge/Twig/composer.json
@@ -30,6 +30,7 @@
         "symfony/security": "~2.4",
         "symfony/stopwatch": "~2.2",
         "symfony/console": "~2.2",
+        "symfony/var-dumper": "~2.6",
         "symfony/expression-language": "~2.4"
     },
     "suggest": {
@@ -41,6 +42,7 @@
         "symfony/yaml": "For using the YamlExtension",
         "symfony/security": "For using the SecurityExtension",
         "symfony/stopwatch": "For using the StopwatchExtension",
+        "symfony/var-dumper": "For using the DumpExtension",
         "symfony/expression-language": "For using the ExpressionExtension"
     },
     "autoload": {

diff --git a/src/Symfony/Component/Debug/Debug.php b/src/Symfony/Component/Debug/Debug.php
@@ -11,6 +11,11 @@
 
 namespace Symfony\Component\Debug;
 
+use Symfony\Component\VarDumper\Cloner\ExtCloner;
+use Symfony\Component\VarDumper\Cloner\PhpCloner;
+use Symfony\Component\VarDumper\Dumper\CliDumper;
+use Symfony\Component\VarDumper\Dumper\HtmlDumper;
+
 /**
  * Registers all the debug tools.
  *
@@ -19,6 +24,7 @@
 class Debug
 {
     private static $enabled = false;
+    private static $dumpHandler;
 
     /**
      * Enables the debug tools.
@@ -59,4 +65,42 @@ public static function enable($errorReportingLevel = null, $displayErrors = true
 
         DebugClassLoader::enable();
     }
+
+    public static function dump($var)
+    {
+        if (null === self::$dumpHandler) {
+            $cloner = extension_loaded('symfony_debug') ? new ExtCloner() : new PhpCloner();
+            $dumper = 'cli' === PHP_SAPI ? new CliDumper() : new HtmlDumper();
+            self::$dumpHandler = function ($var) use ($cloner, $dumper) {
+                $dumper->dump($cloner->cloneVar($var));
+            };
+        }
+
+        $h = self::$dumpHandler;
+
+        if (is_array($h)) {
+            return $h[0]->{$h[1]}($var);
+        }
+
+        return $h($var);
+    }
+
+    public static function setDumpHandler($callable)
+    {
+        if (!is_callable($callable)) {
+            throw new \InvalidArgumentException('Invalid PHP callback.');
+        }
+
+        $prevHandler = self::$dumpHandler;
+
+        if (is_array($callable)) {
+            if (!is_object($callable[0])) {
+                self::$dumpHandler = $callable[0].'::'.$callable[1];
+            }
+        } else {
+            self::$dumpHandler = $callable;
+        }
+
+        return $prevHandler;
+    }
 }
diff --git a/src/Symfony/Component/Debug/composer.json b/src/Symfony/Component/Debug/composer.json
@@ -20,10 +20,12 @@
         "psr/log": "~1.0"
     },
     "require-dev": {
+        "symfony/var-dumper": "~2.6",
         "symfony/http-kernel": "~2.1",
         "symfony/http-foundation": "~2.1"
     },
     "suggest": {
+        "symfony/var-dumper": "For using Debug::dump()",
         "symfony/http-foundation": "",
         "symfony/http-kernel": ""
     },