Merge pull request #8050 from kenjis/refactor-CodeIgniter

refactor: remove deprecated properties and methods in CodeIgniter class
codeigniter4 · Oct 20, 2023 · 091abaf · 091abaf
2 parents 52fcf76 + dd952f4
commit 091abaf
Show file tree

Hide file tree

Showing 4 changed files with 32 additions and 68 deletions.
diff --git a/phpstan-baseline.php b/phpstan-baseline.php
@@ -183,7 +183,7 @@
 ];
 $ignoreErrors[] = [
 	'message' => '#^Construct empty\\(\\) is not allowed\\. Use more strict comparison\\.$#',
-	'count' => 6,
+	'count' => 5,
 	'path' => __DIR__ . '/system/CodeIgniter.php',
 ];
 $ignoreErrors[] = [

diff --git a/system/CodeIgniter.php b/system/CodeIgniter.php
@@ -135,25 +135,6 @@ class CodeIgniter
      */
     protected static $cacheTTL = 0;
 
-    /**
-     * Request path to use.
-     *
-     * @var string
-     *
-     * @deprecated No longer used.
-     */
-    protected $path;
-
-    /**
-     * Should the Response instance "pretend"
-     * to keep from setting headers/cookies/etc
-     *
-     * @var bool
-     *
-     * @deprecated No longer used.
-     */
-    protected $useSafeOutput = false;
-
     /**
      * Context
      *  web:     Invoked by HTTP request
@@ -171,7 +152,7 @@ class CodeIgniter
     /**
      * Whether to return Response object or send response.
      *
-     * @deprecated No longer used.
+     * @deprecated 4.4.0 No longer used.
      */
     protected bool $returnResponse = false;
 
@@ -336,6 +317,8 @@ private function configureKint(): void
      * tries to route the response, loads the controller and generally
      * makes all the pieces work together.
      *
+     * @param bool $returnResponse Used for testing purposes only.
+     *
      * @return ResponseInterface|void
      */
     public function run(?RouteCollectionInterface $routes = null, bool $returnResponse = false)
@@ -355,9 +338,9 @@ public function run(?RouteCollectionInterface $routes = null, bool $returnRespon
         $this->getRequestObject();
         $this->getResponseObject();
 
-        $this->spoofRequestMethod();
-
         try {
+            $this->forceSecureAccess();
+
             $this->response = $this->handleRequest($routes, config(Cache::class), $returnResponse);
         } catch (ResponsableInterface|DeprecatedRedirectException $e) {
             $this->outputBufferingEnd();
@@ -381,22 +364,6 @@ public function run(?RouteCollectionInterface $routes = null, bool $returnRespon
         $this->sendResponse();
     }
 
-    /**
-     * Set our Response instance to "pretend" mode so that things like
-     * cookies and headers are not actually sent, allowing PHP 7.2+ to
-     * not complain when ini_set() function is used.
-     *
-     * @return $this
-     *
-     * @deprecated No longer used.
-     */
-    public function useSafeOutput(bool $safe = true)
-    {
-        $this->useSafeOutput = $safe;
-
-        return $this;
-    }
-
     /**
      * Invoked via php-cli command?
      */
@@ -433,8 +400,6 @@ public function disableFilters(): void
      */
     protected function handleRequest(?RouteCollectionInterface $routes, Cache $cacheConfig, bool $returnResponse = false)
     {
-        $this->forceSecureAccess();
-
         if ($this->request instanceof IncomingRequest && strtolower($this->request->getMethod()) === 'cli') {
             return $this->response->setStatusCode(405)->setBody('Method Not Allowed');
         }
@@ -449,7 +414,7 @@ protected function handleRequest(?RouteCollectionInterface $routes, Cache $cache
 
         $routeFilters = $this->tryToRouteIt($routes);
 
-        $uri = $this->determinePath();
+        $uri = $this->request->getPath();
 
         if ($this->enableFilters) {
             // Start up the filters
@@ -621,6 +586,9 @@ protected function startBenchmark()
      * @param CLIRequest|IncomingRequest $request
      *
      * @return $this
+     *
+     * @internal Used for testing purposes only.
+     * @testTag
      */
     public function setRequest($request)
     {
@@ -637,6 +605,8 @@ public function setRequest($request)
     protected function getRequestObject()
     {
         if ($this->request instanceof Request) {
+            $this->spoofRequestMethod();
+
             return;
         }
 
@@ -647,6 +617,8 @@ protected function getRequestObject()
         }
 
         $this->request = Services::request();
+
+        $this->spoofRequestMethod();
     }
 
     /**
@@ -808,14 +780,14 @@ protected function tryToRouteIt(?RouteCollectionInterface $routes = null)
         // $routes is defined in Config/Routes.php
         $this->router = Services::router($routes, $this->request);
 
-        $path = $this->determinePath();
+        $uri = $this->request->getPath();
 
         $this->benchmark->stop('bootstrap');
         $this->benchmark->start('routing');
 
         $this->outputBufferingStart();
 
-        $this->controller = $this->router->handle($path);
+        $this->controller = $this->router->handle($uri);
         $this->method     = $this->router->methodName();
 
         // If a {locale} segment was matched in the final route,
@@ -834,31 +806,12 @@ protected function tryToRouteIt(?RouteCollectionInterface $routes = null)
      * on the CLI/IncomingRequest path.
      *
      * @return string
-     */
-    protected function determinePath()
-    {
-        if (! empty($this->path)) {
-            return $this->path;
-        }
-
-        return method_exists($this->request, 'getPath') ? $this->request->getPath() : $this->request->getUri()->getPath();
-    }
-
-    /**
-     * Allows the request path to be set from outside the class,
-     * instead of relying on CLIRequest or IncomingRequest for the path.
-     *
-     * This is not used now.
      *
-     * @return $this
-     *
-     * @deprecated No longer used.
+     * @deprecated 4.5.0 No longer used.
      */
-    public function setPath(string $path)
+    protected function determinePath()
     {
-        $this->path = $path;
-
-        return $this;
+        return $this->request->getPath();
     }
 
     /**

diff --git a/tests/system/CodeIgniterTest.php b/tests/system/CodeIgniterTest.php
@@ -87,7 +87,7 @@ public function testRunEmptyDefaultRouteReturnResponse(): void
         $_SERVER['argv'] = ['index.php'];
         $_SERVER['argc'] = 1;
 
-        $response = $this->codeigniter->useSafeOutput(true)->run(null, true);
+        $response = $this->codeigniter->run(null, true);
 
         $this->assertStringContainsString('Welcome to CodeIgniter', $response->getBody());
     }
@@ -164,7 +164,7 @@ public function testRun404OverrideReturnResponse(): void
         $router = Services::router($routes, Services::incomingrequest());
         Services::injectMock('router', $router);
 
-        $response = $this->codeigniter->useSafeOutput(true)->run($routes, true);
+        $response = $this->codeigniter->run($routes, true);
 
         $this->assertStringContainsString('Oops', $response->getBody());
     }

diff --git a/user_guide_src/source/changelogs/v4.5.0.rst b/user_guide_src/source/changelogs/v4.5.0.rst
@@ -109,6 +109,14 @@ Model
 - ``Model::idValue()``
 - ``Model::classToArray()``
 
+CodeIgniter
+-----------
+
+- ``$path``
+- ``$useSafeOutput``
+- ``useSafeOutput()``
+- ``setPath()``
+
 Enhancements
 ************
 
@@ -169,6 +177,9 @@ Changes
 Deprecations
 ************
 
+- **CodeIgniter:** The ``determinePath()`` method has been deprecated. No longer
+  used.
+
 Bugs Fixed
 **********