cashwarden / api

modules/v1/controllers/ActiveController.php

<?php

namespace app\modules\v1\controllers;

use app\core\actions\CreateAction;
use app\core\exceptions\InternalException;
use app\core\exceptions\InvalidArgumentException;
use app\core\helpers\SearchHelper;
use sizeg\jwt\JwtHttpBearerAuth;
use Yii;
use yii\base\InvalidConfigException;
use yii\base\Model;
use yii\data\ActiveDataProvider;
use yii\db\ActiveRecord;
use yii\filters\Cors;
use yii\web\ForbiddenHttpException;
use yiier\helpers\SearchModel;
use yiier\helpers\Setup;

/**
 *
 * @property-read int $pageSize
 */
class ActiveController extends \yii\rest\ActiveController
{
    protected const MAX_PAGE_SIZE = 100;
    protected const DEFAULT_PAGE_SIZE = 20;
    public $defaultOrder = ['id' => SORT_DESC];
    public $partialMatchAttributes = [];
    public $stringToIntAttributes = [];
    public $relations = [];

    /**
     * 不参与校验的 actions
     * @var array
     */
    public $noAuthActions = [];

    // 序列化输出
    public $serializer = [
        'class' => 'yii\rest\Serializer',
        'collectionEnvelope' => 'items',
    ];

    public function behaviors()
    {
        $behaviors = parent::behaviors();

        // 跨区请求 必须先删掉 authenticator
        $behaviors['authenticator'];
        unset($behaviors['authenticator']);

        $behaviors['corsFilter'] = [
            'class' => Cors::class,
            'cors' => [
                'Origin' => ['*'],
                'Access-Control-Request-Method' => ['GET', 'POST', 'PUT', 'DELETE', 'OPTIONS'],
                'Access-Control-Request-Headers' => ['*'],
                'Access-Control-Max-Age' => 86400,
            ]
        ];
        $behaviors['authenticator'] = [
            'class' => JwtHttpBearerAuth::class,
            'optional' => array_merge($this->noAuthActions, ['options']),
        ];

        return $behaviors;
    }

    public function actions()
    {
        $actions = parent::actions();
        $actions['index']['prepareDataProvider'] = [$this, 'prepareDataProvider'];
        $actions['create']['class'] = CreateAction::class;
        return $actions;
    }

    /**
     * @return ActiveDataProvider
     * @throws InvalidArgumentException
     * @throws InternalException
     * @throws InvalidConfigException
     * @throws \Exception
     */
    public function prepareDataProvider()
    {
        /** @var ActiveRecord $modelClass */
        $modelClass = $this->modelClass;
        $searchModel = new SearchModel([
            'defaultOrder' => $this->defaultOrder,
            'model' => $modelClass,
            'relations' => $this->relations,
            'scenario' => 'default',
            'partialMatchAttributes' => $this->partialMatchAttributes,
            'pageSize' => $this->getPageSize()
        ]);

        $params = $this->formatParams(Yii::$app->request->queryParams);
        foreach ($this->stringToIntAttributes as $attribute => $className) {
            if ($type = data_get($params, $attribute)) {
                $params[$attribute] = SearchHelper::stringToInt($type, $className);
            }
        }
        unset($params['sort']);

        $dataProvider = $searchModel->search(['SearchModel' => $params]);
        $dataProvider->query->andWhere([$modelClass::tableName() . '.user_id' => Yii::$app->user->id]);

The method andWhere() does not exist on null.

        return $dataProvider;
    }


    protected function formatParams(array $params)
    {
        return $params;
    }

    /**
     * @return int
     */
    protected function getPageSize()
    {
        if ($pageSize = (int)request('pageSize')) {
            if ($pageSize < self::MAX_PAGE_SIZE) {
                return $pageSize;
            }
            return self::MAX_PAGE_SIZE;
        }
        return self::DEFAULT_PAGE_SIZE;
    }


    /**
     * @param Model $model
     * @param array $params
     * @return Model
     * @throws InvalidArgumentException
     */
    public function validate(Model $model, array $params): Model
    {
        $model->load($params, '');
        if (!$model->validate()) {
            throw new InvalidArgumentException(Setup::errorMessage($model->firstErrors));
        }
        return $model;
    }

    /**
     * @param string $action
     * @param null $model

Are you sure the doc-type for parameter $model is correct as it would always require null to be passed?

     * @param array $params
     * @throws ForbiddenHttpException
     */
    public function checkAccess($action, $model = null, $params = [])
    {
        if (in_array($action, ['delete', 'update', 'view'])) {
            if ($model->user_id !== \Yii::$app->user->id) {
                throw new ForbiddenHttpException(
                    t('app', 'You can only ' . $action . ' data that you\'ve created.')
                );
            }
        }
    }
}