Yii2 RESTクエリ

Question

やあ。 yii\rest\ActiveControllerを拡張するProductControllerがあります。質問は、HTTP GETリクエストを介してクエリを作成する方法です。

例： http：//api.test.loc/v1/products/search？name = iphone

また、戻りオブジェクトには、iphoneという名前のすべての製品が含まれます。

Answer 1

わかりました。コントローラーにこれを配置し、configでURLルートを変更してください。

public function actionSearch()
{
    if (!empty($_GET)) {
        $model = new $this->modelClass;
        foreach ($_GET as $key => $value) {
            if (!$model->hasAttribute($key)) {
                throw new \yii\web\HttpException(404, 'Invalid attribute:' . $key);
            }
        }
        try {
            $provider = new ActiveDataProvider([
                'query' => $model->find()->where($_GET),
                'pagination' => false
            ]);
        } catch (Exception $ex) {
            throw new \yii\web\HttpException(500, 'Internal server error');
        }

        if ($provider->getCount() <= 0) {
            throw new \yii\web\HttpException(404, 'No entries found with this query string');
        } else {
            return $provider;
        }
    } else {
        throw new \yii\web\HttpException(400, 'There are no query string');
    }
}

そしてURLルール（編集）

'urlManager' => [
        'enablePrettyUrl' => true,
        'enableStrictParsing' => true,
        'showScriptName' => false,
        'rules' => [
            ['class' => 'yii\rest\UrlRule', 'controller' => ['v1/product'], 'extraPatterns' => ['GET search' => 'search']],
        ],
    ],

Answer 2

更新：2016年4月29日

これは、前回の更新で紹介した方法よりも簡単な方法です。それは常にgiiによって生成されたSearchクラスを含むことについてです。これを使用して、カスタムシナリオの使用、検証の処理、またはフィルタリングプロセスでの関連モデルの関与など、すべての検索関連ロジックを1か所で定義および維持します（このように 例 ）。だから私は私の最初の答えに戻ります：

_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);
}
_

次に、検索クラスがload($params,'')ではなくload($params)を使用していることを確認するか、これをmodelに追加しますクラス：

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

これでリクエストは次のようになります。

/ products？name = iphone＆status = available＆sort = name、-price

---

更新：2015年9月23日

これは同じアプローチですが、完全でよりクリーンなソリューションを実装することによって：

_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);     
    }
}
_

これで、GETリクエストは次のようになります。

/ products？name = iphone

またはさらに：

/ products？name = iphone＆status = available＆sort = name、-price

• 注：

  _/products?name=iphone_の代わりに、次のようなリクエストの検索またはフィルタリングを処理する特定のアクションを探している場合：

  / products/search？name = iphone

  次に、上記のコードで、すべてのコンテンツを含むアクション関数をremoveする必要があります。

  public function actions() { ... }

  rename：indexDataProvider() to actionSearch()

  ＆最後にadd_'extraPatterns' => ['GET search' => 'search']_をyii\web\UrlManager :: rulesに記述のとおり@KedvesHunorの答えで。

---

元の回答：2015年5月31日

Giiを使用してモデルのCRUDを生成するときに、Search Model Classを定義した場合、これを行う簡単な方法があります。 、その後、それを使用して結果をフィルタリングできます。あなたがしなければならないことは、prepareDataProviderのindexAction関数をオーバーライドして、モデルのActiveDataProvider関数によって返されるsearchインスタンスを強制的に返すことです検索クラスカスタムの新しいものを作成するのではなく。

モデルがProduct.phpであり、ProductSearch.php検索クラスとしてそれから、あなたのコントローラでこれを追加するだけです：

_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);
}
_

次に、結果をフィルタリングするために、URLは次のようになります。

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

またはこのようにさえ：

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

Answer 3

スーパーグローバル$ _GETを直接使用することはお勧めしません。代わりに、Yii::$app->request->get()を使用できます。

以下は、一般的な検索アクションを作成してコントローラーで使用する方法の例です。

コントローラー側

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);
}

カスタム検索アクション

<?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;
    }

}

Answer 4

Config/web.php-> Add 'extraPatterns' => ['GET search' => 'search']を追加

'urlManager' => [
        'enablePrettyUrl' => true,
        'showScriptName' => false,
        'rules' => [['class' => 'yii\rest\UrlRule', 'controller' => 'v1/basicinfo', 'pluralize'=>false,'extraPatterns' => ['GET search' => 'search']]]]

**レストAPIコントローラ内：-Moduels/v1/controllers/**

basicinfo：-コントローラの名前、名前、年齢はフィールドの名前です。テーブルに存在するすべてのパラメータを追加できます。

次のような検索URL：-basicinfo/search？name = yogi＆age = 12-2

include use yii\data\ActiveDataProvider;

 public function actionSearch()
{
    if (!empty($_GET)) {
        $model = new $this->modelClass;
        foreach ($_GET as $key => $value) {
            if (!$model->hasAttribute($key)) {
                throw new \yii\web\HttpException(404, 'Invalid attribute:' . $key);
            }
        }
        try {

           $query = $model->find();
            foreach ($_GET as $key => $value) {
                 if ($key != 'age') {
                    $query->andWhere(['like', $key, $value]);
                  }
                  if ($key == 'age') {
                  $agevalue = explode('-',$value);
                  $query->andWhere(['between', $key,$agevalue[0],$agevalue[1]]);

             }

            }

            $provider = new ActiveDataProvider([
                'query' => $query,
                'sort' => [
                    'defaultOrder' => [
                        'updated_by'=> SORT_DESC
                    ]
                ],
                  'pagination' => [
                'defaultPageSize' => 20,
            ],
            ]);
        } catch (Exception $ex) {
            throw new \yii\web\HttpException(500, 'Internal server error');
        }

        if ($provider->getCount() <= 0) {
            throw new \yii\web\HttpException(404, 'No entries found with this query string');
        } else {
            return $provider;
        }
    } else {
        throw new \yii\web\HttpException(400, 'There are no query string');
    }
}

Answer 5

yii 2.0.13、yii\rest\IndexActionに新しいプロパティ-dataFilterが追加されたため、フィルタリングプロセスが簡略化されます。デフォルトでは、ActiveControllerはindexアクションにyii\rest\IndexActionを使用します：

    class ActiveController extends Controller {
        public function actions()
        {
            return [
                'index' => [
                    'class' => 'yii\rest\IndexAction',
                    'modelClass' => $this->modelClass,
                    'checkAccess' => [$this, 'checkAccess'],
                ]
        }
}

ProductControllerコントローラーで以下を実行します。

class ProductController extends ActiveController
{
    public function actions()
    {
        $actions = parent::actions();

        $actions['index']['dataFilter'] = [
            'class' => 'yii\data\ActiveDataFilter',
            'searchModel' => 'app\models\ProductSearch'
        ];

        return $actions;
    }
}

app\models\ProductSearchが製品フィルターモデルであると想定します。

Answer 6

次のようにAPIにアクセスする必要がある場合：api/product/index?name=fashionフィルタリングする短い方法は次のとおりです。
-アクションの設定を解除します。私の場合はindexアクションです。

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

• 以下に示すように、カスタムクエリを実行します。

  public function actionIndex（）{

  $query = Product::find();
  $dataProvider =  new ActiveDataProvider([
      'query' => $query,
      'pagination' => [
              'pageSize' => 1,
          ],
  ]);
  
  if (isset($_GET['name']) && !empty($_GET['name'])) {
      $searchWord = strtolower(trim($_GET['name']));
      $query->andFilterWhere(['like', 'name', $searchWord]);
  }
  
  return $dataProvider;
  

  }