Skip to content

fix: 404 override controller does not output Response object body #5703

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
kenjis merged 4 commits into from
Feb 18, 2022
Merged

fix: 404 override controller does not output Response object body #5703

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
b348513
test: fix Popcorn controller
kenjis Feb 17, 2022
44a35f5
fix: 404 override controller does not output Response object body
kenjis Feb 17, 2022
a22a145
docs: update PHPDoc types
kenjis Feb 17, 2022
ba7f5df
test: fix test code
kenjis Feb 17, 2022
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
14 changes: 9 additions & 5 deletions system/CodeIgniter.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -777,6 +777,8 @@ public function setPath(string $path)
* Now that everything has been setup, this method attempts to run the
* controller method and make the script go. If it's not able to, will
* show the appropriate Page Not Found error.
*
* @return ResponseInterface|string|void
*/
protected function startController()
{
Expand Down Expand Up @@ -804,7 +806,7 @@ protected function startController()
/**
* Instantiates the controller class.
*
* @return mixed
* @return Controller
*/
protected function createController()
{
Expand All @@ -821,7 +823,7 @@ protected function createController()
*
* @param mixed $class
*
* @return mixed
* @return false|ResponseInterface|string|void
*/
protected function runController($class)
{
Expand All @@ -847,6 +849,8 @@ protected function display404errors(PageNotFoundException $e)
{
// Is there a 404 Override available?
if ($override = $this->router->get404Override()) {
$returned = null;

if ($override instanceof Closure) {
echo $override($e->getMessage());
} elseif (is_array($override)) {
Expand All @@ -857,13 +861,13 @@ protected function display404errors(PageNotFoundException $e)
$this->method = $override[1];

$controller = $this->createController();
$this->runController($controller);
$returned = $this->runController($controller);
}

unset($override);

$cacheConfig = new Cache();
$this->gatherOutput($cacheConfig);
$this->gatherOutput($cacheConfig, $returned);
$this->sendResponse();

return;
Expand Down Expand Up @@ -891,7 +895,7 @@ protected function display404errors(PageNotFoundException $e)
* Gathers the script output from the buffer, replaces some execution
* time tag in the output and displays the debug toolbar, if required.
*
* @param mixed|null $returned
* @param ResponseInterface|string|null $returned
*/
protected function gatherOutput(?Cache $cacheConfig = null, $returned = null)
{
Expand Down
10 changes: 5 additions & 5 deletions tests/_support/Controllers/Popcorn.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,7 @@ public function index()

public function pop()
{
$this->respond('Oops', 567, 'Surprise');
return $this->respond('Oops', 567, 'Surprise');
}

public function popper()
Expand All @@ -40,12 +40,12 @@ public function popper()

public function weasel()
{
$this->respond('', 200);
return $this->respond('', 200);
}

public function oops()
{
$this->failUnauthorized();
return $this->failUnauthorized();
}

public function goaway()
Expand All @@ -72,12 +72,12 @@ public function cat()

public function json()
{
$this->respond(['answer' => 42]);
return $this->respond(['answer' => 42]);
}

public function xml()
{
$this->respond('<my><pet>cat</pet></my>');
return $this->respond('<my><pet>cat</pet></my>');
}

public function toindex()
Expand Down
25 changes: 22 additions & 3 deletions tests/system/CodeIgniterTest.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -94,15 +94,34 @@ public function testRun404Override()
// Inject mock router.
$routes = Services::routes();
$routes->setAutoRoute(false);
$routes->set404Override('Home::index');
$routes->set404Override('Tests\Support\Controllers\Hello::index');
$router = Services::router($routes, Services::request());
Services::injectMock('router', $router);

ob_start();
$this->codeigniter->useSafeOutput(true)->run();
$this->codeigniter->useSafeOutput(true)->run($routes);
$output = ob_get_clean();

$this->assertStringContainsString('Welcome to CodeIgniter', $output);
$this->assertStringContainsString('Hello', $output);
}

public function testRun404OverrideControllerReturnsResponse()
{
$_SERVER['argv'] = ['index.php', '/'];
$_SERVER['argc'] = 2;

// Inject mock router.
$routes = Services::routes();
$routes->setAutoRoute(false);
$routes->set404Override('Tests\Support\Controllers\Popcorn::pop');
$router = Services::router($routes, Services::request());
Services::injectMock('router', $router);

ob_start();
$this->codeigniter->useSafeOutput(true)->run($routes);
$output = ob_get_clean();

$this->assertStringContainsString('Oops', $output);
}

public function testRun404OverrideByClosure()
Expand Down