Yii2 - Return Response during beforeAction

Question

I am building a test API. I have created a Controller Page which extends from yii\rest\Controller. Actions needs to send a response.

To access actions in this controller, a service_id value needs to be posted. If present I need to evaluate if that service_id exists, if it is active and belongs to the user logged in. If validation fails, I need to send a response.

I am trying to do it using beforeAction(), but the problem is that return data is used to validate if action should continue or not.

So my temporary solution is saving service object in a Class attribute to evaluate it in the action and return response.

class PageController extends Controller
{

    public $service;

    public function beforeAction($action)
    {
        parent::beforeAction($action);

        if (Yii::$app->request->isPost) {

            $data = Yii::$app->request->post();
            $userAccess = new UserAccess();
            $userAccess->load($data);

            $service = $userAccess->getService();
            $this->service = $service;
        }

        return true;
    }

    public function actionConnect()
    {

        $response = null;

        if (empty($this->service)) {
            $response['code'] = 'ERROR';
            $response['message'] = 'Service does not exist';

            return $response;
        }
    }
}

But I can potentially have 20 actions which require this validation, is there a way to return the response from the beforeAction method to avoid repeating code?

Answer 1

You can setup response in beforeAction() and return false to avoid action call:

public function beforeAction($action) {
    if (Yii::$app->request->isPost) {
        $userAccess = new UserAccess();
        $userAccess->load(Yii::$app->request->post());
        $this->service = $userAccess->getService();

        if (empty($this->service)) {
            $this->asJson([
                'code' => 'ERROR',
                'message' => 'Service does not exist',
            ]);

            return false;
        }
    }

    return parent::beforeAction($action);
}