PDO::setAttribute
(PHP 5 >= 5.1.0, PHP 7, PECL pdo >= 0.1.0)
PDO::setAttribute — Присвоение атрибута
Описание
Присваивает атрибут PDO объекту. Некоторые основные атрибуты приведены ниже; отдельные драйверы могут имеет свои дополнительные атрибуты.
PDO::ATTR_CASE: Приводить имена столбцов к заданному регистру.
PDO::CASE_LOWER: Приводить имена столбцов к нижнему регистру.
PDO::CASE_NATURAL: Оставлять имена столбцов в том виде, в котором они выданы драйвером.
PDO::CASE_UPPER: Приводить имена столбцов к верхнему регистру.
PDO::ATTR_ERRMODE: Режим сообщений об ошибках.
PDO::ERRMODE_SILENT: Только установка кодов ошибок.
PDO::ERRMODE_WARNING: Вызывать E_WARNING.
PDO::ERRMODE_EXCEPTION: Выбрасывать исключения.
PDO::ATTR_ORACLE_NULLS (доступен для всех драйверов, не только для Oracle): Преобразование NULL в пустые строки.
PDO::NULL_NATURAL: Без преобразования.
PDO::NULL_EMPTY_STRING: Пустые строки преобразовывать в
NULL
.PDO::NULL_TO_STRING: NULL преобразовывать в пустые строки.
PDO::ATTR_STRINGIFY_FETCHES: Преобразовывать числовые значения в строки во время выборки. Значение типа bool.
PDO::ATTR_STATEMENT_CLASS: Задает пользовательский класс производный от PDOStatement. Атрибут нельзя использовать с PDO, использующими постоянные соединения. Принимает массив array(string classname, array(mixed constructor_args)).
PDO::ATTR_TIMEOUT: Задает таймаут в секундах. Не все драйверы поддерживают эту опцию. Также назначение этого таймаута может отличаться в разных драйверах. Например, sqlite будет ждать это количество времени получения блокировки на запись. А другие драйверы могут использовать его, как таймаут подключения или чтения. Атрибут принимает значение типа int.
PDO::ATTR_AUTOCOMMIT (доступен в OCI, Firebird и MySQL): Требуется ли автоматическая фиксация каждого отдельного выражения в запросе.
PDO::ATTR_EMULATE_PREPARES Включение или выключение эмуляции подготавливаемых запросов. Некоторые драйверы не поддерживают подготавливаемые запросы, либо их поддержка ограничена. Эта настройка указывает PDO всегда эмулировать подготавливаемые запросы (если
TRUE
) или пытаться использовать родные средства драйвера (еслиFALSE
). Если драйвер не сможет подготовить запрос, эта настройка сбросится в режим эмуляции. Атрибут принимает значение типа bool.PDO::MYSQL_ATTR_USE_BUFFERED_QUERY (доступен в MySQL): Использовать буферизованные запросы.
PDO::ATTR_DEFAULT_FETCH_MODE: Задает режим выборки данных по умолчанию. Описание возможных режимов приведено в документации к методу PDOStatement::fetch().
Возвращаемые значения
Возвращает TRUE
в случае успешного завершения или FALSE
в случае возникновения ошибки.
- PHP Руководство
- Функции по категориям
- Индекс функций
- Справочник функций
- Расширения для работы с базами данных
- Уровни абстракции
- Объекты данных PHP
- Функция PDO::beginTransaction() - Инициализация транзакции
- Функция PDO::commit() - Фиксирует транзакцию
- Функция PDO::__construct() - Создает экземпляр PDO, предоставляющий соединение с базой данных
- Функция PDO::errorCode() - Возвращает код SQLSTATE результата последней операции с базой данных
- PDO::errorInfo
- PDO::exec
- Функция PDO::getAttribute() - Получить атрибут соеденения с базой данных
- Функция PDO::getAvailableDrivers() - Возвращает массив доступных драйверов PDO
- Функция PDO::inTransaction() - Проверяет, есть ли внутри транзакция
- Функция PDO::lastInsertId() - Возвращает ID последней вставленной строки или последовательное значение
- PDO::prepare
- PDO::query
- Функция PDO::quote() - Заключает строку в кавычки для использования в запросе
- Функция PDO::rollBack() - Откат транзакции
- Функция PDO::setAttribute() - Присвоение атрибута
Коментарии
It is worth noting that not all attributes may be settable via setAttribute(). For example, PDO::MYSQL_ATTR_MAX_BUFFER_SIZE is only settable in PDO::__construct(). You must pass PDO::MYSQL_ATTR_MAX_BUFFER_SIZE as part of the optional 4th parameter to the constructor. This is detailed in http://bugs.php.net/bug.php?id=38015
Because no examples are provided, and to alleviate any confusion as a result, the setAttribute() method is invoked like so:
setAttribute(ATTRIBUTE, OPTION);
So, if I wanted to ensure that the column names returned from a query were returned in the case the database driver returned them (rather than having them returned in all upper case [as is the default on some of the PDO extensions]), I would do the following:
<?php
// Create a new database connection.
$dbConnection = new PDO($dsn, $user, $pass);
// Set the case in which to return column_names.
$dbConnection->setAttribute(PDO::ATTR_CASE, PDO::CASE_NATURAL);
?>
Hope this helps some of you who learn by example (as is the case with me).
.Colin
There is also a way to specifie the default fetch mode :
<?php
$connection = new PDO($connection_string);
$connection->setAttribute(PDO::ATTR_DEFAULT_FETCH_MODE, PDO::FETCH_OBJ);
?>
For PDO::ATTR_EMULATE_PREPARES, the manual states a boolean value is required. However, when getAttribute() is used to check this value, an integer (1 or 0) is returned rather than true or false.
This means that if you are checking a PDO object is configured as required then
<?php
// Check emulate prepares is off
if ($pdo->getAttribute(\PDO::ATTR_EMULATE_PREPARES) !== false) {
/* do something */
}
?>
will always 'do something', regardless.
Either
<?php
// Check emulate prepares is off
if ($pdo->getAttribute(\PDO::ATTR_EMULATE_PREPARES) != false) {
/* do something */
}
?>
or
<?php
// Check emulate prepares is off
if ($pdo->getAttribute(\PDO::ATTR_EMULATE_PREPARES) !== 0) {
/* do something */
}
?>
is needed instead.
Also worth noting that setAttribute() does, in fact, accept an integer value if you want to be consistent.
Well, I have not seen it mentioned anywhere and thought its worth mentioning. It might help someone. If you are wondering whether you can set multiple attributes then the answer is yes.
You can do it like this:
try {
$connection = new PDO("mysql:host=$host; dbname=$dbname", $user, $password);
// You can begin setting all the attributes you want.
$connection->setAttribute(PDO::ATTR_ERRMODE, PDO::ERRMODE_EXCEPTION);
$connection->setAttribute(PDO::ATTR_CASE, PDO::CASE_NATURAL);
$connection->setAttribute(PDO::ATTR_ORACLE_NULLS, PDO::NULL_EMPTY_STRING);
// That's how you can set multiple attributes
}
catch(PDOException $e)
{
die("Database connection failed: " . $e->getMessage());
}
I hope this helps somebody. :)
This is an update to a note I wrote earlier concerning how to set multiple attributes when you create you PDO connection string.
You can put all the attributes you want in an associative array and pass that array as the fourth parameter in your connection string. So it goes like this:
<?php
$options = [
PDO::ATTR_ERRMODE => PDO::ERRMODE_EXCEPTION,
PDO::ATTR_CASE => PDO::CASE_NATURAL,
PDO::ATTR_ORACLE_NULLS => PDO::NULL_EMPTY_STRING
];
// Now you create your connection string
try {
// Then pass the options as the last parameter in the connection string
$connection = new PDO("mysql:host=$host; dbname=$dbname", $user, $password, $options);
// That's how you can set multiple attributes
} catch(PDOException $e) {
die("Database connection failed: " . $e->getMessage());
}
?>
Note that contrary to most PDO methods, setAttribute does not throw a PDOException when it returns false.
Note that in order for
\PDO::ATTR_TIMEOUT
to have any effect, you must set
\PDO::ATTR_ERRMODE=>\PDO::ERRMODE_EXCEPTION.
If
\PDO::ATTR_ERRMODE=>\PDO::ERRMODE_WARNING
it doesn't appear to do anything.