Интерфейс QueryInterface

aliasFieldsource public

aliasField( string $field , string $alias null )

Возвращает массив ключ => значение, представляющий одно алиасированное поле, которое можно передать непосредственно методу select(). Ключ будет содержать псевдоним, а значение — фактическое имя поля.

Если поле уже алиасировано, оно не будет изменено. Если $alias не передан, будет использована таблица по умолчанию для этого запроса.

Параметры

строка $field

Поле для алиасирования

строка $alias необязательно null

Псевдоним, используемый для префикса поля

Возвращает

array
массив

aliasFieldssource public

aliasFields( array $fields , string|null $defaultAlias null )

Выполняет aliasField() для каждого поля в предоставленном списке и возвращает результат в одном массиве.

Параметры

массив $fields

Поля для алиасирования

строка|null $defaultAlias необязательно null

Псевдоним по умолчанию

Возвращает

array
массив

allsource public

all( )

Получить результаты для этого запроса.

Возвращает либо набор результатов через setResult(), либо выполняет этот запрос и возвращает объект ResultSetDecorator, готовый для потоковой передачи результатов.

ResultSetDecorator — это перебираемый объект, который реализует методы, доступные в Cake\Collection\Collection.

Возвращает

Cake\Datasource\ResultSetInterface
\Cake\Datasource\ResultSetInterface

applyOptionssource public

applyOptions( array $options )

Заполняет или добавляет части текущих условий запроса с помощью массива. Это удобно для передачи всех условий запроса сразу. Массив опций принимает:

• fields: Соответствует методу select
• conditions: Соответствует методу where
• limit: Соответствует методу limit
• order: Соответствует методу order
• offset: Соответствует методу offset
• group: Соответствует методу group
• having: Соответствует методу having
• contain: Соответствует параметрам contain для ленивой загрузки
• join: Соответствует методу join
• page: Соответствует методу page

Пример:

$query->applyOptions([
  'fields' => ['id', 'name'],
  'conditions' => [
    'created >=' => '2013-01-01'
  ],
  'limit' => 10
]);

Эквивалентно:

$query
->select(['id', 'name'])
->where(['created >=' => '2013-01-01'])
->limit(10)

Параметры

массив $options

список условий запроса для применения новых частей.

Возвращает

mixed
$this

countsource public

count( )

Возвращает общее количество результатов для запроса.

Возвращает

integer
целое число

findsource public

find( string $finder , array $options [] )

Применяет настраиваемые поиски к существующему объекту запроса.

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

$repository->find('all')->find('recent');

Вышеприведенный пример демонстрирует стекирование нескольких методов поиска в одном запросе.

Параметры

строка $finder

Метод поиска для использования.

массив $options необязательно []

Параметры для метода поиска.

Возвращает

mixed
$this Возвращает изменённый запрос.

firstsource public

first( )

Возвращает первый результат выполнения этого запроса. Если запрос не был выполнен ранее, он установит условие limit в 1 для повышения производительности.

Пример:

$singleUser = $query->select(['id', 'username'])->first();

Возвращает

mixed
первый результат из ResultSet

limitsource public

limit( integer $num )

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

Примеры

$query->limit(10) // generates LIMIT 10
$query->limit($query->newExpr()->add(['1 + 1'])); // LIMIT (1 + 1)

Параметры

целое число $num

количество записей для возврата

Возвращает

mixed
$this

offsetsource public

offset( integer $num )

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

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

Примеры

$query->offset(10) // generates OFFSET 10
$query->offset($query->newExpr()->add(['1 + 1'])); // OFFSET (1 + 1)

Параметры

целое число $num

количество записей для пропуска

Возвращает

mixed
$this

ordersource public

order( array|string $fields , boolean $overwrite false )

Добавляет одно или несколько полей, которые будут использованы в инструкции ORDER для этого запроса. Поля могут быть переданы как массив строк, массив объектов выражения, один объект выражения или одна строка.

Если передаётся массив, ключи будут использоваться как сами поля, а значения — как порядок сортировки. При многократном вызове с одинаковыми полями в качестве ключа, последнее определение порядка будет иметь приоритет над другими.

По умолчанию эта функция будет добавлять любой переданный аргумент в список полей для выбора, если второй аргумент не установлен в true.

Примеры:

$query->order(['title' => 'DESC', 'author_id' => 'ASC']);

Результат:

ORDER BY title DESC, author_id ASC

$query->order(['title' => 'DESC NULLS FIRST'])->order('author_id');

Результат:

ORDER BY title DESC NULLS FIRST, author_id

$expression = $query->newExpr()->add(['id % 2 = 0']);
$query->order($expression)->order(['title' => 'ASC']);

Результат:

ORDER BY (id %2 = 0), title ASC

Если вам нужно установить сложные выражения в качестве условий сортировки, вы должны использовать orderAsc() или orderDesc().

Параметры

массив|строка $fields

поля, которые нужно добавить в список

boolean $overwrite необязательно false

нужно ли сбросить порядок со списком полей

Возвращает

mixed
$this

pagesource public

page( integer $num , integer $limit null )

Устанавливает страницу результатов, которую вы хотите.

