Интерфейс QueryInterface

aliasField()source public

aliasField( string $field , string|null $alias null )

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

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

Параметры

строка $field

Поле, которое нужно алиасировать

строка|null $alias дополнительно null

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

Возвращает

массив

aliasFields()source public

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

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

Параметры

массив $fields

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

строка|null $defaultAlias дополнительно null

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

Возвращает

массив

all()source public

all( )

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

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

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

Возвращает

Cake\Datasource\ResultSetInterface

applyOptions()source 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

Список условий запроса, к которым нужно добавить новые части.

Возвращает

$this

count()source public

count( )

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

Возвращает

целое число

find()source public

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

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

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

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

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

Параметры

строка $finder

Метод поиска, который нужно использовать.

массив $options дополнительно []

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

Возвращает

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

first()source public

first( )

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

Пример:

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

Возвращает

смешанный тип
первый результат из ResultSet

limit()source public

limit( integer $num )

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

Примеры

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

Параметры

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

количество возвращаемых записей

Возвращает

$this

offset()source public

offset( integer $num )

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

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

Примеры

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

Параметры

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

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

Возвращает

$this

order()source 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

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

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

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

Возвращает

$this

page()source public

page( integer $num , integer|null $limit null )

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

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

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

Параметры

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

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

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

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

Возвращает

$this

repository()source public

repository( Cake\Datasource\RepositoryInterface $repository null )

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

Параметры

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

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

Возвращает

Cake\Datasource\RepositoryInterface|Cake\Datasource\QueryInterface
$this

toArray()source public

toArray( )

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

Возвращает

массив

where()source 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])->tieWith('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

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

Возвращает

$this