Merge pull request #6556 from kenjis/fix-ResponseInterface

fix: ResponseInterface (1)

Author: kenjis

system/CodeIgniter.php

@@ -138,6 +138,8 @@ class CodeIgniter
      * to keep from setting headers/cookies/etc
      *
      * @var bool
+     *
+     * @deprecated No longer used.
      */
     protected $useSafeOutput = false;
 
@@ -340,7 +342,7 @@ public function run(?RouteCollectionInterface $routes = null, bool $returnRespon
                 return $response;
             }
 
-            $this->response->pretend($this->useSafeOutput)->send();
+            $this->response->send();
             $this->callExit(EXIT_SUCCESS);
 
             return;
@@ -371,6 +373,8 @@ public function run(?RouteCollectionInterface $routes = null, bool $returnRespon
      * not complain when ini_set() function is used.
      *
      * @return $this
+     *
+     * @deprecated No longer used.
      */
     public function useSafeOutput(bool $safe = true)
     {
@@ -433,7 +437,7 @@ protected function handleRequest(?RouteCollectionInterface $routes, Cache $cache
 
         // If a ResponseInterface instance is returned then send it back to the client and stop
         if ($possibleResponse instanceof ResponseInterface) {
-            return $returnResponse ? $possibleResponse : $possibleResponse->pretend($this->useSafeOutput)->send();
+            return $returnResponse ? $possibleResponse : $possibleResponse->send();
         }
 
         if ($possibleResponse instanceof Request) {
@@ -1057,7 +1061,7 @@ public function spoofRequestMethod()
      */
     protected function sendResponse()
     {
-        $this->response->pretend($this->useSafeOutput)->send();
+        $this->response->send();
     }
 
     /**

system/HTTP/MessageInterface.php

@@ -27,6 +27,15 @@ interface MessageInterface
      */
     public function setBody($data);
 
+    /**
+     * Gets the body of the message.
+     *
+     * @return string|null
+     *
+     * @TODO Incompatible return type with PSR-7
+     */
+    public function getBody();
+
     /**
      * Appends data to the body of the current message.
      *
@@ -48,6 +57,17 @@ public function populateHeaders(): void;
      */
     public function headers(): array;
 
+    /**
+     * Checks if a header exists by the given case-insensitive name.
+     *
+     * @param string $name Case-insensitive header field name.
+     *
+     * @return bool Returns true if any header names match the given header
+     *              name using a case-insensitive string comparison. Returns false if
+     *              no matching header name is found in the message.
+     */
+    public function hasHeader(string $name): bool;
+
     /**
      * Returns a single Header object. If multiple headers with the same
      * name exist, then will return an array of header objects.
@@ -58,6 +78,19 @@ public function headers(): array;
      */
     public function header($name);
 
+    /**
+     * Retrieves a comma-separated string of the values for a single header.
+     *
+     * This method returns all of the header values of the given
+     * case-insensitive header name as a string concatenated together using
+     * a comma.
+     *
+     * NOTE: Not all header values may be appropriately represented using
+     * comma concatenation. For such headers, use getHeader() instead
+     * and supply your own delimiter when concatenating.
+     */
+    public function getHeaderLine(string $name): string;
+
     /**
      * Sets a header and it's value.
      *

system/HTTP/Response.php

@@ -188,10 +188,13 @@ public function __construct($config)
 
     /**
      * Turns "pretend" mode on or off to aid in testing.
+     *
      * Note that this is not a part of the interface so
      * should not be relied on outside of internal testing.
      *
      * @return $this
+     *
+     * @testTag only available to test code
      */
     public function pretend(bool $pretend = true)
     {

system/HTTP/ResponseInterface.php

@@ -28,10 +28,8 @@
  * - Status code and reason phrase
  * - Headers
  * - Message body
- *
- * @mixin RedirectResponse
  */
-interface ResponseInterface
+interface ResponseInterface extends MessageInterface
 {
     /**
      * Constants for status codes.
@@ -130,7 +128,7 @@ public function getStatusCode(): int;
      *                       provided status code; if none is provided, will
      *                       default to the IANA name.
      *
-     * @return self
+     * @return $this
      *
      * @throws InvalidArgumentException For invalid status code arguments.
      */
@@ -153,7 +151,7 @@ public function getReason(): string;
     /**
      * Sets the date header
      *
-     * @return ResponseInterface
+     * @return $this
      */
     public function setDate(DateTime $date);
 
@@ -164,6 +162,8 @@ public function setDate(DateTime $date);
      * preferably, an instance of DateTime.
      *
      * @param DateTime|string $date
+     *
+     * @return $this
      */
     public function setLastModified($date);
 
@@ -172,7 +172,7 @@ public function setLastModified($date);
      *
      * @see http://tools.ietf.org/html/rfc5988
      *
-     * @return Response
+     * @return $this
      *
      * @todo Recommend moving to Pager
      */
@@ -182,7 +182,7 @@ public function setLink(PagerInterface $pager);
      * Sets the Content Type header for this response with the mime type
      * and, optionally, the charset.
      *
-     * @return ResponseInterface
+     * @return $this
      */
     public function setContentType(string $mime, string $charset = 'UTF-8');
 
@@ -202,7 +202,7 @@ public function setJSON($body, bool $unencoded = false);
     /**
      * Returns the current body, converted to JSON is it isn't already.
      *
-     * @return mixed|string
+     * @return bool|string|null
      *
      * @throws InvalidArgumentException If the body property is not array.
      */
@@ -220,7 +220,7 @@ public function setXML($body);
     /**
      * Retrieves the current body into XML and returns it.
      *
-     * @return mixed|string
+     * @return bool|string|null
      *
      * @throws InvalidArgumentException If the body property is not array.
      */
@@ -235,6 +235,8 @@ public function getXML();
     /**
      * Sets the appropriate headers to ensure this response
      * is not cached by the browsers.
+     *
+     * @return $this
      */
     public function noCache();
 
@@ -262,7 +264,7 @@ public function noCache();
      *  - proxy-revalidate
      *  - no-transform
      *
-     * @return ResponseInterface
+     * @return $this
      */
     public function setCache(array $options = []);
 
@@ -273,21 +275,21 @@ public function setCache(array $options = []);
     /**
      * Sends the output to the browser.
      *
-     * @return ResponseInterface
+     * @return $this
      */
     public function send();
 
     /**
      * Sends the headers of this HTTP request to the browser.
      *
-     * @return Response
+     * @return $this
      */
     public function sendHeaders();
 
     /**
      * Sends the Body of the message to the browser.
      *
-     * @return Response
+     * @return $this
      */
     public function sendBody();
 

system/HTTP/ResponseTrait.php

@@ -252,7 +252,7 @@ public function setJSON($body, bool $unencoded = false)
     /**
      * Returns the current body, converted to JSON is it isn't already.
      *
-     * @return mixed|string
+     * @return bool|string|null
      *
      * @throws InvalidArgumentException If the body property is not array.
      */
@@ -284,7 +284,7 @@ public function setXML($body)
     /**
      * Retrieves the current body into XML and returns it.
      *
-     * @return mixed|string
+     * @return bool|string|null
      *
      * @throws InvalidArgumentException If the body property is not array.
      */
@@ -430,7 +430,7 @@ public function setLastModified($date)
     /**
      * Sends the output to the browser.
      *
-     * @return Response
+     * @return $this
      */
     public function send()
     {