Controllers

    Actions are methods on a controller that handle requests. By default all public methods on a controller map to actions and are accessible by a URL. Actions are responsible for interpreting the request and creating the response. Usually responses are in the form of a rendered view, but there are other ways to create responses as well.

    For instance, when you access a URL like this: Phalcon by default will decompose each part like this:

    In this case, the PostsController will handle this request. There is no a special location to put controllers in an application, they could be loaded using Phalcon\Loader, so you’re free to organize your controllers as you need.

    Controllers must have the suffix Controller while actions the suffix Action. A sample of a controller is as follows:

    Additional URI parameters are defined as action parameters, so that they can be easily accessed using local variables. A controller can optionally extend . By doing this, the controller can have easy access tothe application services.

    Parameters without a default value are handled as required. Setting optional values for parameters is done as usual in PHP:

    1. <?php
    3. use Phalcon\Mvc\Controller;
    5. class PostsController extends Controller
    6. {
    7.     public function indexAction()
    8.     {
    10.     }
    12.     public function showAction($year = 2015, $postTitle = 'some default title')
    13.     {
    15.     }
    16. }

    Parameters are assigned in the same order as they were passed in the route. You can get an arbitrary parameter from its name in the following way:

    1. <?php
    3. use Phalcon\Mvc\Controller;
    5. class PostsController extends Controller
    6. {
    7.     public function indexAction()
    8.     {
    10.     }
    12.     public function showAction()
    13.     {
    14.         $year      = $this->dispatcher->getParam('year');
    15.         $postTitle = $this->dispatcher->getParam('postTitle');
    16.     }
    17. }

    Dispatch Loop

    1. <?php
    3. use Phalcon\Mvc\Controller;
    5. class PostsController extends Controller
    6. {
    7.     public function indexAction()
    8.     {
    10.     }
    12.     public function showAction($year, $postTitle)
    13.     {
    14.         $this->flash->error(
    15.             "You don't have permission to access this area"
    16.         );
    18.         // Forward flow to another action
    19.         $this->dispatcher->forward(
    20.             [
    21.                 'controller' => 'users',
    22.                 'action'     => 'signin',
    23.             ]
    24.         );
    25. }

    If users don’t have permission to access a certain action then they will be forwarded to the signin action in the UsersController.

    There is no limit on the forwards you can have in your application, so long as they do not result in circular references, at which point your application will halt. If there are no other actions to be dispatched by the dispatch loop, the dispatcher will automatically invoke the view layer of the MVC that is managed by .

    Phalcon\Mvc\Controller offers the initialize() method, which is executed first, before any action is executed on a controller. The use of the __construct() method is not recommended.

    3. use Phalcon\Mvc\Controller;
    5. class PostsController extends Controller
    6. {
    7.     public $settings;
    9.     public function initialize()
    10.     {
    11.         $this->settings = [
    12.             'mySetting' => 'value',
    13.         ];
    14.     }
    16.     public function saveAction()
    17.     {
    18.         if ($this->settings['mySetting'] === 'value') {
    19.             // ...
    20.         }
    21.     }
    22. }

    If you want to execute some initialization logic just after the controller object is constructed then you can implement the onConstruct() method:

    1. <?php
    3. use Phalcon\Mvc\Controller;
    5. class PostsController extends Controller
    6. {
    7.     public function onConstruct()
    8.     {
    9.         // ...
    10.     }
    11. }

    Be aware that onConstruct() method is executed even if the action to be executed doesn’t exist in the controller or the user does not have access to it (according to custom control access provided by the developer).

    Injecting Services

    If a controller extends Phalcon\Mvc\Controller then it has easy access to the service container in application. For example, if we have registered a service like this:

    1. <?php
    3. use Phalcon\Di;
    5. $di = new Di();
    7. $di->set(
    8.     'storage',
    9.     function () {
    10.         return new Storage(
    11.             '/some/directory'
    12.         );
    13.     },
    14.     true
    15. );

    If you’re using Phalcon as a full-stack framework, you can read the services provided in the framework.

    Assuming that the framework provides a set of pre-registered services. We explain how to interact with the HTTP environment. The request service contains an instance of Phalcon\Http\Request and the response contains a representing what is going to be sent back to the client.

    1. <?php
    3. use Phalcon\Mvc\Controller;
    5. class PostsController extends Controller
    6. {
    7.     public function indexAction()
    8.     {
    10.     }
    12.     public function saveAction()
    13.     {
    14.         // Check if request has made with POST
    15.         if ($this->request->isPost()) {
    17.             $customerBorn = $this->request->getPost('born');
    18.         }
    19.     }
    20. }

    The response object is not usually used directly, but is built up before the execution of the action, sometimes - like in an afterDispatch event - it can be useful to access the response directly:

    1. <?php
    3. use Phalcon\Mvc\Controller;
    5. class PostsController extends Controller
    6. {
    7.     public function indexAction()
    8.     {
    10.     }
    12.     public function notFoundAction()
    13.     {
    14.         // Send a HTTP 404 response header
    15.         $this->response->setStatusCode(404, 'Not Found');
    16.     }
    17. }

    Learn more about the HTTP environment in their dedicated articles request and .

    Session Data

    Sessions help us maintain persistent data between requests. You can access a from any controller to encapsulate data that needs to be persistent:

    1. <?php
    3. use Phalcon\Mvc\Controller;
    5. class UserController extends Controller
    6. {
    7.     public function indexAction()
    8.     {
    9.         $this->persistent->name = 'Michael';
    10.     }
    12.     public function welcomeAction()
    13.     {
    14.         echo 'Welcome, ', $this->persistent->name;
    15.     }
    16. }

    Services may act as controllers, controllers classes are always requested from the services container. Accordingly, any other class registered with its name can easily replace a controller:

    Events in Controllers

    Controllers automatically act as listeners for events, implementing methods with those event names allow you to implement hook points before/after the actions are executed:

    1. <?php
    3. use Phalcon\Mvc\Controller;
    5. class PostsController extends Controller
    6. {
    7.     public function beforeExecuteRoute($dispatcher)
    8.     {
    9.         // This is executed before every found action
    10.         if ($dispatcher->getActionName() === 'save') {
    11.             $this->flash->error(
    12.                 "You don't have permission to save posts"
    13.             );
    15.             $this->dispatcher->forward(
    16.                 [
    17.                     'controller' => 'home',
    18.                     'action'     => 'index',
    19.                 ]
    20.             );
    22.             return false;
    23.         }
    24.     }
    26.     public function afterExecuteRoute($dispatcher)
    27.     {
    28.         // Executed after every found action