Account
Sign in to you account
Sign In Sign Up

How to Define A New Controller In Yii 2?

10 minutes read

To define a new controller in Yii 2, follow these steps:

  1. Create a new PHP file in the controllers directory of your Yii 2 application (usually located in the frontend or backend folder).
  2. Declare a new class that extends the yii\web\Controller class. For example, you can name it YourController. 
 1
 2
 3
 4
 5
 6
 7
 8
 9
10

<?php

namespace app\controllers;

use yii\web\Controller;

class YourController extends Controller
{
    // Controller actions and methods will be defined here
}


  1. Inside the YourController class, you can define various methods that represent the actions for the controller. Each action corresponds to a user request and performs a specific task. For example, you can define an action method called actionIndex() that will be called when a user accesses the route associated with this action.
1
2
3
4

public function actionIndex()
{
    // Code for the "index" action
}


  1. You can create more action methods within the controller as needed for your application. Each action method should have a name starting with action followed by the action name in camel case.
  2. Optionally, you can override the behaviors() method to specify behaviors for your controller. For example, you can apply access control filters or enable RESTful behaviors. 
1
2
3
4
5
6
7
8
9

public function behaviors()
{
    return [
        'access' => [
            'class' => AccessControl::className(),
            // Configure access rules
        ],
    ];
}


  1. Save the file and your new controller is ready to be used. You can now define routes to map to the actions of this controller in the Yii 2 application configuration files.


It is important to note that Yii 2 follows the MVC (Model-View-Controller) pattern, where a controller handles user requests and communicates with models and views to provide the desired response.

Best Yii 2 Frameworks Books to Read in 2024

1
Yii 2 Development: Bring A Map Through The Halls Of Yii 2 Development

Rating is 5 out of 5

Yii 2 Development: Bring A Map Through The Halls Of Yii 2 Development

Get Book Now
2
Yii2 Quick Start Guide - Mastering Yii 2

Rating is 4.9 out of 5

Yii2 Quick Start Guide - Mastering Yii 2

Get Book Now
3
Yii 2 Speed: Getting Up To Speed With Yii 2

Rating is 4.8 out of 5

Yii 2 Speed: Getting Up To Speed With Yii 2

Get Book Now


How to access session data within a controller in Yii 2?

To access session data within a controller in Yii 2, you can use the Yii::$app->session object. Here are a few examples of accessing session data in a controller:

  1. Get a session value:
1

$value = Yii::$app->session->get('key');


  1. Set a session value:
1

Yii::$app->session->set('key', $value);


  1. Check if a session value exists:
1

$exists = Yii::$app->session->has('key');


  1. Remove a session value:
1

Yii::$app->session->remove('key');


  1. Clear all session values:
1

Yii::$app->session->removeAll();


Note: Make sure you have configured the session component in your application configuration file (config/web.php). By default, Yii 2 uses the yii\web\Session class for session management.


How to pass parameters to a controller action in Yii 2?

In Yii 2, you can pass parameters to a controller action in multiple ways:

  1. Query Parameters: You can pass parameters as part of the URL query string. For example, if your action is actionView($id), you can pass the $id parameter as /controller/view?id=123.
  2. Route Parameters: You can define a route with a parameter placeholder in your URL rule configuration. For example, if your action is actionView($id), you can define a route like '/controller/view/' and then pass the $id parameter as /controller/view/123.
  3. Request Body Parameters: You can pass parameters in the request body for POST, PUT, or DELETE requests. In Yii 2, you can access these parameters using the request component. For example, if your action is actionCreate(), you can pass the parameters in the request body and access them using $postParams = Yii::$app->request->post();.
  4. Route parameters with URL rules: You can define complex URL rules that include multiple parameters. For example, if your action is actionSearch($category, $query), you can define a route like '//' and then pass the $category and $query parameters as /books/Yii.


Overall, Yii 2 provides multiple ways to pass parameters to a controller action, and the choice depends on the specific requirements of your application.


How to specify access rules for a controller in Yii 2?

In Yii 2, you can specify access rules for a controller by creating a method named accessRules() in your controller class. This method should return an array of access rules.


Here is an example of how to specify access rules for a controller in Yii 2:

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38

namespace app\controllers;

use yii\web\Controller;
use yii\filters\AccessControl;

class MyController extends Controller
{
    // ...

    public function behaviors()
    {
        return [
            'access' => [
                'class' => AccessControl::class,
                'rules' => $this->accessRules(),
            ],
        ];
    }

