# php_manual

id: MongoDB\Driver\Server::getLatency
type: function
doc:
<comment>Description:</comment>
  Возвращает задержку сервера в миллисекундах
  
  Возвращает задержку сервера в миллисекундах. Измеренное клиентом время прохождения команды <return>hello</return>.

<comment>Return:</comment>
  <info>integer|null</info>  Возвращает задержку сервера в миллисекундах или <info>null</info>, если задержка не была измерена
                (например, клиент подключён к балансировщику нагрузки).

<comment>See Also:</comment>
   * <strong>MongoDB\Driver\Server::getInfo()</strong>
   * <strong>MongoDB\Driver\ServerDescription::getRoundTripTime()</strong>
   * Спецификация обнаружения и мониторинга сервера


id: MongoDB\Driver\Server::getPort
type: function
doc:
<comment>Description:</comment>
  Возвращает порт, который слушает сервер
  
  Возвращает порт, который слушает сервер.

<comment>Return:</comment>
  <info>int</info>  Возвращает порт, который слушает сервер.

<comment>See Also:</comment>
   * <strong>MongoDB\Driver\Server::getInfo()</strong>
   * <strong>MongoDB\Driver\ServerDescription::getPort()</strong>


id: MongoDB\Driver\Server::getServerDescription
type: function
doc:
<comment>Description:</comment>
  Возвращает ServerDescription сервера
  
  Возвращает <class>MongoDB\Driver\ServerDescription</class> сервера. Это неизменяемый объект значения, который
  будет описывать сервер во время вызова метода.

<comment>Return:</comment>
  <info>MongoDB\Driver\ServerDescription</info>  Возвращает <class>MongoDB\Driver\ServerDescription</class> сервера.


id: MongoDB\Driver\Server::getTags
type: function
doc:
<comment>Description:</comment>
  Возвращает массив тегов, описывающих сервер в наборе реплик
  
  Возвращает <info>array</info> тегов, используемых для описания этого сервера в наборе реплик. Массив будет
  содержать ноль или более пар <info>string</info> ключей и значений.

<comment>Return:</comment>
  <info>array</info>  Возвращает <info>array</info> тегов, используемых для описания сервера в наборе реплик.

<comment>See Also:</comment>
   * <strong>MongoDB\Driver\Server::getInfo()</strong>


id: MongoDB\Driver\Server::getType
type: function
doc:
<comment>Description:</comment>
  Возвращает целое число, обозначающее тип этого сервера
  
  Возвращает <info>int</info>, обозначающее тип этого сервера. Значение будет соответствовать константе
  <class>MongoDB\Driver\Server</class>.

<comment>Return:</comment>
  <info>int</info>  Возвращает <info>int</info>, обозначающее тип этого сервера.

<comment>See Also:</comment>
   * <strong>MongoDB\Driver\Server::getInfo()</strong>
   * <strong>MongoDB\Driver\ServerDescription::getType()</strong>


id: MongoDB\Driver\Server::isArbiter
type: function
doc:
<comment>Description:</comment>
  Проверяет, является ли сервер членом-арбитром в наборе реплик
  
  Возвращает, является ли этот сервер членом-арбитром набора реплик.

<comment>Return:</comment>
  <info>bool</info>  Возвращает <info>true</info>, если этот сервер является членом-арбитром набора реплик, и <info>false</info> в
        противном случае.

<comment>See Also:</comment>
   * <strong>MongoDB\Driver\Server::getInfo()</strong>


id: MongoDB\Driver\Server::isHidden
type: function
doc:
<comment>Description:</comment>
  Проверяет, является ли сервер скрытым членом набора реплик
  
  Возвращает, является ли этот сервер скрытым членом набора реплик.

<comment>Return:</comment>
  <info>bool</info>  Возвращает <info>true</info>, если этот сервер является скрытым членом набора реплик, и <info>false</info> в противном
        случае.

<comment>See Also:</comment>
   * <strong>MongoDB\Driver\Server::getInfo()</strong>


id: MongoDB\Driver\Server::isPassive
type: function
doc:
<comment>Description:</comment>
  Проверяет, является ли сервер пассивным членом набора реплик
  
  Возвращает, является ли этот сервер пассивным членом набора реплик (то есть его приоритет равен
  <return>0</return>).

<comment>Return:</comment>
  <info>bool</info>  Возвращает <info>true</info>, если этот сервер является пассивным членом набора реплик, и <info>false</info> в
        противном случае.

<comment>See Also:</comment>
   * <strong>MongoDB\Driver\Server::getInfo()</strong>


id: MongoDB\Driver\Server::isPrimary
type: function
doc:
<comment>Description:</comment>
  Проверяет, является ли сервер основным членом набора реплик
  
  Возвращает, является ли этот сервер основным членом набора реплик.

<comment>Return:</comment>
  <info>bool</info>  Возвращает <info>true</info>, если этот сервер является основным членом набора реплик, и <info>false</info> в
        противном случае.

<comment>See Also:</comment>
   * <strong>MongoDB\Driver\Server::getInfo()</strong>


id: MongoDB\Driver\Server::isSecondary
type: function
doc:
<comment>Description:</comment>
  Проверяет, является ли этот сервер второстепенным членом набора реплик
  
  Возвращает, является ли этот сервер второстепенным членом набора реплик.

<comment>Return:</comment>
  <info>bool</info>  Возвращает <info>true</info>, если этот сервер является второстепенным членом набора реплик, и <info>false</info> в
        противном случае.

<comment>See Also:</comment>
   * <strong>MongoDB\Driver\Server::getInfo()</strong>


id: MongoDB\Driver\ServerApi::__construct
type: function
doc:
<comment>Description:</comment>
  Создаёт новый экземпляр ServerApi
  
  Создаёт новый экземпляр <class>MongoDB\Driver\ServerApi</class> экземпляр, используемый для объявления версии API
  при создании <class>MongoDB\Driver\Manager</class>.

<comment>Param:</comment>
  <info>string</info>     <strong>$version</strong>            Версия API сервера.
                                 
                                 Поддерживаемые версии API представлены в виде констант в
                                 <class>MongoDB\Driver\ServerApi</class>. Единственной поддерживаемой версией API
                                 является <info>MongoDB\Driver\ServerApi::V1</info>.
  <info>bool|null</info>  <strong>$strict</strong>             Если у параметра <strong>$strict</strong> установлено значение <info>true</info>, сервер будет
                                 выдавать ошибку для любой команды, которая не является частью
                                 указанной версии API. Если значение не указано, используется
                                 значение по умолчанию (<info>false</info>).
  <info>bool|null</info>  <strong>$deprecationErrors</strong>  Если у параметра <strong>$deprecationErrors</strong> установлено значение <info>true</info>,
                                 сервер будет выдавать ошибку при использовании команды, которая
                                 устарела в указанной версии API. Если значение не задано,
                                 используется значение по умолчанию (<info>false</info>).


id: MongoDB\Driver\ServerApi::bsonSerialize
type: function
doc:
<comment>Description:</comment>
  Возвращает объект для сериализации BSON

<comment>Return:</comment>
  <info>stdClass</info>  Возвращает объект для сериализации ServerApi как BSON.

<comment>See Also:</comment>
   * MongoDB\BSON\Serializable::bsonSerialize


id: MongoDB\Driver\ServerApi::serialize
type: function
doc:
<comment>Description:</comment>
  Сериализует ServerApi

<comment>Return:</comment>
  <info>string</info>  Возвращает сериализованное представление <class>MongoDB\Driver\ServerApi</class>.

<comment>See Also:</comment>
   * MongoDB\Driver\ServerApi::unserialize
   * <strong>serialize()</strong>
   * Сериализация объектов


id: MongoDB\Driver\ServerApi::unserialize
type: function
doc:
<comment>Description:</comment>
  Десериализует ServerApi

<comment>Param:</comment>
  <info>string</info>  <strong>$data</strong>  Сериализованный <class>MongoDB\Driver\ServerApi</class>.

<comment>Return:</comment>
  <info>void</info>  Функция не возвращает значения после выполнения.

<comment>See Also:</comment>
   * MongoDB\Driver\ServerApi::serialize
   * <strong>unserialize()</strong>
   * Сериализация объектов


id: MongoDB\Driver\ServerDescription
type: class
doc:
<comment>Description:</comment>
  Класс <class>MongoDB\Driver\ServerDescription</class> представляет собой объект значения, представляющий сервер,
  к которому подключён драйвер. Экземпляры класса возвращаются методами
  <strong>MongoDB\Driver\Server::getServerDescription()</strong> и <class>MongoDB\Driver\Monitoring\ServerChangedEvent</class>.


id: MongoDB\Driver\ServerDescription::TYPE_LOAD_BALANCER
type: constant
doc:
<comment>Description:</comment>
  Тип сервера балансировщика нагрузки, возвращаемый методом
  MongoDB\Driver\ServerDescription::getType.


id: MongoDB\Driver\ServerDescription::TYPE_MONGOS
type: constant
doc:
<comment>Description:</comment>
  Тип сервера Mongos, возвращаемый методом MongoDB\Driver\ServerDescription::getType.


id: MongoDB\Driver\ServerDescription::TYPE_POSSIBLE_PRIMARY
type: constant
doc:
<comment>Description:</comment>
  Набор реплик возможного типа первичного сервера, возвращаемый методом
  MongoDB\Driver\ServerDescription::getType.
  
  Сервер может быть определён как возможный первичный, если он ещё не был проверен, но другая память
  набора реплик считает его первичным.


id: MongoDB\Driver\ServerDescription::TYPE_RS_ARBITER
type: constant
doc:
<comment>Description:</comment>
  Тип сервера арбитража набора реплик, возвращаемый методом
  MongoDB\Driver\ServerDescription::getType.


id: MongoDB\Driver\ServerDescription::TYPE_RS_GHOST
type: constant
doc:
<comment>Description:</comment>
  Тип сервера-призрака набора реплик, возвращаемый методом
  MongoDB\Driver\ServerDescription::getType.
  
  Серверы могут быть определены как таковые по крайней мере в трёх ситуациях: кратковременно во
  время запуска сервера; в неинициализированном наборе реплик; или когда сервер избегается (т.е.
  удаляется из конфигурации набора реплик). Они не могут быть запрошены, и их список хостов не может
  быть использован для обнаружения текущей конфигурации набора реплик; однако клиент может следить
  за этим сервером в надежде, что он перейдёт в более полезное состояние.


id: MongoDB\Driver\ServerDescription::TYPE_RS_OTHER
type: constant
doc:
<comment>Description:</comment>
  Набор реплик другого типа сервера, возвращаемый методом MongoDB\Driver\ServerDescription::getType.
  
  Такие серверы могут быть скрыты, запускаться или восстанавливаться. Их нельзя запросить, но их
  списки хостов полезны для обнаружения текущей конфигурации набора реплик.


id: MongoDB\Driver\ServerDescription::TYPE_RS_PRIMARY
type: constant
doc:
<comment>Description:</comment>
  Тип первичного сервера набора реплик, возвращаемый методом
  MongoDB\Driver\ServerDescription::getType.


id: MongoDB\Driver\ServerDescription::TYPE_RS_SECONDARY
type: constant
doc:
<comment>Description:</comment>
  Тип вторичного сервера набора реплик, возвращаемый методом
  MongoDB\Driver\ServerDescription::getType.


id: MongoDB\Driver\ServerDescription::TYPE_STANDALONE
type: constant
doc:
<comment>Description:</comment>
  Тип автономного сервера, возвращаемый методомMongoDB\Driver\ServerDescription::getType.


id: MongoDB\Driver\ServerDescription::TYPE_UNKNOWN
type: constant
doc:
<comment>Description:</comment>
  Неизвестный тип сервера, возвращаемый методом MongoDB\Driver\ServerDescription::getType.


id: MongoDB\Driver\ServerDescription::getHelloResponse
type: function
doc:
<comment>Description:</comment>
  Возвращает последний ответ сервера "hello"
  
  Возвращает массив информации, описывающей сервер. Этот массив формируется из самого последнего (на
  момент создания <class>MongoDB\Driver\ServerDescription</class>) ответа команды hello ответ команды, полученный с
  помощью мониторинга сервера.
  
  Если драйвер подключён к балансировщику нагрузки, метод вернёт пустой массив, так как
  балансировщики нагрузки не отслеживаются. В отличие от <strong>MongoDB\Driver\Server::getInfo()</strong>, которая
  возвращает ответ команды hello от начального рукопожатия соединения.

<comment>Return:</comment>
  <info>array</info>  Возвращает массив информации, описывающей сервер.

<comment>See Also:</comment>
   * <strong>MongoDB\Driver\Server::getInfo()</strong>
   * Команда hello в руководстве по MongoDB
   * Спецификация обнаружения и мониторинга серверов


id: MongoDB\Driver\ServerDescription::getHost
type: function
doc:
<comment>Description:</comment>
  Возвращает имя хоста сервера
  
  Возвращает имя хоста сервера.

<comment>Return:</comment>
  <info>string</info>  Возвращает имя хоста сервера.

<comment>See Also:</comment>
   * <strong>MongoDB\Driver\Server::getHost()</strong>


id: MongoDB\Driver\ServerDescription::getLastUpdateTime
type: function
doc:
<comment>Description:</comment>
  Возвращает время последнего обновления сервера в микросекундах
  
  Возвращает время последнего обновления сервера в микросекундах.
  
  Возвращаемое значение представляет собой монотонную метку времени, которая начинается в
  произвольной точке. Как таковое, оно подходит только для сравнения с другими возвращаемыми
  значениями из функции <strong>MongoDB\Driver\ServerDescription::getLastUpdateTime()</strong>.

<comment>Return:</comment>
  <info>int</info>  Возвращает время последнего обновления сервера в микросекундах.


id: MongoDB\Driver\ServerDescription::getPort
type: function
doc:
<comment>Description:</comment>
  Возвращает порт, на котором прослушивается данный сервер
  
  Возвращает порт, на котором прослушивается данный сервер.

<comment>Return:</comment>
  <info>int</info>  Возвращает порт, на котором прослушивается данный сервер.

<comment>See Also:</comment>
   * <strong>MongoDB\Driver\Server::getPort()</strong>


id: MongoDB\Driver\ServerDescription::getRoundTripTime
type: function
doc:
<comment>Description:</comment>
  Возвращает время обхода сервера в миллисекундах
  
  Возвращает время обхода сервера в миллисекундах. Это измерение продолжительности команды hello.

<comment>Return:</comment>
  <info>int|null</info>  Возвращает время обхода сервера в миллисекундах.

<comment>See Also:</comment>
   * <strong>MongoDB\Driver\Server::getLatency()</strong>


id: MongoDB\Driver\ServerDescription::getType
type: function
doc:
<comment>Description:</comment>
  Возвращает строку, обозначающую тип данного сервера
  
  Возвращает строку (<info>string</info>), обозначающую тип данного сервера. Значение будет соотноситься с
  константой <class>MongoDB\Driver\ServerDescription</class>.

<comment>Return:</comment>
  <info>string</info>  Возвращает строку (<info>string</info>), обозначающую тип данного сервера.

<comment>See Also:</comment>
   * <strong>MongoDB\Driver\Server::getType()</strong>


id: MongoDB\Driver\Session
type: class
doc:
<comment>Description:</comment>
  Класс <class>MongoDB\Driver\Session</class> представляет клиентский сеанс и возвращается
  MongoDB\Driver\Manager::startSession. Команды, запросы и операции записи могут затем быть связаны
  с сеансом.


id: MongoDB\Driver\Session::TRANSACTION_STARTING
type: constant
doc:
<comment>Description:</comment>
  Транзакция была начата, но на сервер не было отправлено ни одной операции.


id: MongoDB\Driver\Session::__construct
type: function
doc:
<comment>Description:</comment>
  Создаёт новый сеанс (не используется)
  
  <class>MongoDB\Driver\Session</class> объекты возвращаются MongoDB\Driver\Manager::startSession и не могут быть
  созданы напрямую.

<comment>See Also:</comment>
   * <strong>MongoDB\Driver\Manager::startSession()</strong>


id: MongoDB\Driver\Session::abortTransaction
type: function
doc:
<comment>Description:</comment>
  Прерывает транзакцию
  
  Завершает многодокументную транзакцию и откатывает любые изменения данных, сделанные операциями
  внутри транзакции. То есть транзакция заканчивается без сохранения каких-либо изменений, внесённых
  операциями в транзакции.

<comment>Return:</comment>
  <info>void</info>  Функция не возвращает значения после выполнения.

<comment>See Also:</comment>
   * MongoDB\Driver\Manager::startSession
   * MongoDB\Driver\Session::commitTransaction
   * MongoDB\Driver\Session::startTransaction


id: MongoDB\Driver\Session::advanceClusterTime
type: function
doc:
<comment>Description:</comment>
  Увеличивает время кластера для сеанса
  
  Увеличивает время кластера для сеанса. Если время кластера меньше или равно текущему времени
  кластера сеанса, функция не будет работать.
  
  Используя этот метод в сочетании с MongoDB\Driver\Session::advanceOperationTime для копирования
  кластера и времени операций из другого сеанса, вы можете убедиться, что операции в этом сеансе
  причинно соответствуют последней операции в другом сеансе.

<comment>Param:</comment>
  <info>array|object</info>  <strong>$clusterTime</strong>  Время кластера - это документ, содержащий логическую метку времени и
                              сигнатуру сервера. Как правило, это значение будет получено путём
                              вызова MongoDB\Driver\Session::getClusterTime для другого объекта
                              сеанса.

<comment>Return:</comment>
  <info>void</info>  Функция не возвращает значения после выполнения.

<comment>See Also:</comment>
   * MongoDB\Driver\Session::advanceOperationTime
   * MongoDB\Driver\Session::getClusterTime


id: MongoDB\Driver\Session::advanceOperationTime
type: function
doc:
<comment>Description:</comment>
  Увеличивает время операции для сеанса
  
  Увеличивает время операции для сеанса. Если время операции меньше или равно текущему времени
  сеанса, функция не будет работать.
  
  Используя этот метод в сочетании с MongoDB\Driver\Session::advanceClusterTime для копирования
  операции и времени кластеризации из другого сеанса, вы можете гарантировать, что операции в этом
  сеансе причинно согласуются с последней операцией в другом сеансе.

<comment>Param:</comment>
  <info>MongoDB\BSON\TimestampInterface</info>  <strong>$operationTime</strong>  Время операции является логической отметкой
                                                   времени. Как правило, это значение будет получено
                                                   путём вызова
                                                   MongoDB\Driver\Session::getOperationTime для
                                                   другого объекта сеанса.

<comment>Return:</comment>
  <info>void</info>  Функция не возвращает значения после выполнения.

<comment>See Also:</comment>
   * MongoDB\Driver\Session::advanceClusterTime
   * MongoDB\Driver\Session::getClusterTime


id: MongoDB\Driver\Session::commitTransaction
type: function
doc:
<comment>Description:</comment>
  Фиксирует транзакцию
  
  Сохраняет изменения, внесённые операциями в многодокументную транзакцию и завершает транзакцию. До
  фиксации ни одно изменение данных, сделанных из транзакции, не будет видно за пределами
  транзакции.

<comment>Return:</comment>
  <info>void</info>  Функция не возвращает значения после выполнения.

<comment>See Also:</comment>
   * MongoDB\Driver\Manager::startSession
   * MongoDB\Driver\Session::abortTransaction
   * MongoDB\Driver\Session::startTransaction
   * MongoDB\Driver\Exception\RuntimeException::hasErrorLabel


id: MongoDB\Driver\Session::endSession
type: function
doc:
<comment>Description:</comment>
  Завершает сеанс
  
  Этот метод закрывает существующий сеанс. Если транзакция была связана с этим сеансом, транзакция
  будет прервана. После вызова этого метода приложения не должны вызывать другие методы в сеансе.
  
  Сессии также закрыты во время сбора мусора. Не должно быть необходимости вызывать этот метод при
  нормальных обстоятельствах.

<comment>Return:</comment>
  <info>void</info>  Функция не возвращает значения после выполнения.

<comment>See Also:</comment>
   * MongoDB\Driver\Manager::startSession
   * MongoDB\Driver\Session::abortTransaction
   * MongoDB\Driver\Session::commitTransaction
   * MongoDB\Driver\Session::startTransaction


id: MongoDB\Driver\Session::getClusterTime
type: function
doc:
<comment>Description:</comment>
  Возвращает время кластера для этого сеанса
  
  Возвращает время кластера для этого сеанса. Если сеанс не использовался для какой-либо операции и
  MongoDB\Driver\Session::advanceClusterTime не был вызван, время кластера будет равно <info>null</info>.

<comment>Return:</comment>
  <info>object|null</info>  Возвращает время кластера для этого сеанса или <info>null</info>, если у сеанса нет времени
               кластера.

<comment>See Also:</comment>
   * MongoDB\Driver\Session::advanceClusterTime


id: MongoDB\Driver\Session::getLogicalSessionId
type: function
doc:
<comment>Description:</comment>
  Возвращает логический идентификатор сеанса для этого сеанса
  
  Возвращает логический идентификатор сеанса для этого сеанса, который может использоваться для
  идентификации операций сеанса на сервере.

<comment>Return:</comment>
  <info>object</info>  Возвращает логический идентификатор сеанса для этого сеанса.


id: MongoDB\Driver\Session::getOperationTime
type: function
doc:
<comment>Description:</comment>
  Возвращает время операции для этого сеанса
  
  Возвращает время операции для этого сеанса. Если сеанс не использовался ни для какой операции, и
  MongoDB\Driver\Session::advanceOperationTime не был вызван, время операции будет равно <info>null</info>.

<comment>Return:</comment>
  <info>MongoDB\BSON\Timestamp|null</info>  Возвращает время операции для этого сеанса или <info>null</info>, если у сеанса
                               нет времени операции.

<comment>See Also:</comment>
   * MongoDB\Driver\Session::advanceOperationTime


id: MongoDB\Driver\Session::getServer
type: function
doc:
<comment>Description:</comment>
  Возвращает сервер к которому привязана текущая сессия
  
  Возвращает <class>MongoDB\Driver\Server</class>, к которому привязана текущая сессия. Если сессия не привязана к
  серверу, то будет возвращён <info>null</info>.
  
  Привязка сессии в основном используется для шардированных транзакций, так как все команды должны
  идти на один и тот же экземпляр mongos. Этот метод предназначен для использования в библиотеках,
  построенных поверх модуля, чтобы можно было закрепить сервер, а не выбирать сервер для каждой
  следующей команды.

<comment>Return:</comment>
  <info>MongoDB\Driver\Server|null</info>  Возвращает <class>MongoDB\Driver\Server</class> к которому прикреплена сессия. Или
                              <info>null</info>, если сессия не прикреплена ни к какому серверу.


id: MongoDB\Driver\Session::getTransactionOptions
type: function
doc:
<comment>Description:</comment>
  Возвращает настройки текущей транзакции
  
  Возвращает настройки текущей транзакции.

<comment>Return:</comment>
  <info>array|null</info>  Возвращает массив, содержащий настройки текущей транзакции, либо <info>null</info>, если транзакция
              не стартована.

<comment>See Also:</comment>
   * MongoDB\Driver\Session::getTransactionState


id: MongoDB\Driver\Session::getTransactionState
type: function
doc:
<comment>Description:</comment>
  Возвращает статус транзакции для текущей сессии
  
  Возвращает статус транзакции для текущей сессии.

<comment>Return:</comment>
  <info>string</info>  Возвращает статус транзакции для текущей сессии.

<comment>See Also:</comment>
   * MongoDB\Driver\Session::isInTransaction
   * MongoDB\Driver\Session::getTransactionOptions


id: MongoDB\Driver\Session::isDirty
type: function
doc:
<comment>Description:</comment>
  Возвращает, была ли сессия помечена как грязная
  
  Возвращает, была ли сессия помечена как грязная (т.е. была ли она использована с командой, которая
  столкнулась с сетевой ошибкой).

<comment>Return:</comment>
  <info>bool</info>  Функция возвращает, была ли сессия помечена как грязная.


id: MongoDB\Driver\Session::isInTransaction
type: function
doc:
<comment>Description:</comment>
  Определяет, происходит ли в данный момент многодокументная транзакция
  
  Определяет, происходит ли в данный момент в текущей сессии многодокументная транзакция. Считается,
  что транзакция "происходит прямо сейчас", если она была запущена, но пока не была ни подтверждена
  ни отменена.

<comment>Return:</comment>
  <info>boolean</info>  Возвращает <info>true</info> или <info>false</info>.

<comment>See Also:</comment>
   * MongoDB\Driver\Session::getTransactionState


id: MongoDB\Driver\Session::startTransaction
type: function
doc:
<comment>Description:</comment>
  Запускает транзакцию
  
  Запускает многодокументную транзакцию, связанную с сеансом. В любой момент времени вы можете иметь
  не более одной открытой транзакции для сеанса. После запуска транзакции объект сеанса должен быть
  передан каждой операции с помощью опции <return>"session"</return> (например,
  MongoDB\Driver\Manager::executeBulkWrite), чтобы связать эту операцию с транзакцией.
  
  Транзакции могут быть зафиксированы через MongoDB\Driver\Session::commitTransaction и прерваны с
  помощью MongoDB\Driver\Session::abortTransaction. Транзакции также автоматически прерываются,
  когда сеанс закрывается из сборки мусора или явно вызывается MongoDB\Driver\Session::endSession.

<comment>Param:</comment>
  <info>array|null</info>  <strong>$options</strong>  Параметры могут быть переданы в качестве аргумента этому методу. Каждый
                        элемент в этом массиве опций переопределяет соответствующую опцию из опции
                        <return>"defaultTransactionOptions"</return>, если она установлена при запуске сеанса с
                        MongoDB\Driver\Manager::startSession.
                        
                        optionsОпцияТипОписаниеmaxCommitTimeMSinteger Максимальный период времени в
                        миллисекундах, в течение которого может выполняться одна команда
                        <return>commitTransaction</return>.  Если указано, <return>maxCommitTimeMS</return> должно быть 32-разрядным
                        целым числом со знаком, большим или равным нулю.
                        readConcern<class>MongoDB\Driver\ReadConcern</class> Гарантия чтения для применения к
                        операции.  Эта опция доступна в MongoDB 3.2+ и приведёт к исключению во
                        время выполнения, если указана для более старой версии сервера.
                        readPreference<class>MongoDB\Driver\ReadPreference</class> Предпочтение чтения,
                        используемая для выбора сервера для выполнения операции.
                        writeConcern<class>MongoDB\Driver\WriteConcern</class> Гарантия записи для применения к
                        операции.
                        
                        Максимальный период времени в миллисекундах, в течение которого может
                        выполняться одна команда <return>commitTransaction</return>.
                        
                        Если указано, <return>maxCommitTimeMS</return> должно быть 32-разрядным целым числом со
                        знаком, большим или равным нулю.
                        
                        Гарантия чтения для применения к операции.
                        
                        Эта опция доступна в MongoDB 3.2+ и приведёт к исключению во время
                        выполнения, если указана для более старой версии сервера.
                        
                        Предпочтение чтения, используемая для выбора сервера для выполнения
                        операции.
                        
                        Гарантия записи для применения к операции.

<comment>Return:</comment>
  <info>void</info>  Функция не возвращает значения после выполнения.

<comment>See Also:</comment>
   * MongoDB\Driver\Manager::startSession
   * MongoDB\Driver\Session::commitTransaction
   * MongoDB\Driver\Session::abortTransaction


id: MongoDB\Driver\TopologyDescription
type: class
doc:
<comment>Description:</comment>
  Класс <class>MongoDB\Driver\TopologyDescription</class> представляет собой объект значения, представляющий
  топологию, к которой подключён драйвер. Экземпляры класса возвращаются методами
  <class>MongoDB\Driver\Monitoring\TopologyChangedEvent</class>.


id: MongoDB\Driver\TopologyDescription::TYPE_LOAD_BALANCED
type: constant
doc:
<comment>Description:</comment>
  Сбалансированная по нагрузке топология, возвращаемая методом
  MongoDB\Driver\TopologyDescription::getType.


id: MongoDB\Driver\TopologyDescription::TYPE_REPLICA_SET_NO_PRIMARY
type: constant
doc:
<comment>Description:</comment>
  Набор реплик без первичного сервера, возвращаемый методом
  MongoDB\Driver\TopologyDescription::getType.


id: MongoDB\Driver\TopologyDescription::TYPE_REPLICA_SET_WITH_PRIMARY
type: constant
doc:
<comment>Description:</comment>
  Набор реплик с первичным сервером, возвращаемый методом
  MongoDB\Driver\TopologyDescription::getType.


id: MongoDB\Driver\TopologyDescription::TYPE_SHARDED
type: constant
doc:
<comment>Description:</comment>
  Разделяемый кластер, возвращаемый методом MongoDB\Driver\TopologyDescription::getType.


id: MongoDB\Driver\TopologyDescription::TYPE_SINGLE
type: constant
doc:
<comment>Description:</comment>
  Одиночный сервер (т.е. прямое соединение), возвращаемый методом
  MongoDB\Driver\TopologyDescription::getType.


id: MongoDB\Driver\TopologyDescription::TYPE_UNKNOWN
type: constant
doc:
<comment>Description:</comment>
  Неизвестный тип топологии, возвращаемый методом MongoDB\Driver\TopologyDescription::getType.


id: MongoDB\Driver\TopologyDescription::getServers
type: function
doc:
<comment>Description:</comment>
  Возвращает серверы в топологии
  
  Возвращает массив объектов <class>MongoDB\Driver\ServerDescription</class>, соответствующих известным серверам в
  топологии.

<comment>Return:</comment>
  <info>array</info>  Возвращает массив объектов <class>MongoDB\Driver\ServerDescription</class>, соответствующих известным
         серверам в топологии.


id: MongoDB\Driver\TopologyDescription::getType
type: function
doc:
<comment>Description:</comment>
  Возвращает строку, обозначающую тип топологии
  
  Возвращает строку (<info>string</info>), обозначающую тип топологии. Значение будет соотноситься с константой
  <class>MongoDB\Driver\TopologyDescription</class>.

<comment>Return:</comment>
  <info>string</info>  Возвращает строку (<info>string</info>), обозначающую тип топологии.


id: MongoDB\Driver\TopologyDescription::hasReadableServer
type: function
doc:
<comment>Description:</comment>
  Возвращает, есть ли в топологии сервер, доступный для чтения
  
  Возвращает, есть ли в топологии сервер, доступный для чтения, или, если указан параметр
  <strong>$readPreference</strong>, сервер, соответствующий указанному предпочтению чтения.

<comment>Return:</comment>
  <info>bool</info>  Возвращает, есть ли в топологии сервер, доступный для чтения, или, если указан параметр
        <strong>$readPreference</strong>, сервер, соответствующий указанному предпочтению чтения.


id: MongoDB\Driver\TopologyDescription::hasWritableServer
type: function
doc:
<comment>Description:</comment>
  Возвращает, есть ли в топологии сервер, доступный для записи
  
  Возвращает, есть ли в топологии сервер, доступный для записи.

<comment>Return:</comment>
  <info>bool</info>  Возвращает, есть ли в топологии сервер, доступный для записи.


id: MongoDB\Driver\WriteConcern
type: class
doc:
<comment>Description:</comment>
  <class>MongoDB\Driver\WriteConcern</class> описывает уровень надёжности, запрошенный MongoDB для операций записи
  на автономный <return>mongod</return> или на набор реплик или на сегментированные кластеры. В сегментированных
  кластерах экземпляры <return>mongos</return> будут передавать гарантии записи на сегменты.


id: MongoDB\Driver\WriteConcern::MAJORITY
type: constant
doc:
<comment>Description:</comment>
  Большинство членов в наборе; арбитров, члены, не участвующие в голосовании, пассивные члены,
  скрытые члены и отложенные члены, все они включены в определение большинства гарантии записи.


id: MongoDB\Driver\WriteConcern::__construct
type: function
doc:
<comment>Description:</comment>
  Создать новый WriteConcern
  
  Создаёт новый <class>MongoDB\Driver\WriteConcern</class>, который является неизменяемым объектом значения.

<comment>Param:</comment>
  <info>string|int</info>  <strong>$w</strong>         Гарантия записиЗначениеОписание1 Требует подтверждение, что операция записи
                         распространилась на автономный <return>mongod</return> или на первичный в наборе реплик. Это
                         гарантия записи по умолчанию для MongoDB. 0 Не требует подтверждение
                         операции записи. Тем не менее, это может вернуть информацию о исключениях
                         сокета и сетевых ошибках в приложение. \<целое число больше 1&gt; Числа, превышающие 1 действительны только для набора реплик для запроса подтверждения от указанного количества членов, включая первичный. <info>MongoDB\Driver\WriteConcern::MAJORITY</info> Требует подтверждения того, что операции записи распространяются на большинство голосующих узлов, включая первичный, и были записаны в журнал на диск для этих узлов.  До MongoDB 3.0 это относится к большинству членов набора реплик (а не только к узлам голосования). string Строковое представление интерпретируется как набор тегов. Требует подтверждение, что операция записи распространяется на член набора реплик с указанным тегом.
                         
                         Требует подтверждения того, что операции записи распространяются на
                         большинство голосующих узлов, включая первичный, и были записаны в журнал
                         на диск для этих узлов.
                         
                         До MongoDB 3.0 это относится к большинству членов набора реплик (а не
                         только к узлам голосования).
  <info>int|null</info>    <strong>$wtimeout</strong>  Сколько ждать (в миллисекундах) ответа от вторичных узлов перед тем, как
                         выдать ошибку.
                         
                         <return>wtimeout</return> приводит к тому, что операции записи возвращаются с ошибкой
                         (<class>WriteConcernError</class>) после указанного периода, даже если требуемая гарантия
                         записи в конечном счёте будет успешной. Когда эти гарантии записи
                         возвращаются, MongoDB не отменяет успешные изменения данных, выполненные до
                         того, как гарантия записи превысила временной лимит <return>wtimeout</return>
                         
                         Если указано, <return>wtimeout</return> должен быть 64-битным целым числом со знаком, больше
                         или равен нулю.
                         
                         Время ожидания гарантии записиЗначениеОписание0Блокировать бесконечно. Это
                         значение по умолчанию.\<целое число больше, чем 0&gt; Миллисекунды до ожидания возврата.
  <info>bool|null</info>   <strong>$journal</strong>   Ожидать, пока mongod не применит запись в журнал.

<comment>See Also:</comment>
   * Справочная информация по гарантии записи


id: MongoDB\Driver\WriteConcern::bsonSerialize
type: function
doc:
<comment>Description:</comment>
  Возвращает объект сериализации BSON

<comment>Return:</comment>
  <info>stdClass</info>  Возвращает объект сериализации WriteConcern как BSON.

<comment>See Also:</comment>
   * MongoDB\BSON\Serializable::bsonSerialize
   * Справочная информация по гарантии записи


id: MongoDB\Driver\WriteConcern::getJournal
type: function
doc:
<comment>Description:</comment>
  Возвращает опцию "journal" WriteConcern

<comment>Return:</comment>
  <info>bool|null</info>  Возвращает опцию "journal" WriteConcern.

<comment>See Also:</comment>
   * Руководство по гарантии записи


id: MongoDB\Driver\WriteConcern::getW
type: function
doc:
<comment>Description:</comment>
  Возвращает опцию "w" WriteConcern

<comment>Return:</comment>
  <info>string|int|null</info>  Возвращает опцию "w" WriteConcern.

<comment>See Also:</comment>
   * Руководство по гарантии записи


id: MongoDB\Driver\WriteConcern::getWtimeout
type: function
doc:
<comment>Description:</comment>
  Возвращает опцию "wtimeout" WriteConcern

<comment>Return:</comment>
  <info>int</info>  Возвращает опцию "wtimeout" WriteConcern.

<comment>See Also:</comment>
   * Руководство по гарантии записи


id: MongoDB\Driver\WriteConcern::isDefault
type: function
doc:
<comment>Description:</comment>
  Проверяет, является ли гарантия записи по умолчанию
  
  Проверяет, является ли эта гарантия записи по умолчанию (т.е. не указаны параметры). Этот метод в
  первую очередь предназначен для использования совместно с MongoDB\Driver\Manager::getWriteConcern
  для определения того, был ли объект Manager создан без каких-либо опций гарантии записи.
  
  Драйвер не будет включать гарантию записи по умолчанию в свои операции записи (например,
  MongoDB\Driver\Manager::executeBulkWrite), чтобы позволить серверу применять свою собственную по
  умолчанию, которая, возможно, была изменена. Библиотеки, которые обращаются к гарантии записи
  Manager, чтобы включить её в свои собственные команды записи, должны использовать этот метод,
  чтобы гарантировать, что гарантии записи по умолчанию остаются неустановленными.

<comment>Return:</comment>
  <info>bool</info>  Возвращает <info>true</info>, если эта гарантия записи по умолчанию, или <info>false</info> в противном случае.

<comment>See Also:</comment>
   * MongoDB\Driver\Manager::getWriteConcern
   * Изменение гарантии записи по умолчанию в руководстве MongoDB
   * Справочная информация по гарантии записи


id: MongoDB\Driver\WriteConcern::serialize
type: function
doc:
<comment>Description:</comment>
  Сериализация WriteConcern

<comment>Return:</comment>
  <info>string</info>  Возвращает сериализованное представление <class>MongoDB\Driver\WriteConcern</class>.

<comment>See Also:</comment>
   * MongoDB\Driver\WriteConcern::unserialize
   * <strong>serialize()</strong>
   * Сериализация объектов


id: MongoDB\Driver\WriteConcern::unserialize
type: function
doc:
<comment>Description:</comment>
  Десериализация WriteConcern

<comment>Param:</comment>
  <info>string</info>  <strong>$data</strong>  Сериализованный <class>MongoDB\Driver\WriteConcern</class>.

<comment>Return:</comment>
  <info>void</info>  Функция не возвращает значения после выполнения.

<comment>See Also:</comment>
   * MongoDB\Driver\WriteConcern::serialize
   * <strong>unserialize()</strong>
   * Сериализация объектов


id: MongoDB\Driver\WriteConcernError
type: class
doc:
<comment>Description:</comment>
  Класс <class>MongoDB\Driver\WriteConcernError</class> инкапсулирует информацию об ошибке записи и может быть
  возвращён MongoDB\Driver\WriteResult::getWriteConcernError.


id: MongoDB\Driver\WriteConcernError::getCode
type: function
doc:
<comment>Description:</comment>
  Возвращает код ошибки WriteConcernError

<comment>Return:</comment>
  <info>int</info>  Возвращает код ошибки WriteConcernError.

<comment>See Also:</comment>
   * Справка по гарантиям записи


id: MongoDB\Driver\WriteConcernError::getInfo
type: function
doc:
<comment>Description:</comment>
  Возвращает документ метаданных для WriteConcernError

<comment>Return:</comment>
  <info>object|null</info>  Возвращает документ метаданных для WriteConcernError или <info>null</info>, если нет метаданных.

<comment>See Also:</comment>
   * Справка по гарантиям записи


id: MongoDB\Driver\WriteConcernError::getMessage
type: function
doc:
<comment>Description:</comment>
  Возвращает сообщение об ошибке WriteConcernError

<comment>Return:</comment>
  <info>string</info>  Возвращает сообщение об ошибке WriteConcernError.

<comment>See Also:</comment>
   * Справка по гарантиям записи


id: MongoDB\Driver\WriteError
type: class
doc:
<comment>Description:</comment>
  Класс <class>MongoDB\Driver\WriteError</class> инкапсулирует информацию об ошибке записи и может быть возвращён
  как элемент массива из MongoDB\Driver\WriteResult::getWriteErrors.


id: MongoDB\Driver\WriteError::getCode
type: function
doc:
<comment>Description:</comment>
  Возвращает код ошибки WriteError

<comment>Return:</comment>
  <info>int</info>  Возвращает код ошибки WriteError.


id: MongoDB\Driver\WriteError::getIndex
type: function
doc:
<comment>Description:</comment>
  Возвращает индекс записи, соответствующей этому WriteError

<comment>Return:</comment>
  <info>int</info>  Возвращает индекс записи (из <class>MongoDB\Driver\BulkWrite</class>), соответствующий текущему WriteError.

<comment>See Also:</comment>
   * <class>MongoDB\Driver\BulkWrite</class>


id: MongoDB\Driver\WriteError::getInfo
type: function
doc:
<comment>Description:</comment>
  Возвращает документ метаданных для WriteError

<comment>Return:</comment>
  <info>object|null</info>  Возвращает документ метаданных для WriteError, либо <info>null</info>, если метаданные недоступны.


id: MongoDB\Driver\WriteError::getMessage
type: function
doc:
<comment>Description:</comment>
  Возвращает сообщение об ошибке WriteError

<comment>Return:</comment>
  <info>string</info>  Возвращает сообщение об ошибке WriteError.


id: MongoDB\Driver\WriteResult
type: class
doc:
<comment>Description:</comment>
  Класс <class>MongoDB\Driver\WriteResult</class> инкапсулирует информацию о выполненном <class>MongoDB\Driver\BulkWrite</class> и
  может быть возвращён MongoDB\Driver\Manager::executeBulkWrite.


id: MongoDB\Driver\WriteResult::getDeletedCount
type: function
doc:
<comment>Description:</comment>
  Возвращает количество удалённых документов

<comment>Return:</comment>
  <info>int|null</info>  Возвращает количество удалённых документов или <info>null</info> если запись не была подтверждена.

<comment>See Also:</comment>
   * MongoDB\Driver\WriteResult::isAcknowledged


id: MongoDB\Driver\WriteResult::getInsertedCount
type: function
doc:
<comment>Description:</comment>
  Возвращает количество вставленных документов (исключая слияния)

<comment>Return:</comment>
  <info>int|null</info>  Возвращает количество вставленных документов (исключая слияния) или <info>null</info> если запись не
            была подтверждена.

<comment>See Also:</comment>
   * MongoDB\Driver\WriteResult::isAcknowledged


id: MongoDB\Driver\WriteResult::getMatchedCount
type: function
doc:
<comment>Description:</comment>
  Возвращает количество документов, выбранных для обновления
  
  Если операция обновления не приводит к изменению документа (например, установка значения поля в
  его текущее значение), сопоставленное количество может быть больше, чем значение, возвращаемое
  MongoDB\Driver\WriteResult::getModifiedCount.

<comment>Return:</comment>
  <info>int|null</info>  Возвращает количество документов, выбранных для обновления, или <info>null</info> если запись не была
            подтверждена.

<comment>See Also:</comment>
   * MongoDB\Driver\WriteResult::getModifiedCount
   * MongoDB\Driver\WriteResult::isAcknowledged


id: MongoDB\Driver\WriteResult::getModifiedCount
type: function
doc:
<comment>Description:</comment>
  Возвращает количество существующих обновлённых документов
  
  Если операция обновления не приводит к изменению документа (например, установка значения поля в
  его текущее значение), изменённое число может быть меньше, чем значение, возвращаемое
  MongoDB\Driver\WriteResult::getMatchedCount.

<comment>Return:</comment>
  <info>int|null</info>  Возвращает количество существующих обновлённых документов или <info>null</info>, если запись не была
            подтверждена.
            
            Изменённый счётчик недоступен в версиях MongoDB до версии 2.6, в которой использовалась
            устаревшая версия проводного протокола (т.е. OP_UPDATE). В этом случае изменённое
            количество также будет равно <info>null</info>.

<comment>See Also:</comment>
   * MongoDB\Driver\WriteResult::getMatchedCount
   * MongoDB\Driver\WriteResult::isAcknowledged


id: MongoDB\Driver\WriteResult::getServer
type: function
doc:
<comment>Description:</comment>
  Возвращает сервер, связанный с этим результатом записи
  
  Возвращает <class>MongoDB\Driver\Server</class>, связанный с этим результатом записи. Это сервер, который
  выполнил <class>MongoDB\Driver\BulkWrite</class>.

<comment>Return:</comment>
  <info>MongoDB\Driver\Server</info>  Возвращает <class>MongoDB\Driver\Server</class> связанный с этим результатом записи.

<comment>See Also:</comment>
   * <class>MongoDB\Driver\Server</class>


id: MongoDB\Driver\WriteResult::getUpsertedCount
type: function
doc:
<comment>Description:</comment>
  Возвращает количество документов, вставленных слиянием

<comment>Return:</comment>
  <info>int|null</info>  Возвращает количество документов, вставленных слиянием.

<comment>See Also:</comment>
   * MongoDB\Driver\WriteResult::getUpsertedIds
   * MongoDB\Driver\WriteResult::isAcknowledged


id: MongoDB\Driver\WriteResult::getUpsertedIds
type: function
doc:
<comment>Description:</comment>
  Возвращает массив идентификаторов для объединённых документов

<comment>Return:</comment>
  <info>array</info>  Возвращает массив идентификаторов (т.е. значения полей <return>"_id"</return>) для объединённых документов.
         Ключи массива будут соответствовать индексу операции записи (из <class>MongoDB\Driver\BulkWrite</class>),
         ответственной за слияние.

<comment>See Also:</comment>
   * MongoDB\Driver\WriteResult::getUpsertedCount
   * MongoDB\Driver\WriteResult::isAcknowledged


id: MongoDB\Driver\WriteResult::getWriteConcernError
type: function
doc:
<comment>Description:</comment>
  Возвращает любую ошибку гарантий записи, которая произошла

<comment>Return:</comment>
  <info>MongoDB\Driver\WriteConcernError|null</info>  Возвращает <class>MongoDB\Driver\WriteConcernError</class>, если во время
                                         операции записи произошла ошибка гарантий записи, и <info>null</info> в
                                         противном случае.

<comment>See Also:</comment>
   * <class>MongoDB\Driver\WriteConcern</class>
   * Справка по гарантиям записи


id: MongoDB\Driver\WriteResult::getWriteErrors
type: function
doc:
<comment>Description:</comment>
  Возвращает любые ошибки записи, которые произошли

<comment>Return:</comment>
  <info>array</info>  Возвращает массив объектов <class>MongoDB\Driver\WriteError</class> для любых ошибок записи, обнаруженных
         во время операции записи. Массив будет пустым, если ошибок не произошло.

<comment>See Also:</comment>
   * <class>MongoDB\Driver\WriteError</class>


id: MongoDB\Driver\WriteResult::isAcknowledged
type: function
doc:
<comment>Description:</comment>
  Возвращает, была ли запись подтверждена
  
  Если запись подтверждена, другие поля будут доступны в объекте <class>MongoDB\Driver\WriteResult</class>.

<comment>Return:</comment>
  <info>bool</info>  Возвращает <info>true</info>, если запись была подтверждена, и <info>false</info> в противном случае.

<comment>See Also:</comment>
   * <class>MongoDB\Driver\WriteConcern</class>
   * Справка по гарантиям записи


id: MultipleIterator
type: class
doc:
<comment>Description:</comment>
  Итератор, который последовательно перебирает по всем присоединённым итераторам


id: MultipleIterator::MIT_NEED_ALL
type: constant
doc:
<comment>Description:</comment>
  Требовать, чтобы все подытераторы были действительными в итерации.


id: MultipleIterator::MIT_NEED_ANY
type: constant
doc:
<comment>Description:</comment>
  Не требовать, чтобы все подытераторы были действительными в итерации.


id: MultipleIterator::__construct
type: function
doc:
<comment>Description:</comment>
  Создаёт новый MultipleIterator
  
  Создаёт новый MultipleIterator.

<comment>Param:</comment>
  <info>int</info>  <strong>$flags</strong>  Флаги для установки, согласно Предопределённым константам.
               <info>MultipleIterator::MIT_NEED_ALL</info> или <info>MultipleIterator::MIT_NEED_ANY</info>
               <info>MultipleIterator::MIT_KEYS_NUMERIC</info> или <info>MultipleIterator::MIT_KEYS_ASSOC</info>
               
               По умолчанию <info>MultipleIterator::MIT_NEED_ALL</info>|<info>MultipleIterator::MIT_KEYS_NUMERIC</info>.

<comment>See Also:</comment>
   * Предопределённые константы
   * MultipleIterator::valid


id: MultipleIterator::attachIterator
type: function
doc:
<comment>Description:</comment>
  Присоединяет итератор
  
  Присоединяет итератор.
  
  К настоящему времени эта функция ещё не была документирована; для ознакомления доступен только
  список аргументов.

<comment>Param:</comment>
  <info>Iterator</info>         <strong>$iterator</strong>  Новый итератор для присоединения.
  <info>string|int|null</info>  <strong>$info</strong>      Ассоциативная информация для итератора (Iterator), которая должна быть
                              представлена целым числом (<info>int</info>), строкой (<info>string</info>), или <info>null</info>.

<comment>Return:</comment>
  <info>void</info>  Описание...

<comment>See Also:</comment>
   * MultipleIterator::__construct


id: MultipleIterator::containsIterator
type: function
doc:
<comment>Description:</comment>
  Проверяет, присоединён ли итератор
  
  Проверяет, присоединён итератор, или нет.
  
  К настоящему времени эта функция ещё не была документирована; для ознакомления доступен только
  список аргументов.

<comment>Param:</comment>
  <info>Iterator</info>  <strong>$iterator</strong>  Итератор для проверки.

<comment>Return:</comment>
  <info>bool</info>  Возвращает <info>true</info> в случае успешного выполнения или <info>false</info> в случае возникновения ошибки.

<comment>See Also:</comment>
   * MultipleIterator::valid


id: MultipleIterator::countIterators
type: function
doc:
<comment>Description:</comment>
  Получает число присоединённых итераторов
  
  Получает число присоединённых итераторов.
  
  К настоящему времени эта функция ещё не была документирована; для ознакомления доступен только
  список аргументов.

<comment>Return:</comment>
  <info>int</info>  Число присоединённых итераторов (в виде <info>int</info>).

<comment>See Also:</comment>
   * MultipleIterator::containsIterator


id: MultipleIterator::current
type: function
doc:
<comment>Description:</comment>
  Получает зарегистрированные итераторы
  
  Получает результат выполнения current() зарегистрированных итераторов.
  
  К настоящему времени эта функция ещё не была документирована; для ознакомления доступен только
  список аргументов.

<comment>Return:</comment>
  <info>array</info>  Массив (<info>array</info>) всех текущих значений каждого присоединённого итератора.

<comment>See Also:</comment>
   * MultipleIterator::valid


id: MultipleIterator::detachIterator
type: function
doc:
<comment>Description:</comment>
  Отсоединяет итератор
  
  Отсоединяет итератор.
  
  К настоящему времени эта функция ещё не была документирована; для ознакомления доступен только
  список аргументов.

<comment>Param:</comment>
  <info>Iterator</info>  <strong>$iterator</strong>  Отсоединяемый итератор.

<comment>Return:</comment>
  <info>void</info>  Функция не возвращает значения после выполнения.

<comment>See Also:</comment>
   * MultipleIterator::attachIterator


id: MultipleIterator::getFlags
type: function
doc:
<comment>Description:</comment>
  Получает информацию о флагах
  
  Получает информацию о флагах.
  
  К настоящему времени эта функция ещё не была документирована; для ознакомления доступен только
  список аргументов.

<comment>Return:</comment>
  <info>int</info>  Информация о флагах, в виде <info>int</info>.

<comment>See Also:</comment>
   * Предопределённые константы
   * MultipleIterator::__construct
   * MultipleIterator::setFlags


id: MultipleIterator::key
type: function
doc:
<comment>Description:</comment>
  Получает зарегистрированные итераторы
  
  Получает результат выполнения key() зарегистрированных итераторов.
  
  К настоящему времени эта функция ещё не была документирована; для ознакомления доступен только
  список аргументов.

<comment>Return:</comment>
  <info>array</info>  Массив (<info>array</info>) всех зарегистрированных итераторов.

<comment>See Also:</comment>
   * MultipleIterator::current


id: MultipleIterator::next
type: function
doc:
<comment>Description:</comment>
  Перемещает все присоединённые итераторы к своим следующим элементам
  
  Перемещает все присоединённые итераторы к своим следующим элементам.
  
  К настоящему времени эта функция ещё не была документирована; для ознакомления доступен только
  список аргументов.

<comment>Return:</comment>
  <info>void</info>  Функция не возвращает значения после выполнения.

<comment>See Also:</comment>
   * MultipleIterator::rewind


id: MultipleIterator::rewind
type: function
doc:
<comment>Description:</comment>
  Возвращает в начало все присоединённые итераторы
  
  Возвращает в начало все присоединённые итераторы.
  
  К настоящему времени эта функция ещё не была документирована; для ознакомления доступен только
  список аргументов.

<comment>Return:</comment>
  <info>void</info>  Функция не возвращает значения после выполнения.

<comment>See Also:</comment>
   * MultipleIterator::next


id: MultipleIterator::setFlags
type: function
doc:
<comment>Description:</comment>
  Устанавливает флаги
  
  Устанавливает флаги.
  
  К настоящему времени эта функция ещё не была документирована; для ознакомления доступен только
  список аргументов.

<comment>Param:</comment>
  <info>int</info>  <strong>$flags</strong>  Флаги для установки, согласно Предопределённым константам

<comment>Return:</comment>
  <info>void</info>  Функция не возвращает значения после выполнения.

<comment>See Also:</comment>
   * Предопределённые константы
   * MultipleIterator::__construct
   * MultipleIterator::getFlags


id: MultipleIterator::valid
type: function
doc:
<comment>Description:</comment>
  Проверяет корректность подытераторов
  
  Проверяет корректность подытераторов.
  
  К настоящему времени эта функция ещё не была документирована; для ознакомления доступен только
  список аргументов.

<comment>Return:</comment>
  <info>bool</info>  Возвращает <info>true</info> если один или все (в зависимости от флагов) подытераторы действительны; в
        противном случае -  <info>false</info>

<comment>See Also:</comment>
   * MultipleIterator::__construct


id: NORM_IGNOREKASHIDA
type: constant
doc:
<comment>Description:</comment>
  Игнорировать символы Arabic kashida.
  
  Доступность зависит от используемой библиотеки.


id: NoRewindIterator
type: class
doc:
<comment>Description:</comment>
  Итератор игнорирует операции перемотки. Это позволяет обрабатывать итератор в нескольких частичных
  циклах foreach.


id: NoRewindIterator::__construct
type: function
doc:
<comment>Description:</comment>
  Создаёт новый объект NoRewindIterator
  
  Создаёт новый объект NoRewindIterator.

<comment>Param:</comment>
  <info>Iterator</info>  <strong>$iterator</strong>  Используемый итератор.

<comment>See Also:</comment>
   * NoRewindIterator::valid


id: NoRewindIterator::current
type: function
doc:
<comment>Description:</comment>
  Получает текущее значение
  
  Получает текущее значение.
  
  К настоящему времени эта функция ещё не была документирована; для ознакомления доступен только
  список аргументов.

<comment>Return:</comment>
  <info>mixed</info>  Текущее значение.

<comment>See Also:</comment>
   * NoRewindIterator::key


id: NoRewindIterator::key
type: function
doc:
<comment>Description:</comment>
  Получает текущий ключ
  
  Получает текущий ключ.
  
  К настоящему времени эта функция ещё не была документирована; для ознакомления доступен только
  список аргументов.

<comment>Return:</comment>
  <info>mixed</info>  Текущий ключ.

<comment>See Also:</comment>
   * NoRewindIterator::next


id: NoRewindIterator::next
type: function
doc:
<comment>Description:</comment>
  Перемещает итератор к следующему элементу
  
  Перемещает итератор к следующему элементу.
  
  К настоящему времени эта функция ещё не была документирована; для ознакомления доступен только
  список аргументов.

<comment>Return:</comment>
  <info>void</info>  Функция не возвращает значения после выполнения.

<comment>See Also:</comment>
   * NoRewindIterator::rewind


id: NoRewindIterator::rewind
type: function
doc:
<comment>Description:</comment>
  Предотвращает возврат внутреннего итератора в начало
  
  Предотвращает возврат внутреннего итератора в начало.

<comment>Return:</comment>
  <info>void</info>  Функция не возвращает значения после выполнения.


id: NoRewindIterator::valid
type: function
doc:
<comment>Description:</comment>
  Проверяет итератор
  
  Проверяет, является ли итератор допустимым.
  
  К настоящему времени эта функция ещё не была документирована; для ознакомления доступен только
  список аргументов.

<comment>Return:</comment>
  <info>bool</info>  Возвращает <info>true</info> в случае успешного выполнения или <info>false</info> в случае возникновения ошибки.

<comment>See Also:</comment>
   * NoRewindIterator::getInnerIterator


id: Normalizer
type: class
doc:
<comment>Description:</comment>
  Нормализация - это процесс преобразования символов и их последовательностей в формальное
  представление более низкого уровня. Данный процесс крайне важен при сравнении строк при сортировке
  или при поиске, но также используется при сохранении текста, чтобы быть уверенным в том, что он
  сохранился корректно.
  
  Консорциум Unicode определил несколько форм нормализации, отражающих разные потребности
  приложений: Normalization Form D (NFD) - Каноническое разложение Normalization Form C (NFC) -
  Каноническое разложение с последующей канонической сборкой  Normalization Form KD (NFKD) -
  Совместимое разложение  Normalization Form KC (NFKC) - Совместимое разложение с последующей
  канонической сборкой  Различные формы задаются в требованиях наборов преобразований текста.
  Преобразования вычисляются с алгоритма и набора файлов данных.


id: Normalizer::FORM_C
type: constant
doc:
<comment>Description:</comment>
  Форма нормализации C (NFC) - Каноническое разложение, после которого каноническая сборка


id: Normalizer::FORM_KC
type: constant
doc:
<comment>Description:</comment>
  Форма нормализации KC (NFKC) - Совместимое разложение, после которого каноническая сборка


id: Normalizer::getRawDecomposition
type: function
doc:
<comment>Description:</comment>
  Извлекает свойство Decomposition_Mapping для заданного символа UTF-8
  
  Объектно-ориентированный стиль
  
  Процедурный стиль
  
  Извлекает свойство Decomposition_Mapping, как определено в Unicode Character Database (UCD), для
  заданного символа UTF-8.

<comment>Param:</comment>
  <info>string</info>  <strong>$string</strong>  Строка, которая должна представлять из себя единичный символ в кодировке UTF-8.

<comment>Return:</comment>
  <info>string|null</info>  Возвращает строку (<info>string</info>), содержащую свойство Decomposition_Mapping, если оно
               присутствует в UCD.
               
               Возвращает <info>null</info> если для символа отсутствует свойство Decomposition_Mapping.

<comment>See Also:</comment>
   * Normalizer::normalize
   * Normalizer::isNormalized


id: Normalizer::isNormalized
type: function
doc:
<comment>Description:</comment>
  Проверить, соответствует ли переданная строка заданной форме нормализации
    
  
  Объектно-ориентированный стиль
  
  Процедурный стиль
  
  Проверить, соответствует ли переданная строка заданной форме нормализации.

<comment>Param:</comment>
  <info>string</info>  <strong>$string</strong>  Проверяемая строка
  <info>int</info>     <strong>$form</strong>    Одна из форм нормализации.

<comment>Return:</comment>
  <info>bool</info>  <info>true</info> если нормализована и <info>false</info>, если нет или если произошла ошибка

<comment>See Also:</comment>
   * <strong>normalizer_normalize()</strong>


id: Normalizer::normalize
type: function
doc:
<comment>Description:</comment>
  Нормализация строки
    
  
  Объектно-ориентированный стиль
  
  Процедурный стиль
  
  Нормализует переданную строку

<comment>Param:</comment>
  <info>string</info>  <strong>$string</strong>  Строка для нормализации
  <info>int</info>     <strong>$form</strong>    Одна из форм нормализации

<comment>Return:</comment>
  <info>string|false</info>  Нормализованная строка или <info>false</info> в случае возникновения ошибки.

<comment>See Also:</comment>
   * <strong>normalizer_is_normalized()</strong>


id: NumberFormatter
type: class
doc:
<comment>Description:</comment>
  Программы хранят и оперируют числами используя, не зависящее от локали, бинарное представление.
  Когда же они выводятся на экран или печатаются, они конвертируются в строки в соответствии с
  требованиями локали. К примеру, число 12345.67 выведется как "12,345.67" в локали US, как "12
  345,67" во французской локали и как "12.345,67" в немецкой.
  
  Вызывая методы этого класса, вы можете форматировать числа, денежные единицы и процентные величины
  в представлении нужной локали. Класс NumberFormatter чувствителен к локали, следовательно вам
  необходимо будет создавать новый экземпляр класса для каждой локали. Методы NumberFormatter
  форматируют примитивные типы чисел, такие как "double", и выводят их в специфичном для локали
  представлении.
  
  Для денежных единиц вы можете использовать тип форматирования денежных единиц, который возвращает
  строку с отформатированным числом и символом денежной единицы. Естественно NumberFormatter не
  знает о курсах обмена, так что для всех денежных единиц будет возвращено одно и то же число. К
  примеру, для числа 9988776.65 результат будет такой: 9 988 776,65 € для Франции9.988.776,65 € для
  Германии$9,988,776.65 для США
  
  Для форматирования процентных величин используется свой тип форматирования. При таком
  форматировании число 0.75 будет выведено как 75%.
  
  Для более сложного форматирования, например для разбора числа, используется форматирование
  основанное на наборе правил.


id: NumberFormatter::CURRENCY_ACCOUNTING
type: constant
doc:
<comment>Description:</comment>
  Формат валюты для учёта, например, <return>($3.00)</return> для отрицательной суммы в валюте вместо <return>-$3.00</return>.
  Доступно с PHP 7.4.1 и ICU 53.


id: NumberFormatter::DEFAULT_RULESET
type: constant
doc:
<comment>Description:</comment>
  Набор правил по умолчанию. Доступно только для форматирования на основе правил.


id: NumberFormatter::LENIENT_PARSE
type: constant
doc:
<comment>Description:</comment>
  Режим снисходительны синтаксического анализа для основанных на правилах форматов.


id: NumberFormatter::PADDING_POSITION
type: constant
doc:
<comment>Description:</comment>
  Позиция с которой дополнение будет иметь место. Смотрите описание констант дополнения.


id: NumberFormatter::PUBLIC_RULESETS
type: constant
doc:
<comment>Description:</comment>
  Публичный набор правил. Доступно только для форматирования на основе правил. Этот атрибут доступен
  только на чтение. Публичный набор правил возвращается в виде строки, в которой каждый набор правил
  отделен точкой с запятой (;).


id: NumberFormatter::ROUND_HALFDOWN
type: constant
doc:
<comment>Description:</comment>
  Округление в сторону "ближайшего соседа" кроме случаев, когда они на одинаковом расстоянии. В этом
  случае округление вниз.


id: NumberFormatter::ROUND_HALFEVEN
type: constant
doc:
<comment>Description:</comment>
  Округление в сторону "ближайшего соседа" кроме случаев, когда они на одинаковом расстоянии. В этом
  случае округление к чётному значению.


id: NumberFormatter::ROUND_HALFUP
type: constant
doc:
<comment>Description:</comment>
  Округление в сторону "ближайшего соседа" кроме случаев, когда они на одинаковом расстоянии. В этом
  случае округление вверх.


id: NumberFormatter::TYPE_CURRENCY
type: constant
doc:
<comment>Description:</comment>
  Форматирование/разбор как денежной единицы. Устарело, начиная с PHP 8.3.0


id: NumberFormatter::__construct
type: function
doc:
<comment>Description:</comment>
  Создаёт средство форматирования чисел
  
  Объектно-ориентированный стиль (метод)
  
  Процедурный стиль
  
  Объектно-ориентированный стиль (конструктор):
  
  Создаёт средство форматирования чисел.

<comment>Param:</comment>
  <info>string</info>       <strong>$locale</strong>   Локаль, в которой будет отформатировано число (название локали, например
                         en_CA).
  <info>int</info>          <strong>$style</strong>    Стиль форматирования, одна из констант стиля форматирования. Если передана
                         <info>NumberFormatter::PATTERN_DECIMAL</info> или <info>NumberFormatter::PATTERN_RULEBASED</info>, то
                         формат числа открывается с использованием данного шаблона, который должен
                         соответствовать синтаксису, описанному в документации ICU DecimalFormat или
                         документации ICU RuleBasedNumberFormat, соответственно.
  <info>string|null</info>  <strong>$pattern</strong>  Строка шаблона, если для выбранного стиля требуется шаблон.

<comment>Return:</comment>
  <info>NumberFormatter|null</info>  Возвращает объект <class>NumberFormatter</class> или <info>null</info> в случае возникновения ошибки.

<comment>See Also:</comment>
   * <strong>numfmt_format()</strong>
   * <strong>numfmt_parse()</strong>


id: NumberFormatter::format
type: function
doc:
<comment>Description:</comment>
  Форматирует число
  
  Объектно-ориентированный стиль
  
  Процедурный стиль
  
  Форматирует числовое значение в соответствии с правилами средства форматирования.

<comment>Param:</comment>
  <info>NumberFormatter</info>  <strong>$formatter</strong>  Объект <class>NumberFormatter</class>.
  <info>int|float</info>        <strong>$num</strong>        Значение для форматирования. Может быть целым числом (<info>int</info>) или числом
                               с плавающей точкой (<info>float</info>), другие типы будут преобразованы в
                               числовое значение.
  <info>int</info>              <strong>$type</strong>       Используемый тип форматирования. Обратите внимание, что константа
                               <info>NumberFormatter::TYPE_CURRENCY</info> не поддерживается; используйте вместо
                               неё метод NumberFormatter::formatCurrency.

<comment>Return:</comment>
  <info>string|false</info>  Возвращает строку, содержащую форматированное значение или <info>false</info> в случае
                возникновения ошибки.

<comment>See Also:</comment>
   * <strong>numfmt_get_error_code()</strong>
   * <strong>numfmt_format_currency()</strong>
   * <strong>numfmt_parse()</strong>
   * <strong>msgfmt_format_message()</strong>


id: NumberFormatter::formatCurrency
type: function
doc:
<comment>Description:</comment>
  Форматирует значение валюты
  
  Объектно-ориентированный стиль
  
  Процедурный стиль
  
  Форматирует значение валюты в соответствии с правилами форматирования.

<comment>Param:</comment>
  <info>NumberFormatter</info>  <strong>$formatter</strong>  Объект <class>NumberFormatter</class>.
  <info>float</info>            <strong>$amount</strong>     Числовое значение валюты.
  <info>string</info>           <strong>$currency</strong>   Трёхбуквенный код валюты ISO 4217, обозначающий используемую валюту.

<comment>Return:</comment>
  <info>string|false</info>  Строка, представляющая форматированное значение валюты или <info>false</info> в случае
                возникновения ошибки.

<comment>See Also:</comment>
   * <strong>numfmt_get_error_code()</strong>
   * <strong>numfmt_format()</strong>
   * <strong>numfmt_parse_currency()</strong>
   * <strong>msgfmt_format_message()</strong>


id: NumberFormatter::getAttribute
type: function
doc:
<comment>Description:</comment>
  Получает атрибут
  
  Объектно-ориентированный стиль
  
  Процедурный стиль
  
  Получает числовой атрибут, связанный со средством форматирования. Примером числового атрибута
  является количество целых цифр, которое будет выдавать средство форматирования.

<comment>Param:</comment>
  <info>NumberFormatter</info>  <strong>$formatter</strong>  Объект <class>NumberFormatter</class>.
  <info>int</info>              <strong>$attribute</strong>  Спецификатор атрибута - одна из констант  числового атрибута.

<comment>Return:</comment>
  <info>int|float|false</info>  Возвращает значение атрибута в случае успешного выполнения или <info>false</info> в случае
                   возникновения ошибки.

<comment>See Also:</comment>
   * <strong>numfmt_get_error_code()</strong>
   * <strong>numfmt_get_text_attribute()</strong>
   * <strong>numfmt_set_attribute()</strong>


id: NumberFormatter::getErrorCode
type: function
doc:
<comment>Description:</comment>
  Получает последний код ошибки средства форматирования
  
  Объектно-ориентированный стиль
  
  Процедурный стиль
  
  Получает код ошибки из последней функции, выполненной средством форматирования.

<comment>Param:</comment>
  <info>NumberFormatter</info>  <strong>$formatter</strong>  Объект <class>NumberFormatter</class>.

<comment>Return:</comment>
  <info>int</info>  Возвращает код ошибки из последнего вызова средства форматирования.

<comment>See Also:</comment>
   * <strong>numfmt_get_error_message()</strong>
   * <strong>intl_get_error_code()</strong>
   * <strong>intl_is_failure()</strong>


id: NumberFormatter::getErrorMessage
type: function
doc:
<comment>Description:</comment>
  Получает последнее сообщение об ошибке средства форматирования
  
  Объектно-ориентированный стиль
  
  Процедурный стиль
  
  Получает сообщение об ошибке от последней функции, выполненной средством форматирования.

<comment>Param:</comment>
  <info>NumberFormatter</info>  <strong>$formatter</strong>  Объект <class>NumberFormatter</class>.

<comment>Return:</comment>
  <info>string</info>  Возвращает сообщение об ошибке из последнего вызова средства форматирования.

<comment>See Also:</comment>
   * <strong>numfmt_get_error_code()</strong>
   * <strong>intl_get_error_code()</strong>
   * <strong>intl_is_failure()</strong>


id: NumberFormatter::getLocale
type: function
doc:
<comment>Description:</comment>
  Получает локаль средства форматирования
  
  Объектно-ориентированный стиль
  
  Процедурный стиль
  
  Получает название локали средства форматирования.

<comment>Param:</comment>
  <info>NumberFormatter</info>  <strong>$formatter</strong>  Объект <class>NumberFormatter</class>.
  <info>int</info>              <strong>$type</strong>       Вы можете выбрать действительную или фактическую локаль (
                               <info>Locale::VALID_LOCALE</info>, <info>Locale::ACTUAL_LOCALE</info>, соответственно). По
                               умолчанию используется фактическая локаль.

<comment>Return:</comment>
  <info>string|false</info>  Имя локали, используемое для создания средства форматирования или <info>false</info> в случае
                возникновения ошибки.

<comment>See Also:</comment>
   * <strong>numfmt_create()</strong>
   * <strong>numfmt_get_error_code()</strong>


id: NumberFormatter::getPattern
type: function
doc:
<comment>Description:</comment>
  Получает шаблон средства форматирования
  
  Объектно-ориентированный стиль
  
  Процедурный стиль
  
  Извлекает шаблон, используемый средством форматирования.

<comment>Param:</comment>
  <info>NumberFormatter</info>  <strong>$formatter</strong>  Объект <class>NumberFormatter</class>.

<comment>Return:</comment>
  <info>string|false</info>  Строка (<info>string</info>) шаблона, используемого средством форматирования или <info>false</info> в случае
                возникновения ошибки.

<comment>See Also:</comment>
   * <strong>numfmt_get_error_code()</strong>
   * <strong>numfmt_set_pattern()</strong>
   * <strong>numfmt_create()</strong>


id: NumberFormatter::getSymbol
type: function
doc:
<comment>Description:</comment>
  Получает значение символа
  
  Объектно-ориентированный стиль
  
  Процедурный стиль
  
  Получает символ, связанный со средством форматирования. Средство форматирования использует символы
  для представления специальных символов, зависящих от языка, в числах, например, знак процента.
  Этот API не поддерживается для средств форматирования на основе правил.

<comment>Param:</comment>
  <info>NumberFormatter</info>  <strong>$formatter</strong>  Объект <class>NumberFormatter</class>.
  <info>int</info>              <strong>$symbol</strong>     Спецификатор символа, одна из констант  символов форматирования.

<comment>Return:</comment>
  <info>string|false</info>  Строка символа или <info>false</info> в случае возникновения ошибки.

<comment>See Also:</comment>
   * <strong>numfmt_get_error_code()</strong>
   * <strong>numfmt_set_symbol()</strong>


id: NumberFormatter::getTextAttribute
type: function
doc:
<comment>Description:</comment>
  Получает текстовый атрибут
  
  Объектно-ориентированный стиль
  
  Процедурный стиль
  
  Получает текстовый атрибут, связанный со средством форматирования. Примером текстового атрибута
  является суффикс для положительных чисел. Если средство форматирования не понимает атрибут,
  выдаётся ошибка <info>U_UNSUPPORTED_ERROR</info>. Средства форматирования на основе правил понимают только
  <info>NumberFormatter::DEFAULT_RULESET</info> и <info>NumberFormatter::PUBLIC_RULESETS</info>.

<comment>Param:</comment>
  <info>NumberFormatter</info>  <strong>$formatter</strong>  Объект <class>NumberFormatter</class>.
  <info>int</info>              <strong>$attribute</strong>  Спецификатор атрибута - одна из констант  текстового атрибута.

<comment>Return:</comment>
  <info>string|false</info>  Возвращает значение атрибута в случае успешного выполнения или <info>false</info> в случае
                возникновения ошибки.

<comment>See Also:</comment>
   * <strong>numfmt_get_error_code()</strong>
   * <strong>numfmt_get_attribute()</strong>
   * <strong>numfmt_set_text_attribute()</strong>


id: NumberFormatter::parse
type: function
doc:
<comment>Description:</comment>
  Разбирает число
  
  Объектно-ориентированный стиль
  
  Процедурный стиль
  
  Преобразует строку в число, используя правила средства форматирования.

<comment>Param:</comment>
  <info>NumberFormatter</info>  <strong>$formatter</strong>  Объект <class>NumberFormatter</class>.
  <info>string</info>           <strong>$string</strong>     Строка для разбора числа.
  <info>int</info>              <strong>$type</strong>       Используемый тип форматирования. По умолчанию используется
                               <info>NumberFormatter::TYPE_DOUBLE</info>. Обратите внимание, что константа
                               <info>NumberFormatter::TYPE_CURRENCY</info> не поддерживается; воспользуйтесь
                               вместо неё методом NumberFormatter::parseCurrency.
  <info>int</info>              <strong>$offset</strong>     Смещение в строке, с которой начинается синтаксический анализ. При
                               возврате это значение будет содержать смещение, на котором закончился
                               синтаксический анализ.

<comment>Return:</comment>
  <info>int|float|false</info>  Значение анализируемого числа или <info>false</info> в случае возникновения ошибки.

<comment>See Also:</comment>
   * <strong>numfmt_get_error_code()</strong>
   * <strong>numfmt_format()</strong>
   * <strong>numfmt_parse_currency()</strong>


id: NumberFormatter::parseCurrency
type: function
doc:
<comment>Description:</comment>
  Разбирает номер валюты
  
  Объектно-ориентированный стиль
  
  Процедурный стиль
  
  Разбирает строку на число с плавающей точкой и валюту с помощью средства форматирования.

<comment>Param:</comment>
  <info>NumberFormatter</info>  <strong>$formatter</strong>  Объект <class>NumberFormatter</class>.
  <info>string</info>           <strong>$currency</strong>   Параметр для получения названия валюты (трёхбуквенный код валюты ISO
                               4217).
  <info>int</info>              <strong>$offset</strong>     Смещение в строке, с которой начинается синтаксический анализ. При
                               возврате это значение будет содержать смещение, на котором закончился
                               синтаксический анализ.

<comment>Return:</comment>
  <info>float|false</info>  Разобранное числовое значение или <info>false</info> в случае возникновения ошибки.

<comment>See Also:</comment>
   * <strong>numfmt_get_error_code()</strong>
   * <strong>numfmt_parse()</strong>
   * <strong>numfmt_format_currency()</strong>


id: NumberFormatter::setAttribute
type: function
doc:
<comment>Description:</comment>
  Устанавливает атрибут
  
  Объектно-ориентированный стиль
  
  Процедурный стиль
  
  Устанавливает числовой атрибут, связанный со средством форматирования. Примером числового атрибута
  является количество целых цифр, которое будет выдавать средство форматирования.

<comment>Param:</comment>
  <info>NumberFormatter</info>  <strong>$formatter</strong>  Объект <class>NumberFormatter</class>.
  <info>int</info>              <strong>$attribute</strong>  Спецификатор атрибута - одна из констант  числового атрибута.
  <info>int|float</info>        <strong>$value</strong>      Значение атрибута.

<comment>Return:</comment>
  <info>bool</info>  Возвращает <info>true</info> в случае успешного выполнения или <info>false</info> в случае возникновения ошибки.

<comment>See Also:</comment>
   * <strong>numfmt_get_error_code()</strong>
   * <strong>numfmt_get_attribute()</strong>
   * <strong>numfmt_set_text_attribute()</strong>


id: NumberFormatter::setPattern
type: function
doc:
<comment>Description:</comment>
  Устанавливает шаблон средства форматирования
  
  Объектно-ориентированный стиль
  
  Процедурный стиль
  
  Устанавливает шаблон, используемый средством форматирования. Не может использоваться в средстве
  форматирования на основе правил.

<comment>Param:</comment>
  <info>NumberFormatter</info>  <strong>$formatter</strong>  Объект <class>NumberFormatter</class>.
  <info>string</info>           <strong>$pattern</strong>    Шаблон в синтаксисе, описанном в документации ICU DecimalFormat.

<comment>Return:</comment>
  <info>bool</info>  Возвращает <info>true</info> в случае успешного выполнения или <info>false</info> в случае возникновения ошибки.

<comment>See Also:</comment>
   * <strong>numfmt_get_error_code()</strong>
   * <strong>numfmt_create()</strong>
   * <strong>numfmt_get_pattern()</strong>


id: NumberFormatter::setSymbol
type: function
doc:
<comment>Description:</comment>
  Устанавливает значение символа
  
  Объектно-ориентированный стиль
  
  Процедурный стиль
  
  Устанавливает символ, связанный со средством форматирования. Средство форматирования использует
  символы для представления специальных символов, зависящих от языка, в числах, например, знак
  процента. Этот API не поддерживается для средств форматирования на основе правил.

<comment>Param:</comment>
  <info>NumberFormatter</info>  <strong>$formatter</strong>  Объект <class>NumberFormatter</class>.
  <info>int</info>              <strong>$symbol</strong>     Спецификатор символа, одна из констант  символа форматирования.
  <info>string</info>           <strong>$value</strong>      Текст для символа.

<comment>Return:</comment>
  <info>bool</info>  Возвращает <info>true</info> в случае успешного выполнения или <info>false</info> в случае возникновения ошибки.

<comment>See Also:</comment>
   * <strong>numfmt_get_error_code()</strong>
   * <strong>numfmt_get_symbol()</strong>


id: NumberFormatter::setTextAttribute
type: function
doc:
<comment>Description:</comment>
  Устанавливает текстовый атрибут
  
  Объектно-ориентированный стиль
  
  Процедурный стиль
  
  Устанавливает текстовый атрибут, связанный со средством форматирования. Примером текстового
  атрибута является суффикс для положительных чисел. Если средство форматирования не понимает
  атрибут, выдаётся ошибка <info>U_UNSUPPORTED_ERROR</info>. Средства форматирования на основе правил понимают
  только <info>NumberFormatter::DEFAULT_RULESET</info> и <info>NumberFormatter::PUBLIC_RULESETS</info>.

<comment>Param:</comment>
  <info>NumberFormatter</info>  <strong>$formatter</strong>  Объект <class>NumberFormatter</class>.
  <info>int</info>              <strong>$attribute</strong>  Спецификатор атрибута - одна из констант текстового атрибута.
  <info>string</info>           <strong>$value</strong>      Текст для значения атрибута.

<comment>Return:</comment>
  <info>bool</info>  Возвращает <info>true</info> в случае успешного выполнения или <info>false</info> в случае возникновения ошибки.

<comment>See Also:</comment>
   * <strong>numfmt_get_error_code()</strong>
   * <strong>numfmt_get_text_attribute()</strong>
   * <strong>numfmt_set_attribute()</strong>


id: OAUTH_AUTH_TYPE_AUTHORIZATION
type: constant
doc:
<comment>Description:</comment>
  Эта константа указывает, что OAuth параметры будут помещены в заголовок <return>Authorization</return>.


id: OAUTH_AUTH_TYPE_FORM
type: constant
doc:
<comment>Description:</comment>
  Эта константа указывает, что OAuth параметры будут помещены в тело HTTP POST запроса.


id: OAUTH_AUTH_TYPE_URI
type: constant
doc:
<comment>Description:</comment>
  Эта константа указывает, что OAuth параметры будут помещены в URI запроса. URI.


id: OAUTH_BAD_NONCE
type: constant
doc:
<comment>Description:</comment>
  Значение oauth_nonce использовалось в предыдущем запросе, следовательно, не может быть
  использовано сейчас.


id: OAUTH_BAD_TIMESTAMP
type: constant
doc:
<comment>Description:</comment>
  Значение oauth_timestamp не было принято провайдером. В этом случае, ответ должен также содержать
  параметр oauth_acceptable_timestamps.


id: OAUTH_CONSUMER_KEY_UNKNOWN
type: constant
doc:
<comment>Description:</comment>
  oauth_consumer_key временно недоступен провайдеру. Например, если провайдер заблокировал
  потребителя.


id: OAUTH_HTTP_METHOD_DELETE
type: constant
doc:
<comment>Description:</comment>
  Константа указывает на использование DELETE метода для OAuth запроса.


id: OAUTH_HTTP_METHOD_GET
type: constant
doc:
<comment>Description:</comment>
  Константа указывает на использование GET метода для OAuth запроса.


id: OAUTH_HTTP_METHOD_HEAD
type: constant
doc:
<comment>Description:</comment>
  Константа указывает на использование HEAD метода для OAuth запроса.


id: OAUTH_HTTP_METHOD_POST
type: constant
doc:
<comment>Description:</comment>
  Константа указывает на использование POST метода для OAuth запроса.


id: OAUTH_HTTP_METHOD_PUT
type: constant
doc:
<comment>Description:</comment>
  Константа указывает на использование PUT метода для OAuth запроса.


id: OAUTH_INVALID_SIGNATURE
type: constant
doc:
<comment>Description:</comment>
  Значение oauth_signature недействительно, так как не совпадает с подписью, вычисленной
  провайдером.


id: OAUTH_PARAMETER_ABSENT
type: constant
doc:
<comment>Description:</comment>
  Требуемый параметр не был получен. В этом случае, ответ должен также содержать параметр
  oauth_parameters_absent.


id: OAUTH_REQENGINE_CURL
type: constant
doc:
<comment>Description:</comment>
  Используется методом OAuth::setRequestEngine для выбора Curl в качестве движка, в
  противоположность константе <info>OAUTH_REQENGINE_STREAMS</info>, использующейся для выбора потоков PHP.


id: OAUTH_REQENGINE_STREAMS
type: constant
doc:
<comment>Description:</comment>
  Используется методом OAuth::setRequestEngine для выбора потоков PHP в качестве движка, в
  противоположность константе <info>OAUTH_REQENGINE_CURL</info>, использующейся для выбора Curl.


id: OAUTH_TOKEN_REJECTED
type: constant
doc:
<comment>Description:</comment>
  Провайдер не принял oauth_token. Причина неизвестна, но возможно заключается в том, что токен
  никогда не был выдан, или уже был использован, или устарел, или был забыт провайдером.


id: OAUTH_TOKEN_USED
type: constant
doc:
<comment>Description:</comment>
  oauth_token был употреблён. Он уже использовался в предыдущем запросе/запросах и более не может
  быть использован.


id: OAuth
type: class
doc:
<comment>Description:</comment>
  Модуль OAuth предоставляет простой интерфейс для взаимодействия с провайдерами данных,
  использующих спецификацию OAuth HTTP для защиты приватных ресурсов.


id: OAuth::__construct
type: function
doc:
<comment>Description:</comment>
  Создаёт новый объект OAuth
  
  Создаёт новый объект OAuth

<comment>Param:</comment>
  <info>string</info>  <strong>$consumer_key</strong>      Ключ потребителя, предоставленный сервис провайдером.
  <info>string</info>  <strong>$consumer_secret</strong>   Секрет потребителя, предоставленный сервис провайдером.
  <info>string</info>  <strong>$signature_method</strong>  Этот необязательный параметр определяет, какой метод подписи будет
                             использован. По умолчанию используется <info>OAUTH_SIG_METHOD_HMACSHA1</info>
                             (HMAC-SHA1).
  <info>int</info>     <strong>$auth_type</strong>         Этот необязательный параметр определяет, как передавать OAuth параметры
                             потребителю. По умолчанию используется <info>OAUTH_AUTH_TYPE_AUTHORIZATION</info> (в
                             заголовке <return>Authorization</return>).


id: OAuth::__destruct
type: function
doc:
<comment>Description:</comment>
  Деструктор
  
  Деструктор.
  
  К настоящему времени эта функция ещё не была документирована; для ознакомления доступен только
  список аргументов.

<comment>Return:</comment>
  <info>void</info>  Функция не возвращает значения после выполнения.

<comment>See Also:</comment>
   * OAuth::__construct


id: OAuth::disableDebug
type: function
doc:
<comment>Description:</comment>
  Выключить подробную отладочную информацию
  
  Выключает подробную информацию о запросе (по умолчанию выключено). Альтернативно можно установить
  свойству debug значение <info>false</info>, чтобы выключить режим отладки.

<comment>Return:</comment>
  <info>bool</info>  <info>true</info>

<comment>See Also:</comment>
   * OAuth::enableDebug


id: OAuth::disableRedirects
type: function
doc:
<comment>Description:</comment>
  Выключить переадресацию
  
  Запретить автоматическую переадресацию, тем самым разрешая запросу быть переадресованным вручную.
  
  К настоящему времени эта функция ещё не была документирована; для ознакомления доступен только
  список аргументов.

<comment>Return:</comment>
  <info>bool</info>  <info>true</info>

<comment>See Also:</comment>
   * OAuth::enableRedirects


id: OAuth::disableSSLChecks
type: function
doc:
<comment>Description:</comment>
  Выключить SSL проверки
  
  Выключает обычные проверки клиентских и хост сертификатов. Не предназначено для продуктивной
  среды. Альтернативно можно установить полю <strong>$sslChecks</strong> значение <info>false</info>, чтобы выключить SSL
  проверки.

<comment>Return:</comment>
  <info>bool</info>  <info>true</info>

<comment>See Also:</comment>
   * OAuth::enableSSLChecks


id: OAuth::enableDebug
type: function
doc:
<comment>Description:</comment>
  Включить подробную отладочную информацию
  
  Включает подробную информацию о запросе, полезную для отладки. Отладочная информация хранится в
  поле <strong>$debugInfo</strong>. Альтернативно можно установить полю <strong>$debug</strong> значение non-<info>false</info>, чтобы включить
  режим отладки.

<comment>Return:</comment>
  <info>bool</info>  <info>true</info>

<comment>See Also:</comment>
   * OAuth::disableDebug


id: OAuth::enableRedirects
type: function
doc:
<comment>Description:</comment>
  Включить переадресацию
  
  Автоматически переходить и подписывать при разрешённой по умолчанию переадресации.
  
  К настоящему времени эта функция ещё не была документирована; для ознакомления доступен только
  список аргументов.

<comment>Return:</comment>
  <info>bool</info>  <info>true</info>

<comment>See Also:</comment>
   * OAuth::disableRedirects


id: OAuth::enableSSLChecks
type: function
doc:
<comment>Description:</comment>
  Включить проверки SSL
  
  Включить обычные проверки сертификата SSL конечной точки и хоста (включено по умолчанию). Также
  можно установить <strong>$sslChecks</strong> в значение не-<info>false</info>, чтобы отключить проверки SSL.

<comment>Return:</comment>
  <info>bool</info>  <info>true</info>

<comment>See Also:</comment>
   * OAuth::disableSSLChecks


id: OAuth::fetch
type: function
doc:
<comment>Description:</comment>
  Извлечь защищённый ресурс OAuth
  
  Извлечь ресурс.

<comment>Param:</comment>
  <info>string</info>  <strong>$protected_resource_url</strong>  URL защищённого ресурса OAuth.
  <info>array</info>   <strong>$extra_parameters</strong>        Дополнительные параметры запроса ресурса.
  <info>string</info>  <strong>$http_method</strong>             Один из методов <info>OAUTH_HTTP_METHOD_*</info>. Смотрите константы OAUTH,
                                   которые включают GET, POST, PUT, HEAD и DELETE.
                                   
                                   HEAD (<info>OAUTH_HTTP_METHOD_HEAD</info>) может быть полезен для изучения
                                   информации перед произведением запроса (если учётные данные OAuth
                                   в заголовке <return>Authorization</return>).
  <info>array</info>   <strong>$http_headers</strong>            Клиентские заголовки HTTP (такие как User-Agent, Accept и т.д.)

<comment>Return:</comment>
  <info>mixed</info>  Возвращает <info>true</info> в случае успешного выполнения или <info>false</info> в случае возникновения ошибки.

<comment>See Also:</comment>
   * OAuth::getLastResponse
   * OAuth::getLastResponseInfo
   * OAuth::setToken


id: OAuth::generateSignature
type: function
doc:
<comment>Description:</comment>
  Сгенерировать подпись
  
  Генерирует подпись на основе метода HTTP, URL и дополнительных параметров.

<comment>Param:</comment>
  <info>string</info>  <strong>$http_method</strong>       HTTP-метод для запроса
  <info>string</info>  <strong>$url</strong>               URL запроса
  <info>mixed</info>   <strong>$extra_parameters</strong>  Строка или массив дополнительных параметров.

<comment>Return:</comment>
  <info>string|false</info>  Строка с подписью или <info>false</info> в случае возникновения ошибки


id: OAuth::getAccessToken
type: function
doc:
<comment>Description:</comment>
  Получить токен доступа
  
  Получает токен доступа, его пароль и все дополнительные параметры ответа от провайдера сервиса.

<comment>Param:</comment>
  <info>string</info>  <strong>$access_token_url</strong>     URL до API выдачи токена доступа.
  <info>string</info>  <strong>$auth_session_handle</strong>  Обработчик сессии авторизации. Этот параметр никак не описывается в
                                спецификации OAuth 1.0, но множеством провайдеров реализуется. Более
                                подробно читайте по ссылке ScalableOAuth.
  <info>string</info>  <strong>$verifier_token</strong>       Для провайдеров с поддержкой 1.0a, параметр <strong>$verifier_token</strong> должен
                                быть задан при обмене токена запроса на токен доступа. Если
                                <strong>$verifier_token</strong> присутствует в <strong>$_GET</strong> или <strong>$_POST</strong>, то он будет задан
                                автоматически и вызывающей стороне не нужно явно его задавать в
                                параметре <strong>$verifier_token</strong> (обычно если токен доступа обменивается с
                                помощью oauth_callback URL). Более подробно читайте по ссылке
                                ScalableOAuth.
  <info>string</info>  <strong>$http_method</strong>          Метод HTTP. Например <return>GET</return> или <return>POST</return>.

<comment>Return:</comment>
  <info>array</info>  Возвращает массив с разобранным ответом OAuth, либо <info>false</info>.

<comment>See Also:</comment>
   * OAuth::getLastResponse
   * OAuth::getLastResponseInfo
   * OAuth::setToken


id: OAuth::getCAPath
type: function
doc:
<comment>Description:</comment>
  Получить информацию CA
  
  Возвращает информацию о центре сертификации, включающую ca_path и ca_info, установленные
  OAuth::setCaPath.
  
  К настоящему времени эта функция ещё не была документирована; для ознакомления доступен только
  список аргументов.

<comment>Return:</comment>
  <info>array</info>  Ассоциативный массив с информацией о центре сертификации с ключами <return>ca_path</return> и <return>ca_info</return>.

<comment>See Also:</comment>
   * OAuth::setCAPath
   * OAuth::getLastResponseInfo


id: OAuth::getLastResponse
type: function
doc:
<comment>Description:</comment>
  Получить последний ответ
  
  Возвращает сырое представление последнего полученного ответа.

<comment>Return:</comment>
  <info>string</info>  Возвращает строку с последним ответом.

<comment>See Also:</comment>
   * OAuth::getLastResponseInfo
   * OAuth::fetch


id: OAuth::getLastResponseHeaders
type: function
doc:
<comment>Description:</comment>
  Получить заголовки последнего ответа
  
  Возвращает заголовки последнего ответа.

<comment>Return:</comment>
  <info>string|false</info>  Строка с заголовками последнего ответа или <info>false</info> в случае возникновения ошибки


id: OAuth::getLastResponseInfo
type: function
doc:
<comment>Description:</comment>
  Получить HTTP-информацию о последнем ответе
  
  Возвращает HTTP-информацию о последнем ответе.

<comment>Return:</comment>
  <info>array</info>  Возвращает массив с информацией по последнему запросу. Можно использовать константы
         <strong>curl_getinfo()</strong>.

<comment>See Also:</comment>
   * OAuth::fetch
   * OAuth::getLastResponse


id: OAuth::getRequestHeader
type: function
doc:
<comment>Description:</comment>
  Сгенерировать подпись заголовка OAuth
  
  Генерирует подпись заголовка OAuth на основе финального метода HTTP, URL и дополнительных
  параметров.

<comment>Param:</comment>
  <info>string</info>  <strong>$http_method</strong>       HTTP-метод.
  <info>string</info>  <strong>$url</strong>               URL запроса.
  <info>mixed</info>   <strong>$extra_parameters</strong>  Строка или массив с дополнительными параметрами.

<comment>Return:</comment>
  <info>string|false</info>  Строка с заголовком запроса или <info>false</info> в случае возникновения ошибки


id: OAuth::getRequestToken
type: function
doc:
<comment>Description:</comment>
  Извлечь токен запроса
  
  Получить токен запроса, его пароль и дополнительные параметры ответа от провайдера сервиса.

<comment>Param:</comment>
  <info>string</info>  <strong>$request_token_url</strong>  URL к API токена запроса.
  <info>string</info>  <strong>$callback_url</strong>       URL callback-функции OAuth. Если <strong>$callback_url</strong> задан пустым значением,
                              то он установится как "oob" решения OAuth 2009.1.
  <info>string</info>  <strong>$http_method</strong>        HTTP-метод, например <return>GET</return> или <return>POST</return>.

<comment>Return:</comment>
  <info>array</info>  Возвращает массив обработанного запроса OAuth или <info>false</info>.

<comment>See Also:</comment>
   * OAuth::getLastResponse
   * OAuth::getLastResponseInfo


id: OAuth::setAuthType
type: function
doc:
<comment>Description:</comment>
  Установить тип авторизации
  
  Устанавливает, каким образом должны передаваться параметры OAuth.

<comment>Param:</comment>
  <info>int</info>  <strong>$auth_type</strong>  <strong>$auth_type</strong> может быть задан одним из следующих флагов (в порядке убывания
                   предпочтения согласно разделу 5.2 OAuth 1.0): <info>OAUTH_AUTH_TYPE_AUTHORIZATION</info>
                   Передавать параметры OAuth HTTP-заголовке <return>Authorization</return>. <info>OAUTH_AUTH_TYPE_FORM</info>
                   Добавить параметры OAuth в тело запроса HTTP POST. <info>OAUTH_AUTH_TYPE_URI</info> Добавить
                   параметры OAuth в URI запроса. <info>OAUTH_AUTH_TYPE_NONE</info> Не передавать.
                   
                   Передавать параметры OAuth HTTP-заголовке <return>Authorization</return>.
                   
                   Добавить параметры OAuth в тело запроса HTTP POST.
                   
                   Добавить параметры OAuth в URI запроса.
                   
                   Не передавать.

<comment>Return:</comment>
  <info>bool</info>  Возвращает <info>true</info> или <info>false</info> (например, если параметр <strong>$auth_type</strong> задан некорректно.)


id: OAuth::setCAPath
type: function
doc:
<comment>Description:</comment>
  Установить CA для пути и информации
  
  Установить центр сертификации (CA) для пути и информации.
  
  К настоящему времени эта функция ещё не была документирована; для ознакомления доступен только
  список аргументов.

<comment>Param:</comment>
  <info>string</info>  <strong>$ca_path</strong>  CA пути.
  <info>string</info>  <strong>$ca_info</strong>  CA информации.

<comment>Return:</comment>
  <info>mixed</info>  Возвращает <info>true</info> или <info>false</info>, если любой из параметров <strong>$ca_path</strong> или <strong>$ca_info</strong> задан
         некорректно.

<comment>See Also:</comment>
   * OAuth::getCaPath


id: OAuth::setNonce
type: function
doc:
<comment>Description:</comment>
  Установить nonce для последующих запросов
  
  Устанавливает nonce для последующих запросов.

<comment>Param:</comment>
  <info>string</info>  <strong>$nonce</strong>  Значение oauth_nonce.

<comment>Return:</comment>
  <info>mixed</info>  Возвращает <info>true</info> в случае успешного выполнения, или <info>false</info>, если параметр <strong>$nonce</strong> задан
         некорректно.

<comment>See Also:</comment>
   * OAuth::setToken
   * OAuth::setAuthType
   * OAuth::setVersion


id: OAuth::setRSACertificate
type: function
doc:
<comment>Description:</comment>
  Установить сертификат RSA
  
  Устанавливает сертификат RSA.
  
  К настоящему времени эта функция ещё не была документирована; для ознакомления доступен только
  список аргументов.

<comment>Param:</comment>
  <info>string</info>  <strong>$cert</strong>  Сертификат RSA.

<comment>Return:</comment>
  <info>mixed</info>  Возвращает <info>true</info> или <info>false</info> (например, если задан некорректный сертификат RSA)

<comment>See Also:</comment>
   * OAuth::setCaPath


id: OAuth::setRequestEngine
type: function
doc:
<comment>Description:</comment>
  Используется для setRequestEngine
  
  Устанавливает Request Engine (механизм запросов), который будет отсылать HTTP-запросы.
  
  К настоящему времени эта функция ещё не была документирована; для ознакомления доступен только
  список аргументов.

<comment>Param:</comment>
  <info>int</info>  <strong>$reqengine</strong>  Выбранный механизм запросов. Задайте <info>OAUTH_REQENGINE_STREAMS</info>, если хотите
                   использовать потоки PHP, или <info>OAUTH_REQENGINE_CURL</info> для использования Curl.

<comment>Return:</comment>
  <info>void</info>  Функция не возвращает значения после выполнения.

<comment>See Also:</comment>
   * Curl
   * потоки PHP
   * <class>OAuthException</class>


id: OAuth::setSSLChecks
type: function
doc:
<comment>Description:</comment>
  Производить определённые проверки SSL для запроса
  
  Производить определённые проверки SSL для запроса.
  
  К настоящему времени эта функция ещё не была документирована; для ознакомления доступен только
  список аргументов.

<comment>Param:</comment>
  <info>int</info>  <strong>$sslcheck</strong>  

<comment>Return:</comment>
  <info>bool</info>  Возвращает <info>true</info> в случае успешного выполнения или <info>false</info> в случае возникновения ошибки.


id: OAuth::setTimestamp
type: function
doc:
<comment>Description:</comment>
  Установить метку времени
  
  Установить метку времени OAuth для последующих запросов.
  
  К настоящему времени эта функция ещё не была документирована; для ознакомления доступен только
  список аргументов.

<comment>Param:</comment>
  <info>string</info>  <strong>$timestamp</strong>  Метка времени.

<comment>Return:</comment>
  <info>mixed</info>  Возвращает <info>true</info> или <info>false</info>, если параметр <strong>$timestamp</strong> задан некорректно.

<comment>See Also:</comment>
   * OAuth::setNonce


id: OAuth::setToken
type: function
doc:
<comment>Description:</comment>
  Задать токен и его пароль
  
  Устанавливает токен и его пароль для последующих запросов.

<comment>Param:</comment>
  <info>string</info>  <strong>$token</strong>         Токен OAuth.
  <info>string</info>  <strong>$token_secret</strong>  Пароль токена OAuth.

<comment>Return:</comment>
  <info>bool</info>  <info>true</info>


id: OAuth::setVersion
type: function
doc:
<comment>Description:</comment>
  Установить версию OAuth
  
  Установить версию OAuth для последующих запросов

<comment>Param:</comment>
  <info>string</info>  <strong>$version</strong>  Версия OAuth, по умолчанию "1.0"

<comment>Return:</comment>
  <info>bool</info>  Возвращает <info>true</info> в случае успешного выполнения или <info>false</info> в случае возникновения ошибки.


id: OAuthException
type: class
doc:
<comment>Description:</comment>
  Это исключение выбрасывается в случае возникновения ошибок при использовании модуля OAuth и
  содержит полезную отладочную информацию.


id: OAuthProvider
type: class
doc:
<comment>Description:</comment>
  Класс управления провайдером OAuth.
  
  Также смотрите подробное описание на внешнем ресурсе Написание сервиса провайдера OAuth, в котором
  описывается практический подход предоставления такого сервиса. Также посмотрите примеры провайдера
  OAuth в исходных кодах модуля OAuth.


id: OAuthProvider::__construct
type: function
doc:
<comment>Description:</comment>
  Конструктор класса OAuthProvider
  
  Создаёт объект класса <class>OAuthProvider</class>.
  
  К настоящему времени эта функция ещё не была документирована; для ознакомления доступен только
  список аргументов.

<comment>Param:</comment>
  <info>array</info>  <strong>$params_array</strong>  Установка этих необязательных параметров ограничена CLI SAPI.

<comment>Return:</comment>
  <info>unknown</info>  Объект класса <class>OAuthProvider</class>.

<comment>See Also:</comment>
   * OAuthProvider::setParam


id: OAuthProvider::addRequiredParameter
type: function
doc:
<comment>Description:</comment>
  Добавить необходимые параметры
  
  Добавляет необходимые параметры провайдера oauth.
  
  К настоящему времени эта функция ещё не была документирована; для ознакомления доступен только
  список аргументов.

<comment>Param:</comment>
  <info>string</info>  <strong>$req_params</strong>  Параметры.

<comment>Return:</comment>
  <info>bool</info>  Возвращает <info>true</info> в случае успешного выполнения или <info>false</info> в случае возникновения ошибки.

<comment>See Also:</comment>
   * OAuthProvider::removeRequiredParameter


id: OAuthProvider::callTimestampNonceHandler
type: function
doc:
<comment>Description:</comment>
  Вызвать callback-функцию timestampNonceHandler
  
  Вызвать зарегистрированную callback-функцию обработчика метки времени, которая была задана с
  помощью OAuthProvider::timestampNonceHandler.
  
  К настоящему времени эта функция ещё не была документирована; для ознакомления доступен только
  список аргументов.

<comment>Return:</comment>
  <info>void</info>  Функция не возвращает значения после выполнения.

<comment>See Also:</comment>
   * OAuthProvider::timestampNonceHandler


id: OAuthProvider::callconsumerHandler
type: function
doc:
<comment>Description:</comment>
  Вызвать callback-функцию consumerNonceHandler
  
  Вызвать зарегистрированную callback-функцию, которая была задана с помощью
  OAuthProvider::consumerHandler.
  
  К настоящему времени эта функция ещё не была документирована; для ознакомления доступен только
  список аргументов.

<comment>Return:</comment>
  <info>void</info>  Функция не возвращает значения после выполнения.

<comment>See Also:</comment>
   * OAuthProvider::consumerHandler


id: OAuthProvider::calltokenHandler
type: function
doc:
<comment>Description:</comment>
  Вызвать callback-функцию tokenNonceHandler
  
  Вызвать зарегистрированную callback-функцию обработчика токена, которая была задана с помощью
  OAuthProvider::tokenHandler.
  
  К настоящему времени эта функция ещё не была документирована; для ознакомления доступен только
  список аргументов.

<comment>Return:</comment>
  <info>void</info>  Функция не возвращает значения после выполнения.

<comment>See Also:</comment>
   * OAuthProvider::tokenHandler


id: OAuthProvider::checkOAuthRequest
type: function
doc:
<comment>Description:</comment>
  Проверка запроса oauth
  
  Проверяет запрос OAuth.
  
  К настоящему времени эта функция ещё не была документирована; для ознакомления доступен только
  список аргументов.

<comment>Param:</comment>
  <info>string</info>  <strong>$uri</strong>     Необязательный URI, или конечная точка.
  <info>string</info>  <strong>$method</strong>  Необязательный параметр, определяющий метод HTTP. Одна из <info>OAUTH_HTTP_METHOD_*</info>
                   констант OAuth.

<comment>Return:</comment>
  <info>void</info>  Функция не возвращает значения после выполнения.

<comment>See Also:</comment>
   * OAuthProvider::reportProblem


id: OAuthProvider::consumerHandler
type: function
doc:
<comment>Description:</comment>
  Установить обработчик consumerHandler
  
  Задаёт callback-функцию обработчика, которая в дальнейшем будет вызываться
  OAuthProvider::callConsumerHandler.
  
  К настоящему времени эта функция ещё не была документирована; для ознакомления доступен только
  список аргументов.

<comment>Param:</comment>
  <info>callable</info>  <strong>$callback_function</strong>  Функция типа <info>callable</info>.

<comment>Return:</comment>
  <info>void</info>  Функция не возвращает значения после выполнения.

<comment>See Also:</comment>
   * OAuthProvider::callConsumerHandler


id: OAuthProvider::generateToken
type: function
doc:
<comment>Description:</comment>
  Генерация случайного токена
  
  Генерирует строку псевдо-случайных байт.

<comment>Param:</comment>
  <info>int</info>   <strong>$size</strong>    Длина токена в байтах.
  <info>bool</info>  <strong>$strong</strong>  Установка в <info>true</info> приведёт к использованию <return>/dev/random</return>, в противном случае будет
                 использован неблокирующий <return>/dev/urandom</return>. В Windows данный параметр будет
                 проигнорирован.

<comment>Return:</comment>
  <info>string</info>  Сгенерированный токен в виде строки байт.

<comment>See Also:</comment>
   * <strong>openssl_random_pseudo_bytes()</strong>
   * <strong>mcrypt_create_iv()</strong>


id: OAuthProvider::is2LeggedEndpoint
type: function
doc:
<comment>Description:</comment>
  is2LeggedEndpoint
  
  Двухсторонний поток или запрос подписи. Не требует токена.
  
  К настоящему времени эта функция ещё не была документирована; для ознакомления доступен только
  список аргументов.

<comment>Param:</comment>
  <info>mixed</info>  <strong>$params_array</strong>  

<comment>Return:</comment>
  <info>void</info>  Объект <class>OAuthProvider</class>.

<comment>See Also:</comment>
   * OAuthProvider::__construct


id: OAuthProvider::isRequestTokenEndpoint
type: function
doc:
<comment>Description:</comment>
  Установка isRequestTokenEndpoint
  
  К настоящему времени эта функция ещё не была документирована; для ознакомления доступен только
  список аргументов.

<comment>Param:</comment>
  <info>bool</info>  <strong>$will_issue_request_token</strong>  Устанавливает, будет ли он выдавать токен запроса, тем самым
                                   определяя, нужно ли вызывать OAuthProvider::tokenHandler.

<comment>Return:</comment>
  <info>void</info>  Функция не возвращает значения после выполнения.

<comment>See Also:</comment>
   * OAuthProvider::setRequestTokenPath
   * OAuthProvider::reportProblem


id: OAuthProvider::removeRequiredParameter
type: function
doc:
<comment>Description:</comment>
  Удалить требуемый параметр
  
  Удаляет требуемый параметр.
  
  К настоящему времени эта функция ещё не была документирована; для ознакомления доступен только
  список аргументов.

<comment>Param:</comment>
  <info>string</info>  <strong>$req_params</strong>  Требуемый параметр для удаления.

<comment>Return:</comment>
  <info>bool</info>  Возвращает <info>true</info> в случае успешного выполнения или <info>false</info> в случае возникновения ошибки.

<comment>See Also:</comment>
   * OAuthProvider::setParam
   * OAuthProvider::addRequiredParameter


id: OAuthProvider::reportProblem
type: function
doc:
<comment>Description:</comment>
  Сообщить о проблеме
  
  Передать проблему в виде исключения <class>OAuthException</class>. Допустимые проблемы перечислены в секции
  константы OAuth.
  
  К настоящему времени эта функция ещё не была документирована; для ознакомления доступен только
  список аргументов.

<comment>Param:</comment>
  <info>string</info>  <strong>$oauthexception</strong>  Объект исключения <class>OAuthException</class>.

<comment>Return:</comment>
  <info>string</info>  Функция не возвращает значения после выполнения.

<comment>See Also:</comment>
   * OAuthProvider::checkOAuthRequest
   * OAuthProvider::isRequestTokenEndpoint


id: OAuthProvider::setParam
type: function
doc:
<comment>Description:</comment>
  Установить параметр
  
  Устанавливает параметр.
  
  К настоящему времени эта функция ещё не была документирована; для ознакомления доступен только
  список аргументов.

<comment>Param:</comment>
  <info>string</info>  <strong>$param_key</strong>  Ключ параметра.
  <info>mixed</info>   <strong>$param_val</strong>  Необязательное значение параметра.
                      
                      Для исключения параметра из процесса проверки подписи установите его в
                      значение <info>null</info>.

<comment>Return:</comment>
  <info>bool</info>  Возвращает <info>true</info> в случае успешного выполнения или <info>false</info> в случае возникновения ошибки.

<comment>See Also:</comment>
   * OAuthProvider::addRequiredParameter


id: OAuthProvider::setRequestTokenPath
type: function
doc:
<comment>Description:</comment>
  Установить путь запроса токена
  
  Устанавливает путь запроса токена.
  
  К настоящему времени эта функция ещё не была документирована; для ознакомления доступен только
  список аргументов.

<comment>Param:</comment>
  <info>string</info>  <strong>$path</strong>  Путь.

<comment>Return:</comment>
  <info>bool</info>  <info>true</info>

<comment>See Also:</comment>
   * OAuthProvider::tokenHandler


id: OAuthProvider::timestampNonceHandler
type: function
doc:
<comment>Description:</comment>
  Установить обработчик timestampNonceHandler
  
  Устанавливает callback-функцию, используемую в OAuthProvider::callTimestampNonceHandler. В этот
  обработчик будут переданы ошибки относящиеся к timestamp/nonce.
  
  К настоящему времени эта функция ещё не была документирована; для ознакомления доступен только
  список аргументов.

<comment>Param:</comment>
  <info>callable</info>  <strong>$callback_function</strong>  Функция типа <info>callable</info>.

<comment>Return:</comment>
  <info>void</info>  Функция не возвращает значения после выполнения.

<comment>See Also:</comment>
   * OAuthProvider::callTimestampNonceHandler


id: OAuthProvider::tokenHandler
type: function
doc:
<comment>Description:</comment>
  Установить обработчик tokenHandler
  
  Устанавливает callback-функцию обработчика токена, которая будет использоваться
  OAuthProvider::callTokenHandler.
  
  К настоящему времени эта функция ещё не была документирована; для ознакомления доступен только
  список аргументов.

<comment>Param:</comment>
  <info>callable</info>  <strong>$callback_function</strong>  Функция типа <info>callable</info>.

<comment>Return:</comment>
  <info>void</info>  Функция не возвращает значения после выполнения.

<comment>See Also:</comment>
   * OAuthProvider::callTokenHandler


id: OCICollection
type: class
doc:
<comment>Description:</comment>
  Функционал коллекций OCI8.
  
  Класс <class>OCI-Collection</class> был переименован в <class>OCICollection</class> в PHP 8 OCI8 3.0.0 в соответствии со
  стандартами именования PHP.


id: OCICollection::append
type: function
doc:
<comment>Description:</comment>
  Добавляет элемент в коллекцию
  
  Добавляет элемент в конец коллекции.

<comment>Param:</comment>
  <info>string</info>  <strong>$value</strong>  Значение, добавляемое в конец коллекции.

<comment>Return:</comment>
  <info>bool</info>  Возвращает <info>true</info> в случае успешного выполнения или <info>false</info> в случае возникновения ошибки.

<comment>See Also:</comment>
   * 


id: OCICollection::assign
type: function
doc:
<comment>Description:</comment>
  Присваивает коллекции значение другой, уже существующей
     коллекции
  
  Присваивает коллекции значение другой, ранее созданной коллекции. Обе коллекции должны быть
  созданы ранее с помощью <strong>oci_new_collection()</strong>.

<comment>Param:</comment>
  <info>OCICollection</info>  <strong>$from</strong>  Экземпляр OCI-Collection.

<comment>Return:</comment>
  <info>bool</info>  Возвращает <info>true</info> в случае успешного выполнения или <info>false</info> в случае возникновения ошибки.

<comment>See Also:</comment>
   * 


id: OCICollection::assignElem
type: function
doc:
<comment>Description:</comment>
  Присваивает значение элементу коллекции
  
  Присваивает значение элементу коллекции с индексом <strong>$index</strong>.

<comment>Param:</comment>
  <info>int</info>     <strong>$index</strong>  Индекс элемента. Первый индекс - ноль.
  <info>string</info>  <strong>$value</strong>  Может быть строкой или числом.

<comment>Return:</comment>
  <info>bool</info>  Возвращает <info>true</info> в случае успешного выполнения или <info>false</info> в случае возникновения ошибки.

<comment>See Also:</comment>
   * 


id: OCICollection::free
type: function
doc:
<comment>Description:</comment>
  Освобождает ресурсы, занимаемые объектом коллекции
  
  Освобождает ресурсы, занимаемые объектом коллекции.

<comment>Return:</comment>
  <info>bool</info>  Возвращает <info>true</info> в случае успешного выполнения или <info>false</info> в случае возникновения ошибки.

<comment>See Also:</comment>
   * 


id: OCICollection::getElem
type: function
doc:
<comment>Description:</comment>
  Возвращает значение элемента
  
  Возвращает значение элемента с индексом <strong>$index</strong> (начиная с нуля).

<comment>Param:</comment>
  <info>int</info>  <strong>$index</strong>  Индекс элемента. Первый индекс - ноль.

<comment>Return:</comment>
  <info>string|float|null|false</info>  Djpdhfoftn <info>false</info>, если такого элемента нет; <info>null</info>, если элемент равен
                           <info>null</info>; строку, если элемент относится к строковому столбцу, и число, если
                           элемент является числовым полем.

<comment>See Also:</comment>
   * 


id: OCICollection::max
type: function
doc:
<comment>Description:</comment>
  Возвращает максимальное количество элементов в коллекции
  
  Возвращает максимальное количество элементов в коллекции.

<comment>Return:</comment>
  <info>int|false</info>  Возвращает максимальное количество как целое число или <info>false</info> в случае возникновения
             ошибки.
             
             Если будет возвращён 0, то количество элементов не ограничено.

<comment>See Also:</comment>
   * 


id: OCICollection::size
type: function
doc:
<comment>Description:</comment>
  Возвращает количество элементов в коллекции
  
  Возвращает количество элементов в коллекции.

<comment>Return:</comment>
  <info>int|false</info>  Возвращает количество элементов в коллекции или <info>false</info> в случае возникновения ошибки.

<comment>See Also:</comment>
   * 


id: OCICollection::trim
type: function
doc:
<comment>Description:</comment>
  Отсекает элементы с конца коллекции
  
  Отсекает <strong>$num</strong> элементов с конца коллекции.

<comment>Param:</comment>
  <info>int</info>  <strong>$num</strong>  Количество элементов для отсечения.

<comment>Return:</comment>
  <info>bool</info>  Возвращает <info>true</info> в случае успешного выполнения или <info>false</info> в случае возникновения ошибки.

<comment>See Also:</comment>
   * 


id: OCILob
type: class
doc:
<comment>Description:</comment>
  Функциональность OCI8 LOB для больших бинарных (BLOB) и символьных (CLOB) объектов.
  
  Класс <class>OCI-Lob</class> был переименован в <class>OCILob</class> в PHP 8 OCI8 3.0.0 в соответствии со стандартами
  именования PHP.


id: OCILob::append
type: function
doc:
<comment>Description:</comment>
  Добавляет данные из объекта LOB в конец другого объекта
  
  Добавляет в конец объекта LOB данные из другого объекта LOB.
  
  Запись в LOB с помощью этого метода вызовет ошибку, если у объекта ранее был включён режим
  буферизации. Поэтому вы должны выключить буферизацию перед её применением. Перед выключением
  буферизации вам может понадобиться метод  для очистки буфера.

<comment>Param:</comment>
  <info>OCILob</info>  <strong>$from</strong>  Копируемый LOB.

<comment>Return:</comment>
  <info>bool</info>  Возвращает <info>true</info> в случае успешного выполнения или <info>false</info> в случае возникновения ошибки.

<comment>See Also:</comment>
   * 
   * 
   * 


id: OCILob::close
type: function
doc:
<comment>Description:</comment>
  Закрывает дескриптор объекта LOB
  
  Закрывает дескриптор объекта LOB или FILE. Функцию следует использовать только вместе с .

<comment>Return:</comment>
  <info>bool</info>  Возвращает <info>true</info> в случае успешного выполнения или <info>false</info> в случае возникновения ошибки.

<comment>See Also:</comment>
   * 


id: OCILob::eof
type: function
doc:
<comment>Description:</comment>
  Проверяет, находится ли указатель LOB на конце объекта
  
  Сообщает о достижении внутренним указателем конца объекта LOB.

<comment>Return:</comment>
  <info>bool</info>  Возвращает <info>true</info>, если внутренний указатель объекта находится на конце LOB. Иначе возвращает
        <info>false</info>.

<comment>See Also:</comment>
   * 


id: OCILob::erase
type: function
doc:
<comment>Description:</comment>
  Очищает указанную часть объекта LOB
  
  Очищает конкретную часть объекта LOB, начиная с позиции, определённой в параметре <strong>$offset</strong>. По
  умолчанию LOB очищается полностью.
  
  Для объектов типа BLOB очищение означает заполнение нулевыми байтами. Объекты типа CLOB
  заполняются пробелами.

<comment>Param:</comment>
  <info>int|null</info>  <strong>$offset</strong>  
  <info>int|null</info>  <strong>$length</strong>  

<comment>Return:</comment>
  <info>int|false</info>  Возвращает число очищенных символов/байт или <info>false</info> в случае возникновения ошибки.

<comment>See Also:</comment>
   * 


id: OCILob::export
type: function
doc:
<comment>Description:</comment>
  Сохраняет содержимое объекта LOB в файл
  
  Сохраняет содержимое объекта LOB в файл.

<comment>Param:</comment>
  <info>string</info>    <strong>$filename</strong>  Путь к файлу.
  <info>int|null</info>  <strong>$offset</strong>    Начальная позиция экспорта.
  <info>int|null</info>  <strong>$length</strong>    Длина экспортируемой части LOB.

<comment>Return:</comment>
  <info>bool</info>  Возвращает <info>true</info> в случае успешного выполнения или <info>false</info> в случае возникновения ошибки.

<comment>See Also:</comment>
   * 


id: OCILob::flush
type: function
doc:
<comment>Description:</comment>
  Очищает и записывает буфер объекта LOB на сервер
  
  <strong>OCILob::flush()</strong> непосредственно записывает данные на сервер.

<comment>Param:</comment>
  <info>int</info>  <strong>$flag</strong>  По умолчанию ресурсы не освобождаются, но используя флаг <info>OCI_LOB_BUFFER_FREE</info> вы можете
              сделать это принудительно. Однако, вы должны быть точно уверены в том, что вы делаете,
              так как следующее чтение из объекта будет более ресурсоемко, чем предыдущие из-за
              необходимости обращения к серверу. Поэтому использовать флаг <info>OCI_LOB_BUFFER_FREE</info>
              рекомендуется только после того, как работа с объектом уже закончена.

<comment>Return:</comment>
  <info>bool</info>  Возвращает <info>true</info> в случае успешного выполнения или <info>false</info> в случае возникновения ошибки.
        
        Возвращает <info>false</info> в случае возникновения ошибки или если буферизация объекта не была
        включена.

<comment>See Also:</comment>
   * 
   * 


id: OCILob::free
type: function
doc:
<comment>Description:</comment>
  Освобождает ресурсы, связанные с дескриптором LOB
  
  Освобождает ресурсы, связанные с дескриптором LOB, изначально выделенные функцией
  <strong>oci_new_descriptor()</strong>.

<comment>Return:</comment>
  <info>bool</info>  Возвращает <info>true</info> в случае успешного выполнения или <info>false</info> в случае возникновения ошибки.


id: OCILob::getBuffering
type: function
doc:
<comment>Description:</comment>
  Возвращает текущее состояние буферизации большого объекта (LOB)
  
  Сообщает, включена ли буферизация для большого объекта (LOB).

<comment>Return:</comment>
  <info>bool</info>  Возвращает <info>false</info>, если буферизация отключена, и <info>true</info>, если включена.

<comment>See Also:</comment>
   * 


id: OCILob::import
type: function
doc:
<comment>Description:</comment>
  Записывает содержимое файла в объект LOB
  
  Записывает содержимое файла <strong>$filename</strong> в текущую позицию объекта LOB.

<comment>Param:</comment>
  <info>string</info>  <strong>$filename</strong>  Путь к файлу.

<comment>Return:</comment>
  <info>bool</info>  Возвращает <info>true</info> в случае успешного выполнения или <info>false</info> в случае возникновения ошибки.

<comment>See Also:</comment>
   * 
   * 


id: OCILob::load
type: function
doc:
<comment>Description:</comment>
  Возвращает содержимое объекта LOB
  
  Возвращает содержимое объекта LOB. Так как выполнение скрипта прекратится при превышении
  memory_limit, необходимо убедиться, что LOB не превышает этого ограничения. Поэтому, в большинстве
  случаев этот метод рекомендуется заменять на .

<comment>Return:</comment>
  <info>string|false</info>  Возвращает содержимое объекта или <info>false</info> в случае возникновения ошибки.

<comment>See Also:</comment>
   * 


id: OCILob::read
type: function
doc:
<comment>Description:</comment>
  Возвращает часть объекта LOB
  
  Читает <strong>$length</strong> байтов (BLOB) или символов (CLOB) с текущей позиции объекта LOB.
  
  Чтение останавливается, когда прочитано <strong>$length</strong> байтов для BLOB, <strong>$length</strong> символов для CLOB или
  когда достигнут конец объекта. Внутренний указатель объекта будет сдвинут на количество
  прочитанных байт/символов.

<comment>Param:</comment>
  <info>int</info>  <strong>$length</strong>  Длина считываемых данных, в байтах (BLOB) или символах (CLOB). Большие значения
                округляются вниз до 1 MB.

<comment>Return:</comment>
  <info>string|false</info>  Возвращает содержимое в виде строки или <info>false</info> в случае возникновения ошибки.

<comment>See Also:</comment>
   * 
   * 


id: OCILob::rewind
type: function
doc:
<comment>Description:</comment>
  Переводит указатель объекта в начало большого объекта
  
  Устанавливает внутренний указатель в начало объекта LOB.

<comment>Return:</comment>
  <info>bool</info>  Возвращает <info>true</info> в случае успешного выполнения или <info>false</info> в случае возникновения ошибки.

<comment>See Also:</comment>
   * 
   * 


id: OCILob::save
type: function
doc:
<comment>Description:</comment>
  Сохраняет данные в LOB
  
  Сохраняет данные из параметра <strong>$data</strong> в объект LOB.

<comment>Param:</comment>
  <info>string</info>  <strong>$data</strong>    Данные для сохранения.
  <info>int</info>     <strong>$offset</strong>  Может использоваться для указания смещения от начала LOB.

<comment>Return:</comment>
  <info>bool</info>  Возвращает <info>true</info> в случае успешного выполнения или <info>false</info> в случае возникновения ошибки.

<comment>See Also:</comment>
   * 
   * 


id: OCILob::saveFile
type: function
doc:
<comment>Description:</comment>
  Псевдоним OCILob::import
  
  Функция является псевдонимом:   <strong>OCILob::import()</strong>.


id: OCILob::seek
type: function
doc:
<comment>Description:</comment>
  Устанавливает позицию внутреннего указателя LOB
  
  Устанавливает позицию внутреннего указателя объекта LOB.

<comment>Param:</comment>
  <info>int</info>  <strong>$offset</strong>  Указывает количество байтов, на которые следует переместиться от позиции,
                определяемой параметром <strong>$whence</strong>:
  <info>int</info>  <strong>$whence</strong>  Может быть одним из значений: <info>OCI_SEEK_SET</info> - установить позицию, равную <strong>$offset</strong>
                <info>OCI_SEEK_CUR</info> - прибавить к текущей позиции <strong>$offset</strong> байт <info>OCI_SEEK_END</info> - прибавить к
                концу файла <strong>$offset</strong> байт (чтобы переместить указатель в начало - укажите
                отрицательный <strong>$offset</strong>)

<comment>Return:</comment>
  <info>bool</info>  Возвращает <info>true</info> в случае успешного выполнения или <info>false</info> в случае возникновения ошибки.

<comment>See Also:</comment>
   * 
   * 
   * 


id: OCILob::setBuffering
type: function
doc:
<comment>Description:</comment>
  Изменяет текущее состояние буферизации большого объекта (LOB)
  
  Устанавливает буферизацию для большого объекта исходя из значения параметра <strong>$mode</strong>.
  
  Использование этой функции может привести к улучшению производительности путём буферизации мелких
  операций чтения и записи в LOB за счёт уменьшения количества сетевых обращений и версий LOB.
  Необходимо обязательно использовать <strong>OCILob::flush()</strong> после завершения всех работ с LOB.

<comment>Param:</comment>
  <info>bool</info>  <strong>$mode</strong>  <info>true</info> для включения и <info>false</info> для отключения.

<comment>Return:</comment>
  <info>bool</info>  Возвращает <info>true</info> в случае успешного выполнения или <info>false</info> в случае возникновения ошибки.
        Повторные вызовы этого метода с тем же флагом будет возвращать <info>true</info>.

<comment>See Also:</comment>
   * 


id: OCILob::size
type: function
doc:
<comment>Description:</comment>
  Возвращает размер объекта LOB
  
  Возвращает размер объекта LOB

<comment>Return:</comment>
  <info>int|false</info>  Возвращает длину объекта LOB или <info>false</info> в случае возникновения ошибки. Для пустых
             объектов длина равняется нулю.


id: OCILob::tell
type: function
doc:
<comment>Description:</comment>
  Возвращает текущую позицию внутреннего указателя объекта LOB
  
  Возвращает текущую позицию внутреннего указателя объекта LOB.

<comment>Return:</comment>
  <info>int|false</info>  Возвращает текущую позицию внутреннего указателя объекта LOB или <info>false</info> в случае
             возникновения ошибки.

<comment>See Also:</comment>
   * 
   * 
   * 


id: OCILob::truncate
type: function
doc:
<comment>Description:</comment>
  Обрезает большой объект
  
  Обрезает объект LOB.

<comment>Param:</comment>
  <info>int</info>  <strong>$length</strong>  Если указан, то LOB обрезается до указанной в <strong>$length</strong> длины в байтах. Иначе LOB
                очищается полностью.

<comment>Return:</comment>
  <info>bool</info>  Возвращает <info>true</info> в случае успешного выполнения или <info>false</info> в случае возникновения ошибки.

<comment>See Also:</comment>
   * 


id: OCILob::write
type: function
doc:
<comment>Description:</comment>
  Записывает данные в объект LOB
  
  Записывает данные из параметра <strong>$data</strong> в текущую позицию внутреннего указателя объекта.

<comment>Param:</comment>
  <info>string</info>    <strong>$data</strong>    Записываемые в LOB данные.
  <info>int|null</info>  <strong>$length</strong>  Если параметр является числом, то запись остановится после того, как <strong>$length</strong>
                     байт будет записано или закончатся данные из параметра <strong>$data</strong>.

<comment>Return:</comment>
  <info>int|false</info>  Возвращает количество записанных байт или <info>false</info> в случае возникновения ошибки.

<comment>See Also:</comment>
   * 


id: OCILob::writeTemporary
type: function
doc:
<comment>Description:</comment>
  Записывает временный большой объект (LOB)
  
  Создаёт временный большой объект и записывает в него данные <strong>$data</strong>.
  
  После завершения работы с этим объектом его желательно закрыть функцией .

<comment>Param:</comment>
  <info>string</info>  <strong>$data</strong>  Данные для записи.
  <info>int</info>     <strong>$type</strong>  Один из следующих вариантов: <info>OCI_TEMP_BLOB</info> для создания временных BLOB
                 <info>OCI_TEMP_CLOB</info> для создания временных CLOB

<comment>Return:</comment>
  <info>bool</info>  Возвращает <info>true</info> в случае успешного выполнения или <info>false</info> в случае возникновения ошибки.

<comment>See Also:</comment>
   * 


id: OCILob::writeToFile
type: function
doc:
<comment>Description:</comment>
  Псевдоним OCILob::export
  
  Функция является псевдонимом:  <strong>OCILob::export()</strong>.


id: OCI_ASSOC
type: constant
doc:
<comment>Description:</comment>
  Используется функциями <strong>oci_fetch_all()</strong> и <strong>oci_fetch_array()</strong> для получения  результатов в виде
  ассоциативного массива.


id: OCI_BOTH
type: constant
doc:
<comment>Description:</comment>
  Используется функциями <strong>oci_fetch_all()</strong> и <strong>oci_fetch_array()</strong> для получения результатов в виде
  массива с ассоциативными и числовыми индексами.


id: OCI_B_BFILE
type: constant
doc:
<comment>Description:</comment>
  Используется функцией <strong>oci_bind_by_name()</strong> для привязки переменных типа BFILE.


id: OCI_B_BIN
type: constant
doc:
<comment>Description:</comment>
  Используется совместно с функцией <strong>oci_bind_by_name()</strong> для привязки необработанных (RAW) данных.


id: OCI_B_BLOB
type: constant
doc:
<comment>Description:</comment>
  Используется функцией <strong>oci_bind_by_name()</strong> для привязки переменных типа BLOB.


id: OCI_B_BOL
type: constant
doc:
<comment>Description:</comment>
  Используется функцией <strong>oci_bind_by_name()</strong> для привязки переменных типа PL/SQL BOOLEAN.


id: OCI_B_CFILEE
type: constant
doc:
<comment>Description:</comment>
  Используется функцией <strong>oci_bind_by_name()</strong> для привязки переменных типа CFILE.


id: OCI_B_CLOB
type: constant
doc:
<comment>Description:</comment>
  Используется функцией <strong>oci_bind_by_name()</strong>  для привязки переменных типа CLOB.


id: OCI_B_CURSOR
type: constant
doc:
<comment>Description:</comment>
  Используется функцией <strong>oci_bind_by_name()</strong> для привязки курсоров, ранее полученных из
  <strong>oci_new_descriptor()</strong>.


id: OCI_B_INT
type: constant
doc:
<comment>Description:</comment>
  Используется функцией <strong>oci_bind_array_by_name()</strong> для привязки массивов элементов типа INTEGER.


id: OCI_B_NTY
type: constant
doc:
<comment>Description:</comment>
  Используется функцией <strong>oci_bind_by_name()</strong> для привязки именованных типов данных.


id: OCI_B_NUM
type: constant
doc:
<comment>Description:</comment>
  Используется функцией <strong>oci_bind_array_by_name()</strong> для привязки массивов элементов типа NUMBER.


id: OCI_B_ROWID
type: constant
doc:
<comment>Description:</comment>
  Используется функцией <strong>oci_bind_by_name()</strong> для привязки переменных типа ROWID.


id: OCI_COMMIT_ON_SUCCESS
type: constant
doc:
<comment>Description:</comment>
  Режим выполнения выражений для <strong>oci_execute()</strong>. Автоматически завершает транзакцию оператором COMMIT
  в случае успешного выполнения выражения.


id: OCI_CRED_EXT
type: constant
doc:
<comment>Description:</comment>
  Используется функцией <strong>oci_connect()</strong> для внешней или системной аутентификации.


id: OCI_DESCRIBE_ONLY
type: constant
doc:
<comment>Description:</comment>
  Режим выполнения выражений для <strong>oci_execute()</strong>. Используйте этот режим, если вы хотите получить
  данные о выполнении запроса, а не выполнить сам запрос.


id: OCI_DTYPE_FILE
type: constant
doc:
<comment>Description:</comment>
  Флаг используется <strong>oci_new_descriptor()</strong> для инициализации дескриптора типа FILE.


id: OCI_DTYPE_LOB
type: constant
doc:
<comment>Description:</comment>
  Флаг используется <strong>oci_new_descriptor()</strong> для инициализации дескриптора типа LOB.


id: OCI_DTYPE_ROWID
type: constant
doc:
<comment>Description:</comment>
  Флаг используется <strong>oci_new_descriptor()</strong> для инициализации дескриптора типа ROWID.


id: OCI_EXACT_FETCH
type: constant
doc:
<comment>Description:</comment>
  Устарело. Режим получения результатов запроса. Используется в том случае, если приложению известно
  заранее сколько строк будет получено в результате. Oracle 8 и более поздние версии не используют
  выборку результатов с упреждением в этом режиме, а курсоры уничтожаются автоматически после
  выборки ожидаемого количества строк, что может уменьшить требования сервера к ресурсам.


id: OCI_NO_AUTO_COMMIT
type: constant
doc:
<comment>Description:</comment>
  Режим выполнения выражений для <strong>oci_execute()</strong>. В этом режиме транзакция не завершается
  автоматически оператором COMMIT. Для повышения читаемости используйте в новом коде эту константу
  вместо старой равносильной константы <info>OCI_DEFAULT</info>.


id: OCI_NUM
type: constant
doc:
<comment>Description:</comment>
  Используется с <strong>oci_fetch_all()</strong> и <strong>oci_fetch_array()</strong> для получения массива с числовыми индексами.


id: OCI_RETURN_LOBS
type: constant
doc:
<comment>Description:</comment>
  Используется <strong>oci_fetch_array()</strong> для получения содержания объекта LOB вместо дескриптора.


id: OCI_RETURN_NULLS
type: constant
doc:
<comment>Description:</comment>
  Используется с <strong>oci_fetch_array()</strong> для получения пустых элементов массива, если соответствующее поле
  в результате равно <info>null</info>.


id: OCI_SYSDBA
type: constant
doc:
<comment>Description:</comment>
  Используется функцией <strong>oci_connect()</strong> для соединения с привилегиями SYSOPER. Опция php.ini
  oci8.privileged_connect должна быть включена.


id: OPENSSL_ALGO_MD2
type: constant
doc:
<comment>Description:</comment>
  Эта константа доступна, только если PHP скомпилирован с поддержкой MD2. Для этого нужно передать в
  -DHAVE_OPENSSL_MD2_H CFLAG при компиляции PHP и включить md2 при компиляции OpenSSL 1.0.0+.


id: OPENSSL_ALGO_SHA1
type: constant
doc:
<comment>Description:</comment>
  Используется как алгоритм по умолчанию для функций <strong>openssl_sign()</strong> и <strong>openssl_verify()</strong>.


id: OPENSSL_CMS_BINARY
type: constant
doc:
<comment>Description:</comment>
  Обычно входное сообщение преобразуется в "каноничный" формат, который эффективно использует <return>CR</return> и
  <return>LF</return> в качестве конца строки: как требуется спецификацией CMS. Когда присутствует эта опция, перевод
  не выполняется. Это полезно при обработке двоичных данных, которые могут быть не в формате CMS.


id: OPENSSL_CMS_DETACHED
type: constant
doc:
<comment>Description:</comment>
  При подписании сообщения используйте подпись открытым текстом с MIME-типом <return>"multipart/signed"</return>. Это
  значение по умолчанию, если вы не укажете никаких <strong>$flags</strong> для <strong>openssl_cms_sign()</strong>. Если вы отключите
  эту опцию, сообщение будет подписано с использованием непрозрачной подписи, которая более
  устойчива к переводу почтовыми ретрансляторами, но не может быть прочитана почтовыми агентами, не
  поддерживающими S/MIME.


id: OPENSSL_CMS_NOATTR
type: constant
doc:
<comment>Description:</comment>
  Обычно при подписании сообщения включается набор атрибутов, который включает время подписи и
  поддерживаемые симметричные алгоритмы. С этой опцией они не включены.


id: OPENSSL_CMS_NOCERTS
type: constant
doc:
<comment>Description:</comment>
  При подписании сообщения сертификат подписывающей стороны обычно включается - с этой опцией он
  исключается. Это уменьшит размер подписанного сообщения, но у проверяющего должна быть копия
  сертификата подписавшего, доступная локально (например, переданная с помощью
  <strong>$untrusted_certificates_filename</strong> в <strong>openssl_cms_verify()</strong>).


id: OPENSSL_CMS_NOINTERN
type: constant
doc:
<comment>Description:</comment>
  При проверке сообщения, сертификаты (если есть), включённые в сообщение, обычно проверяются на
  наличие сертификата подписи. С этой опцией используются только сертификаты, указанные в параметре
  <strong>$untrusted_certificates_filename</strong> в <strong>openssl_cms_verify()</strong>. Однако предоставленные сертификаты можно
  использовать как ненадёжные центры сертификации.


id: OPENSSL_CMS_OLDMIMETYPE
type: constant
doc:
<comment>Description:</comment>
  Доступно, начиная с PHP 8.3.0. Устанавливает тип содержимого <return>application/x-pkcs7-mime</return> вместо
  <return>application/pkcs7-mime</return> для шифрования сообщения.


id: OPENSSL_CMS_TEXT
type: constant
doc:
<comment>Description:</comment>
  Добавляет заголовки content-type text/plain в зашифрованное/подписанное сообщение. При расшифровке
  или проверке эти заголовки удаляются из вывода - если расшифрованное или проверенное сообщение не
  относится к MIME-типу text/plain, произойдёт ошибка.


id: OPENSSL_ENCODING_DER
type: constant
doc:
<comment>Description:</comment>
  Указывает, что используется кодировка DER (Distinguished Encoding Rules).


id: OPENSSL_ENCODING_PEM
type: constant
doc:
<comment>Description:</comment>
  Указывает, что используется кодировка PEM (Privacy-Enhanced Mail).


id: OPENSSL_KEYTYPE_EC
type: constant
doc:
<comment>Description:</comment>
  Эта константа доступна, только если PHP скомпилирован с OpenSSL 0.9.8+.


id: OPENSSL_RAW_DATA
type: constant
doc:
<comment>Description:</comment>
  Если <info>OPENSSL_RAW_DATA</info> установлена в <strong>openssl_encrypt()</strong> или <strong>openssl_decrypt()</strong>, возвращаемые данные
  возвращаются как есть. Если константа не указана, вызывающей стороне возвращаются данные в
  кодировке Base64.


id: OPENSSL_ZERO_PADDING
type: constant
doc:
<comment>Description:</comment>
  По умолчанию операции шифрования дополняются стандартным заполнением блока, а заполнение
  проверяется и удаляется при дешифровании. Если <info>OPENSSL_ZERO_PADDING</info> установлен в <strong>$options</strong> функции
  <strong>openssl_encrypt()</strong> или <strong>openssl_decrypt()</strong>, то заполнение не выполняется, общий объем зашифрованных
  или расшифрованных данных должен быть кратен размеру блока, иначе возникнет ошибка.


id: OP_HALFOPEN
type: constant
doc:
<comment>Description:</comment>
  Для IMAP и NNTP имён, открыть соединение, но не открывать почтовый ящик.


id: OpenSSLAsymmetricKey
type: class
doc:
<comment>Description:</comment>
  Полностью непрозрачный класс, заменяющий ресурсы <return>OpenSSL key</return> в PHP 8.0.0.


id: OpenSSLCertificate
type: class
doc:
<comment>Description:</comment>
  Полностью непрозрачный класс, заменяющий ресурсы <return>OpenSSL X.509</return> в PHP 8.0.0.


id: OpenSSLCertificateSigningRequest
type: class
doc:
<comment>Description:</comment>
  Полностью непрозрачный класс, заменяющий ресурсы <return>OpenSSL X.509 CSR</return> в PHP 8.0.0.


id: OuterIterator
type: class
doc:
<comment>Description:</comment>
  Классы, реализующие <class>OuterIterator</class>, могут быть использованы для перебора итераторов.


id: OuterIterator::getInnerIterator
type: function
doc:
<comment>Description:</comment>
  Возвращает внутренний итератор для текущего элемента
  
  Возвращает внутренний итератор для текущего элемента.

<comment>Return:</comment>
  <info>Iterator|null</info>  Внутренний итератор для текущего элемента, если он существует или <info>null</info> в противном
                 случае.


id: PASSWORD_ARGON2I
type: constant
doc:
<comment>Description:</comment>
  <info>PASSWORD_ARGON2I</info> используется для создания новых хешей паролей с помощью алгоритма Argon2i.
  
  Поддерживаемые опции:
  
  <return>memory_cost</return> (<info>int</info>) - Максимальный размер памяти (в кибибайтах), которую можно использовать для
  вычисления хеша Argon2. По умолчанию <info>PASSWORD_ARGON2_DEFAULT_MEMORY_COST</info>.
  
  <return>time_cost</return> (<info>int</info>) - Максимально возможное время которое можно потратить для вычисления хеша Argon2.
  По умолчанию <info>PASSWORD_ARGON2_DEFAULT_TIME_COST</info>.
  
  <return>threads</return> (<info>int</info>) - Количество потоков, которые можно использовать для вычисления хеша Argon2. По
  умолчанию <info>PASSWORD_ARGON2_DEFAULT_THREADS</info>. Доступно только с libargon2, но не с реализацией
  libsodium.
  
  Доступно с PHP 7.2.0.


id: PASSWORD_ARGON2ID
type: constant
doc:
<comment>Description:</comment>
  <info>PASSWORD_ARGON2ID</info> используется для создания хешей паролей с помощью алгоритма Argon2id.
  Поддерживаются те же опции, что и для <info>PASSWORD_ARGON2I</info>.
  
  Доступно с PHP 7.3.0.


id: PASSWORD_ARGON2_DEFAULT_MEMORY_COST
type: constant
doc:
<comment>Description:</comment>
  Объем памяти в байтах по умолчанию, который будет использоваться при попытке вычислить хеш.
  
  Доступно с PHP 7.2.0.


id: PASSWORD_ARGON2_DEFAULT_THREADS
type: constant
doc:
<comment>Description:</comment>
  Количество потоков по умолчанию для библиотеки Argon2lib. Недоступно с реализацией libsodium.
  
  Доступно с PHP 7.2.0.


id: PASSWORD_ARGON2_DEFAULT_TIME_COST
type: constant
doc:
<comment>Description:</comment>
  Ограничение времени по умолчанию на вычисление хеша.
  
  Доступно с PHP 7.2.0.


id: PASSWORD_BCRYPT
type: constant
doc:
<comment>Description:</comment>
  <info>PASSWORD_BCRYPT</info> используется для создания новых хешей паролей используя алгоритм <info>CRYPT_BLOWFISH</info>.
  
  Результат всегда представляет из себя хеш формата "$2y$" длиной 60 символов.
  
  Поддерживаемые опции:
  
  <return>salt</return> (<info>string</info>) - соль для использования при создании хеша пароля. Обратите внимание, что задание
  этой опции предотвращает автоматическую генерацию соли.
  
  Если не задано, то для каждого хешируемого пароля будет создана случайная соль с помощью функции
  <strong>password_hash()</strong>. Это является предпочтительным способом, а с PHP 7.0.0 опция salt объявлена
  устаревшей.
  
  <return>cost</return> (<info>int</info>) - алгоритмическая стоимость, которую следует использовать. Примеры использования этого
  значения смотрите на странице описания функции <strong>crypt()</strong>.
  
  Если не задано, то будет использовано значение <return>10</return>. Это хорошая базовая стоимость, но вы всегда
  можете её увеличить в зависимости от имеющихся в вашем распоряжении вычислительных ресурсов.


id: PASSWORD_DEFAULT
type: constant
doc:
<comment>Description:</comment>
  Алгоритм хеширования по умолчанию, если не задан принудительно. Может быть изменён в более новых
  версиях PHP на более надёжный алгоритм.
  
  Стоит отметить, что со временем эта константа может (и, вероятно, так и будет) измениться. Так что
  имейте в виду, что длина полученного хеша может измениться. Помните, что если вы используете
  <info>PASSWORD_DEFAULT</info>, то предусмотрите для хранения хешей больше чем 60 символов (рекомендуется 255).
  
  Значения для этой константы:
  
  PHP 5.5.0 - <info>PASSWORD_BCRYPT</info>


id: PCRE_VERSION
type: constant
doc:
<comment>Description:</comment>
  Версия и дата релиза PCRE (например, "<return>7.0 18-Dec-2006</return>").
  
  5.2.4


id: PDO::ATTR_AUTOCOMMIT
type: constant
doc:
<comment>Description:</comment>
  Если значение <info>false</info>, PDO попытается отключить автоматическую фиксацию изменений в базе данных,
  таким образом началом транзакции будет установление соединения.


id: PDO::ATTR_CASE
type: constant
doc:
<comment>Description:</comment>
  Приведение имён столбцов к нужному регистру, который задаётся константами <return>PDO::CASE_*</return>.


id: PDO::ATTR_CLIENT_VERSION
type: constant
doc:
<comment>Description:</comment>
  Этот атрибут предназначен только для чтения; он содержит информацию о версии клиентских библиотек,
  которые использует драйвер PDO.


id: PDO::ATTR_CURSOR
type: constant
doc:
<comment>Description:</comment>
  Выбор типа курсора. PDO на данный момент поддерживает <info>PDO::CURSOR_FWDONLY</info> и <info>PDO::CURSOR_SCROLL</info>.
  Если вы не уверены, что вам нужен именно прокручиваемый курсор, выбирайте <info>PDO::CURSOR_FWDONLY</info>.


id: PDO::ATTR_CURSOR_NAME
type: constant
doc:
<comment>Description:</comment>
  Получение или установке имени курсора. Особенно полезно при использовании прокручиваемых курсоров
  или обновления данных в конкретных позициях.


id: PDO::ATTR_DEFAULT_STR_PARAM
type: constant
doc:
<comment>Description:</comment>
  Устанавливает по умолчанию тип параметра строку, значением может быть одна из констант:
  <info>PDO::PARAM_STR_NATL</info> или <info>PDO::PARAM_STR_CHAR</info>.
  
  Константа доступна с версии PHP 7.2.0.


id: PDO::ATTR_DRIVER_NAME
type: constant
doc:
<comment>Description:</comment>
  Возвращает имя драйвера.
  
  Пример использования <info>PDO::ATTR_DRIVER_NAME</info>getAttribute(PDO::ATTR_DRIVER_NAME) == 'mysql') { echo
  "Работаем с mysql; делаем что-то специфичное для mysql\n";
  }
  ?>
  ]]>


id: PDO::ATTR_FETCH_CATALOG_NAMES
type: constant
doc:
<comment>Description:</comment>
  Предписание предварять имена столбцов именами каталогов в результирующем наборе. Имя столбца
  отделяется от имени каталога десятичной точкой (.). Поддержка этого атрибута заложена на уровне
  драйвера; этот функционал поддерживается не всеми драйверами.


id: PDO::ATTR_FETCH_TABLE_NAMES
type: constant
doc:
<comment>Description:</comment>
  Предписание предварять имена столбцов именами исходных таблиц в результирующем наборе. Имя столбца
  отделяется от имени таблицы десятичной точкой (.). Поддержка этого атрибута заложена на уровне
  драйвера; этот функционал поддерживается не всеми драйверами.


id: PDO::ATTR_PERSISTENT
type: constant
doc:
<comment>Description:</comment>
  Запрашивать постоянное соединение вместо создания нового подключения. Подробнее об этом атрибуте
  смотрите раздел Подключения и управление подключениями.


id: PDO::ATTR_PREFETCH
type: constant
doc:
<comment>Description:</comment>
  Изменение размера буфера предвыборки позволяет регулировать баланс между затрачиваемой памятью и
  скоростью работы с базой данных. Не все связки база/драйвер поддерживают изменение размера этого
  буфера. Чем больше этот размер, тем выше быстродействие, но и выше затраты памяти.


id: PDO::ATTR_SERVER_INFO
type: constant
doc:
<comment>Description:</comment>
  Этот атрибут предназначен только для чтения; он содержит информацию о сервере баз данных, к
  которому подключён PDO.


id: PDO::ATTR_SERVER_VERSION
type: constant
doc:
<comment>Description:</comment>
  Этот атрибут предназначен только для чтения; он содержит информацию о версии сервера баз данных, к
  которому подключён PDO.


id: PDO::ATTR_STATEMENT_CLASS
type: constant
doc:
<comment>Description:</comment>
  Устанавливает имя класса, для которого возвращаются запросы (statements).


id: PDO::ATTR_TIMEOUT
type: constant
doc:
<comment>Description:</comment>
  Задаёт время в секундах, в течение которого должен быть завершён обмен с базой данных.


id: PDO::CASE_NATURAL
type: constant
doc:
<comment>Description:</comment>
  Предписание оставлять имена столбцов такими, какие выдал драйвер базы данных.


id: PDO::CURSOR_FWDONLY
type: constant
doc:
<comment>Description:</comment>
  Предписание создать объект <class>PDOStatement</class> с последовательным курсором. Последовательные курсоры
  выбираются по умолчанию, так как это наиболее общий и быстрый способ доступа к данным в БД из PHP.


id: PDO::CURSOR_SCROLL
type: constant
doc:
<comment>Description:</comment>
  Предписание создать объект <class>PDOStatement</class> с прокручиваемым курсором. Передача констант
  <return>PDO::FETCH_ORI_*</return> позволяет задать режим работы курсора, то, как будут выбираться строки из
  результирующего набора запроса.


id: PDO::ERRMODE_EXCEPTION
type: constant
doc:
<comment>Description:</comment>
  Предписание выбрасывать исключение <class>PDOException</class> в случае возникновения ошибки. Подробнее об этом
  атрибуте смотрите в разделе Ошибки и их обработка.


id: PDO::ERRMODE_SILENT
type: constant
doc:
<comment>Description:</comment>
  Предписание не выбрасывать исключений в случае ошибок. Предполагается, что разработчик скрипта
  явно проверяет все исключительные ситуации. Это режим по умолчанию. Подробнее об этом атрибуте
  смотрите в разделе Ошибки и их обработка.


id: PDO::ERRMODE_WARNING
type: constant
doc:
<comment>Description:</comment>
  Предписание выдавать сообщение об ошибке PHP уровня <info>E_WARNING</info>. Подробнее об этом атрибуте смотрите
  в разделе Ошибки и их обработка.


id: PDO::ERR_NONE
type: constant
doc:
<comment>Description:</comment>
  Соответствует коду SQLSTATE '00000'. Это означает, что SQL-запрос выполнен успешно без ошибок или
  предупреждений. Эта константа внедрена для удобства при проверке, есть ли ошибки, функциями
  PDO::errorCode или PDOStatement::errorCode. Также можно проверять, есть ли ошибка внутри метода,
  сравнивая его код возврата с этой константой.


id: PDO::FETCH_ASSOC
type: constant
doc:
<comment>Description:</comment>
  Указывает, что метод, осуществляющий выборку данных, должен возвращать каждую строку
  результирующего набора в виде ассоциативного массива, индексы которого соответствуют именам
  столбцов результата выборки. Если в результирующем наборе несколько столбцов с одинаковыми
  именами, <info>PDO::FETCH_ASSOC</info> будет возвращать по одному значению для каждого столбца. Значения
  дублирующихся столбцов будут утеряны.


id: PDO::FETCH_BOTH
type: constant
doc:
<comment>Description:</comment>
  Указывает, что метод, осуществляющий выборку данных, должен возвращать каждую строку
  результирующего набора в виде массива. Индексация массива производится и по именам столбцов и по
  их порядковым номерам в результирующей таблице. Нумерация начинается с 0.


id: PDO::FETCH_BOUND
type: constant
doc:
<comment>Description:</comment>
  Указывает, что метод, осуществляющий выборку данных, должен возвращать TRUE и присваивать значения
  столбцов таблицы переменным PHP, которые были привязаны методами PDOStatement::bindParam или
  PDOStatement::bindColumn.


id: PDO::FETCH_CLASS
type: constant
doc:
<comment>Description:</comment>
  Указывает, что метод, осуществляющий выборку данных, должен возвращать новый объект запрашиваемого
  класса, заполняя именованные свойства класса значениями столбцов результирующей таблицы.
  
  Если в классе нет свойства с необходимым именем, будет вызван магический метод __set.


id: PDO::FETCH_COLUMN
type: constant
doc:
<comment>Description:</comment>
  Указывает, что метод, осуществляющий выборку данных, должен возвращать значение только одного
  столбца из следующей строки результирующего набора.


id: PDO::FETCH_DEFAULT
type: constant
doc:
<comment>Description:</comment>
  Указывает, что должен использоваться режим выборки по умолчанию. Доступно с PHP 8.0.7.


id: PDO::FETCH_FUNC
type: constant
doc:
<comment>Description:</comment>
  Позволяет настроить обработку данных "на лету" во время выборки (константа действительна только
  для функции PDOStatement::fetchAll).


id: PDO::FETCH_GROUP
type: constant
doc:
<comment>Description:</comment>
  Группировка возвращаемых значений. Обычно комбинируется с константами <info>PDO::FETCH_COLUMN</info> или
  <info>PDO::FETCH_KEY_PAIR</info>.


id: PDO::FETCH_INTO
type: constant
doc:
<comment>Description:</comment>
  Указывает, что метод, осуществляющий выборку данных, должен обновлять существующий объект
  запрашиваемого класса, заполняя именованные свойства класса значениями столбцов результирующей
  таблицы.


id: PDO::FETCH_KEY_PAIR
type: constant
doc:
<comment>Description:</comment>
  Выборка из двух столбцов будет помещена в массив, в котором значения первого столбца принимаются
  за ключи, а значения второго - за значения.


id: PDO::FETCH_LAZY
type: constant
doc:
<comment>Description:</comment>
  Указывает, что метод, осуществляющий выборку данных, должен возвращать каждую строку выборки в
  виде объекта, в котором имена переменных соответствуют именам столбцов результирующего набора.
  <info>PDO::FETCH_LAZY</info> создаёт объект с такими же именами переменных, с которыми осуществлялась выборка.
  Константа недействительна для функции PDOStatement::fetchAll.


id: PDO::FETCH_NAMED
type: constant
doc:
<comment>Description:</comment>
  Указывает, что метод, осуществляющий выборку данных, должен возвращать каждую строку
  результирующего набора в виде ассоциативного массива, индексы которого соответствуют именам
  столбцов результата выборки. Если в результирующем наборе несколько столбцов с одинаковыми
  именами, <info>PDO::FETCH_NAMED</info> возвращает массив значений для каждого имени столбца.


id: PDO::FETCH_NUM
type: constant
doc:
<comment>Description:</comment>
  Указывает, что метод, осуществляющий выборку данных, должен возвращать каждую строку
  результирующего набора в виде массива, индексы которого соответствуют порядковым номерам столбцов
  результата выборки. Нумерация начинается с 0.


id: PDO::FETCH_OBJ
type: constant
doc:
<comment>Description:</comment>
  Указывает, что метод, осуществляющий выборку данных, должен возвращать каждую строку
  результирующего набора в виде объекта, имена свойств которого соответствуют именам столбцов
  результирующей таблицы.


id: PDO::FETCH_ORI_ABS
type: constant
doc:
<comment>Description:</comment>
  Предписание выбрать строку с указанным номером из результирующего набора. Константа действительна
  только для прокручиваемых курсоров.


id: PDO::FETCH_ORI_FIRST
type: constant
doc:
<comment>Description:</comment>
  Предписание выбрать первую строку из результирующего набора. Константа действительна только для
  прокручиваемых курсоров.


id: PDO::FETCH_ORI_LAST
type: constant
doc:
<comment>Description:</comment>
  Предписание выбрать последнюю строку из результирующего набора. Константа действительна только для
  прокручиваемых курсоров.


id: PDO::FETCH_ORI_NEXT
type: constant
doc:
<comment>Description:</comment>
  Предписание выбрать следующую строку из результирующего набора. Константа действительна только для
  прокручиваемых курсоров.


id: PDO::FETCH_ORI_PRIOR
type: constant
doc:
<comment>Description:</comment>
  Предписание выбрать предыдущую строку из результирующего набора. Константа действительна только
  для прокручиваемых курсоров.


id: PDO::FETCH_ORI_REL
type: constant
doc:
<comment>Description:</comment>
  Предписание выбрать строку из результирующего набора относительно текущего положения курсора.
  Константа действительна только для прокручиваемых курсоров.


id: PDO::FETCH_SERIALIZE
type: constant
doc:
<comment>Description:</comment>
  Аналогична <info>PDO::FETCH_INTO</info>, но объект представлен в виде сериализованной строки. Конструктор
  класса не будет вызван, если этот флаг установлен. Объявлена устаревшей, начиная с PHP 8.1.0.


id: PDO::FETCH_UNIQUE
type: constant
doc:
<comment>Description:</comment>
  Выбирать только уникальные значения, исключать дубли из результата.


id: PDO::MYSQL_ATTR_DIRECT_QUERY
type: constant
doc:
<comment>Description:</comment>
  Выполнять прямые запросы, не использовать подготовленные конструкции.


id: PDO::MYSQL_ATTR_FOUND_ROWS
type: constant
doc:
<comment>Description:</comment>
  Возвращает количество найденных (совпавших) строк, а не количество изменённых строк.


id: PDO::MYSQL_ATTR_IGNORE_SPACE
type: constant
doc:
<comment>Description:</comment>
  Разрешает пробелы после имён функций. Делает все имена функций зарезервированными словами.


id: PDO::MYSQL_ATTR_INIT_COMMAND
type: constant
doc:
<comment>Description:</comment>
  Команда, которую необходимо выполнить при подключении к MySQL-серверу. Также будет автоматически
  выполнена при переподключении.
  
  Обратите внимание, что эта константа может быть использована только в массиве <strong>$driver_options</strong> при
  создании дескриптора новой базы данных.


id: PDO::MYSQL_ATTR_LOCAL_INFILE
type: constant
doc:
<comment>Description:</comment>
  Включить <return>LOAD LOCAL INFILE</return>.
  
  Обратите внимание, что эта константа может быть использована только в массиве <strong>$driver_options</strong> при
  создании дескриптора новой базы данных.


id: PDO::MYSQL_ATTR_LOCAL_INFILE_DIRECTORY
type: constant
doc:
<comment>Description:</comment>
  Позволяет ограничить загрузку LOCAL DATA файлами, расположенными в указанном каталоге. Доступно,
  начиная с версии PHP 8.1.0.
  
  Обратите внимание, что эта константа может использоваться только в массиве <strong>$driver_options</strong> при
  создании нового дескриптора базы данных.


id: PDO::MYSQL_ATTR_MAX_BUFFER_SIZE
type: constant
doc:
<comment>Description:</comment>
  Максимальный размер буфера. По умолчанию равен 1 Мб. Эта константа не поддерживается при
  компиляции вместе с mysqlnd.


id: PDO::MYSQL_ATTR_MULTI_STATEMENTS
type: constant
doc:
<comment>Description:</comment>
  Если установлено как <info>false</info>, запрещает запуск множественных запросов, как для <strong>PDO::prepare()</strong>, так и
  для <strong>PDO::query()</strong>.
  
  Обратите внимание, что эта константа может быть использована только в массиве <strong>$driver_options</strong> при
  создании нового дескриптора БД.


id: PDO::MYSQL_ATTR_READ_DEFAULT_FILE
type: constant
doc:
<comment>Description:</comment>
  Чтение именованных параметров из файла my.cnf. Эта опция недоступна, если используется mysqlnd,
  потому что mysqlnd не читает файлы конфигурации MySQL.


id: PDO::MYSQL_ATTR_READ_DEFAULT_GROUP
type: constant
doc:
<comment>Description:</comment>
  Чтение именованной группы параметров из файла my.cnf или из файла, определённого в константе
  <info>MYSQL_READ_DEFAULT_FILE</info>. Эта опция недоступна, если используется mysqlnd, потому что mysqlnd не
  читает файлы конфигурации MySQL.


id: PDO::MYSQL_ATTR_SSL_CAPATH
type: constant
doc:
<comment>Description:</comment>
  Путь к директории, которая содержит SSL-сертификаты доверенных центров (CA), хранящиеся в формате
  PEM.


id: PDO::MYSQL_ATTR_SSL_CIPHER
type: constant
doc:
<comment>Description:</comment>
  Список из одного или более допустимых шифров для использования в SSL-шифровании в формате, который
  понимает OpenSSL. Например: <return>DHE-RSA-AES256-SHA:AES128-SHA</return>


id: PDO::MYSQL_ATTR_SSL_VERIFY_SERVER_CERT
type: constant
doc:
<comment>Description:</comment>
  Предоставляет способ отключения проверки SSL-сертификата сервера.
  
  Существует, начиная с PHP  7.0.18 и PHP 7.1.4.


id: PDO::MYSQL_ATTR_USE_BUFFERED_QUERY
type: constant
doc:
<comment>Description:</comment>
  По умолчанию все запросы выполняются в буферизованном режиме. Если этот атрибут установлен в
  значение <info>false</info> для объекта <class>PDO</class>, драйвер MySQL будет использовать небуферизованный режим.
  
  Установка небуферизованного режима MySQLsetAttribute(PDO::MYSQL_ATTR_USE_BUFFERED_QUERY, false);
  
  $unbufferedResult = $pdo->query("SELECT Name FROM City");
  foreach ($unbufferedResult as $row) { echo $row['Name'] . PHP_EOL;
  }
  ?>
  ]]>


id: PDO::OCI_ATTR_ACTION
type: constant
doc:
<comment>Description:</comment>
  Позволяет задать действие для сессии.
  
  Существует, начиная с PHP  7.2.16 и 7.3.3


id: PDO::OCI_ATTR_CLIENT_IDENTIFIER
type: constant
doc:
<comment>Description:</comment>
  Позволяет задать идентификатор клиента для сессии.
  
  Существует, начиная с PHP  7.2.16 и 7.3.3


id: PDO::OCI_ATTR_CLIENT_INFO
type: constant
doc:
<comment>Description:</comment>
  Позволяет задать информацию по клиенту для сессии.
  
  Существует, начиная с PHP  7.2.16 и 7.3.3


id: PDO::OCI_ATTR_MODULE
type: constant
doc:
<comment>Description:</comment>
  Позволяет задать модуль для сессии.
  
  Существует, начиная с PHP  7.2.16 и 7.3.3


id: PDO::ODBC_ATTR_ASSUME_UTF8
type: constant
doc:
<comment>Description:</comment>
  Только для Windows. Если <info>true</info>, то данные в кодировке UTF-16 (<return>CHAR</return>, <return>VARCHAR</return> и <return>LONGVARCHAR</return>) будут
  сконвертированны в UTF-8 при чтении или записи. Если <info>false</info> (по умолчанию), преобразование
  кодировки символов может быть выполнено драйвером.


id: PDO::ODBC_ATTR_USE_CURSOR_LIBRARY
type: constant
doc:
<comment>Description:</comment>
  Этот параметр определяет, используется ли библиотека курсоров ODBC. Библиотека курсоров ODBC
  поддерживает некоторые дополнительные особенности ODBC (например блочные прокручиваемые курсоры),
  которые могут не реализовываться драйвером. Поддерживаются следующие значения:
  <info>PDO::ODBC_SQL_USE_IF_NEEDED</info> (по умолчанию): использовать библиотеку курсоров ODBC если необходимо.
  <info>PDO::ODBC_SQL_USE_DRIVER</info>: никогда не использовать библиотеку курсоров ODBC.
  <info>PDO::ODBC_SQL_USE_ODBC</info>: всегда использовать библиотеку курсоров ODBC.
  
  <info>PDO::ODBC_SQL_USE_IF_NEEDED</info> (по умолчанию): использовать библиотеку курсоров ODBC если необходимо.
  
  <info>PDO::ODBC_SQL_USE_DRIVER</info>: никогда не использовать библиотеку курсоров ODBC.
  
  <info>PDO::ODBC_SQL_USE_ODBC</info>: всегда использовать библиотеку курсоров ODBC.


id: PDO::PARAM_EVT_FETCH_POST
type: constant
doc:
<comment>Description:</comment>
  Событие, возникающее после выборки данных из результирующего набора.


id: PDO::PARAM_EVT_FETCH_PRE
type: constant
doc:
<comment>Description:</comment>
  Событие, возникающее перед выборкой данных из результирующего набора.


id: PDO::PARAM_EVT_NORMALIZE
type: constant
doc:
<comment>Description:</comment>
  Событие, возникающее во время регистрации параметров, позволяющее драйверу нормализовать имена
  параметров.


id: PDO::PARAM_INPUT_OUTPUT
type: constant
doc:
<comment>Description:</comment>
  Указывает, что параметр является параметром INOUT для хранимой процедуры. Для задания типа данных
  необходимо применить побитовое ИЛИ этой константы с константой типа PDO::PARAM_*.


id: PDO::PARAM_STMT
type: constant
doc:
<comment>Description:</comment>
  Представляет тип recordset. На данный момент не поддерживается драйверами.


id: PDO::PARAM_STR
type: constant
doc:
<comment>Description:</comment>
  Представляет типы данных SQL CHAR, VARCHAR и другие строковые типы.


id: PDO::PARAM_STR_CHAR
type: constant
doc:
<comment>Description:</comment>
  Флаг для обозначения, что строки используют обычный набор символов.
  
  Константа доступна с версии PHP 7.2.0


id: PDO::PARAM_STR_NATL
type: constant
doc:
<comment>Description:</comment>
  Флаг для обозначения, что строки используют национальный набор символов.
  
  Константа доступна с версии PHP 7.2.0


id: PDO::PGSQL_ATTR_DISABLE_PREPARES
type: constant
doc:
<comment>Description:</comment>
  Отправьте запрос и параметры на сервер вместе за один вызов, избегая необходимости отдельно
  создавать именованный подготовленный оператор. Если запрос будет выполняться только один раз, это
  может уменьшить задержку, избегая ненужного обхода сервера.


id: PDO::SQLITE_DETERMINISTIC
type: constant
doc:
<comment>Description:</comment>
  Указывает, что функция созданная PDO::sqliteCreateFunction детерминирована, то есть она всегда
  возвращает одинаковый результат для для одинаковых входных данных в одном выражении SQL. (Доступно
  с PHP 7.1.4.)


id: PDO::SQLSRV_ATTR_DIRECT_QUERY
type: constant
doc:
<comment>Description:</comment>
  Показывает, что запрос должен быть немедленно выполнен, без подготовки выражения. Константа может
  быть передана в функции PDO::setAttribute и PDO::prepare. За подробностями обратитесь к разделу
  документации Немедленное выполнение выражений и выполнение подготовленных выражений.


id: PDO::SQLSRV_ATTR_QUERY_TIMEOUT
type: constant
doc:
<comment>Description:</comment>
  Неотрицательное целое число, отражающее время ожидания в секундах. Ноль (0) - это значение по
  умолчанию, означающее, что время ожидания не учитывается. Константа может быть передана в функции
  PDOStatement::setAttribute, PDO::setAttribute и PDO::prepare.


id: PDO::SQLSRV_ENCODING_BINARY
type: constant
doc:
<comment>Description:</comment>
  Определяет, что данные отправляются/получаются в виде потока байтов к/от сервера без выполнения
  преобразования кодировки или другого преобразования. Константа может быть передана в функции
  PDOStatement::setAttribute, PDO::prepare, PDOStatement::bindColumn и PDOStatement::bindParam.


id: PDO::SQLSRV_ENCODING_DEFAULT
type: constant
doc:
<comment>Description:</comment>
  Определяет, что данные отправляются/получаются к/от сервера согласно значению
  PDO::SQLSRV_ENCODING_SYSTEM, указанному при подключении. Для подключения может использоваться
  кодировка, указанная при подготовке выражения. Константа может быть передана в функции
  PDOStatement::setAttribute, PDO::setAttribute, PDO::prepare, PDOStatement::bindColumn и
  PDOStatement::bindParam.


id: PDO::SQLSRV_ENCODING_SYSTEM
type: constant
doc:
<comment>Description:</comment>
  Определяет, что данные отправляются/получаются к/от сервера в 8ми-битной кодировке локали Windows,
  установленной в системе. Все мультибайтовые символы и символы, не преобразуемые в данную
  кодировку, заменяются символом вопроса (?). Константа может быть передана в функции
  PDOStatement::setAttribute, PDO::setAttribute, PDO::prepare, PDOStatement::bindColumn и
  PDOStatement::bindParam.


id: PDO::SQLSRV_ENCODING_UTF8
type: constant
doc:
<comment>Description:</comment>
  Определяет, что данные отправляются/получаются к/от сервера в кодировке UTF-8. Константа может
  быть передана в функции PDOStatement::setAttribute, PDO::setAttribute, PDO::prepare,
  PDOStatement::bindColumn и PDOStatement::bindParam.


id: PDO::SQLSRV_TXN_READ_COMMITTED
type: constant
doc:
<comment>Description:</comment>
  Данная константа - допустимое значение для ключа TransactionIsolation SQLSRV DSN. Устанавливает
  уровень изоляции транзакций для соединения в значение Read Committed.


id: PDO::SQLSRV_TXN_READ_UNCOMMITTED
type: constant
doc:
<comment>Description:</comment>
  Данная константа - допустимое значение для ключа TransactionIsolation SQLSRV DSN. Устанавливает
  уровень изоляции транзакций для соединения в значение Read Uncommitted.


id: PDO::SQLSRV_TXN_REPEATABLE_READ
type: constant
doc:
<comment>Description:</comment>
  Данная константа - допустимое значение для ключа TransactionIsolation SQLSRV DSN. Устанавливает
  уровень изоляции транзакций для соединения в значение Repeateable Read.


id: PDO::SQLSRV_TXN_SERIALIZABLE
type: constant
doc:
<comment>Description:</comment>
  Данная константа - допустимое значение для ключа TransactionIsolation SQLSRV DSN. Устанавливает
  уровень изоляции транзакций для соединения в значение Serializable.


id: PDO::SQLSRV_TXN_SNAPSHOT
type: constant
doc:
<comment>Description:</comment>
  Данная константа - допустимое значение для ключа TransactionIsolation SQLSRV DSN. Устанавливает
  уровень изоляции транзакций для соединения в значение Snapshot.


id: PDO::__construct
type: function
doc:
<comment>Description:</comment>
  Создаёт экземпляр PDO, предоставляющий соединение с базой данных
    
  
  Создаёт экземпляр PDO, предоставляющий подключение к необходимой базе данных.

<comment>Param:</comment>
  <info>string</info>       <strong>$dsn</strong>       Имя источника данных или DSN, содержащее информацию, необходимую для
                          подключения к базе данных.
                          
                          В общем, DSN состоит из имени драйвера PDO, за которым следует двоеточие и
                          специфический синтаксис подключения драйвера PDO. Дополнительную
                          информацию можно получить из раздела Документация по специфическим
                          драйверам PDO.
                          
                          Параметр <strong>$dsn</strong> поддерживает три разные метода указания аргументов,
                          необходимых для создания соединения с базой данных:
                          
                          Вызов драйвера<strong>$dsn</strong> содержит полный DSN. Вызов URI Параметр <strong>$dsn</strong> состоит из
                          строки uri: с последующим URI, который определяет расположение файла,
                          содержащего строку DSN. URI может указывать на локальный файл или
                          удалённый URL. uri:file:///path/to/dsnfileСовмещение имён<strong>$dsn</strong> состоит из
                          имени <strong>$name</strong>, которое соответствует параметру pdo.dsn.<strong>$name</strong> в php.ini,
                          определяющему строку DSN.  Псевдоним должен быть определён в php.ini, но
                          не в .htaccess или httpd.conf
                          
                          <strong>$dsn</strong> содержит полный DSN.
                          
                          Параметр <strong>$dsn</strong> состоит из строки uri: с последующим URI, который определяет
                          расположение файла, содержащего строку DSN. URI может указывать на
                          локальный файл или удалённый URL.
                          
                          uri:file:///path/to/dsnfile
                          
                          <strong>$dsn</strong> состоит из имени <strong>$name</strong>, которое соответствует параметру pdo.dsn.<strong>$name</strong>
                          в php.ini, определяющему строку DSN.
                          
                          Псевдоним должен быть определён в php.ini, но не в .htaccess или
                          httpd.conf
  <info>string</info>       <strong>$dsn</strong>       <strong>$dsn</strong> содержит полный DSN.
  <info>string</info>       <strong>$dsn</strong>       Параметр <strong>$dsn</strong> состоит из строки uri: с последующим URI, который определяет
                          расположение файла, содержащего строку DSN. URI может указывать на
                          локальный файл или удалённый URL.
                          
                          uri:file:///path/to/dsnfile
  <info>string</info>       <strong>$dsn</strong>       <strong>$dsn</strong> состоит из имени <strong>$name</strong>, которое соответствует параметру pdo.dsn.<strong>$name</strong>
                          в php.ini, определяющему строку DSN.
                          
                          Псевдоним должен быть определён в php.ini, но не в .htaccess или
                          httpd.conf
  <info>string|null</info>  <strong>$username</strong>  Имя пользователя для строки DSN. Этот параметр опционален для некоторых
                          драйверов PDO.
  <info>string|null</info>  <strong>$password</strong>  Пароль для строки DSN. Этот параметр опционален для некоторых драйверов
                          PDO.
  <info>array|null</info>   <strong>$options</strong>   Массив ключ=&gt;значение специфичных для драйвера настроек подключения.


id: PDO::beginTransaction
type: function
doc:
<comment>Description:</comment>
  Инициализация транзакции
    
  
  Выключает режим автоматической фиксации транзакции. В то время как режим автоматической фиксации
  выключен, изменения, внесённые в базу данных через объект экземпляра PDO, не применяются, пока вы
  не завершите транзакцию, вызвав PDO::commit. Вызов PDO::rollBack откатит все изменения в базе
  данных и вернёт соединение к режиму автоматической фиксации.
  
  Некоторые базы данных, включая MySQL, автоматически выполняют неявную фиксацию, когда выражения
  языка описания данных (DDL), такие как DROP TABLE или CREATE TABLE, находятся внутри транзакции.
  Неявная фиксация предотвратит вам откат любых изменений, сделанных в этой транзакции.

<comment>Return:</comment>
  <info>bool</info>  Возвращает <info>true</info> в случае успешного выполнения или <info>false</info> в случае возникновения ошибки.

<comment>See Also:</comment>
   * PDO::commit
   * PDO::rollBack
   * Транзакции и автоматическая фиксация


id: PDO::commit
type: function
doc:
<comment>Description:</comment>
  Фиксирует транзакцию
    
  
  Фиксирует транзакцию, возвращая соединение с базой данных в режим автоматической фиксации до тех
  пор, пока следующий вызов PDO::beginTransaction не начнёт новую транзакцию.

<comment>Return:</comment>
  <info>bool</info>  Возвращает <info>true</info> в случае успешного выполнения или <info>false</info> в случае возникновения ошибки.

<comment>See Also:</comment>
   * PDO::beginTransaction
   * PDO::rollBack
   * Транзакции и автоматическая фиксация


id: PDO::cubrid_schema
type: function
doc:
<comment>Description:</comment>
  Получить запрошенную информацию о схеме
  
  Эта функция используется для получения информации о схеме базы данных. Если необходима информация
  о конкретной таблице, то будет необходимо указать её имя в параметре <strong>$table_name</strong>. Если нужна
  информация о конкретном столбце таблицы, то его имя необходимо указать в параметре <strong>$col_name</strong>
  (может использоваться только с PDO::CUBRID_SCH_COL_PRIVILEGE).
  
  Результат будет возвращён в виде двумерного массива (столбец (ассоциативный массив) * строка
  (ассоциативный массив)). В следующей таблице приводятся типы схемы и структура столбцов
  результирующего массива, который будет возвращён в зависимости от используемого типа схемы.
  
  Состав результата каждого типаСхемаНомер столбцаИмя
  столбцаЗначениеPDO::CUBRID_SCH_TABLE1NAME2TYPE0:system table 1:view
  2:tablePDO::CUBRID_SCH_VIEW1NAME2TYPE1:viewPDO::CUBRID_SCH_QUERY_SPEC1QUERY_SPECPDO::CUBRID_SCH_ATTRIBUTE
  / PDO::CUBRID_SCH_TABLE_ATTRIBUTE1ATTR_NAME2DOMAIN3SCALE4PRECISION5INDEXED1:indexed6NOT NULL1:not
  null7SHARED1:shared8UNIQUE1:unique9DEFAULT10ATTR_ORDERbase:111CLASS_NAME12SOURCE_CLASS13IS_KEY1:keyPDO::CUBRID_SCH_METHOD
  /
  PDO::CUBRID_SCH_TABLE_METHOD1NAME2RET_DOMAIN3ARG_DOMAINPDO::CUBRID_SCH_METHOD_FILE1METHOD_FILEPDO::CUBRID_SCH_SUPER_TABLE
  / PDO::CUBRID_SCH_DIRECT_SUPER_TABLE / PDO::CUBRID_SCH_SUB_TABLE1CLASS_NAME2TYPE0:system table
  1:view 2:tablePDO::CUBRID_SCH_CONSTRAINT1TYPE0:unique 1:index 2:reverse unique 3:reverse
  index2NAME3ATTR_NAME4NUM_PAGES5NUM_KEYS6PRIMARY_KEY1:primary
  key7KEY_ORDERbase:1PDO::CUBRID_SCH_TRIGGER1NAME2STATUS3EVENT4TARGET_CLASS5TARGET_ATTR6ACTION_TIME7ACTION8PRIORITY9CONDITION_TIME10CONDITIONPDO::CUBRID_SCH_TABLE_PRIVILEGE
  / PDO::CUBRID_SCH_COL_PRIVILEGE1CLASS_NAME /
  ATTR_NAME2PRIVILEGE3GRANTABLEPDO::CUBRID_SCH_PRIMARY_KEY1CLASS_NAME2ATTR_NAME3KEY_SEQbase:14KEY_NAMEPDO::CUBRID_SCH_IMPORTED_KEYS
  / PDO::CUBRID_SCH_EXPORTED_KEYS /
  PDO::CUBRID_SCH_CROSS_REFERENCE1PKTABLE_NAME2PKCOLUMN_NAME3FKTABLE_NAMEbase:14FKCOLUMN_NAME5KEY_SEQbase:16UPDATE_ACTION0:cascade
  1:restrict 2:no action 3:set null7DELETE_ACTION0:cascade 1:restrict 2:no action 3:set
  null8FK_NAME9PK_NAME

<comment>Param:</comment>
  <info>int</info>     <strong>$schema_type</strong>  Требуемый тип схемы.
  <info>string</info>  <strong>$table_name</strong>   Имя таблицы, схему которой вы хотите получить.
  <info>string</info>  <strong>$col_name</strong>     Имя столбца, схему которой вы хотите получить.

<comment>Return:</comment>
  <info>array</info>  В случае успешного выполнения будет возвращён ассоциативный массив со схемой.
         
         В случае неудачи будет возвращено <info>false</info>


id: PDO::errorCode
type: function
doc:
<comment>Description:</comment>
  Возвращает код SQLSTATE результата последней операции с базой данных

<comment>Return:</comment>
  <info>string|null</info>  Возвращает SQLSTATE - пятисимвольный идентификатор, определённый в стандарте ANSI
               SQL-92. Первые два символа SQLSTATE отвечают за класс ошибки, а следующие три
               определяют её подкласс. Класс ошибок 01 означает предупреждение, которому сопутствует
               возвращаемый код SQL_SUCCESS_WITH_INFO. Классы отличные от 01, за исключением 'IM',
               означают ошибки выполнения запросов к базе данных. Класс 'IM' свидетельствует об
               ошибках и предупреждениях, которые вызваны самой реализацией PDO (или, возможно,
               ODBC, если используется драйвер ODBC). Значение подкласса '000' в любом классе
               означает, что подкласс для этого SQLSTATE отсутствует.
               
               PDO::errorCode выдаёт код ошибки только для операций, совершаемых с базой данных
               напрямую из PDO. Если создать объект PDOStatement методами PDO::prepare или
               PDO::query, и вызвать ошибку его методами, PDO::errorCode эту ошибку не отобразит.
               Вам нужно вызвать PDOStatement::errorCode, чтобы получить код ошибки для операции,
               выполняемой на определённом объекте PDOStatement.
               
               Возвращает <info>null</info>, если никаких операций над базой данных средствами PDO-объекта не
               производилось.

<comment>See Also:</comment>
   * PDO::errorInfo
   * PDOStatement::errorCode
   * PDOStatement::errorInfo


id: PDO::errorInfo
type: function
doc:
<comment>Description:</comment>
  Получает расширенную информацию об ошибке, произошедшей в ходе
     последнего обращения к базе данных

<comment>Return:</comment>
  <info>array</info>  PDO::errorInfo возвращает массив с информацией об ошибке, произошедшей в ходе выполнения
         последней операции с базой данных. Массив содержит как минимум следующие поля:
         ЭлементИнформация0Код ошибки SQLSTATE (пятисимвольный идентификатор, определённый в
         стандарте ANSI SQL).1Код ошибки, заданный драйвером.2Сообщение об ошибке, заданное
         драйвером
         
         Если не задан SQLSTATE код или драйвер не сообщил об ошибке, то элементы следующие за
         нулевым будут иметь значение <info>null</info>.
         
         PDO::errorInfo выдаёт информацию об ошибке только для операций, совершаемых с базой данных
         напрямую из PDO. Если создать объект PDOStatement методами PDO::prepare или PDO::query, и
         вызвать ошибку его методами, PDO::errorInfo эту ошибку не отобразит. Вам нужно вызвать
         PDOStatement::errorInfo, чтобы получить информации об ошибках для операции, выполняемой на
         определённом объекте PDOStatement.

<comment>See Also:</comment>
   * PDO::errorCode
   * PDOStatement::errorCode
   * PDOStatement::errorInfo


id: PDO::exec
type: function
doc:
<comment>Description:</comment>
  Выполняет SQL-запрос и возвращает количество затронутых строк
    
  
  Метод PDO::exec запускает SQL-запрос на выполнение и возвращает количество строк, задействованных
  в ходе его выполнения.
  
  Метод PDO::exec не возвращает результат выборки оператором SELECT. Если нужно выбрать данные этим
  оператором единожды в ходе выполнения программы, используют метод PDO::query. Если требуется
  запускать один и тот же запрос на выборку множество раз, лучше создать подготовленный запрос
  PDOStatement методом PDO::prepare, а затем запускать его методом PDOStatement::execute столько
  раз, сколько потребуется.

<comment>Param:</comment>
  <info>string</info>  <strong>$statement</strong>  SQL-выражение, которое необходимо подготовить и запустить.
                      
                      Данные внутри запроса должны быть правильно экранированы.

<comment>Return:</comment>
  <info>int|false</info>  Метод PDO::exec возвращает количество строк, которые были модифицированы или удалены в
             ходе его выполнения. Если таких строк нет, метод PDO::exec вернёт значение <return>0</return>.
             
             Эта функция может возвращать как логическое значение <info>false</info>, так и значение не типа
             boolean, которое приводится к <info>false</info>. За более подробной информацией обратитесь к
             разделу Булев тип. Используйте оператор === для проверки значения, возвращаемого этой
             функцией.
             
             В этом примере разработчик допустил ошибку, полагаясь на возвращаемый методом PDO::exec
             результат. В результате, если запрос отработал без ошибок, но не модифицировал ни одной
             строки, работа скрипта будет завершена функцией <strong>die()</strong>: exec() or
             die(print_r($db->errorInfo(), true)); // неправильно
             ?>
             ]]>

<comment>See Also:</comment>
   * PDO::prepare
   * PDO::query
   * PDOStatement::execute


id: PDO::getAttribute
type: function
doc:
<comment>Description:</comment>
  Получить атрибут соединения с базой данных
    
  
  Эта функция возвращает значение атрибута соединения с базой данных. Чтобы получить атрибуты
  PDOStatement, обратитесь к PDOStatement::getAttribute.
  
  Обратите внимание, что некоторые комбинации базы данных/драйверов могут не поддерживать всех
  атрибутов соединения с базой данных.

<comment>Param:</comment>
  <info>int</info>  <strong>$attribute</strong>  Одни из <return>PDO::ATTR_*</return> констант. Следующие общие атрибуты, применяются для
                   соединений с базами данных:
                   <return>PDO::ATTR_AUTOCOMMIT</return><return>PDO::ATTR_CASE</return><return>PDO::ATTR_CLIENT_VERSION</return><return>PDO::ATTR_CONNECTION_STATUS</return><return>PDO::ATTR_DRIVER_NAME</return><return>PDO::ATTR_ERRMODE</return><return>PDO::ATTR_ORACLE_NULLS</return><return>PDO::ATTR_PERSISTENT</return><return>PDO::ATTR_PREFETCH</return><return>PDO::ATTR_SERVER_INFO</return><return>PDO::ATTR_SERVER_VERSION</return><return>PDO::ATTR_TIMEOUT</return>
                   
                   Некоторые драйверы могут использовать собственные дополнительные атрибуты.
                   Обратите внимание, что атрибуты драйвера не должны использоваться с другими
                   драйверами.

<comment>Return:</comment>
  <info>mixed</info>  Успешный вызов возвращает значение запрашиваемого атрибута PDO. Неудачный вызов возвращает
         <return>null</return>.

<comment>See Also:</comment>
   * PDO::setAttribute
   * PDOStatement::getAttribute
   * PDOStatement::setAttribute


id: PDO::getAvailableDrivers
type: function
doc:
<comment>Description:</comment>
  Возвращает массив доступных драйверов PDO
    
  
  Эта функция возвращает все имеющиеся в настоящее время драйверы PDO, которые можно использовать в
  <strong>$DSN</strong>-параметре PDO::__construct.

<comment>Return:</comment>
  <info>array</info>  Функция PDO::getAvailableDrivers возвращает массив имён драйверов PDO. Если нет драйверов,
         то возвращается пустой массив.


id: PDO::inTransaction
type: function
doc:
<comment>Description:</comment>
  Проверяет, начата ли транзакция
    
  
  Проверяет, активна ли в данный момент транзакция в драйвере. Этот метод работает только для
  драйверов баз данных, которые поддерживают транзакции.

<comment>Return:</comment>
  <info>bool</info>  Возвращает <info>true</info>, если транзакция в данный момент активна и <info>false</info>, если нет.


id: PDO::lastInsertId
type: function
doc:
<comment>Description:</comment>
  Возвращает ID последней вставленной строки или значение последовательности
    
  
  Возвращает ID последней вставленной строки или последнее значение от объекта последовательности, в
  зависимости от базового драйвера. Например, драйвер PDO_PGSQL разрешает задать имя объекта
  последовательности для параметра <strong>$name</strong>.
  
  В зависимости от драйвера PDO этот метод может вообще не выдать осмысленного результата, так как
  база данных может не поддерживать автоматического инкремента полей или последовательностей.

<comment>Param:</comment>
  <info>string|null</info>  <strong>$name</strong>  Имя объекта последовательности, который должен выдать ID.

<comment>Return:</comment>
  <info>string|false</info>  Если объект последовательности для параметра <strong>$name</strong> не задан, метод PDO::lastInsertId
                вернёт строку, представляющую ID последней добавленной в базу записи.
                
                Если же объект последовательности для параметра <strong>$name</strong> задан, метод PDO::lastInsertId
                вернёт строку, представляющую последнее значение, полученное от этого объекта.
                
                Если PDO-драйвер не поддерживает эту возможность, метод PDO::lastInsertId запишет
                значение <return>IM001</return> в SQLSTATE.


id: PDO::pgsqlCopyFromArray
type: function
doc:
<comment>Description:</comment>
  Копировать массив PHP в таблицу
  
  Копирует данные из массива <strong>$rows</strong> в таблицу <strong>$table_name</strong> с использованием разделителя полей
  <strong>$delimiter</strong> и списка полей <strong>$fields</strong>

<comment>Param:</comment>
  <info>string</info>  <strong>$table_name</strong>  Строка с именем таблицы
  <info>array</info>   <strong>$rows</strong>        Массив строк с полями, разделёнными <strong>$delimiter</strong>
  <info>string</info>  <strong>$delimiter</strong>   Разделитель, используемый в массиве <strong>$rows</strong>
  <info>string</info>  <strong>$null_as</strong>     Как интерпретировать значения NULL
  <info>string</info>  <strong>$fields</strong>      Список полей для вставки

<comment>Return:</comment>
  <info>bool</info>  Возвращает <info>true</info> в случае успешного выполнения или <info>false</info> в случае возникновения ошибки.


id: PDO::pgsqlCopyFromFile
type: function
doc:
<comment>Description:</comment>
  Скопировать данные из файла в таблицу
  
  Копирует строки из файла <strong>$filename</strong> в таблицу <strong>$table_name</strong> используя разделитель полей <strong>$delimiter</strong> и
  список полей <strong>$fields</strong>

<comment>Param:</comment>
  <info>string</info>  <strong>$table_name</strong>  Строка с именем таблицы
  <info>string</info>  <strong>$filename</strong>    Имя файла с данными
  <info>string</info>  <strong>$delimiter</strong>   Разделитель полей, используемый в <strong>$filename</strong>
  <info>string</info>  <strong>$null_as</strong>     Как интерпретировать значения NULL
  <info>string</info>  <strong>$fields</strong>      Список полей для вставки

<comment>Return:</comment>
  <info>bool</info>  Возвращает <info>true</info> в случае успешного выполнения или <info>false</info> в случае возникновения ошибки.


id: PDO::pgsqlCopyToArray
type: function
doc:
<comment>Description:</comment>
  Выгрузить данные из таблицы в массив PHP
  
  Выгружает данные из таблицы <strong>$table</strong> в массив, используя разделитель <strong>$delimiter</strong> и список полей
  <strong>$fields</strong>

<comment>Param:</comment>
  <info>string</info>  <strong>$table_name</strong>  Строка с именем таблицы
  <info>string</info>  <strong>$delimiter</strong>   Разделитель полей
  <info>string</info>  <strong>$null_as</strong>     Как интерпретировать значения NULL
  <info>string</info>  <strong>$fields</strong>      Список полей для вставки

<comment>Return:</comment>
  <info>array|false</info>  Возвращает массив строк или <info>false</info> в случае возникновения ошибки.


id: PDO::pgsqlCopyToFile
type: function
doc:
<comment>Description:</comment>
  Выгрузка таблицы в файл
  
  Выгружает данные в файл <strong>$filename</strong> используя разделитель полей <strong>$delimiter</strong> и список полей <strong>$fields</strong>

<comment>Param:</comment>
  <info>string</info>  <strong>$table_name</strong>  Строка с именем таблицы
  <info>string</info>  <strong>$filename</strong>    Имя файла
  <info>string</info>  <strong>$delimiter</strong>   Разделитель полей, используемый в <strong>$filename</strong>
  <info>string</info>  <strong>$null_as</strong>     Как интерпретировать значения NULL
  <info>string</info>  <strong>$fields</strong>      Список полей для вставки

<comment>Return:</comment>
  <info>bool</info>  Возвращает <info>true</info> в случае успешного выполнения или <info>false</info> в случае возникновения ошибки.


id: PDO::pgsqlGetNotify
type: function
doc:
<comment>Description:</comment>
  Получить асинхронное уведомление
  
  Возвращает результирующий набор, представляющий ожидание асинхронного уведомления.

<comment>Param:</comment>
  <info>int</info>  <strong>$result_type</strong>  Формат, в котором должен вернуться результирующий набор, представленный как
                     одна из констант <info>PDO::FETCH_*</info>.
  <info>int</info>  <strong>$ms_timeout</strong>   Время ожидания ответа в миллисекундах.

<comment>Return:</comment>
  <info>array|false</info>  Если одно или больше уведомлений находятся в режиме ожидания, возвращает одну строку
               с полями <return>message</return> и <return>pid</return>, иначе возвращает <info>false</info>.


id: PDO::pgsqlGetPid
type: function
doc:
<comment>Description:</comment>
  Получает PID сервера
  
  Возвращает PID сервера.

<comment>Return:</comment>
  <info>int</info>  PID сервера.


id: PDO::pgsqlLOBCreate
type: function
doc:
<comment>Description:</comment>
  Создать новый большой объект (LOB)
  
  Функция <strong>PDO::pgsqlLOBCreate()</strong> создаёт большой объект (LOB) и возвращает его OID. Вы можете открыть
  поток для чтения или изменения объекта, используя функцию <strong>PDO::pgsqlLOBOpen()</strong>. OID можно сохранить
  в столбце типа OID и использовать как ссылку на LOB не вызывая неконтролируемого увеличения
  размера строк. LOB будет жить в базе данных пока не будет удалён с помощью функции
  <strong>PDO::pgsqlLOBUnlink()</strong>.
  
  Большие объекты могут быть до 2ГБ размером, но они очень громоздкие. Вы должны убедиться, что
  выполнили <strong>PDO::pgsqlLOBUnlink()</strong> до того, как удалите последнюю строку в вашей БД, которая
  ссылается на его OID. К тому же, большие объекты не имеют контроля доступа. В качестве
  альтернативы попробуйте использовать тип данных bytea. Последние версии PostgreSQL разрешают
  столбцы типа bytea до 1ГБ размером и прозрачно управляют табличным пространством для оптимизации
  длины строк.
  
  Эту функцию необходимо выполнять в транзакции.

<comment>Return:</comment>
  <info>string</info>  Возвращает OID созданного объекта или <info>false</info>.

<comment>See Also:</comment>
   * <strong>PDO::pgsqlLOBOpen()</strong>
   * <strong>PDO::pgsqlLOBUnlink()</strong>
   * <strong>pg_lo_create()</strong>


id: PDO::pgsqlLOBOpen
type: function
doc:
<comment>Description:</comment>
  Открывает поток для существующего большого объекта
  
  Функция <strong>PDO::pgsqlLOBOpen()</strong> открывает поток к большому объекту (LOB) заданному с помощью <strong>$oid</strong>.
  Если <strong>$mode</strong> задан как <return>r</return>, поток открывается для чтения. Если <strong>$mode</strong> задан как <return>w</return>, то для записи. Для
  манипуляции с потоком вы можете использовать обычные файловые функции, такие как <strong>fread()</strong>, <strong>fwrite()</strong>
  и <strong>fgets()</strong>.
  
  Эта функция и все манипуляции с LOB должны совершаться в транзакции.

<comment>Param:</comment>
  <info>string</info>  <strong>$oid</strong>   Идентификатор большого объекта.
  <info>string</info>  <strong>$mode</strong>  Если <return>r</return>, то поток открывается на чтение. Если <return>w</return>, то поток открывается на запись.

<comment>Return:</comment>
  <info>resource|false</info>  Возвращает ресурс потока в случае успешного выполнения или <info>false</info> в случае
                  возникновения ошибки.

<comment>See Also:</comment>
   * <strong>PDO::pgsqlLOBCreate()</strong>
   * <strong>PDO::pgsqlLOBUnlink()</strong>
   * <strong>pg_lo_open()</strong>


id: PDO::pgsqlLOBUnlink
type: function
doc:
<comment>Description:</comment>
  Удалить большой объект
  
  Удаляет большой объект (LOB) из БД по его OID.
  
  Эту функция необходимо выполнять в транзакции.

<comment>Param:</comment>
  <info>string</info>  <strong>$oid</strong>  Идентификатор LOB

<comment>Return:</comment>
  <info>bool</info>  Возвращает <info>true</info> в случае успешного выполнения или <info>false</info> в случае возникновения ошибки.

<comment>See Also:</comment>
   * <strong>PDO::pgsqlLOBOpen()</strong>
   * <strong>PDO::pgsqlLOBCreate()</strong>


id: PDO::prepare
type: function
doc:
<comment>Description:</comment>
  Подготавливает запрос к выполнению и возвращает связанный с этим запросом
     объект
    
  
  Подготавливает SQL-запрос к базе данных к запуску посредством метода PDOStatement::execute. Запрос
  может содержать именованные (:name) или неименованные (?) псевдопеременные, которые будут заменены
  реальными значениями во время запуска запроса на выполнение. Использовать одновременно и
  именованные, и неименованные псевдопеременные в одном запросе нельзя, необходимо выбрать что-то
  одно. Используйте псевдопеременные, чтобы привязать к запросу пользовательский ввод, не включайте
  данные, введённые пользователем, напрямую в запрос.
  
  Вы должны подбирать уникальные имена псевдопеременных для каждого значения, которое необходимо
  передавать в запрос при вызове PDOStatement::execute. Нельзя использовать одну псевдопеременную в
  запросе более одного раза, кроме варианта, когда включён режим эмуляции.
  
  Псевдопеременные должны представлять только единичный объем данных. Ни часть значения, ни
  служебное слово, ни имя поля, ни какую-либо произвольную часть запроса. К примеру, вы не можете
  связать псевдопеременную с несколькими значениями для вставки в конструкцию IN().
  
  Вызов PDO::prepare и PDOStatement::execute для запросов, которые будут запускаться многократно с
  различными параметрами, повышает производительность приложения, позволяя драйверу кешировать на
  клиенте и/или сервере план выполнения запроса и метаданные, а также помогает избежать
  SQL-инъекций, так как нет необходимости экранировать передаваемые параметры.
  
  Если драйвер не поддерживает подготавливаемые запросы, PDO умеет их эмулировать, а также может
  заменять псевдопеременные на то, что больше подходит, если, например, драйвер поддерживает только
  именованные или, наоборот, только неименованные псевдопеременные.
  
  Синтаксический анализатор, используемый для эмулируемых подготовленных операторов и для перезаписи
  именованных параметров или параметров стиля вопросительного знака, поддерживает нестандартные
  обратные слеши для одинарных и двойных кавычек. Это означает, что завершающие кавычки,
  непосредственно предшествующие обратной косой черте, не распознаются как таковые, что может
  привести к неправильному обнаружению параметров, что приведёт к сбою подготовленного оператора при
  его выполнении. Обходной путь — не использовать эмулированную подготовку к таким SQL-запросам и
  избегать перезаписи параметров, используя стиль параметров, который изначально поддерживается
  драйвером.
  
  Начиная с PHP 7.4.0, можно избежать экранирования вопросительных знаков, удвоив их. Это означает,
  что строка <return>??</return> будет преобразована в <return>?</return> при отправке запроса в базу данных.

<comment>Param:</comment>
  <info>string</info>  <strong>$query</strong>    Это должен быть корректный SQL-запрос с точки зрения целевой СУБД.
  <info>array</info>   <strong>$options</strong>  Этот массив содержит одну или более пар ключ=&gt;значение для установки значений
                    атрибутов объекта PDOStatement, который будет возвращён из этого метода. В
                    основном, вы будете использовать этот массив для присвоения значения
                    <return>PDO::ATTR_CURSOR</return> атрибуту <return>PDO::CURSOR_SCROLL</return>, чтобы получить прокручиваемый
                    курсор. У некоторых драйверов могут быть свои специфические настройки, которые
                    можно задать во время подготовки запроса.

<comment>Return:</comment>
  <info>PDOStatement|false</info>  Если СУБД успешно подготовила запрос, PDO::prepare возвращает объект
                      <class>PDOStatement</class>. Если подготовить запрос не удалось, PDO::prepare возвращает
                      <info>false</info> или выбрасывает исключение <class>PDOException</class> (зависит от текущего режима
                      обработки ошибок).
                      
                      Эмулируемые подготовленные запросы не создаются на сервере баз данных, поэтому
                      PDO::prepare не может проверить правильность построенного запроса.

<comment>See Also:</comment>
   * PDO::exec
   * PDO::query
   * PDOStatement::execute


id: PDO::query
type: function
doc:
<comment>Description:</comment>
  Подготавливает и выполняет выражение SQL без заполнителей
    
  
  PDO::query подготавливает и выполняет выражение SQL за один вызов функции, возвращая выражение как
  объект <class>PDOStatement</class>.
  
  Если запрос будет запускаться многократно, для улучшения производительности приложения имеет смысл
  этот запрос один раз подготовить <class>PDOStatement</class> методом PDO::prepare, а затем запускать на
  выполнение методом PDOStatement::execute столько раз, сколько потребуется.
  
  Если после выполнения предыдущего запроса вы не выбрали все данные из результирующего набора,
  следующий вызов PDO::query может потерпеть неудачу. В таких случаях следует вызывать метод
  PDOStatement::closeCursor, который освободит ресурсы базы данных, занятые предыдущим объектом
  <class>PDOStatement</class>. После этого можно безопасно вызывать PDO::query.
  
  Если <strong>$query</strong> содержит заполнители, выражение должно быть подготовлено и выполнено отдельно с
  использованием методов PDO::prepare и PDOStatement::execute.

<comment>Param:</comment>
  <info>string</info>    <strong>$query</strong>      SQL-запрос для подготовки и выполнения.
                        
                        Если SQL содержит заполнители, вместо этого метода следует использовать
                        PDO::prepare и PDOStatement::execute. В качестве альтернативы, SQL можно
                        подготовить вручную перед вызовом PDO::query, при этом данные должны быть
                        правильно отформатированы с использованием PDO::quote, если драйвер
                        поддерживает это.
  <info>int|null</info>  <strong>$fetchMode</strong>  Режим выборки по умолчанию для возвращённого <class>PDOStatement</class>. Должен быть одной
                        из констант <return>PDO::FETCH_*</return>.
                        
                        Если этот аргумент передаётся функции, остальные аргументы будут
                        обрабатываться так, как если бы PDOStatement::setFetchMode был вызван для
                        полученного объекта выражения. Последующие аргументы зависят от выбранного
                        режима выборки.

<comment>Return:</comment>
  <info>PDOStatement|false</info>  Возвращает объект <class>PDOStatement</class> или <info>false</info> в случае возникновения ошибки.

<comment>See Also:</comment>
   * PDO::exec
   * PDO::prepare
   * PDOStatement::execute


id: PDO::quote
type: function
doc:
<comment>Description:</comment>
  Заключает строку в кавычки для использования в запросе
    
  
  PDO::quote заключает строку в кавычки (если требуется) и экранирует специальные символы внутри
  строки подходящим для драйвера способом.
  
  Если вы используете эту функцию для построения SQL запросов, настоятельно рекомендуется
  пользоваться методом PDO::prepare для подготовки запроса с псевдопеременными вместо использования
  PDO::quote для вставки данных введённых пользователем в SQL запрос. Подготавливаемые запросы с
  параметрами не только компактней, удобней, устойчивей к SQL-инъекции, но и работают быстрее,
  нежели вручную построенные запросы, так как клиент и сервер могут кешировать такие запросы в уже
  скомпилированном виде.
  
  Не все драйверы PDO реализуют этот метод (особенно PDO_ODBC). Предполагается, что вместо него
  будут использоваться подготавливаемые запросы.
  
  Для корректной работы PDO::quote набор символов должен быть задан либо на сервере, либо задаваться
  самим соединением с базой данных (это зависит от драйвера). Подробнее смотрите документацию к
  драйверу базы данных.

<comment>Param:</comment>
  <info>string</info>  <strong>$string</strong>  Экранируемая строка.
  <info>int</info>     <strong>$type</strong>    Предоставляет подсказку о типе данных для драйверов, которые имеют альтернативные
                   способы экранирования. Например, <info>PDO_PARAM_LOB</info> укажет драйверу экранировать
                   двоичные данные.

<comment>Return:</comment>
  <info>string|false</info>  Возвращает экранированную строку, которую теоретически безопасно использовать в теле
                SQL запроса. Возвращает <info>false</info>, если драйвер не поддерживает экранирование.

<comment>See Also:</comment>
   * PDO::prepare
   * PDOStatement::execute


id: PDO::rollBack
type: function
doc:
<comment>Description:</comment>
  Откат транзакции
    
  
  Откатывает изменения в базе данных сделанные в рамках текущей транзакции, которая была создана
  методом PDO::beginTransaction.
  
  Если в СУБД включён режим автофиксации изменений, эта функция восстановит этот режим после отката.
  
  Некоторые СУБД, включая MySQL, автоматически неявно фиксируют изменения, когда встречаются
  выражения языка определения базы данных (DDL), выполняемые в рамках транзакции. Эта неявная
  фиксация делает невозможным откат других изменений, сделанных в рамках этой транзакции.

<comment>Return:</comment>
  <info>bool</info>  Возвращает <info>true</info> в случае успешного выполнения или <info>false</info> в случае возникновения ошибки.

<comment>See Also:</comment>
   * PDO::beginTransaction
   * PDO::commit
   * Транзакции и автофиксация изменений


id: PDO::setAttribute
type: function
doc:
<comment>Description:</comment>
  Установка атрибута
    
  
  Устанавливает атрибут объекту PDO. Некоторые основные атрибуты приведены ниже; отдельные драйверы
  могут использовать собственные дополнительные атрибуты. Обратите внимание, что атрибуты драйвера
  не должны использоваться с другими драйверами.
   <info>PDO::ATTR_CASE</info> Принудительное приведение имён столбцов к определённому регистру. Может принимать
  одно из следующих значений: <info>PDO::CASE_LOWER</info> Принудительное приведение имён столбцов к нижнему
  регистру. <info>PDO::CASE_NATURAL</info> Оставить имена столбцов в том виде, в котором их возвращает драйвер
  базы данных. <info>PDO::CASE_UPPER</info> Принудительное приведение имён столбцов к верхнему регистру.
  <info>PDO::ATTR_ERRMODE</info> Режим сообщения об ошибках PDO. Может принимать одно из следующих значений:
  <info>PDO::ERRMODE_SILENT</info> Устанавливает только коды ошибок. <info>PDO::ERRMODE_WARNING</info> Вызывает диагностику
  ошибок уровня <info>E_WARNING</info>. <info>PDO::ERRMODE_EXCEPTION</info> Выбрасывает <class>PDOException</class>. <info>PDO::ATTR_ORACLE_NULLS</info>
  Атрибут доступен для всех драйверов, а не только для Oracle.  Определяет, следует ли и как
  преобразовывать <info>null</info> и пустые строки. Может принимать одно из следующих значений:
  <info>PDO::NULL_NATURAL</info> Никакого преобразования не происходит. <info>PDO::NULL_EMPTY_STRING</info> Пустые строки
  преобразуются в <info>null</info>. <info>PDO::NULL_TO_STRING</info><info>null</info> преобразуется в пустую строку.
  <info>PDO::ATTR_STRINGIFY_FETCHES</info> Следует ли преобразовывать числовые значения в строки при выборке.
  Принимает логическое значение (<info>bool</info>): <info>true</info> для включения и <info>false</info> для выключения.
  <info>PDO::ATTR_STATEMENT_CLASS</info> Установка пользовательского класса оператора, производного от
  PDOStatement. Требуется <return>array(string classname, array(mixed constructor_args))</return>.  Не может
  использоваться с постоянными экземплярами PDO. <info>PDO::ATTR_TIMEOUT</info> Указывает продолжительность
  времени ожидания в секундах. Принимает значение в виде целого числа (<info>int</info>).  Не все драйверы
  поддерживают этот параметр и его значение может отличаться от драйвера к драйверу. Например,
  SQLite будет ждать до этого значения времени, прежде чем отказаться от получения блокировки на
  запись, но другие драйверы могут интерпретировать это как интервал ожидания соединения или чтения.
  <info>PDO::ATTR_AUTOCOMMIT</info> Доступно только для драйверов OCI, Firebird и MySQL.  Следует ли
  автоматически фиксировать каждый отдельный оператор. Принимает логическое значение (<info>bool</info>): <info>true</info>
  для включения и <info>false</info> для отключения. По умолчанию <info>true</info>. <info>PDO::ATTR_EMULATE_PREPARES</info> Доступно
  только для драйверов OCI, Firebird и MySQL.  Включить или отключить эмуляцию подготовленных
  запросов. Некоторые драйверы не поддерживают подготовленные запросы нативно или имеют ограниченную
  поддержку. Если установлено значение <info>true</info> PDO всегда будет эмулировать подготовленные запросы, в
  противном случае PDO будет пытаться использовать встроенные подготовленные запросы. Если драйвер
  не сможет успешно подготовить текущий запрос, PDO всегда будет возвращаться к эмуляции
  подготовленного запроса. <info>PDO::MYSQL_ATTR_USE_BUFFERED_QUERY</info> Доступно только для драйвера MySQL.
  Определяет, использовать ли буферизованные запросы. Принимает логическое значение (<info>bool</info>): <info>true</info> для
  включения и <info>false</info> для отключения. По умолчанию <info>true</info>. <info>PDO::ATTR_DEFAULT_FETCH_MODE</info> Устанавливает
  режим выборки по умолчанию. Описание режимов и их использования доступно в документации
  PDOStatement::fetch.
  
  Принудительное приведение имён столбцов к определённому регистру. Может принимать одно из
  следующих значений:
  
  Принудительное приведение имён столбцов к нижнему регистру.
  
  Оставить имена столбцов в том виде, в котором их возвращает драйвер базы данных.
  
  Принудительное приведение имён столбцов к верхнему регистру.
  
  Режим сообщения об ошибках PDO. Может принимать одно из следующих значений:
  
  Устанавливает только коды ошибок.
  
  Вызывает диагностику ошибок уровня <info>E_WARNING</info>.
  
  Выбрасывает <class>PDOException</class>.
  
  Атрибут доступен для всех драйверов, а не только для Oracle.
  
  Определяет, следует ли и как преобразовывать <info>null</info> и пустые строки. Может принимать одно из
  следующих значений:
  
  Никакого преобразования не происходит.
  
  Пустые строки преобразуются в <info>null</info>.
  
  <info>null</info> преобразуется в пустую строку.
  
  Следует ли преобразовывать числовые значения в строки при выборке. Принимает логическое значение
  (<info>bool</info>): <info>true</info> для включения и <info>false</info> для выключения.
  
  Установка пользовательского класса оператора, производного от PDOStatement. Требуется <return>array(string
  classname, array(mixed constructor_args))</return>.
  
  Не может использоваться с постоянными экземплярами PDO.
  
  Указывает продолжительность времени ожидания в секундах. Принимает значение в виде целого числа
  (<info>int</info>).
  
  Не все драйверы поддерживают этот параметр и его значение может отличаться от драйвера к драйверу.
  Например, SQLite будет ждать до этого значения времени, прежде чем отказаться от получения
  блокировки на запись, но другие драйверы могут интерпретировать это как интервал ожидания
  соединения или чтения.
  
  Доступно только для драйверов OCI, Firebird и MySQL.
  
  Следует ли автоматически фиксировать каждый отдельный оператор. Принимает логическое значение
  (<info>bool</info>): <info>true</info> для включения и <info>false</info> для отключения. По умолчанию <info>true</info>.
  
  Доступно только для драйверов OCI, Firebird и MySQL.
  
  Включить или отключить эмуляцию подготовленных запросов. Некоторые драйверы не поддерживают
  подготовленные запросы нативно или имеют ограниченную поддержку. Если установлено значение <info>true</info>
  PDO всегда будет эмулировать подготовленные запросы, в противном случае PDO будет пытаться
  использовать встроенные подготовленные запросы. Если драйвер не сможет успешно подготовить текущий
  запрос, PDO всегда будет возвращаться к эмуляции подготовленного запроса.
  
  Доступно только для драйвера MySQL.
  
  Определяет, использовать ли буферизованные запросы. Принимает логическое значение (<info>bool</info>): <info>true</info> для
  включения и <info>false</info> для отключения. По умолчанию <info>true</info>.
  
  Устанавливает режим выборки по умолчанию. Описание режимов и их использования доступно в
  документации PDOStatement::fetch.

<comment>Param:</comment>
  <info>int</info>    <strong>$attribute</strong>  Атрибут для изменения.
  <info>mixed</info>  <strong>$value</strong>      Значение для установки параметра <strong>$attribute</strong>, может потребовать определённого
                     типа в зависимости от атрибута.

<comment>Return:</comment>
  <info>bool</info>  Возвращает <info>true</info> в случае успешного выполнения или <info>false</info> в случае возникновения ошибки.

<comment>See Also:</comment>
   * <strong>PDO::getAttribute()</strong>
   * <strong>PDOStatement::getAttribute()</strong>
   * <strong>PDOStatement::setAttribute()</strong>


id: PDO::sqliteCreateAggregate
type: function
doc:
<comment>Description:</comment>
  Регистрация агрегирующей пользовательской функции для использования в SQL-запросах
    
  
  Эта функция является ЭКСПЕРИМЕНТАЛЬНОЙ. Поведение этой функции, её имя и относящаяся к ней
  документация могут измениться в последующих версиях PHP без уведомления. Используйте эту функцию
  на свой страх и риск.
  
  Этот метод аналогичен , за исключением того, что он регистрирует функцию, которую можно
  использовать для вычисления агрегированного результата по всем строкам в запросе.
  
  Ключевое отличие этого метода от  в том, что для управление агрегированием требует использование
  двух функций.

<comment>Param:</comment>
  <info>string</info>    <strong>$function_name</strong>  Имя функции для использовании в запросах.
  <info>callable</info>  <strong>$step_func</strong>      Функция обратного вызова для каждой строки в результирующем наборе. Ваша
                            PHP-функция должна аккумулировать результат и сохранять его в контексте
                            агрегации.
                            
                            Эта функция должна быть определена следующим образом:
                            <info>mixed</info>step<info>mixed</info><strong>$context</strong><info>int</info><strong>$rownumber</strong><info>mixed</info><strong>$value</strong><info>mixed</info><strong>$values</strong> <strong>$context</strong> Для
                            первой строки должно равняться <info>null</info>; Для всех последующих строк его
                            значение должно быть равно значению, возвращённому на предыдущем шаге;
                            вы должны использовать его для сохранения состояния агрегации.
                            <strong>$rownumber</strong> Номер текущей строки. <strong>$value</strong> Первый аргумент переданный
                            агрегатору. <strong>$values</strong> Последующие аргументы.  Возвращаемое значение
                            функции будет использовано как параметр <strong>$context</strong> при следующем запуске
                            функции, либо как значение передаваемое финализирующей функции.
                            
                            Для первой строки должно равняться <info>null</info>; Для всех последующих строк его
                            значение должно быть равно значению, возвращённому на предыдущем шаге;
                            вы должны использовать его для сохранения состояния агрегации.
                            
                            Номер текущей строки.
                            
                            Первый аргумент переданный агрегатору.
                            
                            Последующие аргументы.
  <info>mixed</info>     <strong>$context</strong>        Для первой строки должно равняться <info>null</info>; Для всех последующих строк его
                            значение должно быть равно значению, возвращённому на предыдущем шаге;
                            вы должны использовать его для сохранения состояния агрегации.
  <info>int</info>       <strong>$rownumber</strong>      Номер текущей строки.
  <info>mixed</info>     <strong>$value</strong>          Первый аргумент переданный агрегатору.
  <info>mixed</info>     <strong>$values</strong>         Последующие аргументы.
  <info>callable</info>  <strong>$finalize_func</strong>  Функция обратного вызова для вычисление итогового агрегированного
                            значения. Она будет вызвана как только все строки результирующего набора
                            будут обработаны, ей будет передан агрегирующий контекст и она вернёт
                            финальное значение. Данная функция должна вернуть значение типа
                            понятного SQLite (т.е. скалярный тип).
                            
                            Эта функция должна быть определена следующим образом:
                            <info>mixed</info>fini<info>mixed</info><strong>$context</strong><info>int</info><strong>$rowcount</strong> <strong>$context</strong> Содержит значение,
                            возвращённое самым последним вызовом агрегирующей функции step_func.
                            <strong>$rowcount</strong> Количество строк, к которым применялась агрегирующая функция.
                            Возвращаемое значение этой функции будет использовано как результат
                            агрегации.
                            
                            Содержит значение, возвращённое самым последним вызовом агрегирующей
                            функции step_func.
                            
                            Количество строк, к которым применялась агрегирующая функция.
  <info>mixed</info>     <strong>$context</strong>        Содержит значение, возвращённое самым последним вызовом агрегирующей
                            функции step_func.
  <info>int</info>       <strong>$rowcount</strong>       Количество строк, к которым применялась агрегирующая функция.
  <info>int</info>       <strong>$num_args</strong>       Подсказка для парсера SQLite, если функция обратного вызова получает
                            заданное количество аргументов.

<comment>Return:</comment>
  <info>bool</info>  Возвращает <info>true</info> в случае успешного выполнения или <info>false</info> в случае возникновения ошибки.

<comment>See Also:</comment>
   * 
   * <strong>sqlite_create_function()</strong>
   * <strong>sqlite_create_aggregate()</strong>


id: PDO::sqliteCreateCollation
type: function
doc:
<comment>Description:</comment>
  Регистрация пользовательской функции сортировки для использования в SQL-запросах
    
  
  Эта функция является ЭКСПЕРИМЕНТАЛЬНОЙ. Поведение этой функции, её имя и относящаяся к ней
  документация могут измениться в последующих версиях PHP без уведомления. Используйте эту функцию
  на свой страх и риск.

<comment>Param:</comment>
  <info>string</info>    <strong>$name</strong>      Имя функции для использовании в запросах.
  <info>callable</info>  <strong>$callback</strong>  Имя функции PHP, либо определённая пользователем функция для использования в
                       качестве функции обратного вызова и определяющая поведение при сортировке.
                       Она должна принимать две строки и возвращать -1 или 1, если первая строка
                       должна располагаться до или после второй строки соответственно, либо 0, если
                       порядок не важен.
                       
                       Эта функция должна быть определена следующим образом:
                       <info>int</info>collation<info>string</info><strong>$string1</strong><info>string</info><strong>$string2</strong>

<comment>Return:</comment>
  <info>bool</info>  Возвращает <info>true</info> в случае успешного выполнения или <info>false</info> в случае возникновения ошибки.


id: PDO::sqliteCreateFunction
type: function
doc:
<comment>Description:</comment>
  Регистрация пользовательской функции для использования в SQL-запросах
    
  
  Эта функция является ЭКСПЕРИМЕНТАЛЬНОЙ. Поведение этой функции, её имя и относящаяся к ней
  документация могут измениться в последующих версиях PHP без уведомления. Используйте эту функцию
  на свой страх и риск.
  
  Этот метод позволяет вам регистрировать функцию PHP как пользовательскую функцию SQLite (User
  Defined Function, UDF), что позволит использовать её в SQL-запросах.
  
  UDF можно использовать в любом SQL-запросе, в котором позволяется использовать функции, например
  SELECT, UPDATE, а также в триггерах.

<comment>Param:</comment>
  <info>string</info>    <strong>$function_name</strong>  Имя функции для использовании в запросах.
  <info>callable</info>  <strong>$callback</strong>       Функция обратного вызова для обработки вызовов SQL-функции.
                            
                            Функция обратного вызова должна возвращать значение понятного SQLite
                            типа (то есть скалярного типа).
                            
                            Эта функция должна быть определена следующим образом:
                            <info>mixed</info>callback<info>mixed</info><strong>$value</strong><info>mixed</info><strong>$values</strong> <strong>$value</strong> Первый аргумент передаваемый
                            в SQL-функцию. <strong>$values</strong> Последующие аргументы.
                            
                            Первый аргумент передаваемый в SQL-функцию.
                            
                            Последующие аргументы.
  <info>mixed</info>     <strong>$value</strong>          Первый аргумент передаваемый в SQL-функцию.
  <info>mixed</info>     <strong>$values</strong>         Последующие аргументы.
  <info>int</info>       <strong>$num_args</strong>       Количество аргументов, которое принимает функция. Если задать равным <return>-1</return>,
                            то функция будет принимать любое количество аргументов.
  <info>int</info>       <strong>$flags</strong>          Побитовая конъюнкция (ИЛИ) флагов. На данный момент поддерживается
                            только флаг <info>PDO::SQLITE_DETERMINISTIC</info>, который определяет то, что
                            функция всегда возвращает одинаковый результат для одинаковых входных
                            значений.

<comment>Return:</comment>
  <info>bool</info>  Возвращает <info>true</info> в случае успешного выполнения или <info>false</info> в случае возникновения ошибки.

<comment>See Also:</comment>
   * 
   * <strong>sqlite_create_function()</strong>
   * <strong>sqlite_create_aggregate()</strong>


id: PDOStatement
type: class
doc:
<comment>Description:</comment>
  Представляет подготовленный запрос к базе данных, а после выполнения запроса соответствующий
  результирующий набор.


id: PDOStatement::bindColumn
type: function
doc:
<comment>Description:</comment>
  Связывает столбец с переменной PHP
    
  
  PDOStatement::bindColumn привязывает переменную к заданному столбцу в результирующем наборе
  запроса. Каждый вызов PDOStatement::fetch или PDOStatement::fetchAll будет обновлять все
  переменные, задавать им значения столбцов, с которыми они связаны.
  
  В связи с тем, что информация о столбцах результирующего набора запроса не всегда доступна объекту
  PDO, пока запрос не будет запущен, приложениям следует вызывать этот метод после вызова
  PDOStatement::execute.
  
  Однако, при работе с драйвером PgSQL, когда привязывается столбец с LOB-данными, приложению
  необходимо вызывать этот метод до вызова PDOStatement::execute. В противном случае идентификатор
  большого объекта OID будет иметь тип integer.

<comment>Param:</comment>
  <info>string|int</info>  <strong>$column</strong>         Номер столбца (начиная с 1) или его имя в результирующем наборе
                              запроса. Используя имя столбца, имейте в виду, что имя должно быть в
                              том же регистре, в каком оно возвращено драйвером.
  <info>mixed</info>       <strong>$var</strong>            Имя переменной PHP, к которой требуется привязать столбец.
  <info>int</info>         <strong>$type</strong>           Тип данных параметра, заданный одной из констант <return>PDO::PARAM_*</return>.
  <info>int</info>         <strong>$maxLength</strong>      Подсказка для предварительного выделения памяти под переменную.
  <info>mixed</info>       <strong>$driverOptions</strong>  Дополнительные параметры для драйвера.

<comment>Return:</comment>
  <info>bool</info>  Возвращает <info>true</info> в случае успешного выполнения или <info>false</info> в случае возникновения ошибки.

<comment>See Also:</comment>
   * PDOStatement::execute
   * PDOStatement::fetch
   * PDOStatement::fetchAll
   * PDOStatement::fetchColumn


id: PDOStatement::bindParam
type: function
doc:
<comment>Description:</comment>
  Привязывает параметр запроса к переменной
    
  
  Связывает переменную PHP с именованным или неименованным параметром подготавливаемого SQL-запроса.
  В отличие от PDOStatement::bindValue, переменная привязывается по ссылке и её значение будет
  вычисляться во время вызова PDOStatement::execute.
  
  В большинстве случаев в подготавливаемых запросах используются только входные параметры, то есть
  при построении запроса доступ к ним осуществляется только в режиме чтения (возможно приведение в
  соответствии с <strong>$type</strong>). Тем не менее, некоторые драйверы позволяют запускать хранимые процедуры,
  которые, в свою очередь, могут возвращать данные посредством выходных параметров. Зачастую, такие
  параметры используются одновременно как входные и как выходные.

<comment>Param:</comment>
  <info>string|int</info>  <strong>$param</strong>          Идентификатор параметра. Для подготавливаемых запросов с именованными
                              параметрами это будет имя в виде :name. Если используются
                              неименованные параметры (знаки вопроса ?) это будет позиция
                              псевдопеременной в запросе (начиная с 1).
  <info>mixed</info>       <strong>$var</strong>            Имя переменной PHP, которую требуется привязать к параметру
                              SQL-запроса.
  <info>int</info>         <strong>$type</strong>           Явно заданный тип данных параметра. Тип задаётся одной из констант
                              <return>PDO::PARAM_*</return>. Если параметр используется, в том числе для вывода
                              информации из хранимой процедуры, к значению аргумента <strong>$type</strong>
                              необходимо добавить <info>PDO::PARAM_INPUT_OUTPUT</info>, используя оператор
                              побитовое ИЛИ.
  <info>int</info>         <strong>$maxLength</strong>      Размер типа данных. Чтобы указать, что параметр используется для
                              вывода данных из хранимой процедуры, необходимо явно задать его
                              размер. Имеет значение, только если у параметра <strong>$type</strong> установлено
                              значение <info>PDO::PARAM_INPUT_OUTPUT</info>.
  <info>mixed</info>       <strong>$driverOptions</strong>  

<comment>Return:</comment>
  <info>bool</info>  Возвращает <info>true</info> в случае успешного выполнения или <info>false</info> в случае возникновения ошибки.

<comment>See Also:</comment>
   * PDO::prepare
   * PDOStatement::execute
   * PDOStatement::bindValue


id: PDOStatement::bindValue
type: function
doc:
<comment>Description:</comment>
  Связывает параметр с заданным значением
    
  
  Задаёт значение именованной или неименованной псевдопеременной в подготовленном SQL-запросе.

<comment>Param:</comment>
  <info>string|int</info>  <strong>$param</strong>  Идентификатор параметра запроса. Для подготавливаемых запросов с именованными
                      параметрами это будет имя в виде :name. Если используются неименованные
                      параметры (знаки вопроса ?) это будет позиция псевдопеременной в запросе
                      (начиная с 1).
  <info>mixed</info>       <strong>$value</strong>  Значение, которое требуется привязать к параметру.
  <info>int</info>         <strong>$type</strong>   Явно заданный тип данных параметра. Тип задаётся одной из констант
                      <return>PDO::PARAM_*</return>.

<comment>Return:</comment>
  <info>bool</info>  Возвращает <info>true</info> в случае успешного выполнения или <info>false</info> в случае возникновения ошибки.

<comment>See Also:</comment>
   * PDO::prepare
   * PDOStatement::execute
   * PDOStatement::bindParam


id: PDOStatement::closeCursor
type: function
doc:
<comment>Description:</comment>
  Закрывает курсор, переводя запрос в состояние готовности к повторному запуску
    
  
  PDOStatement::closeCursor освобождает соединение с сервером, давая возможность запускать другие
  SQL-запросы. Метод оставляет запрос в состоянии готовности к повторному запуску.
  
  Этот метод полезен при использовании драйверов баз данных, которые не позволяют запустить
  PDOStatement, пока предыдущий объект PDOStatement не выберет все данные из результирующего набора.
  Если это ограничение распространяется на ваш драйвер, будет вызвана ошибка нарушения
  последовательности запросов (out-of-sequence error).
  
  PDOStatement::closeCursor может быть реализован как дополнительный метод конкретного драйвера
  (позволяющий добиться максимальной эффективности работы), либо как внутренний метод PDO, если
  такой функции в драйвере нет. Реализация внутреннего метода PDO семантически схожа с приведённой
  ниже: fetch()) ; if (!$stmt->nextRowset()) break;
  } while (true);
  ?>
  ]]>

<comment>Return:</comment>
  <info>bool</info>  Возвращает <info>true</info> в случае успешного выполнения или <info>false</info> в случае возникновения ошибки.

<comment>See Also:</comment>
   * PDOStatement::execute


id: PDOStatement::columnCount
type: function
doc:
<comment>Description:</comment>
  Возвращает количество столбцов в результирующем наборе
    
  
  Используйте PDOStatement::columnCount, чтобы узнать количество столбцов в результирующем наборе,
  который представляет объект PDOStatement.
  
  Если объект PDOStatement был возвращён из метода PDO::query, число столбцов можно узнать сразу же.
  
  Если объект PDOStatement был возвращён из метода PDO::prepare, точное количество столбцов можно
  будет узнать только после запуска метода PDOStatement::execute.

<comment>Return:</comment>
  <info>int</info>  Возвращает количество столбцов в результирующем наборе запроса PDOStatement, даже если он
       пуст. Если результирующего набора нет, PDOStatement::columnCount возвращает <return>0</return>.

<comment>See Also:</comment>
   * PDO::prepare
   * PDOStatement::execute
   * PDOStatement::rowCount


id: PDOStatement::debugDumpParams
type: function
doc:
<comment>Description:</comment>
  Вывод информации о подготовленной SQL-команде в целях отладки
    
  
  Выводит информацию о подготовленном запросе в выходной поток. Будет выводиться текст используемого
  <return>SQL</return> запроса, количество задействованных параметров (<return>Params</return>), список параметров с их именами ключей
  или индексами, их именами, индексами в запросе (если поддерживается в драйвере PDO, иначе -1),
  типом (<return>param_type</return>) в виде целого числа и логическое значение <return>is_param</return>.
  
  Это отладочная функция, которая направляет данные на стандартный вывод. Как и с любой другой
  функцией, осуществляющей вывод непосредственно в браузер, вы можете использовать функции контроля
  вывода, чтобы перехватывать выводимые этой функцией данные и сохранять их, например, в строку
  (<info>string</info>).
  
  Как и с любой другой функцией, осуществляющей вывод непосредственно в браузер, вы можете
  использовать функции контроля вывода, чтобы перехватывать выводимые этой функцией данные и
  сохранять их, например, в строку (<info>string</info>).
  
  Эта функция выведет информацию о параметрах запроса, существующих на момент вызова. Дополнительные
  параметры не хранятся в запросе, поэтому отображены не будут.

<comment>Return:</comment>
  <info>bool|null</info>  Возвращает <info>null</info> или <info>false</info> в случае возникновения ошибки.

<comment>See Also:</comment>
   * PDO::prepare
   * PDOStatement::bindParam
   * PDOStatement::bindValue


id: PDOStatement::errorCode
type: function
doc:
<comment>Description:</comment>
  Получает код SQLSTATE, связанный с последней операцией в объекте PDOStatement

<comment>Return:</comment>
  <info>string|null</info>  Метод идентичен PDO::errorCode за исключением того, что PDOStatement::errorCode
               возвращает коды ошибок, произошедших в результате работы объекта PDOStatement.

<comment>See Also:</comment>
   * PDO::errorCode
   * PDO::errorInfo
   * PDOStatement::errorInfo


id: PDOStatement::errorInfo
type: function
doc:
<comment>Description:</comment>
  Получение расширенной информации об ошибке, произошедшей в результате работы
     объекта PDOStatement

<comment>Return:</comment>
  <info>array</info>  PDOStatement::errorInfo возвращает массив с информацией об ошибке, соответствующей
         последней операции объекта PDOStatement. Массив состоит как минимум из следующих полей:
         ЭлементИнформация0 Код ошибки SQLSTATE (пятисимвольный код состоящий из букв и цифр,
         определённый в стандарте ANSI SQL). 1Код ошибки, возвращаемый драйвером.2Сообщение об
         ошибке, возвращаемое драйвером.

<comment>See Also:</comment>
   * PDO::errorCode
   * PDO::errorInfo
   * PDOStatement::errorCode


id: PDOStatement::execute
type: function
doc:
<comment>Description:</comment>
  Запускает подготовленный запрос на выполнение
    
  
  Запускает подготовленный запрос. Если запрос содержит маркеры параметров (псевдопеременные), вы
  должны либо: вызвать PDOStatement::bindParam и/или PDOStatement::bindValue, чтобы связать эти
  маркеры, соответственно, с переменными или значениями. Связанные переменные передают свои значения
  как входные данные и получают выходные значенияили передать массив значений только на вход
  
  вызвать PDOStatement::bindParam и/или PDOStatement::bindValue, чтобы связать эти маркеры,
  соответственно, с переменными или значениями. Связанные переменные передают свои значения как
  входные данные и получают выходные значения
  
  или передать массив значений только на вход

<comment>Param:</comment>
  <info>array|null</info>  <strong>$params</strong>  Массив значений, содержащий столько элементов, сколько параметров заявлено в
                       SQL-запросе. Все значения будут приняты, как имеющие тип <info>PDO::PARAM_STR</info>.
                       
                       Нельзя привязать несколько значений к одному параметру; например, нельзя
                       привязать два значения к именованному параметру в выражении IN().
                       
                       Нельзя привязать больше значений, чем заявлено в запросе; если в массиве
                       <strong>$params</strong> больше элементов, чем заявлено в SQL-запросе методом PDO::prepare,
                       выполнение запроса завершится неудачей и будет вызвана ошибка.

<comment>Return:</comment>
  <info>bool</info>  Возвращает <info>true</info> в случае успешного выполнения или <info>false</info> в случае возникновения ошибки.

<comment>See Also:</comment>
   * PDO::prepare
   * PDOStatement::bindParam
   * PDOStatement::fetch
   * PDOStatement::fetchAll
   * PDOStatement::fetchColumn


id: PDOStatement::fetch
type: function
doc:
<comment>Description:</comment>
  Извлечение следующей строки из результирующего набора
    
  
  Извлекает следующую строку из результирующего набора объекта PDOStatement. Параметр <strong>$mode</strong>
  определяет, в каком виде PDO вернёт эту строку.

<comment>Param:</comment>
  <info>int</info>  <strong>$mode</strong>               Определяет, в каком виде следующая строка будет возвращена в вызывающий
                           метод. Это может быть одна из констант <return>PDO::FETCH_*</return>. По умолчанию
                           <return>PDO::ATTR_DEFAULT_FETCH_MODE</return> (что равносильно <return>PDO::FETCH_BOTH</return>).
                           <return>PDO::FETCH_ASSOC</return>: возвращает массив, индексированный именами столбцов
                           результирующего набора <return>PDO::FETCH_BOTH</return> (по умолчанию): возвращает массив,
                           индексированный именами столбцов результирующего набора, а также их
                           номерами (начиная с 0) <return>PDO::FETCH_BOUND</return>: возвращает <info>true</info> и присваивает
                           значения столбцов результирующего набора переменным PHP, которые были
                           привязаны к этим столбцам методом PDOStatement::bindColumn
                           <return>PDO::FETCH_CLASS</return>: создаёт и возвращает объект запрошенного класса,
                           присваивая значения столбцов результирующего набора именованным свойствам
                           класса, и следом вызывает конструктор, если не задан
                           <return>PDO::FETCH_PROPS_LATE</return>. Если <strong>$mode</strong> включает в себя атрибут
                           PDO::FETCH_CLASSTYPE (например, <return>PDO::FETCH_CLASS | PDO::FETCH_CLASSTYPE</return>),
                           то имя класса, от которого нужно создать объект, будет взято из первого
                           столбца. <return>PDO::FETCH_INTO</return>: обновляет существующий объект запрошенного
                           класса, присваивая значения столбцов результирующего набора именованным
                           свойствам объекта <return>PDO::FETCH_LAZY</return>: комбинирует <return>PDO::FETCH_BOTH</return> и
                           <return>PDO::FETCH_OBJ</return>, создавая новый объект со свойствами, соответствующими
                           именам столбцов результирующего набора <return>PDO::FETCH_NAMED</return>: возвращает
                           массив такого же вида, как и <return>PDO::FETCH_ASSOC</return>, но, если есть несколько
                           полей с одинаковым именем, то значением с этим ключом будет массив со
                           всеми значениями из рядов, в которых это поле указано. <return>PDO::FETCH_NUM</return>:
                           возвращает массив, индексированный номерами столбцов (начиная с 0)
                           <return>PDO::FETCH_OBJ</return>: создаёт анонимный объект со свойствами, соответствующими
                           именам столбцов результирующего набора <return>PDO::FETCH_PROPS_LATE</return>: если
                           используется с <return>PDO::FETCH_CLASS</return>, конструктор класса будет вызван перед
                           назначением свойств из значений столбцов.
                           
                           <return>PDO::FETCH_ASSOC</return>: возвращает массив, индексированный именами столбцов
                           результирующего набора
                           
                           <return>PDO::FETCH_BOTH</return> (по умолчанию): возвращает массив, индексированный
                           именами столбцов результирующего набора, а также их номерами (начиная с
                           0)
                           
                           <return>PDO::FETCH_BOUND</return>: возвращает <info>true</info> и присваивает значения столбцов
                           результирующего набора переменным PHP, которые были привязаны к этим
                           столбцам методом PDOStatement::bindColumn
                           
                           <return>PDO::FETCH_CLASS</return>: создаёт и возвращает объект запрошенного класса,
                           присваивая значения столбцов результирующего набора именованным свойствам
                           класса, и следом вызывает конструктор, если не задан
                           <return>PDO::FETCH_PROPS_LATE</return>. Если <strong>$mode</strong> включает в себя атрибут
                           PDO::FETCH_CLASSTYPE (например, <return>PDO::FETCH_CLASS | PDO::FETCH_CLASSTYPE</return>),
                           то имя класса, от которого нужно создать объект, будет взято из первого
                           столбца.
                           
                           <return>PDO::FETCH_INTO</return>: обновляет существующий объект запрошенного класса,
                           присваивая значения столбцов результирующего набора именованным свойствам
                           объекта
                           
                           <return>PDO::FETCH_LAZY</return>: комбинирует <return>PDO::FETCH_BOTH</return> и <return>PDO::FETCH_OBJ</return>, создавая
                           новый объект со свойствами, соответствующими именам столбцов
                           результирующего набора
                           
                           <return>PDO::FETCH_NAMED</return>: возвращает массив такого же вида, как и
                           <return>PDO::FETCH_ASSOC</return>, но, если есть несколько полей с одинаковым именем, то
                           значением с этим ключом будет массив со всеми значениями из рядов, в
                           которых это поле указано.
                           
                           <return>PDO::FETCH_NUM</return>: возвращает массив, индексированный номерами столбцов
                           (начиная с 0)
                           
                           <return>PDO::FETCH_OBJ</return>: создаёт анонимный объект со свойствами, соответствующими
                           именам столбцов результирующего набора
                           
                           <return>PDO::FETCH_PROPS_LATE</return>: если используется с <return>PDO::FETCH_CLASS</return>, конструктор
                           класса будет вызван перед назначением свойств из значений столбцов.
  <info>int</info>  <strong>$cursorOrientation</strong>  Для объектов PDOStatement представляющих прокручиваемый курсор, этот
                           параметр определяет, какая строка будет возвращаться в вызывающий метод.
                           Значением параметра должна быть одна из констант <return>PDO::FETCH_ORI_*</return>, по
                           умолчанию <return>PDO::FETCH_ORI_NEXT</return>. Чтобы запросить прокручиваемый курсор для
                           запроса PDOStatement, необходимо задать атрибут <return>PDO::ATTR_CURSOR</return> со
                           значением <return>PDO::CURSOR_SCROLL</return> во время подготовки запроса методом
                           PDO::prepare.
  <info>int</info>  <strong>$cursorOffset</strong>       Для объектов PDOStatement, представляющих прокручиваемый курсор, параметр
                           <strong>$cursorOrientation</strong> которых принимает значение <return>PDO::FETCH_ORI_ABS</return>, эта
                           величина означает абсолютный номер строки, которую необходимо извлечь из
                           результирующего набора.
                           
                           Для объектов PDOStatement, представляющих прокручиваемый курсор, параметр
                           <strong>$cursorOrientation</strong> которых принимает значение <return>PDO::FETCH_ORI_REL</return>, эта
                           величина указывает, какая строка относительно текущего положения курсора
                           будет извлечена функцией PDOStatement::fetch.

<comment>Return:</comment>
  <info>mixed</info>  В случае успешного выполнения функции возвращаемое значение зависит от режима выборки. В
         случае возникновения ошибки или если больше нет строк, функция возвращает <info>false</info>.

<comment>See Also:</comment>
   * PDO::prepare
   * PDOStatement::execute
   * PDOStatement::fetchAll
   * PDOStatement::fetchColumn
   * PDOStatement::fetchObject
   * PDOStatement::setFetchMode


id: PDOStatement::fetchAll
type: function
doc:
<comment>Description:</comment>
  Выбирает оставшиеся строки из набора результатов

<comment>Param:</comment>
  <info>int</info>         <strong>$mode</strong>             Определяет содержимое возвращаемого массива. Подробней можно узнать
                                из документации к методу PDOStatement::fetch. По умолчанию параметр
                                принимает значение <info>PDO::ATTR_DEFAULT_FETCH_MODE</info> (которое в свою
                                очередь имеет умолчание <info>PDO::FETCH_BOTH</info>)
                                
                                Чтобы извлечь значения только одного столбца, передайте в качестве
                                значения этого параметра константу <info>PDO::FETCH_COLUMN</info>. С помощью
                                параметра <strong>$column</strong> можно задать столбец, из которого требуется
                                извлечь данные.
                                
                                Если требуется извлечь только уникальные строки одного столбца,
                                нужно передать побитовое ИЛИ констант <info>PDO::FETCH_COLUMN</info> и
                                <info>PDO::FETCH_UNIQUE</info>.
                                
                                Чтобы получить ассоциативный массив строк сгруппированный по
                                значениям определённого столбца, нужно передать побитовое ИЛИ
                                констант <info>PDO::FETCH_COLUMN</info> и <info>PDO::FETCH_GROUP</info>.
  <info>int</info>         <strong>$column</strong>           Используется с <info>PDO::FETCH_COLUMN</info>. Возвращает указанный столбец с
                                индексом, начинающимся с 0.
  <info>string</info>      <strong>$class</strong>            Используется с <info>PDO::FETCH_CLASS</info>. Возвращает экземпляры указанного
                                класса, сопоставляя столбцы каждой строки с именованными свойствами
                                класса.
  <info>array|null</info>  <strong>$constructorArgs</strong>  Аргументы конструктора пользовательского класса, когда параметр
                                <strong>$mode</strong> равен <info>PDO::FETCH_CLASS</info>.
  <info>callable</info>    <strong>$callback</strong>         Используется с <info>PDO::FETCH_FUNC</info>. Возвращает результаты вызова
                                указанной функции, используя столбцы каждой строки в качестве
                                параметров вызова.

<comment>Return:</comment>
  <info>array</info>  Метод PDOStatement::fetchAll возвращает массив, содержащий все оставшиеся строки
         результирующего набора. Массив представляет каждую строку либо в виде массива значений
         одного столбца, либо в виде объекта, имена свойств которого совпадают с именами столбцов.
         
         Использование этого метода для извлечения строк больших результирующих наборов может
         пагубно сказаться на производительности системы и сетевых ресурсов. Вместо извлечения всех
         данных и их обработки в PHP рекомендуется использовать встроенные средства СУБД. Например,
         использование выражений WHERE и ORDER BY языка SQL может уменьшить размеры результирующего
         набора.

<comment>See Also:</comment>
   * PDO::query
   * PDOStatement::fetch
   * PDOStatement::fetchColumn
   * PDO::prepare
   * PDOStatement::setFetchMode


id: PDOStatement::fetchColumn
type: function
doc:
<comment>Description:</comment>
  Возвращает данные одного столбца следующей строки результирующего набора
    
  
  Возвращает данные одного столбца следующей строки результирующей таблицы. Если в результате
  запроса строк больше нет, функция вернёт <info>false</info>.
  
  Не следует использовать PDOStatement::fetchColumn для получения булевых полей, так как невозможно
  отличить значение <info>false</info> от отсутствия оставшихся строк результата. Вместо этого используйте метод
  PDOStatement::fetch.

<comment>Param:</comment>
  <info>int</info>  <strong>$column</strong>  Номер столбца, данные которого необходимо извлечь. Нумерация начинается с 0. Если
                параметр не задан, PDOStatement::fetchColumn выберет данные первого столбца.

<comment>Return:</comment>
  <info>mixed</info>  Метод PDOStatement::fetchColumn возвращает значение одного столбца следующей строки
         результирующего набора или <info>false</info>, если больше нет строк.
         
         При вызове метода PDOStatement::fetchColumn для извлечения данных из результирующего набора
         невозможно получить значение другого столбца той же строки.

<comment>See Also:</comment>
   * PDO::query
   * PDOStatement::fetch
   * PDOStatement::fetchAll
   * PDO::prepare
   * PDOStatement::setFetchMode


id: PDOStatement::fetchObject
type: function
doc:
<comment>Description:</comment>
  Извлекает следующую строку и возвращает её в виде объекта
    
  
  Извлекает следующую строку и возвращает её в виде объекта. Этот метод является альтернативой
  вызову PDOStatement::fetch с параметром <info>PDO::FETCH_CLASS</info> или <info>PDO::FETCH_OBJ</info>.
  
  Когда объект извлечён, его свойства наполняются значениями соответствующих столбцов, и, после
  этого, вызывается его конструктор.

<comment>Param:</comment>
  <info>string|null</info>  <strong>$class</strong>            Имя класса создаваемого объекта.
  <info>array</info>        <strong>$constructorArgs</strong>  Элементы этого массива будут переданы в конструктор класса.

<comment>Return:</comment>
  <info>object|false</info>  Возвращает новый объект указанного класса, имена свойств которого соответствуют
                именам столбцов результирующего набора или <info>false</info> в случае возникновения ошибки.

<comment>See Also:</comment>
   * PDOStatement::fetch


id: PDOStatement::getAttribute
type: function
doc:
<comment>Description:</comment>
  Получение значения атрибута запроса PDOStatement
    
  
  Получает значение атрибута запроса. На данный момент не существует общих атрибутов, есть только
  характерные для конкретного драйвера: <return>PDO::ATTR_CURSOR_NAME</return> (для Firebird и ODBC): Получение имени
  курсора для запроса <return>UPDATE ... WHERE CURRENT OF</return>.  Обратите внимание, что атрибуты драйвера не
  должны использоваться с другими драйверами.
  
  <return>PDO::ATTR_CURSOR_NAME</return> (для Firebird и ODBC): Получение имени курсора для запроса <return>UPDATE ... WHERE
  CURRENT OF</return>.

<comment>Param:</comment>
  <info>int</info>  <strong>$name</strong>  Атрибут для запроса.

<comment>Return:</comment>
  <info>mixed</info>  Возвращает значение атрибута.

<comment>See Also:</comment>
   * PDO::getAttribute
   * PDO::setAttribute
   * PDOStatement::setAttribute


id: PDOStatement::getColumnMeta
type: function
doc:
<comment>Description:</comment>
  Возвращает метаданные столбца в результирующей таблице
    
  
  Возвращает метаданные столбца результирующей таблицы в виде ассоциативного массива. Индексация
  столбцов начинается с 0.
  
  Некоторые драйверы PDO могут не реализуют функцию PDOStatement::getColumnMeta, поскольку она
  является необязательной. Однако все драйверы PDO, указанные в руководстве, реализуют эту функцию.

<comment>Param:</comment>
  <info>int</info>  <strong>$column</strong>  Индекс (начиная с 0) столбца результирующего набора.

<comment>Return:</comment>
  <info>array|false</info>  Возвращает ассоциативный массив, содержащий следующие значения метаданных:
               
               Возвращает <info>false</info> в случаях, когда указанного столбца нет в результирующей таблице, а
               также если не существует самого результирующего набора.

<comment>See Also:</comment>
   * PDOStatement::columnCount
   * PDOStatement::rowCount


id: PDOStatement::getIterator
type: function
doc:
<comment>Description:</comment>
  Получает итератор набора результатов
  
  К настоящему времени эта функция ещё не была документирована; для ознакомления доступен только
  список аргументов.

<comment>Return:</comment>
  <info>Iterator</info>  


id: PDOStatement::nextRowset
type: function
doc:
<comment>Description:</comment>
  Переход к следующему набору строк в результате запроса
    
  
  Некоторые СУБД поддерживают хранимые процедуры, которые возвращают более одного набора строк (его
  ещё называют результирующим набором). PDOStatement::nextRowset позволяет получить доступ ко
  второму и дальнейшим наборам, соответствующим объекту PDOStatement. Разные наборы строк могут
  иметь разное количество столбцов.

<comment>Return:</comment>
  <info>bool</info>  Возвращает <info>true</info> в случае успешного выполнения или <info>false</info> в случае возникновения ошибки.

<comment>See Also:</comment>
   * PDOStatement::columnCount
   * PDOStatement::execute
   * PDOStatement::getColumnMeta
   * PDO::query


id: PDOStatement::rowCount
type: function
doc:
<comment>Description:</comment>
  Возвращает количество строк, затронутых последним SQL-запросом
    
  
  PDOStatement::rowCount возвращает количество строк, которые были затронуты в ходе выполнения
  последнего запроса DELETE, INSERT или UPDATE, запущенного соответствующим объектом <return>PDOStatement</return>.
  
  Для операторов, создающих наборы результатов, таких как <return>SELECT</return>, поведение не определено и может
  быть различным для каждого драйвера. Некоторые базы данных могут возвращать количество строк,
  созданных этим оператором (например, MySQL в буферизованном режиме), но такое поведение не
  гарантируется для всех баз данных и не должно использоваться в переносимых приложениях.
  
  Этот метод всегда возвращает "0" (ноль) с драйвером SQLite, а с драйвером PostgreSQL только при
  установке атрибута оператора <info>PDO::ATTR_CURSOR</info> равным <info>PDO::CURSOR_SCROLL</info>.

<comment>Return:</comment>
  <info>int</info>  Возвращает количество строк.

<comment>See Also:</comment>
   * PDOStatement::columnCount
   * PDOStatement::fetchColumn
   * PDO::query


id: PDOStatement::setAttribute
type: function
doc:
<comment>Description:</comment>
  Устанавливает атрибут объекту PDOStatement
    
  
  Задаёт атрибут объекта PDOStatement. На данный момент никаких общих атрибутов устанавливать
  нельзя, только характерные для конкретного драйвера: <return>PDO::ATTR_CURSOR_NAME</return> (для Firebird и ODBC):
  Задаёт имя курсора для запросов вида <return>UPDATE ... WHERE CURRENT OF</return>.  Обратите внимание, что атрибуты
  драйвера не должны использоваться с другими драйверами.
  
  <return>PDO::ATTR_CURSOR_NAME</return> (для Firebird и ODBC): Задаёт имя курсора для запросов вида <return>UPDATE ... WHERE
  CURRENT OF</return>.

<comment>Param:</comment>
  <info>int</info>    <strong>$attribute</strong>  Атрибут для изменения.
  <info>mixed</info>  <strong>$value</strong>      Значение для установки параметра <strong>$attribute</strong> может потребовать определённого
                     типа в зависимости от атрибута.

<comment>Return:</comment>
  <info>bool</info>  Возвращает <info>true</info> в случае успешного выполнения или <info>false</info> в случае возникновения ошибки.

<comment>See Also:</comment>
   * PDO::getAttribute
   * PDO::setAttribute
   * PDOStatement::getAttribute


id: PDOStatement::setFetchMode
type: function
doc:
<comment>Description:</comment>
  Устанавливает режим выборки по умолчанию для объекта запроса

<comment>Param:</comment>
  <info>int</info>         <strong>$mode</strong>             Режим выборки можно задавать только одной из констант <return>PDO::FETCH_*</return>.
  <info>int</info>         <strong>$colno</strong>            Номер столбца.
  <info>string</info>      <strong>$class</strong>            Имя класса.
  <info>array|null</info>  <strong>$constructorArgs</strong>  Аргументы конструктора класса.
  <info>object</info>      <strong>$object</strong>           Объект.

<comment>Return:</comment>
  <info>bool</info>  Возвращает <info>true</info> в случае успешного выполнения или <info>false</info> в случае возникновения ошибки.


id: PGSQL_ASSOC
type: constant
doc:
<comment>Description:</comment>
  Передаётся в функцию <strong>pg_fetch_array()</strong>. Возвращает ассоциативный массив 'имя поля' =&gt; 'значение
  поля'.


id: PGSQL_BAD_RESPONSE
type: constant
doc:
<comment>Description:</comment>
  Возвращается функцией <strong>pg_result_status()</strong>. Сообщает, что ответ от сервера не был распознан.


id: PGSQL_BOTH
type: constant
doc:
<comment>Description:</comment>
  Передаётся в функцию <strong>pg_fetch_array()</strong>. Возвращает массив значений поля, нумерованный (по номеру
  поля) и ассоциативный (по имени поля).


id: PGSQL_COMMAND_OK
type: constant
doc:
<comment>Description:</comment>
  Возвращается функцией <strong>pg_result_status()</strong>. Означает успешное завершение команды, не возвращающей
  данных.


id: PGSQL_CONNECTION_BAD
type: constant
doc:
<comment>Description:</comment>
  Возвращается функцией <strong>pg_connection_status()</strong>, указывает на неработоспособность соединения с базой
  данных.


id: PGSQL_CONNECTION_OK
type: constant
doc:
<comment>Description:</comment>
  Возвращается функцией <strong>pg_connection_status()</strong>, указывает на нормальное (рабочее) состояние
  соединения с базой данных.


id: PGSQL_CONNECT_ASYNC
type: constant
doc:
<comment>Description:</comment>
  Передаётся в <strong>pg_connect()</strong> для создания асинхронного соединения.


id: PGSQL_CONNECT_FORCE_NEW
type: constant
doc:
<comment>Description:</comment>
  Передаётся в функцию <strong>pg_connect()</strong> для принудительного создания нового подключения вместо
  использования идентичного существующего.


id: PGSQL_CONV_FORCE_NULL
type: constant
doc:
<comment>Description:</comment>
  Передаётся в <strong>pg_convert()</strong>. Заменять пустые строки  <info>string</info> на SQL <return>NULL</return> при преобразовании.


id: PGSQL_CONV_IGNORE_DEFAULT
type: constant
doc:
<comment>Description:</comment>
  Передаётся в <strong>pg_convert()</strong>. Игнорировать значения по умолчанию в таблице в процессе преобразования.


id: PGSQL_CONV_IGNORE_NOT_NULL
type: constant
doc:
<comment>Description:</comment>
  Передаётся в <strong>pg_convert()</strong>. Указывает, что не нужно конвертировать <info>null</info> в столбцы SQL <return>NOT NULL</return>.


id: PGSQL_COPY_IN
type: constant
doc:
<comment>Description:</comment>
  Возвращается функцией <strong>pg_result_status()</strong>. Сообщает, чтобы начато копирование данных на сервер.


id: PGSQL_COPY_OUT
type: constant
doc:
<comment>Description:</comment>
  Возвращается функцией <strong>pg_result_status()</strong>. Сообщает, что было начато копирование данных с сервера.


id: PGSQL_DIAG_CONTEXT
type: constant
doc:
<comment>Description:</comment>
  Передаётся в <strong>pg_result_error_field()</strong>. Указание на контекст, где произошла ошибка. В основном
  содержит трассировку запрограммированных функций и автоматически сгенерированных запросов.
  Трассировка выводится построчно, начиная с последней строки.


id: PGSQL_DIAG_INTERNAL_POSITION
type: constant
doc:
<comment>Description:</comment>
  Передаётся в <strong>pg_result_error_field()</strong>. Определение тоже, что и для поля <info>PG_DIAG_STATEMENT_POSITION</info>,
  но используется в случаях, когда курсор указывает на команду, сгенерированную сервером БД. В таких
  случаях всегда появляется поле <info>PG_DIAG_INTERNAL_QUERY</info>.


id: PGSQL_DIAG_INTERNAL_QUERY
type: constant
doc:
<comment>Description:</comment>
  Передаётся в <strong>pg_result_error_field()</strong>. Текст ошибки, сгенерированной внутренней командой СУБД, в
  которой произошла ошибка. Это может быть, например, SQL-запрос, сформированный функцией PL/pgSQL.


id: PGSQL_DIAG_MESSAGE_DETAIL
type: constant
doc:
<comment>Description:</comment>
  Передаётся в <strong>pg_result_error_field()</strong>. Детализация: дополнительное сообщение об ошибке, содержащее
  более подробную информацию о проблеме. Может содержать несколько строк.


id: PGSQL_DIAG_MESSAGE_HINT
type: constant
doc:
<comment>Description:</comment>
  Передаётся в <strong>pg_result_error_field()</strong>. Подсказка: указание на возможные пути устранения ошибки.
  Отличается от детализации ошибки тем, что это просто предложения (возможно ошибочные), а не точная
  информация. Может содержать несколько строк.


id: PGSQL_DIAG_MESSAGE_PRIMARY
type: constant
doc:
<comment>Description:</comment>
  Передаётся в <strong>pg_result_error_field()</strong>. Основное удобочитаемое сообщение об ошибке (обычно одна
  строка). Поле всегда определено.


id: PGSQL_DIAG_SEVERITY
type: constant
doc:
<comment>Description:</comment>
  Передаётся в функцию <strong>pg_result_error_field()</strong>. Сообщает о затруднении. Возможны лишь перечисленные
  значения: <return>ERROR</return>, <return>FATAL</return>, или <return>PANIC</return> (в сообщении об ошибке), либо <return>WARNING</return>, <return>NOTICE</return>, <return>DEBUG</return>, <return>INFO</return>, или
  <return>LOG</return> (в уведомлении), либо перевод перечисленных значений в соответствии с используемой
  локализацией. Поле всегда определено.


id: PGSQL_DIAG_SEVERITY_NONLOCALIZED
type: constant
doc:
<comment>Description:</comment>
  Важность; Возможны следующие значения: ERROR, FATAL или PANIC (в сообщении ошибке), либо WARNING,
  NOTICE, DEBUG, INFO или LOG (в сообщении предупреждении). Это идентично полю PG_DIAG_SEVERITY за
  исключением того, содержимое не локализовано. Доступно только в версии 9.6 или новее / PHP 7.3.0
  или новее.


id: PGSQL_DIAG_SOURCE_FILE
type: constant
doc:
<comment>Description:</comment>
  Передаётся в <strong>pg_result_error_field()</strong>. Имя файла исходного кода PostgreSQL, в котором отмечена
  ошибка.


id: PGSQL_DIAG_SOURCE_FUNCTION
type: constant
doc:
<comment>Description:</comment>
  Передаётся в <strong>pg_result_error_field()</strong>. Имя функции в исходном коде PostgreSQL, сообщающей об
  ошибке.


id: PGSQL_DIAG_SOURCE_LINE
type: constant
doc:
<comment>Description:</comment>
  Передаётся в <strong>pg_result_error_field()</strong>. Номер строки файла исходного кода PostgreSQL, где отмечена
  ошибка.


id: PGSQL_DIAG_SQLSTATE
type: constant
doc:
<comment>Description:</comment>
  Передаётся в <strong>pg_result_error_field()</strong>. Код ошибки SQLSTATE. Код SQLSTATE определяет тип
  произошедшей ошибки; он может быть использован прикладной программой при выполнении специфических
  операций (таких как обработка ошибки) в ответ на ошибку базы данных. Это поле всегда определено и
  его значение не зависит от локализации.


id: PGSQL_DIAG_STATEMENT_POSITION
type: constant
doc:
<comment>Description:</comment>
  Передаётся в <strong>pg_result_error_field()</strong>. Строка, содержащая десятичное целое число, указывающее на
  позицию курсора в исходном выражении, где произошла ошибка. Первый символ имеет индекс 1, позиции
  исчисляются в символах, а не в байтах.


id: PGSQL_DML_ASYNC
type: constant
doc:
<comment>Description:</comment>
  Передаётся в <strong>pg_insert()</strong>, <strong>pg_select()</strong>, <strong>pg_update()</strong> и <strong>pg_delete()</strong>. Выполнить асинхронный запрос с
  помощью этих функций.


id: PGSQL_DML_ESCAPE
type: constant
doc:
<comment>Description:</comment>
  Передаётся в <strong>pg_insert()</strong>, <strong>pg_select()</strong>, <strong>pg_update()</strong> и <strong>pg_delete()</strong>. Применить экранирование ко всем
  параметрам вместо внутреннего вызова <strong>pg_convert()</strong>. Эта опция пропускает просмотр метаданных.
  Запрос может быть таким же быстрым, как и <strong>pg_query()</strong> и <strong>pg_send_query()</strong>.


id: PGSQL_DML_EXEC
type: constant
doc:
<comment>Description:</comment>
  Передаётся в <strong>pg_insert()</strong>, <strong>pg_select()</strong>, <strong>pg_update()</strong> и <strong>pg_delete()</strong>. Выполнить запрос с помощью этих
  функций.


id: PGSQL_DML_NO_CONV
type: constant
doc:
<comment>Description:</comment>
  Передаётся в <strong>pg_insert()</strong>, <strong>pg_select()</strong>, <strong>pg_update()</strong> и <strong>pg_delete()</strong>. Все параметры передаются в
  исходном виде. Ручное экранирование обязательно, если параметры содержат пользовательские данные.
  Используйте для этих целей <strong>pg_escape_string()</strong>.


id: PGSQL_DML_STRING
type: constant
doc:
<comment>Description:</comment>
  Передаётся в <strong>pg_insert()</strong>, <strong>pg_select()</strong>, <strong>pg_update()</strong> и <strong>pg_delete()</strong>. Вернуть строку с выполненным
  запросом.


id: PGSQL_EMPTY_QUERY
type: constant
doc:
<comment>Description:</comment>
  Возвращается функцией <strong>pg_result_status()</strong>. Означает, что отправленная на сервер строка была пустой.


id: PGSQL_ERRORS_DEFAULT
type: constant
doc:
<comment>Description:</comment>
  Передаётся в <strong>pg_set_error_verbosity()</strong>. В режиме по умолчанию сообщения об ошибках содержат
  описанную выше информацию, а также детализацию, подсказку или поля с контекстом ошибки (могут
  занимать несколько строк).


id: PGSQL_ERRORS_TERSE
type: constant
doc:
<comment>Description:</comment>
  Передаётся в <strong>pg_set_error_verbosity()</strong>. Даёт предписание, что выдаваемые сообщения будут содержать
  только важность ошибки, основной текст и указатель на место, где она произошла; эта информация
  обычно умещается в одну строку.


id: PGSQL_ERRORS_VERBOSE
type: constant
doc:
<comment>Description:</comment>
  Передаётся в <strong>pg_set_error_verbosity()</strong>. Задаёт режим, в котором в сообщения будут включены все
  возможные поля.


id: PGSQL_FATAL_ERROR
type: constant
doc:
<comment>Description:</comment>
  Возвращается функцией <strong>pg_result_status()</strong>. Сообщает, что произошла критическая ошибка.


id: PGSQL_LIBPQ_VERSION
type: constant
doc:
<comment>Description:</comment>
  Короткое обозначение версии libpq, содержащее только цифры и точки.


id: PGSQL_LIBPQ_VERSION_STR
type: constant
doc:
<comment>Description:</comment>
  До PHP 8.0.0 - длинное обозначение версии libpq, которое включает информацию о компиляторе.
  Начиная с PHP 8.0.0, значение идентично <info>PGSQL_LIBPQ_VERSION</info>, а использование
  <info>PGSQL_LIBPQ_VERSION_STR</info> устарело.


id: PGSQL_NONFATAL_ERROR
type: constant
doc:
<comment>Description:</comment>
  Возвращается функцией <strong>pg_result_status()</strong>. Сообщает, что произошла некритическая (уведомление или
  предупреждение) ошибка.


id: PGSQL_NOTICE_ALL
type: constant
doc:
<comment>Description:</comment>
  Используется <strong>pg_last_notice()</strong>. Доступно с PHP 7.1.0.


id: PGSQL_NUM
type: constant
doc:
<comment>Description:</comment>
  Передаётся в функцию <strong>pg_fetch_array()</strong>. Возвращает нумерованный массив 'номер поля' =&gt; 'значение
  поля'.


id: PGSQL_POLLING_ACTIVE
type: constant
doc:
<comment>Description:</comment>
  Возвращается функцией <strong>pg_connect_poll()</strong> и указывает на то, что соединение сейчас активно.


id: PGSQL_POLLING_FAILED
type: constant
doc:
<comment>Description:</comment>
  Возвращается функцией <strong>pg_connect_poll()</strong> и указывает на то, что попытка соединения провалилась.


id: PGSQL_POLLING_OK
type: constant
doc:
<comment>Description:</comment>
  Возвращается функцией <strong>pg_connect_poll()</strong> и указывает на то, что соединение готово к использованию.


id: PGSQL_POLLING_READING
type: constant
doc:
<comment>Description:</comment>
  Возвращается функцией <strong>pg_connect_poll()</strong> и указывает на то, что соединение ожидает, когда сокет
  PostgreSQL станет доступным для чтения.


id: PGSQL_POLLING_WRITING
type: constant
doc:
<comment>Description:</comment>
  Возвращается функцией <strong>pg_connect_poll()</strong> и указывает на то, что соединение ожидает, когда сокет
  PostgreSQL станет доступным для записи.


id: PGSQL_SEEK_CUR
type: constant
doc:
<comment>Description:</comment>
  Передаётся в функцию <strong>pg_lo_seek()</strong>. Операция поиска начнёт работу с текущей позиции.


id: PGSQL_SEEK_END
type: constant
doc:
<comment>Description:</comment>
  Передаётся в функцию <strong>pg_lo_seek()</strong>. Операция поиска начнёт работу с конца объекта.


id: PGSQL_SEEK_SET
type: constant
doc:
<comment>Description:</comment>
  Передаётся в функцию <strong>pg_lo_seek()</strong>. Операция поиска начнёт работу с начала объекта.


id: PGSQL_STATUS_LONG
type: constant
doc:
<comment>Description:</comment>
  Передаётся в <strong>pg_result_status()</strong>. Указывает на то, что в качестве возвращаемого значения ожидается
  числовой код.


id: PGSQL_STATUS_STRING
type: constant
doc:
<comment>Description:</comment>
  Передаётся в <strong>pg_result_status()</strong>.  Указывает на то, что в качестве возвращаемого значения ожидается
  текстовое представление статуса.


id: PGSQL_TRANSACTION_ACTIVE
type: constant
doc:
<comment>Description:</comment>
  Возвращается функцией <strong>pg_transaction_status()</strong>. Означает состояние, когда команда находится в
  процессе выполнения. Запрос через соединение отправлен, но выполнение ещё не завершено.


id: PGSQL_TRANSACTION_IDLE
type: constant
doc:
<comment>Description:</comment>
  Возвращается функцией <strong>pg_transaction_status()</strong>. Означает, что соединение на данный момент
  бездействует и не находится в рамках транзакции.


id: PGSQL_TRANSACTION_INERROR
type: constant
doc:
<comment>Description:</comment>
  Возвращается функцией <strong>pg_transaction_status()</strong>. Означает, что соединение простаивает и находится в
  рамках транзакции потерпевшей неудачу при выполнении.


id: PGSQL_TRANSACTION_INTRANS
type: constant
doc:
<comment>Description:</comment>
  Возвращается функцией <strong>pg_transaction_status()</strong>. Означает, что соединение простаивает и находится в
  рамках транзакции.


id: PGSQL_TRANSACTION_UNKNOWN
type: constant
doc:
<comment>Description:</comment>
  Возвращается функцией <strong>pg_transaction_status()</strong>. Означает, что соединение разорвано.


id: PGSQL_TUPLES_OK
type: constant
doc:
<comment>Description:</comment>
  Возвращается функцией <strong>pg_result_status()</strong>. Означает успешное завершение команды, возвращающей
  какие-либо данные (например, <return>SELECT</return> или <return>SHOW</return>).


id: PHP_BINARY
type: constant
doc:
<comment>Description:</comment>
  Указывает путь к исполняемым файлам PHP во время выполнения скрипта.


id: PHP_BINDIR
type: constant
doc:
<comment>Description:</comment>
  Значение --bindir было установлено при настройке. В Windows это значение --with-prefix было
  установлено при настройке.


id: PHP_EOL
type: constant
doc:
<comment>Description:</comment>
  Корректный символ конца строки, используемый на данной платформе.


id: PHP_EXTENSION_DIR
type: constant
doc:
<comment>Description:</comment>
  Каталог по умолчанию, в котором следует искать динамически загружаемые модули (если он не
  переопределён в extension_dir). По умолчанию используется <info>PHP_PREFIX</info> (или PHP_PREFIX . "\\ext" в
  Windows).


id: PHP_EXTRA_VERSION
type: constant
doc:
<comment>Description:</comment>
  Текущая "экстра"-версия PHP в виде строки (например, '-extra' для версии "5.2.7-extra"). Обычно
  используется в различных дистрибутивах для индикации версий пакетов.


id: PHP_FD_SETSIZE
type: constant
doc:
<comment>Description:</comment>
  Максимальное количество файловых дескрипторов для системных вызовов. Доступно с PHP 7.1.0.


id: PHP_FLOAT_DIG
type: constant
doc:
<comment>Description:</comment>
  Количество десятичных цифр, которые могут быть округлены в <info>float</info> и обратно без потери точности.
  Доступно с PHP 7.2.0.


id: PHP_FLOAT_EPSILON
type: constant
doc:
<comment>Description:</comment>
  Наименьшее положительное число x, такое, что <return>x + 1.0 != 1.0</return>. Доступно с PHP 7.2.0.


id: PHP_FLOAT_MAX
type: constant
doc:
<comment>Description:</comment>
  Максимальное возможное число типа <info>float</info>. Доступно с PHP 7.2.0.


id: PHP_FLOAT_MIN
type: constant
doc:
<comment>Description:</comment>
  Наименьшее возможное положительное число типа <info>float</info>. Если вам нужно наименьшее возможное
  отрицательное число типа <info>float</info>, используйте <return>- PHP_FLOAT_MAX</return>. Доступно с PHP 7.2.0.


id: PHP_INT_MAX
type: constant
doc:
<comment>Description:</comment>
  Максимальное целое число, поддерживаемое данной сборкой PHP. Обычно это int(2147483647) в
  32-битных системах и int(9223372036854775807) в 64-битных. Обычно, PHP_INT_MIN === ~PHP_INT_MAX.


id: PHP_INT_MIN
type: constant
doc:
<comment>Description:</comment>
  Минимальное целое число, поддерживаемое данной сборкой PHP. Обычно это int(-2147483648) в
  32-битных системах и int(-9223372036854775808) в 64-битных.


id: PHP_MAJOR_VERSION
type: constant
doc:
<comment>Description:</comment>
  Текущая "основная" (major) версия PHP в виде целого числа (например, int(5) для версии
  "5.2.7-extra").


id: PHP_MAXPATHLEN
type: constant
doc:
<comment>Description:</comment>
  Максимальная длина файловых имён (включая путь), поддерживаемая данной сборкой PHP.


id: PHP_MINOR_VERSION
type: constant
doc:
<comment>Description:</comment>
  Текущая "промежуточная" (minor) версия PHP в виде целого числа (например, int(2) для версии
  "5.2.7-extra").


id: PHP_OS_FAMILY
type: constant
doc:
<comment>Description:</comment>
  Семейство операционных систем, для которых собран PHP. Любая из <return>'Windows'</return>, <return>'BSD'</return>, <return>'Darwin'</return>,
  <return>'Solaris'</return>, <return>'Linux'</return> или <return>'unknown'</return>. Доступно с PHP 7.2.0.


id: PHP_OUTPUT_HANDLER_CLEANABLE
type: constant
doc:
<comment>Description:</comment>
  Определяет может ли буфер вывода, созданный <strong>ob_start()</strong>, быть очищенным.


id: PHP_OUTPUT_HANDLER_CONT
type: constant
doc:
<comment>Description:</comment>
  Обозначает, что буфер был очищен, но буферирование вывода будет продолжено.
  
  Это синоним для <info>PHP_OUTPUT_HANDLER_WRITE</info>.


id: PHP_OUTPUT_HANDLER_END
type: constant
doc:
<comment>Description:</comment>
  Обозначает, что буферирование вывода завершено.
  
  Это синоним для <info>PHP_OUTPUT_HANDLER_FINAL</info>.


id: PHP_OUTPUT_HANDLER_FLUSHABLE
type: constant
doc:
<comment>Description:</comment>
  Определяет может ли буфер вывода, созданный <strong>ob_start()</strong>, быть сброшен (выведен и очищен).


id: PHP_OUTPUT_HANDLER_REMOVABLE
type: constant
doc:
<comment>Description:</comment>
  Определяет может ли буфер вывода, созданный <strong>ob_start()</strong>, быть удалённым до завершения скрипта.


id: PHP_OUTPUT_HANDLER_STDFLAGS
type: constant
doc:
<comment>Description:</comment>
  Значение по умолчанию для флагов буфера вывода. Равняется <info>PHP_OUTPUT_HANDLER_CLEANABLE</info> |
  <info>PHP_OUTPUT_HANDLER_FLUSHABLE</info> | <info>PHP_OUTPUT_HANDLER_REMOVABLE</info>.


id: PHP_OUTPUT_HANDLER_WRITE
type: constant
doc:
<comment>Description:</comment>
  Служит признаком того, что буфер вывода очищается и в нем находятся данные для вывода.


id: PHP_PREFIX
type: constant
doc:
<comment>Description:</comment>
  Значение --prefix было установлено при настройке. В Windows это значение --with-prefix было
  установлено при настройке.


id: PHP_QUERY_RFC1738
type: constant
doc:
<comment>Description:</comment>
  Кодирование выполняется в соответствии с RFC 1738 и типом данных
  <return>application/x-www-form-urlencoded</return>. Это означает, что пробелы заменяются символом плюс (<return>+</return>).


id: PHP_QUERY_RFC3986
type: constant
doc:
<comment>Description:</comment>
  Кодирование производится в соответствии с RFC 3986, и пробелы кодируются как <return>%20</return>.


id: PHP_RELEASE_VERSION
type: constant
doc:
<comment>Description:</comment>
  Текущая "релиз"-версия (release) PHP в виде целого числа (например, int(7) для версии
  "5.2.7-extra").


id: PHP_SAPI
type: constant
doc:
<comment>Description:</comment>
  API сервера (Server API) данной сборки PHP. Смотрите также <strong>php_sapi_name()</strong>.


id: PHP_SESSION_ACTIVE
type: constant
doc:
<comment>Description:</comment>
  Возвращаемое значение функцией <strong>session_status()</strong> в случае существования сессий.


id: PHP_SESSION_DISABLED
type: constant
doc:
<comment>Description:</comment>
  Возвращаемое значение функцией <strong>session_status()</strong> в случае, если сессии отключены.


id: PHP_SESSION_NONE
type: constant
doc:
<comment>Description:</comment>
  Возвращаемое значение функцией <strong>session_status()</strong> в случае, если сессии включены, но нет созданных
  сессий.


id: PHP_SHLIB_SUFFIX
type: constant
doc:
<comment>Description:</comment>
  Суффикс, используемый для динамически линкуемых библиотек, таких как "so" (для большинства
  Unix-систем) или "dll" (Windows).


id: PHP_SVN_AUTH_PARAM_IGNORE_SSL_VERIFY_ERRORS
type: constant
doc:
<comment>Description:</comment>
  Поле, предписывающее игнорирование ошибок верификации SSL-сертификата


id: PHP_VERSION
type: constant
doc:
<comment>Description:</comment>
  Текущая версия PHP в виде строки в формате "major.minor.release[extra]".


id: PHP_VERSION_ID
type: constant
doc:
<comment>Description:</comment>
  Текущая версия PHP в виде целого числа, её удобно использовать при сравнениях версий (например,
  int(50207) для версии "5.2.7-extra").


id: PHP_WINDOWS_EVENT_CTRL_BREAK
type: constant
doc:
<comment>Description:</comment>
  Событие Windows <return>CTRL+BREAK</return>. Доступно с PHP 7.4.0 (Только для Windows).


id: PHP_WINDOWS_EVENT_CTRL_C
type: constant
doc:
<comment>Description:</comment>
  Событие Windows <return>CTRL+C</return>. Доступно с PHP 7.4.0 (Только для Windows).


id: PHP_WINDOWS_NT_SERVER
type: constant
doc:
<comment>Description:</comment>
  Серверная система (напр. Server 2008/2003/2000). Надо учесть, что если сервер является
  контроллером домена, вместо этой константы будет выдаваться <info>PHP_WINDOWS_NT_DOMAIN_CONTROLLER</info>.


id: PHP_WINDOWS_VERSION_BUILD
type: constant
doc:
<comment>Description:</comment>
  Номер сборки Windows (например, Windows Vista SP1 имеет номер сборки 6001)


id: PHP_WINDOWS_VERSION_MAJOR
type: constant
doc:
<comment>Description:</comment>
  Основной номер версии Windows, это может быть <return>4</return> (NT4/Me/98/95), <return>5</return> (XP/2003 R2/2003/2000) или <return>6</return>
  (Vista/2008/7/8/8.1).


id: PHP_WINDOWS_VERSION_MINOR
type: constant
doc:
<comment>Description:</comment>
  Уточняющий номер версии Windows, это может быть <return>0</return> (Vista/2008/2000/NT4/95), <return>1</return> (XP), <return>2</return> (2003
  R2/2003/XP x64), <return>10</return> (98) или <return>90</return> (ME).


id: PHP_WINDOWS_VERSION_PLATFORM
type: constant
doc:
<comment>Description:</comment>
  Платформа, на которой PHP работает на данный момент. Возможны значения <return>2</return> для Windows
  Vista/XP/2000/NT4, Server 2008/2003, а для Windows ME/98/95 это значение будет <return>1</return>.


id: PHP_WINDOWS_VERSION_PRODUCTTYPE
type: constant
doc:
<comment>Description:</comment>
  Содержит значение, определяющее константы вида <return>PHP_WINDOWS_NT_*</return>. Этим значением может быть одна из
  констант <return>PHP_WINDOWS_NT_*</return> указывающая на тип платформы.


id: PHP_WINDOWS_VERSION_SP_MAJOR
type: constant
doc:
<comment>Description:</comment>
  Основной номер версии установленного сервис-пакета. Возможно значение <return>0</return>, если пакетов не
  установлено. Например, в Windows XP с 3м сервис паком это значение будет <return>3</return>.


id: PHP_WINDOWS_VERSION_SP_MINOR
type: constant
doc:
<comment>Description:</comment>
  Дополнительный номер установленного пакета обновлений. Значение <return>0</return> говорит от том, что пакетов не
  установлено.


id: PHP_WINDOWS_VERSION_SUITEMASK
type: constant
doc:
<comment>Description:</comment>
  Битовая маска указывающая, какая дополнительная функциональность установлена в системе Windows.
  Ниже приведена таблица с возможными значениями битового поля.


id: PKCS7_BINARY
type: constant
doc:
<comment>Description:</comment>
  Обычно входящее сообщение приводится к "каноничному" формату, что эффективно при использовании <return>CR</return>
  и <return>LF</return> в конце строки: это требуется сертификацией S/MIME. Когда данная опция указана, проблем с
  трансляцией символов конца строки не происходит. Это удобно в случае обработки бинарных данных,
  которые могут быть не в формате MIME.


id: PKCS7_DETACHED
type: constant
doc:
<comment>Description:</comment>
  При подписании сообщения, используйте подписание в открытом виде (cleartext signing) с MIME-типом
  <return>"multipart/signed"</return>. Это выполняется по умолчанию, если не указывать ничего в <strong>$flags</strong> функции
  <strong>openssl_pkcs7_sign()</strong>. Если выключить эту опцию, сообщение будет подписано с использованием opaque
  signing, что более устойчиво к передаче почтой, но не может быть прочитано почтовыми агентами,
  которые не поддерживают S/MIME.


id: PKCS7_NOATTR
type: constant
doc:
<comment>Description:</comment>
  Обычно, когда сообщение подписано, в набор атрибутов также включается время подписания и
  поддерживаемый симметричный алгоритм. С помощью данной опции такое добавление не происходит.


id: PKCS7_NOCERTS
type: constant
doc:
<comment>Description:</comment>
  При подписании сообщения, сертификат подписанта как правило включается в сообщение - с данной
  опцией сертификат не добавляется. Это позволяет снизить размер подписанного сообщения, но
  проверяющий должен иметь копию сертификата подписанта, доступную локально (это не требуется при
  использовании параметра <strong>$extracerts</strong> функции <strong>openssl_pkcs7_verify()</strong>).


id: PKCS7_NOCHAIN
type: constant
doc:
<comment>Description:</comment>
  Не проверять подписантов сертификата по цепочке: то есть не использовать сертификаты в подписанном
  сообщении как неавторизованные центром сертификации.


id: PKCS7_NOINTERN
type: constant
doc:
<comment>Description:</comment>
  При проверке сообщения, сертификаты (если таковые имеются), включённые в сообщения как правило
  проверяются на наличие подписи. С данной опцией используются только сертификаты, определённые в
  параметре <strong>$extracerts</strong> функции <strong>openssl_pkcs7_verify()</strong>. Все прочие сертификаты остаются
  неподтверждёнными центром сертификации.


id: PKCS7_NOOLDMIMETYPE
type: constant
doc:
<comment>Description:</comment>
  Доступно, начиная с PHP 8.3.0. Устанавливает тип содержимого <return>application/pkcs7-mime</return> вместо
  <return>application/x-pkcs7-mime</return> для шифрования сообщения.


id: PKCS7_TEXT
type: constant
doc:
<comment>Description:</comment>
  Добавляет заголовок содержимого text/plain в зашифрованное или подписанное сообщение. При
  расшифровке или проверке заголовки будут получены при выводе. Если после расшифровки или проверки
  полученное сообщение не имеет MIME-тип text/plain, произойдёт ошибка.


id: PNG_ALL_FILTERS
type: constant
doc:
<comment>Description:</comment>
  Специальный фильтр PNG filter, используется с функцией <strong>imagepng()</strong>.


id: POSIX_RLIMIT_AS
type: constant
doc:
<comment>Description:</comment>
  Максимальный размер адресного пространства процесса в байтах. Также смотрите конфигурационную
  директиву memory_limit.


id: POSIX_RLIMIT_CORE
type: constant
doc:
<comment>Description:</comment>
  Максимальный размер файла дампа ядра. Если это ограничение установлено в качестве 0, то файл дампа
  ядра создаваться не будет.


id: POSIX_RLIMIT_CPU
type: constant
doc:
<comment>Description:</comment>
  Максимальное количество процессорного времени, которое может быть использовано процессом, в
  секундах. Когда достигается мягкое ограничение, процессу будет отправлен сигнал <return>SIGXCPU</return>, который
  может быть обработан с помощью функции <strong>pcntl_signal()</strong>. В зависимости от операционной системы,
  может ежесекундно посылаться дополнительный сигнал <return>SIGXCPU</return>, пока не будет достигнут жёсткий
  предел, достижение которого нельзя обработать. Процессу будет отправлен сигнал <return>SIGKILL</return>.
  
  Смотрите также <strong>set_time_limit()</strong>.


id: POSIX_RLIMIT_DATA
type: constant
doc:
<comment>Description:</comment>
  Максимальный размер сегмента данных процесса, в байтах. Крайне маловероятно, что данное
  ограничение будет влиять на выполнение PHP, за исключением модулей, использующих вызовы функций
  <strong>brk()</strong> или <strong>sbrk()</strong>.


id: POSIX_RLIMIT_FSIZE
type: constant
doc:
<comment>Description:</comment>
  Максимальный размер файлов, которые могут быть созданы процессом в байтах.


id: POSIX_RLIMIT_INFINITY
type: constant
doc:
<comment>Description:</comment>
  Используется для отображения бесконечного значения ограничения ресурса.


id: POSIX_RLIMIT_KQUEUES
type: constant
doc:
<comment>Description:</comment>
  Максимальное количество kqueue, которое может создать этот идентификатор пользователя (FreeBSD).
  Доступно с PHP 8.1.0.


id: POSIX_RLIMIT_LOCKS
type: constant
doc:
<comment>Description:</comment>
  Максимальное количество блокировок, которое данный процесс может создать. Это поддерживается
  только на очень старых ядрах Linux.


id: POSIX_RLIMIT_MEMLOCK
type: constant
doc:
<comment>Description:</comment>
  Максимальное количество байт, которое может быть заблокировано в памяти.


id: POSIX_RLIMIT_MSGQUEUE
type: constant
doc:
<comment>Description:</comment>
  Максимальное количество байт, которое может быть выделено под очередь сообщений POSIX. Стандартная
  сборка PHP не поддерживает POSIX очередь сообщений, поэтому данное ограничение не будет иметь
  никакого эффекта, кроме случаев, когда вы используете модули, обеспечивающие эту поддержку.


id: POSIX_RLIMIT_NICE
type: constant
doc:
<comment>Description:</comment>
  Максимальное значение, приоритета планировщика процессов, которое может быть установлено. Итоговое
  значение вычисляется как <return>20 - limit</return>. Как ограничение ресурса значение не может быть отрицательным.


id: POSIX_RLIMIT_NOFILE
type: constant
doc:
<comment>Description:</comment>
  Значение, превышающее на 1, максимальное количество файловых дескрипторов, которое может быть
  открыть процессом.


id: POSIX_RLIMIT_NPROC
type: constant
doc:
<comment>Description:</comment>
  Максимальное количество процессов (и/или нитей, в зависимости от операционной системы) которое
  может быть создано для реального пользователя процесса.


id: POSIX_RLIMIT_NPTS
type: constant
doc:
<comment>Description:</comment>
  Максимальное количество псевдотерминалов, которое может создать этот идентификатор пользователя
  (FreeBSD). Доступно с PHP 8.1.0.


id: POSIX_RLIMIT_RSS
type: constant
doc:
<comment>Description:</comment>
  Максимальный размер физической памяти (RAM), используемой кодом процесса и данными, в страницах.


id: POSIX_RLIMIT_RTPRIO
type: constant
doc:
<comment>Description:</comment>
  Максимальный приоритет реального времени, который может быть установлен с помощью системных
  вызовов <strong>sched_setscheduler()</strong> и <strong>sched_setparam()</strong>.


id: POSIX_RLIMIT_RTTIME
type: constant
doc:
<comment>Description:</comment>
  Максимальное количество процессорного времени, в миллисекундах, которое процесс может использовать
  без блокирования системных вызовов при использовании планировщика реального времени.


id: POSIX_RLIMIT_SIGPENDING
type: constant
doc:
<comment>Description:</comment>
  Максимальное количество сигналов, которое можно поставить в очередь для реального пользователя
  данного процесса.


id: POSIX_X_OK
type: constant
doc:
<comment>Description:</comment>
  Проверить, существует ли файл и имеется ли разрешение на выполнение.


id: PREG_BACKTRACK_LIMIT_ERROR
type: constant
doc:
<comment>Description:</comment>
  Возвращается функцией <strong>preg_last_error()</strong> в случае, когда лимит обратных ссылок был исчерпан.
  
  5.2.0


id: PREG_BAD_UTF8_ERROR
type: constant
doc:
<comment>Description:</comment>
  Возвращается функцией <strong>preg_last_error()</strong>, если последняя ошибка была вызвана повреждёнными данными
  UTF-8 (только при запуске в режиме UTF-8).
  
  5.2.0


id: PREG_BAD_UTF8_OFFSET_ERROR
type: constant
doc:
<comment>Description:</comment>
  Возвращается функцией <strong>preg_last_error()</strong>, если смещение не соответствует началу корректной кодовой
  точки UTF-8 (только при запуске в режиме UTF-8).
  
  5.3.0


id: PREG_INTERNAL_ERROR
type: constant
doc:
<comment>Description:</comment>
  Возвращается функцией <strong>preg_last_error()</strong> в случае, если произошла внутренняя ошибка PCRE.
  
  5.2.0


id: PREG_JIT_STACKLIMIT_ERROR
type: constant
doc:
<comment>Description:</comment>
  Возвращается функцией <strong>preg_last_error()</strong>, если последняя функция PCRE завершилась неудачно из-за
  лимита стека JIT.
  
  7.0.0


id: PREG_NO_ERROR
type: constant
doc:
<comment>Description:</comment>
  Возвращается функцией <strong>preg_last_error()</strong>, если ошибок нет.
  
  5.2.0


id: PREG_PATTERN_ORDER
type: constant
doc:
<comment>Description:</comment>
  Меняет порядок элементов в результирующем массиве так, чтобы элемент $matches[0] содержал полные
  вхождения шаблона, элемент $matches[1] - все вхождения первой взятой в круглые скобки подмаски и
  т.д. Только <strong>preg_match_all()</strong> реагирует на данный модификатор.


id: PREG_RECURSION_LIMIT_ERROR
type: constant
doc:
<comment>Description:</comment>
  Возвращается функцией <strong>preg_last_error()</strong> в случае, если лимит рекурсии был исчерпан.
  
  5.2.0


id: PREG_SET_ORDER
type: constant
doc:
<comment>Description:</comment>
  Меняет порядок элементов в результирующем массиве так, чтобы элемент $matches[0] содержал первый
  набор вхождений (полное вхождение, вхождение первой подмаски, заключённой в круглые скобки...),
  аналогично элемент $matches[1] - второй набор вхождений и т.д. Только <strong>preg_match_all()</strong> реагирует
  на данный модификатор.


id: PREG_SPLIT_DELIM_CAPTURE
type: constant
doc:
<comment>Description:</comment>
  В случае, если этот флаг указан, то <strong>preg_split()</strong> также возвращает выражение, заключённое в круглые
  скобки в шаблоне разделителя.


id: PREG_SPLIT_NO_EMPTY
type: constant
doc:
<comment>Description:</comment>
  В случае, если этот флаг указан, функция <strong>preg_split()</strong> вернёт только непустые подстроки.


id: PREG_SPLIT_OFFSET_CAPTURE
type: constant
doc:
<comment>Description:</comment>
  В случае, если этот флаг указан, для каждой найденной подстроки будет указана её позиция в
  исходной строке. Необходимо помнить, что этот флаг меняет формат возвращаемых данных: каждое
  вхождение возвращается в виде массива, в нулевом элементе которого содержится найденная подстрока,
  а в первом - смещение. Этот флаг используется только в функции <strong>preg_split()</strong>.


id: PREG_UNMATCHED_AS_NULL
type: constant
doc:
<comment>Description:</comment>
  Этот флаг указывает <strong>preg_match()</strong> и <strong>preg_match_all()</strong> включать несовпадающие подмаски в $matches в
  виде значений <info>null</info>. Без этого флага несовпадающие подмаски отображаются как пустые строки, как
  если бы не было найдено совпадений. Установка этого флага позволяет проводить различие между двумя
  этими случаями.
  
  7.2.0


id: PSFS_ERR_FATAL
type: constant
doc:
<comment>Description:</comment>
  <return>Return Code</return> указывает, что пользовательский фильтр вызвал необрабатываемую ошибку (т.е. получены
  неверные данные).


id: PSFS_FEED_ME
type: constant
doc:
<comment>Description:</comment>
  <return>Return Code</return> указывает, что пользовательский фильтр не вернул бакеты (buckets) в <strong>$out</strong>. (т.е. нет
  доступных данных).


id: PSFS_PASS_ON
type: constant
doc:
<comment>Description:</comment>
  <return>Return Code</return> указывает, что пользовательский фильтр вернул бакеты (buckets) в <strong>$out</strong>.


id: PSpell\Config
type: class
doc:
<comment>Description:</comment>
  Полностью непрозрачный класс, заменяющий ресурс <return>pspell config</return> в PHP 8.1.0.


id: PSpell\Dictionary
type: class
doc:
<comment>Description:</comment>
  Полностью непрозрачный класс, заменяющий ресурс <return>pspell</return> в PHP 8.1.0.


id: PTHREADS_ALLOW_HEADERS
type: constant
doc:
<comment>Description:</comment>
  Позволять потокам отправлять заголовки (headers) в стандартный вывод (обычно запрещено)


id: PTHREADS_INHERIT_ALL
type: constant
doc:
<comment>Description:</comment>
  Настройка по умолчанию для всех потоков, указывает pthreads копировать все окружение при создании
  нового потока (класс Thread)


id: PTHREADS_INHERIT_INCLUDES
type: constant
doc:
<comment>Description:</comment>
  Наследовать информацию из подключённых файлов при старте нового потока


id: ParentIterator
type: class
doc:
<comment>Description:</comment>
  Это расширенный класс от <class>FilterIterator</class>, позволяющий осуществить рекурсивную итерацию, используя
  класс <class>RecursiveIteratorIterator</class>, который показывает только те элементы, которые имеют потомков.


id: ParentIterator::__construct
type: function
doc:
<comment>Description:</comment>
  Конструктор класса ParentIterator
  
  Создаёт новый объект класса <class>ParentIterator</class> на основе объекта-итератора.
  
  К настоящему времени эта функция ещё не была документирована; для ознакомления доступен только
  список аргументов.

<comment>Param:</comment>
  <info>RecursiveIterator</info>  <strong>$iterator</strong>  Объект-итератор, на основе которого создаётся новый объект.


id: ParentIterator::accept
type: function
doc:
<comment>Description:</comment>
  Определение доступности
  
  Определяет, имеет ли элемент дочерние элементы.
  
  К настоящему времени эта функция ещё не была документирована; для ознакомления доступен только
  список аргументов.

<comment>Return:</comment>
  <info>bool</info>  <info>true</info>, если элемент доступен, <info>false</info> в противном случае.

<comment>See Also:</comment>
   * ParentIterator::hasChildren
   * FilterIterator::accept


id: ParentIterator::getChildren
type: function
doc:
<comment>Description:</comment>
  Возвращает дочерние объекты итератора, хранящегося внутри ParentIterator
    
  
  Возвращает дочерние объекты итератора, хранящегося внутри ParentIterator.
  
  К настоящему времени эта функция ещё не была документирована; для ознакомления доступен только
  список аргументов.

<comment>Return:</comment>
  <info>ParentIterator</info>  Объект (<info>object</info>).


id: ParentIterator::hasChildren
type: function
doc:
<comment>Description:</comment>
  Проверяет, имеет ли внутренний объект-итератор дочерние объекты
    
  
  Проверяет, имеет ли внутренний объект-итератор дочерние объекты.
  
  К настоящему времени эта функция ещё не была документирована; для ознакомления доступен только
  список аргументов.

<comment>Return:</comment>
  <info>bool</info>  Возвращает <info>true</info> в случае успешного выполнения или <info>false</info> в случае возникновения ошибки.


id: ParentIterator::next
type: function
doc:
<comment>Description:</comment>
  Перемещает указатель на одну позицию вперёд
  
  Перемещает указатель на одну позицию вперёд.
  
  К настоящему времени эта функция ещё не была документирована; для ознакомления доступен только
  список аргументов.

<comment>Return:</comment>
  <info>void</info>  Функция не возвращает значения после выполнения.


id: ParentIterator::rewind
type: function
doc:
<comment>Description:</comment>
  Переводит итератор на начало
  
  Перемещает указатель на начальную позицию.
  
  К настоящему времени эта функция ещё не была документирована; для ознакомления доступен только
  список аргументов.

<comment>Return:</comment>
  <info>void</info>  Функция не возвращает значения после выполнения.


id: Parle\ErrorInfo
type: class
doc:
<comment>Description:</comment>
  Класс представляет подробную информацию об ошибке, предоставленной Parle\Parser::errorInfo


id: Parle\INTERNAL_UTF32
type: constant
doc:
<comment>Description:</comment>
  Определяет, скомпилирована ли внутренняя поддержка UTF-32. Доступно начиная с версии 0.7.2.


id: Parle\Lexer
type: class
doc:
<comment>Description:</comment>
  Класс лексера с одним состоянием. Лексемы можно определять на лету. Если конкретный экземпляр
  лексера предназначен для использования с <class>Parle\Parser</class>, идентификаторы токенов должны быть взяты
  оттуда. В противном случае могут быть предоставлены произвольные идентификаторы токенов. Лексер
  может дать определённое преимущество в производительности по сравнению с <class>Parle\RLexer</class>, если не
  требуется несколько состояний. Обратите внимание, что <class>Parle\RParser</class> несовместим с этим лексером.


id: Parle\Lexer::advance
type: function
doc:
<comment>Description:</comment>
  Обрабатывает следующее правило лексера
  
  Обрабатывает следующее правило и подготавливает полученные данные токена.

<comment>Return:</comment>
  <info>void</info>  Функция не возвращает значения после выполнения.


id: Parle\Lexer::build
type: function
doc:
<comment>Description:</comment>
  Завершает набор правил лексера
  
  Правила, ранее добавленные с помощью Parle\Lexer::push, завершаются. Этот вызов метода должен быть
  выполнен после того, как были применены все необходимые правила. Набор правил доступен только для
  чтения. Можно начинать лексирование.

<comment>Return:</comment>
  <info>void</info>  Функция не возвращает значения после выполнения.


id: Parle\Lexer::callout
type: function
doc:
<comment>Description:</comment>
  Определяет callback-функцию токена
  
  Определяет callback-функцию, которая будет вызываться, когда лексер встречает определённый токен.

<comment>Param:</comment>
  <info>int</info>       <strong>$id</strong>        Идентификатор токена.
  <info>callable</info>  <strong>$callback</strong>  Callable для вызова. Вызываемый объект не получает аргументов, а его
                       возвращаемое значение игнорируется.

<comment>Return:</comment>
  <info>void</info>  Функция не возвращает значения после выполнения.


id: Parle\Lexer::consume
type: function
doc:
<comment>Description:</comment>
  Передаёт данные на обработку
  
  Обрабатывает данные для лексирования.

<comment>Param:</comment>
  <info>string</info>  <strong>$data</strong>  Данные для лексирования.

<comment>Return:</comment>
  <info>void</info>  Функция не возвращает значения после выполнения.


id: Parle\Lexer::dump
type: function
doc:
<comment>Description:</comment>
  Выводит состояние устройства
  
  Выводит текущее состояние устройства в стандартный вывод.

<comment>Return:</comment>
  <info>void</info>  Функция не возвращает значения после выполнения.


id: Parle\Lexer::getToken
type: function
doc:
<comment>Description:</comment>
  Получает текущий токен
  
  Получает текущий токен.

<comment>Return:</comment>
  <info>Parle\Token</info>  Возвращает экземпляр <class>Parle\Token</class>.


id: Parle\Lexer::insertMacro
type: function
doc:
<comment>Description:</comment>
  Вставляет макрос регулярного выражения
  
  Вставляет макрос регулярного выражения, который позже можно использовать как ярлык и включить в
  другие регулярные выражения.

<comment>Param:</comment>
  <info>string</info>  <strong>$name</strong>   Имя макроса.
  <info>string</info>  <strong>$regex</strong>  Регулярное выражение.

<comment>Return:</comment>
  <info>void</info>  Функция не возвращает значения после выполнения.


id: Parle\Lexer::push
type: function
doc:
<comment>Description:</comment>
  Добавляет правило лексера
  
  Выдвигает шаблон для распознавания лексемы.

<comment>Param:</comment>
  <info>string</info>  <strong>$regex</strong>  Регулярное выражение, используемое для сопоставления токенов.
  <info>int</info>     <strong>$id</strong>     Идентификатор токена. Если экземпляр лексера предназначен для автономного
                  использования, может быть произвольным числом. Если экземпляр лексера будет
                  передан синтаксическому анализатору, должен быть идентификатор, возвращаемый
                  Parle\Parser::tokenid.

<comment>Return:</comment>
  <info>void</info>  Функция не возвращает значения после выполнения.


id: Parle\Lexer::reset
type: function
doc:
<comment>Description:</comment>
  Сбрасывает лексер
  
  Сбрасывает лексер, опционально предоставляя желаемое смещение.

<comment>Param:</comment>
  <info>int</info>  <strong>$pos</strong>  Позиция для сброса.

<comment>Return:</comment>
  <info>void</info>  Функция не возвращает значения после выполнения.


id: Parle\Parser
type: class
doc:
<comment>Description:</comment>
  Класс парсера. Правила можно определять на лету. После завершения требуется экземпляр <class>Parle\Lexer</class>
  для доставки потока токенов.


id: Parle\Parser::advance
type: function
doc:
<comment>Description:</comment>
  Обрабатывает следующее правило парсера
  
  Обрабатывает следующее правило парсера.

<comment>Return:</comment>
  <info>void</info>  Функция не возвращает значения после выполнения.


id: Parle\Parser::build
type: function
doc:
<comment>Description:</comment>
  Завершает грамматические правила
  
  Все ранее добавленные токены и грамматические правила завершаются. Набор правил становится
  доступным только для чтения, и анализатор готов к запуску.

<comment>Return:</comment>
  <info>void</info>  Функция не возвращает значения после выполнения.


id: Parle\Parser::consume
type: function
doc:
<comment>Description:</comment>
  Потребляет данные для обработки
  
  Потребляет данные для обработки.

<comment>Param:</comment>
  <info>string</info>       <strong>$data</strong>   Данные, которые необходимо обработать.
  <info>Parle\Lexer</info>  <strong>$lexer</strong>  Объект лексера, содержащий правила лексирования, подготовленные для
                       конкретной грамматики.

<comment>Return:</comment>
  <info>void</info>  Функция не возвращает значения после выполнения.


id: Parle\Parser::dump
type: function
doc:
<comment>Description:</comment>
  Выводит грамматику
  
  Выводит текущую грамматику в стандартный вывод.

<comment>Return:</comment>
  <info>void</info>  Функция не возвращает значения после выполнения.


id: Parle\Parser::errorInfo
type: function
doc:
<comment>Description:</comment>
  Получает информацию об ошибке
  
  Получает информацию об ошибке в случае, если Parle\Parser::action вернул действие в случае
  возникновения ошибки.

<comment>Return:</comment>
  <info>Parle\ErrorInfo</info>  Возвращает экземпляр <class>Parle\ErrorInfo</class>.


id: Parle\Parser::left
type: function
doc:
<comment>Description:</comment>
  Объявляет токен с левой ассоциативностью
  
  Объявляет токен с левой ассоциативностью.

<comment>Param:</comment>
  <info>string</info>  <strong>$tok</strong>  Имя токена.

<comment>Return:</comment>
  <info>void</info>  Функция не возвращает значения после выполнения.


id: Parle\Parser::nonassoc
type: function
doc:
<comment>Description:</comment>
  Объявляет токен без ассоциативности
  
  Объявляет терминал, который не может появляться более одного раза в строке.

<comment>Param:</comment>
  <info>string</info>  <strong>$tok</strong>  Имя токена.

<comment>Return:</comment>
  <info>void</info>  Функция не возвращает значения после выполнения.


id: Parle\Parser::precedence
type: function
doc:
<comment>Description:</comment>
  Объявляет правило приоритета
  
  Объявляет правило приоритета для фиктивного терминального символа. Правило может быть позже
  использовано в специальных правилах грамматики.

<comment>Param:</comment>
  <info>string</info>  <strong>$tok</strong>  Имя токена.

<comment>Return:</comment>
  <info>void</info>  Функция не возвращает значения после выполнения.


id: Parle\Parser::push
type: function
doc:
<comment>Description:</comment>
  Добавляет грамматическое правило
  
  Добавляет грамматическое правило. Возвращённый производственный идентификатор может быть
  использован позже в процессе синтаксического анализа, чтобы идентифицировать соответствие правилу.

<comment>Param:</comment>
  <info>string</info>  <strong>$name</strong>  Имя правила.
  <info>string</info>  <strong>$rule</strong>  Правило, которое будет добавлено. Синтаксис совместим с Bison.

<comment>Return:</comment>
  <info>int</info>  Возвращает целое число (<info>int</info>), представляющее индекс правила.


id: Parle\Parser::reset
type: function
doc:
<comment>Description:</comment>
  Сбрасывает состояние парсера
  
  Сбрасывает состояние парсера с использованием заданного идентификатора токена.

<comment>Param:</comment>
  <info>int</info>  <strong>$tokenId</strong>  Идентификатор токена.

<comment>Return:</comment>
  <info>void</info>  Функция не возвращает значения после выполнения.


id: Parle\Parser::right
type: function
doc:
<comment>Description:</comment>
  Объявляет токен с правой ассоциативностью
  
  Объявляет токен с правой ассоциативностью.

<comment>Param:</comment>
  <info>string</info>  <strong>$tok</strong>  Имя токена.

<comment>Return:</comment>
  <info>void</info>  Функция не возвращает значения после выполнения.


id: Parle\Parser::sigil
type: function
doc:
<comment>Description:</comment>
  Извлекает часть совпадения по правилу
  
  Возвращает часть совпадения по правилу. Метод эквивалентен функциональности псевдопеременных в
  Bison.

<comment>Param:</comment>
  <info>int</info>  <strong>$idx</strong>  Индекс совпадения, отсчитываемый от нуля.

<comment>Return:</comment>
  <info>string</info>  Возвращает строку (<info>string</info>) с совпадающей частью.


id: Parle\Parser::sigilCount
type: function
doc:
<comment>Description:</comment>
  Получает количество элементов в совпадающем правиле
  
  Получает количество элементов в совпадающем правиле.

<comment>Return:</comment>
  <info>int</info>  Возвращает целое число (<info>int</info>).


id: Parle\Parser::sigilName
type: function
doc:
<comment>Description:</comment>
  Получает имя правила или токена
  
  Получение частичного имени правила или имени токена, соответствующего индексу.

<comment>Param:</comment>
  <info>int</info>  <strong>$idx</strong>  Индекс соответствия, отсчёт начинается с нуля

<comment>Return:</comment>
  <info>string</info>  Возвращает строку (<info>string</info>) с найденной частью.


id: Parle\Parser::token
type: function
doc:
<comment>Description:</comment>
  Объявляет токен
  
  Объявляет терминал, который будет использоваться в грамматике.

<comment>Param:</comment>
  <info>string</info>  <strong>$tok</strong>  Имя токена.

<comment>Return:</comment>
  <info>void</info>  Функция не возвращает значения после выполнения.


id: Parle\Parser::tokenId
type: function
doc:
<comment>Description:</comment>
  Получает идентификатор токена
  
  Получает идентификатор указанного токена.

<comment>Param:</comment>
  <info>string</info>  <strong>$tok</strong>  Имя токена, используемое в Parle\Parser::token.

<comment>Return:</comment>
  <info>int</info>  Возвращает целое число (<info>int</info>) представляющее идентификатор токена.


id: Parle\Parser::trace
type: function
doc:
<comment>Description:</comment>
  Следит за работой парсера
  
  Получает описание текущей работы парсера. Может быть полезно для изучения парсера и оптимизации
  грамматики.

<comment>Return:</comment>
  <info>string</info>  Возвращает строку (<info>string</info>) с информацией о трассировке.


id: Parle\Parser::validate
type: function
doc:
<comment>Description:</comment>
  Проверяет входные данные
  
  Проверяет входную строку. Строка анализируется внутри, поэтому метод полезен для быстрой проверки
  ввода.

<comment>Param:</comment>
  <info>string</info>       <strong>$data</strong>   Строка для проверки.
  <info>Parle\Lexer</info>  <strong>$lexer</strong>  Объект лексера, содержащий правила лексирования, подготовленные для
                       конкретной грамматики.

<comment>Return:</comment>
  <info>bool</info>  Возвращает логическое значение(<info>bool</info>) в зависимости от того, соответствуют ли входные данные
        заданным правилам или нет.


id: Parle\RLexer
type: class
doc:
<comment>Description:</comment>
  Класс лексера с несколькими состояниями. Лексемы можно определять на лету. Если конкретный
  экземпляр лексера предназначен для использования с <class>Parle\RParser</class>, идентификаторы токенов должны
  быть взяты оттуда. В противном случае могут быть предоставлены произвольные идентификаторы
  токенов. Обратите внимание, что <class>Parle\Parser</class> несовместим с этим лексером.


id: Parle\RLexer::advance
type: function
doc:
<comment>Description:</comment>
  Обработка следующего правила лексера
  
  Обрабатывает следующее правило и подготавливает полученные данные токена.

<comment>Return:</comment>
  <info>void</info>  Функция не возвращает значения после выполнения.


id: Parle\RLexer::build
type: function
doc:
<comment>Description:</comment>
  Завершает набор правил лексера
  
  Правила, ранее добавленные с помощью Parle\RLexer::push, завершаются. Вызов метода должен быть
  выполнен после того, как все необходимые правила были переданы. Набор правил становится только для
  чтения. Лексер готов к запуску.

<comment>Return:</comment>
  <info>void</info>  Функция не возвращает значения после выполнения.


id: Parle\RLexer::callout
type: function
doc:
<comment>Description:</comment>
  Определяет callback-функцию токена
  
  Определяет callback-функцию, которая будет вызываться, когда лексер встречает определённый токен.

<comment>Param:</comment>
  <info>int</info>       <strong>$id</strong>        Token id.
  <info>callable</info>  <strong>$callback</strong>  Callable-функция. Вызываемый объект не получает аргументов, а его
                       возвращаемое значение игнорируется.

<comment>Return:</comment>
  <info>void</info>  Функция не возвращает значения после выполнения.


id: Parle\RLexer::consume
type: function
doc:
<comment>Description:</comment>
  Передаёт данные для обработки
  
  Потребляет данные для лексинга.

<comment>Param:</comment>
  <info>string</info>  <strong>$data</strong>  Данные для лексирования.

<comment>Return:</comment>
  <info>void</info>  Функция не возвращает значения после выполнения.


id: Parle\RLexer::dump
type: function
doc:
<comment>Description:</comment>
  Выгружает состояние устройства
  
  Выгружает текущее состояние устройства на стандартный вывод.

<comment>Return:</comment>
  <info>void</info>  Функция не возвращает значения после выполнения.


id: Parle\RLexer::getToken
type: function
doc:
<comment>Description:</comment>
  v
  
  Получает текущий токен.

<comment>Return:</comment>
  <info>Parle\Token</info>  Возвращает экземпляр <class>Parle\Token</class>.


id: Parle\RLexer::insertMacro
type: function
doc:
<comment>Description:</comment>
  Вставляет макрос регулярного выражения
  
  Вставляет макрос регулярного выражения, который впоследствии можно использовать в качестве ярлыка
  и включать в другие регулярные выражения.

<comment>Param:</comment>
  <info>string</info>  <strong>$name</strong>   Имя макроса
  <info>string</info>  <strong>$regex</strong>  Регулярное выражение.

<comment>Return:</comment>
  <info>void</info>  Функция не возвращает значения после выполнения.


id: Parle\RLexer::push
type: function
doc:
<comment>Description:</comment>
  Добавляет правило лексера
  
  Добавляет шаблон для распознавания лексемы.
  
  "Начальное состояние" и "состояние выхода" можно указать с помощью подходящей сигнатуры.

<comment>Param:</comment>
  <info>string</info>  <strong>$regex</strong>     Регулярное выражение, используемое для сопоставления токенов.
  <info>int</info>     <strong>$id</strong>        Идентификатор токена. Если экземпляр лексера предназначен для автономного
                     использования, это может быть произвольное число. Если экземпляр лексера будет
                     передан синтаксическому анализатору, это должен быть идентификатор,
                     возвращаемый Parle\RParser::tokenid.
  <info>string</info>  <strong>$state</strong>     Название состояния. Если в качестве начального состояния используется '*', то
                     правило применяется ко всем состояниям лексера.
  <info>string</info>  <strong>$newState</strong>  Новое название состояния после применения правила.
                     
                     Если в качестве состояния выхода указано '.', то состояние лексера не
                     изменяется, когда правило совпадает. Состояние выхода с '&gt;' перед именем
                     означает добавление. Используйте сигнатуру без идентификатора либо для
                     продолжения, либо для начала сопоставления, когда требуется продолжение или
                     рекурсия.
                     
                     Если в качестве состояния выхода указано '\<', это означает извлечение. В этом случае сигнатура, содержащая идентификатор, может использоваться для идентификации совпадения. Обратите внимание, что даже в том случае, если указан идентификатор, правило завершится первым, когда будут выполнены все предыдущие добавления.

<comment>Return:</comment>
  <info>void</info>  Функция не возвращает значения после выполнения.


id: Parle\RLexer::pushState
type: function
doc:
<comment>Description:</comment>
  Продвигает новое начальное состояние
  
  Этот тип лексера может иметь более одного состояния устройства. Это позволяет вам использовать
  разные токены в зависимости от контекста, что позволяет выполнять простой синтаксический анализ.
  После отправки состояния его можно использовать с подходящим вариантом сигнатуры
  Parle\RLexer::push.

<comment>Param:</comment>
  <info>string</info>  <strong>$state</strong>  Название состояния

<comment>Return:</comment>
  <info>int</info>  


id: Parle\RLexer::reset
type: function
doc:
<comment>Description:</comment>
  Сбрасывает лексер
  
  Сброс лексинга, при желании предоставляя желаемое смещение.

<comment>Param:</comment>
  <info>int</info>  <strong>$pos</strong>  Позиция сбрасывания.

<comment>Return:</comment>
  <info>void</info>  Функция не возвращает значения после выполнения.


id: Parle\RParser
type: class
doc:
<comment>Description:</comment>
  Класс парсера. Правила могут быть определены на лету. После завершения необходимо создать
  экземпляр <class>Parle\RLexer</class> для доставки потока токенов.


id: Parle\RParser::advance
type: function
doc:
<comment>Description:</comment>
  Обработка следующего правила парсера
  
  Обработка следующего правила парсера.

<comment>Return:</comment>
  <info>void</info>  Функция не возвращает значения после выполнения.


id: Parle\RParser::build
type: function
doc:
<comment>Description:</comment>
  Завершает грамматические правила
  
  Все ранее добавленные токены и правила грамматики будут доработаны. Набор правил становится
  доступным только для чтения, и анализатор готов к запуску.

<comment>Return:</comment>
  <info>void</info>  Функция не возвращает значения после выполнения.


id: Parle\RParser::consume
type: function
doc:
<comment>Description:</comment>
  Использовать данные для обработки
  
  Использовать данные для обработки.

<comment>Param:</comment>
  <info>string</info>  <strong>$data</strong>   Данные для обработки.
  <info></info>        <strong>$lexer</strong>  Объект лексера, содержащий правила лексинга, подготовленные для конкретной
                  грамматики.

<comment>Return:</comment>
  <info>void</info>  Функция не возвращает значения после выполнения.


id: Parle\RParser::errorInfo
type: function
doc:
<comment>Description:</comment>
  Получает информацию об ошибке
  
  Получает информацию об ошибке в случае, если Parle\RParser::action вернул действие в случае
  возникновения ошибки.

<comment>Return:</comment>
  <info>Parle\ErrorInfo</info>  Возвращает экземпляр <class>Parle\ErrorInfo</class>.


id: Parle\RParser::left
type: function
doc:
<comment>Description:</comment>
  Объявляет токен с левой ассоциативностью
  
  Объявляет терминал с левой ассоциативностью.

<comment>Param:</comment>
  <info>string</info>  <strong>$tok</strong>  Имя токена.

<comment>Return:</comment>
  <info>void</info>  Функция не возвращает значения после выполнения.


id: Parle\RParser::precedence
type: function
doc:
<comment>Description:</comment>
  Объявляет правило приоритета
  
  Объявляет правило приоритета для фиктивного терминального символа. Это правило может быть позже
  использовано в конкретных правилах грамматики.

<comment>Param:</comment>
  <info>string</info>  <strong>$tok</strong>  Имя токена.

<comment>Return:</comment>
  <info>void</info>  Функция не возвращает значения после выполнения.


id: Parle\RParser::push
type: function
doc:
<comment>Description:</comment>
  Добавляет грамматическое правило
  
  Добавляет грамматическое правило. Возвращённый идентификатор может быть использован позже в
  процессе синтаксического анализа, чтобы идентифицировать соответствие правилу.

<comment>Param:</comment>
  <info>string</info>  <strong>$name</strong>  Имя правила.
  <info>string</info>  <strong>$rule</strong>  Правило, которое будет добавлено. Синтаксис совместим с Bison.

<comment>Return:</comment>
  <info>int</info>  Возвращает целое число (<info>int</info>), представляющее индекс правила.


id: Parle\RParser::sigil
type: function
doc:
<comment>Description:</comment>
  Извлекает совпадающую часть по правилу
  
  Возвращает часть совпадения по правилу. Метод эквивалентен функциональности псевдопеременных в
  Bison.

<comment>Param:</comment>
  <info>int</info>  <strong>$idx</strong>  Индекс совпадения, отсчитываемый от нуля.

<comment>Return:</comment>
  <info>string</info>  Возвращает строку (<info>string</info>) с совпадающей частью.


id: Parle\RParser::tokenId
type: function
doc:
<comment>Description:</comment>
  Получает идентификатор токена
  
  Получает идентификатор заданного токена.

<comment>Param:</comment>
  <info>string</info>  <strong>$tok</strong>  Имя токена, используемое в Parle\RParser::token.

<comment>Return:</comment>
  <info>int</info>  Возвращает целое число (<info>int</info>), представляющее идентификатор токена.


id: Parle\RParser::trace
type: function
doc:
<comment>Description:</comment>
  Следит за работой парсера
  
  Получает описание текущей работы парсера. Может быть полезно для изучения синтаксического
  анализатора и оптимизации грамматики.

<comment>Return:</comment>
  <info>string</info>  Возвращает строку (<info>string</info>) с информацией о трассировке.


id: Parle\RParser::validate
type: function
doc:
<comment>Description:</comment>
  Проверяет входные данные
  
  Проверяет входную строку. Строка анализируется внутренним механизмом, поэтому метод полезен для
  быстрой проверки входных данных.

<comment>Param:</comment>
  <info>string</info>        <strong>$data</strong>   Строка для проверки.
  <info>Parle\RLexer</info>  <strong>$lexer</strong>  Объект лексера, содержащий правила лексирования, подготовленные для
                        конкретной грамматики.

<comment>Return:</comment>
  <info>bool</info>  Возвращает логическое значение (<info>bool</info>) определяющее, соответствуют ли входные данные заданным
        правилам или нет.


id: Parle\Stack
type: class
doc:
<comment>Description:</comment>
  <class>Parle\Stack</class> — это стек LIFO. Элементы добавляются и удаляются только с одного конца.


id: Parle\Stack::pop
type: function
doc:
<comment>Description:</comment>
  Извлекает предмет из стека

<comment>Return:</comment>
  <info>void</info>  Функция не возвращает значения после выполнения.


id: Parle\Stack::push
type: function
doc:
<comment>Description:</comment>
  Помещает элемент в стек

<comment>Param:</comment>
  <info>mixed</info>  <strong>$item</strong>  Переменная, которую необходимо поместить в стек

<comment>Return:</comment>
  <info>void</info>  Функция не возвращает значения после выполнения.


id: Parle\Token
type: class
doc:
<comment>Description:</comment>
  Класс представляет токен. Лексер возвращает экземпляры этого класса.


id: PgSql\Connection
type: class
doc:
<comment>Description:</comment>
  Полностью непрозрачный класс, заменяющий ресурс <return>pgsql link</return> в PHP 8.1.0.


id: PgSql\Lob
type: class
doc:
<comment>Description:</comment>
  Полностью непрозрачный класс, заменяющий ресурс <return>pgsql large object</return> в PHP 8.1.0.


id: PgSql\Result
type: class
doc:
<comment>Description:</comment>
  Полностью непрозрачный класс, заменяющий ресурс <return>pgsql result</return> в PHP 8.1.0.


id: Phar
type: class
doc:
<comment>Description:</comment>
  Класс Phar предоставляет высокоуровневый интерфейс для доступа и создания архивов phar.


id: Phar::COMPRESSED
type: constant
doc:
<comment>Description:</comment>
  0x0000F000
  
  битовая маска, которая может быть использована с флагами файла для определения наличия сжатия


id: Phar::OPENSSL
type: constant
doc:
<comment>Description:</comment>
  подпись с помощью пары открытого/закрытого ключей OpenSSL. Это подлинная подпись, использующая
  асимметричный ключ.


id: Phar::PHP
type: constant
doc:
<comment>Description:</comment>
  используется для указания параметру переопределения MIME-типа <strong>Phar::webPhar()</strong> на то, что
  расширение должно быть разобрано как файл PHP


id: Phar::PHPS
type: constant
doc:
<comment>Description:</comment>
  используется для указания параметра переопределения MIME-типа <strong>Phar::webPhar()</strong>, в соответствии с
  которым расширение должно быть разобрано как исходный файл PHP посредством <strong>highlight_file()</strong>


id: Phar::SHA256
type: constant
doc:
<comment>Description:</comment>
  подпись с помощью алгоритма хеширования sha256 (требуется модуль hash)


id: Phar::SHA512
type: constant
doc:
<comment>Description:</comment>
  подпись с помощью алгоритма хеширования sha512 (требуется модуль hash)


id: Phar::__construct
type: function
doc:
<comment>Description:</comment>
  Создаёт объект Phar-архива

<comment>Param:</comment>
  <info>string</info>       <strong>$filename</strong>  Путь к уже существующему Phar-архиву или к архиву, который должен быть
                          создан. Расширение в имени файла должно содержать .phar.
  <info>int</info>          <strong>$flags</strong>     Флаги, которые должны быть переданы в родительский класс
                          <class>RecursiveDirectoryIterator</class>.
  <info>string|null</info>  <strong>$alias</strong>     Псевдоним, с помощью которого должны производиться ссылки на этот
                          Phar-архив в вызовах, связанных с функционалом потоков.


id: Phar::addEmptyDir
type: function
doc:
<comment>Description:</comment>
  Добавляет в phar-архив пустую директорию
  
  Для корректной работы с объектами <class>Phar</class>
  этому методу необходима установка значения php.ini <return>phar.readonly</return> в <return>0</return>.
  В противном случае, будет выброшено исключение <class>PharException</class>.
  
  С помощью этого метода создаётся пустая директория, путь к которой указан в <return>dirname</return>. Этот метод
  аналогичен <strong>ZipArchive::addEmptyDir()</strong>.

<comment>Param:</comment>
  <info>string</info>  <strong>$directory</strong>  Имя пустого каталога, который должен быть создан в phar-архиве.

<comment>Return:</comment>
  <info>void</info>  Нет возвращаемого значения, в случае возникновения ошибки выбрасывается исключение.

<comment>See Also:</comment>
   * <strong>PharData::addEmptyDir()</strong>
   * <strong>Phar::addFile()</strong>
   * <strong>Phar::addFromString()</strong>


id: Phar::addFile
type: function
doc:
<comment>Description:</comment>
  Добавляет в phar-архив файл из файловой системы
  
  Для корректной работы с объектами <class>Phar</class>
  этому методу необходима установка значения php.ini <return>phar.readonly</return> в <return>0</return>.
  В противном случае, будет выброшено исключение <class>PharException</class>.
  
  С помощью этого метода в phar-архив может быть добавлен любой файл или содержимое, доступное по
  URL. Если указан необязательный второй параметр <return>localName</return>, то файл будет сохранён в архиве с таким
  именем, в ином случае в качестве пути для сохранения внутри архива будет использован параметр
  <return>file</return>. При добавлении содержимого, доступного по URL, параметр <return>localname</return> должен быть указан, иначе
  будет выброшено исключение. Этот метод аналогичен <strong>ZipArchive::addFile()</strong>.

<comment>Param:</comment>
  <info>string</info>       <strong>$filename</strong>   Полный или относительный путь к файлу в файловой системе, который должен
                           быть добавлен в phar-архив.
  <info>string|null</info>  <strong>$localName</strong>  Путь, по которому файл будет сохранён в архиве.

<comment>Return:</comment>
  <info>void</info>  Нет возвращаемого значения, в случае возникновения ошибки выбрасывается исключение.

<comment>See Also:</comment>
   * <strong>Phar::offsetSet()</strong>
   * <strong>PharData::addFile()</strong>
   * <strong>Phar::addFromString()</strong>
   * <strong>Phar::addEmptyDir()</strong>


id: Phar::addFromString
type: function
doc:
<comment>Description:</comment>
  Добавляет в phar-архив файл из строки
  
  Для корректной работы с объектами <class>Phar</class>
  этому методу необходима установка значения php.ini <return>phar.readonly</return> в <return>0</return>.
  В противном случае, будет выброшено исключение <class>PharException</class>.
  
  С помощью этого метода в phar-архив может быть добавлена любая строка. Файл будет сохранён в
  архиве под именем, указанным в параметре <return>localname</return>. Этот метод аналогичен
  <strong>ZipArchive::addFromString()</strong>.

<comment>Param:</comment>
  <info>string</info>  <strong>$localName</strong>  Путь, по которому файл будет сохранён в архиве.
  <info>string</info>  <strong>$contents</strong>   Содержимое файла для сохранения.

<comment>Return:</comment>
  <info>void</info>  Нет возвращаемого значения, в случае возникновения ошибки выбрасывается исключение.

<comment>See Also:</comment>
   * <strong>Phar::offsetSet()</strong>
   * <strong>PharData::addFromString()</strong>
   * <strong>Phar::addFile()</strong>
   * <strong>Phar::addEmptyDir()</strong>


id: Phar::apiVersion
type: function
doc:
<comment>Description:</comment>
  Возвращает версию API
  
  Возвращает версию API формата phar-файла, которая будет использована для создания архивов. Модуль
  Phar поддерживает чтение начиная с версии API 1.0.0. Для использования хешей SHA-256 и SHA-512
  требуется версия API 1.1.0, а для хранения пустых директорий требуется версия API 1.1.1.

<comment>Return:</comment>
  <info>string</info>  Строка версии API, как в <return>"1.0.0"</return>.


id: Phar::buildFromDirectory
type: function
doc:
<comment>Description:</comment>
  Создаёт phar-архив из файлов, расположенных внутри директории
  
  Для корректной работы с объектами <class>Phar</class>
  этому методу необходима установка значения php.ini <return>phar.readonly</return> в <return>0</return>.
  В противном случае, будет выброшено исключение <class>PharException</class>.
  
  Заполняет phar-архив содержимым директории. Необязательный второй параметр является регулярным
  выражением (PCRE) и используется для исключения файлов. Любой файл, чьё имя соответствует
  регулярному выражению, будет включён, все остальные будут исключены. Для более детализированного
  контроля используйте <strong>Phar::buildFromIterator()</strong>.

<comment>Param:</comment>
  <info>string</info>  <strong>$directory</strong>  Полный или абсолютный путь к директории, все файлы которой должны быть
                      добавлены в архив.
  <info>string</info>  <strong>$pattern</strong>    Необязательное регулярное выражение (PCRE), которое используется для
                      фильтрации списка файлов. В архив будут включены только те файлы, пути к
                      которым соответствуют регулярному выражению.

<comment>Return:</comment>
  <info>array</info>  <strong>Phar::buildFromDirectory()</strong> возвращает ассоциативный массив, в котором отражено соответствие
         пути к файлу внутри архива к пути к файлу в файловой системе.

<comment>See Also:</comment>
   * <strong>Phar::buildFromIterator()</strong>


id: Phar::buildFromIterator
type: function
doc:
<comment>Description:</comment>
  Создаёт phar-архив из итератора
  
  Для корректной работы с объектами <class>Phar</class>
  этому методу необходима установка значения php.ini <return>phar.readonly</return> в <return>0</return>.
  В противном случае, будет выброшено исключение <class>PharException</class>.
  
  Заполняет phar-архив из итератора. Поддерживаются итераторы двух типов: такие, в которых
  отображается соответствие имени файла внутри phar-архива к файлу на диске, и такие как
  DirectoryIterator, которые возвращают объекты SplFileInfo. Для итераторов, которые возвращают
  объекты SplFileInfo, второй параметр является обязательным.

<comment>Param:</comment>
  <info>Traversable</info>  <strong>$iterator</strong>       Любой итератор, который или ассоциативно отображает пути к файлам
                               внутри phar-архива к файлам на диске, или возвращает объекты
                               SplFileInfo.
  <info>string|null</info>  <strong>$baseDirectory</strong>  Для итераторов, возвращающих объекты SplFileInfo, — часть полного
                               пути каждого файла, которая должна быть удалена во время его
                               добавления в phar-архив.

<comment>Return:</comment>
  <info>array</info>  <strong>Phar::buildFromIterator()</strong> возвращает ассоциативный массив, в котором отображаются
         соответствия пути к файлу внутри архива к пути к файлу в файловой системе.

<comment>See Also:</comment>
   * <strong>Phar::buildFromDirectory()</strong>


id: Phar::canCompress
type: function
doc:
<comment>Description:</comment>
  Проверяет, поддерживает ли модуль phar сжатие с использованием zlib или bzip2
  
  Этот метод следует использовать для проверки поддержки сжатия до загрузки phar-архива, содержащего
  сжатые файлы.

<comment>Param:</comment>
  <info>int</info>  <strong>$compression</strong>  Может быть использована одна из констант <return>Phar::GZ</return> или <return>Phar::BZ2</return> для проверки
                     возможности сжатия по алгоритму zlib или bzip2 соответственно.

<comment>Return:</comment>
  <info>bool</info>  <info>true</info>, если сжатие/распаковка доступны, <info>false</info>, в противном случае.

<comment>See Also:</comment>
   * <strong>PharFileInfo::getCompressedSize()</strong>
   * <strong>PharFileInfo::isCompressed()</strong>
   * <strong>PharFileInfo::compress()</strong>
   * <strong>PharFileInfo::decompress()</strong>
   * <strong>Phar::isCompressed()</strong>
   * <strong>Phar::compressFiles()</strong>
   * <strong>Phar::decompressFiles()</strong>
   * <strong>Phar::getSupportedCompression()</strong>
   * <strong>Phar::convertToExecutable()</strong>
   * <strong>Phar::convertToData()</strong>


id: Phar::canWrite
type: function
doc:
<comment>Description:</comment>
  Проверяет, поддерживает ли модуль phar сохранение и создание phar-архивов
  
  Этот статический метод определяет, был ли отключён доступ на запись в системном файле php.ini с
  использованием переменной phar.readonly.

<comment>Return:</comment>
  <info>bool</info>  <info>true</info>, если доступ на запись включён, <info>false</info> в противном случае.

<comment>See Also:</comment>
   * phar.readonly
   * <strong>Phar::isWritable()</strong>


id: Phar::compress
type: function
doc:
<comment>Description:</comment>
  Сжимает весь Phar-архив с помощью Gzip- или Bzip2-сжатия
  
  Для корректной работы с объектами <class>Phar</class>
  этому методу необходима установка значения php.ini <return>phar.readonly</return> в <return>0</return>.
  В противном случае, будет выброшено исключение <class>PharException</class>.
  
  В случае использования с phar-архивами, основанными на tar или phar, этот метод сжимает весь
  архив, используя gzip- или bzip2-сжатие. Полученный файл может быть обработан одной из команд
  gunzip/bunzip; к нему также можно получить прямой доступ, используя модуль Phar.
  
  В случае использования с phar-архивами, основанными на zip, вызов этого метода потерпит неудачу и
  будет брошено исключение. Для сжатия по алгоритму gzip должен быть включён модуль zlib. Для сжатия
  по алгоритму bzip2 должен быть включён модуль bzip2. Как и в случае с другим функционалом,
  модифицирующим содержание phar-архива, для успешной работы данного метода необходимо, чтобы
  INI-переменная phar.readonly была отключена.
  
  Кроме того, этот метод автоматически переименовывает архив, добавляя <return>.gz</return>, <return>.bz2</return> или удаляя
  расширение, если в качестве первого параметра был передан <return>Phar::NONE</return>, сообщающий о необходимости
  распаковки. В качестве альтернативы расширение файла может быть задано с помощью второго
  параметра.

<comment>Param:</comment>
  <info>int</info>          <strong>$compression</strong>  Сжатие должно быть определено одной из констант: <return>Phar::GZ</return>, <return>Phar::BZ2</return>
                             для использования соответствующего алгоритма сжатия, или <return>Phar::NONE</return> для
                             распаковки.
  <info>string|null</info>  <strong>$extension</strong>    Для сжатия phar-архивов по умолчанию используется расширение <return>.phar.gz</return>
                             или <return>.phar.bz2</return>, а для сжатия tar-архивов — <return>.phar.tar.gz</return> или
                             <return>.phar.tar.bz2</return>. В случае распаковки, расширениями по умолчанию являются
                             <return>.phar</return> и <return>.phar.tar</return>.

<comment>Return:</comment>
  <info>Phar|null</info>  Возвращает объект <class>Phar</class> или <info>null</info> в случае возникновения ошибки.

<comment>See Also:</comment>
   * <strong>PharFileInfo::getCompressedSize()</strong>
   * <strong>PharFileInfo::isCompressed()</strong>
   * <strong>PharFileInfo::compress()</strong>
   * <strong>PharFileInfo::decompress()</strong>
   * <strong>PharData::compress()</strong>
   * <strong>Phar::canCompress()</strong>
   * <strong>Phar::isCompressed()</strong>
   * <strong>Phar::decompress()</strong>
   * <strong>Phar::getSupportedCompression()</strong>
   * <strong>Phar::compressFiles()</strong>
   * <strong>Phar::decompressFiles()</strong>


id: Phar::compressFiles
type: function
doc:
<comment>Description:</comment>
  Сжимает все файлы в текущем Phar-архиве
  
  Для корректной работы с объектами <class>Phar</class>
  этому методу необходима установка значения php.ini <return>phar.readonly</return> в <return>0</return>.
  В противном случае, будет выброшено исключение <class>PharException</class>.
  
  В случае использования с phar-архивами, основанными на tar, этот метод выбрасывает исключение
  <class>BadMethodCallException</class>, поскольку сжатие отдельных файлов внутри tar-архива не поддерживается
  данным форматом. Для сжатия целого phar-архива, основанного на tar, используйте <strong>Phar::compress()</strong>.
  
  В случае использования с phar-архивами, основанными на zip или phar, этот метод сжимает все файлы
  в Phar-архиве используя указанный алгоритм сжатия. Для возможности воспользоваться данным методом
  должен быть включён модуль zlib или bzip2. Кроме того, если какие-либо файлы в архиве уже сжаты с
  использованием bzip2/zlib-сжатия, то для их распаковки перед повторным сжатием должен быть включён
  соответствующий модуль. Как и в случае с другим функционалом, модифицирующим содержание
  phar-архива, для успешной работы данного метода необходимо, чтобы INI-переменная phar.readonly
  была отключена.

<comment>Param:</comment>
  <info>int</info>  <strong>$compression</strong>  Сжатие должно быть определено одной из констант: <return>Phar::GZ</return>, <return>Phar::BZ2</return> для
                     использования соответствующего алгоритма сжатия, или <return>Phar::NONE</return> для распаковки.

<comment>Return:</comment>
  <info>void</info>  Функция не возвращает значения после выполнения.

<comment>See Also:</comment>
   * <strong>PharFileInfo::getCompressedSize()</strong>
   * <strong>PharFileInfo::isCompressed()</strong>
   * <strong>PharFileInfo::compress()</strong>
   * <strong>PharFileInfo::decompress()</strong>
   * <strong>Phar::canCompress()</strong>
   * <strong>Phar::isCompressed()</strong>
   * <strong>Phar::decompressFiles()</strong>
   * <strong>Phar::getSupportedCompression()</strong>
   * <strong>Phar::compress()</strong>
   * <strong>Phar::decompress()</strong>


id: Phar::convertToData
type: function
doc:
<comment>Description:</comment>
  Конвертирует phar-архив в неисполняемый tar- или zip-файл
  
  Этот метод используется для конвертирования phar-архив в tar- или zip-файл. Чтобы создать сделать
  tar или zip неисполняемым, из создаваемого в результате конвертации архива удаляются загрузка и
  псевдоним phar-архива.
  
  Если не были указаны никакие изменения, то данный метод выбросит исключение
  <class>BadMethodCallException</class>, если форматом файла архива является phar. В случае использования с
  архивами в формате tar или zip, данный метод конвертирует архив в неисполняемый архив.
  
  В случае успешного выполнения данный метод создаёт на диске новый архив и возвращает объект
  <class>PharData</class>. Старый архив не удаляется с диска, это должно быть сделано вручную после завершения
  процесса.

<comment>Param:</comment>
  <info>int|null</info>     <strong>$format</strong>       Значением этого параметра должна быть одна из констант: <return>Phar::TAR</return> или
                             <return>Phar::ZIP</return>. Если значение установлено в <info>null</info>, то существующий формат
                             файла будет сохранён.
  <info>int|null</info>     <strong>$compression</strong>  Значением этого параметра должна быть одна из констант: <return>Phar::NONE</return> для
                             отсутствия сжатия всего архива, <return>Phar::GZ</return> для сжатия, основанного на
                             zlib, или <return>Phar::BZ2</return> для bzip-сжатия.
  <info>string|null</info>  <strong>$extension</strong>    Этот параметр используется для переопределения расширение файла по
                             умолчанию для сконвертированного архива. Обратите внимание, что <return>.phar</return>
                             не может быть использовано где-либо в имени файла неисполняемого tar-
                             или zip-архива.
                             
                             В случае конвертации phar-архива, основанного на tar, расширениями по
                             умолчанию являются: <return>.tar</return>, <return>.tar.gz</return> и <return>.tar.bz2</return>, в зависимости от
                             указанного сжатия. Для архивов, основанных на zip, расширением по
                             умолчанию является <return>.zip</return>.

<comment>Return:</comment>
  <info>PharData|null</info>  Данный метод возвращает объект <class>PharData</class> в случае успешного выполнения и <info>null</info> в
                 случае возникновения ошибки.

<comment>See Also:</comment>
   * <strong>Phar::convertToExecutable()</strong>
   * <strong>PharData::convertToExecutable()</strong>
   * <strong>PharData::convertToData()</strong>


id: Phar::convertToExecutable
type: function
doc:
<comment>Description:</comment>
  Конвертирует phar-архив в другой исполняемый формат файла
  
  Для корректной работы с объектами <class>Phar</class>
  этому методу необходима установка значения php.ini <return>phar.readonly</return> в <return>0</return>.
  В противном случае, будет выброшено исключение <class>PharException</class>.
  
  Этот метод используется для конвертирования phar-архива в другой формат файла. Например, он может
  быть использован для создания исполняемого phar-архива, основанного на tar, из исполняемого
  phar-архива, основанного на zip, или из исполняемого phar-архива с форматом файла phar. Кроме
  того, данный метод может быть использован для сжатия целого архива, основанного на tar или phar.
  
  Если не были указаны никакие изменения, то данный метод выбросит исключение
  <class>BadMethodCallException</class>.
  
  В случае успешного выполнения данный метод создаёт на диске новый архив и возвращает объект <class>Phar</class>.
  Старый архив не удаляется с диска, это должно быть сделано вручную после завершения процесса.

<comment>Param:</comment>
  <info>int|null</info>     <strong>$format</strong>       Значением этого параметра должна быть одна из констант: <return>Phar::PHAR</return>,
                             <return>Phar::TAR</return> или <return>Phar::ZIP</return>. Если значение установлено в <info>null</info>, то
                             существующий формат файла будет сохранён.
  <info>int|null</info>     <strong>$compression</strong>  Значением этого параметра должна быть одна из констант: <return>Phar::NONE</return> для
                             отсутствия сжатия всего архива, <return>Phar::GZ</return> для сжатия, основанного на
                             zlib, или <return>Phar::BZ2</return> для bzip-сжатия.
  <info>string|null</info>  <strong>$extension</strong>    Этот параметр используется для переопределения расширение файла по
                             умолчанию для сконвертированного архива. Обратите внимание, что все
                             phar-архивы, основанные на tar или zip, должны содержать <return>.phar</return> в
                             расширении файла чтобы они могли быть обработаны в качестве
                             phar-архива.
                             
                             В случае конвертации архива, основанного на phar, расширениями по
                             умолчанию являются <return>.phar</return>, <return>.phar.gz</return> и <return>.phar.bz2</return>, в зависимости от
                             указанного сжатия. В случае конвертации phar-архива, основанного на
                             tar, расширениями по умолчанию являются <return>.phar.tar</return>, <return>.phar.tar.gz</return> и
                             <return>.phar.tar.bz2</return>. Для архивов, основанных на zip, расширением по умолчанию
                             является <return>.zip</return>.

<comment>Return:</comment>
  <info>Phar|null</info>  Данный метод возвращает объект <class>Phar</class> в успешного выполнения и <info>null</info> в случае
             возникновения ошибки.

<comment>See Also:</comment>
   * <strong>Phar::convertToData()</strong>
   * <strong>PharData::convertToExecutable()</strong>
   * <strong>PharData::convertToData()</strong>


id: Phar::copy
type: function
doc:
<comment>Description:</comment>
  Копирует один файл внутри phar-архива в другой новый файл внутри phar-архива
  
  Для корректной работы с объектами <class>Phar</class>
  этому методу необходима установка значения php.ini <return>phar.readonly</return> в <return>0</return>.
  В противном случае, будет выброшено исключение <class>PharException</class>.
  
  Копирует внутренний файл phar-архива в другой новый файл внутри phar-архива. Это
  объектно-ориентированная альтернатива использованию <strong>copy()</strong> с обёрткой потока phar.

<comment>Param:</comment>
  <info>string</info>  <strong>$from</strong>  
  <info>string</info>  <strong>$to</strong>    

<comment>Return:</comment>
  <info>bool</info>  возвращает <info>true</info> в случае успешного выполнения, но безопаснее заключить вызов метода в блок
        try/catch и считать его успешным, если не было выброшено исключение.


id: Phar::count
type: function
doc:
<comment>Description:</comment>
  Возвращает количество записей (файлов) в Phar-архиве

<comment>Param:</comment>
  <info>int</info>  <strong>$mode</strong>  Параметр <strong>$mode</strong> - целочисленное значение, определяющее используемый режим подсчёта. По
              умолчанию установлено значение <info>COUNT_NORMAL</info>, подсчитываются только элементы в архиве,
              которые не были удалены или скрыты. Если установлено значение <info>COUNT_RECURSIVE</info>,
              подсчитываются все элементы в архиве, включая удалённые или скрытые.

<comment>Return:</comment>
  <info>int</info>  Количество файлов, содержащихся в этом phar-архиве, либо <return>0</return> (число ноль), если архив пуст.


id: Phar::createDefaultStub
type: function
doc:
<comment>Description:</comment>
  Создать заглушку в формате phar-архива
  
  Этот метод создаёт код заглушку (stub) в специфичном для phar-архива формате и не предназначенный
  для использования с файловыми архивами на основе tar или zip.
  
  Phar-архивы содержат загрузчик (<return>stub</return>), написанный на PHP, который запускается при запуске архива,
  когда его подключают через include:
  ]]> или просто запускают: 
  
  Этот метод предоставляет простой  способ для создания заглушку, который будет отрабатывать при
  запуске phar-архива. Кроме того, можно указывать разные файлы для запуска phar-архива через
  веб-сервер и через командную строку. Заглушка также вызывает <strong>Phar::interceptFileFuncs()</strong> для
  простого создания приложений PHP с доступом к файловой системе. Если модуль phar отсутствует, то
  заглушка распакует phar-архив во временную директорию и запустит приложение оттуда. Функция
  завершения работы удалит все временные файлы.

<comment>Param:</comment>
  <info>string|null</info>  <strong>$index</strong>     Относительный путь в phar-архиве для запуска при доступе из командной
                          строки
  <info>string|null</info>  <strong>$webIndex</strong>  Относительный путь в phar-архиве для запуска при доступе через браузер

<comment>Return:</comment>
  <info>string</info>  Возвращает текст с кодом заглушку, который позволит Phar-архиву запускаться независимо от
          того, подключён ли модуль Phar или нет.

<comment>See Also:</comment>
   * <strong>Phar::setStub()</strong>
   * <strong>Phar::getStub()</strong>


id: Phar::decompress
type: function
doc:
<comment>Description:</comment>
  Распаковывает весь Phar-архив
  
  Для корректной работы с объектами <class>Phar</class>
  этому методу необходима установка значения php.ini <return>phar.readonly</return> в <return>0</return>.
  В противном случае, будет выброшено исключение <class>PharException</class>.
  
  В случае с phar-архивами, основанными на tar или phar, этот метод распаковывает весь архив.
  
  В случае с phar-архивами, основанными на zip, вызов данного метода потерпит неудачу и будет
  брошено исключение. Для распаковки архива, сжатого по алгоритму gzip, должен быть включён модуль
  zlib; для распаковки архива, сжатого по алгоритму bzip2, должен быть включён модуль bzip2. Как и в
  случае с другим функционалом, модифицирующим содержание phar-архива, для успешной работы данного
  метода необходимо, чтобы INI-переменная phar.readonly была отключена.
  
  Кроме того, этот метод автоматически меняет расширения файла архива: по умолчанию <return>.phar</return> для
  phar-архивов и <return>.phar.tar</return> для phar-архивов, основанных на tar. В качестве альтернативы расширение
  файла может быть задано с помощью второго параметра.

<comment>Param:</comment>
  <info>string|null</info>  <strong>$extension</strong>  Расширениями распакованного файла по умолчанию являются <return>.phar</return> и
                           <return>.phar.tar</return>. Этот параметр может быть использован для задания другого
                           расширения распакованного файла. Имейте в виду, что все исполняемые
                           phar-архивы должны содержать <return>.phar</return> в имени файла.

<comment>Return:</comment>
  <info>Phar|null</info>  Возвращает объект <class>Phar</class> в случае успешного выполнения и <info>null</info> в случае возникновения
             ошибки.

<comment>See Also:</comment>
   * <strong>PharFileInfo::getCompressedSize()</strong>
   * <strong>PharFileInfo::isCompressed()</strong>
   * <strong>PharFileInfo::compress()</strong>
   * <strong>PharFileInfo::decompress()</strong>
   * <strong>PharData::compress()</strong>
   * <strong>Phar::canCompress()</strong>
   * <strong>Phar::isCompressed()</strong>
   * <strong>Phar::compress()</strong>
   * <strong>Phar::getSupportedCompression()</strong>
   * <strong>Phar::compressFiles()</strong>
   * <strong>Phar::decompressFiles()</strong>


id: Phar::decompressFiles
type: function
doc:
<comment>Description:</comment>
  Распаковывает все файлы в текущем Phar-архиве
  
  Для корректной работы с объектами <class>Phar</class>
  этому методу необходима установка значения php.ini <return>phar.readonly</return> в <return>0</return>.
  В противном случае, будет выброшено исключение <class>PharException</class>.
  
  В случае использования с phar-архивами, основанными на tar, этот метод выбрасывает исключение
  <class>BadMethodCallException</class>, поскольку сжатие отдельных файлов внутри tar-архива не поддерживается
  данным форматом. Для сжатия целого phar-архива, основанного на tar, используйте <strong>Phar::compress()</strong>.
  
  В случае использования с phar-архивами, основанными на zip или phar, этот метод распаковывает все
  файлы в Phar-архиве. Если какие-либо файлы внутри архива были сжаты при помощи bzip2/zlib-сжатия,
  то для возможности воспользоваться данным методом должен быть включён модуль zlib или bzip2. Как и
  в случае с другим функционалом, модифицирующим содержание phar-архива, для успешной работы данного
  метода необходимо, чтобы INI-переменная phar.readonly была отключена.

<comment>Return:</comment>
  <info>bool</info>  Возвращает <info>true</info> в случае успешного выполнения или <info>false</info> в случае возникновения ошибки.

<comment>See Also:</comment>
   * <strong>PharFileInfo::getCompressedSize()</strong>
   * <strong>PharFileInfo::isCompressed()</strong>
   * <strong>PharFileInfo::compress()</strong>
   * <strong>PharFileInfo::decompress()</strong>
   * <strong>Phar::canCompress()</strong>
   * <strong>Phar::isCompressed()</strong>
   * <strong>Phar::compressFiles()</strong>
   * <strong>Phar::getSupportedCompression()</strong>
   * <strong>Phar::compress()</strong>
   * <strong>Phar::decompress()</strong>


id: Phar::delMetadata
type: function
doc:
<comment>Description:</comment>
  Удалить глобальные метаданные в архиве phar
  
  Для корректной работы с объектами <class>Phar</class>
  этому методу необходима установка значения php.ini <return>phar.readonly</return> в <return>0</return>.
  В противном случае, будет выброшено исключение <class>PharException</class>.
  
  Удаляет глобальные метаданные в архиве phar

<comment>Return:</comment>
  <info>bool</info>  Возвращает <info>true</info> в успешного выполнения, но лучше использовать проверку исключений.

<comment>See Also:</comment>
   * <strong>Phar::getMetadata()</strong>
   * <strong>Phar::setMetadata()</strong>
   * <strong>Phar::hasMetadata()</strong>


id: Phar::delete
type: function
doc:
<comment>Description:</comment>
  Удаляет файл внутри phar-архива
  
  Для корректной работы с объектами <class>Phar</class>
  этому методу необходима установка значения php.ini <return>phar.readonly</return> в <return>0</return>.
  В противном случае, будет выброшено исключение <class>PharException</class>.
  
  Удаляет файл из архива. Эта функция аналогична вызову <strong>unlink()</strong> для обёртки потока, как это
  показано в примере ниже.

<comment>Param:</comment>
  <info>string</info>  <strong>$localName</strong>  Путь внутри архива к файлу для удаления.

<comment>Return:</comment>
  <info>bool</info>  Возвращает <info>true</info> в случае успешного выполнения, но лучше проверить, было ли выброшено
        исключение, и считать успешным вызов, в результате которого не было выброшено исключение.

<comment>See Also:</comment>
   * <strong>PharData::delete()</strong>
   * <strong>Phar::unlinkArchive()</strong>


id: Phar::extractTo
type: function
doc:
<comment>Description:</comment>
  Извлечь содержимое phar-архива в директорию
  
  Извлекает все файлы phar-архива на диск. Извлечённые файлы и директории сохраняют все разрешения,
  которые у них были. Опциональные параметры позволяют контролировать, какие именно файлы извлекать
  и нужно ли перезаписывать уже существующие. Второй параметр <strong>$files</strong> может быть как именем файла,
  так и путём директории, которые надо извлекать. По умолчанию уже существующие на диске файлы
  перезаписываться не будут. Для указания, что нужно использовать перезапись, используется третий
  параметр. Этот метод аналогичен методу <strong>ZipArchive::extractTo()</strong>.

<comment>Param:</comment>
  <info>string</info>             <strong>$directory</strong>  Путь, по которому необходимо сохраните извлечённые файлы (<strong>$files</strong>)
  <info>array|string|null</info>  <strong>$files</strong>      Имя файла или директории, которые надо извлечь или архив с именами
                                 файлов/директорий. <info>null</info> для пропуска этого параметра.
  <info>bool</info>               <strong>$overwrite</strong>  Установите в <info>true</info>, если необходимо перезаписывать уже существующие
                                 файлы

<comment>Return:</comment>
  <info>bool</info>  Возвращает <info>true</info> в случае успешного выполнения. Но лучше использовать механизм перехвата
        исключений для контроля успешности.

<comment>See Also:</comment>
   * <strong>PharData::extractTo()</strong>


id: Phar::getAlias
type: function
doc:
<comment>Description:</comment>
  Получить псевдоним для Phar
  
  К настоящему времени эта функция ещё не была документирована; для ознакомления доступен только
  список аргументов.

<comment>Return:</comment>
  <info>string|null</info>  Возвращает псевдоним или <info>null</info> в случае его отсутствия.


id: Phar::getMetadata
type: function
doc:
<comment>Description:</comment>
  Извлечь метаданные phar-архива
  
  Возвращает метаданные phar-архива. Метаданными может быть любая переменная PHP, которая может быть
  сериализована.

<comment>Return:</comment>
  <info>mixed</info>  Любое значение PHP, которое может быть сериализовано и хранится как метаданные для архива
         Phar, либо  <info>null</info>, если метаданные отсутствуют.

<comment>See Also:</comment>
   * <strong>Phar::setMetadata()</strong>
   * <strong>Phar::delMetadata()</strong>
   * <strong>Phar::hasMetadata()</strong>


id: Phar::getModified
type: function
doc:
<comment>Description:</comment>
  Определить, изменялся phar-архив
  
  Этот метод используется для определения, изменялось ли что-либо в phar-архиве.

<comment>Return:</comment>
  <info>bool</info>  <info>true</info>, если архив после открытия изменялся и <info>false</info>, в противном случае.


id: Phar::getPath
type: function
doc:
<comment>Description:</comment>
  Получить реальный путь к Phar-архиву на диске
  
  К настоящему времени эта функция ещё не была документирована; для ознакомления доступен только
  список аргументов.

<comment>Return:</comment>
  <info>string</info>  


id: Phar::getSignature
type: function
doc:
<comment>Description:</comment>
  Получить MD5/SHA1/SHA256/SHA512/OpenSSL подпись Phar-архива
  
  Возвращает проверочную подпись phar-архива в виде строки шестнадцатеричных цифр.

<comment>Return:</comment>
  <info>array|false</info>  Массив, содержащий цифровую подпись открытого архива по ключу <return>hash</return>, и <return>MD5</return>, <return>SHA-1</return>,
               <return>SHA-256</return>, <return>SHA-512</return> или <return>OpenSSL</return> по ключу <return>hash_type</return>. Подпись - это хеш, вычисленный от
               содержимого архива, которую можно использовать для проверки его целостности.
               Корректная подпись требуется для всех запускаемых phar-архивов, если разрешена
               INI-переменная phar.require_hash. Если сигнатуры нет, функция возвращает <info>false</info>.


id: Phar::getStub
type: function
doc:
<comment>Description:</comment>
  Получить загрузчик PHP или загрузчик заглушки Phar-архива
  
  Phar-архивы содержат начальную загрузку или заглушку (<return>stub</return>), написанную на PHP, который
  запускается при запуске архива, когда его подключают через include:
  ]]> или просто запускают: 

<comment>Return:</comment>
  <info>string</info>  Возвращает строку с содержанием начального загрузчика (заглушки) текущего Phar-архива.

<comment>See Also:</comment>
   * <strong>Phar::setStub()</strong>
   * <strong>Phar::createDefaultStub()</strong>


id: Phar::getSupportedCompression
type: function
doc:
<comment>Description:</comment>
  Возвращает массив поддерживаемых алгоритмов сжатия

<comment>Return:</comment>
  <info>array</info>  Возвращает массив, содержащий любые из значений <return>Phar::GZ</return> или <return>Phar::BZ2</return> в зависимости от
         доступности модулей zlib и bz2.

<comment>See Also:</comment>
   * <strong>PharFileInfo::getCompressedSize()</strong>
   * <strong>PharFileInfo::isCompressed()</strong>
   * <strong>PharFileInfo::compress()</strong>
   * <strong>PharFileInfo::decompress()</strong>
   * <strong>Phar::compress()</strong>
   * <strong>Phar::decompress()</strong>
   * <strong>Phar::canCompress()</strong>
   * <strong>Phar::isCompressed()</strong>
   * <strong>Phar::compressFiles()</strong>
   * <strong>Phar::decompressFiles()</strong>


id: Phar::getSupportedSignatures
type: function
doc:
<comment>Description:</comment>
  Получить массив поддерживаемых алгоритмов подписи архива
  
  Возвращает массив поддерживаемых алгоритмов подписи архива

<comment>Return:</comment>
  <info>array</info>  Возвращает массив примерно такого содержания: <return>MD5</return>, <return>SHA-1</return>, <return>SHA-256</return>, <return>SHA-512</return>, <return>OpenSSL</return>.

<comment>See Also:</comment>
   * <strong>Phar::getSignature()</strong>
   * <strong>Phar::setSignatureAlgorithm()</strong>


id: Phar::getVersion
type: function
doc:
<comment>Description:</comment>
  Получить версию Phar-архива
  
  Возвращает версию API открытого Phar-архива.

<comment>Return:</comment>
  <info>string</info>  Версия API открытого архива. Не перепутайте с версией API загруженного модуля phar. Каждый
          Phar-архив имеет жёстко прописанную версию API, с помощью которого его создавали, в
          манифесте. Подробную документацию можно почитать на странице Формат файла Phar.

<comment>See Also:</comment>
   * <strong>Phar::apiVersion()</strong>


id: Phar::hasMetadata
type: function
doc:
<comment>Description:</comment>
  Проверить, содержит ли phar-архив глобальные метаданные
  
  Проверяет, содержит ли phar-архив глобальные метаданные.

<comment>Return:</comment>
  <info>bool</info>  Возвращает <info>true</info> или <info>false</info>.

<comment>See Also:</comment>
   * <strong>Phar::getMetadata()</strong>
   * <strong>Phar::setMetadata()</strong>
   * <strong>Phar::delMetadata()</strong>


id: Phar::interceptFileFuncs
type: function
doc:
<comment>Description:</comment>
  Указывает phar перехватывать fopen, file_get_contents, opendir и все stat-функции
  
  Указывает phar перехватывать <strong>fopen()</strong>, <strong>readfile()</strong>, <strong>file_get_contents()</strong>, <strong>opendir()</strong> и все
  stat-функции. Если какая-либо из этих функций будет вызвана из phar-архива с относительным путём,
  то вызов будет модифицирован для доступа к содержимому архива. В случае с абсолютными путями будут
  работать штатные функции доступа к файловой системе.
  
  Эта функция позволяет писать приложения работающие не привязанные к жёсткому диску.

<comment>Return:</comment>
  <info>void</info>  


id: Phar::isBuffering
type: function
doc:
<comment>Description:</comment>
  Проверить, будут ли операции с Phar-архивом буферизованы или записаны напрямую на диск
  
  Проверяет, будут ли операции с Phar-архивом сразу записаны на диск или для этого надо вызывать
  <strong>Phar::stopBuffering()</strong>.
  
  Настройки буферизации индивидуальны для каждого архива. Включённая буферизация для <return>foo.phar</return> никак
  не влияет на режим работы с <return>bar.phar</return>.

<comment>Return:</comment>
  <info>bool</info>  Возвращает <info>true</info> или <info>false</info>.

<comment>See Also:</comment>
   * <strong>Phar::startBuffering()</strong>
   * <strong>Phar::stopBuffering()</strong>


id: Phar::isCompressed
type: function
doc:
<comment>Description:</comment>
  Возвращает Phar::GZ или PHAR::BZ2, если phar-архив сжат целиком (.tar.gz/tar.bz и так далее)
  
  Для корректной работы с объектами <class>Phar</class>
  этому методу необходима установка значения php.ini <return>phar.readonly</return> в <return>0</return>.
  В противном случае, будет выброшено исключение <class>PharException</class>.
  
  Возвращает Phar::GZ или PHAR::BZ2, если phar-архив сжат целиком (.tar.gz/tar.bz и так далее).
  Phar-архивы, основанные на zip, не могут быть сжаты целиком, поэтому этот метод всегда возвращает
  <info>false</info>, если он был вызван на phar-архиве, основанном на zip.

<comment>Return:</comment>
  <info>int|false</info>  <return>Phar::GZ</return>, <return>Phar::BZ2</return> или <info>false</info>.

<comment>See Also:</comment>
   * <strong>PharFileInfo::getCompressedSize()</strong>
   * <strong>PharFileInfo::isCompressed()</strong>
   * <strong>PharFileInfo::decompress()</strong>
   * <strong>PharFileInfo::compress()</strong>
   * <strong>Phar::decompress()</strong>
   * <strong>Phar::compress()</strong>
   * <strong>Phar::canCompress()</strong>
   * <strong>Phar::compressFiles()</strong>
   * <strong>Phar::decompressFiles()</strong>
   * <strong>Phar::getSupportedCompression()</strong>


id: Phar::isFileFormat
type: function
doc:
<comment>Description:</comment>
  Проверить, что phar-архив имеет заданный формат (tar/phar/zip)

<comment>Param:</comment>
  <info>int</info>  <strong>$format</strong>  <return>Phar::PHAR</return>, <return>Phar::TAR</return> или <return>Phar::ZIP</return>, в зависимости от проверяемого формата.

<comment>Return:</comment>
  <info>bool</info>  Возвращает <info>true</info>, если phar-архив имеет указанный формат

<comment>See Also:</comment>
   * <strong>Phar::convertToExecutable()</strong>
   * <strong>Phar::convertToData()</strong>


id: Phar::isValidPharFilename
type: function
doc:
<comment>Description:</comment>
  Проверяет, что заданное имя файла является корректным именем phar-архива
  
  Проверяет, что заданное имя файла является корректным именем phar-архива. Можно использовать для
  проверки имени файла до момента его непосредственного создания, чтобы избежать нежелательных
  исключений.

<comment>Param:</comment>
  <info>string</info>  <strong>$filename</strong>    Имя или полный путь до файла, который ещё не создан
  <info>bool</info>    <strong>$executable</strong>  Этот параметр определяет, должен ли файл опознаваться как запускаемый
                       phar-архив, или как незапускаемый архив с данными

<comment>Return:</comment>
  <info>bool</info>  Возвращает <info>true</info> или <info>false</info>.


id: Phar::isWritable
type: function
doc:
<comment>Description:</comment>
  Проверяет, можно ли модифицировать phar-архив
  
  Этот метод возвращает <info>true</info>, если <return>phar.readonly</return> установлен в <return>0</return>, архив существует и доступен для
  записи.

<comment>Return:</comment>
  <info>bool</info>  Возвращает <info>true</info>, если архив можно модифицировать

<comment>See Also:</comment>
   * <strong>Phar::canWrite()</strong>
   * <strong>PharData::isWritable()</strong>


id: Phar::loadPhar
type: function
doc:
<comment>Description:</comment>
  Загрузить phar-архив с псевдонимом
  
  Может использоваться для загрузки внешнего Phar-архива. То, что для phar-архива назначается
  псевдоним, позволяет в дальнейшем использовать более короткие ссылки для доступа к нему или же для
  загрузки архивов Phar, содержащих только данные и не предназначенных для выполнения.

<comment>Param:</comment>
  <info>string</info>       <strong>$filename</strong>  Путь к загружаемому phar-архиву
  <info>string|null</info>  <strong>$alias</strong>     Псевдоним для доступа к архиву. Обратите внимание, что многие phar-архивы
                          имеют свой явно заданный псевдоним и, при задании нового псевдонима, будет
                          выброшено исключение <class>PharException</class>.

<comment>Return:</comment>
  <info>bool</info>  Возвращает <info>true</info> в случае успешного выполнения или <info>false</info> в случае возникновения ошибки.

<comment>See Also:</comment>
   * <strong>Phar::mapPhar()</strong>


id: Phar::mapPhar
type: function
doc:
<comment>Description:</comment>
  Прочитать текущий запущенный phar-архив и зарегистрировать его манифест
  
  Этот статический метод можно использовать только в заглушке загрузчика Phar-архива в целях его
  инициализации, когда он запущен напрямую, либо включён в другой скрипт.

<comment>Param:</comment>
  <info>string|null</info>  <strong>$alias</strong>   Псевдоним можно использовать в обёртках <return>phar://</return>, ссылаясь на этот архив,
                        вместо использования полного пути.
  <info>int</info>          <strong>$offset</strong>  Неиспользуемая переменная. Существует только для совместимости с
                        PEAR-пакетом PHP_Archive.

<comment>Return:</comment>
  <info>bool</info>  Возвращает <info>true</info> в случае успешного выполнения или <info>false</info> в случае возникновения ошибки.

<comment>See Also:</comment>
   * <strong>Phar::loadPhar()</strong>


id: Phar::mount
type: function
doc:
<comment>Description:</comment>
  Монтирование внешнего путь или файла к виртуальному пути в phar-архиве
  
  Очень похоже на концепцию файловой системы unix по монтированию внешнего устройства в существующее
  дерево директорий. <strong>Phar::mount()</strong> позволяет ссылаться на внешние файлы и директории, как будто они
  находятся внутри архива. Это позволяет повысить уровень абстракции обращаясь ко внешним
  конфигурационным файлам так, как будто они являются частью архива.

<comment>Param:</comment>
  <info>string</info>  <strong>$pharPath</strong>      Внутренний путь в архиве, по которому необходимо примонтировать внешний
                         путь. Это должен быть несуществующий относительный путь внутри архива.
  <info>string</info>  <strong>$externalPath</strong>  Путь или URL внешнего файла или директории

<comment>Return:</comment>
  <info>void</info>  Ничего не возвращает. В случае возникновения ошибки выбрасывает исключение <class>PharException</class>.


id: Phar::mungServer
type: function
doc:
<comment>Description:</comment>
  Определить список до четырёх $_SERVER-переменных, которые должны быть изменены для запуска
  
  Функция <strong>Phar::mungServer()</strong> должна вызываться только в загрузчике.
  
  Определяет список до четырёх $_SERVER-переменных, которые необходимо модифицировать для запуска.
  Модификация заключается в удалении следов запуска из phar-архива для переменных <return>REQUEST_URI</return>,
  <return>PHP_SELF</return>, <return>SCRIPT_NAME</return> и <return>SCRIPT_FILENAME</return>.
  
  Сам по себе этот метод ничего не делает. Эффект достигается только в комбинации с <strong>Phar::webPhar()</strong>
  и только если запрошенный файл является PHP-файлом для разбора. Обратите внимание, что переменные
  <return>PATH_INFO</return> и <return>PATH_TRANSLATED</return> всегда модифицированы.
  
  Оригинальные значения изменяемых переменных будут сохранены в массиве SERVER с префиксами <return>PHAR_</return>.
  Например, оригинальное значение <return>SCRIPT_NAME</return> будет записано в <return>PHAR_SCRIPT_NAME</return>.

<comment>Param:</comment>
  <info>array</info>  <strong>$variables</strong>  Массив любой из строк: <return>REQUEST_URI</return>, <return>PHP_SELF</return>, <return>SCRIPT_NAME</return> и <return>SCRIPT_FILENAME</return>.
                     Любые другие значения вызовут исключение. Обратите внимание, что функция
                     <strong>Phar::mungServer()</strong> чувствительна к регистру символов.

<comment>Return:</comment>
  <info>void</info>  Ничего не возвращает.

<comment>See Also:</comment>
   * <strong>Phar::webPhar()</strong>
   * <strong>Phar::setStub()</strong>


id: Phar::offsetExists
type: function
doc:
<comment>Description:</comment>
  Определить, есть ли файл в архиве
  
  Это реализация интерфейса ArrayAccess, позволяющая манипулировать содержимым Phar-архива в стиле
  доступа к элементам массива.
  
  offsetExists() запускается каждый раз, когда вызывается <strong>isset()</strong>.

<comment>Param:</comment>
  <info>string</info>  <strong>$localName</strong>  Имя файла (относительный путь).

<comment>Return:</comment>
  <info>bool</info>  Возвращает <info>true</info>, если файл присутствует в архиве и <info>false</info> в противном случае.

<comment>See Also:</comment>
   * <strong>Phar::offsetGet()</strong>
   * <strong>Phar::offsetSet()</strong>
   * <strong>Phar::offsetUnset()</strong>


id: Phar::offsetGet
type: function
doc:
<comment>Description:</comment>
  Получить объект PharFileInfo для конкретного файла
  
  Это реализация интерфейса ArrayAccess, позволяющая манипулировать содержимым Phar-архива в стиле
  доступа к элементам массива. Phar::offsetGet используется для извлечения файлов из архива.

<comment>Param:</comment>
  <info>string</info>  <strong>$localName</strong>  Имя файла (относительный путь).

<comment>Return:</comment>
  <info>SplFileInfo</info>  Объект класса <class>PharFileInfo</class>. Можно использовать для получения информации о файле и для
               извлечения контента через итерирование.

<comment>See Also:</comment>
   * <strong>Phar::offsetExists()</strong>
   * <strong>Phar::offsetSet()</strong>
   * <strong>Phar::offsetUnset()</strong>


id: Phar::offsetSet
type: function
doc:
<comment>Description:</comment>
  Изменение содержимого файла
  
  Для корректной работы с объектами <class>Phar</class>
  этому методу необходима установка значения php.ini <return>phar.readonly</return> в <return>0</return>.
  В противном случае, будет выброшено исключение <class>PharException</class>.
  
  Это реализация интерфейса ArrayAccess, позволяющая манипулировать содержимым Phar-архива в стиле
  доступа к элементам массива. offsetSet используется для изменения контента существующего файла,
  либо для создания нового.

<comment>Param:</comment>
  <info>string</info>           <strong>$localName</strong>  Имя файла (относительный путь).
  <info>resource|string</info>  <strong>$value</strong>      Содержимое файла.

<comment>Return:</comment>
  <info>void</info>  Ничего не возвращает.

<comment>See Also:</comment>
   * <strong>Phar::offsetExists()</strong>
   * <strong>Phar::offsetGet()</strong>
   * <strong>Phar::offsetUnset()</strong>


id: Phar::offsetUnset
type: function
doc:
<comment>Description:</comment>
  Удалить файл из phar-архива
  
  Для корректной работы с объектами <class>Phar</class>
  этому методу необходима установка значения php.ini <return>phar.readonly</return> в <return>0</return>.
  В противном случае, будет выброшено исключение <class>PharException</class>.
  
  Это реализация интерфейса ArrayAccess, позволяющая манипулировать содержимым Phar-архива в стиле
  доступа к элементам массива. offsetUnset используется для удаления файлов и запускается каждый
  раз, когда используется конструкция <strong>unset()</strong>.

<comment>Param:</comment>
  <info>string</info>  <strong>$localName</strong>  Имя файла (относительный путь).

<comment>Return:</comment>
  <info>void</info>  Функция не возвращает значения после выполнения.

<comment>See Also:</comment>
   * <strong>Phar::offsetExists()</strong>
   * <strong>Phar::offsetGet()</strong>
   * <strong>Phar::offsetSet()</strong>
   * <strong>Phar::unlinkArchive()</strong>
   * <strong>Phar::delete()</strong>


id: Phar::running
type: function
doc:
<comment>Description:</comment>
  Получить полный путь на диске, либо полный URL запущенного Phar-архива
  
  Возвращает полный путь запущенного phar-архива. Используется для того же, для чего используется
  константа <return>__FILE__</return> и работает только внутри запущенного phar-архива.
  
  При запуске <strong>Phar::running()</strong> из загрузчика результат будет <return>""</return>.  Внутри загрузчика используйте
  константу <info>__FILE__</info>.

<comment>Param:</comment>
  <info>bool</info>  <strong>$returnPhar</strong>  Если <info>false</info>, то будет возвращён полный дисковый путь к phar-архиву. Если <info>true</info>,
                     то будет возвращён полный URL.

<comment>Return:</comment>
  <info>string</info>  Вернёт путь, если он корректен, либо пустую строку.


id: Phar::setAlias
type: function
doc:
<comment>Description:</comment>
  Установить псевдоним для Phar-архива
  
  Для корректной работы с объектами <class>Phar</class>
  этому методу необходима установка значения php.ini <return>phar.readonly</return> в <return>0</return>.
  В противном случае, будет выброшено исключение <class>PharException</class>.
  
  Устанавливает псевдоним для Phar-архива и записывает его как постоянный псевдоним для этого
  архива. Псевдоним можно использовать внутри phar-архива для уверенности в том, что доступ через
  потоковую обёртку <return>phar</return> для доступа к внутренним файлам будет работать всегда, независимо от
  местоположения phar-архива на файловой системе. Другой альтернативой является надежда на перехват
  <strong>include()</strong> или использование <strong>Phar::interceptFileFuncs()</strong> совместно с относительными путями.

<comment>Param:</comment>
  <info>string</info>  <strong>$alias</strong>  Короткое имя, которое можно будет использовать с доступом через потоковую обёртку
                  <return>phar</return>.

<comment>Return:</comment>
  <info>bool</info>  

<comment>See Also:</comment>
   * <strong>Phar::__construct()</strong>
   * <strong>Phar::interceptFileFuncs()</strong>


id: Phar::setDefaultStub
type: function
doc:
<comment>Description:</comment>
  Установить загрузчик PHP или начальную заглушку Phar-архива в загрузчик по умолчанию
  
  Для корректной работы с объектами <class>Phar</class>
  этому методу необходима установка значения php.ini <return>phar.readonly</return> в <return>0</return>.
  В противном случае, будет выброшено исключение <class>PharException</class>.
  
  Этот метод комбинирует функциональность двух других методов, <strong>Phar::createDefaultStub()</strong> и
  <strong>Phar::setStub()</strong>.

<comment>Param:</comment>
  <info>string|null</info>  <strong>$index</strong>     Относительный путь в phar-архиве для запуска при доступе из командной
                          строки
  <info>string|null</info>  <strong>$webIndex</strong>  Относительный путь в phar-архиве для запуска при доступе из веб-браузера

<comment>Return:</comment>
  <info>bool</info>  Возвращает <info>true</info> в случае успешного выполнения или <info>false</info> в случае возникновения ошибки.

<comment>See Also:</comment>
   * <strong>Phar::setStub()</strong>
   * <strong>Phar::createDefaultStub()</strong>


id: Phar::setMetadata
type: function
doc:
<comment>Description:</comment>
  Установить метаданные phar-архива
  
  Для корректной работы с объектами <class>Phar</class>
  этому методу необходима установка значения php.ini <return>phar.readonly</return> в <return>0</return>.
  В противном случае, будет выброшено исключение <class>PharException</class>.
  
  Функция <strong>Phar::setMetadata()</strong> используется для сохранения данных, характеризующих phar-архив в
  целом. <strong>PharFileInfo::setMetadata()</strong> используется для установки метаданных для конкретного файла.
  Если метаданных будет много, то это может снизить скорость загрузки phar-архива.
  
  Метаданные можно использовать, например, для указания, какой файл должен исполняться при загрузке,
  или для указания местоположения манифеста, типа package.xml для модуля PEAR. В общем, любые
  полезные в контексте phar-архива данные.

<comment>Param:</comment>
  <info>mixed</info>  <strong>$metadata</strong>  Любая переменная PHP, содержащая необходимую информацию

<comment>Return:</comment>
  <info>void</info>  Функция не возвращает значения после выполнения.

<comment>See Also:</comment>
   * <strong>Phar::getMetadata()</strong>
   * <strong>Phar::delMetadata()</strong>
   * <strong>Phar::hasMetadata()</strong>


id: Phar::setSignatureAlgorithm
type: function
doc:
<comment>Description:</comment>
  Установить алгоритм подписания phar-архива и применение его
  
  Для корректной работы с объектами <class>Phar</class>
  этому методу необходима установка значения php.ini <return>phar.readonly</return> в <return>0</return>.
  В противном случае, будет выброшено исключение <class>PharException</class>.
  
  Устанавливает алгоритм подписания phar-архива и применяет его. Доступны следующие алгоритмы
  подписания: <return>Phar::MD5</return>, <return>Phar::SHA1</return>, <return>Phar::SHA256</return>, <return>Phar::SHA512</return> и <return>Phar::OPENSSL</return>.
  
  Обратите внимание, что для всех исполняемых phar-архивов подпись создаётся автоматически, с
  использованием по умолчанию <return>SHA1</return>. Архивы с данными на основе tar или zip (созданные с помощью
  класса <class>PharData</class>) должны иметь явно созданную с помощью <strong>Phar::setSignatureAlgorithm()</strong> подпись.

<comment>Param:</comment>
  <info>int</info>          <strong>$algo</strong>        Одна из констант: <return>Phar::MD5</return>, <return>Phar::SHA1</return>, <return>Phar::SHA256</return>, <return>Phar::SHA512</return> или
                            <return>Phar::OPENSSL</return>
  <info>string|null</info>  <strong>$privateKey</strong>  Секретный ключ OpenSSL, извлечённый из сертификата, либо файл с ключом
                            OpenSSL: setSignatureAlgorithm(Phar::OPENSSL, $pkey);
                            ?>
                            ]]> Подробности об именовании и размещении файла открытого ключа
                            смотрите в разделе Введение в phar.

<comment>Return:</comment>
  <info>void</info>  Функция не возвращает значения после выполнения.

<comment>See Also:</comment>
   * <strong>Phar::getSupportedSignatures()</strong>
   * <strong>Phar::getSignature()</strong>


id: Phar::setStub
type: function
doc:
<comment>Description:</comment>
  Установить загрузчик или загрузочную заглушку в Phar-архив
  
  Для корректной работы с объектами <class>Phar</class>
  этому методу необходима установка значения php.ini <return>phar.readonly</return> в <return>0</return>.
  В противном случае, будет выброшено исключение <class>PharException</class>.
  
  Этот метод используется для добавления начальной загрузочной заглушки PHP (PHP bootstrap loader
  stub) в новый Phar-архив, либо для замены уже существующего загрузочной заглушки.
  
  Загрузчик заглушки используется при подключении Phar-архива с помощью included:
  
  Загрузчик не доступен, когда архив включается с использованием обёртки <return>phar</return>, как в примере ниже:

<comment>Param:</comment>
  <info>resource|string</info>  <strong>$stub</strong>    Строка, либо открытый ресурс потока.
  <info>int</info>              <strong>$length</strong>  

<comment>Return:</comment>
  <info>bool</info>  Возвращает <info>true</info> в случае успешного выполнения или <info>false</info> в случае возникновения ошибки.

<comment>See Also:</comment>
   * <strong>Phar::getStub()</strong>
   * <strong>Phar::createDefaultStub()</strong>


id: Phar::startBuffering
type: function
doc:
<comment>Description:</comment>
  Запускает буферизацию операций записи, отключая запись изменений Phar-архива на диск
  
  Метод <strong>Phar::startBuffering()</strong> может дать значительный прирост производительности при создании, либо
  модификации phar-архива с большим количеством файлов. Обычно, когда добавляется новый файл, либо
  изменяется существующий, запускается операция пересоздания phar-архива. С включённой буферизацией
  архив будет пересоздан один раз в самом конце внесения изменений.
  
  Эта концепция работает аналогично транзакции в базе данных, что позволяет сделать вне необходимые
  изменения и применить их одновременно, в рамках одной операции. Такое поведение обеспечивает пара
  методов <strong>Phar::startBuffering()</strong>/<strong>Phar::stopBuffering()</strong>.
  
  Настройки буферизации индивидуальны для каждого архива. Включённая буферизация для <return>foo.phar</return> никак
  не влияет на режим работы с <return>bar.phar</return>.

<comment>Return:</comment>
  <info>void</info>  Функция не возвращает значения после выполнения.

<comment>See Also:</comment>
   * <strong>Phar::stopBuffering()</strong>
   * <strong>Phar::isBuffering()</strong>


id: Phar::stopBuffering
type: function
doc:
<comment>Description:</comment>
  Останавливает буферизацию и записывает все изменения на диск
  
  Метод <strong>Phar::stopBuffering()</strong> используется совместно с методом <strong>Phar::startBuffering()</strong>.
  <strong>Phar::startBuffering()</strong> может дать значительный прирост производительности при создании, либо
  модификации phar-архива с большим количеством файлов. Обычно, когда добавляется новый файл, либо
  изменяется существующий, запускается операция пересоздания phar-архива. С включённой буферизацией
  архив будет пересоздан один раз в самом конце внесения изменений.
  
  Эта концепция работает аналогично транзакции в базе данных, что позволяет сделать вне необходимые
  изменения и применить их одновременно, в рамках одной операции. Такое поведение обеспечивает пара
  методов <strong>Phar::startBuffering()</strong>/<strong>Phar::stopBuffering()</strong>.
  
  Настройки буферизации индивидуальны для каждого архива. Включённая буферизация для <return>foo.phar</return> никак
  не влияет на режим работы с <return>bar.phar</return>.

<comment>Return:</comment>
  <info>void</info>  Функция не возвращает значения после выполнения.

<comment>See Also:</comment>
   * <strong>Phar::startBuffering()</strong>
   * <strong>Phar::isBuffering()</strong>


id: Phar::unlinkArchive
type: function
doc:
<comment>Description:</comment>
  Полностью удалить архив из памяти и с диска
  
  Полностью удаляет архив из памяти и с диска.

<comment>Param:</comment>
  <info>string</info>  <strong>$filename</strong>  Путь к архиву на файловой системе.

<comment>Return:</comment>
  <info>bool</info>  Возвращает <info>true</info> в случае успешного выполнения или <info>false</info> в случае возникновения ошибки.

<comment>See Also:</comment>
   * <strong>Phar::delete()</strong>
   * <strong>Phar::offsetUnset()</strong>


id: Phar::webPhar
type: function
doc:
<comment>Description:</comment>
  Направляет запрос из браузера во внутренний файл в phar-архиве
  
  <strong>Phar::webPhar()</strong> служит <strong>Phar::mapPhar()</strong> для веб-архивов phar. Метод анализирует
  $_SERVER['REQUEST_URI'] и направляет запрос из браузера во внутренний файл в phar-архиве. Он
  имитирует веб-сервер, направляет запросы к нужному файлу, отображает правильные заголовки и
  анализирует файлы PHP по мере необходимости. В сочетании с <strong>Phar::mungServer()</strong> и
  <strong>Phar::interceptFileFuncs()</strong>, любое веб-приложение можно использовать без изменений из phar-архива.
  
  <strong>Phar::webPhar()</strong> должен вызываться только из заглушки (stub) phar-архива (о том, что такое заглушка
  и как с ним работать, читайте тут).

<comment>Param:</comment>
  <info>string|null</info>    <strong>$alias</strong>               Псевдоним для использования в обёртках <return>phar://</return>.
  <info>string|null</info>    <strong>$index</strong>               Местоположение в phar-архиве индексного файла.
  <info>string|null</info>    <strong>$fileNotFoundScript</strong>  Местоположение скрипта, отвечающего за обработку ошибки HTTP
                                      404. Скрипт должен возвращать корректные заголовки для этой
                                      ошибки.
  <info>array</info>          <strong>$mimeTypes</strong>           Массив сопоставления расширений файлов типам MIME. Если
                                      достаточно сопоставления по умолчанию, то передайте сюда
                                      пустой массив. По умолчанию используются такие сопоставления:
                                      Phar::PHPS, // передаётся в highlight_file() 'c' =>
                                      'text/plain', 'cc' => 'text/plain', 'cpp' => 'text/plain',
                                      'c++' => 'text/plain', 'dtd' => 'text/plain', 'h' =>
                                      'text/plain', 'log' => 'text/plain', 'rng' => 'text/plain',
                                      'txt' => 'text/plain', 'xsd' => 'text/plain', 'php' =>
                                      Phar::PHP, // разбирается как PHP 'inc' => Phar::PHP, //
                                      разбирается как PHP 'avi' => 'video/avi', 'bmp' =>
                                      'image/bmp', 'css' => 'text/css', 'gif' => 'image/gif', 'htm'
                                      => 'text/html', 'html' => 'text/html', 'htmls' => 'text/html',
                                      'ico' => 'image/x-ico', 'jpe' => 'image/jpeg', 'jpg' =>
                                      'image/jpeg', 'jpeg' => 'image/jpeg', 'js' =>
                                      'application/x-javascript', 'midi' => 'audio/midi', 'mid' =>
                                      'audio/midi', 'mod' => 'audio/mod', 'mov' =>
                                      'movie/quicktime', 'mp3' => 'audio/mp3', 'mpg' =>
                                      'video/mpeg', 'mpeg' => 'video/mpeg', 'pdf' =>
                                      'application/pdf', 'png' => 'image/png', 'swf' =>
                                      'application/shockwave-flash', 'tif' => 'image/tiff', 'tiff'
                                      => 'image/tiff', 'wav' => 'audio/wav', 'xbm' => 'image/xbm',
                                      'xml' => 'text/xml',
                                      );
                                      ?>
                                      ]]>
  <info>callable|null</info>  <strong>$rewrite</strong>             Функция перезаписи, которой передаётся единственный строковый
                                      параметр и которая должна также вернуть строку, либо <info>false</info>.
                                      
                                      Если вы используете fast-cgi или cgi, то параметром,
                                      передаваемым в эту функцию будет значение переменной
                                      $_SERVER['PATH_INFO']. В ином случае передаваться будет
                                      значение переменной $_SERVER['REQUEST_URI'].
                                      
                                      Если будет возвращена строка, то она будет использована как
                                      путь к файлу внутри архива. Если вернётся <info>false</info>, то webPhar()
                                      пошлёт код ошибки HTTP 403.

<comment>Return:</comment>
  <info>void</info>  Функция не возвращает значения после выполнения.

<comment>See Also:</comment>
   * <strong>Phar::mungServer()</strong>
   * <strong>Phar::interceptFileFuncs()</strong>


id: PharData
type: class
doc:
<comment>Description:</comment>
  Класс PharData предоставляет высокоуровневый интерфейс доступа и создания неисполняемых tar- и
  zip-архивов. Поскольку архивы этих типов не содержат заглушку и не могут быть выполнены модулем
  Phar, есть возможность создавать и обрабатывать обычные zip- и tar-файлы, используя класс
  PharData, даже если параметр <return>phar.readonly</return> в php.ini равен <return>1</return>.


id: PharData::__construct
type: function
doc:
<comment>Description:</comment>
  Конструктор объекта PharData

<comment>Param:</comment>
  <info>string</info>       <strong>$filename</strong>  Путь либо к существующему tar/zip-архиву, либо к вновь создаваемому
  <info>int</info>          <strong>$flags</strong>     Флаги для передачи родительскому классу <class>Phar</class> <class>RecursiveDirectoryIterator</class>.
  <info>string|null</info>  <strong>$alias</strong>     Псевдоним, который необходимо назначить phar-архиву для использования в
                          потоковых обёртках.
  <info>int</info>          <strong>$format</strong>    Одна из констант формата файлов доступная для класса <class>Phar</class>.


id: PharData::addEmptyDir
type: function
doc:
<comment>Description:</comment>
  Добавить пустую директорию в tar/zip-архив
  
  С помощью этого места можно создать директорию по пути <return>dirname</return>. Этот метод аналогичен
  <strong>ZipArchive::addEmptyDir()</strong>.

<comment>Param:</comment>
  <info>string</info>  <strong>$directory</strong>  Путь создаваемой директории

<comment>Return:</comment>
  <info>void</info>  Ничего не возвращает. В случае ошибок выбрасывает исключение.

<comment>See Also:</comment>
   * <strong>Phar::addEmptyDir()</strong>
   * <strong>PharData::addFile()</strong>
   * <strong>PharData::addFromString()</strong>


id: PharData::addFile
type: function
doc:
<comment>Description:</comment>
  Добавить существующие файлы к tar/zip-архиву
  
  С помощью этого метода можно добавить к архиву любые файлы или URL. Если задан опциональный
  параметр <return>localname</return>, то файл будет добавлен в архив с указанным именем, иначе будет использовано
  оригинальное имя из параметра <return>file</return>. Для URL локальное имя должно быть указано в обязательном
  порядке, иначе будет выброшено исключение. Метод аналогичен <strong>ZipArchive::addFile()</strong>.

<comment>Param:</comment>
  <info>string</info>       <strong>$filename</strong>   Полный или относительный путь до файла на диске.
  <info>string|null</info>  <strong>$localName</strong>  Путь, по которому файл необходимо добавить в архив.

<comment>Return:</comment>
  <info>void</info>  Ничего не возвращает, а в случае возникновения ошибки выбрасывает исключение.

<comment>See Also:</comment>
   * <strong>PharData::offsetSet()</strong>
   * <strong>Phar::addFile()</strong>
   * <strong>PharData::addFromString()</strong>
   * <strong>PharData::addEmptyDir()</strong>


id: PharData::addFromString
type: function
doc:
<comment>Description:</comment>
  Добавляет файл из строки в архив tar/zip
  
  Этот метод позволяет создать внутри архива файл с заданным текстом. Файл будет сохранён по пути
  <return>localname</return>. Этот метод аналогичен <strong>ZipArchive::addFromString()</strong>.

<comment>Param:</comment>
  <info>string</info>  <strong>$localName</strong>  Путь создаваемого файла.
  <info>string</info>  <strong>$contents</strong>   Содержимое файла в виде строки

<comment>Return:</comment>
  <info>void</info>  Ничего не возвращает, в случае возникновения ошибки выбрасывает исключение.

<comment>See Also:</comment>
   * <strong>PharData::offsetSet()</strong>
   * <strong>Phar::addFromString()</strong>
   * <strong>PharData::addFile()</strong>
   * <strong>PharData::addEmptyDir()</strong>


id: PharData::buildFromDirectory
type: function
doc:
<comment>Description:</comment>
  Создаёт tar/zip-архив из файлов в директории
  
  Наполняет tar/zip-архив содержимым директории. Второй опциональный параметр является регулярным
  выражением (pcre). Файлы, имена которых подходят под регулярное выражение, будут включены в архив,
  а все остальные нет. Если при создании архива нужна большая избирательность, то используйте метод
  <strong>PharData::buildFromIterator()</strong>.

<comment>Param:</comment>
  <info>string</info>  <strong>$directory</strong>  Полный или относительный путь до директории, файлы из которой будут добавлены
                      в архив.
  <info>string</info>  <strong>$pattern</strong>    Регулярное выражение, определяющее, какие файлы необходимо включать в архив.

<comment>Return:</comment>
  <info>array</info>  <strong>Phar::buildFromDirectory()</strong> возвращает ассоциативный массив, связывающий путь к файлу внутри
         архива с полным путём к файлу на диске или <info>false</info> в случае возникновения ошибки.

<comment>See Also:</comment>
   * <strong>Phar::buildFromDirectory()</strong>
   * <strong>PharData::buildFromIterator()</strong>


id: PharData::buildFromIterator
type: function
doc:
<comment>Description:</comment>
  Создание tar/zip-архива с помощью итератора
  
  Наполнение архив tar или zip с помощью итератора. Поддерживаются два типа итераторов: итератор,
  связывающий файл на диске с файлом внутри архива и итератор в стиле DirectoryIterator, который
  возвращает объекты SplFileInfo. Для итераторов, возвращающих объекты SplFileInfo, второй параметр
  является обязательным.

<comment>Param:</comment>
  <info>Traversable</info>  <strong>$iterator</strong>       Итератор, предоставляющий связки ключ=&gt;значение, либо объекты
                               SplFileInfo
  <info>string|null</info>  <strong>$baseDirectory</strong>  Для итераторов, возвращающих объекты SplFileInfo, часть полного пути
                               добавляемых файлов, которая будет удаляться из полного пути внутри
                               архива.

<comment>Return:</comment>
  <info>array</info>  <strong>PharData::buildFromIterator()</strong> возвращает ассоциативный массив, связывающий путь к файлу
         внутри архива с полным путём к файлу на диске.

<comment>See Also:</comment>
   * <strong>Phar::buildFromIterator()</strong>


id: PharData::compress
type: function
doc:
<comment>Description:</comment>
  Сжимает весь архив tar/zip, используя сжатие Gzip или Bzip2
  
  Для tar-архивов, этот метод произведёт сжатие всего архива с помощью gzip или bzip2.
  Результирующий файл можно распаковать с помощью команд gunzip или bunzip, либо использовать
  напрямую через модуль Phar.
  
  Для zip-архивов этот метод выбросит исключение. Для gzip-сжатия должен быть доступен модуль zlib.
  Для bzip2-сжатия должен быть доступен модуль bzip2.
  
  Этот метод переименовывает архив, добавляя к его имени расширение <return>.gz</return>, <return>.bz2</return> или наоборот,
  убирающее его, если параметр типа сжатия задан как <return>Phar::NONE</return>. Также можно явно указать, какое
  расширение будет иметь файл.

<comment>Param:</comment>
  <info>int</info>          <strong>$compression</strong>  Одна из констант: <return>Phar::GZ</return>, <return>Phar::BZ2</return>, или <return>Phar::NONE</return> для отключения
                             компрессии.
  <info>string|null</info>  <strong>$extension</strong>    По умолчанию файлу назначится расширение <return>.tar.gz</return> или <return>.tar.bz2</return> для
                             сжатия и <return>.tar</return>, если сжатие отключено.

<comment>Return:</comment>
  <info>PharData|null</info>  Возвращает объект <class>PharData</class> в случае успешного выполнения или <info>null</info> в случае
                 возникновения ошибки.

<comment>See Also:</comment>
   * <strong>Phar::compress()</strong>


id: PharData::compressFiles
type: function
doc:
<comment>Description:</comment>
  Сжать все файлы в текущем tar/zip-архиве
  
  Для tar-архивов данный метод выбросит исключение <class>BadMethodCallException</class>, так как сжатие отдельных
  файлов в tar-архиве не поддерживается форматом файла. Используйте <strong>PharData::compress()</strong> для сжатия
  всего tar-архива.
  
  Для Zip-архивов этот метод сожмёт все файлы используя заданный тип сжатия. Для корректной работы
  требуются включённые модули zlib  или bzip2, в зависимости от типа сжатия. Также, если некоторые
  файлы уже были сжаты, то необходимо, чтобы соответствующий модуль был включён, иначе не удастся
  обработать.

<comment>Param:</comment>
  <info>int</info>  <strong>$compression</strong>  Одна из констант: <return>Phar::GZ</return>, <return>Phar::BZ2</return> или <return>Phar::NONE</return>, для отмены сжатия.

<comment>Return:</comment>
  <info>void</info>  Функция не возвращает значения после выполнения.

<comment>See Also:</comment>
   * <strong>PharFileInfo::getCompressedSize()</strong>
   * <strong>PharFileInfo::isCompressed()</strong>
   * <strong>PharFileInfo::compress()</strong>
   * <strong>PharFileInfo::decompress()</strong>
   * <strong>Phar::canCompress()</strong>
   * <strong>Phar::isCompressed()</strong>
   * <strong>PharData::decompressFiles()</strong>
   * <strong>Phar::getSupportedCompression()</strong>
   * <strong>PharData::compress()</strong>
   * <strong>PharData::decompress()</strong>


id: PharData::convertToData
type: function
doc:
<comment>Description:</comment>
  Конвертация phar-архива в незапускаемый tar/zip-архив
  
  Этот метод используется для преобразования незапускаемого tar/zip-архива в другой незапускаемый
  формат.
  
  Если не указано никаких изменений, то будет выброшено исключение <class>BadMethodCallException</class>. Этот
  метод можно использовать для преобразования tar-архива в zip-архив и наоборот. Несмотря на то что,
  что можно изменить сжатие для tar-архива с помощью этого метода, для этих целей лучше использовать
  метод <strong>PharData::compress()</strong>.
  
  В случае успешного выполнения будет создан новый архив на диске и возвращён объект <class>PharData</class>.
  Старый архив удаляться не будет.

<comment>Param:</comment>
  <info>int|null</info>     <strong>$format</strong>       Одна из констант: <return>Phar::TAR</return> или <return>Phar::ZIP</return>.  Если задать как <info>null</info>, то
                             будет использован текущий формат.
  <info>int|null</info>     <strong>$compression</strong>  Одна из констант: <return>Phar::NONE</return> (для отключения сжатия всего архива),
                             <return>Phar::GZ</return> (для zlib-сжатия), <return>Phar::BZ2</return> (для bzip-сжатия).
  <info>string|null</info>  <strong>$extension</strong>    Этот параметр используется для явного указания расширения нового
                             архива. Обратите внимание, что для незапускаемых архивов ни в коем
                             случае нельзя допускать появление подстроки <return>.phar</return> в любом месте имени
                             файла.
                             
                             По умолчанию для tar-архивов используются расширения: <return>.tar</return>, <return>.tar.gz</return> и
                             <return>.tar.bz2</return>. Для zip-архивов: <return>.zip</return>.

<comment>Return:</comment>
  <info>PharData|null</info>  Метод возвращает объект <class>PharData</class> или <info>null</info> в случае возникновения ошибки.

<comment>See Also:</comment>
   * <strong>Phar::convertToExecutable()</strong>
   * <strong>Phar::convertToData()</strong>
   * <strong>PharData::convertToExecutable()</strong>


id: PharData::convertToExecutable
type: function
doc:
<comment>Description:</comment>
  Конвертация tar/zip-архива с данными в запускаемый phar-архив
  
  Для корректной работы с объектами <class>Phar</class>
  этому методу необходима установка значения php.ini <return>phar.readonly</return> в <return>0</return>.
  В противном случае, будет выброшено исключение <class>PharException</class>.
  
  Этот метод используется для конвертации незапускаемого tar/zip-архива а запускаемый phar-архив.
  Может быть использован любой из трёх запускаемых форматов (phar, tar или zip). Также допустимо
  сжатие архива целиком.
  
  Если изменения не указаны, этот метод бросает исключение <class>BadMethodCallException</class>.
  
  В случае успешного выполнения, этот метод создаёт новый архив на диске и возвращает объект <class>Phar</class>.
  Старый архив остаётся нетронутым.

<comment>Param:</comment>
  <info>int|null</info>     <strong>$format</strong>       Одна из констант: <return>Phar::PHAR</return>, <return>Phar::TAR</return>, или <return>Phar::ZIP</return>.  Если задано
                             <info>null</info>, то будет сохранён текущий формат.
  <info>int|null</info>     <strong>$compression</strong>  Одна из констант: <return>Phar::NONE</return> (без сжатия всего архива), <return>Phar::GZ</return> (zlib
                             сжатие), <return>Phar::BZ2</return> (bzip сжатие).
  <info>string|null</info>  <strong>$extension</strong>    Этот параметр используется для явного задания расширения для нового
                             архива. Обратите внимание, что для того, чтобы обрабатываться как
                             phar-архив, файлы должны в своём расширении иметь <return>.phar</return>.
                             
                             При конвертации в phar-архива, расширение по умолчанию <return>.phar</return>, <return>.phar.gz</return>
                             или <return>.phar.bz2</return>, в зависимости от заданного типа сжатия. Для tar-архивов,
                             расширение по умолчанию <return>.phar.tar</return>, <return>.phar.tar.gz</return>, и <return>.phar.tar.bz2</return>.  Для
                             zip-архивов расширение по умолчанию <return>.phar.zip</return>.

<comment>Return:</comment>
  <info>Phar|null</info>  Этот метод возвращает объект <class>Phar</class> и <info>null</info> в случае возникновения ошибки.

<comment>See Also:</comment>
   * <strong>Phar::convertToExecutable()</strong>
   * <strong>Phar::convertToData()</strong>
   * <strong>PharData::convertToData()</strong>


id: PharData::copy
type: function
doc:
<comment>Description:</comment>
  Скопировать файл из tar/zip-архива в новый файл внутри него же
  
  Копирует файл из tar/zip-архива в новый файл внутри него же. Это объектно-ориентированная
  альтернатива для <strong>copy()</strong> с потоковой обёрткой phar.

<comment>Param:</comment>
  <info>string</info>  <strong>$from</strong>  
  <info>string</info>  <strong>$to</strong>    

<comment>Return:</comment>
  <info>bool</info>  Возвращает <info>true</info> в случае успешного выполнения. Но лучше использовать механизм перехвата
        исключений для контроля успешности.


id: PharData::decompress
type: function
doc:
<comment>Description:</comment>
  Распаковать весь Phar-архив
  
  Для архивов типа tar, этот метод распаковывает весь архив.
  
  Для архивов типа Zip этот метод выбросит исключение. Для разжатия gzip-архивов должен быть включён
  модуль zlib, а для bzip2, соответственно, модуль bzip2.
  
  Также этот метод автоматически меняет расширение файла, по умолчанию <return>.tar</return>. Расширение можно
  указать явно с помощью параметра <strong>$extension</strong>.

<comment>Param:</comment>
  <info>string|null</info>  <strong>$extension</strong>  По умолчанию при распаковке файлу меняется расширение на <return>.tar</return>. С помощью
                           этого параметра можно явно указать новое расширение. Будьте осторожны,
                           только запускаемые архивы могут содержать <return>.phar</return> в своих именах.

<comment>Return:</comment>
  <info>PharData|null</info>  Возвращает объект типа <class>PharData</class> в случае успешного выполнения и <info>null</info> в случае
                 возникновения ошибки.

<comment>See Also:</comment>
   * <strong>PharFileInfo::getCompressedSize()</strong>
   * <strong>PharFileInfo::isCompressed()</strong>
   * <strong>PharFileInfo::compress()</strong>
   * <strong>PharFileInfo::decompress()</strong>
   * <strong>PharData::compress()</strong>
   * <strong>Phar::canCompress()</strong>
   * <strong>Phar::isCompressed()</strong>
   * <strong>PharData::compress()</strong>
   * <strong>Phar::getSupportedCompression()</strong>
   * <strong>PharData::compressFiles()</strong>
   * <strong>PharData::decompressFiles()</strong>


