Получить значение атрибута оператора

Назначение

Предоставление текущего значения атрибута поискового SQL-оператора.

Синтаксические правила
 
mixed PDOStatement::getAttribute (int attribute);
attribute

Идентификатор запрашиваемого атрибута.

Кроме атрибутов, перечисленных в пункте «Установить атрибут оператора», дополнительно может быть запрошена информация о следующих атрибутах:

  1. PDO::ATTR_CURSOR – тип курсора.

    Возможные значения:

    • PDO::CURSOR_SCROLL – скролируемый курсор (перемещение по выборке вперед/назад).

  2. PDO::ATTR_MAX_COLUMN_LEN – максимальная длина ответа.

  3. PDO::ATTR_FETCH_TABLE_NAMES – управление добавлением имени таблицы перед именем столбца.

    Допустимые значения:

    • true – предварять (через точку) имя столбца именем таблицы;

    • false – не добавлять имя таблицы к имени столбца.

  4. PDO::ATTR_FETCH_CATALOG_NAMES – управление добавлением имени БД перед именем столбца (таблицы).

    Допустимые значения атрибута:

    • true – предварять (через точку) имя столбца (таблицы) именем БД;

    • false – не добавлять имя БД к имени столбца (таблицы).

  5. PDO::ATTR_RENAME_DUBBED_COL – управление дубликатами имен столбцов в выборке данных. В случае дублирующихся имён столбцов к имени столбца добавляется постфикс _N, где N – номер дубля. (Первый столбец остаётся со своим именем).

    По умолчанию (или при установке значения 0 (FALSE)) дубликаты имен столбцов остаются неизменными.

    Однако в комбинации PDO::FETCH_LAZY + PDO::ATTR_RENAME_DUBBED_COL = FALSE переименование столбцов с одинаковыми именами будет выполняться.

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

  6. PDO::ATTR_GENERATE_COL_NAME – управление представлением неименованных столбцов выборки данных (заставляет для пустых имён столбцов автоматически генерировать имя AUTO_GENERATED_NAME). Предназначено для работы в программной среде, которая требует обязательного задания имён столбцов в выборке данных. По умолчанию (или при установке значения 0) автоматическое именование пустых столбцов не выполняется.

  7. PDO::ATTR_CURSOR_NAME – устанавливает имя курсора.

    Допустимые значения:

    • string cursorName – имя курсора.

  8. PDO::ATTR_DT_FORMAT – устанавливает формат значений типа «дата-время».

    Допустимые значения:

Описание

Функция предоставляет текущее значение запрошенного атрибута поискового оператора связанного с данным PDOStatement-объектом.

Возвращаемое значение
  • значение запрошенного атрибута (удачное завершение);

  • NULL-значение – неудачное завершение.