[GH-7707] Added tests for RequestStack and documentation for new clas…

…ses.
symfony · beberlei · Apr 18, 2013 · Apr 18, 2013 · Apr 30, 2013 · Apr 30, 2013
commit 0ef36646355c0aa9448f538c2f1a627904ceb43e
diff --git a/src/Symfony/Component/HttpKernel/Event/RequestFinishedEvent.php b/src/Symfony/Component/HttpKernel/Event/RequestFinishedEvent.php
@@ -1,7 +1,21 @@
 <?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\Component\HttpKernel\Event;

+/**
+ * Triggered whenever a request is fully processed.
+ *
+ * @author Benjamin Eberlei <kontakt@beberlei.de>
+ */
 class RequestFinishedEvent extends KernelEvent
 {
 }
diff --git a/src/Symfony/Component/HttpKernel/RequestContext.php b/src/Symfony/Component/HttpKernel/RequestContext.php
@@ -1,5 +1,14 @@
 <?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\Component\HttpKernel;

 /**
@@ -8,6 +17,8 @@
 * Facade for RequestStack that prevents modification of the stack,
 * so that users don't accidentily push()/pop() from the stack and
 * mess up the request cycle.
+ *
+ * @author Benjamin Eberlei <kontakt@beberlei.de>
 */
 class RequestContext
 {

diff --git a/src/Symfony/Component/HttpKernel/RequestStack.php b/src/Symfony/Component/HttpKernel/RequestStack.php
@@ -1,5 +1,14 @@
 <?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\Component\HttpKernel;

 use Symfony\Component\HttpFoundation\Request;
@@ -8,6 +17,8 @@
 * Request stack that controls the lifecycle of requests.
 *
 * Notifies services of changes in the stack.
+ *
+ * @author Benjamin Eberlei <kontakt@beberlei.de>
 */
 class RequestStack
 {
@@ -34,18 +45,22 @@ public function pop()
    }

    /**
-     * @return Request
+     * @return Request|null
     */
    public function getCurrentRequest()
    {
-        return end($this->requests);
+        return end($this->requests) ?: null;
    }

    /**
-     * @return Request
+     * @return Request|null
     */
    public function getMasterRequest()
    {
+        if (!$this->requests) {
+            return null;
+        }
+
        return $this->requests[0];
    }


diff --git a/src/Symfony/Component/HttpKernel/Tests/RequestStackTest.php b/src/Symfony/Component/HttpKernel/Tests/RequestStackTest.php
@@ -0,0 +1,76 @@
+<?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\Component\HttpKernel\Tests;
+
+use Symfony\Component\HttpKernel\RequestStack;
+use Symfony\Component\HttpFoundation\Request;
+
+class RequestStackTest extends \PHPUnit_Framework_TestCase
+{
+    public function testPushThenPopReturnsSameRequest()
+    {
+        $request = Request::create('/');
+
+        $stack = new RequestStack();
+        $stack->push($request);
+
+        $this->assertSame($request, $stack->pop());
+        $this->assertNull($stack->pop());
+    }
+
+    public function testPopEmptyStackReturnsNull()
+    {
+        $stack = new RequestStack();
+
+        $this->assertNull($stack->pop());
+    }
+
+    public function testGetCurrentRequest()
+    {
+        $request = Request::create('/');
+        $stack = new RequestStack();
+
+        $this->assertNull($stack->getCurrentRequest());
+
+        $stack->push($request);
+
+        $this->assertSame($request, $stack->getCurrentRequest());
+        $this->assertSame($request, $stack->getCurrentRequest());
+    }
+
+    public function testGetMasterRequest()
+    {
+        $request = Request::create('/');
+        $stack = new RequestStack();
+
+        $this->assertNull($stack->getMasterRequest());
+
+        $stack->push($request);
+
+        $this->assertSame($request, $stack->getMasterRequest());
+        $this->assertSame($request, $stack->getMasterRequest());
+    }
+
+    public function testGetParentRequest()
+    {
+        $request = Request::create('/');
+        $subrequest = Request::create('/');
+
+        $stack = new RequestStack();
+        $stack->push($request);
+        $stack->push($subrequest);
+
+        $this->assertSame($request, $stack->getParentRequest());
+        $this->assertSame($subrequest, $stack->pop());
+        $this->assertSame($request, $stack->pop());
+    }
+}
-Original file line number
+Diff line change
@@ -1,5 +1,14 @@
     <?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\Component\HttpKernel;
     /**
@@ -8,6 +17,8 @@
      * Facade for RequestStack that prevents modification of the stack,
      * so that users don't accidentily push()/pop() from the stack and
             Copy link

  
      
    
  

  
      

  
    Contributor


      

  

  
    
      

      
            pborreli
  

      

      

      


        Apr 30, 2013


      
    

  


        
      
  
  
  
    

    There was a problem hiding this comment.


  

 
  
    

    Choose a reason for hiding this comment

    
      The reason will be displayed to describe this comment to others. Learn more.
    

    
      
      


  


  
    
      accidently
    
  
  


    

        
      
  
  
    
  
  
  
    
    Sorry, something went wrong.
  

  
    
  
    
      

              Uh oh!

              
There was an error while loading. Please reload this page.


  
  


          
      
  
    
    
      
        
            
    All reactions
  


          
          
        
      
    

    



  
        
  
    
        
    
  


      
          
  
      
            Copy link

  
      
    
  

  
      

  
    Contributor


      

  

  
    
      

      
            jameshalsall
  

      

      

      


        Apr 30, 2013


      
    

  


        
      
  
  
  
    

    There was a problem hiding this comment.


  

 
  
    

    Choose a reason for hiding this comment

    
      The reason will be displayed to describe this comment to others. Learn more.
    

    
      
      


  


  
    
      accidentally
    
  
  


    

        
      
  
  
    
  
  
  
    
    Sorry, something went wrong.
  

  
    
  
    
      

              Uh oh!

              
There was an error while loading. Please reload this page.


  
  


          
      
  
    
    
      
        
            
    All reactions
      * mess up the request cycle.
+     *
+     * @author Benjamin Eberlei <kontakt@beberlei.de>
      */
     class RequestContext
     {
-          Expand Down