Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Original file line numberDiff line numberDiff line change
Expand Up@@ -76,18 +76,37 @@ public function read(string $class, string $defaultController = 'Home', string $
);

if ($routeWithoutController !== []) {
// Route for the default controller.
$output = [...$output, ...$routeWithoutController];

continue;
}

$params = [];
$routeParams = '';
$refParams = $method->getParameters();

foreach ($refParams as $param) {
$required = true;
if ($param->isOptional()) {
$required = false;

$routeParams .= '[/..]';
} else {
$routeParams .= '/..';
}

// [variable_name => required?]
$params[$param->getName()] = $required;
}

// Route for the default method.
$output[] = [
'method' => $httpVerb,
'route' => $classInUri,
'route_params' => '',
'route_params' => $routeParams,
'handler' => '\\' . $classname . '::' . $methodName,
'params' => [],
'params' => $params,
];

continue;
Expand Down
41 changes: 32 additions & 9 deletions system/Router/AutoRouterImproved.php
Original file line numberDiff line numberDiff line change
Expand Up@@ -12,6 +12,7 @@
namespace CodeIgniter\Router;

use CodeIgniter\Exceptions\PageNotFoundException;
use CodeIgniter\Router\Exceptions\MethodNotFoundException;
use ReflectionClass;
use ReflectionException;

Expand DownExpand Up@@ -168,17 +169,30 @@ public function getRoute(string $uri): array
'\\'
);

// Ensure routes registered via $routes->cli() are not accessible via web.
// Ensure the controller is not defined in routes.
$this->protectDefinedRoutes();

// Check _remap()
// Ensure the controller does not have _remap() method.
$this->checkRemap();

// Check parameters
// Check parameter count
try {
$this->checkParameters($uri);
} catch (ReflectionException $e) {
throw PageNotFoundException::forControllerNotFound($this->controller, $this->method);
} catch (MethodNotFoundException $e) {
// Fallback to the default method
if (! isset($methodSegment)) {
throw PageNotFoundException::forControllerNotFound($this->controller, $this->method);
}

array_unshift($this->params, $methodSegment);
$method = $this->method;
$this->method = $this->defaultMethod;

try {
$this->checkParameters($uri);
} catch (MethodNotFoundException $e) {
throw PageNotFoundException::forControllerNotFound($this->controller, $method);
}
}

return [$this->directory, $this->controller, $this->method, $this->params];
Expand All@@ -201,12 +215,21 @@ private function protectDefinedRoutes(): void

