Yii2 RESTE de la requête

Mise à JOUR: 29 Avril 2016

C'est une approche plus simple que celui que j'ai présenté dans la précédente mise à jour. Il est toujours à propos de l'implication de la de Recherche classe générée par gii. J'aime l'utiliser pour définir et maintenir l'ensemble de la recherche, de la logique en un seul endroit, comme l'utilisation de scénarios personnalisés, gérer les validations, ou qui impliquent des modèles connexes sur le processus de filtrage (comme dans cette exemple). Donc, je vais revenir à ma première réponse :

public function actions() 
{ 
    $actions = parent::actions();
    $actions['index']['prepareDataProvider'] = [$this, 'prepareDataProvider'];
    return $actions;
}

public function prepareDataProvider() 
{
    $searchModel = new \app\models\ProductSearch();    
    return $searchModel->search(\Yii::$app->request->queryParams);
}

Alors assurez-vous que votre recherche est la classe à l'aide de load($params,'') au lieu de load($params) ou bien ajoutez à cela le modèle classe:

class Product extends \yii\db\ActiveRecord
{
    public function formName()
    {
        return '';
    }

Qui devrait être suffisant pour avoir de vos demandes de recherche comme:

/produits?nom=iphone&mode=&tri=nom, prix

---

Mise à JOUR: 23 septembre 2015

C'est la même approche, mais par la mise en œuvre complète & solution de nettoyage :

namespace app\api\modules\v1\controllers;
use yii\rest\ActiveController;
use yii\helpers\ArrayHelper;
use yii\web\BadRequestHttpException;
class ProductController extends ActiveController
{
public $modelClass = 'app\models\Product';
//Some reserved attributes like maybe 'q' for searching all fields at once 
//or 'sort' which is already supported by Yii RESTful API
public $reservedParams = ['sort','q'];
public function actions() {
$actions = parent::actions();
//'prepareDataProvider' is the only function that need to be overridden here
$actions['index']['prepareDataProvider'] = [$this, 'indexDataProvider'];
return $actions;
}
public function indexDataProvider() {
$params = \Yii::$app->request->queryParams;
$model = new $this->modelClass;
//I'm using yii\base\Model::getAttributes() here
//In a real app I'd rather properly assign 
//$model->scenario then use $model->safeAttributes() instead
$modelAttr = $model->attributes;
//this will hold filtering attrs pairs ( 'name' => 'value' )
$search = [];
if (!empty($params)) {
foreach ($params as $key => $value) {
//In case if you don't want to allow wired requests
//holding 'objects', 'arrays' or 'resources'
if(!is_scalar($key) or !is_scalar($value)) {
throw new BadRequestHttpException('Bad Request');
}
//if the attr name is not a reserved Keyword like 'q' or 'sort' and 
//is matching one of models attributes then we need it to filter results
if (!in_array(strtolower($key), $this->reservedParams) 
&& ArrayHelper::keyExists($key, $modelAttr, false)) {
$search[$key] = $value;
}
}
}
//you may implement and return your 'ActiveDataProvider' instance here.
//in my case I prefer using the built in Search Class generated by Gii which is already 
//performing validation and using 'like' whenever the attr is expecting a 'string' value.
$searchByAttr['ProductSearch'] = $search;
$searchModel = new \app\models\ProductSearch();    
return $searchModel->search($searchByAttr);     
}
}

Maintenant votre demande GET va ressembler :

/produits?nom=iphone

Ou même comme :

/produits?nom=iphone&mode=&tri=nom, prix

• Remarque:

  Si, au lieu de /products?name=iphone vous êtes à la recherche pour un
  l'action de la poignée de recherche ou de filtrage des requêtes comme :

  /produits/search?nom=iphone

  Ensuite, dans le code ci-dessus, vous aurez besoin de supprimer les actions en fonction avec l'ensemble de son contenu :

  public function actions() { ... }

  renommer :indexDataProvider() à actionSearch()

