ActiveQuery.php 10.8 KB
Newer Older
1 2 3 4 5 6 7 8
<?php
/**
 * @link http://www.yiiframework.com/
 * @copyright Copyright (c) 2008 Yii Software LLC
 * @license http://www.yiiframework.com/license/
 */

namespace yii\elasticsearch;
Carsten Brandt committed
9

10 11
use yii\db\ActiveQueryInterface;
use yii\db\ActiveQueryTrait;
12
use yii\db\ActiveRelationTrait;
13 14

/**
15
 * ActiveQuery represents a [[Query]] associated with an [[ActiveRecord]] class.
16
 *
17 18
 * An ActiveQuery can be a normal query or be used in a relational context.
 *
19
 * ActiveQuery instances are usually created by [[ActiveRecord::find()]].
20 21 22 23
 * Relational queries are created by [[ActiveRecord::hasOne()]] and [[ActiveRecord::hasMany()]].
 *
 * Normal Query
 * ------------
24 25 26 27 28 29 30
 *
 * ActiveQuery mainly provides the following methods to retrieve the query results:
 *
 * - [[one()]]: returns a single record populated with the first row of data.
 * - [[all()]]: returns all records based on the query results.
 * - [[count()]]: returns the number of records.
 * - [[scalar()]]: returns the value of the first column in the first row of the query result.
31
 * - [[column()]]: returns the value of the first column in the query result.
32 33
 * - [[exists()]]: returns a value indicating whether the query result has data or not.
 *
34 35
 * Because ActiveQuery extends from [[Query]], one can use query methods, such as [[where()]],
 * [[orderBy()]] to customize the query options.
36 37 38 39 40 41 42 43 44
 *
 * ActiveQuery also provides the following additional query options:
 *
 * - [[with()]]: list of relations that this query should be performed with.
 * - [[indexBy()]]: the name of the column by which the query result should be indexed.
 * - [[asArray()]]: whether to return each record as an array.
 *
 * These options can be configured using methods of the same name. For example:
 *
45
 * ```php
46
 * $customers = Customer::find()->with('orders')->asArray()->all();
47 48 49 50 51 52 53 54 55 56 57 58
 * ```
 * > NOTE: elasticsearch limits the number of records returned to 10 records by default.
 * > If you expect to get more records you should specify limit explicitly.
 *
 * Relational query
 * ----------------
 *
 * In relational context ActiveQuery represents a relation between two Active Record classes.
 *
 * Relational ActiveQuery instances are usually created by calling [[ActiveRecord::hasOne()]] and
 * [[ActiveRecord::hasMany()]]. An Active Record class declares a relation by defining
 * a getter method which calls one of the above methods and returns the created ActiveQuery object.
59
 *
60 61 62 63 64 65 66 67 68 69 70
 * A relation is specified by [[link]] which represents the association between columns
 * of different tables; and the multiplicity of the relation is indicated by [[multiple]].
 *
 * If a relation involves a pivot table, it may be specified by [[via()]].
 * This methods may only be called in a relational context. Same is true for [[inverseOf()]], which
 * marks a relation as inverse of another relation.
 *
 * > NOTE: elasticsearch limits the number of records returned by any query to 10 records by default.
 * > If you expect to get more records you should specify limit explicitly in relation definition.
 * > This is also important for relations that use [[via()]] so that if via records are limited to 10
 * > the relations records can also not be more than 10.
71
 *
72 73 74
 * @author Carsten Brandt <mail@cebe.cc>
 * @since 2.0
 */
