Класс yii\db\ActiveQuery

__construct() public method

Конструктор.

alias() public method (доступно с версии 2.0.7)

Определить псевдоним для таблицы, определённой в $modelClass.

Этот метод скорректирует from(), чтобы уже определённый псевдоним был перезаписан. Если он не был определён, from() будет заполнен заданным псевдонимом.

all() public method

Выполняет запрос и возвращает все результаты в виде массива.

andOnCondition() public method

Добавляет дополнительное условие ON к существующему.

Новое условие и существующее будут объединены с помощью оператора 'AND'.

См. также:

• onCondition()
• orOnCondition()

createCommand() public method

Создаёт команду базы данных, которая может использоваться для выполнения этого запроса.

getPrimaryTableName() protected method (доступно с версии 2.0.12)

getTablesUsedInFrom() public method (доступно с версии 2.0.12)

Возвращает имена таблиц, используемых в from(), индексированные по псевдонимам.

И псевдонимы, и имена заключены в {{ и }}.

init() public method

Инициализирует объект.

Этот метод вызывается в конце конструктора. Стандартная реализация вызовет событие EVENT_INIT. Если вы переопределяете этот метод, убедитесь, что вызываете родительскую реализацию в конце, чтобы гарантировать срабатывание события.

innerJoinWith() public method

Внутреннее соединение со специфическими отношениями.

Это метод-костыль для joinWith() с типом соединения "INNER JOIN". Обратитесь к joinWith() для подробного использования этого метода.

См. также joinWith().

joinWith() public method

Соединение со специфическими отношениями.

Этот метод позволяет повторно использовать существующие определения отношений для выполнения запросов JOIN. Основываясь на определении указанных отношений, метод добавит одну или несколько инструкций JOIN к текущему запросу.

Если параметр $eagerLoading равен true, метод также выполнит ленивую загрузку для указанных отношений, что эквивалентно вызову with() с указанными отношениями.

Обратите внимание, что, поскольку будет выполнено соединение, вы несете ответственность за разграничение имён столбцов.

Этот метод отличается от with() тем, что он построит и выполнит инструкцию JOIN SQL для основной таблицы. И когда $eagerLoading равно true, он также вызовет with() с указанными отношениями.

// find all orders that contain books, and eager loading "books"
Order::find()->joinWith('books', true, 'INNER JOIN')->all();
// find all orders, eager loading "books", and sort the orders and books by the book names.
Order::find()->joinWith([
    'books' => function (\yii\db\ActiveQuery $query) {
        $query->orderBy('item.name');
    }
])->all();
// find all orders that contain books of the category 'Science fiction', using the alias "b" for the books table
Order::find()->joinWith(['books b'], true, 'INNER JOIN')->where(['b.category' => 'Science fiction'])->all();

onCondition() public method

Устанавливает условие ON для запроса отношений.

Условие будет использовано в части ON при вызове yii\db\ActiveQuery::joinWith(). В противном случае условие будет использовано в части WHERE запроса.

Используйте этот метод для указания дополнительных условий при объявлении отношения в классе yii\db\ActiveRecord:

public function getActiveUsers()
{
    return $this->hasMany(User::className(), ['id' => 'user_id'])
                ->onCondition(['active' => true]);
}

Обратите внимание, что это условие применяется как при выполнении объединения, так и при получении связанных записей. Таким образом, в условии можно использовать только поля связанной таблицы. Попытка доступа к полям основной записи приведет к ошибке в запросе без объединения.

one() public method

Выполняет запрос и возвращает единственную строку результата.

orOnCondition() public method

Добавляет дополнительное условие ON к существующему.

Новое условие и существующее будут объединены с помощью оператора 'OR'.

См. также:

• onCondition()
• andOnCondition()

populate() public method

Преобразует сырые результаты запроса в формат, указанный этим запросом.

Этот метод используется внутри для преобразования данных, полученных из базы данных, в формат, необходимый для этого запроса.

prepare() public method

Готовит к построению SQL.

Этот метод вызывается yii\db\QueryBuilder, когда он начинает строить SQL из объекта запроса. Вы можете переопределить этот метод, чтобы выполнить некоторые окончательные подготовительные работы при преобразовании запроса в оператор SQL.

queryScalar() protected method

Выполняет запрос скалярного значения, установив select() сначала.

Восстанавливает значение select, чтобы сделать этот запрос повторно используемым.

viaTable() public method

Указывает таблицу соединения для реляционного запроса.

Используйте этот метод для указания таблицы соединения при объявлении отношения в классе yii\db\ActiveRecord:

public function getItems()
{
    return $this->hasMany(Item::className(), ['id' => 'item_id'])
                ->viaTable('order_item', ['order_id' => 'id']);
}

См. также via().