fabrazer/yii2-helpers

0.0.4 2018-12-07 15:47 UTC

Requires

• php: >=5.4.0

MIT

README

Features

1. Displaying, Sorting and Filtering Model Relations on a GridView

   The EnableRelatedModelSearch trait is used to easily enable the displaying, sorting and filtering via model relations on a GridView.

   This trait does the job which is described under this link: https://www.yiiframework.com/wiki/653/displaying-sorting-and-filtering-model-relations-on-a-gridview

Installation

$ php composer.phar require fabrazer/yii2-helpers "@dev"

Usage

1. EnableRelatedModelSearch

   1. Enable trait

      namespace app\models\search;
      
      use fabrazer\helpers\traits\EnableRelatedModelSearch;
      
      class TourSearch extends Tour
      {
      	use EnableRelatedModelSearch;
      
      	// Your code ...
      }
      

   2. Add missing rules to your search model

      public function rules()
      {
      	$rules = [
      		// Your rules
      	];
      
      	// Add rules of the relations "city" and "country"
      	$this->enableRelatedModelSearchRules(['city', 'country'], $rules);
      
      	return $rules;
      }
      

   3. Add missing attributes

      public function attributes()
      {
      	// Add attributes of the relations "city" and "country"
      	return $this->enableRelatedModelSearchAttributes(['city', 'country'], parent::attributes());
      }
      

   4. Add sorting and filtering to the query

      public function search($params)
      {
      	// Your code ...
      
      	// Add sorting and filtering to the query
      	$this->enableRelatedModelSearch(['city', 'country'], $dataProvider);
      }