CakePHP Controllers

The controller as the name indicates controls the application. It acts like a bridge between models and views. CakePHP Controllerss 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 CakePHP Controllers class names are in plural form, Camel Cased, and end in CakePHP Controllers — PostsCakePHP Controllers.

AppCakePHP Controllers

The AppConttroller class is the parent class of all applications’ controllers. This class extends the CakePHP Controllers class of CakePHP. AppCakePHP Controllers is defined at src/CakePHP Controllers/AppCakePHP Controllers.php. The file contains the following code.

<?php declare(strict_types=1);
namespace App\CakePHP Controllers;
use Cake\CakePHP Controllers\CakePHP Controllers;
class AppCakePHP Controllers extends CakePHP Controllers {
   public function initialize(): void {
      parent::initialize();
      $this->loadComponent('RequestHandler');
      $this->loadComponent('Flash');
   }
}

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

CakePHP Controllers 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 RecipesCakePHP Controllers extends AppCakePHP Controllers {
   public function view($id) {
      // Action logic goes here.
   }
   public function share($customerId, $recipeId) {
      // Action logic goes here.
   }
   public function search($query) {
      // Action logic goes here.
   }
}

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

CakePHP Controllersing

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.

Cake\CakePHP Controllers\CakePHP Controllers::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 Cake\Http\Middleware\CsrfProtectionMiddleware;
use Cake\Routing\Route\DashedRoute;
use Cake\Routing\RouteBuilder;
$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'=>'CakePHP Controllerss','action'=>'action1']);
   $builder->connect('/redirect-controller2',['controller'=>'CakePHP Controllerss','action'=>'action2']);
   $builder->fallbacks();
});

Create a CakePHP ControllerssCakePHP Controllers.php file at src/CakePHP Controllers/CakePHP ControllerssCakePHP Controllers.php. Copy the following code in the controller file.

src/CakePHP Controllers/CakePHP ControllerssCakePHP Controllers.php

<?php declare(strict_types=1);
namespace App\CakePHP Controllers;
use Cake\Core\Configure;
use Cake\Http\Exception\ForbiddenException;
use Cake\Http\Exception\NotFoundException;
use Cake\Http\Response;
use Cake\View\Exception\MissingTemplateException;
class CakePHP ControllerssCakePHP Controllers extends AppCakePHP Controllers {
   public function action1() {
   }
   public function action2(){
      echo "redirecting from action2";
      $this->setAction('action1');
   }
}

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

src/Template/CakePHP Controllerss/action1.php

<h1 id="This-is-an-example-of-how-to-redirect-within-controller">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 −

Cake\CakePHP Controllers\CakePHP Controllers::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 line in controller’s action.

$this->loadModel('Articles');

The above is the detailed content of CakePHP Controllers. For more information, please follow other related articles on the PHP Chinese website!