Split ServerRequest::session() into getter/setter

Author: Michael Hoffmann

src/Auth/Storage/SessionStorage.php

@@ -67,7 +67,7 @@ class SessionStorage implements StorageInterface
      */
     public function __construct(ServerRequest $request, Response $response, array $config = [])
     {
-        $this->_session = $request->session();
+        $this->_session = $request->getSession();
         $this->setConfig($config);
     }
 

src/Controller/Component/AuthComponent.php

@@ -254,7 +254,7 @@ public function initialize(array $config)
         $controller = $this->_registry->getController();
         $this->eventManager($controller->eventManager());
         $this->response =& $controller->response;
-        $this->session = $controller->request->session();
+        $this->session = $controller->request->getSession();
     }
 
     /**

src/Controller/Component/FlashComponent.php

@@ -60,7 +60,7 @@ class FlashComponent extends Component
     public function __construct(ComponentRegistry $registry, array $config = [])
     {
         parent::__construct($registry, $config);
-        $this->_session = $registry->getController()->request->session();
+        $this->_session = $registry->getController()->request->getSession();
     }
 
     /**

src/Controller/Component/SecurityComponent.php

@@ -100,7 +100,7 @@ class SecurityComponent extends Component
     public function startup(Event $event)
     {
         $controller = $event->getSubject();
-        $this->session = $controller->request->session();
+        $this->session = $controller->request->getSession();
         $this->_action = $controller->request->getParam('action');
         $hasData = (bool)$controller->request->getData();
         try {

src/Http/ServerRequest.php

@@ -514,12 +514,40 @@ public function contentType()
         return $this->env('HTTP_CONTENT_TYPE');
     }
 
+    /**
+     * Update the request with a new session instance.
+     *
+     * Returns an updated request object. This method returns
+     * a *new* request object and does not mutate the request in-place.
+     *
+     * @param \Cake\Network\Session $session the session object to use
+     * @return static
+     */
+    public function withSession(Session $session)
+    {
+        $new = clone $this;
+        $new->session = $session;
+
+        return $new;
+    }
+
+    /**
+     * Returns the instance of the Session object for this request
+     *
+     * @return \Cake\Network\Session
+     */
+    public function getSession()
+    {
+        return $this->session;
+    }
+
     /**
      * Returns the instance of the Session object for this request
      *
      * If a session object is passed as first argument it will be set as
      * the session to use for this request
      *
+     * @deprecated 3.5.0 Use getSession()/withSession() instead.
      * @param \Cake\Network\Session|null $session the session object to use
      * @return \Cake\Network\Session
      */

src/View/Helper/FlashHelper.php

@@ -70,7 +70,7 @@ class FlashHelper extends Helper
      */
     public function render($key = 'flash', array $options = [])
     {
-        if (!$this->request->session()->check("Flash.$key")) {
+        if (!$this->request->getSession()->check("Flash.$key")) {
             return null;
         }
 
@@ -81,7 +81,7 @@ public function render($key = 'flash', array $options = [])
                 $key
             ));
         }
-        $this->request->session()->delete("Flash.$key");
+        $this->request->getSession()->delete("Flash.$key");
 
         $out = '';
         foreach ($flash as $message) {

src/View/Helper/SessionHelper.php

@@ -54,7 +54,7 @@ public function __construct(View $View, array $config = [])
      */
     public function read($name = null)
     {
-        return $this->request->session()->read($name);
+        return $this->request->getSession()->read($name);
     }
 
     /**
@@ -70,7 +70,7 @@ public function read($name = null)
      */
     public function check($name)
     {
-        return $this->request->session()->check($name);
+        return $this->request->getSession()->check($name);
     }
 
     /**

tests/TestCase/Http/ServerRequestTest.php

@@ -3178,6 +3178,35 @@ public function testSession()
         $this->assertEquals($session, $request->session());
     }
 
+    /**
+     * Tests getting the session from the request
+     *
+     * @return void
+     */
+    public function testGetSession()
+    {
+        $session = new Session;
+        $request = new ServerRequest(['session' => $session]);
+        $this->assertSame($session, $request->getSession());
+
+        $request = ServerRequestFactory::fromGlobals();
+        $this->assertEquals($session, $request->getSession());
+    }
+
+    /**
+     * Tests setting the session to the request
+     *
+     * @return void
+     */
+    public function testWithtSession()
+    {
+        $session = new Session;
+        $request = new ServerRequest();
+        $newRequest = $request->withSession($session);
+        $this->assertNotSame($newRequest, $request);
+        $this->assertSame($session, $newRequest->getSession());
+    }
+
     /**
      * Test the content type method.
      *