Yii 中特殊行為 ActionFilter 的使用示例

新建 app\filters\LoggingFilter 繼承 yii\base\ActionFilter

LoggingFilter 的功能: 在指定請求的 action 前後各記錄一條日誌

<?php

namespace app\filters;

use yii\base\ActionFilter;

class LoggingFilter extends ActionFilter
{
    public function beforeAction($action)
    {
        parent::beforeAction($action);

        // To do something
        printf('This is a logging for %s\beforeAction.%s', $this->getActionId($action), PHP_EOL);

        return true;
    }

    public function afterAction($action, $result)
    {
        parent::afterAction($action, $result);

        // To do something
        printf('This is a logging for %s\afterAction.%s', $this->getActionId($action), PHP_EOL);

        return true;
    }
}

新建 app\controllers\SystemController

<?php

namespace app\controllers;

use app\filters\LoggingFilter;

class SystemController extends \yii\web\Controller
{
    public function behaviors()
    {
        parent::behaviors();

        return [
            'anchorAuth' => [
                'class'  => LoggingFilter::className(),
                'only'   => ['test', 'test-one'], // 僅對 'test'、'test-one' 生效
                'except' => ['test-one'], // 排除 'test-one'
            ],
        ];
    }

    public function actionTestOne()
    {
        printf('This is a testing for %s.%s', $this->getRoute(), PHP_EOL);
    }

    public function actionTestTwo()
    {
        printf('This is a testing for %s.%s', $this->getRoute(), PHP_EOL);
    }

    public function actionTest()
    {
        printf('This is a testing for %s.%s', $this->getRoute(), PHP_EOL);
    }
}

測試

請求 http://yii.test/index.php?r=system/test

This is a logging for test\beforeAction.
This is a testing for system/test.
This is a logging for test\afterAction.

請求 http://yii.test/index.php?r=system/test-one

This is a testing for system/test-one.

請求 http://yii.test/index.php?r=system/test-two

This is a testing for system/test-two.

總結

Yii 中的 ActionFilter（過濾器）相當於 Laravel 中的 Middleware（中介軟體），beforeAction 相當於前置中介軟體，afterAction 相當於後置中介軟體。

原文連結

• github.com/guanguans/guanguans.git...

本作品採用《CC 協議》，轉載必須註明作者和本文連結