merged branch WouterJ/stopwatch_php (PR #8968)

fabpot · fabpot · commit 3e370f66a54f · 2013-09-12T06:30:13.000+02:00
This PR was merged into the master branch. Discussion ---------- Added Stopwatch helper for PHP templates | Q | A | ------------- | --- | Bug fix? | no | New feature? | yes | BC breaks? | no | Deprecations? | no | Tests pass? | yes | Fixed tickets | - | License | MIT | Doc PR | symfony/symfony-docs#2960 Commits ------- 3ee2989 Added Stopwatch Helper
diff --git a/src/Symfony/Bundle/FrameworkBundle/CHANGELOG.md b/src/Symfony/Bundle/FrameworkBundle/CHANGELOG.md
@@ -5,6 +5,7 @@ CHANGELOG
 -----
 
  * allowed multiple IP addresses in profiler matcher settings
+ * added stopwatch helper to time templates with the WebProfilerBundle
 
 2.3.0
 -----
diff --git a/src/Symfony/Bundle/FrameworkBundle/Resources/config/templating_php.xml b/src/Symfony/Bundle/FrameworkBundle/Resources/config/templating_php.xml
@@ -15,6 +15,7 @@
         <parameter key="templating.helper.code.class">Symfony\Bundle\FrameworkBundle\Templating\Helper\CodeHelper</parameter>
         <parameter key="templating.helper.translator.class">Symfony\Bundle\FrameworkBundle\Templating\Helper\TranslatorHelper</parameter>
         <parameter key="templating.helper.form.class">Symfony\Bundle\FrameworkBundle\Templating\Helper\FormHelper</parameter>
+        <parameter key="templating.helper.stopwatch.class">Symfony\Bundle\FrameworkBundle\Templating\Helper\StopwatchHelper</parameter>
         <parameter key="templating.form.engine.class">Symfony\Component\Form\Extension\Templating\TemplatingRendererEngine</parameter>
         <parameter key="templating.form.renderer.class">Symfony\Component\Form\FormRenderer</parameter>
         <parameter key="templating.globals.class">Symfony\Bundle\FrameworkBundle\Templating\GlobalVariables</parameter>
@@ -101,6 +102,11 @@
             <argument type="service" id="templating.form.renderer" />
         </service>
 
+        <service id="templating.helper.stopwatch" class="%templating.helper.stopwatch.class%">
+            <tag name="templating.helper" alias="stopwatch" />
+            <argument type="service" id="debug.stopwatch" on-invalid="ignore" />
+        </service>
+
         <service id="templating.form.engine" class="%templating.form.engine.class%" public="false">
             <argument type="service" id="templating.engine.php" />
             <argument>%templating.helper.form.resources%</argument>
diff --git a/src/Symfony/Bundle/FrameworkBundle/Templating/Helper/StopwatchHelper.php b/src/Symfony/Bundle/FrameworkBundle/Templating/Helper/StopwatchHelper.php
@@ -0,0 +1,46 @@
+<?php
+
+/*
+ * This file is part of the Symfony package.
+ *
+ * (c) Fabien Potencier <fabien@symfony.com>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+namespace Symfony\Bundle\FrameworkBundle\Templating\Helper;
+
+use Symfony\Component\Stopwatch\Stopwatch;
+use Symfony\Component\Templating\Helper\Helper;
+
+/**
+ * StopwatchHelper provides methods time your PHP templates.
+ *
+ * @author Wouter J <wouter@wouterj.nl>
+ */
+class StopwatchHelper extends Helper
+{
+    private $stopwatch;
+
+    public function __construct(Stopwatch $stopwatch = null)
+    {
+        $this->stopwatch = $stopwatch;
+    }
+
+    public function getName()
+    {
+        return 'stopwatch';
+    }
+
+    public function __call($method, $arguments = array())
+    {
+        if (null !== $this->stopwatch) {
+            if (method_exists($this->stopwatch, $method)) {
+                return call_user_func_array(array($this->stopwatch, $method), $arguments);
+            }
+
+            throw new \BadMethodCallException(sprintf('Method "%s" of Stopwatch does not exist', $method));
+        }
+    }
+}
diff --git a/src/Symfony/Bundle/FrameworkBundle/Tests/Templating/Helper/StopwatchHelperTest.php b/src/Symfony/Bundle/FrameworkBundle/Tests/Templating/Helper/StopwatchHelperTest.php
@@ -0,0 +1,39 @@
+<?php
+
+/*
+ * This file is part of the Symfony package.
+ *
+ * (c) Fabien Potencier <fabien@symfony.com>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+namespace Symfony\Bundle\FrameworkBundle\Tests\Templating\Helper;
+
+use Symfony\Bundle\FrameworkBundle\Templating\Helper\StopwatchHelper;
+
+class StopwatchHelperTest extends \PHPUnit_Framework_TestCase
+{
+    public function testDevEnvironment()
+    {
+        $stopwatch = $this->getMock('Symfony\Component\Stopwatch\Stopwatch');
+        $stopwatch->expects($this->once())
+            ->method('start')
+            ->with('foo');
+
+        $helper = new StopwatchHelper($stopwatch);
+        $helper->start('foo');
+    }
+
+    public function testProdEnvironment()
+    {
+        $helper = new StopwatchHelper(null);
+
+        try {
+            $helper->start('foo');
+        } catch (\BadMethodCallException $e) {
+            $this->fail('Assumed stopwatch is not called when not provided');
+        }
+    }
+}
