How to setup a 404 page in Phalcon

Question

How can I set a 404 page in Phalcon to be displayed when a controller/action does not exist?

Answer 1

You can set the dispatcher to do that for you.

When you bootstrap your application you can do this ($di is your DI factory):

use \Phalcon\Mvc\Dispatcher as PhDispatcher;

$di->set(
    'dispatcher',
    function() use ($di) {

        $evManager = $di->getShared('eventsManager');

        $evManager->attach(
            "dispatch:beforeException",
            function($event, $dispatcher, $exception)
            {
                switch ($exception->getCode()) {
                    case PhDispatcher::EXCEPTION_HANDLER_NOT_FOUND:
                    case PhDispatcher::EXCEPTION_ACTION_NOT_FOUND:
                        $dispatcher->forward(
                            array(
                                'controller' => 'error',
                                'action'     => 'show404',
                            )
                        );
                        return false;
                }
            }
        );
        $dispatcher = new PhDispatcher();
        $dispatcher->setEventsManager($evManager);
        return $dispatcher;
    },
    true
);

Create an ErrorController

<?php

/**
 * ErrorController 
 */
class ErrorController extends \Phalcon\Mvc\Controller
{
    public function show404Action()
    {
        $this->response->setStatusCode(404, 'Not Found');
        $this->view->pick('404/404');
    }
}

and a 404 view (/views/404/404.volt)

<div align="center" id="fourohfour">
    <div class="sub-content">
        <strong>ERROR 404</strong>
        <br />
        <br />
        You have tried to access a page which does not exist or has been moved.
        <br />
        <br />
        Please click the links at the top navigation bar to 
        navigate to other parts of the site, or
        if you wish to contact us, there is information in the About page.
        <br />
        <br />
        [ERROR]
    </div>
</div>

Answer 2

You can use routing to handle 404 not found page:

$router->notFound(array(
    "controller" => "index",
    "action" => "route404"
));

Ref: http://docs.phalconphp.com/en/latest/reference/routing.html#not-found-paths

Answer 3

The solution proposed by Dimopoulos doesn't work. It generates a cycling condition.

The Phalcon Router component has a default behavior providing a very simple routing that always expects an URI that matches the following pattern: /:controller/:action/:params. This is gonna cause many problems because Phalcon will search a controller that doesn't exist when the server receives a request for an URL that doesn't match any defined route.

So, first of all, you must disable this behavior. This can be done passing FALSE during the Router instance creation, as follows:

$router = Phalcon\Mvc\Router(FALSE);

At this point you can use the solution proposed by @Nguyễn Trọng Bằng.

$router->notFound(
  [
    "namespace" => "MyNamespace\Controller"
    "controller" => "index",
    "action" => "route404"
  ]
);

It's important to note, if you are using a namespace the dispatcher will not be able to find the controller, unless you specify it, like I did above.

This is not only the easiest solution, but it is the only one that works.

Answer 4

You also can set the header in a errorController by using

class ErrorController extends ControllerBase
{
     public function error404Action()
    {
        $this->response->setHeader('HTTP/1.0 404','Not Found');
        // $this->response->setHeader(404, 'Not Found'); <- did not work
    }
}

And before, in the controller, where an error occures, you can forward to this error-controller.

class IndexController extends ControllerBase
{
    public function indexAction()
    {
        $id = (int)$this->getId($param);
        if ($id > 0) {

           // do you stuff
        } else {
           $this->dispatcher->forward(array(
               'controller' => 'error', 'action' =>   'error404')
           );
        }
    }
}

That's a quick and dirty(?) way and is good, if you're getting content from a database and want to throw an error, if nothing was found.