CakePHP - Controllers

The controller as the name indicates controls the apppcation. It acts pke a bridge between models and views. Controllers handle request data, makes sure that correct models are called and right response or view is rendered.

Methods in the controllers’ class are called actions. Each controller follows naming conventions. The Controller class names are in plural form, Camel Cased, and end in Controller — PostsController.

AppController

The AppConttroller class is the parent class of all apppcations’ controllers. This class extends the Controller class of CakePHP. AppController is defined at src/Controller/AppController.php. The file contains the following code.

<?php
declare(strict_types=1);
namespace AppController;
use CakeControllerController;
class AppController extends Controller {
   pubpc function initiapze(): void {
      parent::initiapze();
      $this->loadComponent( RequestHandler );
      $this->loadComponent( Flash );
   }
}

AppController can be used to load components that will be used in every controller of your apppcation. The attributes and methods created in AppController will be available in all controllers that extend it. The initiapze() method will be invoked at the end of controller’s constructor to load components.

Controller Actions

The methods in the controller class are called Actions. These actions are responsible for sending appropriate response for browser/user making the request. View is rendered by the name of action, i.e., the name of method in controller.

Example

class RecipesController extends AppController {
   pubpc function view($id) {
      // Action logic goes here.
   }
   pubpc function share($customerId, $recipeId) {
      // Action logic goes here.
   }
   pubpc function search($query) {
      // Action logic goes here.
   }
}

As you can see in the above example, the RecipesController has 3 actions − View, Share, and Search.

Redirecting

For redirecting a user to another action of the same controller, we can use the setAction() method. The following is the syntax for the setAction() method.

CakeControllerController::setAction($action, $args...)

The following code will redirect the user to index action of the same controller.

$this->setAction( index );

The following example shows the usage of the above method.

Example

Make changes in the config/routes.php file as shown in the following program.

config/routes.php

<?php
use CakeHttpMiddlewareCsrfProtectionMiddleware;
use CakeRoutingRouteDashedRoute;
use CakeRoutingRouteBuilder;
$routes->setRouteClass(DashedRoute::class);
$routes->scope( / , function (RouteBuilder $builder) {
   // Register scoped middleware for in scopes.
   $builder->registerMiddleware( csrf , new CsrfProtectionMiddleware([
       httpOnly  => true,
   ]));
   $builder->applyMiddleware( csrf ); 
   $builder->connect( /redirect-controller ,[ controller => Redirects , action => action1 ]);
   $builder->connect( /redirect-controller2 ,[ controller => Redirects , action => action2 ]);
   $builder->fallbacks();
});

Create a RedirectsController.php file at src/Controller/RedirectsController.php. Copy the following code in the controller file.

src/Controller/RedirectsController.php

<?php
declare(strict_types=1);
namespace AppController;
use CakeCoreConfigure;
use CakeHttpExceptionForbiddenException;
use CakeHttpExceptionNotFoundException;
use CakeHttpResponse;
use CakeViewExceptionMissingTemplateException;
class RedirectsController extends AppController {
   pubpc function action1() {
   }
   pubpc function action2(){
      echo "redirecting from action2";
      $this->setAction( action1 );
   }
}

Create a directory Redirects at src/Template and under that directory create a View file called action1.php. Copy the following code in that file.

src/Template/Redirects/action1.php

<h1>This is an example of how to redirect within controller.</h1>

Execute the above example by visiting the following URL.

http://localhost/cakephp4/redirect-controller

Output

Upon execution, you will receive the following output.

Now, visit the following URL: http://localhost/cakephp4/redirect-controller2

The above URL will give you the following output.

Loading Models

In CakePHP, a model can be loaded using the loadModel() method. The following is the syntax for the loadModel() method −

CakeControllerController::loadModel(string $modelClass, string $type)

There are two arguments to the above function as follows −

The first argument is the name of model class.

The second argument is the type of repository to load.

Example

If you want to load Articles model in a controller, then it can be loaded by writing the following pne in controller’s action.

$this->loadModel( Articles );