  & enfin ajouter 'extraPatterns' => ['GET search' => 'search'] à votre yii\web\UrlManager::règles comme décrit
  dans @KedvesHunor de réponse.

---

Original de réponse: 31 Mai 2015

Il y a un court chemin pour ce faire, si lors de l'utilisation de Gii pour générer CRUD pour votre modèle, vous avez défini un Modèle de Recherche de Classe, alors vous pouvez l'utiliser pour filtrer les résultats, tout ce que vous avez à faire est de remplacer la prepareDataProvider fonction de indexAction à force de retourner le ActiveDataProvider instance retournée par la search fonction de votre modèle de de recherche de classe plutôt que d'en créer un nouveau.

À reprendre si votre modèle est Product.php & vous avez généré un ProductSearch.php comme un de recherche de classe, puis dans votre Contrôleur vous avez juste besoin d'ajouter ceci :

public function actions() {
$actions = parent::actions();
$actions['index']['prepareDataProvider'] = [$this, 'prepareDataProvider'];
return $actions;
}
public function prepareDataProvider() {
$searchModel = new \app\models\ProductSearch();    
return $searchModel->search(\Yii::$app->request->queryParams);
}

Puis de filtrer les résultats, votre url peut ressembler à ceci :

api.test.loc/v1/products?ProductSearch[name]=iphone

ou même comme ceci :

api.test.loc/v1/products?ProductSearch[available]=1&ProductSearch[name]=iphone

OriginalL'auteur Salem Ouerdani

Je recommande de ne pas utiliser les Superglobales $_GET directement . Au lieu de cela, vous pouvez utiliser Yii::$app->request->get().

Est le suivant comment vous pouvez créer une recherche générique de l'action et de l'utiliser dans le contrôleur.

Au contrôleur Fin

public function actions() {
$actions = [
'search' => [
'class'       => 'app\[YOUR NAMESPACE]\SearchAction',
'modelClass'  => $this->modelClass,
'checkAccess' => [$this, 'checkAccess'],
'params'      => \Yii::$app->request->get()
],
];
return array_merge(parent::actions(), $actions);
}
public function verbs() {
$verbs = [
'search'   => ['GET']
];
return array_merge(parent::verbs(), $verbs);
}

De La Recherche Personnalisée De L'Action

<?php
namespace app\[YOUR NAMESPACE];
use Yii;
use yii\data\ActiveDataProvider;
use yii\rest\Action;
class SearchAction extends Action {
/**
* @var callable a PHP callable that will be called to prepare a data provider that
* should return a collection of the models. If not set, [[prepareDataProvider()]] will be used instead.
* The signature of the callable should be:
*
* ```php
* function ($action) {
*     //$action is the action object currently running
* }
* ```
*
* The callable should return an instance of [[ActiveDataProvider]].
*/
public $prepareDataProvider;
public $params;
/**
* @return ActiveDataProvider
*/
public function run() {
if ($this->checkAccess) {
call_user_func($this->checkAccess, $this->id);
}
return $this->prepareDataProvider();
}
/**
* Prepares the data provider that should return the requested collection of the models.
* @return ActiveDataProvider
*/
protected function prepareDataProvider() {
if ($this->prepareDataProvider !== null) {
return call_user_func($this->prepareDataProvider, $this);
}
/**
* @var \yii\db\BaseActiveRecord $modelClass
*/
$modelClass = $this->modelClass;
$model = new $this->modelClass([
]);
$safeAttributes = $model->safeAttributes();
$params = array();
foreach($this->params as $key => $value){
if(in_array($key, $safeAttributes)){
$params[$key] = $value;                
}
}
$query = $modelClass::find();
$dataProvider = new ActiveDataProvider([
'query' => $query,
]);
if (empty($params)) {
return $dataProvider;
}
foreach ($params as $param => $value) {
$query->andFilterWhere([
$param => $value,
]);
}
return $dataProvider;
}
}

OriginalL'auteur Rx Seven