private function checkParameters(string $uri): void
{
$refClass = new ReflectionClass($this->controller);
$refMethod = $refClass->getMethod($this->method);
$refParams = $refMethod->getParameters();
try {
$refClass = new ReflectionClass($this->controller);
} catch (ReflectionException $e) {
throw PageNotFoundException::forControllerNotFound($this->controller, $this->method);
}

try {
$refMethod = $refClass->getMethod($this->method);
$refParams = $refMethod->getParameters();
} catch (ReflectionException $e) {
throw new MethodNotFoundException();
}

if (! $refMethod->isPublic()) {
throw PageNotFoundException::forMethodNotFound($this->method);
throw new MethodNotFoundException();
}

if (count($refParams) < count($this->params)) {
Expand Down
21 changes: 21 additions & 0 deletions system/Router/Exceptions/MethodNotFoundException.php
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
<?php

/**
* This file is part of CodeIgniter 4 framework.
*
* (c) CodeIgniter Foundation <admin@codeigniter.com>
*
* For the full copyright and license information, please view
* the LICENSE file that was distributed with this source code.
*/

namespace CodeIgniter\Router\Exceptions;

use RuntimeException;

/**
* @internal
*/
final class MethodNotFoundException extends RuntimeException
{
}
2 changes: 1 addition & 1 deletion tests/_support/Controllers/Newautorouting.php
Original file line numberDiff line numberDiff line change
Expand Up@@ -15,7 +15,7 @@

class Newautorouting extends Controller
{
public function getIndex()
public function getIndex(string $m = '')
{
return 'Hello';
}
Expand Down
2 changes: 1 addition & 1 deletion tests/system/Commands/RoutesTest.php
Original file line numberDiff line numberDiff line change
Expand Up@@ -129,7 +129,7 @@ public function testRoutesCommandAutoRouteImproved()
| TRACE | testing | testing-index | \App\Controllers\TestController::index | | toolbar |
| CONNECT | testing | testing-index | \App\Controllers\TestController::index | | toolbar |
| CLI | testing | testing-index | \App\Controllers\TestController::index | | |
| GET(auto) | newautorouting | | \Tests\Support\Controllers\Newautorouting::getIndex | | toolbar |
| GET(auto) | newautorouting[/..] | | \Tests\Support\Controllers\Newautorouting::getIndex | | toolbar |
| POST(auto) | newautorouting/save/../..[/..] | | \Tests\Support\Controllers\Newautorouting::postSave | | toolbar |
+------------+--------------------------------+---------------+-----------------------------------------------------+----------------+---------------+
EOL;
Expand Down
Original file line numberDiff line numberDiff line change
Expand Up@@ -62,7 +62,7 @@ public function testGetFilterMatches()
$expected = [
0 => [
'GET(auto)',
'newautorouting',
'newautorouting[/..]',
'',
'\\Tests\\Support\\Controllers\\Newautorouting::getIndex',
'',
Expand DownExpand Up@@ -90,7 +90,7 @@ public function testGetFilterDoesNotMatch()
$expected = [
0 => [
'GET(auto)',
'newautorouting',
'newautorouting[/..]',
'',
'\\Tests\\Support\\Controllers\\Newautorouting::getIndex',
'',
Expand Down
Original file line numberDiff line numberDiff line change
Expand Up@@ -43,9 +43,11 @@ public function testRead()
0 => [
'method' => 'get',
'route' => 'newautorouting',
'route_params' => '',
'route_params' => '[/..]',
'handler' => '\Tests\Support\Controllers\Newautorouting::getIndex',
'params' => [],
'params' => [
'm' => false,
],
],
[
'method' => 'post',
Expand Down
13 changes: 13 additions & 0 deletions tests/system/Router/AutoRouterImprovedTest.php
Original file line numberDiff line numberDiff line change
Expand Up@@ -199,6 +199,19 @@ public function testAutoRouteFindsDefaultDashFolder()
$this->assertSame([], $params);
}

public function testAutoRouteFallbackToDefaultMethod()
{
$router = $this->createNewAutoRouter();

[$directory, $controller, $method, $params]
= $router->getRoute('index/15');

$this->assertNull($directory);
$this->assertSame('\\' . Index::class, $controller);
$this->assertSame('getIndex', $method);
$this->assertSame(['15'], $params);
}

public function testAutoRouteRejectsSingleDot()
{
$this->expectException(PageNotFoundException::class);
Expand Down
2 changes: 1 addition & 1 deletion tests/system/Router/Controllers/Index.php
Original file line numberDiff line numberDiff line change
Expand Up@@ -15,7 +15,7 @@

class Index extends Controller
{
public function getIndex()
public function getIndex($p1 = '')
{
}

Expand Down
5 changes: 4 additions & 1 deletion user_guide_src/source/changelogs/v4.4.0.rst
Original file line numberDiff line numberDiff line change
Expand Up@@ -58,8 +58,11 @@ Helpers and Functions

Others
======
- **View:** Added optional 2nd parameter ``$saveData`` on ``renderSection()`` to prevent from auto cleans the data after displaying. See :ref:`View Layouts <creating-a-layout>` for details.

- **View:** Added optional 2nd parameter ``$saveData`` on ``renderSection()`` to prevent from auto cleans the data after displaying. See :ref:`View Layouts <creating-a-layout>` for details.
- **Auto Routing (Improved)**: Now you can use URI without a method name like
``product/15`` where ``15`` is an arbitrary number.
See :ref:`controller-default-method-fallback` for details.

Message Changes
***************
Expand Down
23 changes: 23 additions & 0 deletions user_guide_src/source/incoming/controllers.rst
Original file line numberDiff line numberDiff line change
Expand Up@@ -263,6 +263,29 @@ Your method will be passed URI segments 3 and 4 (``'sandals'`` and ``'123'``):

.. literalinclude:: controllers/022.php

.. _controller-default-method-fallback:

Default Method Fallback
=======================

.. versionadded:: 4.4.0

If the controller method corresponding to the URI segment of the method name
does not exist, and if the default method is defined, the URI segments are
passed to the default method for execution.

.. literalinclude:: controllers/024.php

Load the following URL::

example.com/index.php/product/15/edit

The method will be passed URI segments 2 and 3 (``'15'`` and ``'edit'``):

.. note:: If there are more parameters in the URI than the method parameters,
Auto Routing (Improved) does not execute the method, and it results in 404
Not Found.

Defining a Default Controller
=============================

Expand Down
11 changes: 11 additions & 0 deletions user_guide_src/source/incoming/controllers/024.php
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
<?php

namespace App\Controllers;

class Product extends BaseController
{
public function getIndex($id = null, $action = '')
{
// ...
}
}
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Add copy buttons to all
 blocks\n(function() {\n function addCopyButtons() {\n document.querySelectorAll('pre code').forEach(function(codeBlock) {\n if (codeBlock.parentElement.hasAttribute('data-copy-added')) return;\n codeBlock.parentElement.setAttribute('data-copy-added', 'true');\n \n var btn = document.createElement('button');\n btn.textContent = 'Copy';\n btn.style.cssText = 'position:absolute;top:4px;right:4px;padding:2px 8px;font-size:11px;background:#4ecdc4;border:none;border-radius:4px;color:#1a1a2e;cursor:pointer;opacity:0.7;transition:opacity 0.2s;';\n btn.onmouseover = function() { this.style.opacity = '1'; };\n btn.onmouseout = function() { this.style.opacity = '0.7'; };\n btn.onclick = function() {\n navigator.clipboard.writeText(codeBlock.textContent).then(function() {\n btn.textContent = 'Copied!';\n setTimeout(function() { btn.textContent = 'Copy'; }, 1500);\n });\n };\n codeBlock.parentElement.style.position = 'relative';\n codeBlock.parentElement.appendChild(btn);\n });\n }\n \n addCopyButtons();\n \n // Re-run on dynamic content\n var observer = new MutationObserver(addCopyButtons);\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "Add Copy Buttons to Code Blocks");
}
} catch(__e) { console.warn('[Userscript:Add Copy Buttons to Code Blocks]', __e); }
})();
(function(){
try {
var __m = "github.com";
var __re = new RegExp('^' + "github\\.com" + '
Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Original file line numberDiff line numberDiff line change
Expand Up@@ -76,18 +76,37 @@ public function read(string $class, string $defaultController = 'Home', string $
);

if ($routeWithoutController !== []) {
// Route for the default controller.
$output = [...$output, ...$routeWithoutController];

continue;
}

$params = [];
$routeParams = '';
$refParams = $method->getParameters();

foreach ($refParams as $param) {
$required = true;
if ($param->isOptional()) {
$required = false;

$routeParams .= '[/..]';
} else {
$routeParams .= '/..';
}

// [variable_name => required?]
$params[$param->getName()] = $required;
}

// Route for the default method.
$output[] = [
'method' => $httpVerb,
'route' => $classInUri,
'route_params' => '',
'route_params' => $routeParams,
'handler' => '\\' . $classname . '::' . $methodName,
'params' => [],
'params' => $params,
];

continue;
Expand Down
41 changes: 32 additions & 9 deletions system/Router/AutoRouterImproved.php
Original file line numberDiff line numberDiff line change
Expand Up@@ -12,6 +12,7 @@
namespace CodeIgniter\Router;

use CodeIgniter\Exceptions\PageNotFoundException;
use CodeIgniter\Router\Exceptions\MethodNotFoundException;
use ReflectionClass;
use ReflectionException;

Expand DownExpand Up@@ -168,17 +169,30 @@ public function getRoute(string $uri): array
'\\'
);

// Ensure routes registered via $routes->cli() are not accessible via web.
// Ensure the controller is not defined in routes.
$this->protectDefinedRoutes();

// Check _remap()
// Ensure the controller does not have _remap() method.
$this->checkRemap();

// Check parameters
// Check parameter count
try {
$this->checkParameters($uri);
} catch (ReflectionException $e) {
throw PageNotFoundException::forControllerNotFound($this->controller, $this->method);
} catch (MethodNotFoundException $e) {
// Fallback to the default method
if (! isset($methodSegment)) {
throw PageNotFoundException::forControllerNotFound($this->controller, $this->method);
}

array_unshift($this->params, $methodSegment);
$method = $this->method;
$this->method = $this->defaultMethod;

try {
$this->checkParameters($uri);
} catch (MethodNotFoundException $e) {
throw PageNotFoundException::forControllerNotFound($this->controller, $method);
}
}

return [$this->directory, $this->controller, $this->method, $this->params];
Expand All@@ -201,12 +215,21 @@ private function protectDefinedRoutes(): void

private function checkParameters(string $uri): void
{
$refClass = new ReflectionClass($this->controller);
$refMethod = $refClass->getMethod($this->method);
$refParams = $refMethod->getParameters();
try {
$refClass = new ReflectionClass($this->controller);
} catch (ReflectionException $e) {
throw PageNotFoundException::forControllerNotFound($this->controller, $this->method);
}

try {
$refMethod = $refClass->getMethod($this->method);
$refParams = $refMethod->getParameters();
} catch (ReflectionException $e) {
throw new MethodNotFoundException();
}

if (! $refMethod->isPublic()) {
throw PageNotFoundException::forMethodNotFound($this->method);
throw new MethodNotFoundException();
}

if (count($refParams) < count($this->params)) {
Expand Down
21 changes: 21 additions & 0 deletions system/Router/Exceptions/MethodNotFoundException.php
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
<?php

/**
* This file is part of CodeIgniter 4 framework.
*
* (c) CodeIgniter Foundation <admin@codeigniter.com>
*
* For the full copyright and license information, please view
* the LICENSE file that was distributed with this source code.
*/

namespace CodeIgniter\Router\Exceptions;

use RuntimeException;

/**
* @internal
*/
final class MethodNotFoundException extends RuntimeException
{
}
2 changes: 1 addition & 1 deletion tests/_support/Controllers/Newautorouting.php
Original file line numberDiff line numberDiff line change
Expand Up@@ -15,7 +15,7 @@

class Newautorouting extends Controller
{
public function getIndex()
public function getIndex(string $m = '')
{
return 'Hello';
}
Expand Down
2 changes: 1 addition & 1 deletion tests/system/Commands/RoutesTest.php
Original file line numberDiff line numberDiff line change
Expand Up@@ -129,7 +129,7 @@ public function testRoutesCommandAutoRouteImproved()
| TRACE | testing | testing-index | \App\Controllers\TestController::index | | toolbar |
| CONNECT | testing | testing-index | \App\Controllers\TestController::index | | toolbar |
| CLI | testing | testing-index | \App\Controllers\TestController::index | | |
| GET(auto) | newautorouting | | \Tests\Support\Controllers\Newautorouting::getIndex | | toolbar |
| GET(auto) | newautorouting[/..] | | \Tests\Support\Controllers\Newautorouting::getIndex | | toolbar |
| POST(auto) | newautorouting/save/../..[/..] | | \Tests\Support\Controllers\Newautorouting::postSave | | toolbar |
+------------+--------------------------------+---------------+-----------------------------------------------------+----------------+---------------+
EOL;
Expand Down
Original file line numberDiff line numberDiff line change
Expand Up@@ -62,7 +62,7 @@ public function testGetFilterMatches()
$expected = [
0 => [
'GET(auto)',
'newautorouting',
'newautorouting[/..]',
'',
'\\Tests\\Support\\Controllers\\Newautorouting::getIndex',
'',
Expand DownExpand Up@@ -90,7 +90,7 @@ public function testGetFilterDoesNotMatch()
$expected = [
0 => [
'GET(auto)',
'newautorouting',
'newautorouting[/..]',
'',
'\\Tests\\Support\\Controllers\\Newautorouting::getIndex',
'',
Expand Down
Original file line numberDiff line numberDiff line change
Expand Up@@ -43,9 +43,11 @@ public function testRead()
0 => [
'method' => 'get',
'route' => 'newautorouting',
'route_params' => '',
'route_params' => '[/..]',
'handler' => '\Tests\Support\Controllers\Newautorouting::getIndex',
'params' => [],
'params' => [
'm' => false,
],
],
[
'method' => 'post',
Expand Down
13 changes: 13 additions & 0 deletions tests/system/Router/AutoRouterImprovedTest.php
Original file line numberDiff line numberDiff line change
Expand Up@@ -199,6 +199,19 @@ public function testAutoRouteFindsDefaultDashFolder()
$this->assertSame([], $params);
}

public function testAutoRouteFallbackToDefaultMethod()
{
$router = $this->createNewAutoRouter();

[$directory, $controller, $method, $params]
= $router->getRoute('index/15');

$this->assertNull($directory);
$this->assertSame('\\' . Index::class, $controller);
$this->assertSame('getIndex', $method);
$this->assertSame(['15'], $params);
}

public function testAutoRouteRejectsSingleDot()
{
$this->expectException(PageNotFoundException::class);
Expand Down
2 changes: 1 addition & 1 deletion tests/system/Router/Controllers/Index.php
Original file line numberDiff line numberDiff line change
Expand Up@@ -15,7 +15,7 @@

class Index extends Controller
{
public function getIndex()
public function getIndex($p1 = '')
{
}

Expand Down
5 changes: 4 additions & 1 deletion user_guide_src/source/changelogs/v4.4.0.rst
Original file line numberDiff line numberDiff line change
Expand Up@@ -58,8 +58,11 @@ Helpers and Functions

Others
======
- **View:** Added optional 2nd parameter ``$saveData`` on ``renderSection()`` to prevent from auto cleans the data after displaying. See :ref:`View Layouts <creating-a-layout>` for details.

- **View:** Added optional 2nd parameter ``$saveData`` on ``renderSection()`` to prevent from auto cleans the data after displaying. See :ref:`View Layouts <creating-a-layout>` for details.
- **Auto Routing (Improved)**: Now you can use URI without a method name like
``product/15`` where ``15`` is an arbitrary number.
See :ref:`controller-default-method-fallback` for details.

Message Changes
***************
Expand Down
23 changes: 23 additions & 0 deletions user_guide_src/source/incoming/controllers.rst
Original file line numberDiff line numberDiff line change
Expand Up@@ -263,6 +263,29 @@ Your method will be passed URI segments 3 and 4 (``'sandals'`` and ``'123'``):

.. literalinclude:: controllers/022.php

.. _controller-default-method-fallback:

Default Method Fallback
=======================

.. versionadded:: 4.4.0

If the controller method corresponding to the URI segment of the method name
does not exist, and if the default method is defined, the URI segments are
passed to the default method for execution.

.. literalinclude:: controllers/024.php

Load the following URL::

example.com/index.php/product/15/edit

The method will be passed URI segments 2 and 3 (``'15'`` and ``'edit'``):

.. note:: If there are more parameters in the URI than the method parameters,
Auto Routing (Improved) does not execute the method, and it results in 404
Not Found.

Defining a Default Controller
=============================

Expand Down
11 changes: 11 additions & 0 deletions user_guide_src/source/incoming/controllers/024.php
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
<?php

namespace App\Controllers;

class Product extends BaseController
{
public function getIndex($id = null, $action = '')
{
// ...
}
}
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Force GitHub README to respect dark mode\n(function() {\n var style = document.createElement('style');\n style.textContent = '\n .markdown-body {\n color-scheme: dark light;\n }\n .markdown-body pre { background: #161b22 !important; }\n .markdown-body code { background: rgba(110, 118, 129, 0.4) !important; }\n .markdown-body table th, .markdown-body table td { border-color: #30363d !important; }\n .markdown-body img { background: #0d1117; }\n .markdown-body blockquote { border-left-color: #8b949e; }\n .markdown-body hr { border-color: #30363d; }\n ';\n document.head.appendChild(style);\n})();", "GitHub Dark Mode README Fix"); } } catch(__e) { console.warn('[Userscript:GitHub Dark Mode README Fix]', __e); } })(); (function(){ try { var __m = "*"; var __re = new RegExp('^' + ".*" + '
Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Original file line numberDiff line numberDiff line change
Expand Up@@ -76,18 +76,37 @@ public function read(string $class, string $defaultController = 'Home', string $
);

if ($routeWithoutController !== []) {
// Route for the default controller.
$output = [...$output, ...$routeWithoutController];

continue;
}

$params = [];
$routeParams = '';
$refParams = $method->getParameters();

foreach ($refParams as $param) {
$required = true;
if ($param->isOptional()) {
$required = false;

$routeParams .= '[/..]';
} else {
$routeParams .= '/..';
}

// [variable_name => required?]
$params[$param->getName()] = $required;
}

// Route for the default method.
$output[] = [
'method' => $httpVerb,
'route' => $classInUri,
'route_params' => '',
'route_params' => $routeParams,
'handler' => '\\' . $classname . '::' . $methodName,
'params' => [],
'params' => $params,
];

continue;
Expand Down
41 changes: 32 additions & 9 deletions system/Router/AutoRouterImproved.php
Original file line numberDiff line numberDiff line change
Expand Up@@ -12,6 +12,7 @@
namespace CodeIgniter\Router;

use CodeIgniter\Exceptions\PageNotFoundException;
use CodeIgniter\Router\Exceptions\MethodNotFoundException;
use ReflectionClass;
use ReflectionException;

Expand DownExpand Up@@ -168,17 +169,30 @@ public function getRoute(string $uri): array
'\\'
);

// Ensure routes registered via $routes->cli() are not accessible via web.
// Ensure the controller is not defined in routes.
$this->protectDefinedRoutes();

// Check _remap()
// Ensure the controller does not have _remap() method.
$this->checkRemap();

// Check parameters
// Check parameter count
try {
$this->checkParameters($uri);
} catch (ReflectionException $e) {
throw PageNotFoundException::forControllerNotFound($this->controller, $this->method);
} catch (MethodNotFoundException $e) {
// Fallback to the default method
if (! isset($methodSegment)) {
throw PageNotFoundException::forControllerNotFound($this->controller, $this->method);
}

array_unshift($this->params, $methodSegment);
$method = $this->method;
$this->method = $this->defaultMethod;

try {
$this->checkParameters($uri);
} catch (MethodNotFoundException $e) {
throw PageNotFoundException::forControllerNotFound($this->controller, $method);
}
}

return [$this->directory, $this->controller, $this->method, $this->params];
Expand All@@ -201,12 +215,21 @@ private function protectDefinedRoutes(): void

private function checkParameters(string $uri): void
{
$refClass = new ReflectionClass($this->controller);
$refMethod = $refClass->getMethod($this->method);
$refParams = $refMethod->getParameters();
try {
$refClass = new ReflectionClass($this->controller);
} catch (ReflectionException $e) {
throw PageNotFoundException::forControllerNotFound($this->controller, $this->method);
}

try {
$refMethod = $refClass->getMethod($this->method);
$refParams = $refMethod->getParameters();
} catch (ReflectionException $e) {
throw new MethodNotFoundException();
}

if (! $refMethod->isPublic()) {
throw PageNotFoundException::forMethodNotFound($this->method);
throw new MethodNotFoundException();
}

if (count($refParams) < count($this->params)) {
Expand Down
21 changes: 21 additions & 0 deletions system/Router/Exceptions/MethodNotFoundException.php
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
<?php

/**
* This file is part of CodeIgniter 4 framework.
*
* (c) CodeIgniter Foundation <admin@codeigniter.com>
*
* For the full copyright and license information, please view
* the LICENSE file that was distributed with this source code.
*/

namespace CodeIgniter\Router\Exceptions;

use RuntimeException;

/**
* @internal
*/
final class MethodNotFoundException extends RuntimeException
{
}
2 changes: 1 addition & 1 deletion tests/_support/Controllers/Newautorouting.php
Original file line numberDiff line numberDiff line change
Expand Up@@ -15,7 +15,7 @@

class Newautorouting extends Controller
{
public function getIndex()
public function getIndex(string $m = '')
{
return 'Hello';
}
Expand Down
2 changes: 1 addition & 1 deletion tests/system/Commands/RoutesTest.php
Original file line numberDiff line numberDiff line change
Expand Up@@ -129,7 +129,7 @@ public function testRoutesCommandAutoRouteImproved()
| TRACE | testing | testing-index | \App\Controllers\TestController::index | | toolbar |
| CONNECT | testing | testing-index | \App\Controllers\TestController::index | | toolbar |
| CLI | testing | testing-index | \App\Controllers\TestController::index | | |
| GET(auto) | newautorouting | | \Tests\Support\Controllers\Newautorouting::getIndex | | toolbar |
| GET(auto) | newautorouting[/..] | | \Tests\Support\Controllers\Newautorouting::getIndex | | toolbar |
| POST(auto) | newautorouting/save/../..[/..] | | \Tests\Support\Controllers\Newautorouting::postSave | | toolbar |
+------------+--------------------------------+---------------+-----------------------------------------------------+----------------+---------------+
EOL;
Expand Down
Original file line numberDiff line numberDiff line change
Expand Up@@ -62,7 +62,7 @@ public function testGetFilterMatches()
$expected = [
0 => [
'GET(auto)',
'newautorouting',
'newautorouting[/..]',
'',
'\\Tests\\Support\\Controllers\\Newautorouting::getIndex',
'',
Expand DownExpand Up@@ -90,7 +90,7 @@ public function testGetFilterDoesNotMatch()
$expected = [
0 => [
'GET(auto)',
'newautorouting',
'newautorouting[/..]',
'',
'\\Tests\\Support\\Controllers\\Newautorouting::getIndex',
'',
Expand Down
Original file line numberDiff line numberDiff line change
Expand Up@@ -43,9 +43,11 @@ public function testRead()
0 => [
'method' => 'get',
'route' => 'newautorouting',
'route_params' => '',
'route_params' => '[/..]',
'handler' => '\Tests\Support\Controllers\Newautorouting::getIndex',
'params' => [],
'params' => [
'm' => false,
],
],
[
'method' => 'post',
Expand Down
13 changes: 13 additions & 0 deletions tests/system/Router/AutoRouterImprovedTest.php
Original file line numberDiff line numberDiff line change
Expand Up@@ -199,6 +199,19 @@ public function testAutoRouteFindsDefaultDashFolder()
$this->assertSame([], $params);
}

public function testAutoRouteFallbackToDefaultMethod()
{
$router = $this->createNewAutoRouter();

[$directory, $controller, $method, $params]
= $router->getRoute('index/15');

$this->assertNull($directory);
$this->assertSame('\\' . Index::class, $controller);
$this->assertSame('getIndex', $method);
$this->assertSame(['15'], $params);
}

public function testAutoRouteRejectsSingleDot()
{
$this->expectException(PageNotFoundException::class);
Expand Down
2 changes: 1 addition & 1 deletion tests/system/Router/Controllers/Index.php
Original file line numberDiff line numberDiff line change
Expand Up@@ -15,7 +15,7 @@

class Index extends Controller
{
public function getIndex()
public function getIndex($p1 = '')
{
}

Expand Down
5 changes: 4 additions & 1 deletion user_guide_src/source/changelogs/v4.4.0.rst
Original file line numberDiff line numberDiff line change
Expand Up@@ -58,8 +58,11 @@ Helpers and Functions

Others
======
- **View:** Added optional 2nd parameter ``$saveData`` on ``renderSection()`` to prevent from auto cleans the data after displaying. See :ref:`View Layouts <creating-a-layout>` for details.

- **View:** Added optional 2nd parameter ``$saveData`` on ``renderSection()`` to prevent from auto cleans the data after displaying. See :ref:`View Layouts <creating-a-layout>` for details.
- **Auto Routing (Improved)**: Now you can use URI without a method name like
``product/15`` where ``15`` is an arbitrary number.
See :ref:`controller-default-method-fallback` for details.

Message Changes
***************
Expand Down
23 changes: 23 additions & 0 deletions user_guide_src/source/incoming/controllers.rst
Original file line numberDiff line numberDiff line change
Expand Up@@ -263,6 +263,29 @@ Your method will be passed URI segments 3 and 4 (``'sandals'`` and ``'123'``):

.. literalinclude:: controllers/022.php

.. _controller-default-method-fallback:

Default Method Fallback
=======================

.. versionadded:: 4.4.0

If the controller method corresponding to the URI segment of the method name
does not exist, and if the default method is defined, the URI segments are
passed to the default method for execution.

.. literalinclude:: controllers/024.php

Load the following URL::

example.com/index.php/product/15/edit

The method will be passed URI segments 2 and 3 (``'15'`` and ``'edit'``):

.. note:: If there are more parameters in the URI than the method parameters,
Auto Routing (Improved) does not execute the method, and it results in 404
Not Found.

Defining a Default Controller
=============================

Expand Down
11 changes: 11 additions & 0 deletions user_guide_src/source/incoming/controllers/024.php
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
<?php

namespace App\Controllers;

class Product extends BaseController
{
public function getIndex($id = null, $action = '')
{
// ...
}
}
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Highlight search terms from Google/DuckDuckGo/Bing referrer\n(function() {\n var ref = document.referrer;\n var terms = [];\n \n if (ref.includes('google.com') || ref.includes('duckduckgo.com') || ref.includes('bing.com')) {\n var url = new URL(ref);\n var q = url.searchParams.get('q') || url.searchParams.get('p');\n if (q) {\n terms = q.split(/\\s+/).filter(function(t) { return t.length > 2; });\n }\n }\n \n if (terms.length === 0) return;\n \n var style = document.createElement('style');\n style.textContent = '.userscript-highlight { background: #fbbf24; color: #1a1a2e; padding: 1px 3px; border-radius: 2px; }';\n document.head.appendChild(style);\n \n function highlight(node) {\n if (node.nodeType === 3) { // text node\n var text = node.textContent;\n var found = false;\n terms.forEach(function(term) {\n var regex = new RegExp('(' + term.replace(/[.*+?^${}()|[\\]\\\\]/g, '\\\\') + ')', 'gi');\n if (regex.test(text)) {\n found = true;\n var frag = document.createDocumentFragment();\n var parts = text.split(regex);\n parts.forEach(function(part, i) {\n if (i % 2 === 0) {\n frag.appendChild(document.createTextNode(part));\n } else {\n var span = document.createElement('span');\n span.className = 'userscript-highlight';\n span.textContent = part;\n frag.appendChild(span);\n }\n });\n node.parentNode.replaceChild(frag, node);\n }\n });\n } else if (node.nodeType === 1 && node.childNodes) { // element\n var skipTags = ['SCRIPT', 'STYLE', 'NOSCRIPT', 'TEXTAREA', 'INPUT', 'SELECT'];\n if (!skipTags.includes(node.tagName)) {\n Array.from(node.childNodes).forEach(highlight);\n }\n }\n }\n \n highlight(document.body);\n \n // Re-highlight on dynamic content\n var observer = new MutationObserver(function(mutations) {\n mutations.forEach(function(m) {\n m.addedNodes.forEach(function(node) {\n if (node.nodeType === 1 || node.nodeType === 3) highlight(node);\n });\n });\n });\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "Highlight Search Terms"); } } catch(__e) { console.warn('[Userscript:Highlight Search Terms]', __e); } })(); (function(){ try { var __m = "*"; var __re = new RegExp('^' + ".*" + '
Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Original file line numberDiff line numberDiff line change
Expand Up@@ -76,18 +76,37 @@ public function read(string $class, string $defaultController = 'Home', string $
);

if ($routeWithoutController !== []) {
// Route for the default controller.
$output = [...$output, ...$routeWithoutController];

continue;
}

$params = [];
$routeParams = '';
$refParams = $method->getParameters();

foreach ($refParams as $param) {
$required = true;
if ($param->isOptional()) {
$required = false;

$routeParams .= '[/..]';
} else {
$routeParams .= '/..';
}

// [variable_name => required?]
$params[$param->getName()] = $required;
}

// Route for the default method.
$output[] = [
'method' => $httpVerb,
'route' => $classInUri,
'route_params' => '',
'route_params' => $routeParams,
'handler' => '\\' . $classname . '::' . $methodName,
'params' => [],
'params' => $params,
];

continue;
Expand Down
41 changes: 32 additions & 9 deletions system/Router/AutoRouterImproved.php
Original file line numberDiff line numberDiff line change
Expand Up@@ -12,6 +12,7 @@
namespace CodeIgniter\Router;

use CodeIgniter\Exceptions\PageNotFoundException;
use CodeIgniter\Router\Exceptions\MethodNotFoundException;
use ReflectionClass;
use ReflectionException;

Expand DownExpand Up@@ -168,17 +169,30 @@ public function getRoute(string $uri): array
'\\'
);

// Ensure routes registered via $routes->cli() are not accessible via web.
// Ensure the controller is not defined in routes.
$this->protectDefinedRoutes();

// Check _remap()
// Ensure the controller does not have _remap() method.
$this->checkRemap();

// Check parameters
// Check parameter count
try {
$this->checkParameters($uri);
} catch (ReflectionException $e) {
throw PageNotFoundException::forControllerNotFound($this->controller, $this->method);
} catch (MethodNotFoundException $e) {
// Fallback to the default method
if (! isset($methodSegment)) {
throw PageNotFoundException::forControllerNotFound($this->controller, $this->method);
}

array_unshift($this->params, $methodSegment);
$method = $this->method;
$this->method = $this->defaultMethod;

try {
$this->checkParameters($uri);
} catch (MethodNotFoundException $e) {
throw PageNotFoundException::forControllerNotFound($this->controller, $method);
}
}

return [$this->directory, $this->controller, $this->method, $this->params];
Expand All@@ -201,12 +215,21 @@ private function protectDefinedRoutes(): void

private function checkParameters(string $uri): void
{
$refClass = new ReflectionClass($this->controller);
$refMethod = $refClass->getMethod($this->method);
$refParams = $refMethod->getParameters();
try {
$refClass = new ReflectionClass($this->controller);
} catch (ReflectionException $e) {
throw PageNotFoundException::forControllerNotFound($this->controller, $this->method);
}

try {
$refMethod = $refClass->getMethod($this->method);
$refParams = $refMethod->getParameters();
} catch (ReflectionException $e) {
throw new MethodNotFoundException();
}

if (! $refMethod->isPublic()) {
throw PageNotFoundException::forMethodNotFound($this->method);
throw new MethodNotFoundException();
}

if (count($refParams) < count($this->params)) {
Expand Down
21 changes: 21 additions & 0 deletions system/Router/Exceptions/MethodNotFoundException.php
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
<?php

/**
* This file is part of CodeIgniter 4 framework.
*
* (c) CodeIgniter Foundation <admin@codeigniter.com>
*
* For the full copyright and license information, please view
* the LICENSE file that was distributed with this source code.
*/

namespace CodeIgniter\Router\Exceptions;

use RuntimeException;

/**
* @internal
*/
final class MethodNotFoundException extends RuntimeException
{
}
2 changes: 1 addition & 1 deletion tests/_support/Controllers/Newautorouting.php
Original file line numberDiff line numberDiff line change
Expand Up@@ -15,7 +15,7 @@

class Newautorouting extends Controller
{
public function getIndex()
public function getIndex(string $m = '')
{
return 'Hello';
}
Expand Down
2 changes: 1 addition & 1 deletion tests/system/Commands/RoutesTest.php
Original file line numberDiff line numberDiff line change
Expand Up@@ -129,7 +129,7 @@ public function testRoutesCommandAutoRouteImproved()
| TRACE | testing | testing-index | \App\Controllers\TestController::index | | toolbar |
| CONNECT | testing | testing-index | \App\Controllers\TestController::index | | toolbar |
| CLI | testing | testing-index | \App\Controllers\TestController::index | | |
| GET(auto) | newautorouting | | \Tests\Support\Controllers\Newautorouting::getIndex | | toolbar |
| GET(auto) | newautorouting[/..] | | \Tests\Support\Controllers\Newautorouting::getIndex | | toolbar |
| POST(auto) | newautorouting/save/../..[/..] | | \Tests\Support\Controllers\Newautorouting::postSave | | toolbar |
+------------+--------------------------------+---------------+-----------------------------------------------------+----------------+---------------+
EOL;
Expand Down
Original file line numberDiff line numberDiff line change
Expand Up@@ -62,7 +62,7 @@ public function testGetFilterMatches()
$expected = [
0 => [
'GET(auto)',
'newautorouting',
'newautorouting[/..]',
'',
'\\Tests\\Support\\Controllers\\Newautorouting::getIndex',
'',
Expand DownExpand Up@@ -90,7 +90,7 @@ public function testGetFilterDoesNotMatch()
$expected = [
0 => [
'GET(auto)',
'newautorouting',
'newautorouting[/..]',
'',
'\\Tests\\Support\\Controllers\\Newautorouting::getIndex',
'',
Expand Down
Original file line numberDiff line numberDiff line change
Expand Up@@ -43,9 +43,11 @@ public function testRead()
0 => [
'method' => 'get',
'route' => 'newautorouting',
'route_params' => '',
'route_params' => '[/..]',
'handler' => '\Tests\Support\Controllers\Newautorouting::getIndex',
'params' => [],
'params' => [
'm' => false,
],
],
[
'method' => 'post',
Expand Down
13 changes: 13 additions & 0 deletions tests/system/Router/AutoRouterImprovedTest.php
Original file line numberDiff line numberDiff line change
Expand Up@@ -199,6 +199,19 @@ public function testAutoRouteFindsDefaultDashFolder()
$this->assertSame([], $params);
}

public function testAutoRouteFallbackToDefaultMethod()
{
$router = $this->createNewAutoRouter();

[$directory, $controller, $method, $params]
= $router->getRoute('index/15');

$this->assertNull($directory);
$this->assertSame('\\' . Index::class, $controller);
$this->assertSame('getIndex', $method);
$this->assertSame(['15'], $params);
}

public function testAutoRouteRejectsSingleDot()
{
$this->expectException(PageNotFoundException::class);
Expand Down
2 changes: 1 addition & 1 deletion tests/system/Router/Controllers/Index.php
Original file line numberDiff line numberDiff line change
Expand Up@@ -15,7 +15,7 @@

class Index extends Controller
{
public function getIndex()
public function getIndex($p1 = '')
{
}

Expand Down
5 changes: 4 additions & 1 deletion user_guide_src/source/changelogs/v4.4.0.rst
Original file line numberDiff line numberDiff line change
Expand Up@@ -58,8 +58,11 @@ Helpers and Functions

Others
======
- **View:** Added optional 2nd parameter ``$saveData`` on ``renderSection()`` to prevent from auto cleans the data after displaying. See :ref:`View Layouts <creating-a-layout>` for details.

- **View:** Added optional 2nd parameter ``$saveData`` on ``renderSection()`` to prevent from auto cleans the data after displaying. See :ref:`View Layouts <creating-a-layout>` for details.
- **Auto Routing (Improved)**: Now you can use URI without a method name like
``product/15`` where ``15`` is an arbitrary number.
See :ref:`controller-default-method-fallback` for details.

Message Changes
***************
Expand Down
23 changes: 23 additions & 0 deletions user_guide_src/source/incoming/controllers.rst
Original file line numberDiff line numberDiff line change
Expand Up@@ -263,6 +263,29 @@ Your method will be passed URI segments 3 and 4 (``'sandals'`` and ``'123'``):

.. literalinclude:: controllers/022.php

.. _controller-default-method-fallback:

Default Method Fallback
=======================

.. versionadded:: 4.4.0

If the controller method corresponding to the URI segment of the method name
does not exist, and if the default method is defined, the URI segments are
passed to the default method for execution.

.. literalinclude:: controllers/024.php

Load the following URL::

example.com/index.php/product/15/edit

The method will be passed URI segments 2 and 3 (``'15'`` and ``'edit'``):

.. note:: If there are more parameters in the URI than the method parameters,
Auto Routing (Improved) does not execute the method, and it results in 404
Not Found.

Defining a Default Controller
=============================

Expand Down
11 changes: 11 additions & 0 deletions user_guide_src/source/incoming/controllers/024.php
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
<?php

namespace App\Controllers;

class Product extends BaseController
{
public function getIndex($id = null, $action = '')
{
// ...
}
}
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Strip utm_, fbclid, gclid, etc. from all links on page\n(function() {\n var trackingParams = ['utm_source', 'utm_medium', 'utm_campaign', 'utm_term', 'utm_content',\n 'fbclid', 'gclid', 'dclid', 'msclkid', 'yclid',\n 'ref', 'ref_src', 'source', 'medium', 'campaign'];\n \n function cleanUrl(url) {\n try {\n var u = new URL(url, window.location.origin);\n var changed = false;\n trackingParams.forEach(function(p) {\n if (u.searchParams.has(p)) {\n u.searchParams.delete(p);\n changed = true;\n }\n });\n return changed ? u.toString() : url;\n } catch (e) {\n return url;\n }\n }\n \n function cleanLinks() {\n document.querySelectorAll('a[href]').forEach(function(a) {\n var clean = cleanUrl(a.href);\n if (clean !== a.href) a.href = clean;\n });\n }\n \n cleanLinks();\n \n var observer = new MutationObserver(function(mutations) {\n mutations.forEach(function(m) {\n m.addedNodes.forEach(function(node) {\n if (node.nodeType === 1) {\n if (node.tagName === 'A') cleanLinks();\n node.querySelectorAll('a[href]').forEach(function(a) {\n var clean = cleanUrl(a.href);\n if (clean !== a.href) a.href = clean;\n });\n }\n });\n });\n });\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "Remove Tracking Parameters from Links"); } } catch(__e) { console.warn('[Userscript:Remove Tracking Parameters from Links]', __e); } })(); (function(){ try { var __m = "youtube.com"; var __re = new RegExp('^' + "youtube\\.com" + '
Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Original file line numberDiff line numberDiff line change
Expand Up@@ -76,18 +76,37 @@ public function read(string $class, string $defaultController = 'Home', string $
);

if ($routeWithoutController !== []) {
// Route for the default controller.
$output = [...$output, ...$routeWithoutController];

continue;
}

$params = [];
$routeParams = '';
$refParams = $method->getParameters();

foreach ($refParams as $param) {
$required = true;
if ($param->isOptional()) {
$required = false;

$routeParams .= '[/..]';
} else {
$routeParams .= '/..';
}

// [variable_name => required?]
$params[$param->getName()] = $required;
}

// Route for the default method.
$output[] = [
'method' => $httpVerb,
'route' => $classInUri,
'route_params' => '',
'route_params' => $routeParams,
'handler' => '\\' . $classname . '::' . $methodName,
'params' => [],
'params' => $params,
];

continue;
Expand Down
41 changes: 32 additions & 9 deletions system/Router/AutoRouterImproved.php
Original file line numberDiff line numberDiff line change
Expand Up@@ -12,6 +12,7 @@
namespace CodeIgniter\Router;

use CodeIgniter\Exceptions\PageNotFoundException;
use CodeIgniter\Router\Exceptions\MethodNotFoundException;
use ReflectionClass;
use ReflectionException;

Expand DownExpand Up@@ -168,17 +169,30 @@ public function getRoute(string $uri): array
'\\'
);

// Ensure routes registered via $routes->cli() are not accessible via web.
// Ensure the controller is not defined in routes.
$this->protectDefinedRoutes();

// Check _remap()
// Ensure the controller does not have _remap() method.
$this->checkRemap();

// Check parameters
// Check parameter count
try {
$this->checkParameters($uri);
} catch (ReflectionException $e) {
throw PageNotFoundException::forControllerNotFound($this->controller, $this->method);
} catch (MethodNotFoundException $e) {
// Fallback to the default method
if (! isset($methodSegment)) {
throw PageNotFoundException::forControllerNotFound($this->controller, $this->method);
}

array_unshift($this->params, $methodSegment);
$method = $this->method;
$this->method = $this->defaultMethod;

try {
$this->checkParameters($uri);
} catch (MethodNotFoundException $e) {
throw PageNotFoundException::forControllerNotFound($this->controller, $method);
}
}

return [$this->directory, $this->controller, $this->method, $this->params];
Expand All@@ -201,12 +215,21 @@ private function protectDefinedRoutes(): void

private function checkParameters(string $uri): void
{
$refClass = new ReflectionClass($this->controller);
$refMethod = $refClass->getMethod($this->method);
$refParams = $refMethod->getParameters();
try {
$refClass = new ReflectionClass($this->controller);
} catch (ReflectionException $e) {
throw PageNotFoundException::forControllerNotFound($this->controller, $this->method);
}

try {
$refMethod = $refClass->getMethod($this->method);
$refParams = $refMethod->getParameters();
} catch (ReflectionException $e) {
throw new MethodNotFoundException();
}

if (! $refMethod->isPublic()) {
throw PageNotFoundException::forMethodNotFound($this->method);
throw new MethodNotFoundException();
}

if (count($refParams) < count($this->params)) {
Expand Down
21 changes: 21 additions & 0 deletions system/Router/Exceptions/MethodNotFoundException.php
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
<?php

/**
* This file is part of CodeIgniter 4 framework.
*
* (c) CodeIgniter Foundation <admin@codeigniter.com>
*
* For the full copyright and license information, please view
* the LICENSE file that was distributed with this source code.
*/

namespace CodeIgniter\Router\Exceptions;

use RuntimeException;

/**
* @internal
*/
final class MethodNotFoundException extends RuntimeException
{
}
2 changes: 1 addition & 1 deletion tests/_support/Controllers/Newautorouting.php
Original file line numberDiff line numberDiff line change
Expand Up@@ -15,7 +15,7 @@

class Newautorouting extends Controller
{
public function getIndex()
public function getIndex(string $m = '')
{
return 'Hello';
}
Expand Down
2 changes: 1 addition & 1 deletion tests/system/Commands/RoutesTest.php
Original file line numberDiff line numberDiff line change
Expand Up@@ -129,7 +129,7 @@ public function testRoutesCommandAutoRouteImproved()
| TRACE | testing | testing-index | \App\Controllers\TestController::index | | toolbar |
| CONNECT | testing | testing-index | \App\Controllers\TestController::index | | toolbar |
| CLI | testing | testing-index | \App\Controllers\TestController::index | | |
| GET(auto) | newautorouting | | \Tests\Support\Controllers\Newautorouting::getIndex | | toolbar |
| GET(auto) | newautorouting[/..] | | \Tests\Support\Controllers\Newautorouting::getIndex | | toolbar |
| POST(auto) | newautorouting/save/../..[/..] | | \Tests\Support\Controllers\Newautorouting::postSave | | toolbar |
+------------+--------------------------------+---------------+-----------------------------------------------------+----------------+---------------+
EOL;
Expand Down
Original file line numberDiff line numberDiff line change
Expand Up@@ -62,7 +62,7 @@ public function testGetFilterMatches()
$expected = [
0 => [
'GET(auto)',
'newautorouting',
'newautorouting[/..]',
'',
'\\Tests\\Support\\Controllers\\Newautorouting::getIndex',
'',
Expand DownExpand Up@@ -90,7 +90,7 @@ public function testGetFilterDoesNotMatch()
$expected = [
0 => [
'GET(auto)',
'newautorouting',
'newautorouting[/..]',
'',
'\\Tests\\Support\\Controllers\\Newautorouting::getIndex',
'',
Expand Down
Original file line numberDiff line numberDiff line change
Expand Up@@ -43,9 +43,11 @@ public function testRead()
0 => [
'method' => 'get',
'route' => 'newautorouting',
'route_params' => '',
'route_params' => '[/..]',
'handler' => '\Tests\Support\Controllers\Newautorouting::getIndex',
'params' => [],
'params' => [
'm' => false,
],
],
[
'method' => 'post',
Expand Down
13 changes: 13 additions & 0 deletions tests/system/Router/AutoRouterImprovedTest.php
Original file line numberDiff line numberDiff line change
Expand Up@@ -199,6 +199,19 @@ public function testAutoRouteFindsDefaultDashFolder()
$this->assertSame([], $params);
}

public function testAutoRouteFallbackToDefaultMethod()
{
$router = $this->createNewAutoRouter();

[$directory, $controller, $method, $params]
= $router->getRoute('index/15');

$this->assertNull($directory);
$this->assertSame('\\' . Index::class, $controller);
$this->assertSame('getIndex', $method);
$this->assertSame(['15'], $params);
}

public function testAutoRouteRejectsSingleDot()
{
$this->expectException(PageNotFoundException::class);
Expand Down
2 changes: 1 addition & 1 deletion tests/system/Router/Controllers/Index.php
Original file line numberDiff line numberDiff line change
Expand Up@@ -15,7 +15,7 @@

class Index extends Controller
{
public function getIndex()
public function getIndex($p1 = '')
{
}

Expand Down
5 changes: 4 additions & 1 deletion user_guide_src/source/changelogs/v4.4.0.rst
Original file line numberDiff line numberDiff line change
Expand Up@@ -58,8 +58,11 @@ Helpers and Functions

Others
======
- **View:** Added optional 2nd parameter ``$saveData`` on ``renderSection()`` to prevent from auto cleans the data after displaying. See :ref:`View Layouts <creating-a-layout>` for details.

- **View:** Added optional 2nd parameter ``$saveData`` on ``renderSection()`` to prevent from auto cleans the data after displaying. See :ref:`View Layouts <creating-a-layout>` for details.
- **Auto Routing (Improved)**: Now you can use URI without a method name like
``product/15`` where ``15`` is an arbitrary number.
See :ref:`controller-default-method-fallback` for details.

Message Changes
***************
Expand Down
23 changes: 23 additions & 0 deletions user_guide_src/source/incoming/controllers.rst
Original file line numberDiff line numberDiff line change
Expand Up@@ -263,6 +263,29 @@ Your method will be passed URI segments 3 and 4 (``'sandals'`` and ``'123'``):

.. literalinclude:: controllers/022.php

.. _controller-default-method-fallback:

Default Method Fallback
=======================

.. versionadded:: 4.4.0

If the controller method corresponding to the URI segment of the method name
does not exist, and if the default method is defined, the URI segments are
passed to the default method for execution.

.. literalinclude:: controllers/024.php

Load the following URL::

example.com/index.php/product/15/edit

The method will be passed URI segments 2 and 3 (``'15'`` and ``'edit'``):

.. note:: If there are more parameters in the URI than the method parameters,
Auto Routing (Improved) does not execute the method, and it results in 404
Not Found.

Defining a Default Controller
=============================

Expand Down
11 changes: 11 additions & 0 deletions user_guide_src/source/incoming/controllers/024.php
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
<?php

namespace App\Controllers;

class Product extends BaseController
{
public function getIndex($id = null, $action = '')
{
// ...
}
}
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Auto-enable theater mode on YouTube\n(function() {\n function tryTheater() {\n var btn = document.querySelector('button[aria-label=\"Theater mode\"], ytd-player #player button[title=\"Theater mode\"]');\n if (btn && !btn.classList.contains('activated')) {\n btn.click();\n }\n }\n \n // Try immediately\n tryTheater();\n \n // Try after navigation (SPA)\n var lastUrl = location.href;\n setInterval(function() {\n if (location.href !== lastUrl) {\n lastUrl = location.href;\n setTimeout(tryTheater, 500);\n }\n }, 1000);\n \n // Also try on player load\n var observer = new MutationObserver(tryTheater);\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "YouTube Theater Mode Default"); } } catch(__e) { console.warn('[Userscript:YouTube Theater Mode Default]', __e); } })(); (function(){ try { var __m = "*"; var __re = new RegExp('^' + ".*" + '
Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Original file line numberDiff line numberDiff line change
Expand Up@@ -76,18 +76,37 @@ public function read(string $class, string $defaultController = 'Home', string $
);

if ($routeWithoutController !== []) {
// Route for the default controller.
$output = [...$output, ...$routeWithoutController];

continue;
}

$params = [];
$routeParams = '';
$refParams = $method->getParameters();

foreach ($refParams as $param) {
$required = true;
if ($param->isOptional()) {
$required = false;

$routeParams .= '[/..]';
} else {
$routeParams .= '/..';
}

// [variable_name => required?]
$params[$param->getName()] = $required;
}

// Route for the default method.
$output[] = [
'method' => $httpVerb,
'route' => $classInUri,
'route_params' => '',
'route_params' => $routeParams,
'handler' => '\\' . $classname . '::' . $methodName,
'params' => [],
'params' => $params,
];

continue;
Expand Down
41 changes: 32 additions & 9 deletions system/Router/AutoRouterImproved.php
Original file line numberDiff line numberDiff line change
Expand Up@@ -12,6 +12,7 @@
namespace CodeIgniter\Router;

use CodeIgniter\Exceptions\PageNotFoundException;
use CodeIgniter\Router\Exceptions\MethodNotFoundException;
use ReflectionClass;
use ReflectionException;

Expand DownExpand Up@@ -168,17 +169,30 @@ public function getRoute(string $uri): array
'\\'
);

// Ensure routes registered via $routes->cli() are not accessible via web.
// Ensure the controller is not defined in routes.
$this->protectDefinedRoutes();

// Check _remap()
// Ensure the controller does not have _remap() method.
$this->checkRemap();

// Check parameters
// Check parameter count
try {
$this->checkParameters($uri);
} catch (ReflectionException $e) {
throw PageNotFoundException::forControllerNotFound($this->controller, $this->method);
} catch (MethodNotFoundException $e) {
// Fallback to the default method
if (! isset($methodSegment)) {
throw PageNotFoundException::forControllerNotFound($this->controller, $this->method);
}

array_unshift($this->params, $methodSegment);
$method = $this->method;
$this->method = $this->defaultMethod;

try {
$this->checkParameters($uri);
} catch (MethodNotFoundException $e) {
throw PageNotFoundException::forControllerNotFound($this->controller, $method);
}
}

return [$this->directory, $this->controller, $this->method, $this->params];
Expand All@@ -201,12 +215,21 @@ private function protectDefinedRoutes(): void

private function checkParameters(string $uri): void
{
$refClass = new ReflectionClass($this->controller);
$refMethod = $refClass->getMethod($this->method);
$refParams = $refMethod->getParameters();
try {
$refClass = new ReflectionClass($this->controller);
} catch (ReflectionException $e) {
throw PageNotFoundException::forControllerNotFound($this->controller, $this->method);
}

try {
$refMethod = $refClass->getMethod($this->method);
$refParams = $refMethod->getParameters();
} catch (ReflectionException $e) {
throw new MethodNotFoundException();
}

if (! $refMethod->isPublic()) {
throw PageNotFoundException::forMethodNotFound($this->method);
throw new MethodNotFoundException();
}

if (count($refParams) < count($this->params)) {
Expand Down
21 changes: 21 additions & 0 deletions system/Router/Exceptions/MethodNotFoundException.php
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
<?php

/**
* This file is part of CodeIgniter 4 framework.
*
* (c) CodeIgniter Foundation <admin@codeigniter.com>
*
* For the full copyright and license information, please view
* the LICENSE file that was distributed with this source code.
*/

namespace CodeIgniter\Router\Exceptions;

use RuntimeException;

/**
* @internal
*/
final class MethodNotFoundException extends RuntimeException
{
}
2 changes: 1 addition & 1 deletion tests/_support/Controllers/Newautorouting.php
Original file line numberDiff line numberDiff line change
Expand Up@@ -15,7 +15,7 @@

class Newautorouting extends Controller
{
public function getIndex()
public function getIndex(string $m = '')
{
return 'Hello';
}
Expand Down
2 changes: 1 addition & 1 deletion tests/system/Commands/RoutesTest.php
Original file line numberDiff line numberDiff line change
Expand Up@@ -129,7 +129,7 @@ public function testRoutesCommandAutoRouteImproved()
| TRACE | testing | testing-index | \App\Controllers\TestController::index | | toolbar |
| CONNECT | testing | testing-index | \App\Controllers\TestController::index | | toolbar |
| CLI | testing | testing-index | \App\Controllers\TestController::index | | |
| GET(auto) | newautorouting | | \Tests\Support\Controllers\Newautorouting::getIndex | | toolbar |
| GET(auto) | newautorouting[/..] | | \Tests\Support\Controllers\Newautorouting::getIndex | | toolbar |
| POST(auto) | newautorouting/save/../..[/..] | | \Tests\Support\Controllers\Newautorouting::postSave | | toolbar |
+------------+--------------------------------+---------------+-----------------------------------------------------+----------------+---------------+
EOL;
Expand Down
Original file line numberDiff line numberDiff line change
Expand Up@@ -62,7 +62,7 @@ public function testGetFilterMatches()
$expected = [
0 => [
'GET(auto)',
'newautorouting',
'newautorouting[/..]',
'',
'\\Tests\\Support\\Controllers\\Newautorouting::getIndex',
'',
Expand DownExpand Up@@ -90,7 +90,7 @@ public function testGetFilterDoesNotMatch()
$expected = [
0 => [
'GET(auto)',
'newautorouting',
'newautorouting[/..]',
'',
'\\Tests\\Support\\Controllers\\Newautorouting::getIndex',
'',
Expand Down
Original file line numberDiff line numberDiff line change
Expand Up@@ -43,9 +43,11 @@ public function testRead()
0 => [
'method' => 'get',
'route' => 'newautorouting',
'route_params' => '',
'route_params' => '[/..]',
'handler' => '\Tests\Support\Controllers\Newautorouting::getIndex',
'params' => [],
'params' => [
'm' => false,
],
],
[
'method' => 'post',
Expand Down
13 changes: 13 additions & 0 deletions tests/system/Router/AutoRouterImprovedTest.php
Original file line numberDiff line numberDiff line change
Expand Up@@ -199,6 +199,19 @@ public function testAutoRouteFindsDefaultDashFolder()
$this->assertSame([], $params);
}

public function testAutoRouteFallbackToDefaultMethod()
{
$router = $this->createNewAutoRouter();

[$directory, $controller, $method, $params]
= $router->getRoute('index/15');

$this->assertNull($directory);
$this->assertSame('\\' . Index::class, $controller);
$this->assertSame('getIndex', $method);
$this->assertSame(['15'], $params);
}

public function testAutoRouteRejectsSingleDot()
{
$this->expectException(PageNotFoundException::class);
Expand Down
2 changes: 1 addition & 1 deletion tests/system/Router/Controllers/Index.php
Original file line numberDiff line numberDiff line change
Expand Up@@ -15,7 +15,7 @@

class Index extends Controller
{
public function getIndex()
public function getIndex($p1 = '')
{
}

Expand Down
5 changes: 4 additions & 1 deletion user_guide_src/source/changelogs/v4.4.0.rst
Original file line numberDiff line numberDiff line change
Expand Up@@ -58,8 +58,11 @@ Helpers and Functions

Others
======
- **View:** Added optional 2nd parameter ``$saveData`` on ``renderSection()`` to prevent from auto cleans the data after displaying. See :ref:`View Layouts <creating-a-layout>` for details.

- **View:** Added optional 2nd parameter ``$saveData`` on ``renderSection()`` to prevent from auto cleans the data after displaying. See :ref:`View Layouts <creating-a-layout>` for details.
- **Auto Routing (Improved)**: Now you can use URI without a method name like
``product/15`` where ``15`` is an arbitrary number.
See :ref:`controller-default-method-fallback` for details.

Message Changes
***************
Expand Down
23 changes: 23 additions & 0 deletions user_guide_src/source/incoming/controllers.rst
Original file line numberDiff line numberDiff line change
Expand Up@@ -263,6 +263,29 @@ Your method will be passed URI segments 3 and 4 (``'sandals'`` and ``'123'``):

.. literalinclude:: controllers/022.php

.. _controller-default-method-fallback:

Default Method Fallback
=======================

.. versionadded:: 4.4.0

If the controller method corresponding to the URI segment of the method name
does not exist, and if the default method is defined, the URI segments are
passed to the default method for execution.

.. literalinclude:: controllers/024.php

Load the following URL::

example.com/index.php/product/15/edit

The method will be passed URI segments 2 and 3 (``'15'`` and ``'edit'``):

.. note:: If there are more parameters in the URI than the method parameters,
Auto Routing (Improved) does not execute the method, and it results in 404
Not Found.

Defining a Default Controller
=============================

Expand Down
11 changes: 11 additions & 0 deletions user_guide_src/source/incoming/controllers/024.php
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
<?php

namespace App\Controllers;

class Product extends BaseController
{
public function getIndex($id = null, $action = '')
{
// ...
}
}
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Remove or un-stick sticky/fixed headers that block content\n(function() {\n function unstick() {\n document.querySelectorAll('header, nav, [role=\"banner\"], .header, .navbar, .sticky, .fixed-top, [style*=\"position: fixed\"], [style*=\"position:sticky\"]').forEach(function(el) {\n if (el.style.position === 'fixed' || el.style.position === 'sticky' || \n getComputedStyle(el).position === 'fixed' || getComputedStyle(el).position === 'sticky') {\n el.style.position = 'static';\n el.style.top = 'auto';\n el.style.zIndex = 'auto';\n }\n });\n }\n \n unstick();\n \n var observer = new MutationObserver(unstick);\n observer.observe(document.body, { childList: true, subtree: true, attributes: true, attributeFilter: ['style', 'class'] });\n})();", "Kill Sticky Headers"); } } catch(__e) { console.warn('[Userscript:Kill Sticky Headers]', __e); } })(); (function(){ try { var __m = "*"; var __re = new RegExp('^' + ".*" + '
Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Original file line numberDiff line numberDiff line change
Expand Up@@ -76,18 +76,37 @@ public function read(string $class, string $defaultController = 'Home', string $
);

if ($routeWithoutController !== []) {
// Route for the default controller.
$output = [...$output, ...$routeWithoutController];

continue;
}

$params = [];
$routeParams = '';
$refParams = $method->getParameters();

foreach ($refParams as $param) {
$required = true;
if ($param->isOptional()) {
$required = false;

$routeParams .= '[/..]';
} else {
$routeParams .= '/..';
}

// [variable_name => required?]
$params[$param->getName()] = $required;
}

// Route for the default method.
$output[] = [
'method' => $httpVerb,
'route' => $classInUri,
'route_params' => '',
'route_params' => $routeParams,
'handler' => '\\' . $classname . '::' . $methodName,
'params' => [],
'params' => $params,
];

continue;
Expand Down
41 changes: 32 additions & 9 deletions system/Router/AutoRouterImproved.php
Original file line numberDiff line numberDiff line change
Expand Up@@ -12,6 +12,7 @@
namespace CodeIgniter\Router;

use CodeIgniter\Exceptions\PageNotFoundException;
use CodeIgniter\Router\Exceptions\MethodNotFoundException;
use ReflectionClass;
use ReflectionException;

Expand DownExpand Up@@ -168,17 +169,30 @@ public function getRoute(string $uri): array
'\\'
);

// Ensure routes registered via $routes->cli() are not accessible via web.
// Ensure the controller is not defined in routes.
$this->protectDefinedRoutes();

// Check _remap()
// Ensure the controller does not have _remap() method.
$this->checkRemap();

// Check parameters
// Check parameter count
try {
$this->checkParameters($uri);
} catch (ReflectionException $e) {
throw PageNotFoundException::forControllerNotFound($this->controller, $this->method);
} catch (MethodNotFoundException $e) {
// Fallback to the default method
if (! isset($methodSegment)) {
throw PageNotFoundException::forControllerNotFound($this->controller, $this->method);
}

array_unshift($this->params, $methodSegment);
$method = $this->method;
$this->method = $this->defaultMethod;

try {
$this->checkParameters($uri);
} catch (MethodNotFoundException $e) {
throw PageNotFoundException::forControllerNotFound($this->controller, $method);
}
}

return [$this->directory, $this->controller, $this->method, $this->params];
Expand All@@ -201,12 +215,21 @@ private function protectDefinedRoutes(): void

private function checkParameters(string $uri): void
{
$refClass = new ReflectionClass($this->controller);
$refMethod = $refClass->getMethod($this->method);
$refParams = $refMethod->getParameters();
try {
$refClass = new ReflectionClass($this->controller);
} catch (ReflectionException $e) {
throw PageNotFoundException::forControllerNotFound($this->controller, $this->method);
}

try {
$refMethod = $refClass->getMethod($this->method);
$refParams = $refMethod->getParameters();
} catch (ReflectionException $e) {
throw new MethodNotFoundException();
}

if (! $refMethod->isPublic()) {
throw PageNotFoundException::forMethodNotFound($this->method);
throw new MethodNotFoundException();
}

if (count($refParams) < count($this->params)) {
Expand Down
21 changes: 21 additions & 0 deletions system/Router/Exceptions/MethodNotFoundException.php
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
<?php

/**
* This file is part of CodeIgniter 4 framework.
*
* (c) CodeIgniter Foundation <admin@codeigniter.com>
*
* For the full copyright and license information, please view
* the LICENSE file that was distributed with this source code.
*/

namespace CodeIgniter\Router\Exceptions;

use RuntimeException;

/**
* @internal
*/
final class MethodNotFoundException extends RuntimeException
{
}
2 changes: 1 addition & 1 deletion tests/_support/Controllers/Newautorouting.php
Original file line numberDiff line numberDiff line change
Expand Up@@ -15,7 +15,7 @@

class Newautorouting extends Controller
{
public function getIndex()
public function getIndex(string $m = '')
{
return 'Hello';
}
Expand Down
2 changes: 1 addition & 1 deletion tests/system/Commands/RoutesTest.php
Original file line numberDiff line numberDiff line change
Expand Up@@ -129,7 +129,7 @@ public function testRoutesCommandAutoRouteImproved()
| TRACE | testing | testing-index | \App\Controllers\TestController::index | | toolbar |
| CONNECT | testing | testing-index | \App\Controllers\TestController::index | | toolbar |
| CLI | testing | testing-index | \App\Controllers\TestController::index | | |
| GET(auto) | newautorouting | | \Tests\Support\Controllers\Newautorouting::getIndex | | toolbar |
| GET(auto) | newautorouting[/..] | | \Tests\Support\Controllers\Newautorouting::getIndex | | toolbar |
| POST(auto) | newautorouting/save/../..[/..] | | \Tests\Support\Controllers\Newautorouting::postSave | | toolbar |
+------------+--------------------------------+---------------+-----------------------------------------------------+----------------+---------------+
EOL;
Expand Down
Original file line numberDiff line numberDiff line change
Expand Up@@ -62,7 +62,7 @@ public function testGetFilterMatches()
$expected = [
0 => [
'GET(auto)',
'newautorouting',
'newautorouting[/..]',
'',
'\\Tests\\Support\\Controllers\\Newautorouting::getIndex',
'',
Expand DownExpand Up@@ -90,7 +90,7 @@ public function testGetFilterDoesNotMatch()
$expected = [
0 => [
'GET(auto)',
'newautorouting',
'newautorouting[/..]',
'',
'\\Tests\\Support\\Controllers\\Newautorouting::getIndex',
'',
Expand Down
Original file line numberDiff line numberDiff line change
Expand Up@@ -43,9 +43,11 @@ public function testRead()
0 => [
'method' => 'get',
'route' => 'newautorouting',
'route_params' => '',
'route_params' => '[/..]',
'handler' => '\Tests\Support\Controllers\Newautorouting::getIndex',
'params' => [],
'params' => [
'm' => false,
],
],
[
'method' => 'post',
Expand Down
13 changes: 13 additions & 0 deletions tests/system/Router/AutoRouterImprovedTest.php
Original file line numberDiff line numberDiff line change
Expand Up@@ -199,6 +199,19 @@ public function testAutoRouteFindsDefaultDashFolder()
$this->assertSame([], $params);
}

public function testAutoRouteFallbackToDefaultMethod()
{
$router = $this->createNewAutoRouter();

[$directory, $controller, $method, $params]
= $router->getRoute('index/15');

$this->assertNull($directory);
$this->assertSame('\\' . Index::class, $controller);
$this->assertSame('getIndex', $method);
$this->assertSame(['15'], $params);
}

public function testAutoRouteRejectsSingleDot()
{
$this->expectException(PageNotFoundException::class);
Expand Down
2 changes: 1 addition & 1 deletion tests/system/Router/Controllers/Index.php
Original file line numberDiff line numberDiff line change
Expand Up@@ -15,7 +15,7 @@

class Index extends Controller
{
public function getIndex()
public function getIndex($p1 = '')
{
}

Expand Down
5 changes: 4 additions & 1 deletion user_guide_src/source/changelogs/v4.4.0.rst
Original file line numberDiff line numberDiff line change
Expand Up@@ -58,8 +58,11 @@ Helpers and Functions

Others
======
- **View:** Added optional 2nd parameter ``$saveData`` on ``renderSection()`` to prevent from auto cleans the data after displaying. See :ref:`View Layouts <creating-a-layout>` for details.

- **View:** Added optional 2nd parameter ``$saveData`` on ``renderSection()`` to prevent from auto cleans the data after displaying. See :ref:`View Layouts <creating-a-layout>` for details.
- **Auto Routing (Improved)**: Now you can use URI without a method name like
``product/15`` where ``15`` is an arbitrary number.
See :ref:`controller-default-method-fallback` for details.

Message Changes
***************
Expand Down
23 changes: 23 additions & 0 deletions user_guide_src/source/incoming/controllers.rst
Original file line numberDiff line numberDiff line change
Expand Up@@ -263,6 +263,29 @@ Your method will be passed URI segments 3 and 4 (``'sandals'`` and ``'123'``):

.. literalinclude:: controllers/022.php

.. _controller-default-method-fallback:

Default Method Fallback
=======================

.. versionadded:: 4.4.0

If the controller method corresponding to the URI segment of the method name
does not exist, and if the default method is defined, the URI segments are
passed to the default method for execution.

.. literalinclude:: controllers/024.php

Load the following URL::

example.com/index.php/product/15/edit

The method will be passed URI segments 2 and 3 (``'15'`` and ``'edit'``):

.. note:: If there are more parameters in the URI than the method parameters,
Auto Routing (Improved) does not execute the method, and it results in 404
Not Found.

Defining a Default Controller
=============================

Expand Down
11 changes: 11 additions & 0 deletions user_guide_src/source/incoming/controllers/024.php
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
<?php

namespace App\Controllers;

class Product extends BaseController
{
public function getIndex($id = null, $action = '')
{
// ...
}
}
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Universal Dark Mode - works on any site\n(function() {\n var enabled = true;\n \n function applyDarkMode() {\n if (!enabled) return;\n \n // Create style element if it doesn't exist\n var style = document.getElementById('universal-dark-mode-style');\n if (!style) {\n style = document.createElement('style');\n style.id = 'universal-dark-mode-style';\n document.head.appendChild(style);\n }\n \n // Dark mode CSS - inverts colors but preserves images/video\n style.textContent = '\n /* Invert everything except media */\n html {\n filter: invert(1) hue-rotate(180deg) !important;\n background: #1a1a2e !important;\n }\n \n /* Restore images, videos, iframes, canvas */\n img, video, iframe, canvas, svg, picture, [style*=\"background-image\"] {\n filter: invert(1) hue-rotate(180deg) !important;\n }\n \n /* Preserve specific elements that should not be inverted */\n .no-dark-mode, .no-dark-mode *,\n [data-theme=\"light\"], [data-theme=\"light\"],\n .ace_editor, .ace_editor *,\n .CodeMirror, .CodeMirror *,\n .monaco-editor, .monaco-editor *,\n .markdown-body pre, .markdown-body pre *,\n .highlight, .highlight *,\n pre code, pre code * {\n filter: none !important;\n }\n \n /* Fix common UI elements */\n .modal, .popup, .dropdown-menu, .tooltip, .popover {\n filter: invert(1) hue-rotate(180deg) !important;\n background: #2d2d44 !important;\n border-color: #444 !important;\n }\n \n /* Scrollbars */\n ::-webkit-scrollbar { background: #1a1a2e !important; }\n ::-webkit-scrollbar-thumb { background: #444 !important; }\n ::-webkit-scrollbar-thumb:hover { background: #555 !important; }\n \n /* Selection */\n ::selection { background: #4ecdc4 !important; color: #1a1a2e !important; }\n ::-moz-selection { background: #4ecdc4 !important; color: #1a1a2e !important; }\n ';\n }\n \n function removeDarkMode() {\n var style = document.getElementById('universal-dark-mode-style');\n if (style) style.remove();\n }\n \n // Toggle with Alt+Shift+D\n document.addEventListener('keydown', function(e) {\n if (e.altKey && e.shiftKey && e.key === 'D') {\n e.preventDefault();\n enabled = !enabled;\n if (enabled) {\n applyDarkMode();\n console.log('[Universal Dark Mode] Enabled');\n } else {\n removeDarkMode();\n console.log('[Universal Dark Mode] Disabled');\n }\n }\n });\n \n // Apply on load\n applyDarkMode();\n \n // Re-apply on dynamic content\n var observer = new MutationObserver(function(mutations) {\n if (enabled && !document.getElementById('universal-dark-mode-style')) {\n applyDarkMode();\n }\n });\n observer.observe(document.head, { childList: true });\n \n console.log('[Universal Dark Mode] Loaded - Press Alt+Shift+D to toggle');\n})();", "Universal Dark Mode"); } } catch(__e) { console.warn('[Userscript:Universal Dark Mode]', __e); } })(); })();
Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Original file line numberDiff line numberDiff line change
Expand Up@@ -76,18 +76,37 @@ public function read(string $class, string $defaultController = 'Home', string $
);

if ($routeWithoutController !== []) {
// Route for the default controller.
$output = [...$output, ...$routeWithoutController];

continue;
}

$params = [];
$routeParams = '';
$refParams = $method->getParameters();

foreach ($refParams as $param) {
$required = true;
if ($param->isOptional()) {
$required = false;

$routeParams .= '[/..]';
} else {
$routeParams .= '/..';
}

// [variable_name => required?]
$params[$param->getName()] = $required;
}

// Route for the default method.
$output[] = [
'method' => $httpVerb,
'route' => $classInUri,
'route_params' => '',
'route_params' => $routeParams,
'handler' => '\\' . $classname . '::' . $methodName,
'params' => [],
'params' => $params,
];

continue;
Expand Down
41 changes: 32 additions & 9 deletions system/Router/AutoRouterImproved.php
Original file line numberDiff line numberDiff line change
Expand Up@@ -12,6 +12,7 @@
namespace CodeIgniter\Router;

use CodeIgniter\Exceptions\PageNotFoundException;
use CodeIgniter\Router\Exceptions\MethodNotFoundException;
use ReflectionClass;
use ReflectionException;

Expand DownExpand Up@@ -168,17 +169,30 @@ public function getRoute(string $uri): array
'\\'
);

// Ensure routes registered via $routes->cli() are not accessible via web.
// Ensure the controller is not defined in routes.
$this->protectDefinedRoutes();

// Check _remap()
// Ensure the controller does not have _remap() method.
$this->checkRemap();

// Check parameters
// Check parameter count
try {
$this->checkParameters($uri);
} catch (ReflectionException $e) {
throw PageNotFoundException::forControllerNotFound($this->controller, $this->method);
} catch (MethodNotFoundException $e) {
// Fallback to the default method
if (! isset($methodSegment)) {
throw PageNotFoundException::forControllerNotFound($this->controller, $this->method);
}

array_unshift($this->params, $methodSegment);
$method = $this->method;
$this->method = $this->defaultMethod;

try {
$this->checkParameters($uri);
} catch (MethodNotFoundException $e) {
throw PageNotFoundException::forControllerNotFound($this->controller, $method);
}
}

return [$this->directory, $this->controller, $this->method, $this->params];
Expand All@@ -201,12 +215,21 @@ private function protectDefinedRoutes(): void

private function checkParameters(string $uri): void
{
$refClass = new ReflectionClass($this->controller);
$refMethod = $refClass->getMethod($this->method);
$refParams = $refMethod->getParameters();
try {
$refClass = new ReflectionClass($this->controller);
} catch (ReflectionException $e) {
throw PageNotFoundException::forControllerNotFound($this->controller, $this->method);
}

try {
$refMethod = $refClass->getMethod($this->method);
$refParams = $refMethod->getParameters();
} catch (ReflectionException $e) {
throw new MethodNotFoundException();
}

if (! $refMethod->isPublic()) {
throw PageNotFoundException::forMethodNotFound($this->method);
throw new MethodNotFoundException();
}

if (count($refParams) < count($this->params)) {
Expand Down
21 changes: 21 additions & 0 deletions system/Router/Exceptions/MethodNotFoundException.php
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
<?php

/**
* This file is part of CodeIgniter 4 framework.
*
* (c) CodeIgniter Foundation <admin@codeigniter.com>
*
* For the full copyright and license information, please view
* the LICENSE file that was distributed with this source code.
*/

namespace CodeIgniter\Router\Exceptions;

use RuntimeException;

/**
* @internal
*/
final class MethodNotFoundException extends RuntimeException
{
}
2 changes: 1 addition & 1 deletion tests/_support/Controllers/Newautorouting.php
Original file line numberDiff line numberDiff line change
Expand Up@@ -15,7 +15,7 @@

class Newautorouting extends Controller
{
public function getIndex()
public function getIndex(string $m = '')
{
return 'Hello';
}
Expand Down
2 changes: 1 addition & 1 deletion tests/system/Commands/RoutesTest.php
Original file line numberDiff line numberDiff line change
Expand Up@@ -129,7 +129,7 @@ public function testRoutesCommandAutoRouteImproved()
| TRACE | testing | testing-index | \App\Controllers\TestController::index | | toolbar |
| CONNECT | testing | testing-index | \App\Controllers\TestController::index | | toolbar |
| CLI | testing | testing-index | \App\Controllers\TestController::index | | |
| GET(auto) | newautorouting | | \Tests\Support\Controllers\Newautorouting::getIndex | | toolbar |
| GET(auto) | newautorouting[/..] | | \Tests\Support\Controllers\Newautorouting::getIndex | | toolbar |
| POST(auto) | newautorouting/save/../..[/..] | | \Tests\Support\Controllers\Newautorouting::postSave | | toolbar |
+------------+--------------------------------+---------------+-----------------------------------------------------+----------------+---------------+
EOL;
Expand Down
Original file line numberDiff line numberDiff line change
Expand Up@@ -62,7 +62,7 @@ public function testGetFilterMatches()
$expected = [
0 => [
'GET(auto)',
'newautorouting',
'newautorouting[/..]',
'',
'\\Tests\\Support\\Controllers\\Newautorouting::getIndex',
'',
Expand DownExpand Up@@ -90,7 +90,7 @@ public function testGetFilterDoesNotMatch()
$expected = [
0 => [
'GET(auto)',
'newautorouting',
'newautorouting[/..]',
'',
'\\Tests\\Support\\Controllers\\Newautorouting::getIndex',
'',
Expand Down
Original file line numberDiff line numberDiff line change
Expand Up@@ -43,9 +43,11 @@ public function testRead()
0 => [
'method' => 'get',
'route' => 'newautorouting',
'route_params' => '',
'route_params' => '[/..]',
'handler' => '\Tests\Support\Controllers\Newautorouting::getIndex',
'params' => [],
'params' => [
'm' => false,
],
],
[
'method' => 'post',
Expand Down
13 changes: 13 additions & 0 deletions tests/system/Router/AutoRouterImprovedTest.php
Original file line numberDiff line numberDiff line change
Expand Up@@ -199,6 +199,19 @@ public function testAutoRouteFindsDefaultDashFolder()
$this->assertSame([], $params);
}

public function testAutoRouteFallbackToDefaultMethod()
{
$router = $this->createNewAutoRouter();

[$directory, $controller, $method, $params]
= $router->getRoute('index/15');

$this->assertNull($directory);
$this->assertSame('\\' . Index::class, $controller);
$this->assertSame('getIndex', $method);
$this->assertSame(['15'], $params);
}

public function testAutoRouteRejectsSingleDot()
{
$this->expectException(PageNotFoundException::class);
Expand Down
2 changes: 1 addition & 1 deletion tests/system/Router/Controllers/Index.php
Original file line numberDiff line numberDiff line change
Expand Up@@ -15,7 +15,7 @@

class Index extends Controller
{
public function getIndex()
public function getIndex($p1 = '')
{
}

Expand Down
5 changes: 4 additions & 1 deletion user_guide_src/source/changelogs/v4.4.0.rst
Original file line numberDiff line numberDiff line change
Expand Up@@ -58,8 +58,11 @@ Helpers and Functions

Others
======
- **View:** Added optional 2nd parameter ``$saveData`` on ``renderSection()`` to prevent from auto cleans the data after displaying. See :ref:`View Layouts <creating-a-layout>` for details.

- **View:** Added optional 2nd parameter ``$saveData`` on ``renderSection()`` to prevent from auto cleans the data after displaying. See :ref:`View Layouts <creating-a-layout>` for details.
- **Auto Routing (Improved)**: Now you can use URI without a method name like
``product/15`` where ``15`` is an arbitrary number.
See :ref:`controller-default-method-fallback` for details.

Message Changes
***************
Expand Down
23 changes: 23 additions & 0 deletions user_guide_src/source/incoming/controllers.rst
Original file line numberDiff line numberDiff line change
Expand Up@@ -263,6 +263,29 @@ Your method will be passed URI segments 3 and 4 (``'sandals'`` and ``'123'``):

.. literalinclude:: controllers/022.php

.. _controller-default-method-fallback:

Default Method Fallback
=======================

.. versionadded:: 4.4.0

If the controller method corresponding to the URI segment of the method name
does not exist, and if the default method is defined, the URI segments are
passed to the default method for execution.

.. literalinclude:: controllers/024.php

Load the following URL::

example.com/index.php/product/15/edit

The method will be passed URI segments 2 and 3 (``'15'`` and ``'edit'``):

.. note:: If there are more parameters in the URI than the method parameters,
Auto Routing (Improved) does not execute the method, and it results in 404
Not Found.

Defining a Default Controller
=============================

Expand Down
11 changes: 11 additions & 0 deletions user_guide_src/source/incoming/controllers/024.php
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
<?php

namespace App\Controllers;

class Product extends BaseController
{
public function getIndex($id = null, $action = '')
{
// ...
}
}