YII как сделать наследование CRUD операции от базового контроллера? Как использовать?

Question

[Максим]

Всем привет! В проекте очень много повторяющихся действий для CRUD операций, много видов с однотипным кодом. Хочется это все упросить с помощью наследования или другого метода. Таким образом у нас получится единый круд, а динамические данные будем передавать параметрами. Есть ли что-то подобное? Как вообще это можно сделать? Ведь тогда нужно будет создавать лишь один контроллер, а виды будут сами подтягиваться, кроме формы и _columns

Может быть имеет смысл вынести CRUD действия контроллеров в классы?

Answer 1

[Сергей]

Я что-то не понимаю, наверное, но ведь это классика - создать модель, где будут нужные методы, и использовать их в контроллере. Т.е. все CRUD операции держать в отдельном классе, которые будут в models, подключать этот класс в нужных контроллерах и использовать методы там (обращаясь к ним статически)

Пример:

в frontend/models создаете файл Crud.php:

namespace frontend\models;

Class Crud extends Model {
    public static function getData() {
        return ... // тут какие-нибудь вычисления или берем что-то из БД и т.п.
    }
}

После в любом контроллере подключаете эту модель:
use frontend\models\Crud;

И используете:
$some_res = Crud::getData();

Comments

[Максим]

Благодарю. Выше ответ показался более понятным и полезным. А у вас есть пример о том, что говорите? Просто не все понимаю как сделать до конца.

И вопрос с видами? Их все равно дублировать нужно будет?

[Сергей]

Максим Ворожцов, обновил ответ, если не понятно что-то - спрашивайте

[Максим]

Сергей, благодарю. А что вы посоветуете использовать? Модель или контроллер?

[Сергей]

Максим Ворожцов,

По правилам хорошего тона в контроллере не должно быть никаких операций\вычислений. Он отвечает только за маршрутизацию - "берем это отсюда и отображаем там-то". Все вычисления, запросы к БД должны быть в моделях. (Почитайте про MVC)

Конечно, все так или иначе этим пренебрегают, но, отвечая на Ваш вопрос "что лучше" - лучше, получается, модели.

Пример, когда этим все пренебрегают, не смотря на каноны:
Допустим, Вам надо брать данные из БД 2 раза. Взять данные 2 раза = 2 строки кода, примерно таких:
Table::find()->where()->...->one();

А создавать отдельный класс, где будет один метод, который возвращает результат той же строки - уже overkill, получается.

[Максим]

Сергей, понял)) Благодарю)) А как в этом случае поступать с видами?)

[Сергей]

Максим Ворожцов, что именно Вас смущает с видами?
Они почти всегда рендерятся внутри контроллера.

return $this->render('viefile');

[Максим]

Сергей, имею ввиду их никак не сократить?)

[Сергей]

Максим Ворожцов, Ну можно разбивать одну большую вьюху на много маленьких частей, и вызывать echo $this->render() внутри большой вьюхи для каждой части.

[Максим]

Сергей, понял) Благодарю!

Answer 2

[Дмитрий Ким]

Я использую нечто такое:

abstract CrudController extends Controller {
  public $modelClass;
  public $searchModelClass;

  public function actionIndex(){
    $searchModel = new $this->searchModel;
    // ...
  }

  public function actionView($id){
    $model = $this->findModel($id);
    // ...
    return $this->render('view', ['model' => $model]);
  }
  public function actionCreate(){
    $model = new $this->modelClass;
    // ...
  }
  public function actionUpdate($id){
    $model = $this->findModel($id);
    // ...
  }
  public function actionDelete($id){
    $model = $this->findModel($id);
    // ...
  }
  private function findModel($id){
    $modelCLass = new $this->modelClass;
    $model = $modelClass::findOne($id);
    // ...
    return $model;
  }
}

class ProductController extends CrudController {
  public $modelClass = '\app\common\models\Product';
  public $searchModelClass = '\backend\modules\product\models\Product';
}

class ItemController extends CrudController {
  public $modelClass = '\app\common\models\Item';
  public $searchModelClass = '\backend\modules\product\models\Item';
}

Фишка в том, что если использовать разделение на модули, то и не нужно прописывать каждому контроллеру пути для вьюшек, все будет лежать в модулях на своих местах.

Так же можно добавить проверку прав доступа:

abstract CrudController extends Controller {
  public $permissions = [
    'index' => null,
    'view' => null,
    'create' => null,
    'update' => null,
    'delete' => null,
  ];
  // ...
  public function actionView(){
    if (isset($this->permissions['view']) && !Yii::$app->user->can($this->permissions['view']){
      throw new ForbiddenException();
    }
  }
}

class ProductController extends CrudController {
  public $permissions = [
    'index' => 'indexProduct',
    'view' => 'viewProduct',
    //...
  ];
}

class ItemController extends CrudController {
  public function beforeAction() {
    $this->permissions = array_merge(parent::$permissions, [
      'view' => 'viewItem',
    ]);
    return parent::beforeAction();
  }
}

Еще можно добавить сценарии на свой вкус:

abstract CrudController extends Controller {
  public $scenarios = [
    'index' => Model::SCENARIO_DEFAULT,
    'view' => Model::SCENARIO_DEFAULT,
    'create' => Model::SCENARIO_DEFAULT,
    'update' => Model::SCENARIO_DEFAULT,
    'delete' => Model::SCENARIO_DEFAULT,
  ];

  public function actionView($id){
    $model = $this->findModel($id);
    $model->scenario = $this->scenario['view'];
  }
  // ...
}
class ProductController extends CrudController {
  public function beforeAction() {
    $this->scenarios['view'] = Product::SCENARIO_VIEW;
    return parent::beforeAction();
  }
}

Comments

[Максим]

Благодарю за развёрнутый ответ с примерами! Скажите, а сами виды не пытались как-то усовершенствовать в этом случае? Ведь в видах тоже самое дублируется из круда в круд

[Дмитрий Ким]

Максим Ворожцов, с видами сложнее, так как негоже формировать отображение в контроллерах, а именно туда придётся выносить настройки конкретных видов: список полей, типы и т.д. Виды через gii уже принимают адекватный вид (кстати сам gii я отнаследовал и изменил шаблоны для генерации, добавил свои стили, подписи и т.д., поэтому при автогенерации они уже "съедобны").

[Максим]

Дмитрий Ким понял)) Но было бы хорошо ещё над видами поработать. Для того и программирование, чтобы все упрощать) Можно, конечно, не заморачиваться и сделать как вы посоветовали) Если не будет вариантов - так и сделаю) А что касается генератора - тоже свой сделал)