mirror of
https://github.com/yiisoft/yii2.git
synced 2025-11-04 14:46:19 +08:00
274 lines
9.7 KiB
PHP
274 lines
9.7 KiB
PHP
<?php
|
|
/**
|
|
* @link http://www.yiiframework.com/
|
|
* @copyright Copyright (c) 2008 Yii Software LLC
|
|
* @license http://www.yiiframework.com/license/
|
|
*/
|
|
|
|
namespace yii\elasticsearch;
|
|
|
|
use yii\db\ActiveQueryInterface;
|
|
use yii\db\ActiveQueryTrait;
|
|
use yii\db\ActiveRelationTrait;
|
|
|
|
/**
|
|
* ActiveQuery represents a [[Query]] associated with an [[ActiveRecord]] class.
|
|
*
|
|
* An ActiveQuery can be a normal query or be used in a relational context.
|
|
*
|
|
* ActiveQuery instances are usually created by [[ActiveRecord::find()]].
|
|
* Relational queries are created by [[ActiveRecord::hasOne()]] and [[ActiveRecord::hasMany()]].
|
|
*
|
|
* Normal Query
|
|
* ------------
|
|
*
|
|
* 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.
|
|
* - [[column()]]: returns the value of the first column in the query result.
|
|
* - [[exists()]]: returns a value indicating whether the query result has data or not.
|
|
*
|
|
* Because ActiveQuery extends from [[Query]], one can use query methods, such as [[where()]],
|
|
* [[orderBy()]] to customize the query options.
|
|
*
|
|
* 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:
|
|
*
|
|
* ```php
|
|
* $customers = Customer::find()->with('orders')->asArray()->all();
|
|
* ```
|
|
* > 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.
|
|
*
|
|
* 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 junction 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.
|
|
*
|
|
* > Note: Currently [[with]] is not supported in combination with [[asArray]].
|
|
*
|
|
* @author Carsten Brandt <mail@cebe.cc>
|
|
* @since 2.0
|
|
*/
|
|
class ActiveQuery extends Query implements ActiveQueryInterface
|
|
{
|
|
use ActiveQueryTrait;
|
|
use ActiveRelationTrait;
|
|
|
|
/**
|
|
* @event Event an event that is triggered when the query is initialized via [[init()]].
|
|
*/
|
|
const EVENT_INIT = 'init';
|
|
|
|
|
|
/**
|
|
* 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);
|
|
}
|
|
|
|
/**
|
|
* Initializes the object.
|
|
* This method is called at the end of the constructor. The default implementation will trigger
|
|
* an [[EVENT_INIT]] event. If you override this method, make sure you call the parent implementation at the end
|
|
* to ensure triggering of the event.
|
|
*/
|
|
public function init()
|
|
{
|
|
parent::init();
|
|
$this->trigger(self::EVENT_INIT);
|
|
}
|
|
|
|
/**
|
|
* 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 $viaQuery ActiveQuery */
|
|
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]);
|
|
}
|
|
}
|
|
|
|
/* @var $modelClass ActiveRecord */
|
|
$modelClass = $this->modelClass;
|
|
if ($db === null) {
|
|
$db = $modelClass::getDb();
|
|
}
|
|
|
|
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);
|
|
|
|
return $db->createCommand($commandConfig);
|
|
}
|
|
|
|
/**
|
|
* 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)
|
|
{
|
|
if ($this->asArray) {
|
|
// TODO implement with
|
|
return parent::all($db);
|
|
}
|
|
|
|
$result = $this->createCommand($db)->search();
|
|
if (empty($result['hits']['hits'])) {
|
|
return [];
|
|
}
|
|
$models = $this->createModels($result['hits']['hits']);
|
|
if (!empty($this->with)) {
|
|
$this->findWith($this->with, $models);
|
|
}
|
|
foreach ($models as $model) {
|
|
$model->afterFind();
|
|
}
|
|
|
|
return $models;
|
|
}
|
|
|
|
/**
|
|
* 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) {
|
|
// TODO implement with()
|
|
// /* @var $modelClass ActiveRecord */
|
|
// $modelClass = $this->modelClass;
|
|
// $model = $result['_source'];
|
|
// $pk = $modelClass::primaryKey()[0];
|
|
// if ($pk === '_id') {
|
|
// $model['_id'] = $result['_id'];
|
|
// }
|
|
// $model['_score'] = $result['_score'];
|
|
// if (!empty($this->with)) {
|
|
// $models = [$model];
|
|
// $this->findWith($this->with, $models);
|
|
// $model = $models[0];
|
|
// }
|
|
return $result;
|
|
} else {
|
|
/* @var $class ActiveRecord */
|
|
$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];
|
|
}
|
|
$model->afterFind();
|
|
return $model;
|
|
}
|
|
}
|
|
|
|
/**
|
|
* @inheritdoc
|
|
*/
|
|
public function search($db = null, $options = [])
|
|
{
|
|
$result = $this->createCommand($db)->search($options);
|
|
// TODO implement with() for asArray
|
|
if (!empty($result['hits']['hits']) && !$this->asArray) {
|
|
$models = $this->createModels($result['hits']['hits']);
|
|
if (!empty($this->with)) {
|
|
$this->findWith($this->with, $models);
|
|
}
|
|
foreach ($models as $model) {
|
|
$model->afterFind();
|
|
}
|
|
$result['hits']['hits'] = $models;
|
|
}
|
|
|
|
return $result;
|
|
}
|
|
|
|
/**
|
|
* @inheritdoc
|
|
*/
|
|
public function column($field, $db = null)
|
|
{
|
|
if ($field == '_id') {
|
|
$command = $this->createCommand($db);
|
|
$command->queryParts['fields'] = [];
|
|
$command->queryParts['_source'] = false;
|
|
$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);
|
|
}
|
|
}
|