for testing and deploying your application
for finding and fixing issues
for empowering human code reviews
<?php
namespace roaresearch\yii2\roa\actions;
use roaresearch\yii2\roa\hal\ARContractSearch;
use Yii;
use yii\{base\InvalidConfigException, data\DataProviderInterface, di\Instance};
/**
* Action to retreive a filtered and sorted collection based on a `$searchClass`
*
* @author Angel (Faryshta) Guevara <[email protected]>
*/
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 | ARContractSearch
public function run(): DataProviderInterface | ARContractSearch
/** @var ARContractSearch $searchModel */
$searchModel = Instance::ensure(
['class' => $this->searchClass],
ARContractSearch::class
$dataProvider = $searchModel->search(
Yii::$app->request->getQueryParams(),
$this->formName
$this->checkAccess($searchModel, Yii::$app->request->getQueryParams());
return $dataProvider ?: $searchModel;
ROAResearch /
yii2-roa
