refactor: Remove deprecated RedirectException (#9399)

* refacror: Remove CodeIgniter\Router\Exceptions\RedirectException * docs: Update changelog, userguide
codeigniter4 · Jan 11, 2025 · f67bc68 · f67bc68
1 parent 1f7e106
commit f67bc68
Show file tree

Hide file tree

Showing 7 changed files with 6 additions and 70 deletions.
diff --git a/system/CodeIgniter.php b/system/CodeIgniter.php
@@ -29,7 +29,6 @@
 use CodeIgniter\HTTP\ResponsableInterface;
 use CodeIgniter\HTTP\ResponseInterface;
 use CodeIgniter\HTTP\URI;
-use CodeIgniter\Router\Exceptions\RedirectException as DeprecatedRedirectException;
 use CodeIgniter\Router\RouteCollectionInterface;
 use CodeIgniter\Router\Router;
 use Config\App;
@@ -353,11 +352,8 @@ public function run(?RouteCollectionInterface $routes = null, bool $returnRespon
         } else {
             try {
                 $this->response = $this->handleRequest($routes, config(Cache::class), $returnResponse);
-            } catch (DeprecatedRedirectException|ResponsableInterface $e) {
+            } catch (ResponsableInterface $e) {
                 $this->outputBufferingEnd();
-                if ($e instanceof DeprecatedRedirectException) {
-                    $e = new RedirectException($e->getMessage(), $e->getCode(), $e);
-                }
 
                 $this->response = $e->getResponse();
             } catch (PageNotFoundException $e) {

diff --git a/system/Router/Exceptions/RedirectException.php b/system/Router/Exceptions/RedirectException.php
diff --git a/tests/system/CodeIgniterTest.php b/tests/system/CodeIgniterTest.php
@@ -19,7 +19,6 @@
 use CodeIgniter\Exceptions\PageNotFoundException;
 use CodeIgniter\HTTP\Method;
 use CodeIgniter\HTTP\Response;
-use CodeIgniter\Router\Exceptions\RedirectException;
 use CodeIgniter\Router\RouteCollection;
 use CodeIgniter\Test\CIUnitTestCase;
 use CodeIgniter\Test\Filters\CITestStreamFilter;
@@ -600,29 +599,6 @@ public function testRunRedirectionWithPOSTAndHTTPCode301(): void
         $this->assertSame(301, $response->getStatusCode());
     }
 
-    /**
-     * test for deprecated \CodeIgniter\Router\Exceptions\RedirectException for backward compatibility
-     */
-    public function testRedirectExceptionDeprecated(): void
-    {
-        $_SERVER['argv'] = ['index.php', '/'];
-        $_SERVER['argc'] = 2;
-
-        // Inject mock router.
-        $routes = service('routes');
-        $routes->get('/', static function (): never {
-            throw new RedirectException('redirect-exception', 503);
-        });
-
-        $router = service('router', $routes, service('incomingrequest'));
-        Services::injectMock('router', $router);
-
-        $response = $this->codeigniter->run($routes, true);
-
-        $this->assertSame(503, $response->getStatusCode());
-        $this->assertSame('http://example.com/redirect-exception', $response->getHeaderLine('Location'));
-    }
-
     public function testStoresPreviousURL(): void
     {
         $_SERVER['argv'] = ['index.php', '/'];

diff --git a/user_guide_src/source/changelogs/v4.6.0.rst b/user_guide_src/source/changelogs/v4.6.0.rst
@@ -198,6 +198,7 @@ Removed Deprecated Items
 - **Logger:** The deprecated ``CodeIgniter\Log\Logger::cleanFilenames()`` and
   ``CodeIgniter\Test\TestLogger::cleanup()`` have been removed. Use the
   ``clean_path()`` function instead.
+  **Router:** The deprecated ``CodeIgniter\Router\Exceptions\RedirectException`` has been removed. Use ``CodeIgniter\HTTP\Exceptions\RedirectException`` instead.
 
 ************
 Enhancements

diff --git a/user_guide_src/source/general/errors.rst b/user_guide_src/source/general/errors.rst
@@ -209,7 +209,7 @@ RedirectException
 
 .. note:: Since v4.4.0, the namespace of ``RedirectException`` has been changed.
     Previously it was ``CodeIgniter\Router\Exceptions\RedirectException``. The
-    previous class is deprecated.
+    previous class has been removed in v4.6.0.
 
 This exception is a special case allowing for overriding of all other response routing and
 forcing a redirect to a specific URI:

diff --git a/utils/phpstan-baseline/codeigniter.superglobalAccessAssign.neon b/utils/phpstan-baseline/codeigniter.superglobalAccessAssign.neon
@@ -164,12 +164,12 @@ parameters:
 
         -
             message: '#^Assigning 2 directly on offset ''argc'' of \$_SERVER is discouraged\.$#'
-            count: 27
+            count: 26
             path: ../../tests/system/CodeIgniterTest.php
 
         -
             message: '#^Assigning array\{''index\.php'', ''/''\} directly on offset ''argv'' of \$_SERVER is discouraged\.$#'
-            count: 12
+            count: 11
             path: ../../tests/system/CodeIgniterTest.php
 
         -

diff --git a/utils/phpstan-baseline/property.phpDocType.neon b/utils/phpstan-baseline/property.phpDocType.neon
@@ -1,4 +1,4 @@
-# total 48 errors
+# total 47 errors
 
 parameters:
     ignoreErrors:
@@ -172,11 +172,6 @@ parameters:
             count: 1
             path: ../../system/Images/Handlers/ImageMagickHandler.php
 
-        -
-            message: '#^PHPDoc type int of property CodeIgniter\\Router\\Exceptions\\RedirectException\:\:\$code is not the same as PHPDoc type mixed of overridden property Exception\:\:\$code\.$#'
-            count: 1
-            path: ../../system/Router/Exceptions/RedirectException.php
-
         -
             message: '#^PHPDoc type string of property CodeIgniter\\Session\\Handlers\\FileHandler\:\:\$savePath is not the same as PHPDoc type array\|string of overridden property CodeIgniter\\Session\\Handlers\\BaseHandler\:\:\$savePath\.$#'
             count: 1