Интерфейс StatementInterface
Представляет базу данных оператор. Конкретные реализации могут использовать либо PDOStatement, либо родной драйвер
Прямые реализаторы
Косвенные реализаторы
Краткое описание констант
-
stringFETCH_TYPE_ASSOC'assoc' -
stringFETCH_TYPE_NUM'num' -
stringFETCH_TYPE_OBJ'obj'
Краткое описание магических свойств
-
$queryStringpublicstring
Краткое описание методов
- bind() publicСвязывает набор значений с объектом оператора с соответствующим типом
- bindValue() public
Назначает значение позиционной или именованной переменной в подготовленном запросе. При использовании позиционных переменных необходимо начинать с индекса один, при использовании именованных параметров просто используйте имя в любом порядке.
- closeCursor() public
Закрывает указатель в базе данных, освобождая все ресурсы и память, выделенные для него. В большинстве случаев вы не должны вызывать этот метод, так как он автоматически вызывается после извлечения всех результатов из набора результатов.
- columnCount() publicВозвращает количество столбцов, которые будут содержать результаты этого оператора
- count() public
Операторы могут быть переданы в качестве аргумента для count(), чтобы вернуть количество затронутых строк из последнего выполнения
- errorCode() publicВозвращает код ошибки для последней ошибки, возникшей при выполнении этого оператора
- errorInfo() public
Возвращает информацию об ошибке для последней ошибки, возникшей при выполнении этого оператора
- execute() public
Выполняет оператор, отправляя SQL-запрос в базу данных. Он может необязательно принимать массив или аргументы, которые будут привязаны к переменным запроса. Обратите внимание, что привязка параметров из этого метода не будет выполнять никакой пользовательской конвертации типов, так как это обычно происходит при вызове
bindValue - fetch() public
Возвращает следующую строку для набора результатов после выполнения этого оператора. Строки можно извлечь, чтобы они содержали столбцы как имена или позиции. Если в наборе результатов не осталось строк, этот метод вернёт false
- fetchAll() publicВозвращает массив со всеми строками, полученными в результате выполнения этого оператора
- lastInsertId() publicВозвращает последний вставленный первичный ключ, используя этот оператор
- rowCount() publicВозвращает количество строк, затронутых этим SQL-оператор
Подробное описание методов
bind()source public
bind( array $params , array $types )
Связывает набор значений с объектом оператора с соответствующим типом
Параметры
- массив
$params - список значений, которые должны быть привязаны
- массив
$types - список типов, которые должны быть использованы, ключи должны соответствовать тем, которые в $params
bindValue()source public
bindValue( string|integer $column , mixed $value , string $type = 'string' )
Назначает значение позиционной или именованной переменной в подготовленном запросе. При использовании позиционных переменных необходимо начинать с индекса один, при использовании именованных параметров просто используйте имя в любом порядке.
Не допускается комбинирование позиционных и именованных переменных в одном операторе
Примеры:
$statement->bindValue(1, 'a title');
$statement->bindValue('active', true, 'boolean');
$statement->bindValue(5, new \DateTime(), 'date'); Параметры
- строка|целое число
$column - имя или позиция параметра для привязки
- смешанное значение
$value - Значение, которое нужно привязать к переменной в запросе
- строка
$typeнеобязательно 'string' - имя настроенного класса типа
closeCursor()source public
closeCursor( )
Закрывает указатель в базе данных, освобождая все ресурсы и память, выделенные для него. В большинстве случаев вы не должны вызывать этот метод, так как он автоматически вызывается после извлечения всех результатов из набора результатов.
columnCount()source public
columnCount( )
Возвращает количество столбцов, которые будут содержать результаты этого оператора
Пример:
$statement = $connection->prepare('SELECT id, title from articles');
$statement->execute();
echo $statement->columnCount(); // outputs 2 Возвращает
целое числоcount()source public
count( )
Операторы могут быть переданы в качестве аргумента для count(), чтобы вернуть количество затронутых строк из последнего выполнения
Возвращает
целое числоerrorCode()source public
errorCode( )
Возвращает код ошибки для последней ошибки, возникшей при выполнении этого оператора
Возвращает
целое число|строкаerrorInfo()source public
errorInfo( )
Возвращает информацию об ошибке для последней ошибки, возникшей при выполнении этого оператора
Возвращает
массивexecute()source public
execute( array|null $params = null )
Выполняет оператор, отправляя SQL-запрос в базу данных. Он может необязательно принимать массив или аргументы, которые будут привязаны к переменным запроса. Обратите внимание, что привязка параметров из этого метода не будет выполнять никакой пользовательской конвертации типов, так как это обычно происходит при вызове bindValue
Параметры
- массив|null
$paramsнеобязательно null - список значений, которые должны быть привязаны к запросу
Возвращает
булевоистина при успехе, ложь в противном случае
fetch()source public
fetch( string $type = 'num' )
Возвращает следующую строку для набора результатов после выполнения этого оператора. Строки можно извлечь, чтобы они содержали столбцы как имена или позиции. Если в наборе результатов не осталось строк, этот метод вернёт false
Пример:
$statement = $connection->prepare('SELECT id, title from articles');
$statement->execute();
print_r($statement->fetch('assoc')); // will show ['id' => 1, 'title' => 'a title'] Параметры
- строка
$typeнеобязательно 'num' - 'num' для позиционных столбцов, assoc для именованных столбцов
Возвращает
массив|falseМассив результатов, содержащий столбцы и значения, или false, если результатов больше нет
fetchAll()source public
fetchAll( string $type = 'num' )
Возвращает массив со всеми строками, полученными в результате выполнения этого оператора
Пример:
$statement = $connection->prepare('SELECT id, title from articles');
$statement->execute();
print_r($statement->fetchAll('assoc')); // will show [0 => ['id' => 1, 'title' => 'a title']] Параметры
- строка
$typeнеобязательно 'num' - num для извлечения столбцов в качестве позиционных ключей или assoc для имён столбцов в качестве ключей
Возвращает
массивсписок всех результатов из базы данных для этого оператора
lastInsertId()source public
lastInsertId( string|null $table = null , string|null $column = null )
Возвращает последний вставленный первичный ключ с помощью этого оператора
Параметры
- string|null
$tableнеобязательно null - имя таблицы или последовательности для получения последнего значения вставки
- string|null
$columnнеобязательно null - имя столбца, представляющего первичный ключ
Возвращаемое значение
stringrowCount()source public
rowCount( )
Возвращает количество строк, затронутых этим SQL-оператором
Пример:
$statement = $connection->prepare('SELECT id, title from articles');
$statement->execute();
print_r($statement->rowCount()); // will show 1 Возвращаемое значение
integerПодробное описание магических свойств
$queryStringsource
public только для чтения string
© 2005–present The Cake Software Foundation, Inc.
Licensed under the MIT License.
CakePHP is a registered trademark of Cake Software Foundation, Inc.
We are not endorsed by or affiliated with CakePHP.
https://api.cakephp.org/3.8/class-Cake.Database.StatementInterface.html