roboapp\crud\Index

Complexity

Total Complexity

4

Size/Duplication

Total Lines	67
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	4

Test Coverage

Coverage

100%

Importance

Changes	4
Bugs	1	Features	1

3 Methods

Rating	Name	Duplication	Size	Complexity
A	newSearchModel()	0	4	1
A	dataProvider()	0	8	2
A	run()	0	10	1

<?php
/**
 * @link https://github.com/roboapp
 * @copyright Copyright (c) 2016 Roboapp
 * @license [MIT License](https://opensource.org/licenses/MIT)
 */

namespace roboapp\crud;

use Yii;
use yii\base\InvalidConfigException;
use yii\base\Model;

/**
 * Action displays the models list with search support.
 *
 * @author iRipVanWinkle <iripvanwinkle@gmail.com>
 * @since 1.0
 */
class Index extends BaseAction
{
    /**
     * @var string | callable a PHP callable that will be called to create the search model.
     * The callable should return the new model instance.
     */
    public $searchModel;

    /**
     * @var string name of the view
     */
    public $view = 'index';

    /**
     * @var string the name variable model in the view template
     */
    public $nameVariableModel = 'model';

    /**
     * @var string the name variable data provider in the view template
     */
    public $nameVariableDataProvider = 'dataProvider';

    /**
     * @var string the method name  for return DataProvider
     */
    public $searchMethodName = 'search';

    /**
     * Creates new search model instance.
     * @return Model new model instance.
     * @throws InvalidConfigException on invalid configuration.
     */
    protected function newSearchModel()
    {
        return \Yii::createObject($this->searchModel);
    }

    /**
     * @param Model $model new model instance.
     * @return mixed
     * @throws InvalidConfigException
     */
    protected function dataProvider($model)
    {
        if (method_exists($model, $this->searchMethodName)) {
            return $model->{$this->searchMethodName}(Yii::$app->getRequest()->getQueryParams());
        }

        throw new InvalidConfigException('"' . get_class($this) . '::searchModel" must be set existing method.');
    }

    /**
     * Displays models list.
     * @return mixed response.
     */
    public function run()
    {
        $searchModel = $this->newSearchModel();
        $dataProvider = $this->dataProvider($searchModel);

        return $this->controller->render($this->view, [
            $this->nameVariableModel => $searchModel,
            $this->nameVariableDataProvider => $dataProvider,
        ]);
    }
}