    public function accessRules()
    {
        return [
            [
                'controllers' => ['my'],
                'actions' => ['index'],
                'allow' => true,
                'roles' => ['@'], // Allow authenticated users
            ],
            [
                'controllers' => ['my'],
                'allow' => false,
                'roles' => ['?'], // Deny guest users
            ],
        ];
    }

    // ...
}


In the example above, the accessRules() method returns an array of access rules. Each access rule is defined as an array with the following properties:

  • controllers: An array of controller IDs that this rule applies to. In this example, the rule applies to the 'my' controller.
  • actions: An array of action IDs that this rule applies to. In this example, the rule applies to the 'index' action.
  • allow: Specifies whether to allow or deny access. In this example, the rule allows access.
  • roles: An array of role names that can access the specified controller and action. In this example, the rule allows access to authenticated users by specifying the '@' role, and denies access to guest users by specifying the '?' role.


Note: You can customize the access rules according to your application's requirements.

Best Yii 2 Cloud Hosting Providers in 2024

1
DigitalOcean

Rating is 5 out of 5

DigitalOcean

Try It Now
2
AWS

Rating is 4.9 out of 5

AWS

Try It Now
3
Vultr

Rating is 4.8 out of 5

Vultr

Try It Now
4
Cloudways

Rating is 4.7 out of 5

Cloudways

Try It Now


How to register an action filter for a controller in Yii 2?

To register an action filter for a controller in Yii 2, you need to follow these steps:

  1. Create a new class for your action filter, for example, MyFilter. This class should extend the yii\base\ActionFilter class.
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18

namespace app\filters;

use yii\base\ActionFilter;

class MyFilter extends ActionFilter
{
    public function beforeAction($action)
    {
        // Code to be executed before the action is executed
        return parent::beforeAction($action);
    }

    public function afterAction($action, $result)
    {
        // Code to be executed after the action is executed
        return parent::afterAction($action, $result);
    }
}


  1. In your controller class, add a behaviors() method that returns an array of filters to be applied to the actions. You can specify the filters for the whole controller or for individual actions.
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27

namespace app\controllers;

use yii\web\Controller;
use app\filters\MyFilter;

class MyController extends Controller
{
    public function behaviors()
    {
        return [
            'myFilter' => [
                'class' => MyFilter::class,
                'only' => ['action1', 'action2'], // Apply the filter only to these actions
            ],
        ];
    }

    public function action1()
    {
        // Your action code
    }

    public function action2()
    {
        // Your action code
    }
}


In this example, the MyFilter filter is registered for the action1 and action2 actions of the MyController controller.


Note: Don't forget to import the appropriate namespaces (use statements) for the filter class and the controller class.


How to redirect to another controller action in Yii 2?

In Yii 2, you can redirect to another controller action using the redirect() method. Here's an example:

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16

use yii\web\Controller;
use yii\helpers\Url;

class SiteController extends Controller
{
    public function actionIndex()
    {
        // Redirect to the 'about' action of the 'site' controller
        return $this->redirect(['site/about']);
    }

    public function actionAbout()
    {
        return $this->render('about');
    }
}


In the example above, the actionIndex() method uses the redirect() method to redirect to the about action of the site controller. The ['site/about'] parameter passed to the redirect() method is an array representing the URL to redirect to. You can also use the Url::to() method to generate the URL dynamically.


You can also specify the HTTP status code for the redirect by passing it as the second parameter to the redirect() method. By default, it uses 302 Found status code.


Note that you should return the redirect() method in your action method to properly perform the redirection.

Facebook Twitter LinkedIn Telegram

Related Posts:

How to Create And Apply Yii 2 Console Commands?
Yii 2 is a powerful PHP framework that allows developers to easily create web applications. One of the key features of Yii 2 is the ability to create and apply console commands. Console commands are scripts that can be executed via the command line, allowing d...
How to Install Yii 2 Framework?
To install Yii 2 framework, follow these steps:Ensure that your system meets the minimum requirements for Yii 2. These include PHP 5.4 or later and various PHP extensions such as PDO, OpenSSL, and Mbstring. Download the latest version of Yii 2 from the officia...
How to Create A New Yii 2 Project?
To create a new Yii 2 project, you can follow these steps:Install Yii 2: Make sure you have Yii 2 installed on your system. If not, you can install it by running the following command in your terminal: composer global require &#34;fxp/composer-asset-plugin:^1....