Этот метод предоставляет более удобный интерфейс для установки limit + offset в наборе записей, которые вы хотите в качестве результатов. Если пусто, limit будет по умолчанию равен существующему условию limit, а если и оно пусто, то 25 будет использоваться.

Страницы должны начинаться с 1.

Параметры

целое число $num

Номер страницы, которую вы хотите.

целое число $limit необязательно null

Количество строк на странице. Если null, будет использоваться текущее условие limit.

Возвращает

mixed
$this

repositorysource public

repository( Cake\Datasource\RepositoryInterface $repository null )

Возвращает объект репозитория по умолчанию, который будет использоваться этим запросом, то есть репозиторий, который будет отображаться в инструкции from.

Параметры

Cake\Datasource\RepositoryInterface $repository необязательно null

Объект репозитория по умолчанию для использования

Возвращает

Cake\Datasource\RepositoryInterface|$this
$this

toArraysource public

toArray( )

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

Возвращает

array
массив

wheresource public

where( string|array|callable|null $conditions null , array $types [] , boolean $overwrite false )

Добавляет условие или набор условий, используемых в предложении WHERE для этого запроса. Условия могут быть выражены как массив полей в качестве ключей со знаками сравнения в нем, значения для массива будут использоваться для сравнения поля с таким литералом. Наконец, условия могут быть выражены как одна строка или массив строк.

При использовании массивов каждая запись будет присоединена к остальным условиям с помощью оператора AND. Последовательные вызовы этой функции также будут объединять новые указанные условия с помощью оператора AND. Кроме того, значения могут быть выражены с помощью объектов выражений, которые могут включать другие объекты запросов.

Любые условия, созданные с помощью этого метода, могут быть использованы с запросами любого типа SELECT, UPDATE и DELETE.

Условия с использованием операторов:

$query->where([
    'posted >=' => new DateTime('3 days ago'),
    'title LIKE' => 'Hello W%',
    'author_id' => 1,
], ['posted' => 'datetime']);

Предыдущий пример приводит к:

WHERE posted >= 2012-01-27 AND title LIKE 'Hello W%' AND author_id = 1

Второй параметр используется для указания ожидаемого типа для каждого переданного ключа. Допустимые типы могут быть взяты из сопоставленного с классом Database\Type.

Вложенные условия с союзами:

$query->where([
    'author_id !=' => 1,
    'OR' => ['published' => true, 'posted <' => new DateTime('now')],
    'NOT' => ['title' => 'Hello']
], ['published' => boolean, 'posted' => 'datetime']

Предыдущий пример приводит к:

WHERE author_id = 1 AND (published = 1 OR posted < '2012-02-01') AND NOT (title = 'Hello')

Вы можете вкладывать условия с помощью союзов сколько угодно. Иногда вам может потребоваться определить 2 различных варианта для одного и того же ключа, в этом случае вы можете обернуть каждое условие в новый массив:

$query->where(['OR' => [['published' => false], ['published' => true]])

Помните, что каждый раз, когда вы вызываете where() с третьим параметром, установленным в false (по умолчанию), он будет присоединять переданные условия к предыдущему сохраненному списку с помощью оператора AND. Кроме того, использование одного и того же ключа массива дважды в последовательных вызовах этого метода не перезапишет предыдущее значение.

Использование объектов выражений:

$exp = $query->newExpr()->add(['id !=' => 100, 'author_id' != 1])->type('OR');
$query->where(['published' => true], ['published' => 'boolean'])->where($exp);

Предыдущий пример приводит к:

WHERE (id != 100 OR author_id != 1) AND published = 1

Другие объекты запросов могут быть использованы в качестве условий для любого поля.

Добавление условий в несколько шагов:

Вы можете использовать вызываемые функции для построения сложных выражений, функции принимают в качестве первого аргумента новый объект QueryExpression, а этот экземпляр запроса — в качестве второго аргумента. Функции должны возвращать объект выражения, который будет добавлен в список условий запроса с помощью оператора AND.

$query
->where(['title !=' => 'Hello World'])
->where(function ($exp, $query) {
    $or = $exp->or_(['id' => 1]);
    $and = $exp->and_(['id >' => 2, 'id <' => 10]);
return $or->add($and);
});

• Предыдущий пример приводит к:

WHERE title != 'Hello World' AND (id = 1 OR (id > 2 AND id < 10))

Условия в виде строк:

$query->where(['articles.author_id = authors.id', 'modified IS NULL']);

Предыдущий пример приводит к:

WHERE articles.author_id = authors.id AND modified IS NULL

Обратите внимание, что при использовании обозначений массивов или объектов выражений все значения будут правильно заключены в кавычки и автоматически преобразованы в соответствующий тип данных базы данных, тем самым защищая ваше приложение от SQL-инъекций. Если вы используете строковые условия, убедитесь, что ваши значения правильно заключены в кавычки. Самое безопасное — никогда не использовать строковые условия.

Параметры

строка|массив|вызываемая функция|null $conditions необязательно null

Условия для фильтрации.

массив $types необязательно []

ассоциативный массив имен типов, используемых для привязки значений к запросу

логическое значение $overwrite необязательно false

нужно ли сбрасывать условия с переданным списком или нет

Возвращает

mixed
$this