75
class ActiveQuery extends Query implements ActiveQueryInterface
76
{
77 78
    use ActiveQueryTrait;
    use ActiveRelationTrait;
79

80

Qiang Xue committed
81 82 83 84 85 86 87 88 89 90 91
    /**
     * Constructor.
     * @param array $modelClass the model class associated with this query
     * @param array $config configurations to be applied to the newly created query object
     */
    public function __construct($modelClass, $config = [])
    {
        $this->modelClass = $modelClass;
        parent::__construct($config);
    }

92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118
    /**
     * Creates a DB command that can be used to execute this query.
     * @param  Connection $db the DB connection used to create the DB command.
     *                        If null, the DB connection returned by [[modelClass]] will be used.
     * @return Command    the created DB command instance.
     */
    public function createCommand($db = null)
    {
        if ($this->primaryModel !== null) {
            // lazy loading
            if (is_array($this->via)) {
                // via relation
                /** @var ActiveQuery $viaQuery */
                list($viaName, $viaQuery) = $this->via;
                if ($viaQuery->multiple) {
                    $viaModels = $viaQuery->all();
                    $this->primaryModel->populateRelation($viaName, $viaModels);
                } else {
                    $model = $viaQuery->one();
                    $this->primaryModel->populateRelation($viaName, $model);
                    $viaModels = $model === null ? [] : [$model];
                }
                $this->filterByModels($viaModels);
            } else {
                $this->filterByModels([$this->primaryModel]);
            }
        }
119

120 121 122 123 124
        /** @var ActiveRecord $modelClass */
        $modelClass = $this->modelClass;
        if ($db === null) {
            $db = $modelClass::getDb();
        }
125

126 127 128 129 130 131 132 133
        if ($this->type === null) {
            $this->type = $modelClass::type();
        }
        if ($this->index === null) {
            $this->index = $modelClass::index();
            $this->type = $modelClass::type();
        }
        $commandConfig = $db->getQueryBuilder()->build($this);
134

135 136
        return $db->createCommand($commandConfig);
    }
137

138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187
    /**
     * Executes query and returns all results as an array.
     * @param  Connection $db the DB connection used to create the DB command.
     *                        If null, the DB connection returned by [[modelClass]] will be used.
     * @return array      the query results. If the query results in nothing, an empty array will be returned.
     */
    public function all($db = null)
    {
        $result = $this->createCommand($db)->search();
        if (empty($result['hits']['hits'])) {
            return [];
        }
        if ($this->fields !== null) {
            foreach ($result['hits']['hits'] as &$row) {
                $row['_source'] = isset($row['fields']) ? $row['fields'] : [];
                unset($row['fields']);
            }
            unset($row);
        }
        /** @var ActiveRecord $modelClass */
        $modelClass = $this->modelClass;
        $pk = $modelClass::primaryKey()[0];
        if ($this->asArray && $this->indexBy) {
            foreach ($result['hits']['hits'] as &$row) {
                if ($pk === '_id') {
                    $row['_source']['_id'] = $row['_id'];
                }
                $row['_source']['_score'] = $row['_score'];
                $row = $row['_source'];
            }
            unset($row);
        }
        $models = $this->createModels($result['hits']['hits']);
        if ($this->asArray && !$this->indexBy) {
            foreach ($models as $key => $model) {
                if ($pk === '_id') {
                    $model['_source']['_id'] = $model['_id'];
                }
                $model['_source']['_score'] = $model['_score'];
                $models[$key] = $model['_source'];
            }
        }
        if (!empty($this->with)) {
            $this->findWith($this->with, $models);
        }
        if (!$this->asArray) {
            foreach ($models as $model) {
                $model->afterFind();
            }
        }
188

189 190
        return $models;
    }
191

192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227
    /**
     * Executes query and returns a single row of result.
     * @param  Connection              $db the DB connection used to create the DB command.
     *                                     If null, the DB connection returned by [[modelClass]] will be used.
     * @return ActiveRecord|array|null a single row of query result. Depending on the setting of [[asArray]],
     *                                    the query result may be either an array or an ActiveRecord object. Null will be returned
     *                                    if the query results in nothing.
     */
    public function one($db = null)
    {
        if (($result = parent::one($db)) === false) {
            return null;
        }
        if ($this->asArray) {
            /** @var ActiveRecord $modelClass */
            $modelClass = $this->modelClass;
            $model = $result['_source'];
            $pk = $modelClass::primaryKey()[0];
            if ($pk === '_id') {
                $model['_id'] = $result['_id'];
            }
            $model['_score'] = $result['_score'];
        } else {
            /** @var ActiveRecord $class */
            $class = $this->modelClass;
            $model = $class::instantiate($result);
            $class::populateRecord($model, $result);
        }
        if (!empty($this->with)) {
            $models = [$model];
            $this->findWith($this->with, $models);
            $model = $models[0];
        }
        if (!$this->asArray) {
            $model->afterFind();
        }
228

229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304
        return $model;
    }

    /**
     * @inheritdoc
     */
    public function search($db = null, $options = [])
    {
        $result = $this->createCommand($db)->search($options);
        if (!empty($result['hits']['hits'])) {
            $models = $this->createModels($result['hits']['hits']);
            if ($this->asArray) {
                /** @var ActiveRecord $modelClass */
                $modelClass = $this->modelClass;
                $pk = $modelClass::primaryKey()[0];
                foreach ($models as $key => $model) {
                    if ($pk === '_id') {
                        $model['_source']['_id'] = $model['_id'];
                    }
                    $model['_source']['_score'] = $model['_score'];
                    $models[$key] = $model['_source'];
                }
            }
            if (!empty($this->with)) {
                $this->findWith($this->with, $models);
            }
            if (!$this->asArray) {
                foreach ($models as $model) {
                    $model->afterFind();
                }
            }
            $result['hits']['hits'] = $models;
        }

        return $result;
    }

    /**
     * @inheritdoc
     */
    public function scalar($field, $db = null)
    {
        $record = parent::one($db);
        if ($record !== false) {
            if ($field == '_id') {
                return $record['_id'];
            } elseif (isset($record['_source'][$field])) {
                return $record['_source'][$field];
            }
        }

        return null;
    }

    /**
     * @inheritdoc
     */
    public function column($field, $db = null)
    {
        if ($field == '_id') {
            $command = $this->createCommand($db);
            $command->queryParts['fields'] = [];
            $result = $command->search();
            if (empty($result['hits']['hits'])) {
                return [];
            }
            $column = [];
            foreach ($result['hits']['hits'] as $row) {
                $column[] = $row['_id'];
            }

            return $column;
        }

        return parent::column($field, $db);
    }
305
}