[HttpKernel] added PostResponseEvent dispatching to HttpKernel

vagrant · vagrant · commit 2a61714df690 · 2011-12-06T11:18:45.000-08:00
diff --git a/src/Symfony/Component/HttpKernel/HttpKernel.php b/src/Symfony/Component/HttpKernel/HttpKernel.php
@@ -30,7 +30,7 @@
  *
  * @api
  */
-class HttpKernel implements HttpKernelInterface
+class HttpKernel implements HttpKernelInterface, TerminableInterface
 {
     private $dispatcher;
     private $resolver;
@@ -79,6 +79,19 @@ public function handle(Request $request, $type = HttpKernelInterface::MASTER_REQ
         }
     }
 
+    /**
+     * Terminates a request/response cycle.
+     *
+     * Should be called after sending the response and before shutting down the kernel.
+     *
+     * @api
+     */
+    public function terminate()
+    {
+        $event = new PostResponseEvent($this);
+        $this->dispatcher->dispatch(KernelEvents::TERMINATE, $event);
+    }
+
     /**
      * Handles a request to convert it to a response.
      *
diff --git a/src/Symfony/Component/HttpKernel/Kernel.php b/src/Symfony/Component/HttpKernel/Kernel.php
@@ -143,6 +143,13 @@ public function boot()
      */
     public function terminate()
     {
+        if (false === $this->booted) {
+            return;
+        }
+
+        if ($this->getHttpKernel() instanceof TerminableInterface) {
+            $this->getHttpKernel()->terminate();
+        }
     }
 
     /**
diff --git a/tests/Symfony/Tests/Component/HttpKernel/HttpCache/HttpCacheTest.php b/tests/Symfony/Tests/Component/HttpKernel/HttpCache/HttpCacheTest.php
@@ -35,7 +35,7 @@ public function testTerminateDelegatesTerminationOnlyForTerminableInterface()
         $kernel = new HttpCache($kernelMock, $storeMock);
         $kernel->terminate();
 
-        // does implement TerminableInterface
+        // implements TerminableInterface
         $kernelMock = $this->getMockBuilder('Symfony\\Component\\HttpKernel\\Kernel')
             ->disableOriginalConstructor()
             ->setMethods(array('terminate', 'registerBundles', 'registerContainerConfiguration'))
diff --git a/tests/Symfony/Tests/Component/HttpKernel/HttpKernelTest.php b/tests/Symfony/Tests/Component/HttpKernel/HttpKernelTest.php
@@ -164,6 +164,20 @@ public function testHandleWithAResponseListener()
         $this->assertEquals('foo', $kernel->handle(new Request())->getContent());
     }
 
+    public function testTerminate()
+    {
+        $dispatcher = new EventDispatcher();
+        $kernel = new HttpKernel($dispatcher, $this->getResolver());
+        $dispatcher->addListener(KernelEvents::TERMINATE, function ($event) use (&$called, &$capturedKernel) {
+            $called = true;
+            $capturedKernel = $event->getKernel();
+        });
+
+        $kernel->terminate();
+        $this->assertTrue($called);
+        $this->assertEquals($kernel, $capturedKernel);
+    }
+
     protected function getResolver($controller = null)
     {
         if (null === $controller) {
diff --git a/tests/Symfony/Tests/Component/HttpKernel/KernelTest.php b/tests/Symfony/Tests/Component/HttpKernel/KernelTest.php
@@ -652,6 +652,66 @@ public function testInitializeBundleThrowsExceptionWhenABundleExtendsItself()
         $kernel->initializeBundles();
     }
 
+    public function testTerminateReturnsSilentlyIfKernelIsNotBooted()
+    {
+        $kernel = $this->getMockBuilder('Symfony\Tests\Component\HttpKernel\KernelForTest')
+            ->disableOriginalConstructor()
+            ->setMethods(array('getHttpKernel'))
+            ->getMock();
+
+        $kernel->expects($this->never())
+            ->method('getHttpKernel');
+
+        $kernel->setIsBooted(false);
+        $kernel->terminate();
+    }
+
+    public function testTerminateDelegatesTerminationOnlyForTerminableInterface()
+    {
+        // does not implement TerminableInterface
+        $httpKernelMock = $this->getMockBuilder('Symfony\Component\HttpKernel\HttpKernelInterface')
+            ->disableOriginalConstructor()
+            ->getMock();
+
+        $httpKernelMock
+            ->expects($this->never())
+            ->method('terminate');
+
+        $kernel = $this->getMockBuilder('Symfony\Tests\Component\HttpKernel\KernelForTest')
+            ->disableOriginalConstructor()
+            ->setMethods(array('getHttpKernel'))
+            ->getMock();
+
+        $kernel->expects($this->once())
+            ->method('getHttpKernel')
+            ->will($this->returnValue($httpKernelMock));
+
+        $kernel->setIsBooted(true);
+        $kernel->terminate();
+
+        // implements TerminableInterface
+        $httpKernelMock = $this->getMockBuilder('Symfony\Component\HttpKernel\HttpKernel')
+            ->disableOriginalConstructor()
+            ->setMethods(array('terminate'))
+            ->getMock();
+
+        $httpKernelMock
+            ->expects($this->once())
+            ->method('terminate');
+
+        $kernel = $this->getMockBuilder('Symfony\Tests\Component\HttpKernel\KernelForTest')
+            ->disableOriginalConstructor()
+            ->setMethods(array('getHttpKernel'))
+            ->getMock();
+
+        $kernel->expects($this->exactly(2))
+            ->method('getHttpKernel')
+            ->will($this->returnValue($httpKernelMock));
+
+        $kernel->setIsBooted(true);
+        $kernel->terminate();
+    }
+
     protected function getBundle($dir = null, $parent = null, $className = null, $bundleName = null)
     {
         $bundle = $this

Original file line number	Diff line number	Diff line change
`@@ -30,7 +30,7 @@`
`30`	`30`	`*`
`31`	`31`	`* @api`
`32`	`32`	`*/`
`33`		`-class HttpKernel implements HttpKernelInterface`
	`33`	`+class HttpKernel implements HttpKernelInterface, TerminableInterface`
`34`	`34`	`{`
`35`	`35`	`private $dispatcher;`
`36`	`36`	`private $resolver;`
`@@ -79,6 +79,19 @@ public function handle(Request $request, $type = HttpKernelInterface::MASTER_REQ`
`79`	`79`	`}`
`80`	`80`	`}`
`81`	`81`
	`82`	`+ /**`
	`83`	`+ * Terminates a request/response cycle.`
	`84`	`+ *`
	`85`	`+ * Should be called after sending the response and before shutting down the kernel.`
	`86`	`+ *`
	`87`	`+ * @api`
	`88`	`+ */`
	`89`	`+ public function terminate()`
	`90`	`+ {`
	`91`	`+ $event = new PostResponseEvent($this);`
	`92`	`+ $this->dispatcher->dispatch(KernelEvents::TERMINATE, $event);`
	`93`	`+ }`
	`94`	`+`
`82`	`95`	`/**`
`83`	`96`	`* Handles a request to convert it to a response.`
`84`	`97`	`*`
Original file line number	Diff line number	Diff line change
`@@ -143,6 +143,13 @@ public function boot()`
`143`	`143`	`*/`
`144`	`144`	`public function terminate()`
`145`	`145`	`{`
	`146`	`+ if (false === $this->booted) {`
	`147`	`+ return;`
	`148`	`+ }`
	`149`	`+`
	`150`	`+ if ($this->getHttpKernel() instanceof TerminableInterface) {`
	`151`	`+ $this->getHttpKernel()->terminate();`
	`152`	`+ }`
`146`	`153`	`}`
`147`	`154`
`148`	`155`	`/**`