roaresearch\yii2\roa\actions\Index

Complexity

Total Complexity

4

Size/Duplication

Total Lines	39
Duplicated Lines	0 %

Test Coverage

Coverage

84.62%

Importance

Changes

0

<?php
 */
class Index extends Action
{
    /**
     * @var string model class to retreive the records on the collection.
     */
    public string $searchClass;

    /**
     * @var string name of the form containing the filter data.
     */
    public string $formName = '';

    /**
     * @inheritdoc
     */
    public function init()
    {
        $this->searchClass ?: throw new InvalidConfigException(
            $this::class . '::$searchClass must be set.'
        );
    }

    /**
     * @return DataProviderInterface|ActiveRecordInterface
     */
    public function run(): DataProvideInterface | ARContractSearch
    {
        $searchModel = $this->buildSearchModel();
        $dataProvider = $searchModel->search(
            Yii::$app->request->getQueryParams(),
            $this->formName
        );
        $this->checkAccess($searchModel, Yii::$app->request->getQueryParams());

        return $dataProvider ?: $searchModel;
    }

    /**
     * @return ARContractSearch the model used to create the data provider