* @since 2.0 */ class ActiveQuery extends Query implements ActiveQueryInterface { use ActiveQueryTrait; /** * @var string the SQL statement to be executed for retrieving AR records. * This is set by [[ActiveRecord::findBySql()]]. */ public $sql; /** * Sets the [[snippetCallback]] to [[fetchSnippetSourceFromModels]], which allows to * fetch the snippet source strings from the Active Record models, using method * [[ActiveRecord::getSnippetSource()]]. * Warning: this option should NOT be used with [[asArray]] at the same time! * @return static the query object itself */ public function snippetByModel() { $this->snippetCallback(array($this, 'fetchSnippetSourceFromModels')); return $this; } /** * 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) { $command = $this->createCommand($db); $rows = $command->queryAll(); if (!empty($rows)) { $models = $this->createModels($rows); if (!empty($this->with)) { $this->findWith($this->with, $models); } $models = $this->fillUpSnippets($models); return $models; } else { return []; } } /** * 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) { $command = $this->createCommand($db); $row = $command->queryOne(); if ($row !== false) { if ($this->asArray) { $model = $row; } else { /** @var $class ActiveRecord */ $class = $this->modelClass; $model = $class::create($row); } if (!empty($this->with)) { $models = [$model]; $this->findWith($this->with, $models); $model = $models[0]; } list ($model) = $this->fillUpSnippets([$model]); return $model; } else { return null; } } /** * 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) { /** @var $modelClass ActiveRecord */ $modelClass = $this->modelClass; $this->setConnection($db); $db = $this->getConnection(); $params = $this->params; if ($this->sql === null) { if ($this->from === null) { $tableName = $modelClass::indexName(); if ($this->select === null && !empty($this->join)) { $this->select = ["$tableName.*"]; } $this->from = [$tableName]; } list ($this->sql, $params) = $db->getQueryBuilder()->build($this); } return $db->createCommand($this->sql, $params); } /** * @inheritdoc */ protected function defaultConnection() { $modelClass = $this->modelClass; return $modelClass::getDb(); } /** * Fetches the source for the snippets using [[ActiveRecord::getSnippetSource()]] method. * @param ActiveRecord[] $models raw query result rows. * @return array snippet source strings */ protected function fetchSnippetSourceFromModels($models) { $result = []; foreach ($models as $model) { $result[] = $model->getSnippetSource(); } return $result; } }