# php_manual

id: pg_connection_status
type: function
doc:
<comment>Description:</comment>
  Определяет состояние подключения
    
  
  <strong>pg_connection_status()</strong> возвращает состояние переданного в качестве аргумента соединения
  <strong>$connection</strong>.

<comment>Param:</comment>
  <info>PgSql\Connection</info>  <strong>$connection</strong>  Экземпляр <class>PgSql\Connection</class>.

<comment>Return:</comment>
  <info>int</info>  <info>PGSQL_CONNECTION_OK</info> либо <info>PGSQL_CONNECTION_BAD</info>.

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


id: pg_consume_input
type: function
doc:
<comment>Description:</comment>
  Читает вводные данные на соединении
  
  <strong>pg_consume_input()</strong> принимает любые входные данные, ожидающие чтения с сервера базы данных.

<comment>Param:</comment>
  <info>PgSql\Connection</info>  <strong>$connection</strong>  Экземпляр <class>PgSql\Connection</class>.

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


id: pg_convert
type: function
doc:
<comment>Description:</comment>
  Преобразует значения ассоциативного массива в приемлемые для использования в SQL-запросах
    
  
  <strong>pg_convert()</strong> проверяет и преобразовывает значения из <strong>$values</strong> в приемлемые для SQL-сервера.
  Необходимо, чтобы существовала таблица <strong>$table_name</strong>, а количество колонок в ней должно быть не
  меньше, чем значений в массиве <strong>$values</strong>. Имена колонок в таблице <strong>$table_name</strong> должны совпадать с
  ключами массива <strong>$values</strong>, типы данных значений массива также должны совпадать с типами данных
  соответствующих колонок. В случае удачной конвертации функция возвращает массив преобразованных
  значений, иначе возвращает <info>false</info>.
  
  Булевы значения преобразуются в булев тип PostgreSQL. Строковые представления булевого значения
  также поддерживаются. <info>null</info> преобразуется в PostgreSQL NULL.

<comment>Param:</comment>
  <info>PgSql\Connection</info>  <strong>$connection</strong>  Экземпляр <class>PgSql\Connection</class>.
  <info>string</info>            <strong>$table_name</strong>  Имя таблицы базы данных.
  <info>array</info>             <strong>$values</strong>      Данные для преобразования.
  <info>int</info>               <strong>$flags</strong>       Одна из констант <info>PGSQL_CONV_IGNORE_DEFAULT</info>, <info>PGSQL_CONV_FORCE_NULL</info>
                                 или <info>PGSQL_CONV_IGNORE_NOT_NULL</info>, либо их комбинация.

<comment>Return:</comment>
  <info>array|false</info>  Массив (<info>array</info>), содержащий преобразованные данные или <info>false</info> в случае возникновения
               ошибки.

<comment>See Also:</comment>
   * <strong>pg_meta_data()</strong>
   * <strong>pg_insert()</strong>
   * <strong>pg_select()</strong>
   * <strong>pg_update()</strong>
   * <strong>pg_delete()</strong>


id: pg_copy_from
type: function
doc:
<comment>Description:</comment>
  Вставляет записи из массива в таблицу
    
  
  <strong>pg_copy_from()</strong> вставляет записи в таблицу из массива <strong>$rows</strong>. В ходе выполнения вызывает SQL-команду
  <return>COPY FROM</return> для вставки записей.

<comment>Param:</comment>
  <info>PgSql\Connection</info>  <strong>$connection</strong>  Экземпляр <class>PgSql\Connection</class>.
  <info>string</info>            <strong>$table_name</strong>  Имя таблицы, в которую копируются значения из <strong>$rows</strong>.
  <info>array</info>             <strong>$rows</strong>        Массив (<info>array</info>) данных для копирования в <strong>$table_name</strong>. Каждое
                                 значение в <strong>$rows</strong> становится строкой в <strong>$table_name</strong>. Каждое значение
                                 массива <strong>$rows</strong> должно быть строкой с разделителем, содержащей
                                 значения для вставки в каждое поле таблицы. Значения должны
                                 заканчиваться символом перевода строки.
  <info>string</info>            <strong>$separator</strong>   Символ, отделяющий значения друг от друга в каждом элементе массива
                                 <strong>$rows</strong>. По умолчанию <return>\t</return>.
  <info>string</info>            <strong>$null_as</strong>     Определяет, каким образом значения SQL <return>NULL</return> представлены в массиве
                                 <strong>$rows</strong>. По умолчанию <return>\\N</return> (<return>"\\\\N"</return>).

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

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


id: pg_copy_to
type: function
doc:
<comment>Description:</comment>
  Копирует данные из таблицы в массив
    
  
  <strong>pg_copy_to()</strong> копирует данные из таблицы в массив. Для получения записей посылает серверу команду
  SQL <return>COPY TO</return>.

<comment>Param:</comment>
  <info>PgSql\Connection</info>  <strong>$connection</strong>  Экземпляр <class>PgSql\Connection</class>.
  <info>string</info>            <strong>$table_name</strong>  Имя таблицы, из которой данные копируются в массив <strong>$rows</strong>.
  <info>string</info>            <strong>$separator</strong>   Символ-разделитель, отделяющий значения полей в элементах массива
                                 <strong>$rows</strong>. По умолчанию <return>\t</return>.
  <info>string</info>            <strong>$null_as</strong>     Этот параметр отвечает за то, как значения SQL <return>NULL</return> будут
                                 представлены в массиве <strong>$rows</strong>. По умолчанию <return>\\N</return> (<return>"\\\\N"</return>).

<comment>Return:</comment>
  <info>array|false</info>  Массив (<info>array</info>), в котором каждый элемент - строка, полученная с помощью <return>COPY</return> или
               <info>false</info> в случае возникновения ошибки.

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


id: pg_dbname
type: function
doc:
<comment>Description:</comment>
  Определяет имя базы данных
  
  <strong>pg_dbname()</strong> возвращает имя базы данных, соответствующей экземпляру PostgreSQL <strong>$connection</strong>.

<comment>Param:</comment>
  <info>PgSql\Connection|null</info>  <strong>$connection</strong>  Экземпляр <class>PgSql\Connection</class>.
                                      Если параметр <strong>$connection</strong> указан <info>null</info>, используется соединение
                                      по умолчанию. Соединение по умолчанию — это последнее
                                      соединение, выполненное с помощью функций <strong>pg_connect()</strong> или
                                      <strong>pg_pconnect()</strong>.
                                      Начиная с версии PHP 8.1.0, использование соединения по
                                      умолчанию устарело.
                                      
                                      Начиная с версии PHP 8.1.0, использование соединения по
                                      умолчанию устарело.

<comment>Return:</comment>
  <info>string</info>  Строка, содержащая имя базы данных, соответствующей ресурсу <strong>$connection</strong>.


id: pg_delete
type: function
doc:
<comment>Description:</comment>
  Удаляет записи
    
  
  <strong>pg_delete()</strong> удаляет из таблицы записи, соответствующие ключам и значениям массива <strong>$conditions</strong>.
  
  Если <strong>$flags</strong> указан, <strong>pg_convert()</strong> применяется к <return>conditions</return> с указанными флагами.
  
  По умолчанию <strong>pg_delete()</strong> передаёт необработанные значения. Значения должны быть экранированы или
  опция <info>PGSQL_DML_ESCAPE</info> должна быть указана. <info>PGSQL_DML_ESCAPE</info> заключает в кавычки и экранирует
  параметры/идентификаторы. Поэтому имена таблиц/столбцов становятся чувствительными к регистру.
  
  Обратите внимание, что ни экранирование, ни подготовленный запрос не защитят запрос LIKE, JSON,
  массив, регулярные выражения и т.д. Эти параметры должны обрабатываться в соответствии с их
  контекстами, т.е. следует экранировать/проверять значения.

<comment>Param:</comment>
  <info>PgSql\Connection</info>  <strong>$connection</strong>  Экземпляр <class>PgSql\Connection</class>.
  <info>string</info>            <strong>$table_name</strong>  Имя таблицы, из которой удаляются записи.
  <info>array</info>             <strong>$conditions</strong>  Ассоциативный массив, ключи которого соответствуют именам полей
                                 таблицы <strong>$table_name</strong>, а значения соответствуют удаляемым значениям в
                                 этих колонках.
  <info>int</info>               <strong>$flags</strong>       Комбинация констант <info>PGSQL_CONV_FORCE_NULL</info>, <info>PGSQL_DML_NO_CONV</info>,
                                 <info>PGSQL_DML_ESCAPE</info>, <info>PGSQL_DML_EXEC</info>, <info>PGSQL_DML_ASYNC</info> или
                                 <info>PGSQL_DML_STRING</info>. Если константа <info>PGSQL_DML_STRING</info> присутствует в
                                 аргументе <strong>$flags</strong>, то функция вернёт строку, содержащую запрос. Если
                                 установлены <info>PGSQL_DML_NO_CONV</info> или <info>PGSQL_DML_ESCAPE</info>, то функция
                                 <strong>pg_convert()</strong> внутренне не вызывается.

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

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


id: pg_end_copy
type: function
doc:
<comment>Description:</comment>
  Синхронизирует с бэкендом PostgreSQL
  
  <strong>pg_end_copy()</strong> синхронизирует данные между фронтендом PostgreSQL (обычно процессом веб-сервера) и
  сервером PostgreSQL после завершения копирования данных, совершенных с помощью функции
  <strong>pg_put_line()</strong>. Использование <strong>pg_end_copy()</strong> необходимо, чтобы избежать рассинхронизации сервера
  PostgreSQL с фронтендом и сообщений об ошибках.

<comment>Param:</comment>
  <info>PgSql\Connection|null</info>  <strong>$connection</strong>  Экземпляр <class>PgSql\Connection</class>.
                                      Если параметр <strong>$connection</strong> указан <info>null</info>, используется соединение
                                      по умолчанию. Соединение по умолчанию — это последнее
                                      соединение, выполненное с помощью функций <strong>pg_connect()</strong> или
                                      <strong>pg_pconnect()</strong>.
                                      Начиная с версии PHP 8.1.0, использование соединения по
                                      умолчанию устарело.
                                      
                                      Начиная с версии PHP 8.1.0, использование соединения по
                                      умолчанию устарело.

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

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


id: pg_escape_bytea
type: function
doc:
<comment>Description:</comment>
  Экранирует спецсимволы в строке для вставки в поле типа bytea
    
  
  <strong>pg_escape_bytea()</strong> экранирует спецсимволы в строке с данными типа bytea. Возвращает экранированную
  строку.
  
  При выборке SQL-функцией <return>SELECT</return> данных типа bytea PostgreSQL возвращает значения в восьмеричной
  системе счисления с префиксом '\' (такие как \032). Пользователю необходимо вручную
  преобразовывать их в двоичный формат.
  
  Функция поддерживается PostgreSQL версии 7.2 и выше. Для версий 7.2.0 и 7.2.1 значения должны быть
  преобразованы к типу bytea, когда включена мультибайтовая поддержка. Тогда как <return>INSERT INTO
  test_table (image)VALUES ('$image_escaped'::bytea);</return> в PostgreSQL 7.2.2 и выше не требует
  каких-либо преобразований. Исключение составляет случай, когда клиентская (frontend) кодировка не
  соответствует серверной (backend). При этом возникает ошибка мультибайтового потока, и
  пользователь должен привести данные к типу bytea, чтобы её избежать.

<comment>Param:</comment>
  <info>PgSql\Connection</info>  <strong>$connection</strong>  Экземпляр <class>PgSql\Connection</class>.
                                 Если <strong>$connection</strong> не указано, используется соединение по умолчанию.
                                 Соединение по умолчанию — это последнее соединение, выполненное с
                                 помощью функций <strong>pg_connect()</strong>
                                 или <strong>pg_pconnect()</strong>.
                                 Начиная с версии PHP 8.1.0, использование соединения по умолчанию
                                 устарело.
                                 
                                 Начиная с версии PHP 8.1.0, использование соединения по умолчанию
                                 устарело.
  <info>string</info>            <strong>$data</strong>        Строка, содержащая двоичные данные в виде текста, которые требуется
                                 поместить в поле типа bytea.

<comment>Return:</comment>
  <info>string</info>  Возвращает строку, в которой экранированы все необходимые символы.

<comment>See Also:</comment>
   * <strong>pg_unescape_bytea()</strong>
   * <strong>pg_escape_string()</strong>


id: pg_escape_identifier
type: function
doc:
<comment>Description:</comment>
  Экранирует идентификатор для вставки в текстовое поле
    
  
  <strong>pg_escape_identifier()</strong> экранирует идентификатор (например, таблицу, имена полей) для выполнения
  запроса к базе. Возвращает экранированный идентификатор строки для сервера PostgreSQL.
  <strong>pg_escape_identifier()</strong> добавляет двойные кавычки до и после данных. Пользователи не должны
  добавлять двойные кавычки. Использование этой функции рекомендуется для параметров идентификаторов
  в запросах. Для SQL-литералов (то есть параметров, кроме bytea) необходимо использовать
  <strong>pg_escape_literal()</strong> или <strong>pg_escape_string()</strong>. Для типа поля bytea нужно использовать
  <strong>pg_escape_bytea()</strong>.
  
  Эта функция имеет внутренний код экранирования и может быть использована с PostgreSQL 8.4 и ниже.

<comment>Param:</comment>
  <info>PgSql\Connection</info>  <strong>$connection</strong>  Экземпляр <class>PgSql\Connection</class>.
                                 Если <strong>$connection</strong> не указано, используется соединение по умолчанию.
                                 Соединение по умолчанию — это последнее соединение, выполненное с
                                 помощью функций <strong>pg_connect()</strong>
                                 или <strong>pg_pconnect()</strong>.
                                 Начиная с версии PHP 8.1.0, использование соединения по умолчанию
                                 устарело.
                                 
                                 Начиная с версии PHP 8.1.0, использование соединения по умолчанию
                                 устарело.
  <info>string</info>            <strong>$data</strong>        Строка (<info>string</info>), содержащая текст, который должен быть экранирован.

<comment>Return:</comment>
  <info>string</info>  Строка (<info>string</info>), содержащая экранированные данные.

<comment>See Also:</comment>
   * <strong>pg_escape_literal()</strong>
   * <strong>pg_escape_bytea()</strong>
   * <strong>pg_escape_string()</strong>


id: pg_escape_literal
type: function
doc:
<comment>Description:</comment>
  Экранировать литерал при вставке в текстовое поле
    
  
  Функция <strong>pg_escape_literal()</strong> экранирует литерал для запроса базы данных PostgreSQL. Она возвращает
  экранированный литерал в формате PostgreSQL. <strong>pg_escape_literal()</strong> добавляет кавычки до и после
  данных. Пользователи не должны добавлять кавычки. Рекомендуется использовать эту функцию вместо
  <strong>pg_escape_string()</strong>. Если тип столбца - bytea, вместо него следует использовать  <strong>pg_escape_bytea()</strong>.
  Для экранирования идентификаторов (например, таблицы, имён полей) необходимо использовать
  <strong>pg_escape_identifier()</strong>.
  
  Эта функция имеет внутренний код экранирования и может также использоваться с PostgreSQL 8.4 или
  младшей версии.

<comment>Param:</comment>
  <info>PgSql\Connection</info>  <strong>$connection</strong>  Экземпляр <class>PgSql\Connection</class>.
                                 Если <strong>$connection</strong> не указано, используется соединение по умолчанию.
                                 Соединение по умолчанию — это последнее соединение, выполненное с
                                 помощью функций <strong>pg_connect()</strong>
                                 или <strong>pg_pconnect()</strong>.
                                 Начиная с версии PHP 8.1.0, использование соединения по умолчанию
                                 устарело.
                                 
                                 Начиная с версии PHP 8.1.0, использование соединения по умолчанию
                                 устарело.
  <info>string</info>            <strong>$data</strong>        Строка (<info>string</info>), содержащая текст для экранирования.

<comment>Return:</comment>
  <info>string</info>  Строка (<info>string</info>), содержащая экранированный текст.

<comment>See Also:</comment>
   * <strong>pg_escape_identifier()</strong>
   * <strong>pg_escape_bytea()</strong>
   * <strong>pg_escape_string()</strong>


id: pg_escape_string
type: function
doc:
<comment>Description:</comment>
  Экранирование спецсимволов в строке запроса
    
  
  Функция <strong>pg_escape_string()</strong> экранирует спецсимволы в строке запроса для базы данных. Она возвращает
  экранированную строку в формате PostgreSQL. Функция <strong>pg_escape_string()</strong> является наиболее
  предпочтительным способом экранирования SQL параметров для PostgreSQL, в то время как <strong>addslashes()</strong>
  не должна использоваться с PostgreSQL. Если тип столбца bytea, то должна использоваться функция
  <strong>pg_escape_bytea()</strong> вместо pg_escape_string. Функция <strong>pg_escape_identifier()</strong> должна использоваться
  для экранирования идентификаторов (например, имена таблиц или полей).
  
  Функция поддерживается PostgreSQL версии 7.2 и выше.

<comment>Param:</comment>
  <info>PgSql\Connection</info>  <strong>$connection</strong>  Экземпляр <class>PgSql\Connection</class>.
                                 Если <strong>$connection</strong> не указано, используется соединение по умолчанию.
                                 Соединение по умолчанию — это последнее соединение, выполненное с
                                 помощью функций <strong>pg_connect()</strong>
                                 или <strong>pg_pconnect()</strong>.
                                 Начиная с версии PHP 8.1.0, использование соединения по умолчанию
                                 устарело.
                                 
                                 Начиная с версии PHP 8.1.0, использование соединения по умолчанию
                                 устарело.
  <info>string</info>            <strong>$data</strong>        Исходная экранируемая строка.

<comment>Return:</comment>
  <info>string</info>  Возвращает строку, в которой экранированы все необходимые символы.

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


id: pg_execute
type: function
doc:
<comment>Description:</comment>
  Запускает выполнение ранее подготовленного параметризованного запроса и ждёт результат
  
  Запускает выполнение ранее подготовленного параметризованного запроса и ждёт результат.
  
  <strong>pg_execute()</strong> аналог функции <strong>pg_query_params()</strong>, только вместо строки с запросом принимает имя
  предварительно подготовленного SQL-запроса. Это позволяет многократно выполнять единожды созданные
  запросы с различными параметрами. Сам запрос должен быть заранее подготовлен в текущей сессии.
  <strong>pg_execute()</strong> поддерживается PostgreSQL версии 7.4 и выше. Функция не будет работать на соединениях
  с сервером ранних версий.
  
  Аргументы функции те же, что и у <strong>pg_query_params()</strong>, за исключением имени предварительно
  составленного запроса, который передаётся вместо строки с запросом.

<comment>Param:</comment>
  <info>PgSql\Connection</info>  <strong>$connection</strong>  Экземпляр <class>PgSql\Connection</class>.
                                 Если <strong>$connection</strong> не указано, используется соединение по умолчанию.
                                 Соединение по умолчанию — это последнее соединение, выполненное с
                                 помощью функций <strong>pg_connect()</strong>
                                 или <strong>pg_pconnect()</strong>.
                                 Начиная с версии PHP 8.1.0, использование соединения по умолчанию
                                 устарело.
                                 
                                 Начиная с версии PHP 8.1.0, использование соединения по умолчанию
                                 устарело.
  <info>string</info>            <strong>$stmtname</strong>    Имя подготовленного к исполнению запроса. Если передана пустая
                                 строка "", будет выполнен безымянный запрос. Имя и содержимое
                                 запроса должны быть подготовлены функцией <strong>pg_prepare()</strong>,
                                 <strong>pg_send_prepare()</strong> либо с помощью SQL-команды <return>PREPARE</return>.
  <info>array</info>             <strong>$params</strong>      Массив значений параметров запроса для замены псевдопеременных $1,
                                 $2 и т.д. в исходной строке запроса. Количество элементов массива
                                 должно точно совпадать с количеством псевдопеременных.
                                 
                                 Элементы массива будут преобразованы в строки.

<comment>Return:</comment>
  <info>PgSql\Result|false</info>  Экземпляр <class>PgSql\Result</class> в случае успешного выполнения или <info>false</info> в случае
                      возникновения ошибки.

<comment>See Also:</comment>
   * <strong>pg_prepare()</strong>
   * <strong>pg_send_prepare()</strong>
   * <strong>pg_query_params()</strong>


id: pg_fetch_all
type: function
doc:
<comment>Description:</comment>
  Выбирает все данные из результата запроса и помещает их в массив
  
  <strong>pg_fetch_all()</strong> возвращает массив содержащий все записи экземпляра <class>PgSql\Result</class>.
  
  Эта функция устанавливает NULL-поля
  в значение <info>null</info> PHP.

<comment>Param:</comment>
  <info>PgSql\Result</info>  <strong>$result</strong>  Экземпляр <class>PgSql\Result</class>, возвращаемый функциями <strong>pg_query()</strong>,
                         <strong>pg_query_params()</strong> или <strong>pg_execute()</strong> (среди прочего).
  <info>int</info>           <strong>$mode</strong>    Необязательный параметр, управляющий тем, как индексируется возвращаемый
                         массив (<info>array</info>).
                         Параметр <strong>$mode</strong> является константой и может принимать следующие значения:
                         <info>PGSQL_ASSOC</info>, <info>PGSQL_NUM</info> и <info>PGSQL_BOTH</info>.
                         При использовании <info>PGSQL_NUM</info> функция возвращает массив с числовыми
                         индексами,
                         при использовании <info>PGSQL_ASSOC</info> она вернёт только ассоциативные индексы,
                         а <info>PGSQL_BOTH</info> вернёт как числовые, так и ассоциативные индексы.

<comment>Return:</comment>
  <info>array</info>  Многомерный массив данных результата запроса. Каждая строка результата представляется
         массивом значений полей, индексированным именами этих полей.

<comment>See Also:</comment>
   * <strong>pg_fetch_row()</strong>
   * <strong>pg_fetch_array()</strong>
   * <strong>pg_fetch_object()</strong>
   * <strong>pg_fetch_result()</strong>


id: pg_fetch_all_columns
type: function
doc:
<comment>Description:</comment>
  Выбирает все записи из одной колонки результата запроса и помещает их в массив
  
  <strong>pg_fetch_all_columns()</strong> возвращает массив, содержащий все записи одной колонки экземпляра
  <class>PgSql\Result</class>.
  
  Эта функция устанавливает NULL-поля
  в значение <info>null</info> PHP.

<comment>Param:</comment>
  <info>PgSql\Result</info>  <strong>$result</strong>  Экземпляр <class>PgSql\Result</class>, возвращаемый функциями <strong>pg_query()</strong>,
                         <strong>pg_query_params()</strong> или <strong>pg_execute()</strong> (среди прочего).
  <info>int</info>           <strong>$field</strong>   Номер колонки. Если параметр не задан, будет обработана первая (нулевая)
                         колонка.

<comment>Return:</comment>
  <info>array</info>  Массив значений колонки результата запроса.

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


id: pg_fetch_array
type: function
doc:
<comment>Description:</comment>
  Возвращает строку результата в виде массива
  
  <strong>pg_fetch_array()</strong> возвращает массив, соответствующий выбранной строке (записи).
  
  <strong>pg_fetch_array()</strong> расширенная версия функции <strong>pg_fetch_row()</strong>.  Эта функция способна сохранить данные
  не только с цифровыми индексами, но и с ассоциативными (имя поля). По умолчанию хранит и те и
  другие.
  
  Эта функция устанавливает NULL-поля
  в значение <info>null</info> PHP.
  
  <strong>pg_fetch_array()</strong> выполняется незначительно медленнее чем <strong>pg_fetch_row()</strong>, но значительно проще в
  использовании.

<comment>Param:</comment>
  <info>PgSql\Result</info>  <strong>$result</strong>  Экземпляр <class>PgSql\Result</class>, возвращаемый функциями <strong>pg_query()</strong>,
                         <strong>pg_query_params()</strong> или <strong>pg_execute()</strong> (среди прочего).
  <info>int|null</info>      <strong>$row</strong>     Номер строки в result для выборки. Строки пронумерованы с 0 по возрастанию.
                         Если параметр опущен или передан <info>null</info> будет выбрана следующая строка.
  <info>int</info>           <strong>$mode</strong>    Необязательный параметр, управляющий тем, как индексируется возвращаемый
                         массив (<info>array</info>).
                         Параметр <strong>$mode</strong> является константой и может принимать следующие значения:
                         <info>PGSQL_ASSOC</info>, <info>PGSQL_NUM</info> и <info>PGSQL_BOTH</info>.
                         При использовании <info>PGSQL_NUM</info> функция возвращает массив с числовыми
                         индексами,
                         при использовании <info>PGSQL_ASSOC</info> она вернёт только ассоциативные индексы,
                         а <info>PGSQL_BOTH</info> вернёт как числовые, так и ассоциативные индексы.

<comment>Return:</comment>
  <info>array|false</info>  Массив (<info>array</info>) с числовыми индексами (начиная с 0), либо ассоциативными (по имени
               поля), либо с обеими типами индексов. Каждое значение в массиве (<info>array</info>) представлено
               как строка (<info>string</info>). Значение <return>NULL</return> возвращается как <info>null</info>.
               
               Функция возвращает <info>false</info>, если <strong>$row</strong> выходит за рамки количества строк в выборке, или
               отсутствия строк, или в случае любой другой ошибки. Выборка из результата запроса,
               отличного от SELECT, также вернёт <info>false</info>.

<comment>See Also:</comment>
   * <strong>pg_fetch_row()</strong>
   * <strong>pg_fetch_object()</strong>
   * <strong>pg_fetch_result()</strong>


id: pg_fetch_assoc
type: function
doc:
<comment>Description:</comment>
  Выбирает строку результата запроса и помещает данные в ассоциативный массив
  
  <strong>pg_fetch_assoc()</strong> возвращает ассоциативный массив, содержащий записи из строки результата запроса.
  
  Результат выполнения <strong>pg_fetch_assoc()</strong> тот же, что и у <strong>pg_fetch_array()</strong> с параметром <info>PGSQL_ASSOC</info>.
  Функция возвращает только ассоциативный массив. Если нужен численно-индексированный массив,
  используйте функцию <strong>pg_fetch_row()</strong>.
  
  Эта функция устанавливает NULL-поля
  в значение <info>null</info> PHP.
  
  <strong>pg_fetch_assoc()</strong> не намного медленней и значительно проще в использовании, чем <strong>pg_fetch_row()</strong>.

<comment>Param:</comment>
  <info>PgSql\Result</info>  <strong>$result</strong>  Экземпляр <class>PgSql\Result</class>, возвращаемый функциями <strong>pg_query()</strong>,
                         <strong>pg_query_params()</strong> или <strong>pg_execute()</strong> (среди прочего).
  <info>int|null</info>      <strong>$row</strong>     Номер выбираемой из результата запроса строки. Нумерация начинается с нуля.
                         Если аргумент опущен или равен <info>null</info>, берётся следующая по очереди строка.

<comment>Return:</comment>
  <info>array|false</info>  Ассоциативный массив, индексированный именами полей выборки. Значения массива
               представляются в виде текстовых строк. Значения <return>NULL</return> базы данных преобразуются в PHP
               <info>null</info>.
               
               <info>false</info>, если <strong>$row</strong> превышает число строк в результате запроса, когда строк в результате
               не осталось, и при прочих ошибках.

<comment>See Also:</comment>
   * <strong>pg_fetch_row()</strong>
   * <strong>pg_fetch_array()</strong>
   * <strong>pg_fetch_object()</strong>
   * <strong>pg_fetch_result()</strong>


id: pg_fetch_object
type: function
doc:
<comment>Description:</comment>
  Выбирает строку результата запроса и возвращает данные в виде объекта
  
  <strong>pg_fetch_object()</strong> возвращает объект, свойства которого соответствуют именам полей выборки. Также
  функция может создать экземпляр конкретного класса и передать параметры его конструктору.
  
  Эта функция устанавливает NULL-поля
  в значение <info>null</info> PHP.
  
  По скорости функция идентична <strong>pg_fetch_array()</strong> и немного медленней <strong>pg_fetch_row()</strong> (разница
  незначительна).

<comment>Param:</comment>
  <info>PgSql\Result</info>  <strong>$result</strong>            Экземпляр <class>PgSql\Result</class>, возвращаемый функциями <strong>pg_query()</strong>,
                                   <strong>pg_query_params()</strong> или <strong>pg_execute()</strong> (среди прочего).
  <info>int|null</info>      <strong>$row</strong>               Номер выбираемой из результата запроса строки. Нумерация
                                   начинается с нуля. Если аргумент опущен или равен <info>null</info>, берётся
                                   следующая по очереди строка.
  <info>string</info>        <strong>$class</strong>             Имя класса создаваемого и возвращаемого объекта. Если не задано,
                                   функция создаст экземпляр класса <class>stdClass</class>.
  <info>array</info>         <strong>$constructor_args</strong>  Необязательный аргумент. Массив (<info>array</info>) параметров для передачи в
                                   конструктор создаваемого объекта (<strong>$class</strong>).

<comment>Return:</comment>
  <info>object|false</info>  Объект (<info>object</info>), имена и значения свойств которого соответствуют именам и значениям
                полей результата запроса. Значения <return>NULL</return> базы данных преобразуются в PHP <info>null</info>.
                
                <info>false</info>, когда <strong>$row</strong> превышает число строк в результате запроса, когда строк в
                результате не осталось, и при прочих ошибках.

<comment>See Also:</comment>
   * <strong>pg_query()</strong>
   * <strong>pg_fetch_array()</strong>
   * <strong>pg_fetch_assoc()</strong>
   * <strong>pg_fetch_row()</strong>
   * <strong>pg_fetch_result()</strong>


id: pg_fetch_result
type: function
doc:
<comment>Description:</comment>
  Возвращает запись из результата запроса
  
  <strong>pg_fetch_result()</strong> возвращает значение ячейки таблицы экземпляра <class>PgSql\Result</class>.
  
  Прежнее наименование функции: <strong>pg_result()</strong>.

<comment>Param:</comment>
  <info>PgSql\Result</info>  <strong>$result</strong>  Экземпляр <class>PgSql\Result</class>, возвращаемый функциями <strong>pg_query()</strong>,
                         <strong>pg_query_params()</strong> или <strong>pg_execute()</strong> (среди прочего).
  <info>int</info>           <strong>$row</strong>     Номер выбираемой из результата запроса строки. Нумерация начинается с нуля.
                         Если аргумент опущен, берётся следующая по очереди строка.
  <info>mixed</info>         <strong>$field</strong>   Имя или номер поля выбираемого значения. Поля нумеруются с нуля.

<comment>Return:</comment>
  <info>string|false|null</info>  Логические значения возвращаются как "t" или "f". Остальные типы, включая
                     массивы, возвращаются в виде строк в стандартном формате PostgreSQL, аналогично
                     выводу программы psql. Значения <return>NULL</return> базы данных преобразуются в PHP <info>null</info>.
                     
                     <info>false</info>, если <strong>$row</strong> превышает число строк в результате запроса, и при прочих
                     ошибках.

<comment>See Also:</comment>
   * <strong>pg_query()</strong>
   * <strong>pg_fetch_array()</strong>


id: pg_fetch_row
type: function
doc:
<comment>Description:</comment>
  Выбирает строку результата запроса и помещает данные в массив
  
  <strong>pg_fetch_row()</strong> выбирает одну строку из результата запроса <strong>$result</strong>.
  
  Эта функция устанавливает NULL-поля
  в значение <info>null</info> PHP.

<comment>Param:</comment>
  <info>PgSql\Result</info>  <strong>$result</strong>  Экземпляр <class>PgSql\Result</class>, возвращаемый функциями <strong>pg_query()</strong>,
                         <strong>pg_query_params()</strong> или <strong>pg_execute()</strong> (среди прочего).
  <info>int|null</info>      <strong>$row</strong>     Номер выбираемой из результата запроса строки. Нумерация начинается с нуля.
                         Если аргумент опущен или равен <info>null</info>, берётся следующая по очереди строка.
  <info>int</info>           <strong>$mode</strong>    Необязательный параметр, управляющий тем, как индексируется возвращаемый
                         массив (<info>array</info>).
                         Параметр <strong>$mode</strong> является константой и может принимать следующие значения:
                         <info>PGSQL_ASSOC</info>, <info>PGSQL_NUM</info> и <info>PGSQL_BOTH</info>.
                         При использовании <info>PGSQL_NUM</info> функция возвращает массив с числовыми
                         индексами,
                         при использовании <info>PGSQL_ASSOC</info> она вернёт только ассоциативные индексы,
                         а <info>PGSQL_BOTH</info> вернёт как числовые, так и ассоциативные индексы.

<comment>Return:</comment>
  <info>array|false</info>  Численно индексированный массив значений из строки результата запроса. Индексация
               начинается с нуля. Значения представляются в виде строк. Значения <return>NULL</return> базы данных
               преобразуются в PHP <info>null</info>.
               
               <info>false</info>, если <strong>$row</strong> превышает число строк в результате запроса, когда строк в результате
               не осталось, и при прочих ошибках.

<comment>See Also:</comment>
   * <strong>pg_query()</strong>
   * <strong>pg_fetch_array()</strong>
   * <strong>pg_fetch_object()</strong>
   * <strong>pg_fetch_result()</strong>


id: pg_field_is_null
type: function
doc:
<comment>Description:</comment>
  Проверка поля на значение SQL NULL
  
  <strong>pg_field_is_null()</strong> проверяет, содержит ли ячейка экземпляра <class>PgSql\Result</class> значение SQL <return>NULL</return>.
  
  Прежнее наименование функции: <strong>pg_fieldisnull()</strong>.

<comment>Param:</comment>
  <info>PgSql\Result</info>  <strong>$result</strong>  Экземпляр <class>PgSql\Result</class>, возвращаемый функциями <strong>pg_query()</strong>,
                         <strong>pg_query_params()</strong> или <strong>pg_execute()</strong> (среди прочего).
  <info>int</info>           <strong>$row</strong>     Номер строки результата запроса с нужным полем. Нумерация строк начинается
                         с нуля. Если аргумент не задан, будет выбрана текущая строка.
  <info>mixed</info>         <strong>$field</strong>   Номер поля (начиная с нуля) как <info>int</info> или имя поля как <info>string</info>.

<comment>Return:</comment>
  <info>int</info>  Возвращает <return>1</return>, если выбранное значение SQL <return>NULL</return>, <return>0</return> для других значений. Функция вернёт <info>false</info>,
       если номер строки будет вне допустимого диапазона и при прочих ошибках.


id: pg_field_name
type: function
doc:
<comment>Description:</comment>
  Возвращает наименование поля
  
  <strong>pg_field_name()</strong> возвращает имя поля результата запроса <strong>$result</strong> с порядковым номером <strong>$field</strong>.
  Нумерация полей начинается с нуля.
  
  Прежнее название функции: <strong>pg_fieldname()</strong>.

<comment>Param:</comment>
  <info>PgSql\Result</info>  <strong>$result</strong>  Экземпляр <class>PgSql\Result</class>, возвращаемый функциями <strong>pg_query()</strong>,
                         <strong>pg_query_params()</strong> или <strong>pg_execute()</strong> (среди прочего).
  <info>int</info>           <strong>$field</strong>   Номер поля, начиная с нуля.

<comment>Return:</comment>
  <info>string</info>  Наименование поля.

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


id: pg_field_num
type: function
doc:
<comment>Description:</comment>
  Возвращает порядковый номер именованного поля
  
  <strong>pg_field_num()</strong> вернёт порядковый номер поля с именем <strong>$field</strong> в результате запроса <strong>$result</strong>.
  
  Прежнее название функции: <strong>pg_fieldnum()</strong>.

<comment>Param:</comment>
  <info>PgSql\Result</info>  <strong>$result</strong>  Экземпляр <class>PgSql\Result</class>, возвращаемый функциями <strong>pg_query()</strong>,
                         <strong>pg_query_params()</strong> или <strong>pg_execute()</strong> (среди прочего).
  <info>string</info>        <strong>$field</strong>   Наименование поля. Данное имя обрабатывается как идентификатор в
                         SQL-команде, то есть оно переводится в нижний регистр, если оно не
                         заключено в двойные кавычки.

<comment>Return:</comment>
  <info>int</info>  Номер поля (начиная с нуля), либо -1 в случае возникновения ошибки.

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


id: pg_field_prtlen
type: function
doc:
<comment>Description:</comment>
  Возвращает количество печатаемых символов
  
  <strong>pg_field_prtlen()</strong> возвращает длину строки (количество символов) значения поля при выводе
  результата <strong>$result</strong>. Строки нумеруются с нуля. Функция вернёт <info>false</info> в случае возникновения ошибки.
  
  <strong>$field_name_or_number</strong> Номер или имя выбранного поля. Может передаваться либо как <info>int</info>, либо как
  <info>string</info>. Если передаётся значение типа <info>int</info>, PHP распознает его как номер, в противном случае как
  наименование поля.
  
  Ознакомьтесь с примерами на странице с описанием функции <strong>pg_field_name()</strong>.
  
  Прежнее название функции: <strong>pg_fieldprtlen()</strong>.

<comment>Param:</comment>
  <info>PgSql\Result</info>  <strong>$result</strong>  Экземпляр <class>PgSql\Result</class>, возвращаемый функциями <strong>pg_query()</strong>,
                         <strong>pg_query_params()</strong> или <strong>pg_execute()</strong> (среди прочего).
  <info></info>              <strong>$row</strong>     Номер строки результата запроса с нужным полем. Нумерация строк начинается
                         с нуля. Если аргумент не задан, будет выбрана текущая строка.

<comment>Return:</comment>
  <info>int</info>  Длина строки при выводе значения поля.

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


id: pg_field_size
type: function
doc:
<comment>Description:</comment>
  Возвращает размер поля
    
  
  <strong>pg_field_size()</strong> возвращает объем памяти (в байтах), занимаемый значением поля результата запроса
  PostgreSQL <strong>$result</strong>.
  
  Прежнее название функции: <strong>pg_fieldsize()</strong>.

<comment>Param:</comment>
  <info>PgSql\Result</info>  <strong>$result</strong>  Экземпляр <class>PgSql\Result</class>, возвращаемый функциями <strong>pg_query()</strong>,
                         <strong>pg_query_params()</strong> или <strong>pg_execute()</strong> (среди прочего).
  <info>int</info>           <strong>$field</strong>   Порядковый номер поля результата запроса, начиная с нуля.

<comment>Return:</comment>
  <info>int</info>  Требуемый объем памяти (в байтах) для хранения значения поля. -1 указывает на переменный
       размер поля.

<comment>See Also:</comment>
   * <strong>pg_field_prtlen()</strong>
   * <strong>pg_field_type()</strong>


id: pg_field_table
type: function
doc:
<comment>Description:</comment>
  Возвращает наименование или идентификатор таблицы, содержащей заданное поле
  
  <strong>pg_field_table()</strong> возвращает имя таблицы, которой принадлежит заданное поле. Если в качестве
  аргумента <strong>$oid_only</strong> передаётся <info>true</info>, функция вернёт oid-идентификатор таблицы.

<comment>Param:</comment>
  <info>PgSql\Result</info>  <strong>$result</strong>    Экземпляр <class>PgSql\Result</class>, возвращаемый функциями <strong>pg_query()</strong>,
                           <strong>pg_query_params()</strong> или <strong>pg_execute()</strong> (среди прочего).
  <info>int</info>           <strong>$field</strong>     Порядковый номер поля результата запроса, начиная с нуля.
  <info>bool</info>          <strong>$oid_only</strong>  По умолчанию функция возвращает название таблицы, содержащей заданное
                           поле. Если параметр <strong>$oid_only</strong> равен <info>true</info>, то функция вернёт oid таблицы.

<comment>Return:</comment>
  <info>string|int|false</info>  При успешном завершении название таблицы или её oid или <info>false</info> в случае
                    возникновения ошибки.

<comment>See Also:</comment>
   * <strong>pg_field_name()</strong>
   * <strong>pg_field_type()</strong>


id: pg_field_type
type: function
doc:
<comment>Description:</comment>
  Возвращает имя типа заданного поля
    
  
  <strong>pg_field_type()</strong> возвращает строку, содержащую имя базового типа значений колонки результата
  запроса <strong>$result</strong> с номером <strong>$field</strong>.
  
  Если в качестве типа значений используется PostgreSQL домен (вместо базового типа), функция вернёт
  имя типа внутри домена, а не имя самого домена.
  
  Прежнее название функции: <strong>pg_fieldtype()</strong>.

<comment>Param:</comment>
  <info>PgSql\Result</info>  <strong>$result</strong>  Экземпляр <class>PgSql\Result</class>, возвращаемый функциями <strong>pg_query()</strong>,
                         <strong>pg_query_params()</strong> или <strong>pg_execute()</strong> (среди прочего).
  <info>int</info>           <strong>$field</strong>   Порядковый номер поля, начиная с нуля.

<comment>Return:</comment>
  <info>string</info>  Строка, содержащая имя базового типа значений поля.

<comment>See Also:</comment>
   * <strong>pg_field_prtlen()</strong>
   * <strong>pg_field_name()</strong>
   * <strong>pg_field_type_oid()</strong>


id: pg_field_type_oid
type: function
doc:
<comment>Description:</comment>
  Возвращает идентификатор типа заданного поля
    
  
  <strong>pg_field_type_oid()</strong> возвращает целочисленный идентификатор базового типа (OID) значений колонки
  результата запроса <strong>$result</strong> с номером <strong>$field</strong>.
  
  Более подробную информацию о типе значений можно получить, отправив запрос с полученным OID к
  системной таблице PostgreSQL <return>pg_type</return>. Функция PostgreSQL <strong>format_type()</strong> преобразует OID в
  стандартное имя типа SQL.
  
  Если в качестве типа значений используется PostgreSQL домен (вместо базового типа), функция вернёт
  OID типа внутри домена, а не OID самого домена.

<comment>Param:</comment>
  <info>PgSql\Result</info>  <strong>$result</strong>  Экземпляр <class>PgSql\Result</class>, возвращаемый функциями <strong>pg_query()</strong>,
                         <strong>pg_query_params()</strong> или <strong>pg_execute()</strong> (среди прочего).
  <info>int</info>           <strong>$field</strong>   Порядковый номер поля, начиная с нуля.

<comment>Return:</comment>
  <info>string|int</info>  OID базового типа значений поля.

<comment>See Also:</comment>
   * <strong>pg_field_type()</strong>
   * <strong>pg_field_prtlen()</strong>
   * <strong>pg_field_name()</strong>


id: pg_flush
type: function
doc:
<comment>Description:</comment>
  Сбросить данные исходящего запроса на соединении
  
  <strong>pg_flush()</strong> сбрасывает любые данные исходящего запроса, ожидающие отправки на соединении.

<comment>Param:</comment>
  <info>PgSql\Connection</info>  <strong>$connection</strong>  Экземпляр <class>PgSql\Connection</class>.

<comment>Return:</comment>
  <info>int|bool</info>  Возвращает <info>true</info>, если сброс был успешный или данные не ожидали сброса, либо <return>0</return>, если
            часть ожидающих данных была сброшена, однако остались ещё или <info>false</info> в случае
            возникновения ошибки.


id: pg_free_result
type: function
doc:
<comment>Description:</comment>
  Очистка результата запроса и освобождение памяти
  
  <strong>pg_free_result()</strong>  освобождает память, занятую экземпляром <class>PgSql\Result</class>.
  
  Вызывать эту функцию следует только в случае нехватки памяти при выполнении скрипта. В любом
  случае память будет освобождена автоматически по окончании работы скрипта.
  
  Прежнее название функции: <strong>pg_freeresult()</strong>.

<comment>Param:</comment>
  <info>PgSql\Result</info>  <strong>$result</strong>  Экземпляр <class>PgSql\Result</class>, возвращаемый функциями <strong>pg_query()</strong>,
                         <strong>pg_query_params()</strong> или <strong>pg_execute()</strong> (среди прочего).

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

<comment>See Also:</comment>
   * <strong>pg_query()</strong>
   * <strong>pg_query_params()</strong>
   * <strong>pg_execute()</strong>


id: pg_get_notify
type: function
doc:
<comment>Description:</comment>
  Получение SQL NOTIFY сообщения
  
  <strong>pg_get_notify()</strong> получает уведомления, сгенерированные командой SQL <return>NOTIFY</return>. Для получения
  уведомлений используйте команду SQL <return>LISTEN</return>.

<comment>Param:</comment>
  <info>PgSql\Connection</info>  <strong>$connection</strong>  Экземпляр <class>PgSql\Connection</class>.
  <info>int</info>               <strong>$mode</strong>        Необязательный параметр, управляющий тем, как индексируется
                                 возвращаемый массив (<info>array</info>).
                                 Параметр <strong>$mode</strong> является константой и может принимать следующие
                                 значения:
                                 <info>PGSQL_ASSOC</info>, <info>PGSQL_NUM</info> и <info>PGSQL_BOTH</info>.
                                 При использовании <info>PGSQL_NUM</info> функция возвращает массив с числовыми
                                 индексами,
                                 при использовании <info>PGSQL_ASSOC</info> она вернёт только ассоциативные
                                 индексы,
                                 а <info>PGSQL_BOTH</info> вернёт как числовые, так и ассоциативные индексы.

<comment>Return:</comment>
  <info>array|false</info>  Массив (<info>array</info>), содержащий сообщение <return>NOTIFY</return> и PID сервера БД. Если поддерживается
               сервером, массив также содержит версию сервера и полезную нагрузку. Если никаких
               уведомлений не ожидается, функция вернёт <info>false</info>.

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


id: pg_get_pid
type: function
doc:
<comment>Description:</comment>
  Получает ID процесса сервера БД
  
  <strong>pg_get_pid()</strong> получает PID сервера базы данных. PID полезен, когда требуется определить, какой
  процесс отправил <return>NOTIFY</return> сообщение, принятое функцией <strong>pg_get_notify()</strong> (точнее узнать, сервер его
  отправил или какой-то другой процесс).

<comment>Param:</comment>
  <info>PgSql\Connection</info>  <strong>$connection</strong>  Экземпляр <class>PgSql\Connection</class>.

<comment>Return:</comment>
  <info>int</info>  ID процесса сервера баз данных.

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


id: pg_get_result
type: function
doc:
<comment>Description:</comment>
  Получение результата асинхронного запроса
    
  
  <strong>pg_get_result()</strong> получает экземпляр <class>PgSql\Result</class> из асинхронного запроса, запущенного функциями
  <strong>pg_send_query()</strong>, <strong>pg_send_query_params()</strong> или <strong>pg_send_execute()</strong>.
  
  <strong>pg_send_query()</strong> и другие функции, посылающие асинхронные запросы, может посылать сразу несколько
  запросов на сервер. Функция <strong>pg_get_result()</strong> получит результаты всех запросов по очереди.

<comment>Param:</comment>
  <info>PgSql\Connection</info>  <strong>$connection</strong>  Экземпляр <class>PgSql\Connection</class>.

<comment>Return:</comment>
  <info>PgSql\Result|false</info>  Экземпляр <class>PgSql\Result</class>, либо <info>false</info>, когда доступных результатов больше нет.

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


id: pg_host
type: function
doc:
<comment>Description:</comment>
  Возвращает имя хоста, соответствующего подключению
    
  
  <strong>pg_host()</strong>  возвращает имя хоста, с которым установлено заданное соединение PostgreSQL <strong>$connection</strong>.

<comment>Param:</comment>
  <info>PgSql\Connection|null</info>  <strong>$connection</strong>  Экземпляр <class>PgSql\Connection</class>.
                                      Если параметр <strong>$connection</strong> указан <info>null</info>, используется соединение
                                      по умолчанию. Соединение по умолчанию — это последнее
                                      соединение, выполненное с помощью функций <strong>pg_connect()</strong> или
                                      <strong>pg_pconnect()</strong>.
                                      Начиная с версии PHP 8.1.0, использование соединения по
                                      умолчанию устарело.
                                      
                                      Начиная с версии PHP 8.1.0, использование соединения по
                                      умолчанию устарело.

<comment>Return:</comment>
  <info>string</info>  Строка, содержащая имя подключённого через <strong>$connection</strong> хоста, либо пустая строка в случае
          возникновения ошибки.

<comment>See Also:</comment>
   * <strong>pg_connect()</strong>
   * <strong>pg_pconnect()</strong>


id: pg_insert
type: function
doc:
<comment>Description:</comment>
  Заносит данные из массива в таблицу базы данных
    
  
  <strong>pg_insert()</strong> вставляет записи из массива <strong>$values</strong> в таблицу <strong>$table_name</strong>.
  
  Если <return>flags</return> указан, <strong>pg_convert()</strong> применяется к <return>values</return> с указанными флагами.
  
  По умолчанию <strong>pg_insert()</strong> передаёт необработанные значения. Значения должны быть экранированы или
  опция <info>PGSQL_DML_ESCAPE</info> должна быть указана. <info>PGSQL_DML_ESCAPE</info> заключает в кавычки и экранирует
  параметры/идентификаторы. Поэтому имена таблиц/столбцов становятся чувствительными к регистру.
  
  Обратите внимание, что ни экранирование, ни подготовленный запрос не защитят запрос LIKE, JSON,
  массив, регулярные выражения и т.д.. Эти параметры должны обрабатываться в соответствии с их
  контекстами, т.е. следует экранировать/проверять значения.

<comment>Param:</comment>
  <info>PgSql\Connection</info>  <strong>$connection</strong>  Экземпляр <class>PgSql\Connection</class>.
  <info>string</info>            <strong>$table_name</strong>  Имя таблицы для вставки данных. Количество колонок в таблице
                                 <strong>$table_name</strong> должно быть не меньше, чем элементов в массиве <strong>$values</strong>.
  <info>array</info>             <strong>$values</strong>      Ассоциативный массив(<info>array</info>), в котором ключи являются названиями
                                 колонок таблицы <strong>$table_name</strong>, а значения - записи, которые
                                 необходимо вставить в эти колонки.
  <info>int</info>               <strong>$flags</strong>       Комбинация констант <info>PGSQL_CONV_OPTS</info>, <info>PGSQL_DML_NO_CONV</info>,
                                 <info>PGSQL_DML_ESCAPE</info>, <info>PGSQL_DML_EXEC</info>, <info>PGSQL_DML_ASYNC</info> и
                                 <info>PGSQL_DML_STRING</info>. Если в числе прочих передаётся <info>PGSQL_DML_STRING</info> в
                                 параметре <strong>$flags</strong>, функция вернёт строку запроса. Если установлены
                                 <info>PGSQL_DML_NO_CONV</info> или <info>PGSQL_DML_ESCAPE</info>, то функция <strong>pg_convert()</strong>
                                 внутренне не вызывается.

<comment>Return:</comment>
  <info>PgSql\Result|string|bool</info>  Возвращает <info>true</info> в случае успешного выполнения или <info>false</info> в случае
                            возникновения ошибки.. Или возвращает строку(<info>string</info>), если
                            <info>PGSQL_DML_STRING</info> включена в список параметров аргумента <strong>$flags</strong>.

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


id: pg_last_error
type: function
doc:
<comment>Description:</comment>
  Получает сообщение о последней произошедшей ошибке на соединении с базой данных
  
  <strong>pg_last_error()</strong> возвращает сообщение о последней ошибке на заданном соединении <strong>$connection</strong>.
  
  Сообщения об ошибках могут перезаписываться при внутренних вызовах функций PostgreSQL (libpq).
  Если внутри модуля PostgreSQL произойдёт несколько ошибок, сообщение может оказаться
  неинформативным.
  
  Для обработки ошибок лучше использовать функции <strong>pg_result_error()</strong>, <strong>pg_result_error_field()</strong>,
  <strong>pg_result_status()</strong> и <strong>pg_connection_status()</strong>.
  
  Прежнее название функции: <strong>pg_errormessage()</strong>.

<comment>Param:</comment>
  <info>PgSql\Connection|null</info>  <strong>$connection</strong>  Экземпляр <class>PgSql\Connection</class>.
                                      Если параметр <strong>$connection</strong> указан <info>null</info>, используется соединение
                                      по умолчанию. Соединение по умолчанию — это последнее
                                      соединение, выполненное с помощью функций <strong>pg_connect()</strong> или
                                      <strong>pg_pconnect()</strong>.
                                      Начиная с версии PHP 8.1.0, использование соединения по
                                      умолчанию устарело.
                                      
                                      Начиная с версии PHP 8.1.0, использование соединения по
                                      умолчанию устарело.

<comment>Return:</comment>
  <info>string</info>  Строка, содержащая сообщение о последней ошибке, произошедшей на соединении <strong>$connection</strong>.

<comment>See Also:</comment>
   * <strong>pg_result_error()</strong>
   * <strong>pg_result_error_field()</strong>


id: pg_last_notice
type: function
doc:
<comment>Description:</comment>
  Возвращает последнее уведомление от сервера PostgreSQL
    
  
  <strong>pg_last_notice()</strong> возвращает последнее уведомление, сгенерированное сервером PostgreSQL на заданном
  соединении <strong>$connection</strong>. В некоторых случаях сервер посылает уведомления, например при создании в
  таблице колонки типа <return>SERIAL</return>.
  
  Благодаря <strong>pg_last_notice()</strong> не требуется делать лишних запросов, чтобы узнать посылала ваша
  транзакция уведомления или нет.
  
  Можно отключить отслеживание уведомлений установкой в значение 1 параметра <return>pgsql.ignore_notice</return> в
  файле php.ini.
  
  Можно отключить журналирование уведомлений установкой в значение 0 параметра <return>pgsql.log_notice</return> в
  файле php.ini. Пока этот параметр установлен в значение 0, уведомления невозможно записать в
  журнал выполнения.

<comment>Param:</comment>
  <info>PgSql\Connection</info>  <strong>$connection</strong>  Экземпляр <class>PgSql\Connection</class>.
  <info>int</info>               <strong>$mode</strong>        Одна из констант <info>PGSQL_NOTICE_LAST</info> (для возврата последнего
                                 уведомления), <info>PGSQL_NOTICE_ALL</info> (для возврата всех уведомлений) или
                                 <info>PGSQL_NOTICE_CLEAR</info> (для очистки уведомлений).

<comment>Return:</comment>
  <info>array|string|bool</info>  Строка, содержащая последнее уведомление на заданном соединении, если задана
                     опция <info>PGSQL_NOTICE_LAST</info>, массив (<info>array</info>), если опция <info>PGSQL_NOTICE_ALL</info> и значение
                     типа <info>bool</info> в случае опции <info>PGSQL_NOTICE_CLEAR</info>.

<comment>See Also:</comment>
   * <strong>pg_query()</strong>
   * <strong>pg_last_error()</strong>


id: pg_last_oid
type: function
doc:
<comment>Description:</comment>
  Возвращает OID последней добавленной в базу строки
  
  <strong>pg_last_oid()</strong> используется для определения OID, соответствующего вставленной в таблицу строке.
  
  Поле OID таблиц баз данных стало необязательным, начиная с версии PostgreSQL 7.2, а с версии 8.1
  перестанет добавляться в таблицы по умолчанию. Если поле OID таблицы не задано, используйте
  функцию <strong>pg_result_status()</strong> для проверки успешности вставки записей в таблицу.
  
  Чтобы получить значение <return>SERIAL</return> поля после вставки строки в таблицу, используйте функцию PostgreSQL
  <return>CURRVAL</return>, передав ей имя последовательности, значение которой нужно получить. Чтобы узнать имя
  последовательности, необходимо использовать функцию <return>pg_get_serial_sequence</return> (PostgreSQL 8.0).
  
  В PostgreSQL 8.1 есть функция <return>LASTVAL</return>, возвращающая значение наиболее часто используемой за сессию
  последовательности. Так можно избежать необходимость задавать название последовательности, таблицы
  или колонки.
  
  Прежнее название функции: <strong>pg_getlastoid()</strong>.

<comment>Param:</comment>
  <info>PgSql\Result</info>  <strong>$result</strong>  Экземпляр <class>PgSql\Result</class>, возвращаемый функциями <strong>pg_query()</strong>,
                         <strong>pg_query_params()</strong> или <strong>pg_execute()</strong> (среди прочего).

<comment>Return:</comment>
  <info>string|int|false</info>  Целое число (<info>int</info>) или строка (<info>string</info>), содержащая OID последней вставленной
                    строки на соединении <strong>$connection</strong>, либо <info>false</info>, если произошла ошибка или поле OID
                    недоступно.

<comment>See Also:</comment>
   * <strong>pg_query()</strong>
   * <strong>pg_result_status()</strong>


id: pg_lo_close
type: function
doc:
<comment>Description:</comment>
  Закрывает большой объект
  
  <strong>pg_lo_close()</strong> закрывает большой объект.
  
  Операции с использованием интерфейса больших объектов необходимо заключать в блок транзакции.
  
  Прежнее название функции: <strong>pg_loclose()</strong>.

<comment>Param:</comment>
  <info>PgSql\Lob</info>  <strong>$lob</strong>  An <class>PgSql\Lob</class> instance, returned by <strong>pg_lo_open()</strong>.

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

<comment>See Also:</comment>
   * <strong>pg_lo_open()</strong>
   * <strong>pg_lo_create()</strong>
   * <strong>pg_lo_import()</strong>


id: pg_lo_create
type: function
doc:
<comment>Description:</comment>
  Создаёт большой объект
  
  <strong>pg_lo_create()</strong> создаёт большой объект и возвращает его OID. Режимы доступа PostgreSQL <info>INV_READ</info>,
  <info>INV_WRITE</info>, и <info>INV_ARCHIVE</info> не поддерживаются, объект всегда создаётся с доступом на чтение и запись.
  Режим <info>INV_ARCHIVE</info> убран из PostgreSQL версий 6.3 и выше.
  
  Операции с использованием интерфейса больших объектов необходимо заключать в блок транзакции.
  
  Вместо использования интерфейса больших объектов (который не имеет контроля доступа и весьма
  громоздкий сам по себе) пользуйтесь полями PostgreSQL типа bytea для хранения двоичных данных и
  функцией <strong>pg_escape_bytea()</strong> для их экранирования.
  
  Прежнее название функции: <strong>pg_locreate()</strong>.

<comment>Param:</comment>
  <info>PgSql\Connection</info>  <strong>$connection</strong>  Экземпляр <class>PgSql\Connection</class>.
                                 Если <strong>$connection</strong> не указано, используется соединение по умолчанию.
                                 Соединение по умолчанию — это последнее соединение, выполненное с
                                 помощью функций <strong>pg_connect()</strong>
                                 или <strong>pg_pconnect()</strong>.
                                 Начиная с версии PHP 8.1.0, использование соединения по умолчанию
                                 устарело.
                                 
                                 Начиная с версии PHP 8.1.0, использование соединения по умолчанию
                                 устарело.
  <info>mixed</info>             <strong>$object_id</strong>   Если задан аргумент <strong>$object_id</strong>, функция попытается создать объект с
                                 этим идентификатором, в противном случае будет использован
                                 свободный идентификатор, назначенный сервером. Этот аргумент
                                 основан на функционале, впервые реализованном в PostgreSQL 8.1.

<comment>Return:</comment>
  <info>int</info>  OID большого объекта или <info>false</info> в случае возникновения ошибки.


id: pg_lo_export
type: function
doc:
<comment>Description:</comment>
  Вывод большого объекта в файл
  
  <strong>pg_lo_export()</strong> выбирает большой объект из базы данных и сохраняет его данные локально в файловой
  системе.
  
  Операции с использованием интерфейса больших объектов необходимо заключать в блок транзакции.
  
  Прежнее название функции: <strong>pg_loexport()</strong>.

<comment>Param:</comment>
  <info>PgSql\Connection</info>  <strong>$connection</strong>  Экземпляр <class>PgSql\Connection</class>.
                                 Если <strong>$connection</strong> не указано, используется соединение по умолчанию.
                                 Соединение по умолчанию — это последнее соединение, выполненное с
                                 помощью функций <strong>pg_connect()</strong>
                                 или <strong>pg_pconnect()</strong>.
                                 Начиная с версии PHP 8.1.0, использование соединения по умолчанию
                                 устарело.
                                 
                                 Начиная с версии PHP 8.1.0, использование соединения по умолчанию
                                 устарело.
  <info>int</info>               <strong>$oid</strong>         OID большого объекта в базе данных.
  <info>string</info>            <strong>$pathname</strong>    Полный путь и имя файла в клиентской файловой системе для записи
                                 данных большого объекта.

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

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


id: pg_lo_import
type: function
doc:
<comment>Description:</comment>
  Импорт большого объекта из файла
  
  <strong>pg_lo_import()</strong> создаёт большой объект в базе данных, используя локальный файл в качестве источника
  данных.
  
  Операции с использованием интерфейса больших объектов необходимо заключать в блок транзакции.
  
  Прежнее название функции: <strong>pg_loimport()</strong>.

<comment>Param:</comment>
  <info>PgSql\Connection</info>  <strong>$connection</strong>  Экземпляр <class>PgSql\Connection</class>.
                                 Если <strong>$connection</strong> не указано, используется соединение по умолчанию.
                                 Соединение по умолчанию — это последнее соединение, выполненное с
                                 помощью функций <strong>pg_connect()</strong>
                                 или <strong>pg_pconnect()</strong>.
                                 Начиная с версии PHP 8.1.0, использование соединения по умолчанию
                                 устарело.
                                 
                                 Начиная с версии PHP 8.1.0, использование соединения по умолчанию
                                 устарело.
  <info>string</info>            <strong>$pathname</strong>    Полный путь и имя файла в клиентской файловой системе для чтения
                                 данных большого объекта.
  <info>mixed</info>             <strong>$object_id</strong>   Если задан аргумент <strong>$object_id</strong>, функция попытается создать объект с
                                 этим идентификатором, в противном случае будет использован
                                 свободный идентификатор, назначенный сервером. Этот аргумент
                                 основан на функционале, впервые реализованном в PostgreSQL 8.1.

<comment>Return:</comment>
  <info>int</info>  OID созданного большого объекта или <info>false</info> в случае возникновения ошибки.

<comment>See Also:</comment>
   * <strong>pg_lo_export()</strong>
   * <strong>pg_lo_open()</strong>


id: pg_lo_open
type: function
doc:
<comment>Description:</comment>
  Открывает большой объект базы данных
  
  <strong>pg_lo_open()</strong> открывает большой объект базы данных и возвращает экземпляр <class>PgSql\Lob</class>.
  
  Не следует закрывать соединение с базой данных до того, как завершится работа с экземпляром
  <class>PgSql\Lob</class>.
  
  Операции с использованием интерфейса больших объектов необходимо заключать в блок транзакции.
  
  Прежнее название функции: <strong>pg_loopen()</strong>.

<comment>Param:</comment>
  <info>PgSql\Connection</info>  <strong>$connection</strong>  Экземпляр <class>PgSql\Connection</class>.
                                 Если <strong>$connection</strong> не указано, используется соединение по умолчанию.
                                 Соединение по умолчанию — это последнее соединение, выполненное с
                                 помощью функций <strong>pg_connect()</strong>
                                 или <strong>pg_pconnect()</strong>.
                                 Начиная с версии PHP 8.1.0, использование соединения по умолчанию
                                 устарело.
                                 
                                 Начиная с версии PHP 8.1.0, использование соединения по умолчанию
                                 устарело.
  <info>int</info>               <strong>$oid</strong>         OID большого объекта в базе данных.
  <info>string</info>            <strong>$mode</strong>        Режим доступа к объекту. Возможные значения: "r" - только для
                                 чтения, "w" - только для записи, "rw" - для чтения и записи.

<comment>Return:</comment>
  <info>PgSql\Lob|false</info>  Экземпляр <class>PgSql\Lob</class> или <info>false</info> в случае возникновения ошибки.

<comment>See Also:</comment>
   * <strong>pg_lo_close()</strong>
   * <strong>pg_lo_create()</strong>


id: pg_lo_read
type: function
doc:
<comment>Description:</comment>
  Читает данные большого объекта
  
  <strong>pg_lo_read()</strong> читает <strong>$length</strong> байт большого объекта и возвращает их в виде строки.
  
  Операции с использованием интерфейса больших объектов необходимо заключать в блок транзакции.
  
  Прежнее название функции: <strong>pg_loread()</strong>.

<comment>Param:</comment>
  <info>int</info>  <strong>$length</strong>  An <class>PgSql\Lob</class> instance, returned by <strong>pg_lo_open()</strong>.
  <info>int</info>  <strong>$length</strong>  Необязательный аргумент. Количество байт, которые необходимо прочитать.

<comment>Return:</comment>
  <info>string|false</info>  Строка(<info>string</info>), содержащая <strong>$length</strong> байт большого объекта, либо <info>false</info> в случае
                возникновения ошибки.

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


id: pg_lo_read_all
type: function
doc:
<comment>Description:</comment>
  Читает содержимое большого объекта и посылает напрямую в браузер
    
  
  <strong>pg_lo_read_all()</strong> читает большой объект и посылает данные напрямую в браузер после отправки всех
  необходимых заголовков. Используется в основном для пересылки двоичных данных, таких как
  изображения или звук.
  
  Операции с использованием интерфейса больших объектов необходимо заключать в блок транзакции.
  
  Прежнее название функции: <strong>pg_loreadall()</strong>.

<comment>Param:</comment>
  <info>PgSql\Lob</info>  <strong>$lob</strong>  An <class>PgSql\Lob</class> instance, returned by <strong>pg_lo_open()</strong>.

<comment>Return:</comment>
  <info>int</info>  Количество прочитанных байт.

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


id: pg_lo_seek
type: function
doc:
<comment>Description:</comment>
  Перемещает внутренний указатель большого объекта
    
  
  <strong>pg_lo_seek()</strong> перемещает внутренний указатель экземпляра <class>PgSql\Lob</class>.
  
  Операции с использованием интерфейса больших объектов необходимо заключать в блок транзакции.

<comment>Param:</comment>
  <info>PgSql\Lob</info>  <strong>$lob</strong>     An <class>PgSql\Lob</class> instance, returned by <strong>pg_lo_open()</strong>.
  <info>int</info>        <strong>$offset</strong>  Количество байт, на сколько требуется переместить указатель.
  <info>int</info>        <strong>$whence</strong>  Одна из констант: <info>PGSQL_SEEK_SET</info> (перемещать от начала объекта),
                      <info>PGSQL_SEEK_CUR</info> (перемещать с текущей позиции) или <info>PGSQL_SEEK_END</info> (отступать от
                      конца объекта).

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

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


id: pg_lo_tell
type: function
doc:
<comment>Description:</comment>
  Возвращает текущее положение внутреннего указателя большого объекта
    
  
  <strong>pg_lo_tell()</strong> возвращает текущую позицию (отступ от начала) внутреннего указателя большого объекта.
  
  Операции с использованием интерфейса больших объектов необходимо заключать в блок транзакции.

<comment>Param:</comment>
  <info>PgSql\Lob</info>  <strong>$lob</strong>  An <class>PgSql\Lob</class> instance, returned by <strong>pg_lo_open()</strong>.

<comment>Return:</comment>
  <info>int</info>  Текущая позиция внутреннего указателя (количество байт от начала) большого объекта. В случае
       возникновения ошибки функция вернёт отрицательное значение.

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


id: pg_lo_truncate
type: function
doc:
<comment>Description:</comment>
  Обрезает большой объект
    
  
  <strong>pg_lo_truncate()</strong> обрезает экземпляр <class>PgSql\Lob</class>.
  
  Для использования интерфейса большого объекта, необходимо заключить его в блок транзакций.

<comment>Param:</comment>
  <info>PgSql\Lob</info>  <strong>$lob</strong>   An <class>PgSql\Lob</class> instance, returned by <strong>pg_lo_open()</strong>.
  <info>int</info>        <strong>$size</strong>  Количество байтов для обрезания.

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

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


id: pg_lo_unlink
type: function
doc:
<comment>Description:</comment>
  Удаление большого объекта
  
  <strong>pg_lo_unlink()</strong> удаляет большой объект с идентификатором <strong>$oid</strong>.
  
  Операции с использованием интерфейса больших объектов необходимо заключать в блок транзакции.
  
  Прежнее название функции: <strong>pg_lounlink()</strong>.

<comment>Param:</comment>
  <info>PgSql\Connection</info>  <strong>$connection</strong>  Экземпляр <class>PgSql\Connection</class>.
                                 Если <strong>$connection</strong> не указано, используется соединение по умолчанию.
                                 Соединение по умолчанию — это последнее соединение, выполненное с
                                 помощью функций <strong>pg_connect()</strong>
                                 или <strong>pg_pconnect()</strong>.
                                 Начиная с версии PHP 8.1.0, использование соединения по умолчанию
                                 устарело.
                                 
                                 Начиная с версии PHP 8.1.0, использование соединения по умолчанию
                                 устарело.
  <info>int</info>               <strong>$oid</strong>         OID большого объекта в базе данных.

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

<comment>See Also:</comment>
   * <strong>pg_lo_create()</strong>
   * <strong>pg_lo_import()</strong>


id: pg_lo_write
type: function
doc:
<comment>Description:</comment>
  Записывает данные в большой объект
  
  <strong>pg_lo_write()</strong> записывает данные в большой объект, начиная с текущей позиции внутреннего указателя.
  
  Операции с использованием интерфейса больших объектов необходимо заключать в блок транзакции.
  
  Прежнее название функции: <strong>pg_lowrite()</strong>.

<comment>Param:</comment>
  <info>PgSql\Lob</info>  <strong>$lob</strong>     An <class>PgSql\Lob</class> instance, returned by <strong>pg_lo_open()</strong>.
  <info>string</info>     <strong>$data</strong>    Данные для записи в большой объект. Если аргумент <strong>$length</strong> задан и меньше
                      размера <strong>$data</strong>, то записаны будут только <strong>$length</strong> байт.
  <info>int|null</info>   <strong>$length</strong>  Необязательный аргумент. Максимальное количество записываемых байт. Должен
                      быть больше нуля и не превышать размер <strong>$data</strong>. По умолчанию принимается равным
                      размеру <strong>$data</strong>.

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

<comment>See Also:</comment>
   * <strong>pg_lo_create()</strong>
   * <strong>pg_lo_open()</strong>


id: pg_meta_data
type: function
doc:
<comment>Description:</comment>
  Получение метаданных таблицы
    
  
  <strong>pg_meta_data()</strong> возвращает определение таблицы <return>table_name</return> в виде массива.

<comment>Param:</comment>
  <info>PgSql\Connection</info>  <strong>$connection</strong>  Экземпляр <class>PgSql\Connection</class>.
  <info>string</info>            <strong>$table_name</strong>  Название таблицы.
  <info>bool</info>              <strong>$extended</strong>    Флаг, указывающий, что нужно вернуть расширенные мета-данные. По
                                 умолчанию <info>false</info>.

<comment>Return:</comment>
  <info>array|false</info>  Массив, содержащий определение таблицы или <info>false</info> в случае возникновения ошибки.

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


id: pg_num_fields
type: function
doc:
<comment>Description:</comment>
  Возвращает количество полей в выборке
  
  <strong>pg_num_fields()</strong> возвращает количество полей (столбцов) в экземпляре <class>PgSql\Result</class>.
  
  Ранее функция называлась <strong>pg_numfields()</strong>.

<comment>Param:</comment>
  <info>PgSql\Result</info>  <strong>$result</strong>  Экземпляр <class>PgSql\Result</class>, возвращаемый функциями <strong>pg_query()</strong>,
                         <strong>pg_query_params()</strong> или <strong>pg_execute()</strong> (среди прочего).

<comment>Return:</comment>
  <info>int</info>  Количество полей (столбцов) в выборке. В случае возникновения ошибки возвращает -1.

<comment>See Also:</comment>
   * <strong>pg_num_rows()</strong>
   * <strong>pg_affected_rows()</strong>


id: pg_num_rows
type: function
doc:
<comment>Description:</comment>
  Возвращает количество строк в выборке
  
  <strong>pg_num_rows()</strong> возвращает количество строк в экземпляре <class>PgSql\Result</class>.
  
  Ранее функция называлась <strong>pg_numrows()</strong>.

<comment>Param:</comment>
  <info>PgSql\Result</info>  <strong>$result</strong>  Экземпляр <class>PgSql\Result</class>, возвращаемый функциями <strong>pg_query()</strong>,
                         <strong>pg_query_params()</strong> или <strong>pg_execute()</strong> (среди прочего).

<comment>Return:</comment>
  <info>int</info>  Количество строк в выборке. В случае возникновения ошибки возвращает <return>-1</return>.

<comment>See Also:</comment>
   * <strong>pg_num_fields()</strong>
   * <strong>pg_affected_rows()</strong>


id: pg_options
type: function
doc:
<comment>Description:</comment>
  Получение параметров соединения с сервером баз данных
  
  <strong>pg_options()</strong> возвращает строку, содержащую параметры соединения PostgreSQL <strong>$connection</strong>.

<comment>Param:</comment>
  <info>PgSql\Connection|null</info>  <strong>$connection</strong>  Экземпляр <class>PgSql\Connection</class>.
                                      Если параметр <strong>$connection</strong> указан <info>null</info>, используется соединение
                                      по умолчанию. Соединение по умолчанию — это последнее
                                      соединение, выполненное с помощью функций <strong>pg_connect()</strong> или
                                      <strong>pg_pconnect()</strong>.
                                      Начиная с версии PHP 8.1.0, использование соединения по
                                      умолчанию устарело.
                                      
                                      Начиная с версии PHP 8.1.0, использование соединения по
                                      умолчанию устарело.

<comment>Return:</comment>
  <info>string</info>  Строка, содержащая параметры соединения <strong>$connection</strong>.

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


id: pg_parameter_status
type: function
doc:
<comment>Description:</comment>
  Просмотр текущих значений параметров сервера
  
  Получает текущее значение заданного параметра сервера.
  
  Значения некоторых параметров сервер сообщает автоматически при установлении подключения или при
  изменении данных значений. Функция <strong>pg_parameter_status()</strong> может запрашивать подобные значения. Она
  возвращает значение параметра, если оно определено, либо <info>false</info> в случае возникновения ошибки.
  
  Список параметров серверов PostgreSQL версий 8.0 и выше: <return>server_version</return>, <return>server_encoding</return>,
  <return>client_encoding</return>, <return>is_superuser</return>, <return>session_authorization</return>, <return>DateStyle</return>, <return>TimeZone</return>, и <return>integer_datetimes</return>.
  (<return>server_encoding</return>, <return>TimeZone</return>, и <return>integer_datetimes</return> не определяются для версий ниже 8.0.) Стоит
  отметить, что значения <return>server_version</return>, <return>server_encoding</return> и <return>integer_datetimes</return> нельзя изменить после
  запуска PostgreSQL.
  
  Несмотря на то, что PostgreSQL версий 7.3 и ниже не сообщают значений своих параметров,
  <strong>pg_parameter_status()</strong> позволяет определить значения параметров <return>server_version</return> и <return>client_encoding</return>.
  Для определения значений этих параметров предпочтительней использовать <strong>pg_parameter_status()</strong>,
  нежели специально разрабатывать другие функции.
  
  Если при использовании сервера PostgreSQL версий 7.4 и ниже изменить параметр <return>client_encoding</return>
  посредством команды сервера <return>SET</return> уже после установки соединения, функция <strong>pg_parameter_status()</strong> не
  сможет отразить этот факт.

<comment>Param:</comment>
  <info>PgSql\Connection</info>  <strong>$connection</strong>  Экземпляр <class>PgSql\Connection</class>.
                                 Если <strong>$connection</strong> не указано, используется соединение по умолчанию.
                                 Соединение по умолчанию — это последнее соединение, выполненное с
                                 помощью функций <strong>pg_connect()</strong>
                                 или <strong>pg_pconnect()</strong>.
                                 Начиная с версии PHP 8.1.0, использование соединения по умолчанию
                                 устарело.
                                 
                                 Начиная с версии PHP 8.1.0, использование соединения по умолчанию
                                 устарело.
  <info>string</info>            <strong>$param_name</strong>  Допустимые значения аргумента: <return>server_version</return>, <return>server_encoding</return>,
                                 <return>client_encoding</return>, <return>is_superuser</return>, <return>session_authorization</return>, <return>DateStyle</return>,
                                 <return>TimeZone</return> и <return>integer_datetimes</return>. Обратите внимание, что это значение
                                 чувствительно к регистру.

<comment>Return:</comment>
  <info>string</info>  Значение запрашиваемого параметра в виде строки, либо <info>false</info>, если передан недопустимый
          параметр.


id: pg_pconnect
type: function
doc:
<comment>Description:</comment>
  Открывает постоянное соединение с сервером PostgreSQL
  
  <strong>pg_pconnect()</strong> устанавливает соединение с базой данных PostgreSQL. Возвращает экземпляр
  <class>PgSql\Connection</class>, необходимый для работы большинства функций PostgreSQL.
  
  При повторном вызове функции <strong>pg_pconnect()</strong> с теми же значениями параметров в <strong>$connection_string</strong>
  функция вернёт существующее подключение. Чтобы принудительно создать новое соединение, необходимо
  передать строку подключения функции <info>PGSQL_CONNECT_FORCE_NEW</info> в качестве параметра <strong>$flags</strong>.
  
  Возможность создавать постоянные подключения регулируется директивой pgsql.allow_persistent файла
  php.ini. Для включения, установите значение в "On" (является значением по умолчанию). Максимальное
  количество постоянных соединений задаётся директивой pgsql.max_persistent файла php.ini (по
  умолчанию -1, не ограничено). Количество любых возможных подключений устанавливается директивой
  pgsql.max_links файла php.ini.
  
  <strong>pg_close()</strong> не закрывает соединения, открытые функцией <strong>pg_pconnect()</strong>.

<comment>Param:</comment>
  <info>string</info>  <strong>$connection_string</strong>  Строка <strong>$connection_string</strong> может быть пустой строкой или содержать
                              несколько параметров разделённых пробелами. Каждый параметр
                              указывается как <return>keyword = value</return>. Пробелы вокруг знака равно
                              необязательны. Пустые строки в качестве значения или значения,
                              содержащие пробелы отделяются одинарными кавычками, как например,
                              <return>keyword = 'a value'</return>. Для задания одинарных кавычек и обратных слешей в
                              качестве значений их необходимо экранировать обратным слешем, то есть
                              \' и \\.
                              
                              Список основных ключевых слов: <strong>$host</strong>, <strong>$hostaddr</strong>, <strong>$port</strong>, <strong>$dbname</strong>
                              (значение по умолчанию для параметра <strong>$user</strong>), <strong>$user</strong>, <strong>$password</strong>,
                              <strong>$connect_timeout</strong>, <strong>$options</strong>, <strong>$tty</strong> (игнорируется), <strong>$sslmode</strong>, <strong>$requiressl</strong>
                              (устарело в связи с использованием параметра <strong>$sslmode</strong>), и <strong>$service</strong>.
                              Какие из этих аргументов будут обработаны, зависит от версии
                              PostgreSQL.
  <info>int</info>     <strong>$flags</strong>              Если в функцию передана константа <info>PGSQL_CONNECT_FORCE_NEW</info>, будет
                              создаваться новое подключение, даже если <strong>$connection_string</strong> идентична
                              строке существующего подключения.

<comment>Return:</comment>
  <info>PgSql\Connection|false</info>  Экземпляр <class>PgSql\Connection</class> в случае успешного выполнения или <info>false</info> в
                          случае возникновения ошибки.

<comment>See Also:</comment>
   * <strong>pg_connect()</strong>
   * 
     Постоянные соединения с базой данных


id: pg_ping
type: function
doc:
<comment>Description:</comment>
  Проверка соединения с базой данных
  
  <strong>pg_ping()</strong> проверяет соединение с базой данных и переподключается, если оно нарушено.

<comment>Param:</comment>
  <info>PgSql\Connection|null</info>  <strong>$connection</strong>  Экземпляр <class>PgSql\Connection</class>.
                                      Если параметр <strong>$connection</strong> указан <info>null</info>, используется соединение
                                      по умолчанию. Соединение по умолчанию — это последнее
                                      соединение, выполненное с помощью функций <strong>pg_connect()</strong> или
                                      <strong>pg_pconnect()</strong>.
                                      Начиная с версии PHP 8.1.0, использование соединения по
                                      умолчанию устарело.
                                      
                                      Начиная с версии PHP 8.1.0, использование соединения по
                                      умолчанию устарело.

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

<comment>See Also:</comment>
   * <strong>pg_connection_status()</strong>
   * <strong>pg_connection_reset()</strong>


id: pg_port
type: function
doc:
<comment>Description:</comment>
  Возвращает номер порта, соответствующий заданному соединению
    
  
  <strong>pg_port()</strong> возвращает номер порта, соответствующего заданному соединению PostgreSQL <strong>$connection</strong>.

<comment>Param:</comment>
  <info>PgSql\Connection|null</info>  <strong>$connection</strong>  Экземпляр <class>PgSql\Connection</class>.
                                      Если параметр <strong>$connection</strong> указан <info>null</info>, используется соединение
                                      по умолчанию. Соединение по умолчанию — это последнее
                                      соединение, выполненное с помощью функций <strong>pg_connect()</strong> или
                                      <strong>pg_pconnect()</strong>.
                                      Начиная с версии PHP 8.1.0, использование соединения по
                                      умолчанию устарело.
                                      
                                      Начиная с версии PHP 8.1.0, использование соединения по
                                      умолчанию устарело.

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


id: pg_prepare
type: function
doc:
<comment>Description:</comment>
  Посылает запрос на создание параметризованного SQL выражения
    и ждёт его завершения
  
  <strong>pg_prepare()</strong> создаёт заготовку SQL выражения на сервере для последующего запуска функциями
  <strong>pg_execute()</strong> или <strong>pg_send_execute()</strong>. Это позволяет многократно выполнять единожды созданные запросы
  с различными параметрами. <strong>pg_prepare()</strong> поддерживается PostgreSQL версии 7.4 и выше. Функция не
  будет работать c серверами ранних версий.
  
  Функция создаёт заготовку SQL запроса с названием <strong>$stmtname</strong> и телом <strong>$query</strong>, которое должно
  содержать одно SQL выражение. <strong>$stmtname</strong> может быть пустой строкой, тогда будет создана безымянная
  заготовка. Если какая-либо безымянная заготовка уже определена, она будет заменена на новую
  автоматически. В остальных случаях совпадение имён новой и существующей в данной сессии заготовок
  приведёт к ошибке. Если в <strong>$query</strong> будут передаваться параметры, то они заменят псевдопеременные $1,
  $2 и т.д. при передаче запроса.
  
  Подобные заготовки запросов также можно делать с помощью SQL-команды <return>PREPARE</return> (но <strong>pg_prepare()</strong>
  более гибкая, так как не требует строгой типизации своих параметров). Важно отметить, что в PHP
  нет функций для удаления подготовленных SQL-выражений, для этого используйте команду SQL
  <return>DEALLOCATE</return>.

<comment>Param:</comment>
  <info>PgSql\Connection</info>  <strong>$connection</strong>  Экземпляр <class>PgSql\Connection</class>.
                                 Если <strong>$connection</strong> не указано, используется соединение по умолчанию.
                                 Соединение по умолчанию — это последнее соединение, выполненное с
                                 помощью функций <strong>pg_connect()</strong>
                                 или <strong>pg_pconnect()</strong>.
                                 Начиная с версии PHP 8.1.0, использование соединения по умолчанию
                                 устарело.
                                 
                                 Начиная с версии PHP 8.1.0, использование соединения по умолчанию
                                 устарело.
  <info>string</info>            <strong>$stmtname</strong>    Имя создаваемой заготовки. Должно быть уникальным в пределах
                                 сессии. Если задана пустая строка, будет создано безымянное SQL
                                 выражение. При этом оно перезапишет уже существующее безымянное
                                 выражение, определённое ранее.
  <info>string</info>            <strong>$query</strong>       Параметризованный SQL-запрос. Должен содержать только одно
                                 выражение (несколько выражений разделённых точкой с запятой не
                                 поддерживаются). Если в запрос будут передаваться параметры, то они
                                 заменят псевдопеременные $1, $2 и т.д.

<comment>Return:</comment>
  <info>PgSql\Result|false</info>  Экземпляр <class>PgSql\Result</class> в случае успешного выполнения или <info>false</info> в случае
                      возникновения ошибки.

<comment>See Also:</comment>
   * <strong>pg_execute()</strong>
   * <strong>pg_send_execute()</strong>


id: pg_put_line
type: function
doc:
<comment>Description:</comment>
  Передаёт на PostgreSQL сервер строку с завершающим нулём
  
  <strong>pg_put_line()</strong> передаёт на PostgreSQL сервер строку с завершающим нулём. Завершение строки
  значением NULL необходимо при её объединении с командой PostgreSQL <return>COPY FROM</return>.
  
  <return>COPY</return> является высокоскоростным интерфейсом передачи данных, поддерживаемым PostgreSQL. Данные
  передаются одной транзакцией и не разбираются парсером.
  
  В качестве альтернативы можно использовать функцию <strong>pg_copy_from()</strong>. Она значительно проще в
  использовании.
  
  Перед запуском функции <strong>pg_end_copy()</strong> приложение должно сообщить о серверу о завершении передачи
  данных, добавив в конец последней строки символы "\.".
  
  Использование <strong>pg_put_line()</strong> может привести к отказу операций с большими объектами, включающих
  функции <strong>pg_lo_read()</strong> и <strong>pg_lo_tell()</strong>. Для этих целей используйте функции <strong>pg_copy_from()</strong> и
  <strong>pg_copy_to()</strong>.

<comment>Param:</comment>
  <info>PgSql\Connection</info>  <strong>$connection</strong>  Экземпляр <class>PgSql\Connection</class>.
                                 Если <strong>$connection</strong> не указано, используется соединение по умолчанию.
                                 Соединение по умолчанию — это последнее соединение, выполненное с
                                 помощью функций <strong>pg_connect()</strong>
                                 или <strong>pg_pconnect()</strong>.
                                 Начиная с версии PHP 8.1.0, использование соединения по умолчанию
                                 устарело.
                                 
                                 Начиная с версии PHP 8.1.0, использование соединения по умолчанию
                                 устарело.
  <info>string</info>            <strong>$data</strong>        Текстовая строка для прямой пересылки на сервер. Завершающий <return>NULL</return>
                                 добавляется автоматически.

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

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


id: pg_query
type: function
doc:
<comment>Description:</comment>
  Выполняет запрос
  
  <strong>pg_query()</strong> выполняет <strong>$query</strong> к указанной в <strong>$connection</strong> базе данных. <strong>pg_query_params()</strong> должна быть
  предпочтительнее в большинстве случаев.
  
  В случае возникновения ошибки функция возвращает <info>false</info>, детали ошибки можно получить с помощью
  функции <strong>pg_last_error()</strong>, если соединение с БД не нарушено.
  
   Несмотря на то, что параметр <strong>$connection</strong> может быть опущен, делать так не рекомендуется, так как
  это может привести к трудно находимым ошибкам в скриптах.
  
  Несмотря на то, что параметр <strong>$connection</strong> может быть опущен, делать так не рекомендуется, так как
  это может привести к трудно находимым ошибкам в скриптах.
  
  Ранее данная функция называлась <strong>pg_exec()</strong>. <strong>pg_exec()</strong> всё ещё доступна в целях обеспечения
  совместимости, но лучше использовать новое имя.

<comment>Param:</comment>
  <info>PgSql\Connection</info>  <strong>$connection</strong>  Экземпляр <class>PgSql\Connection</class>.
                                 Если <strong>$connection</strong> не указано, используется соединение по умолчанию.
                                 Соединение по умолчанию — это последнее соединение, выполненное с
                                 помощью функций <strong>pg_connect()</strong>
                                 или <strong>pg_pconnect()</strong>.
                                 Начиная с версии PHP 8.1.0, использование соединения по умолчанию
                                 устарело.
                                 
                                 Начиная с версии PHP 8.1.0, использование соединения по умолчанию
                                 устарело.
  <info>string</info>            <strong>$query</strong>       Выражение или выражения SQL для выполнения. Если передано несколько
                                 выражений они автоматически выполняются, как одна транзакция если
                                 явно не указаны команды BEGIN/COMMIT внутри выражения. Тем не
                                 менее, использовать несколько транзакций в одном вызове функции не
                                 рекомендуется.
                                 
                                 Строковое представление пользовательских данных очень опасно и
                                 часто приводит к возможности SQL инъекции. В большинстве случаев
                                 лучше передавать пользовательские данные параметром в
                                 <strong>pg_query_params()</strong>, а не подставлять их в строку запроса.
                                 
                                 Любые данные передаваемые от пользователя непосредственно в строку
                                 запроса должны быть хорошо экранированы.

<comment>Return:</comment>
  <info>PgSql\Result|false</info>  Экземпляр <class>PgSql\Result</class> в случае успешного выполнения или <info>false</info> в случае
                      возникновения ошибки.

<comment>See Also:</comment>
   * <strong>pg_connect()</strong>
   * <strong>pg_pconnect()</strong>
   * <strong>pg_fetch_array()</strong>
   * <strong>pg_fetch_object()</strong>
   * <strong>pg_num_rows()</strong>
   * <strong>pg_affected_rows()</strong>


id: pg_query_params
type: function
doc:
<comment>Description:</comment>
  Посылает параметризованный запрос на сервер, параметры передаются отдельно от текста SQL запроса
    
  
  Посылает параметризованный запрос на сервер и ждёт результат. Параметры передаются отдельно от
  строки запроса.
  
  <strong>pg_query_params()</strong> подобна функции <strong>pg_query()</strong>, но предоставляет дополнительный функционал:
  параметры запроса можно передавать отдельно от строки запроса. <strong>pg_query_params()</strong> поддерживается на
  соединениях с серверами PostgreSQL версий 7.4 и выше. Функция не будет работать с серверами ранних
  версий.
  
  Если используются параметры <strong>$params</strong>, они заменяют псевдопеременные $1, $2 и т.д. в строке запроса
  <strong>$query</strong>. Один и тот же параметр может быть указан больше одного раза в <strong>$query</strong>; в этом случае будут
  использованы одинаковые значения. <strong>$params</strong> определяют текущие значения параметров. Значение <info>null</info> в
  массиве параметров будет означать SQL <return>NULL</return> в запросе.
  
  Главное преимущество <strong>pg_query_params()</strong> перед <strong>pg_query()</strong> заключается в том, что значения параметров
  могут передаваться отдельно от строки запроса <strong>$query</strong>. Это даёт возможность избежать утомительную и
  подверженную ошибкам процедуру экранирования спецсимволов и заключения значений в кавычки. Однако,
  в отличие от <strong>pg_query()</strong>, эта функция поддерживает только один SQL запрос в передаваемой строке.
  (Он может содержать точку с запятой, но не более одной непустой SQL-команды.)

<comment>Param:</comment>
  <info>PgSql\Connection</info>  <strong>$connection</strong>  Экземпляр <class>PgSql\Connection</class>.
                                 Если <strong>$connection</strong> не указано, используется соединение по умолчанию.
                                 Соединение по умолчанию — это последнее соединение, выполненное с
                                 помощью функций <strong>pg_connect()</strong>
                                 или <strong>pg_pconnect()</strong>.
                                 Начиная с версии PHP 8.1.0, использование соединения по умолчанию
                                 устарело.
                                 
                                 Начиная с версии PHP 8.1.0, использование соединения по умолчанию
                                 устарело.
  <info>string</info>            <strong>$query</strong>       Параметризованный SQL запрос. Должен содержать только одно
                                 выражение (несколько выражений разделённых точкой с запятой не
                                 поддерживаются). Если в запрос будут передаваться параметры, то они
                                 заменят псевдопеременные $1, $2 и т.д.
                                 
                                 Пользовательские данные всегда должны передаваться как параметры, и
                                 не передаваться в строку запроса напрямую, где они могут привести к
                                 возможным атакам через SQL-инъекции и приводит к ошибкам, если
                                 данные содержат кавычки. Если по каким-то причинам вы не можете
                                 использовать параметр, убедитесь, что пользовательские данные
                                 правильно экранированы.
  <info>array</info>             <strong>$params</strong>      Массив значений параметров запроса для замены псевдопеременных $1,
                                 $2 и т.д. в исходной строке запроса. Количество элементов массива
                                 должно точно совпадать с количеством псевдопеременных.
                                 
                                 Значения предназначенные для <return>bytea</return> полей нельзя передавать в
                                 параметрах. Используйте функцию <strong>pg_escape_bytea()</strong> или функции для
                                 больших объектов.

<comment>Return:</comment>
  <info>PgSql\Result|false</info>  Экземпляр <class>PgSql\Result</class> в случае успешного выполнения или <info>false</info> в случае
                      возникновения ошибки.

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


id: pg_result_error
type: function
doc:
<comment>Description:</comment>
  Возвращает сообщение об ошибке, связанное с запросом результата
    
  
  <strong>pg_result_error()</strong> возвращает сообщение о любой ошибке, связанное с экземпляром <strong>$result</strong>. Таким
  образом, возможно получить более верное сообщение об ошибке, чем при использовании
  <strong>pg_last_error()</strong>.
  
  Функция <strong>pg_result_error_field()</strong> может дать гораздо более подробную информацию об ошибке, чем
  <strong>pg_result_error()</strong>.
  
  Так как <strong>pg_query()</strong> возвращает <info>false</info> в случае возникновения ошибки запроса, необходимо использовать
  <strong>pg_send_query()</strong> и <strong>pg_get_result()</strong> для получения дескриптора результата.

<comment>Param:</comment>
  <info>PgSql\Result</info>  <strong>$result</strong>  Экземпляр <class>PgSql\Result</class>, возвращаемый функциями <strong>pg_query()</strong>,
                         <strong>pg_query_params()</strong> или <strong>pg_execute()</strong> (среди прочего).

<comment>Return:</comment>
  <info>string|false</info>  Возвращает строку (<info>string</info>). Возвращает пустую строку, если нет ошибки. Если же есть
                ошибка, не связанная с параметром <strong>$result</strong>, то возвращается <info>false</info>.

<comment>See Also:</comment>
   * <strong>pg_result_error_field()</strong>
   * <strong>pg_query()</strong>
   * <strong>pg_send_query()</strong>
   * <strong>pg_get_result()</strong>
   * <strong>pg_last_error()</strong>
   * <strong>pg_last_notice()</strong>


id: pg_result_error_field
type: function
doc:
<comment>Description:</comment>
  Возвращает конкретное поле из отчёта об ошибках
    
  
  <strong>pg_result_error_field()</strong> возвращает одно из полей отчёта об ошибках, связанного с экземпляром
  <strong>$result</strong>. Функция поддерживается серверами PostgreSQL версий 7.4 и выше. Нужное поле задаётся
  аргументом <strong>$field_code</strong>.
  
  Функции <strong>pg_query()</strong> и <strong>pg_query_params()</strong> в случае ошибок возвращают <info>false</info> вместо ресурса. Чтобы
  иметь возможность обрабатывать ошибки, пользуйтесь функциями <strong>pg_send_query()</strong> и <strong>pg_get_result()</strong>.
  
  Для получения дополнительной информации о ходе выполнения отказавшей функции <strong>pg_query()</strong>
  используйте функции <strong>pg_set_error_verbosity()</strong> и <strong>pg_last_error()</strong> и обрабатывайте результат их
  выполнения.

<comment>Param:</comment>
  <info>PgSql\Result</info>  <strong>$result</strong>      Экземпляр <class>PgSql\Result</class>, возвращаемый функциями <strong>pg_query()</strong>,
                             <strong>pg_query_params()</strong> или <strong>pg_execute()</strong> (среди прочего).
  <info>int</info>           <strong>$field_code</strong>  Возможные значения аргумента <strong>$field_code</strong>: <info>PGSQL_DIAG_SEVERITY</info>,
                             <info>PGSQL_DIAG_SQLSTATE</info>, <info>PGSQL_DIAG_MESSAGE_PRIMARY</info>,
                             <info>PGSQL_DIAG_MESSAGE_DETAIL</info>, <info>PGSQL_DIAG_MESSAGE_HINT</info>,
                             <info>PGSQL_DIAG_STATEMENT_POSITION</info>, <info>PGSQL_DIAG_INTERNAL_POSITION</info> (для версий
                             PostgreSQL 8.0 и выше), <info>PGSQL_DIAG_INTERNAL_QUERY</info> (для версий
                             PostgreSQL 8.0 и выше), <info>PGSQL_DIAG_CONTEXT</info>, <info>PGSQL_DIAG_SOURCE_FILE</info>,
                             <info>PGSQL_DIAG_SOURCE_LINE</info>, <info>PGSQL_DIAG_SOURCE_FUNCTION</info>.

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

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


id: pg_result_seek
type: function
doc:
<comment>Description:</comment>
  Смещает указатель на строку выборки в экземпляре результата запроса
    
  
  <strong>pg_result_seek()</strong> устанавливает смещение внутреннего указателя в экземпляре <strong>$result</strong>.

<comment>Param:</comment>
  <info>PgSql\Result</info>  <strong>$result</strong>  Экземпляр <class>PgSql\Result</class>, возвращаемый функциями <strong>pg_query()</strong>,
                         <strong>pg_query_params()</strong> или <strong>pg_execute()</strong> (среди прочего).
  <info>int</info>           <strong>$row</strong>     Количество строк, на которое требуется сместить внутренний указатель
                         ресурса <class>PgSql\Result</class>. Строки нумеруются с нуля.

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

<comment>See Also:</comment>
   * <strong>pg_fetch_row()</strong>
   * <strong>pg_fetch_assoc()</strong>
   * <strong>pg_fetch_array()</strong>
   * <strong>pg_fetch_object()</strong>
   * <strong>pg_fetch_result()</strong>


id: pg_result_status
type: function
doc:
<comment>Description:</comment>
  Возвращает состояние результата запроса
    
  
  <strong>pg_result_status()</strong> возвращает текущее состояние экземпляра <class>PgSql\Result</class>, либо тег завершения
  сервером работы с с этим ресурсом.

<comment>Param:</comment>
  <info>PgSql\Result</info>  <strong>$result</strong>  Экземпляр <class>PgSql\Result</class>, возвращаемый функциями <strong>pg_query()</strong>,
                         <strong>pg_query_params()</strong> или <strong>pg_execute()</strong> (среди прочего).
  <info>int</info>           <strong>$mode</strong>    Принимает одно из двух значений: <info>PGSQL_STATUS_LONG</info> для получения числового
                         обозначения состояния <strong>$result</strong>, либо <info>PGSQL_STATUS_STRING</info> для получения тэга
                         состояния в виде строки. По умолчанию используется <info>PGSQL_STATUS_LONG</info>.

<comment>Return:</comment>
  <info>string|int</info>  Если в качестве аргумента передаётся <info>PGSQL_STATUS_LONG</info>, то возвращается одна из
              перечисленных констант: <info>PGSQL_EMPTY_QUERY</info>, <info>PGSQL_COMMAND_OK</info>, <info>PGSQL_TUPLES_OK</info>,
              <info>PGSQL_COPY_OUT</info>, <info>PGSQL_COPY_IN</info>, <info>PGSQL_BAD_RESPONSE</info>, <info>PGSQL_NONFATAL_ERROR</info>,
              <info>PGSQL_FATAL_ERROR</info>. В противном случае функция вернёт строковое представление состояния
              результата запроса.

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


id: pg_select
type: function
doc:
<comment>Description:</comment>
  Выбирает записи из базы данных
    
  
  <strong>pg_select()</strong> выбирает записи из базы данных, удовлетворяющие условиям <return>field=&gt;value</return>, заданным в
  массиве <strong>$conditions</strong>.
  
  Если задан параметр <strong>$flags</strong>, то к массиву <strong>$conditions</strong> будет применена функция <strong>pg_convert()</strong> с
  параметрами, заданными в качестве аргумента.
  
  Если задан параметр <strong>$mode</strong>, возвращаемое значение будет в виде массива при <info>PGSQL_NUM</info>,
  ассоциативного массива при <info>PGSQL_ASSOC</info> (по умолчанию) или и того, и другого при <info>PGSQL_BOTH</info>.
  
  По умолчанию <strong>pg_insert()</strong> передаёт необработанные значения. Значения должны быть экранированы или
  опция PGSQL_DML_ESCAPE должна быть указана. PGSQL_DML_ESCAPE заключает в кавычки и экранирует
  параметры/идентификаторы. Поэтому имена таблиц/столбцов становятся чувствительными к регистру.
  
  Обратите внимание, что ни экранирование, ни подготовленный запрос не защитят запрос LIKE, JSON,
  массив, регулярные выражения и т.д.. Эти параметры должны обрабатываться в соответствии с их
  контекстами, т.е. следует экранировать/проверять значения.

<comment>Param:</comment>
  <info>PgSql\Connection</info>  <strong>$connection</strong>  Экземпляр <class>PgSql\Connection</class>.
  <info>string</info>            <strong>$table_name</strong>  Название таблицы, из которой выбираются данные.
  <info>array</info>             <strong>$conditions</strong>  Массив (<info>array</info>), ключи которого соответствуют именам колонок таблицы
                                 <strong>$table_name</strong>. Будут выбраны только те строки, значения полей которых
                                 совпадут со значениями массива.
  <info>int</info>               <strong>$flags</strong>       Одна из констант <info>PGSQL_CONV_FORCE_NULL</info>, <info>PGSQL_DML_NO_CONV</info>,
                                 <info>PGSQL_DML_ESCAPE</info>, <info>PGSQL_DML_EXEC</info>, <info>PGSQL_DML_ASYNC</info>, <info>PGSQL_DML_STRING</info>
                                 или их комбинация. Если <strong>$flags</strong> содержит <info>PGSQL_DML_STRING</info>, функция
                                 вернёт строку. Если установлены <info>PGSQL_DML_NO_CONV</info> или
                                 <info>PGSQL_DML_ESCAPE</info>, то функция <strong>pg_convert()</strong> внутренне не вызывается.
  <info>int</info>               <strong>$mode</strong>        Одна из констант <info>PGSQL_ASSOC</info>, <info>PGSQL_NUM</info> или <info>PGSQL_BOTH</info>. Если
                                 установлено значение <info>PGSQL_ASSOC</info>, возвращаемое значение будет
                                 ассоциативным массивом (<info>array</info>), при <info>PGSQL_NUM</info> возвращаемое значение
                                 будет массивом (<info>array</info>), а при <info>PGSQL_BOTH</info> возвращаемое значение
                                 будет и ассоциативным и числовым индексированным массивом (<info>array</info>).

<comment>Return:</comment>
  <info>array|string|false</info>  Возвращает строку (<info>string</info>), если <strong>$flags</strong> содержит <info>PGSQL_DML_STRING</info>, в противном
                      случае в случае успешного выполнения функция возвращает массив (<info>array</info>) или
                      <info>false</info> в случае возникновения ошибки.

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


id: pg_send_execute
type: function
doc:
<comment>Description:</comment>
  Запускает предварительно подготовленный SQL-запрос и
     передаёт ему параметры; не ожидает возвращаемого результата
    
  
  Запускает предварительно подготовленный SQL-запрос и передаёт ему параметры; не ожидает
  возвращаемого результата.
  
  Работает аналогично функции <strong>pg_send_query_params()</strong>, только вместо строки с запросом принимает имя
  предварительно подготовленного SQL-запроса. Аргументы функции обрабатываются так же, как и в
  функции <strong>pg_execute()</strong>. Как и <strong>pg_execute()</strong> эта функция не будет работать на соединениях с серверами
  PostgreSQL версий ниже 7.4.

<comment>Param:</comment>
  <info>PgSql\Connection</info>  <strong>$connection</strong>      Экземпляр <class>PgSql\Connection</class>.
  <info>string</info>            <strong>$statement_name</strong>  Имя подготовленного к исполнению запроса. Если передана пустая
                                     строка "", будет выполнен безымянный запрос. Имя и содержимое
                                     запроса должны быть подготовлены функцией <strong>pg_prepare()</strong>,
                                     <strong>pg_send_prepare()</strong> либо с помощью SQL-команды <return>PREPARE</return>.
  <info>array</info>             <strong>$params</strong>          Массив значений параметров запроса для замены псевдопеременных
                                     $1, $2 и т.д. в исходной строке запроса. Количество элементов
                                     массива должно точно совпадать с количеством псевдопеременных.

<comment>Return:</comment>
  <info>int|bool</info>  Возвращает <info>true</info> в случае успешного выполнения, <info>false</info> или <return>0</return> в случае возникновения
            ошибки. Для получения результата запроса используйте функцию <strong>pg_get_result()</strong>.

<comment>See Also:</comment>
   * <strong>pg_prepare()</strong>
   * <strong>pg_send_prepare()</strong>
   * <strong>pg_execute()</strong>


id: pg_send_prepare
type: function
doc:
<comment>Description:</comment>
  Посылает запрос на создание параметризованного SQL-выражения,
     не дожидаясь его завершения
    
  
  Посылает запрос на создание параметризованного SQL выражения и не ждёт его завершения.
  
  Это асинхронная версия функции <strong>pg_prepare()</strong>: она возвращает <info>true</info>, если удалось отправить запрос,
  <info>false</info> в противном случае. После успешной отправки, воспользуйтесь функцией <strong>pg_get_result()</strong>, чтобы
  узнать, создалось ли требуемое SQL выражение. Аргументы функции обрабатываются так же, как в
  <strong>pg_prepare()</strong>. Функция не будет работать с серверами PostgreSQL версий ниже 7.4.

<comment>Param:</comment>
  <info>PgSql\Connection</info>  <strong>$connection</strong>      Экземпляр <class>PgSql\Connection</class>.
  <info>string</info>            <strong>$statement_name</strong>  Имя создаваемой заготовки. Должно быть уникальным в пределах
                                     сессии. Если задана пустая строка, будет создано безымянное SQL
                                     выражение. При этом оно перезапишет уже существующее безымянное
                                     выражение, определённое ранее.
  <info>string</info>            <strong>$query</strong>           Параметризованный SQL запрос. Должен содержать только одно
                                     выражение (несколько выражений разделённых точкой с запятой не
                                     поддерживаются). Если в запрос будут передаваться параметры, то
                                     они заменят псевдопеременные $1, $2 и т.д.

<comment>Return:</comment>
  <info>int|bool</info>  Возвращает <info>true</info> в случае успешного выполнения, <info>false</info> или <return>0</return> в случае возникновения
            ошибки. Для получения результата запроса используйте функцию <strong>pg_get_result()</strong>.

<comment>See Also:</comment>
   * <strong>pg_connect()</strong>
   * <strong>pg_pconnect()</strong>
   * <strong>pg_execute()</strong>
   * <strong>pg_send_execute()</strong>
   * <strong>pg_send_query_params()</strong>


id: pg_send_query
type: function
doc:
<comment>Description:</comment>
  Отправляет асинхронный запрос
    
  
  <strong>pg_send_query()</strong> отправляет на выполнение асинхронный запрос. В отличие от <strong>pg_query()</strong> запрос может
  содержать несколько SQL-выражений, разделённых точкой с запятой. Для получения результата запроса
  используйте функцию <strong>pg_get_result()</strong>.
  
  Выполнение запроса не прерывает работу скрипта. Для определения занятости соединения (когда запрос
  ещё выполняется) используйте функцию <strong>pg_connection_busy()</strong>. Выполнение запроса можно прервать
  функцией <strong>pg_cancel_query()</strong>.
  
  Несмотря на то, что можно отправить несколько запросов за раз, их нельзя посылать, пока соединение
  занято. В противном случае, посланный запрос дождётся завершения предыдущего, сотрёт его результат
  и запустится сам. Таким образом вы потеряете данные результата предыдущего запроса.

<comment>Param:</comment>
  <info>PgSql\Connection</info>  <strong>$connection</strong>  Экземпляр <class>PgSql\Connection</class>.
  <info>string</info>            <strong>$query</strong>       Одно или несколько SQL-выражений, разделённых точкой с запятой.
                                 
                                 Спецсимволы в строке запроса должны быть экранированы.

<comment>Return:</comment>
  <info>int|bool</info>  Возвращает <info>true</info> в случае успешного выполнения, <info>false</info> или <return>0</return> в случае возникновения
            ошибки. Для получения результата запроса используйте функцию <strong>pg_get_result()</strong>.

<comment>See Also:</comment>
   * <strong>pg_query()</strong>
   * <strong>pg_cancel_query()</strong>
   * <strong>pg_get_result()</strong>
   * <strong>pg_connection_busy()</strong>


id: pg_send_query_params
type: function
doc:
<comment>Description:</comment>
  Посылает параметризованный запрос на сервер, не ожидает возвращаемого результата
    
  
  Отправляет параметризованный запрос на выполнение и не ждёт его завершения. Параметры передаются
  отдельно от текста SQL запроса.
  
  Функция является аналогом <strong>pg_send_query()</strong> за одним исключением: параметры запроса можно передавать
  отдельно от строки запроса. Аргументы функции обрабатываются так же, как и в <strong>pg_query_params()</strong>.
  <strong>pg_send_query()</strong> поддерживается на соединениях с серверами PostgreSQL версий 7.4 и выше. Функция не
  будет работать с серверами ранних версий. Также она поддерживает только одну SQL-команду в
  выражении.

<comment>Param:</comment>
  <info>PgSql\Connection</info>  <strong>$connection</strong>  Экземпляр <class>PgSql\Connection</class>.
  <info>string</info>            <strong>$query</strong>       Параметризованный SQL запрос. Должен содержать только одно
                                 выражение (несколько выражений разделённых точкой с запятой не
                                 поддерживаются). Если в запрос будут передаваться параметры, то они
                                 заменят псевдопеременные $1, $2 и т.д.
  <info>array</info>             <strong>$params</strong>      Массив значений параметров запроса для замены псевдопеременных $1,
                                 $2 и т.д. в исходной строке запроса. Количество элементов массива
                                 должно точно совпадать с количеством псевдопеременных.

<comment>Return:</comment>
  <info>int|bool</info>  Возвращает <info>true</info> в случае успешного выполнения, <info>false</info> или <return>0</return> в случае возникновения
            ошибки. Для получения результата запроса используйте функцию <strong>pg_get_result()</strong>.

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


id: pg_set_client_encoding
type: function
doc:
<comment>Description:</comment>
  Устанавливает клиентскую кодировку
    
  
  <strong>pg_set_client_encoding()</strong> устанавливает клиентскую кодировку и возвращает 0 в случае успешного
  выполнения, -1 в случае возникновения ошибки.
  
  PostgreSQL автоматически конвертирует данные из кодировки базы данных в кодировку клиентского
  приложения.
  
  Прежнее название функции: <strong>pg_setclientencoding()</strong>.

<comment>Param:</comment>
  <info>PgSql\Connection</info>  <strong>$connection</strong>  Экземпляр <class>PgSql\Connection</class>.
                                 Если <strong>$connection</strong> не указано, используется соединение по умолчанию.
                                 Соединение по умолчанию — это последнее соединение, выполненное с
                                 помощью функций <strong>pg_connect()</strong>
                                 или <strong>pg_pconnect()</strong>.
                                 Начиная с версии PHP 8.1.0, использование соединения по умолчанию
                                 устарело.
                                 
                                 Начиная с версии PHP 8.1.0, использование соединения по умолчанию
                                 устарело.
  <info>string</info>            <strong>$encoding</strong>    Требуемая клиентская кодировка. Список возможных значений:
                                 <return>SQL_ASCII</return>, <return>EUC_JP</return>, <return>EUC_CN</return>, <return>EUC_KR</return>, <return>EUC_TW</return>, <return>UNICODE</return>, <return>MULE_INTERNAL</return>,
                                 <return>LATINX</return> (X=1...9), <return>KOI8</return>, <return>WIN</return>, <return>ALT</return>, <return>SJIS</return>, <return>BIG5</return> or <return>WIN1250</return>.
                                 
                                 Список доступных кодировок зависит от версии PostgreSQL. Смотрите
                                 документацию к вашей версии сервера.

<comment>Return:</comment>
  <info>int</info>  Возвращает <return>0</return> в случае успешного выполнения, либо <return>-1</return> в случае возникновения ошибки.

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


id: pg_set_error_context_visibility
type: function
doc:
<comment>Description:</comment>
  Determines the visibility of the context's error messages returned by pg_last_error
     and pg_result_error
    
  
  Determines the visibility of the context's error messages returned by <strong>pg_last_error()</strong> and
  <strong>pg_result_error()</strong>

<comment>Param:</comment>
  <info>PgSql\Connection</info>  <strong>$connection</strong>  Экземпляр <class>PgSql\Connection</class>.
  <info>int</info>               <strong>$visibility</strong>  The required visibility: <info>PGSQL_SHOW_CONTEXT_NEVER</info>,
                                 <info>PGSQL_SHOW_CONTEXT_ERRORS</info> or <info>PGSQL_SHOW_CONTEXT_ALWAYS</info>.

<comment>Return:</comment>
  <info>int</info>  The previous visibility level: <info>PGSQL_SHOW_CONTEXT_NEVER</info>, <info>PGSQL_SHOW_CONTEXT_ERRORS</info> or
       <info>PGSQL_SHOW_CONTEXT_ALWAYS</info>.

<comment>See Also:</comment>
   * <strong>pg_last_error()</strong>
   * <strong>pg_result_error()</strong>


id: pg_set_error_verbosity
type: function
doc:
<comment>Description:</comment>
  Определяет объем текста сообщений, возвращаемых функциями
     pg_last_error и pg_result_error
    
  
  Определяет объем текста сообщений, возвращаемых функциями <strong>pg_last_error()</strong> и <strong>pg_result_error()</strong>.
  
  <strong>pg_set_error_verbosity()</strong> устанавливает режим, отвечающий за полноту сообщений об ошибках. В режиме
  <info>PGSQL_ERRORS_TERSE</info> сообщения будут содержать только важность ошибки, основной текст и место
  возникновения; эта информация обычно умещается в одну строку. В режиме по умолчанию
  <info>PGSQL_ERRORS_DEFAULT</info> в сообщения будут добавлены детали ошибки, подсказка или поля контекста (это
  может занять несколько строк). В режиме <info>PGSQL_ERRORS_VERBOSE</info> сообщения будут содержать все
  возможные поля. Изменение режима не затронет сообщения уже существующих ресурсов. Новый режим
  будет применяться только к вновь создаваемым.

<comment>Param:</comment>
  <info>PgSql\Connection</info>  <strong>$connection</strong>  Экземпляр <class>PgSql\Connection</class>.
                                 Если <strong>$connection</strong> не указано, используется соединение по умолчанию.
                                 Соединение по умолчанию — это последнее соединение, выполненное с
                                 помощью функций <strong>pg_connect()</strong>
                                 или <strong>pg_pconnect()</strong>.
                                 Начиная с версии PHP 8.1.0, использование соединения по умолчанию
                                 устарело.
                                 
                                 Начиная с версии PHP 8.1.0, использование соединения по умолчанию
                                 устарело.
  <info>int</info>               <strong>$verbosity</strong>   Требуемый режим: <info>PGSQL_ERRORS_TERSE</info>, <info>PGSQL_ERRORS_DEFAULT</info> или
                                 <info>PGSQL_ERRORS_VERBOSE</info>.

<comment>Return:</comment>
  <info>int</info>  Предыдущий режим действовавший до запуска функции: <info>PGSQL_ERRORS_TERSE</info>, <info>PGSQL_ERRORS_DEFAULT</info>
       или <info>PGSQL_ERRORS_VERBOSE</info>.

<comment>See Also:</comment>
   * <strong>pg_last_error()</strong>
   * <strong>pg_result_error()</strong>


id: pg_socket
type: function
doc:
<comment>Description:</comment>
  Получить дескриптор только для чтения на сокет, лежащего в основе соединения PostgreSQL
    
  
  <strong>pg_socket()</strong> возвращает ресурс (<info>resource</info>) только для чтения, соответствующий сокету, лежащему в
  основе данного соединения PostgreSQL.
  
  К настоящему времени эта функция ещё не была документирована; для ознакомления доступен только
  список аргументов.

<comment>Param:</comment>
  <info>PgSql\Connection</info>  <strong>$connection</strong>  Экземпляр <class>PgSql\Connection</class>.

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


id: pg_trace
type: function
doc:
<comment>Description:</comment>
  Включает трассировку подключения PostgreSQL
  
  <strong>pg_trace()</strong> включает трассировку соединения с PostgreSQL сервером во внешний файл. Чтобы понимать
  содержимое таких файлов, необходимо хорошо разбираться во внутреннем устройстве клиент-серверного
  взаимодействия.
  
  Для тех, кто не обладает подобными навыками, трассировка всё же может оказаться полезной для
  поиска ошибок при отправке запросов на сервер. Например, можно выполнить команду grep '^To
  backend' trace.log и посмотреть, какие запросы реально отправлены на сервер. Дополнительную
  информацию можно почерпнуть из документации PostgreSQL.

<comment>Param:</comment>
  <info>string</info>                 <strong>$filename</strong>    Полный путь и имя файла для записи журнала трассировки.
                                      Аналогично <strong>fopen()</strong>.
  <info>string</info>                 <strong>$mode</strong>        Необязательный аргумент. Режим доступа к файлу. Аналогично
                                      <strong>fopen()</strong>.
  <info>PgSql\Connection|null</info>  <strong>$connection</strong>  Экземпляр <class>PgSql\Connection</class>.
                                      Если параметр <strong>$connection</strong> указан <info>null</info>, используется соединение
                                      по умолчанию. Соединение по умолчанию — это последнее
                                      соединение, выполненное с помощью функций <strong>pg_connect()</strong> или
                                      <strong>pg_pconnect()</strong>.
                                      Начиная с версии PHP 8.1.0, использование соединения по
                                      умолчанию устарело.
                                      
                                      Начиная с версии PHP 8.1.0, использование соединения по
                                      умолчанию устарело.
  <info>int</info>                    <strong>$trace_mode</strong>  Необязательный режим трассировки со следующими константами:
                                      <info>PGSQL_TRACE_SUPPRESS_TIMESTAMPS</info> и <info>PGSQL_TRACE_REGRESS_MODE</info>.

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

<comment>See Also:</comment>
   * <strong>fopen()</strong>
   * <strong>pg_untrace()</strong>


id: pg_transaction_status
type: function
doc:
<comment>Description:</comment>
  Возвращает текущее состояние транзакции на сервере
    
  
  Возвращает текущее состояние транзакции на сервере.
  
  <strong>pg_transaction_status()</strong> выдаёт некорректный результат при работе с сервером PostgreSQL 7.3, на
  котором выключена опция <return>autocommit</return>. Автоматическое завершение транзакций на стороне сервера
  устарело и не используется в более поздних версиях.

<comment>Param:</comment>
  <info>PgSql\Connection</info>  <strong>$connection</strong>  Экземпляр <class>PgSql\Connection</class>.

<comment>Return:</comment>
  <info>int</info>  Список возможных состояний: <info>PGSQL_TRANSACTION_IDLE</info> (сервер бездействует),
       <info>PGSQL_TRANSACTION_ACTIVE</info> (выполняется запрос), <info>PGSQL_TRANSACTION_INTRANS</info> (сервер
       бездействует, работа в режиме транзакции), или <info>PGSQL_TRANSACTION_INERROR</info> (сервер
       бездействует, транзакция потерпела неудачу). <info>PGSQL_TRANSACTION_UNKNOWN</info> - ошибка подключения.
       <info>PGSQL_TRANSACTION_ACTIVE</info> возвращается только когда запрос уже отправлен на сервер, но ещё не
       обработан.


id: pg_tty
type: function
doc:
<comment>Description:</comment>
  Возвращает имя терминала TTY, связанное с соединением
    
  
  <strong>pg_tty()</strong> возвращает имя терминала, связанного с экземпляром <strong>$connection</strong>, на который выводится
  отладочная информация.
  
  <strong>pg_tty()</strong> устарела, но оставлена для обратной совместимости.

<comment>Param:</comment>
  <info>PgSql\Connection|null</info>  <strong>$connection</strong>  Экземпляр <class>PgSql\Connection</class>.
                                      Если параметр <strong>$connection</strong> указан <info>null</info>, используется соединение
                                      по умолчанию. Соединение по умолчанию — это последнее
                                      соединение, выполненное с помощью функций <strong>pg_connect()</strong> или
                                      <strong>pg_pconnect()</strong>.
                                      Начиная с версии PHP 8.1.0, использование соединения по
                                      умолчанию устарело.
                                      
                                      Начиная с версии PHP 8.1.0, использование соединения по
                                      умолчанию устарело.

<comment>Return:</comment>
  <info>string</info>  Имя TTY для подключения <strong>$connection</strong> в виде строки (<info>string</info>).


id: pg_unescape_bytea
type: function
doc:
<comment>Description:</comment>
  Убирает экранирование двоичных данных типа bytea
    
  
  <strong>pg_unescape_bytea()</strong> убирает экранирование спецсимволов в значениях типа PostgreSQL bytea.
  Возвращает неэкранированную строку, содержащую двоичные данные.
  
  При выборке SQL функцией <return>SELECT</return> данных типа bytea PostgreSQL возвращает значения в восьмеричной
  системе счисления с префиксом '\' (такие как \032). Пользователю необходимо вручную
  преобразовывать их в двоичный формат.
  
  Функция поддерживается PostgreSQL версии 7.2 и выше. Для версий 7.2.0 и 7.2.1 значения должны быть
  преобразованы к типу bytea, когда включена мультибайтовая поддержка. Тогда как <return>INSERT INTO
  test_table (image)VALUES ('$image_escaped'::bytea);</return> в PostgreSQL 7.2.2 и выше не требует
  каких-либо преобразований. Исключение составляет случай, когда клиентская (frontend) кодировка не
  соответствует серверной (backend). При этом возникает ошибка мультибайтового потока, и
  пользователь должен привести данные к типу bytea, чтобы её избежать.

<comment>Param:</comment>
  <info>string</info>  <strong>$string</strong>  Строка (<info>string</info>), содержащая данные типа PostgreSQL bytea и подлежащая
                   преобразованию в двоичную строку PHP.

<comment>Return:</comment>
  <info>string</info>  Строка (<info>string</info>) с неэкранированными спецсимволами.

<comment>See Also:</comment>
   * <strong>pg_escape_bytea()</strong>
   * <strong>pg_escape_string()</strong>


id: pg_untrace
type: function
doc:
<comment>Description:</comment>
  Отключает трассировку соединения с PostgreSQL
  
  Останавливает трассировку, запущенную функцией <strong>pg_trace()</strong>.

<comment>Param:</comment>
  <info>PgSql\Connection|null</info>  <strong>$connection</strong>  Экземпляр <class>PgSql\Connection</class>.
                                      Если параметр <strong>$connection</strong> указан <info>null</info>, используется соединение
                                      по умолчанию. Соединение по умолчанию — это последнее
                                      соединение, выполненное с помощью функций <strong>pg_connect()</strong> или
                                      <strong>pg_pconnect()</strong>.
                                      Начиная с версии PHP 8.1.0, использование соединения по
                                      умолчанию устарело.
                                      
                                      Начиная с версии PHP 8.1.0, использование соединения по
                                      умолчанию устарело.

<comment>Return:</comment>
  <info>true</info>  Функция всегда возвращает <info>true</info>.

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


id: pg_update
type: function
doc:
<comment>Description:</comment>
  Обновление данных в таблице
    
  
  <strong>pg_update()</strong> заменяет записи в таблице, удовлетворяющие условиям <strong>$conditions</strong> данными <strong>$values</strong>.
  
  Если <strong>$flags</strong> указан, <strong>pg_convert()</strong> применяется к <strong>$values</strong> с указанными флагами.
  
  По умолчанию <strong>pg_update()</strong> передаёт необработанные значения. Значения должны быть экранированы или
  опция <info>PGSQL_DML_ESCAPE</info> должна быть указана. <info>PGSQL_DML_ESCAPE</info> заключает в кавычки и экранирует
  параметры/идентификаторы. Поэтому имена таблиц/столбцов становятся чувствительными к регистру.
  
  Обратите внимание, что ни экранирование, ни подготовленный запрос не защитят запрос LIKE, JSON,
  массив, регулярные выражения и т.д.. Эти параметры должны обрабатываться в соответствии с их
  контекстами, т.е. следует экранировать/проверять значения.

<comment>Param:</comment>
  <info>PgSql\Connection</info>  <strong>$connection</strong>  Экземпляр <class>PgSql\Connection</class>.
  <info>string</info>            <strong>$table_name</strong>  Имя таблицы, в которой обновляются записи.
  <info>array</info>             <strong>$values</strong>      Массив (<info>array</info>), ключи которого соответствуют именам колонок таблицы
                                 <strong>$table_name</strong>, а значения заменят данные в этих колонках.
  <info></info>                  <strong>$condition</strong>   Массив (<info>array</info>), ключи которого соответствуют именам колонок таблицы
                                 <strong>$table_name</strong>. Будут обновлены только те строки, значения полей
                                 которых совпадут со значениями массива.
  <info>int</info>               <strong>$flags</strong>       Одна из констант <info>PGSQL_CONV_OPTS</info>, <info>PGSQL_DML_NO_CONV</info>,
                                 <info>PGSQL_DML_ESCAPE</info>, <info>PGSQL_DML_EXEC</info>, <info>PGSQL_DML_ASYNC</info> или
                                 <info>PGSQL_DML_STRING</info>, либо их комбинация. Если <strong>$flags</strong> содержит
                                 <info>PGSQL_DML_STRING</info>, функция вернёт строку. Если установлены
                                 <info>PGSQL_DML_NO_CONV</info> или <info>PGSQL_DML_ESCAPE</info>, то функция <strong>pg_convert()</strong>
                                 внутренне не вызывается.

<comment>Return:</comment>
  <info>string|bool</info>  Возвращает <info>true</info> в случае успешного выполнения или <info>false</info> в случае возникновения
               ошибки. Функция вернёт строку (<info>string</info>), если константа <info>PGSQL_DML_STRING</info> содержится в
               <strong>$flags</strong>.

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


id: pg_version
type: function
doc:
<comment>Description:</comment>
  Возвращает массив, содержащий версии клиента, протокола клиент-серверного
     взаимодействия и сервера (если доступно)
    
  
  <strong>pg_version()</strong> возвращает массив, содержащий версии клиента, протокола клиент-серверного
  взаимодействия и сервера. Версии протокола и сервера доступны, только если модуль PHP
  скомпилирован для PostgreSQL версии 7.4 или выше.
  
  Для получения детальной информации о сервере используйте функцию <strong>pg_parameter_status()</strong>.

<comment>Param:</comment>
  <info>PgSql\Connection|null</info>  <strong>$connection</strong>  Экземпляр <class>PgSql\Connection</class>.
                                      Если параметр <strong>$connection</strong> указан <info>null</info>, используется соединение
                                      по умолчанию. Соединение по умолчанию — это последнее
                                      соединение, выполненное с помощью функций <strong>pg_connect()</strong> или
                                      <strong>pg_pconnect()</strong>.
                                      Начиная с версии PHP 8.1.0, использование соединения по
                                      умолчанию устарело.
                                      
                                      Начиная с версии PHP 8.1.0, использование соединения по
                                      умолчанию устарело.

<comment>Return:</comment>
  <info>array</info>  Возвращает массив с ключами <return>client</return>, <return>protocol</return> и <return>server</return> и соответствующими значениями версий.

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


id: php_ini_loaded_file
type: function
doc:
<comment>Description:</comment>
  Получить путь к загруженному файлу php.ini
    
  
  Проверяет, загружен ли файл php.ini, и возвращает его путь.

<comment>Return:</comment>
  <info>string|false</info>  Путь к загруженному файлу php.ini или <info>false</info>, если файл не загружен.

<comment>See Also:</comment>
   * <strong>php_ini_scanned_files()</strong>
   * <strong>phpinfo()</strong>
   * Конфигурационный файл


id: php_ini_scanned_files
type: function
doc:
<comment>Description:</comment>
  Возвращает список .ini-файлов, найденных в дополнительной ini-директории
    
  
  <strong>php_ini_scanned_files()</strong> возвращает список разделённых запятыми конфигурационных файлов,
  проанализированных после php.ini. Директории, в которых производится поиск, задаются при
  компиляции и, опционально, переменной окружения во время исполнения. Больше информации можно найти
  в инструкции по установке.
  
  Возвращаемые имена файлов включают полный путь.

<comment>Return:</comment>
  <info>string|false</info>  При успехе возвращает строку с разделёнными запятыми именами .ini-файлов. За каждой
                запятой следует новая строка. Если директива --with-config-file-scan-dir не задана и
                переменная окружения PHP_INI_SCAN_DIR тоже не задана, функция вернёт <info>false</info>. Если
                директива задана и она пуста, будет возвращена пустая строка. Если файл не удаётся
                распознать, он всё же будет включён в список, но при этом PHP сообщит об ошибке. Эта
                ошибка будет возникать как при компиляции, так и во время работы
                <strong>php_ini_scanned_files()</strong>.

<comment>See Also:</comment>
   * <strong>ini_set()</strong>
   * <strong>phpinfo()</strong>
   * <strong>php_ini_loaded_file()</strong>


id: php_sapi_name
type: function
doc:
<comment>Description:</comment>
  Возвращает тип интерфейса между веб-сервером и PHP
    
  
  Возвращает строку в нижнем регистре, содержащую описание типа интерфейса (Server API, SAPI),
  который использует PHP. Например, в CLI PHP эта строка будет "cli", в то время как с Apache может
  быть несколько разных значений в зависимости от конкретного SAPI. Возможные значение приведены
  ниже.

<comment>Return:</comment>
  <info>string|false</info>  Возвращает тип интерфейса в виде строки в нижнем регистре или <info>false</info> в случае
                возникновения ошибки.
                
                Возможные возвращаемые значения (список может быть неполным): <return>apache</return>,
                <return>apache2handler</return>, <return>cgi</return> (до PHP 5.3), <return>cgi-fcgi</return>, <return>cli</return>, <return>cli-server</return>, <return>embed</return>, <return>fpm-fcgi</return>,
                <return>litespeed</return>, <return>phpdbg</return>.

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


id: php_strip_whitespace
type: function
doc:
<comment>Description:</comment>
  Возвращает исходный код без комментариев и пробелов
  
  Возвращает исходный код PHP в файл (<strong>$filename</strong>) с удалёнными комментариями и пробелами. Эта функция
  может быть полезной для определения фактичного объёма чистого кода в скриптах по сравнению с
  количеством комментариев. Функция аналогична использованию php -w из командной строки.

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

<comment>Return:</comment>
  <info>string</info>  Возвращает очищенный исходный код в случае успешного выполнения или пустую строку в случае
          возникновения ошибки.
          
          Эта функция принимает во внимание значение INI-директивы short_open_tag.


id: php_uname
type: function
doc:
<comment>Description:</comment>
  Возвращает информацию об операционной системе, на которой запущен PHP
    
  
  <strong>php_uname()</strong> возвращает описание операционной системы, на которой запущен PHP. Это та же строка, с
  которой начинается вывод <strong>phpinfo()</strong>. Для вывода названия операционной системы также можно
  использовать константу <info>PHP_OS</info>, но имейте в виду, что эта константа содержит название операционной
  системы, на которой PHP был собран (built).
  
  На некоторых старых UNIX-платформах получить информацию о текущей ОС может оказаться невозможным.
  В таких случаях функция выдаст название ОС, на которой PHP был собран. Такое случается, когда
  библиотека, которой пользуется uname(), недоступна или работает некорректно.

<comment>Param:</comment>
  <info>string</info>  <strong>$mode</strong>  <strong>$mode</strong> - одиночный символ, определяющий, какая информация будет выводиться: <return>'a'</return>: По
                 умолчанию. Содержит все режимы в следующей последовательности <return>"s n r v m"</return>. <return>'s'</return>:
                 Название операционной системы, например, <return>FreeBSD</return>. <return>'n'</return>: Имя хоста, например,
                 <return>localhost.example.com</return>. <return>'r'</return>: Номер релиза, например, <return>5.1.2-RELEASE</return>. <return>'v'</return>: Информация
                 о версии. Может сильно различаться в разных ОС. <return>'m'</return>: Архитектура процессора,
                 например, <return>i386</return>.
                 
                 <return>'a'</return>: По умолчанию. Содержит все режимы в следующей последовательности <return>"s n r v m"</return>.
                 
                 <return>'s'</return>: Название операционной системы, например, <return>FreeBSD</return>.
                 
                 <return>'n'</return>: Имя хоста, например, <return>localhost.example.com</return>.
                 
                 <return>'r'</return>: Номер релиза, например, <return>5.1.2-RELEASE</return>.
                 
                 <return>'v'</return>: Информация о версии. Может сильно различаться в разных ОС.
                 
                 <return>'m'</return>: Архитектура процессора, например, <return>i386</return>.

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

<comment>See Also:</comment>
   * <strong>phpversion()</strong>
   * <strong>php_sapi_name()</strong>
   * <strong>phpinfo()</strong>


id: php_user_filter
type: class
doc:
<comment>Description:</comment>
  Потомки этого класса передаются в функцию <strong>stream_filter_register()</strong>. Обратите внимание, что метод
  __construct не вызывается; вместо этого для инициализации следует использовать
  php_user_filter::onCreate.


id: php_user_filter::filter
type: function
doc:
<comment>Description:</comment>
  Вызывается, как только применяется фильтр
    
  
  Этот метод вызывается всякий раз, когда данные читаются из присоединённого потока или записываются
  в него (такими функциями, как <strong>fread()</strong> или <strong>fwrite()</strong>).

<comment>Param:</comment>
  <info>resource</info>  <strong>$in</strong>        <strong>$in</strong> - ресурс, указывающий на <return>bucket brigade</return>, которая содержит один или
                       несколько объектов <return>bucket</return> содержащих фильтруемые данные.
  <info>resource</info>  <strong>$out</strong>       <strong>$out</strong> - ресурс, указывающий на другой объект <return>bucket brigade</return>, в который будут
                       помещаться модифицированные бакеты.
  <info>int</info>       <strong>$consumed</strong>  <strong>$consumed</strong>, который должен всегда передаваться по ссылке, должен увеличиваться
                       на размер данных, которые фильтр читает и изменяет. В большинстве случаев это
                       значит, что Вы сами будете увеличивать значение <strong>$consumed</strong> на
                       <return>$bucket-&gt;datalen</return> для каждого <return>$bucket</return>.
  <info>bool</info>      <strong>$closing</strong>   Если поток закрывается (следовательно, это последний фильтр в цепочке),
                       аргумент <strong>$closing</strong> примет значение <info>true</info>.

<comment>Return:</comment>
  <info>int</info>  Метод filter должен возвращать одно из трёх значений. Возвращаемое
       значениеОписание<info>PSFS_PASS_ON</info> Фильтр отработал успешно, данные доступны через аргумент <strong>$out</strong>
       <return>bucket brigade</return>. <info>PSFS_FEED_ME</info> Фильтр отработал успешно, однако доступных для вывода данных
       нет. Требуются ещё данные из потока или предыдущего фильтра. <info>PSFS_ERR_FATAL</info> (по умолчанию)
       Фильтр вызвал необрабатываемую ошибку и не может продолжить выполнение.


id: php_user_filter::onClose
type: function
doc:
<comment>Description:</comment>
  Вызывается при закрытии фильтра
  
  Этот метод вызывается, когда фильтр завершает работу (обычно вместе с закрытием потока), и
  выполняется после вызова метода <return>flush</return>. Если какие-либо ресурсы были выделены во время выполнения
  метода <return>onCreate()</return>, то это время, когда их пора уничтожать.

<comment>Return:</comment>
  <info>void</info>  Возвращаемое значение игнорируется.


id: php_user_filter::onCreate
type: function
doc:
<comment>Description:</comment>
  Вызывается при создании объекта фильтра
  
  Этот метод вызывается при создании фильтра во время создания экземпляра класса. В этом методе
  можно выделять необходимые ресурсы и инициализировать объекты (например, различные буферы).
  
  Когда фильтр сначала создаётся и вызывается метод <return>yourfilter-&gt;onCreate()</return>, будет доступен ряд
  следующих свойств, которые описаны в таблице.
  
  СвойствоСодержание<return>FilterClass-&gt;filtername</return> Строка, содержащая имя фильтра, присвоенное ему при
  создании. Фильтры можно регистрировать под разными именами или спецсимволами. Это свойство можно
  использовать для определения, какое имя было использовано. <return>FilterClass-&gt;params</return> Содержимое
  аргумента <strong>$params</strong> передаётся в функцию <strong>stream_filter_append()</strong> или <strong>stream_filter_prepend()</strong>.
  <return>FilterClass-&gt;stream</return> Ресурс потока, который будет фильтроваться. Свойство доступно, только если
  метод filter вызывается, когда параметр <return>closing</return> равен <info>false</info>.

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


id: phpcredits
type: function
doc:
<comment>Description:</comment>
  Выводит список разработчиков PHP
    
  
  Эта функция выводит список разработчиков PHP, модулей и т.д. Она генерирует соответствующий
  HTML-код для вставки на страницу.

<comment>Param:</comment>
  <info>int</info>  <strong>$flags</strong>  Использование аргумента <strong>$flags</strong> позволяет произвольно компоновать информацию об
               отдельных группах разработчиков.
               
               Предопределённые флаги <strong>phpcredits()</strong>ИмяОписаниеCREDITS_ALL Все разработчики,
               эквивалентно использованию: <info>CREDITS_DOCS</info> + <info>CREDITS_GENERAL</info> + <info>CREDITS_GROUP</info> +
               <info>CREDITS_MODULES</info> + <info>CREDITS_FULLPAGE</info>. В этом случае будет сгенерирована полностью
               независимая HTML-страница с соответствующими тэгами. CREDITS_DOCSУчастники команды
               документированияCREDITS_FULLPAGE Обычно используется в комбинации с другими флагами.
               Указывает на то, что независимая HTML страница должна содержать информацию других
               флагов. CREDITS_GENERAL Главные разработчики: Концепция и дизайн языка, авторы PHP и
               модуля SAPI. CREDITS_GROUPСписок разработчиков ядра языкаCREDITS_MODULES Список
               модулей для PHP и их авторов CREDITS_SAPI Список модулей серверных API и их авторов

<comment>Return:</comment>
  <info>true</info>  Функция всегда возвращает <info>true</info>.

<comment>See Also:</comment>
   * <strong>phpversion()</strong>
   * <strong>phpinfo()</strong>


id: phpdbg_break_file
type: function
doc:
<comment>Description:</comment>
  Добавить точку прерывания на конкретную строку файла
  
  Добавляет точку прерывания на строку <strong>$line</strong> файла <strong>$file</strong>.

<comment>Param:</comment>
  <info>string</info>  <strong>$file</strong>  Имя файла.
  <info>int</info>     <strong>$line</strong>  Номер строки.

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

<comment>See Also:</comment>
   * <strong>phpdbg_break_function()</strong>
   * <strong>phpdbg_break_method()</strong>
   * <strong>phpdbg_break_next()</strong>
   * <strong>phpdbg_clear()</strong>


id: phpdbg_break_function
type: function
doc:
<comment>Description:</comment>
  Добавить точку прерывания на вызов функции
  
  Добавляет точку прерывания на вызов функции <strong>$function</strong>.

<comment>Param:</comment>
  <info>string</info>  <strong>$function</strong>  Имя функции.

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

<comment>See Also:</comment>
   * <strong>phpdbg_break_file()</strong>
   * <strong>phpdbg_break_method()</strong>
   * <strong>phpdbg_break_next()</strong>
   * <strong>phpdbg_clear()</strong>


id: phpdbg_break_method
type: function
doc:
<comment>Description:</comment>
  Добавить точку прерывания на вызов метода класса
  
  Добавляет точку прерывания на вызов метода <strong>$method</strong> класса <strong>$class</strong>.

<comment>Param:</comment>
  <info>string</info>  <strong>$class</strong>   Имя класса.
  <info>string</info>  <strong>$method</strong>  Имя метода.

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

<comment>See Also:</comment>
   * <strong>phpdbg_break_file()</strong>
   * <strong>phpdbg_break_function()</strong>
   * <strong>phpdbg_break_next()</strong>
   * <strong>phpdbg_clear()</strong>


id: phpdbg_break_next
type: function
doc:
<comment>Description:</comment>
  Добавить точку прерывания на следующий опкод
  
  Добавляет точку прерывания на следующий опкод.

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

<comment>See Also:</comment>
   * <strong>phpdbg_break_file()</strong>
   * <strong>phpdbg_break_function()</strong>
   * <strong>phpdbg_break_method()</strong>
   * <strong>phpdbg_clear()</strong>


id: phpdbg_clear
type: function
doc:
<comment>Description:</comment>
  Убрать все точки прерывания
  
  Удаляет все заданные ранее точки прерывания. Работает как для заданных с помощью функций
  <strong>phpdbg_break_*()</strong>, так и для добавленных вручную через консоль.
  
  К настоящему времени эта функция ещё не была документирована; для ознакомления доступен только
  список аргументов.

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

<comment>See Also:</comment>
   * <strong>phpdbg_break_file()</strong>
   * <strong>phpdbg_break_function()</strong>
   * <strong>phpdbg_break_method()</strong>
   * <strong>phpdbg_break_next()</strong>


id: phpdbg_color
type: function
doc:
<comment>Description:</comment>
  Задать цвет для элемента
  
  Устанавливает цвет <strong>$color</strong> для элемента <strong>$element</strong>.

<comment>Param:</comment>
  <info>int</info>     <strong>$element</strong>  Одна из констант <info>PHPDBG_COLOR_*</info>.
  <info>string</info>  <strong>$color</strong>    Имя цвета. Одно из: <return>white</return>, <return>red</return>, <return>green</return>, <return>yellow</return>, <return>blue</return>, <return>purple</return>, <return>cyan</return> или <return>black</return>.
                    Опционально можно использовать суффиксы <return>-bold</return> или <return>-underline</return>. К примеру
                    <return>white-bold</return> или <return>green-underline</return>.

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

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


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

<comment>Param:</comment>
  <info>array</info>  <strong>$options</strong>  

<comment>Return:</comment>
  <info>array|null</info>  


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

<comment>Param:</comment>
  <info>string</info>  <strong>$context</strong>  

<comment>Return:</comment>
  <info>string|bool</info>  Предыдущий контекст исполнения, если он был задан. <info>true</info>, если контекст исполнения
               ранее не был задан. Если запрос на установку контекста завершится с ошибкой, то будет
               возвращено <info>false</info> и вызвана ошибка уровня <info>E_WARNING</info>.


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

<comment>Param:</comment>
  <info>array</info>  <strong>$options</strong>  

<comment>Return:</comment>
  <info>array</info>  


id: phpdbg_prompt
type: function
doc:
<comment>Description:</comment>
  Установить приглашение командной строки
  
  Устанавливает приглашение командной строки как задано в <strong>$string</strong>.

<comment>Param:</comment>
  <info>string</info>  <strong>$string</strong>  Строка, которая будет использована как приглашение.

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

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


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

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


id: phpinfo
type: function
doc:
<comment>Description:</comment>
  Выводит информацию о текущей конфигурации PHP
    
  
  Выводит большое количество информации о текущем состоянии PHP. Сюда входит информация о настройках
  компиляции PHP, о модулях, о версии, информация о сервере и среде выполнения (если PHP
  компилировался как модуль), окружении PHP, версии ОС, о путях, об основных и локальных значениях
  настроек конфигурации, о HTTP-заголовках и лицензии PHP.
  
  Так как каждая система имеет свои особенности, <strong>phpinfo()</strong> используется в основном для проверки
  настроек конфигурации и для просмотра доступных предопределённых констант в данной системе.
  
  <strong>phpinfo()</strong> также используется в целях отладки, так как содержит все данные EGPCS (Environment, GET,
  POST, Cookie, Server).

<comment>Param:</comment>
  <info>int</info>  <strong>$flags</strong>  Вывод функции можно настраивать, передавая битовую маску из одной или более
               приведённых ниже констант (constants). Эта маска передаётся в качестве
               необязательного аргумента <strong>$flags</strong>. Отдельные константы или битовые значения можно
               комбинировать с помощью побитового оператора ИЛИ.
               
               Настройки <strong>phpinfo()</strong>Имя (константа)ЗначениеОписаниеINFO_GENERAL1 Строка конфигурации,
               расположение php.ini, дата сборки, сервер, система и др. INFO_CREDITS2 Разработчики
               PHP. Смотрите также <strong>phpcredits()</strong>. INFO_CONFIGURATION4 Текущие значение основных и
               локальных PHP директив. Смотрите также <strong>ini_get()</strong>. INFO_MODULES8 Загруженные модули и
               их настройки. Смотрите также <strong>get_loaded_extensions()</strong>. INFO_ENVIRONMENT16 Информация о
               переменных окружения, которая также доступна в $_ENV. INFO_VARIABLES32 Выводит все
               предопределённые переменные из EGPCS (Environment, GET, POST, Cookie, Server).
               INFO_LICENSE64 Информация о лицензии PHP. Смотрите также license FAQ. INFO_ALL-1
               Выводит все приведённое выше.

<comment>Return:</comment>
  <info>true</info>  Функция всегда возвращает <info>true</info>.

<comment>See Also:</comment>
   * <strong>phpversion()</strong>
   * <strong>phpcredits()</strong>
   * <strong>ini_get()</strong>
   * <strong>ini_set()</strong>
   * <strong>get_loaded_extensions()</strong>
   * Предопределённые переменные


id: phpversion
type: function
doc:
<comment>Description:</comment>
  Получает текущую версию PHP
  
  Возвращает строку с номером версии текущего PHP-интерпретатора или модуля.

<comment>Param:</comment>
  <info>string|null</info>  <strong>$extension</strong>  Необязательное имя модуля.

<comment>Return:</comment>
  <info>string|false</info>  Возвращает текущую версию PHP в виде строки (<info>string</info>). Если в параметре <strong>$extension</strong>
                указано строковое значение (<info>string</info>), <strong>phpversion()</strong> вернёт версию этого модуля или
                <info>false</info>, если информации о версии нет или модуль в данный момент не включён.

<comment>See Also:</comment>
   * Константы PHP_VERSION
   * <strong>version_compare()</strong>
   * <strong>phpinfo()</strong>
   * <strong>phpcredits()</strong>
   * <strong>zend_version()</strong>


id: pi
type: function
doc:
<comment>Description:</comment>
  Возвращает число Пи
  
  Возвращает приближённое значение числа Пи. Константа <info>M_PI</info> даёт идентичный результат.

<comment>Return:</comment>
  <info>float</info>  Приближенное значение числа Пи в виде числа с плавающей точкой (<info>float</info>).


id: png2wbmp
type: function
doc:
<comment>Description:</comment>
  Преобразование PNG файла в WBMP
    
  
  Преобразует PNG файл в WBMP.

<comment>Param:</comment>
  <info>string</info>  <strong>$pngname</strong>      Путь к PNG файлу.
  <info>string</info>  <strong>$wbmpname</strong>     Путь к результирующему WBMP файлу.
  <info>int</info>     <strong>$dest_height</strong>  Высота результирующего изображения.
  <info>int</info>     <strong>$dest_width</strong>   Ширина результирующего изображения.
  <info>int</info>     <strong>$threshold</strong>    Ограничение, от 0 до 8 (включительно).

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

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


id: popen
type: function
doc:
<comment>Description:</comment>
  Открывает файловый указатель процесса
  
  Открывает поток к процессу, выполняемый при помощи форка команды, заданной в параметре <strong>$command</strong>.

<comment>Param:</comment>
  <info>string</info>  <strong>$command</strong>  Команда
  <info>string</info>  <strong>$mode</strong>     Режим. Либо <return>'r'</return> для чтения, либо <return>'w'</return> для записи.
                    
                    В Windows для <strong>popen()</strong> по умолчанию используется текстовый режим, т.е. любые
                    символы <return>\n</return>, записанные в канал или прочитанные из него, будут преобразованы в
                    <return>\r\n</return>. Если это нежелательно, можно принудительно использовать двоичный режим,
                    установив для <strong>$mode</strong> значение <return>'rb'</return> и <return>'wb'</return> соответственно.

<comment>Return:</comment>
  <info>resource|false</info>  Возвращает файловый указатель, идентичный возвращаемому функцией <strong>fopen()</strong>, за
                  исключением того, что он односторонний (может быть использован только для чтения
                  или записи) и должен быть закрыт при помощи <strong>pclose()</strong>. Этот указатель может быть
                  использован с <strong>fgets()</strong>, <strong>fgetss()</strong> и <strong>fwrite()</strong>. Если в качестве режима указано 'r',
                  файловый указатель аналогичен потоку вывода (STDOUT) команды, если же указано 'w',
                  то файловый указатель аналогичен потоку ввода (STDIN) команды.
                  
                  В случае возникновения ошибки возвращает <info>false</info>.

<comment>See Also:</comment>
   * <strong>pclose()</strong>
   * <strong>fopen()</strong>
   * <strong>proc_open()</strong>


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


id: posix_access
type: function
doc:
<comment>Description:</comment>
  Определяет доступность файла
    
  
  Функция <strong>posix_access()</strong> проверяет права пользователя на доступ к файлу.

<comment>Param:</comment>
  <info>string</info>  <strong>$filename</strong>  Путь к проверяемому файлу.
  <info>int</info>     <strong>$flags</strong>     Маска, состоящая из одной или более констант: <info>POSIX_F_OK</info>, <info>POSIX_R_OK</info>,
                     <info>POSIX_W_OK</info> или <info>POSIX_X_OK</info>.
                     
                     <info>POSIX_R_OK</info>, <info>POSIX_W_OK</info> и <info>POSIX_X_OK</info> проверяют существование и доступность файла
                     на чтение, запись и выполнение. <info>POSIX_F_OK</info> проверяет только существование
                     файла.

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

<comment>See Also:</comment>
   * <strong>posix_get_last_error()</strong>
   * <strong>posix_strerror()</strong>


id: posix_ctermid
type: function
doc:
<comment>Description:</comment>
  Возвращает путь управляющего терминала
  
  Возвращает переменную типа <info>string</info>, содержащую путь до текущего управляющего терминала данного
  процесса. В случае возникновения ошибки будет установлен её номер, который может быть обработан с
  использованием <strong>posix_get_last_error()</strong>

<comment>Return:</comment>
  <info>string|false</info>  В случае успешного выполнения возвращает <info>string</info> с путём до текущего управляющего
                терминала. В противном случае возвращает <info>false</info> и устанавливает номер ошибки, который
                может быть обработан с помощью <strong>posix_get_last_error()</strong>.

<comment>See Also:</comment>
   * <strong>posix_ttyname()</strong>
   * <strong>posix_get_last_error()</strong>


id: posix_eaccess
type: function
doc:
<comment>Description:</comment>
  Determine accessibility of a file
    
  
  <strong>posix_eaccess()</strong> checks the effective user's permission of a file

<comment>Param:</comment>
  <info>string</info>  <strong>$filename</strong>  The name of a file to be tested.
  <info>int</info>     <strong>$flags</strong>     A mask consisting of one or more of <info>POSIX_F_OK</info>, <info>POSIX_R_OK</info>, <info>POSIX_W_OK</info> and
                     <info>POSIX_X_OK</info>.
                     
                     <info>POSIX_R_OK</info>, <info>POSIX_W_OK</info> and <info>POSIX_X_OK</info> request checking whether the file exists
                     and has read, write and execute permissions, respectively. <info>POSIX_F_OK</info> just
                     requests checking for the existence of the file.

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

<comment>See Also:</comment>
   * <strong>posix_get_last_error()</strong>
   * <strong>posix_strerror()</strong>
   * <strong>posix_access()</strong>


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


id: posix_fpathconf
type: function
doc:
<comment>Description:</comment>
  Returns the value of a configurable limit
  
  Returns the value of a configurable limit from <strong>$name</strong> for a file descriptor <strong>$resource</strong>

<comment>Param:</comment>
  <info>resource|int</info>  <strong>$file_descriptor</strong>  Файловый дескриптор, который ожидается в виде или ресурса <info>resource</info>
                                  или целого числа <info>int</info>. Под <info>int</info> подразумевается файловый дескриптор,
                                  который можно передать непосредственно в базовый системный вызов.
  <info>int</info>           <strong>$name</strong>             The name of the configurable limit, one of the following.
                                  <info>POSIX_PC_LINK_MAX</info>, <info>POSIX_PC_MAX_CANON</info> <info>POSIX_PC_MAX_INPUT</info>,
                                  <info>POSIX_PC_NAME_MAX</info> <info>POSIX_PC_PATH_MAX</info>, <info>POSIX_PC_PIPE_BUF</info>
                                  <info>POSIX_PC_CHOWN_RESTRICTED</info>, <info>POSIX_PC_NO_TRUNC</info>
                                  <info>POSIX_PC_ALLOC_SIZE_MIN</info>, <info>POSIX_PC_SYMLINK_MAX</info>

<comment>Return:</comment>
  <info>int|false</info>  Returns the configurable limit or <info>false</info>.

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


id: posix_get_last_error
type: function
doc:
<comment>Description:</comment>
  Возвращает номер ошибки, которая произошла в последней posix функции, завершившейся неудачей
  
  Возвращает номер ошибки, произошедшей в последней posix функции, завершившейся неудачей. Системное
  сообщение об ошибке, соответствующее её номеру, может быть получено с помощью <strong>posix_strerror()</strong>.

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

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


id: posix_getcwd
type: function
doc:
<comment>Description:</comment>
  Возвращает путь текущей директории
  
  Возвращает абсолютный путь рабочей директории выполняемого скрипта. В случае возникновения ошибки
  будет установлен её номер, который может быть обработан с помощью <strong>posix_get_last_error()</strong>

<comment>Return:</comment>
  <info>string|false</info>  Возвращает <info>string</info> с абсолютным путём в случае успешного выполнения. В случае
                возникновения ошибки будет возвращено <info>false</info>, также будет установлен номер ошибки,
                который может быть обработан с помощью <strong>posix_get_last_error()</strong>.


id: posix_getegid
type: function
doc:
<comment>Description:</comment>
  Возвращает эффективный идентификатор группы текущего процесса EGID
  
  Возвращает эффективной идентификатор группы текущего процесса.

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

<comment>See Also:</comment>
   * <strong>posix_getgrgid()</strong>
   * <strong>posix_getgid()</strong>
   * <strong>posix_setgid()</strong>


id: posix_geteuid
type: function
doc:
<comment>Description:</comment>
  Возвращает эффективный идентификатор пользователя текущего процесса EUID
  
  Возвращает число, соответствующее эффективному идентификатору пользователя текущего процесса.
  Посмотрите функцию <strong>posix_getpwuid()</strong> для получения информации как преобразовать данное число в имя
  пользователя.

<comment>Return:</comment>
  <info>int</info>  Возвращает ID пользователя как <info>int</info>

<comment>See Also:</comment>
   * <strong>posix_getpwuid()</strong>
   * <strong>posix_getuid()</strong>
   * <strong>posix_setuid()</strong>
   * POSIX руководство GETEUID(2)


id: posix_getgid
type: function
doc:
<comment>Description:</comment>
  Возвращает действительный ID группы текущего процесса GID
  
  Возвращает число, соответствующее действительному ID группы текущего процесса.

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

<comment>See Also:</comment>
   * <strong>posix_getgrgid()</strong>
   * <strong>posix_getegid()</strong>
   * <strong>posix_setgid()</strong>
   * POSIX руководство GETGID(2)


id: posix_getgrgid
type: function
doc:
<comment>Description:</comment>
  Возвращает информацию о группе по её ID
  
  Возвращает информацию о группе, используя её ID.

<comment>Param:</comment>
  <info>int</info>  <strong>$group_id</strong>  Идентификатор группы.

<comment>Return:</comment>
  <info>array|false</info>  Массив со следующими элементами: Массив с информацией о группеЭлементОписаниеname
               Элемент name содержит имя группы. Это короткий, обычно менее 16 символов "дескриптор"
               группы, не являющийся полным именем группы. passwd Элемент passwd содержит пароль
               группы в зашифрованном виде. Часто, например в системах, использующих "shadow" файлы
               для хранения информации о паролях, это поле содержит строку из звёздочек. gid Элемент
               содержит ID группы и должен соответствовать <strong>$group_id</strong> параметру, используемому при
               вызове функции. Данный элемент является избыточным. members Этот элемент состоит из
               <info>array</info>, содержащего <info>string</info>. Значениями данного массива являются имена членов данной
               группы.  Функция возвращает <info>false</info> в случае возникновения ошибки.

<comment>See Also:</comment>
   * <strong>posix_getegid()</strong>
   * <strong>posix_getgrnam()</strong>
   * <strong>filegroup()</strong>
   * <strong>stat()</strong>
   * POSIX руководство GETGRNAM(3)


id: posix_getgrnam
type: function
doc:
<comment>Description:</comment>
  Возвращает информацию о группе, используя её имя
  
  Возвращает информацию о группе, используя её имя.

<comment>Param:</comment>
  <info>string</info>  <strong>$name</strong>  Имя группы

<comment>Return:</comment>
  <info>array|false</info>  Возвращает массив (<info>array</info>) в случае успешного выполнения или <info>false</info> в случае
               возникновения ошибки. Возвращаемый массив имеет следующие элементы: Массив с
               информацией о группеЭлементОписаниеname Элемент name содержит имя группы. Это
               короткий, обычно менее 16 символов "дескриптор" группы, не являющийся действительным
               полным именем группы. Он должен соответствовать <strong>$name</strong> параметру, используемому в
               данной функции. Элемент является избыточным. passwd Элемент passwd содержит пароль
               группы в зашифрованном виде. Часто, например в системах, использующих "shadow" файлы
               для хранения информации о паролях, это поле содержит звёздочку. gid Идентификатор
               группы, состоящий из цифр. members Этот элемент состоит из <info>array</info>, содержащего <info>string</info>.
               Значениями данного массива являются имена членов данной группы.

<comment>See Also:</comment>
   * <strong>posix_getegid()</strong>
   * <strong>posix_getgrgid()</strong>
   * <strong>filegroup()</strong>
   * <strong>stat()</strong>
   * POSIX руководство GETGRNAM(3)


id: posix_getgroups
type: function
doc:
<comment>Description:</comment>
  Возвращает список групп для текущего процесса
  
  Возвращает список групп для текущего процесса.

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

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


id: posix_getlogin
type: function
doc:
<comment>Description:</comment>
  Возвращает логин владельца процесса
  
  Возвращает логин пользователя, являющегося владельцем данного процесса.

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

<comment>See Also:</comment>
   * <strong>posix_getpwnam()</strong>
   * POSIX руководство GETLOGIN(3)


id: posix_getpgid
type: function
doc:
<comment>Description:</comment>
  Возвращает ID группы текущего процесса для менеджера задач
  
  Возвращает идентификатор группы текущего процесса. <strong>$process_id</strong> или <info>false</info> в случае возникновения
  ошибки.

<comment>Param:</comment>
  <info>int</info>  <strong>$process_id</strong>  Идентификатор текущего процесса.

<comment>Return:</comment>
  <info>int|false</info>  Возвращает идентификатор как число типа <info>int</info>.

<comment>See Also:</comment>
   * <strong>posix_getppid()</strong>
   * руководство SETPGID(2)


id: posix_getpgrp
type: function
doc:
<comment>Description:</comment>
  Возвращает идентификатор группы текущего процесса
  
  Возвращает идентификатор группы текущего процесса.

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

<comment>See Also:</comment>
   * POSIX.1 и getpgrp(2) руководства для POSIX систем для получения
     более подробной информации о группах процессов.


id: posix_getpid
type: function
doc:
<comment>Description:</comment>
  Возвращает идентификатор текущего процесса
  
  Возвращает идентификатор текущего процесса.

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

<comment>See Also:</comment>
   * <strong>posix_kill()</strong>
   * POSIX руководство GETPID(2)


id: posix_getppid
type: function
doc:
<comment>Description:</comment>
  Возвращает идентификатор родительского процесса
  
  Возвращает идентификатор родительского процесса по отношению к текущему процессу.

<comment>Return:</comment>
  <info>int</info>  Возвращает идентификатор процесса как <info>int</info>.


id: posix_getpwnam
type: function
doc:
<comment>Description:</comment>
  Возвращает информацию о пользователе по его имени
  
  Возвращает массив (<info>array</info>) с информацией о переданном пользователе.

<comment>Param:</comment>
  <info>string</info>  <strong>$username</strong>  Буквенно-цифровое имя пользователя.

<comment>Return:</comment>
  <info>array|false</info>  В случае успешного выполнения возвращается массив со следующими элементами, иначе
               возвращается <info>false</info>. Массив с информацией о пользователеЭлементОписаниеname Элемент
               name содержит имя пользователя. Это короткий, обычно менее 16 символов "дескриптор"
               пользователя, не являющийся фактическим полным именем пользователя. Должно совпадать
               с именем, переданным в параметре <strong>$username</strong> при вызове данной функции. Элемент
               является избыточным. passwd Элемент passwd содержит пароль группы в зашифрованном
               виде. Часто, например в системах, использующих "shadow" файлы для хранения информации
               о паролях, это поле содержит звёздочку. uid Числовой идентификатор пользователя. gid
               Идентификатор группы пользователя. Используйте функцию <strong>posix_getgrgid()</strong> для получения
               имени группы и списка пользователей- её членов. gecos GECOS является устаревшим
               членом, который указывает на информационное поле в системе пакетной обработки
               Honeywell. Однако, это поле существует, и его содержимое формализовано в стандарте
               POSIX. Это поле содержит список, разделённый запятыми, и содержащий в себе полное имя
               пользователя, рабочий телефон, номер офиса и домашний телефон. В большинстве систем
               доступно только полное имя пользователя. dir Этот элемент содержит абсолютный путь к
               домашней директории пользователя. shell Элемент shell содержит абсолютный путь к
               исполняемому файлу командной оболочки пользователя по умолчанию.

<comment>See Also:</comment>
   * <strong>posix_getpwuid()</strong>
   * POSIX руководство GETPWNAM(3)


id: posix_getpwuid
type: function
doc:
<comment>Description:</comment>
  Возвращает информацию о пользователе, используя его ID
  
  Возвращает <info>array</info> с информацией о пользователе, используя идентификатор пользователя.

<comment>Param:</comment>
  <info>int</info>  <strong>$user_id</strong>  Идентификатор пользователя.

<comment>Return:</comment>
  <info>array|false</info>  Возвращает ассоциативный массив со следующими элементами: Массив с информацией о
               пользователеЭлементОписаниеname Элемент name содержит имя пользователя. Это короткий,
               обычно менее 16 символов "дескриптор" пользователя, не являющийся фактическим полным
               именем пользователя. passwd Элемент passwd содержит пароль группы в зашифрованном
               виде. Часто, например в системах, использующих "shadow" файлы для хранения информации
               о паролях, это поле содержит звёздочку. uid Числовой идентификатор пользователя,
               должен совпадать с параметром <strong>$user_id</strong>, переданном при вызове функции. Является
               избыточным. gid Идентификатор группы пользователя. Используйте функцию
               <strong>posix_getgrgid()</strong> для получения имени группы и списка пользователей- её членов. gecos
               GECOS является устаревшим членом, который указывает на информационное поле в системе
               пакетной обработки Honeywell. Однако, это поле существует, и его содержимое было
               формализовано в стандарте POSIX. Это поле содержит список, разделённый запятыми, и
               содержащий в себе полное имя пользователя, рабочий телефон, номер офиса и домашний
               телефон. В большинстве систем доступно только полное имя пользователя. dir Этот
               элемент содержит абсолютный путь к домашней директории пользователя. shell Элемент
               shell содержит абсолютный путь к исполняемому файлу командной оболочки пользователя
               по умолчанию.  Функция возвращает <info>false</info> в случае возникновения ошибки.

<comment>See Also:</comment>
   * <strong>posix_getpwnam()</strong>
   * POSIX руководство GETPWNAM(3)


id: posix_getrlimit
type: function
doc:
<comment>Description:</comment>
  Возвращает информацию об ограничениях системных ресурсов
  
  <strong>posix_getrlimit()</strong> возвращает <info>array</info> с информацией о текущих мягких и жёстких ограничениях системных
  ресурсов.
  
  С каждым ресурсом ассоциированы свои мягкие и жёсткие ограничения. Мягкие ограничения — это
  величина, которую ядро обещает обеспечить ресурсу. Жёсткие ограничения — это величина,
  характеризующая потолок мягких ресурсов. Непривилегированный процесс может управлять только своими
  мягкими ограничениями, выставляя их от 0 до величины жёсткого ограничения.

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

<comment>Return:</comment>
  <info>array|false</info>  Возвращает ассоциативный <info>array</info>, каждый элемент которого соответствует определённому
               ограничению. Каждый лимит имеет мягкое и жёсткое ограничения. Список возможных
               ограниченийОграничениеОписание ограниченияcore Максимальный размер системного файла.
               В случае некорректного завершения программы, операционная система завершает этот
               процесс и создаёт системный файл с дампом состояния программы, чтобы программисты
               могли разобраться в причинах произошедшего. Если данное ограничение установлено в 0,
               то системные файлы не создаются. Если размер системного файла превышает этот предел,
               то он обрезается до указанного размера. totalmem Максимальный размер памяти,
               доступной процессу, в байтах. virtualmem Максимальный размер виртуальной памяти,
               доступной процессу, в байтах. data Максимальный размер сегмента данных для процесса,
               в байтах. stack Максимальный размер стека процесса в байтах. rss Максимальное
               количество виртуальных страниц в оперативной памяти maxproc Максимальное количество
               процессов, которое может быть создано для отдельного действительного ID пользователя,
               вызвавшего процесс. memlock Максимальный объем памяти в байтах, который может быть
               заблокирован в RAM cpu Количество процессорного времени, доступного для использования
               в CPU. filesize Максимальный размер сегмента данных для процесса, в байтах. openfiles
               На один больше, чем доступное максимальное количество открытых файловых дескрипторов.
               Функция возвращает <info>false</info> в случае возникновения ошибки.

<comment>See Also:</comment>
   * руководство GETRLIMIT(2)
   * <strong>posix_setrlimit()</strong>


id: posix_getsid
type: function
doc:
<comment>Description:</comment>
  Возвращает текущий SID процесса
  
  Возвращает идентификатор сессии процесса <strong>$process_id</strong>. Сессионным идентификатором процесса является
  идентификатор процесса лидера сеанса.

<comment>Param:</comment>
  <info>int</info>  <strong>$process_id</strong>  Идентификатор процесса. Если установлено в 0, подразумевается текущий процесс.
                    Если передан некорректный <strong>$process_id</strong>, то будет возвращено <info>false</info>. Также будет
                    установлен номер ошибки, который можно обработать с помощью функции
                    <strong>posix_get_last_error()</strong>.

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

<comment>See Also:</comment>
   * <strong>posix_getpgid()</strong>
   * <strong>posix_setsid()</strong>
   * POSIX руководство GETSID(2)


id: posix_getuid
type: function
doc:
<comment>Description:</comment>
  Возвращает фактический идентификатор пользователя текущего процесса UID
  
  Возвращает число, соответствующее действительному ID пользователю текущего процесса.

<comment>Return:</comment>
  <info>int</info>  Возвращает ID пользователя как <info>int</info>

<comment>See Also:</comment>
   * <strong>posix_getpwuid()</strong>
   * POSIX руководство GETUID(2)


id: posix_initgroups
type: function
doc:
<comment>Description:</comment>
  Определяет уровень доступа для группы
  
  Определяет уровень доступа группы для пользователя, указанного в параметрах.

<comment>Param:</comment>
  <info>string</info>  <strong>$username</strong>  Имя пользователя, для которого определяется уровень доступа.
  <info>int</info>     <strong>$group_id</strong>  Идентификатор базовой группы из файла password.

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

<comment>See Also:</comment>
   * Руководство Unix initgroups(3).


id: posix_isatty
type: function
doc:
<comment>Description:</comment>
  Определяет является ли файловый дескриптор интерактивным терминалом
  
  Определяет является ли файловый дескриптор <strong>$file_descriptor</strong> ссылкой на валидный терминал.

<comment>Param:</comment>
  <info>resource|int</info>  <strong>$file_descriptor</strong>  Файловый дескриптор, который ожидается в виде или ресурса <info>resource</info>
                                  или целого числа <info>int</info>. Под <info>int</info> подразумевается файловый дескриптор,
                                  который можно передать непосредственно в базовый системный вызов.

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

<comment>See Also:</comment>
   * <strong>posix_ttyname()</strong>
   * <strong>stream_isatty()</strong>


id: posix_kill
type: function
doc:
<comment>Description:</comment>
  Отправляет сигнал соответствующему процессу
  
  Отправляет сигнал <strong>$signal</strong> процессу с идентификатором <strong>$process_id</strong>.

<comment>Param:</comment>
  <info>int</info>  <strong>$process_id</strong>  Идентификатор процесса.
  <info>int</info>  <strong>$signal</strong>      Одна из PCNTL констант сигналов.

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

<comment>See Also:</comment>
   * 
     kill(2) руководство для POSIX систем, которые содержат дополнительную информацию
     об отрицательных идентификаторах процессов, специальном идентификаторе 0, специальном
     идентификаторе -1, и сигнале с идентификатором 0.
    


id: posix_mkfifo
type: function
doc:
<comment>Description:</comment>
  Создаёт специальный fifo файл (именованный канал- pipe)
  
  <strong>posix_mkfifo()</strong> создаёт специальный <return>FIFO</return> файл, который существует в файловой системе и выступает в
  качестве двунаправленной связи для процессов.

<comment>Param:</comment>
  <info>string</info>  <strong>$filename</strong>     Путь к <return>FIFO</return> файлу.
  <info>int</info>     <strong>$permissions</strong>  Второй параметр <strong>$permissions</strong> должен быть представлен в восьмеричной нотации
                        (например 0644). Это уровень прав для вновь созданного <return>FIFO</return> файла, также
                        зависит от настроек текущего <strong>umask()</strong>. Права на созданный файл будут
                        определяться как результат (mode & ~umask).

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


id: posix_mknod
type: function
doc:
<comment>Description:</comment>
  Создаёт специальный или обычный файл (POSIX.1)
    
  
  Создаёт специальный или обычный файл.

<comment>Param:</comment>
  <info>string</info>  <strong>$filename</strong>  Путь и имя создаваемого файла
  <info>int</info>     <strong>$flags</strong>     Данный параметр получается с помощью побитового ИЛИ между типом файла (одной из
                     следующих констант: <info>POSIX_S_IFREG</info>, <info>POSIX_S_IFCHR</info>, <info>POSIX_S_IFBLK</info>, <info>POSIX_S_IFIFO</info>
                     или <info>POSIX_S_IFSOCK</info>) и правами доступа.
  <info>int</info>     <strong>$major</strong>     Старший номер устройства (обязательный параметр при использовании констант
                     <info>S_IFCHR</info> или <info>S_IFBLK</info>).
  <info>int</info>     <strong>$minor</strong>     Младший номер устройства.

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

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


id: posix_pathconf
type: function
doc:
<comment>Description:</comment>
  Returns the value of a configurable limit
  
  К настоящему времени эта функция ещё не была документирована; для ознакомления доступен только
  список аргументов.
  
  Returns the value of a configurable limit from <strong>$name</strong> for a <strong>$file</strong>

<comment>Param:</comment>
  <info>string</info>  <strong>$path</strong>  The name of the file whose limit you want to get.
  <info>int</info>     <strong>$name</strong>  The name of the configurable limit, one of the following. <info>POSIX_PC_LINK_MAX</info>,
                 <info>POSIX_PC_MAX_CANON</info> <info>POSIX_PC_MAX_INPUT</info>, <info>POSIX_PC_NAME_MAX</info> <info>POSIX_PC_PATH_MAX</info>,
                 <info>POSIX_PC_PIPE_BUF</info> <info>POSIX_PC_CHOWN_RESTRICTED</info>, <info>POSIX_PC_NO_TRUNC</info>
                 <info>POSIX_PC_ALLOC_SIZE_MIN</info>, <info>POSIX_PC_SYMLINK_MAX</info>

<comment>Return:</comment>
  <info>int|false</info>  Returns the configurable limit or <info>false</info>.

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


id: posix_setegid
type: function
doc:
<comment>Description:</comment>
  Устанавливает эффективный идентификатор группы для текущего процесса EGID
  
  Устанавливает эффективный идентификатор группы для текущего процесса. Это привилегированная
  функция и требует соответствующих прав (как правило прав суперпользователя root) в системе, чтобы
  иметь возможность выполнять её.

<comment>Param:</comment>
  <info>int</info>  <strong>$group_id</strong>  Устанавливаемый эффективный идентификатор группы для текущего процесса

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

<comment>See Also:</comment>
   * <strong>posix_getgrgid()</strong>
   * <strong>posix_getgid()</strong>
   * <strong>posix_setgid()</strong>


id: posix_seteuid
type: function
doc:
<comment>Description:</comment>
  Устанавливает эффективный идентификатор пользователя для текущего процесса EUID
  
  Устанавливает эффективный идентификатор пользователя. Это привилегированная функция и требует
  соответствующих прав (как правило прав суперпользователя root) чтобы иметь возможность выполнить
  её.

<comment>Param:</comment>
  <info>int</info>  <strong>$user_id</strong>  Устанавливаемый идентификатор пользователя.

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

<comment>See Also:</comment>
   * <strong>posix_geteuid()</strong>
   * <strong>posix_setuid()</strong>
   * <strong>posix_getuid()</strong>


id: posix_setgid
type: function
doc:
<comment>Description:</comment>
  Устанавливает идентификатор группы для текущего процесса GID
  
  Устанавливает фактический идентификатор группы текущего процесса. Это привилегированная функция и
  требует соответствующих прав (обычно прав суперпользователя root) в системе, чтобы иметь
  возможность выполнить её. Правильным является следующий порядок вызова функций: сначала
  <strong>posix_setgid()</strong>, затем <strong>posix_setuid()</strong>.
  
  Если функция будет вызвана суперпользователем, то также будет установлен и эффективный
  идентификатор группы пользователя.

<comment>Param:</comment>
  <info>int</info>  <strong>$group_id</strong>  Идентификатор группы.

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

<comment>See Also:</comment>
   * <strong>posix_getgrgid()</strong>
   * <strong>posix_getgid()</strong>


id: posix_setpgid
type: function
doc:
<comment>Description:</comment>
  Устанавливает идентификатор группы процесса для менеджера задач
  
  Добавляет к процессу <strong>$process_id</strong> идентификатор группы <strong>$process_group_id</strong>.

<comment>Param:</comment>
  <info>int</info>  <strong>$process_id</strong>        Идентификатор процесса.
  <info>int</info>  <strong>$process_group_id</strong>  Идентификатор группы процесса.

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

<comment>See Also:</comment>
   * 
     Для получения более полной информации о процессах и управлении заданиями
     обратитесь к POSIX.1 и setsid(2) руководству в POSIX системах.
    


id: posix_setrlimit
type: function
doc:
<comment>Description:</comment>
  Устанавливает пределы системных ресурсов
  
  <strong>posix_setrlimit()</strong> устанавливает жёсткие и мягкие пределы заданных системных ресурсов.
  
  С каждым ресурсом ассоциированы свои мягкие и жёсткие ограничения. Мягкие ограничения — это
  величина, которую ядро обещает обеспечить ресурсу. Жёсткие ограничения — это величина,
  характеризующая потолок мягких ресурсов. Непривилегированный процесс может управлять только своими
  мягкими ограничениями, выставляя их от 0 до величины жёсткого ограничения.

<comment>Param:</comment>
  <info>int</info>  <strong>$resource</strong>    Константа предела ресурса отвечающая за предел, который должен быть установлен.
  <info>int</info>  <strong>$soft_limit</strong>  Мягкий предел, любой требуемый предел, или <info>POSIX_RLIMIT_INFINITY</info>.
  <info>int</info>  <strong>$hard_limit</strong>  Жёсткий предел, любой требуемый предел, или <info>POSIX_RLIMIT_INFINITY</info>.

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

<comment>See Also:</comment>
   * man page SETRLIMIT(2)
   * <strong>posix_getrlimit()</strong>


id: posix_setsid
type: function
doc:
<comment>Description:</comment>
  Делает текущий процесс лидером сессии
  
  Делает текущий процесс лидером сессии.

<comment>Return:</comment>
  <info>int</info>  Возвращает идентификатор сессии или -1 в случае возникновения ошибки.

<comment>See Also:</comment>
   * 
     Стандарт POSIX.1 руководство по setsid(2) в POSIX совместимых системах для
     получения более полной информации о группах процессов и управлении заданиями.
    


id: posix_setuid
type: function
doc:
<comment>Description:</comment>
  Устанавливает UID текущего процесса
  
  Устанавливает фактический идентификатор пользователя текущего процесса. Это привилегированный
  процесс и требует соответствующих прав (обычно прав суперпользователя root) в системе для
  возможности выполнить эту функцию.

<comment>Param:</comment>
  <info>int</info>  <strong>$user_id</strong>  Идентификатор пользователя.

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

<comment>See Also:</comment>
   * <strong>posix_setgid()</strong>
   * <strong>posix_seteuid()</strong>
   * <strong>posix_getuid()</strong>
   * <strong>posix_geteuid()</strong>


id: posix_strerror
type: function
doc:
<comment>Description:</comment>
  Возвращает системное сообщение об ошибке, основываясь на полученном номере ошибки
  
  Возвращает POSIX системное сообщение об ошибке, связанное с полученным в параметре <strong>$error_code</strong>
  номером. Вы можете получить параметр <strong>$error_code</strong> с помощью вызова функции <strong>posix_get_last_error()</strong>.

<comment>Param:</comment>
  <info>int</info>  <strong>$error_code</strong>  POSIX номер ошибки, полученный из функции <strong>posix_get_last_error()</strong>. Если передано
                    значение 0, то будет возвращено сообщение "Success".

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

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


id: posix_sysconf
type: function
doc:
<comment>Description:</comment>
  Returns system runtime information
  
  Returns system runtime information.

<comment>Param:</comment>
  <info>int</info>  <strong>$conf_id</strong>  Identifier of the variable with the following constants <info>POSIX_SC_ARG_MAX</info>,
                 <info>POSIX_SC_PAGESIZE</info> <info>POSIX_SC_NPROCESSORS_CONF</info>, <info>POSIX_SC_NPROCESSORS_ONLN</info>

<comment>Return:</comment>
  <info>int</info>  Returns the numeric value related to <strong>$conf_id</strong>


id: posix_times
type: function
doc:
<comment>Description:</comment>
  Возвращает информацию об использовании процессорного времени
  
  Возвращает информацию об уровне загрузки CPU.

<comment>Return:</comment>
  <info>array|false</info>  Возвращает массив строк с информацией об текущем использовании CPU, который включает
               следующее  ticks - число тактов, прошедшее с момента перезагрузки.  utime - время
               пользователя, затраченное текущим процессом.  stime - системное время, затраченное
               текущим процессом.  cutime - время пользователя, затраченное текущим процессом и его
               дочерними процессами.  cstime - системное время, затраченное текущим процессом и его
               дочерними процессами..  Функция возвращает <info>false</info> в случае возникновения ошибки.
               
               ticks - число тактов, прошедшее с момента перезагрузки.
               
               utime - время пользователя, затраченное текущим процессом.
               
               stime - системное время, затраченное текущим процессом.
               
               cutime - время пользователя, затраченное текущим процессом и его дочерними
               процессами.
               
               cstime - системное время, затраченное текущим процессом и его дочерними процессами..


id: posix_ttyname
type: function
doc:
<comment>Description:</comment>
  Определяет имя терминального устройства
  
  Возвращает <info>string</info>, содержащую абсолютный путь до текущего терминального устройства, которое
  открыто и связано с файловым дескриптором <strong>$file_descriptor</strong>.

<comment>Param:</comment>
  <info>resource|int</info>  <strong>$file_descriptor</strong>  Файловый дескриптор, который ожидается в виде или ресурса <info>resource</info>
                                  или целого числа <info>int</info>. Под <info>int</info> подразумевается файловый дескриптор,
                                  который можно передать непосредственно в базовый системный вызов.

<comment>Return:</comment>
  <info>string|false</info>  В случае успешного выполнения возвращает строку (<info>string</info>), содержащую абсолютный путь
                до терминала, связанного с файловым дескриптором <strong>$file_descriptor</strong>. В случае неудачи
                возвращает <info>false</info>

<comment>See Also:</comment>
   * <strong>posix_isatty()</strong>
   * <strong>stream_isatty()</strong>


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

<comment>Return:</comment>
  <info>array|false</info>  Возвращает массив с информацией о системе, включая следующие элементы:  sysname -
               название операционной системы (например Linux)  nodename - системное имя (например
               valiant)  release - номер релиза (например 2.2.10)  version - версия операционной
               системы (например #4 Tue Jul 20 17:01:36 MEST 1999)  machine - архитектура системы
               (например i586)  domainname - DNS имя домена (например example.com)
               
               sysname - название операционной системы (например Linux)
               
               nodename - системное имя (например valiant)
               
               release - номер релиза (например 2.2.10)
               
               version - версия операционной системы (например #4 Tue Jul 20 17:01:36 MEST 1999)
               
               machine - архитектура системы (например i586)
               
               domainname - DNS имя домена (например example.com)
               
               domainname это GNU расширение, а не часть POSIX.1, поэтому это поле доступно только
               для GNU систем или при использовании библиотеки GNU libc.
               
               Функция возвращает <info>false</info> в случае возникновения ошибки.


id: pow
type: function
doc:
<comment>Description:</comment>
  Возведение в степень
  
  Возвращает <strong>$num</strong>, возведённое в степень <strong>$exponent</strong>.
  
  Вместо функции можно использовать оператор **.

<comment>Param:</comment>
  <info>mixed</info>  <strong>$num</strong>       Основание
  <info>mixed</info>  <strong>$exponent</strong>  Показатель степени

<comment>Return:</comment>
  <info>int|float|object</info>  Основание <strong>$num</strong> возведённое в степень <strong>$exponent</strong>. Если оба аргумента -
                    неотрицательные целые и результат может быть представлен как целое, то
                    возвращаемый результат будет типа <info>int</info>. В ином случае результат будет типа <info>float</info>.

<comment>See Also:</comment>
   * <strong>exp()</strong>
   * <strong>sqrt()</strong>
   * <strong>bcpow()</strong>
   * <strong>gmp_pow()</strong>


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

<comment>Return:</comment>
  <info>string|array|null</info>  Возвращает массив (<info>array</info>), если аргумент <strong>$subject</strong> имеет тип <info>array</info> или строка
                     (<info>string</info>) в противном случае.
                     
                     Если совпадений не найдено или возникла ошибка, возвращается пустой массив
                     (<info>array</info>), когда <strong>$subject</strong> имеет тип <info>array</info> или <info>null</info> в противном случае.

<comment>See Also:</comment>
   * Шаблоны PCRE
   * <strong>preg_quote()</strong>
   * <strong>preg_replace()</strong>
   * <strong>preg_replace_callback()</strong>
   * <strong>preg_grep()</strong>
   * <strong>preg_last_error()</strong>


id: preg_grep
type: function
doc:
<comment>Description:</comment>
  Возвращает массив вхождений, которые соответствуют шаблону
  
  Возвращает массив, состоящий из элементов входящего массива <strong>$array</strong>, которые соответствуют
  заданному шаблону <strong>$pattern</strong>.

<comment>Param:</comment>
  <info>string</info>  <strong>$pattern</strong>  Искомый шаблон в виде строки.
  <info>array</info>   <strong>$array</strong>    Входящий массив.
  <info>int</info>     <strong>$flags</strong>    В случае, если установлен в <info>PREG_GREP_INVERT</info>, функция <strong>preg_grep()</strong> возвращает те
                    элементы массива, которые не соответствуют заданному шаблону <strong>$pattern</strong>.

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

<comment>See Also:</comment>
   * Регулярные выражения PCRE
   * <strong>preg_quote()</strong>
   * <strong>preg_match_all()</strong>
   * <strong>preg_filter()</strong>
   * <strong>preg_last_error()</strong>


id: preg_last_error
type: function
doc:
<comment>Description:</comment>
  Возвращает код ошибки выполнения последнего регулярного выражения PCRE
  
  Возвращает код ошибки выполнения последнего регулярного выражения PCRE.
  
  Пример использования <strong>preg_last_error()</strong>
  ]]>Результат выполнения данного примера:
  
  Результат выполнения данного примера:

<comment>Return:</comment>
  <info>int</info>  Возвращает одну из следующих констант (описанных на отдельной странице.):
       <info>PREG_NO_ERROR</info><info>PREG_INTERNAL_ERROR</info><info>PREG_BACKTRACK_LIMIT_ERROR</info> (смотрите также
       pcre.backtrack_limit)<info>PREG_RECURSION_LIMIT_ERROR</info> (смотрите также
       pcre.recursion_limit)<info>PREG_BAD_UTF8_ERROR</info><info>PREG_BAD_UTF8_OFFSET_ERROR</info><info>PREG_JIT_STACKLIMIT_ERROR</info>

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


id: preg_last_error_msg
type: function
doc:
<comment>Description:</comment>
  Возвращает сообщение об ошибке последней запущенной функции PCRE
  
  Возвращает сообщение об ошибке последней запущенной функции PCRE.

<comment>Return:</comment>
  <info>string</info>  В случае успешного выполнения возвращает сообщение об ошибке. Если ошибки не было,
          возвращает строку <return>"No error"</return>.

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


id: preg_match
type: function
doc:
<comment>Description:</comment>
  Выполняет проверку на соответствие регулярному выражению
  
  Ищет в заданном тексте <strong>$subject</strong> совпадения с шаблоном <strong>$pattern</strong>.

<comment>Param:</comment>
  <info>string</info>  <strong>$pattern</strong>  Искомый шаблон в виде строки.
  <info>string</info>  <strong>$subject</strong>  Входная строка.
  <info>array</info>   <strong>$matches</strong>  В случае, если указан дополнительный параметр <strong>$matches</strong>, он будет заполнен
                    результатами поиска. Элемент $matches[0] будет содержать часть строки,
                    соответствующую вхождению всего шаблона, $matches[1] - часть строки,
                    соответствующую первой подмаске и так далее.
  <info>int</info>     <strong>$flags</strong>    <strong>$flags</strong> может быть комбинацией следующих флагов: <info>PREG_OFFSET_CAPTURE</info> В случае,
                    если этот флаг указан, для каждой найденной подстроки будет указана её позиция
                    (в байтах) в исходной строке. Необходимо помнить, что этот флаг меняет формат
                    возвращаемого массива <strong>$matches</strong> в массив, каждый элемент которого содержит
                    массив, содержащий в индексе с номером <return>0</return> найденную подстроку, а смещение этой
                    подстроки в параметре <strong>$subject</strong> - в индексе <return>1</return>.
                    ]]>Результат выполнения данного примера: Array ( [0] => foobarbaz [1] => 0 )
                     [1] => Array ( [0] => foo [1] => 0 )
                     [2] => Array ( [0] => bar [1] => 3 )
                     [3] => Array ( [0] => baz [1] => 6 )
                    
                    )
                    ]]> <info>PREG_UNMATCHED_AS_NULL</info> Если этот флаг передан, несовпадающие подмаски будут
                    представлены значениями <info>null</info>; в противном случае они отображаются в виде пустых
                    строк (<info>string</info>).
                    ]]>Результат выполнения данного примера: string(2) "ac" [1]=> string(1) "a"
                    [2]=> string(0) "" [3]=> string(1) "c"
                    }
                    array(4) { [0]=> string(2) "ac" [1]=> string(1) "a" [2]=> NULL [3]=> string(1)
                    "c"
                    }
                    ]]> 
                    
                    В случае, если этот флаг указан, для каждой найденной подстроки будет указана её
                    позиция (в байтах) в исходной строке. Необходимо помнить, что этот флаг меняет
                    формат возвращаемого массива <strong>$matches</strong> в массив, каждый элемент которого содержит
                    массив, содержащий в индексе с номером <return>0</return> найденную подстроку, а смещение этой
                    подстроки в параметре <strong>$subject</strong> - в индексе <return>1</return>.
                    ]]>Результат выполнения данного примера: Array ( [0] => foobarbaz [1] => 0 )
                     [1] => Array ( [0] => foo [1] => 0 )
                     [2] => Array ( [0] => bar [1] => 3 )
                     [3] => Array ( [0] => baz [1] => 6 )
                    
                    )
                    ]]>
                    
                    Результат выполнения данного примера:
                    
                    Если этот флаг передан, несовпадающие подмаски будут представлены значениями
                    <info>null</info>; в противном случае они отображаются в виде пустых строк (<info>string</info>).
                    ]]>Результат выполнения данного примера: string(2) "ac" [1]=> string(1) "a"
                    [2]=> string(0) "" [3]=> string(1) "c"
                    }
                    array(4) { [0]=> string(2) "ac" [1]=> string(1) "a" [2]=> NULL [3]=> string(1)
                    "c"
                    }
                    ]]>
                    
                    Результат выполнения данного примера:
  <info>array</info>   <strong>$matches</strong>  В случае, если этот флаг указан, для каждой найденной подстроки будет указана её
                    позиция (в байтах) в исходной строке. Необходимо помнить, что этот флаг меняет
                    формат возвращаемого массива <strong>$matches</strong> в массив, каждый элемент которого содержит
                    массив, содержащий в индексе с номером <return>0</return> найденную подстроку, а смещение этой
                    подстроки в параметре <strong>$subject</strong> - в индексе <return>1</return>.
                    ]]>Результат выполнения данного примера: Array ( [0] => foobarbaz [1] => 0 )
                     [1] => Array ( [0] => foo [1] => 0 )
                     [2] => Array ( [0] => bar [1] => 3 )
                     [3] => Array ( [0] => baz [1] => 6 )
                    
                    )
                    ]]>
                    
                    Результат выполнения данного примера:
  <info>int</info>     <strong>$offset</strong>   Обычно поиск осуществляется слева направо, с начала строки. Можно использовать
                    дополнительный параметр <strong>$offset</strong> для указания альтернативной начальной позиции
                    для поиска (в байтах).
                    
                    Использование параметра <strong>$offset</strong> не эквивалентно замене сопоставляемой строки
                    выражением substr($subject, $offset) при вызове функции <strong>preg_match()</strong>, поскольку
                    шаблон <strong>$pattern</strong> может содержать такие условия как ^, $ или (?\<=x). Сравните:
                    ]]>Результат выполнения данного примера: В то время как этот пример 
                    ]]> выведет следующее:  Array ( [0] => def [1] => 0 )
                    
                    )
                    ]]> В качестве альтернативы <strong>substr()()</strong>, используйте утверждение <return>\G</return> вместо якоря
                    <return>^</return> или модификатор <return>A</return>. Оба они работают с параметром <strong>$offset</strong>.
                    
                    Результат выполнения данного примера:
                    
                    В то время как этот пример
                    
                    выведет следующее:
                    
                    В качестве альтернативы <strong>substr()()</strong>, используйте утверждение <return>\G</return> вместо якоря <return>^</return>
                    или модификатор <return>A</return>. Оба они работают с параметром <strong>$offset</strong>.

<comment>Return:</comment>
  <info>int|false</info>  <strong>preg_match()</strong> возвращает 1, если параметр <strong>$pattern</strong> соответствует переданному параметру
             <strong>$subject</strong>, 0 если нет или <info>false</info> в случае возникновения ошибки.
             
             Эта функция может возвращать как логическое значение <info>false</info>, так и значение не типа
             boolean, которое приводится к <info>false</info>. За более подробной информацией обратитесь к
             разделу Булев тип. Используйте оператор === для проверки значения, возвращаемого этой
             функцией.

<comment>See Also:</comment>
   * "Регулярные выражения PCRE"
   * <strong>preg_quote()</strong>
   * <strong>preg_match_all()</strong>
   * <strong>preg_replace()</strong>
   * <strong>preg_split()</strong>
   * <strong>preg_last_error()</strong>
   * <strong>preg_last_error_msg()</strong>


id: preg_match_all
type: function
doc:
<comment>Description:</comment>
  Выполняет глобальный поиск шаблона в строке
  
  Ищет в строке <strong>$subject</strong> все совпадения с шаблоном <strong>$pattern</strong> и помещает результат в массив <strong>$matches</strong> в
  порядке, определяемом комбинацией флагов <strong>$flags</strong>.
  
  После обнаружения первого соответствия поиски будут выполняться с конца последнего найденного
  вхождения.

<comment>Param:</comment>
  <info>string</info>  <strong>$pattern</strong>  Искомый шаблон в виде строки.
  <info>string</info>  <strong>$subject</strong>  Входная строка.
  <info>array</info>   <strong>$matches</strong>  Массив совпавших значений, отсортированный в соответствии с параметром <strong>$flags</strong>.
  <info>int</info>     <strong>$flags</strong>    Может быть комбинацией следующих флагов (обратите внимание, указывать флаг
                    <info>PREG_PATTERN_ORDER</info> одновременно с флагом <info>PREG_SET_ORDER</info> бессмысленно):
                    <info>PREG_PATTERN_ORDER</info> Упорядочивает результаты так, что элемент $matches[0]
                    содержит массив полных вхождений шаблона, элемент $matches[1] содержит массив
                    вхождений первой подмаски и т. д.
                    ]]>Результат выполнения данного примера:пример: , это тест
                    пример: , это тест
                    ]]> Так, элемент $out[0] содержит массив строк, которые соответствуют полному
                    шаблону, а элемент $out[1] содержит массив строк, которые заключены в теги.
                    Если шаблон содержит именованные подшаблоны, $matches дополнительно будет
                    содержать записи для ключей с именами этих подшаблонов.  Если шаблон содержит
                    задублированные именованные подшаблоны, то только самый правый подшаблон будет
                    сохранён в элементе $matches[NAME].
                    ]]>Результат выполнения данного примера: [1] => bar
                    )
                    ]]> <info>PREG_SET_ORDER</info> Упорядочивает результаты так, что элемент $matches[0]
                    становится массивом с первым набором вхождений, а элемент $matches[1] — со
                    вторым набором вхождений и т. д.
                    ]]>Результат выполнения данного примера:пример: , пример:
                    это тест, это тест
                    ]]> <info>PREG_OFFSET_CAPTURE</info> Если передан этот флаг, для каждой найденной подстроки
                    также будет возвращена её позиция в исходной строке (в байтах). Обратите
                    внимание, что этот флаг изменяет массив <strong>$matches</strong> на многомерный, каждый элемент
                    которого содержит массив, содержащий в индексе с номером <return>0</return> найденную подстроку,
                    а смещение этой подстроки в параметре <strong>$subject</strong> — в индексе <return>1</return>.
                    ]]>Результат выполнения данного примера: Array ( [0] => Array ( [0] => foobarbaz
                    [1] => 0 )
                     )
                     [1] => Array ( [0] => Array ( [0] => foo [1] => 0 )
                     )
                     [2] => Array ( [0] => Array ( [0] => bar [1] => 3 )
                     )
                     [3] => Array ( [0] => Array ( [0] => baz [1] => 6 )
                     )
                    
                    )
                    ]]> <info>PREG_UNMATCHED_AS_NULL</info> Если этот флаг передан, несовпадающие подмаски будут
                    представлены значениями <info>null</info>; иначе они отображаются в виде пустых строк
                    (<info>string</info>).
                    
                    Упорядочивает результаты так, что элемент $matches[0] содержит массив полных
                    вхождений шаблона, элемент $matches[1] содержит массив вхождений первой подмаски
                    и т. д.
                    
                    
                    ]]>Результат выполнения данного примера:пример: , это тест
                    пример: , это тест
                    ]]> Так, элемент $out[0] содержит массив строк, которые соответствуют полному
                    шаблону, а элемент $out[1] содержит массив строк, которые заключены в теги.
                    
                    Результат выполнения данного примера:
                    
                    Так, элемент $out[0] содержит массив строк, которые соответствуют полному
                    шаблону, а элемент $out[1] содержит массив строк, которые заключены в теги.
                    
                    Если шаблон содержит именованные подшаблоны, $matches дополнительно будет
                    содержать записи для ключей с именами этих подшаблонов.
                    
                    Если шаблон содержит задублированные именованные подшаблоны, то только самый
                    правый подшаблон будет сохранён в элементе $matches[NAME].
                    ]]>Результат выполнения данного примера: [1] => bar
                    )
                    ]]>
                    
                    Результат выполнения данного примера:
                    
                    Упорядочивает результаты так, что элемент $matches[0] становится массивом с
                    первым набором вхождений, а элемент $matches[1] — со вторым набором вхождений и
                    т. д.
                    ]]>Результат выполнения данного примера:пример: , пример:
                    это тест, это тест
                    ]]>
                    
                    Результат выполнения данного примера:
                    
                    Если передан этот флаг, для каждой найденной подстроки также будет возвращена её
                    позиция в исходной строке (в байтах). Обратите внимание, что этот флаг изменяет
                    массив <strong>$matches</strong> на многомерный, каждый элемент которого содержит массив,
                    содержащий в индексе с номером <return>0</return> найденную подстроку, а смещение этой подстроки
                    в параметре <strong>$subject</strong> — в индексе <return>1</return>.
                    ]]>Результат выполнения данного примера: Array ( [0] => Array ( [0] => foobarbaz
                    [1] => 0 )
                     )
                     [1] => Array ( [0] => Array ( [0] => foo [1] => 0 )
                     )
                     [2] => Array ( [0] => Array ( [0] => bar [1] => 3 )
                     )
                     [3] => Array ( [0] => Array ( [0] => baz [1] => 6 )
                     )
                    
                    )
                    ]]>
                    
                    Результат выполнения данного примера:
                    
                    Если этот флаг передан, несовпадающие подмаски будут представлены значениями
                    <info>null</info>; иначе они отображаются в виде пустых строк (<info>string</info>).
                    
                    Если флаг сортировки не передан, будет использован флаг по умолчанию —
                    <info>PREG_PATTERN_ORDER</info>.
  <info>array</info>   <strong>$matches</strong>  Если передан этот флаг, для каждой найденной подстроки также будет возвращена её
                    позиция в исходной строке (в байтах). Обратите внимание, что этот флаг изменяет
                    массив <strong>$matches</strong> на многомерный, каждый элемент которого содержит массив,
                    содержащий в индексе с номером <return>0</return> найденную подстроку, а смещение этой подстроки
                    в параметре <strong>$subject</strong> — в индексе <return>1</return>.
                    ]]>Результат выполнения данного примера: Array ( [0] => Array ( [0] => foobarbaz
                    [1] => 0 )
                     )
                     [1] => Array ( [0] => Array ( [0] => foo [1] => 0 )
                     )
                     [2] => Array ( [0] => Array ( [0] => bar [1] => 3 )
                     )
                     [3] => Array ( [0] => Array ( [0] => baz [1] => 6 )
                     )
                    
                    )
                    ]]>
                    
                    Результат выполнения данного примера:
  <info>int</info>     <strong>$offset</strong>   Обычно поиск выполняется слева направо, с начала строки. Через необязательный
                    параметр <strong>$offset</strong> можно указать другую позицию (в байтах), с которой будет начат
                    поиск.
                    
                    Использование параметра <strong>$offset</strong> не эквивалентно замене сопоставляемой строки
                    выражением substr($subject, $offset) при вызове функции <strong>preg_match_all()</strong>,
                    поскольку шаблон <strong>$pattern</strong> может содержать такие условия как ^, $ или (?\<=x). Примеры можно посмотреть в описании функции <strong>preg_match()</strong>.

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

<comment>See Also:</comment>
   * Регулярные выражения PCRE
   * <strong>preg_quote()</strong>
   * <strong>preg_match()</strong>
   * <strong>preg_replace()</strong>
   * <strong>preg_split()</strong>
   * <strong>preg_last_error()</strong>


id: preg_quote
type: function
doc:
<comment>Description:</comment>
  Экранирует символы в регулярных выражениях
  
  Функция <strong>preg_quote()</strong> принимает строку <strong>$str</strong> и добавляет обратный слеш перед каждым служебным
  символом. Это бывает полезно, если в составлении шаблона участвуют строковые переменные, значение
  которых в процессе работы скрипта может меняться.
  
  В регулярных выражениях служебными считаются следующие символы: <return>. \ + * ? [ ^ ] $ ( ) { } = !
  \< &gt; | : - #</return>
  
  Обратите внимание, что символ <return>/</return> не является служебным.
  
  Обратите внимание, что <strong>preg_quote()</strong> не предназначена для применения к строкам $replacement функции
  <strong>preg_replace()</strong> и т.д.

<comment>Param:</comment>
  <info>string</info>       <strong>$str</strong>        Входная строка.
  <info>string|null</info>  <strong>$delimiter</strong>  В случае, если указан необязательный параметр <strong>$delimiter</strong>, он будет также
                           экранироваться. Это удобно для экранирования разделителя, который
                           используется в PCRE-функциях. Наиболее распространённым разделителем
                           является символ <return>/</return>.

<comment>Return:</comment>
  <info>string</info>  Возвращает экранированную строку.

<comment>See Also:</comment>
   * Регулярные выражения PCRE
   * <strong>escapeshellcmd()</strong>


id: preg_replace
type: function
doc:
<comment>Description:</comment>
  Выполняет поиск и замену по регулярному выражению
  
  Выполняет поиск совпадений в строке <strong>$subject</strong> с шаблоном <strong>$pattern</strong> и заменяет их на <strong>$replacement</strong>.
  
  Для соответствия точной строке, а не шаблону, вместо этой функции используйте функцию
  <strong>str_replace()</strong> или <strong>str_ireplace()</strong>.

<comment>Param:</comment>
  <info>string|array</info>  <strong>$pattern</strong>      Искомый шаблон. Может быть как строкой, так и массивом строк.
                              
                              Также доступны некоторые модификаторы PCRE.
  <info>string|array</info>  <strong>$replacement</strong>  Строка или массив строк для замены. Если этот параметр является
                              строкой, а <strong>$pattern</strong> является массивом, все шаблоны будут заменены этой
                              строкой. Если и <strong>$pattern</strong> и <strong>$replacement</strong> являются массивами, каждый
                              элемент <strong>$pattern</strong> будет заменён соответствующим элементом из
                              <strong>$replacement</strong>. Если массив <strong>$replacement</strong> содержит меньше элементов, чем
                              массив <strong>$pattern</strong>, то все лишние шаблоны из <strong>$pattern</strong> будут заменены
                              пустыми строками.
                              
                              <strong>$replacement</strong> может содержать ссылки вида <return>\n</return>, либо <return>$n</return>, причём последний
                              вариант предпочтительней. Каждая такая ссылка будет заменена на
                              подстроку, соответствующую n-ой подмаске. n может принимать значения
                              от 0 до 99, причём ссылка <return>\0</return> (либо <return>$0</return>) соответствует вхождению всего
                              шаблона. Подмаски нумеруются слева направо, начиная с единицы.
                              Обратите внимание, что обратные слеши в строке (<info>string</info>) литералы могут
                              требовать экранирования.
                              
                              При замене по шаблону с использованием ссылок на подмаски может
                              возникнуть ситуация, когда непосредственно за маской следует цифра
                              (например, установка цифры сразу после совпавшей маски). В таком
                              случае нельзя использовать знакомую нотацию вида <return>\1</return> для ссылки на
                              подмаски. Запись, например, <return>\11</return>, смутит <strong>preg_replace()</strong>, так как она не
                              сможет понять, хотите ли вы использовать ссылку <return>\1</return>, за которой следует
                              цифра <return>1</return> или же вы хотите просто использовать ссылку <return>\11</return>, за которой
                              ничего не следует. Это недоразумение можно устранить, если
                              воспользоваться конструкцией <return>${1}1</return>, использующей изолированную ссылку
                              <return>$1</return>, и следующую за ней цифру <return>1</return>.
                              
                              При использовании устаревшего модификатора <return>e</return> эта функция экранирует
                              некоторые символы (а именно <return>'</return>, <return>"</return>, <return>\</return> и NULL) в строках, замещающих
                              обратные ссылки. Это сделано для удостоверения корректности синтаксиса
                              при использовании обратных ссылок внутри одинарных или двойных кавычек
                              (например, <return>'strlen(\'$1\')+strlen("$2")'</return>). Убедитесь, что вы владеете
                              синтаксисом обработки строк PHP для того, чтобы точно осознавать, как
                              будет выглядеть интерпретированная строка.
  <info>string|array</info>  <strong>$subject</strong>      Строка или массив строк для поиска и замены.
                              
                              Если <strong>$subject</strong> является массивом, то поиск с заменой осуществляется для
                              каждого элемента массива <strong>$subject</strong>, а возвращаемое значение также будет
                              являться массивом.
                              
                              Если параметр <strong>$subject</strong> является ассоциативным массивом, ключи будут
                              сохранены в возвращаемом значении.
  <info>int</info>           <strong>$limit</strong>        Максимально возможное количество замен каждого шаблона для каждой
                              строки <strong>$subject</strong>. По умолчанию равно <return>-1</return> (без ограничений).
  <info>int</info>           <strong>$count</strong>        Если указана, то эта переменная будет заполнена количеством
                              произведённых замен.

<comment>Return:</comment>
  <info>string|array|null</info>  <strong>preg_replace()</strong> возвращает массив, если параметр <strong>$subject</strong> является массивом,
                     иначе возвращается строка.
                     
                     Если найдены совпадения, возвращается новая версия <strong>$subject</strong>, иначе <strong>$subject</strong>
                     возвращается нетронутым, в случае ошибки возвращается <info>null</info>.

<comment>See Also:</comment>
   * Регулярные выражения PCRE
   * <strong>preg_quote()</strong>
   * <strong>preg_filter()</strong>
   * <strong>preg_match()</strong>
   * <strong>preg_replace_callback()</strong>
   * <strong>preg_split()</strong>
   * <strong>preg_last_error()</strong>
   * <strong>str_replace()</strong>


id: preg_replace_callback
type: function
doc:
<comment>Description:</comment>
  Выполняет поиск по регулярному выражению и замену с использованием callback-функции
  
  Поведение этой функции во многом напоминает <strong>preg_replace()</strong>, за исключением того, что вместо
  параметра <strong>$replacement</strong> необходимо указывать <strong>$callback</strong>-функцию.

<comment>Param:</comment>
  <info>string|array</info>  <strong>$pattern</strong>   Искомый шаблон. Может быть как строкой, так и массивом строк.
  <info>callable</info>      <strong>$callback</strong>  Вызываемая callback-функция, которой будет передан массив совпавших
                           элементов из строки <strong>$subject</strong>. Callback-функция должна вернуть строку с
                           заменой. Callback-функция должна быть описана так:
                           
                           <info>string</info>handler<info>array</info><strong>$matches</strong>
                           
                           Достаточно часто <strong>$callback</strong> функция, кроме как в вызове
                           <strong>preg_replace_callback()</strong>, ни в чем больше не участвует. Исходя из этих
                           соображений, можно использовать анонимные функции для создания
                           callback-функции непосредственно в вызове <strong>preg_replace_callback()</strong>. Если
                           вы используете такой подход, вся информация, связанная с заменой по
                           регулярному выражению, будет собрана в одном месте, и пространство имён
                           функций не будет загромождаться неиспользуемыми записями.
                           
                           <strong>preg_replace_callback()</strong> и анонимная функция
                           ]]>
  <info>string|array</info>  <strong>$subject</strong>   Строка или массив строк для поиска и замены.
  <info>int</info>           <strong>$limit</strong>     Максимально возможное количество замен для каждого шаблона в каждой
                           строке <strong>$subject</strong>. По умолчанию равно <return>-1</return> (без ограничений).
  <info>int</info>           <strong>$count</strong>     Если указана, то эта переменная будет заполнена количеством произведённых
                           замен.
  <info>int</info>           <strong>$flags</strong>     <strong>$flags</strong> может быть комбинацией флагов <info>PREG_OFFSET_CAPTURE</info> и
                           <info>PREG_UNMATCHED_AS_NULL</info>, которые влияют на формат массива совпадений.
                           Смотрите описание в <strong>preg_match()</strong> для более подробной информации.

<comment>Return:</comment>
  <info>string|array|null</info>  <strong>preg_replace_callback()</strong> возвращает массив, если параметр <strong>$subject</strong> является
                     массивом, иначе возвращается строка. В случае ошибок возвращается <info>null</info>
                     
                     Если найдены совпадения, будет возвращена результирующая строка, иначе <strong>$subject</strong>
                     вернётся неизмененным.

<comment>See Also:</comment>
   * Регулярные выражения PCRE
   * <strong>preg_replace_callback_array()</strong>
   * <strong>preg_quote()</strong>
   * <strong>preg_replace()</strong>
   * <strong>preg_last_error()</strong>
   * Анонимные функции


id: preg_replace_callback_array
type: function
doc:
<comment>Description:</comment>
  Выполняет поиск и замену по регулярному выражению с использованием функций обратного вызова
  
  Поведение этой функции похоже на <strong>preg_replace_callback()</strong>, за исключением того, что для каждого
  шаблона используется своя функция обратного вызова.

<comment>Param:</comment>
  <info>array</info>         <strong>$pattern</strong>  Ассоциативный массив, связывающий шаблоны регулярного выражения (ключи) и
                          <info>callable</info> (значения).
  <info>string|array</info>  <strong>$subject</strong>  Строка, в которой будет производиться поиск и замена.
  <info>int</info>           <strong>$limit</strong>    Максимальное количество замен для каждого шаблона в строке <strong>$subject</strong>. По
                          умолчанию <return>-1</return> (без ограничений).
  <info>int</info>           <strong>$count</strong>    Если задан, то в указанную переменную будет записано количество
                          произведённых замен.
  <info>int</info>           <strong>$flags</strong>    <strong>$flags</strong> может быть комбинацией флагов <info>PREG_OFFSET_CAPTURE</info> и
                          <info>PREG_UNMATCHED_AS_NULL</info>, которые влияют на формат массива совпадений.
                          Смотрите описание в <strong>preg_match()</strong> для более подробной информации.

<comment>Return:</comment>
  <info>string|array|null</info>  <strong>preg_replace_callback_array()</strong> возвращает массив, если параметр <strong>$subject</strong>
                     является массивом и строку, если строкой. В случае возникновения ошибки
                     возвращается <info>null</info>
                     
                     Если совпадения найдены, будет возвращена новая строка, а если нет, то исходная
                     <strong>$subject</strong>.

<comment>See Also:</comment>
   * Шаблоны PCRE
   * <strong>preg_replace_callback()</strong>
   * <strong>preg_quote()</strong>
   * <strong>preg_replace()</strong>
   * <strong>preg_last_error()</strong>
   * Анонимные функции


id: preg_split
type: function
doc:
<comment>Description:</comment>
  Разбивает строку по регулярному выражению
  
  Разбивает строку по регулярному выражению.

<comment>Param:</comment>
  <info>string</info>  <strong>$pattern</strong>  Строка, содержащая искомый шаблон.
  <info>string</info>  <strong>$subject</strong>  Входная строка.
  <info>int</info>     <strong>$limit</strong>    Если указан, функция возвращает не более, чем <strong>$limit</strong> подстрок. Оставшаяся часть
                    строки будет возвращена в последней подстроке. Специальное значение <strong>$limit</strong>,
                    равное -1 или 0, подразумевает отсутствие ограничения.
  <info>int</info>     <strong>$flags</strong>    <strong>$flags</strong> может быть любой комбинацией следующих флагов (объединённых с помощью
                    побитового оператора <return>|</return>): <info>PREG_SPLIT_NO_EMPTY</info> Если указан этот флаг, функция
                    <strong>preg_split()</strong> вернёт только непустые подстроки. <info>PREG_SPLIT_DELIM_CAPTURE</info> Если
                    указан этот флаг, выражение, заключённое в круглые скобки в разделяющем шаблоне,
                    также извлекается из заданной строки и возвращается функцией.
                    <info>PREG_SPLIT_OFFSET_CAPTURE</info> Если указан этот флаг, для каждой найденной подстроки
                    будет указана её позиция в исходной строке. Необходимо помнить, что этот флаг
                    меняет формат возвращаемого массива: каждый элемент будет содержать массив,
                    содержащий в индексе с номером <return>0</return> найденную подстроку, а смещение этой подстроки
                    в параметре <strong>$subject</strong> - в индексе <return>1</return>.
                    
                    Если указан этот флаг, функция <strong>preg_split()</strong> вернёт только непустые подстроки.
                    
                    Если указан этот флаг, выражение, заключённое в круглые скобки в разделяющем
                    шаблоне, также извлекается из заданной строки и возвращается функцией.
                    
                    Если указан этот флаг, для каждой найденной подстроки будет указана её позиция в
                    исходной строке. Необходимо помнить, что этот флаг меняет формат возвращаемого
                    массива: каждый элемент будет содержать массив, содержащий в индексе с номером <return>0</return>
                    найденную подстроку, а смещение этой подстроки в параметре <strong>$subject</strong> - в индексе
                    <return>1</return>.
  <info>string</info>  <strong>$subject</strong>  Если указан этот флаг, для каждой найденной подстроки будет указана её позиция в
                    исходной строке. Необходимо помнить, что этот флаг меняет формат возвращаемого
                    массива: каждый элемент будет содержать массив, содержащий в индексе с номером <return>0</return>
                    найденную подстроку, а смещение этой подстроки в параметре <strong>$subject</strong> - в индексе
                    <return>1</return>.

<comment>Return:</comment>
  <info>array|false</info>  Возвращает массив, состоящий из подстрок заданной строки <strong>$subject</strong>, которая разбита по
               границам, соответствующим шаблону <strong>$pattern</strong> или <info>false</info> в случае возникновения ошибки.

<comment>See Also:</comment>
   * "Регулярные выражения PCRE"
   * <strong>preg_quote()</strong>
   * <strong>implode()</strong>
   * <strong>preg_match()</strong>
   * <strong>preg_match_all()</strong>
   * <strong>preg_replace()</strong>
   * <strong>preg_last_error()</strong>


id: prev
type: function
doc:
<comment>Description:</comment>
  Передвигает внутренний указатель массива на одну позицию назад
  
  Передвигает внутренний указатель массива на одну позицию назад.
  
  <strong>prev()</strong> ведёт себя подобно <strong>next()</strong>, за исключением того, что она передвигает внутренний указатель
  массива на одну позицию назад, а не вперёд.

<comment>Param:</comment>
  <info>array|object</info>  <strong>$array</strong>  Входной массив.

<comment>Return:</comment>
  <info>mixed</info>  Возвращает значение массива, на которое ранее указывал внутренний указатель массива, или
         <info>false</info>, если больше элементов нет.
         
         Эта функция может возвращать как логическое значение <info>false</info>, так и значение не типа boolean,
         которое приводится к <info>false</info>. За более подробной информацией обратитесь к разделу Булев тип.
         Используйте оператор === для проверки значения, возвращаемого этой функцией.

<comment>See Also:</comment>
   * <strong>current()</strong>
   * <strong>end()</strong>
   * <strong>next()</strong>
   * <strong>reset()</strong>
   * <strong>each()</strong>


id: print
type: function
doc:
<comment>Description:</comment>
  Выводит строку
  
  Выводит <strong>$expression</strong>.
  
  <return>print</return> - это не функция, а языковая конструкция. Его аргумент - это выражение после ключевого слова
  <return>print</return>, не ограниченное круглыми скобками.
  
  Главное отличие от <return>echo</return> в том, что <return>print</return> принимает только один аргумент и всегда возвращает <return>1</return>.

<comment>Param:</comment>
  <info>string</info>  <strong>$expression</strong>  Выражение для вывода. Нестроковые значения будут преобразованы в строки, даже
                       если включена директива <return>strict_types</return>.

<comment>Return:</comment>
  <info>int</info>  Всегда возвращает <return>1</return>.

<comment>See Also:</comment>
   * <strong>echo()</strong>
   * <strong>printf()</strong>
   * <strong>flush()</strong>
   * Способы работы со строками


id: print_r
type: function
doc:
<comment>Description:</comment>
  Выводит удобочитаемую информацию о переменной
    
  
  <strong>print_r()</strong> выводит информацию о переменной в удобочитаемом виде.
  
  <strong>print_r()</strong>, <strong>var_dump()</strong> и <strong>var_export()</strong> могут также показывать защищённые и закрытые атрибуты
  объектов. Статические элементы класса не будут отображены.

<comment>Param:</comment>
  <info>mixed</info>  <strong>$value</strong>   Выражение для вывода на экран.
  <info>bool</info>   <strong>$return</strong>  Если вы хотите перехватить вывод <strong>print_r()</strong>, используйте параметр <strong>$return</strong>. Если его
                  значение равно <info>true</info>, то <strong>print_r()</strong> вернёт информацию вместо вывода в браузер.

<comment>Return:</comment>
  <info>string|bool</info>  Если в функцию передаются значения типов <info>string</info>, <info>int</info> или <info>float</info>, будет напечатано само
               значение. Если передаётся массив <info>array</info>, значения будут напечатаны в формате,
               показывающем ключи и элементы массива. Аналогичный формат вывода используется для
               объектов.
               
               Если параметр <strong>$return</strong> установлен в <info>true</info>, данная функция вернёт строку (<info>string</info>). В
               противном случае возвращаемое значение будет равно <info>true</info>.

<comment>See Also:</comment>
   * <strong>ob_start()</strong>
   * <strong>var_dump()</strong>
   * <strong>var_export()</strong>


id: printf
type: function
doc:
<comment>Description:</comment>
  Выводит отформатированную строку
  
  Выводит строку, отформатированную в соответствии с аргументом <strong>$format</strong>.

<comment>Param:</comment>
  <info>string</info>  <strong>$format</strong>  Строка формата состоит из нуля или более директив: обычные символы (за
                   исключением <return>%</return>), которые просто выводятся без изменения и спецификаторы
                   преобразования, каждый из которых требует передачи своего параметра.
                   
                   Спецификаторы преобразования имеют следующий формат:
                   <return>%[argnum$][flags][width][.precision]specifier</return>.
                   
                   Целое число, за которым следует знак доллара <return>$</return>, чтобы указать, какой числовой
                   аргумент обрабатывать при преобразовании.
                   
                   ФлагиФлагОписание<return>-</return> Выравнивание по левому краю в пределах заданной ширины поля;
                   По умолчанию выравнивание происходит по правому краю. <return>+</return> Печатает плюс <return>+</return> у не
                   отрицательных чисел; По умолчанию знак печатается только у отрицательных чисел. <return>
                   </return>(space) Дополняет результат пробелами. Это поведение по умолчанию. <return>0</return> Дополняет
                   числа нулями (только слева). Со спецификатором <return>s</return> также может дополнять нулями
                   справа. <return>'</return>(char) Дополняет результат символом (char).
                   
                   Либо целое число, указывающее, сколько символов (минимум) должно получиться в
                   результате преобразования, либо <return>*</return>. Если используется <return>*</return>, то ширина предоставляется
                   как дополнительное целое значение, предшествующее значению, отформатированному
                   спецификатором.
                   
                   Точка <return>.</return>, с последующим целым числом, либо <return>*</return>, значение которого зависит от
                   спецификатора:  Для спецификаторов <return>e</return>, <return>E</return>, <return>f</return> и <return>F</return>: задаёт количество цифр после
                   десятичной запятой (по умолчанию 6).  Для спецификаторов <return>g</return>,<return>G</return>, <return>h</return> и <return>H</return>: задаёт
                   максимальное значение печатаемых значащих цифр.  Для спецификатора <return>s</return>: задаёт
                   ограничение максимального количества символов в строке, которые будут выведены.
                   Если указана точка без последующего значения точности, то точность будет
                   считаться за 0. Если используется <return>*</return>, точность предоставляется как дополнительное
                   целое значение, предшествующее значению, отформатированному спецификатором.
                   
                   Для спецификаторов <return>e</return>, <return>E</return>, <return>f</return> и <return>F</return>: задаёт количество цифр после десятичной запятой
                   (по умолчанию 6).
                   
                   Для спецификаторов <return>g</return>,<return>G</return>, <return>h</return> и <return>H</return>: задаёт максимальное значение печатаемых значащих
                   цифр.
                   
                   Для спецификатора <return>s</return>: задаёт ограничение максимального количества символов в
                   строке, которые будут выведены.
                   
                   Если указана точка без последующего значения точности, то точность будет
                   считаться за 0. Если используется <return>*</return>, точность предоставляется как дополнительное
                   целое значение, предшествующее значению, отформатированному спецификатором.
                   
                   СпецификаторыСпецификаторОписание<return>%</return> Символ процента. Аргументы не требуются. <return>b</return>
                   Аргумент рассматривается как целое число и печатается в бинарном представлении. <return>c</return>
                   Аргумент рассматривается как целое число и печатается как символ из таблицы ASCII
                   с соответствующим кодом. <return>d</return> Аргумент рассматривается как целое число и печатается
                   как целое число со знаком. <return>e</return> Аргумент считается за число в научной нотации (т.е.
                   1.2e+2). <return>E</return> Аналогично спецификатору <return>e</return>, но использует заглавные символы (т.е.
                   1.2E+2). <return>f</return> Аргумент считается за число с плавающей точкой (с учётом локали). <return>F</return>
                   Аргумент считается за число с плавающей точкой (без учёта локали). <return>g</return> Общий
                   формат.  Пусть P равно точности, если она не равно нулю, 6 — если точность не
                   задана и 1, если точность задана как 0. Тогда, если преобразование со стилем "E"
                   будет иметь показатель степени X:  Если P &gt; X ≥ −4, преобразование будет в
                   стиле "f" и точность будет P − (X + 1). В обратном случае, преобразование будет в
                   стиле "e" и точность будет P − 1. <return>G</return> Аналогично спецификатору <return>g</return>, но использует <return>E</return> и
                   <return>f</return>. <return>h</return> Аналогично спецификатору <return>g</return>, но использует <return>F</return>. Доступен с PHP 8.0.0. <return>H</return>
                   Аналогично спецификатору <return>g</return>, но использует <return>E</return> и <return>F</return>. Доступен с PHP 8.0.0. <return>o</return> Аргумент
                   рассматривается как целое число и печатается в восьмеричном представлении. <return>s</return>
                   Аргумент рассматривается и печатается как строка. <return>u</return> Аргумент рассматривается как
                   целое число и печатается как беззнаковое целое число. <return>x</return> Аргумент рассматривается
                   как целое число и печатается в шестнадцатеричном представлении (буквы будут в
                   нижнем регистре). <return>X</return> Аргумент рассматривается как целое число и печатается в
                   шестнадцатеричном представлении (буквы будут в верхнем регистре).
                   
                   Общий формат.
                   
                   Пусть P равно точности, если она не равно нулю, 6 — если точность не задана и 1,
                   если точность задана как 0. Тогда, если преобразование со стилем "E" будет иметь
                   показатель степени X:
                   
                   Если P &gt; X ≥ −4, преобразование будет в стиле "f" и точность будет P − (X +
                   1). В обратном случае, преобразование будет в стиле "e" и точность будет P − 1.
                   
                   Спецификатор <return>c</return> игнорирует значения ширины и дополнения
                   
                   Попытка использовать спецификаторы с указанием ширины для строки в многобайтовой
                   кодировке может привести к неожиданным результатам.
                   
                   Переменные будут приведены к подходящему для спецификатора типу: Обработка
                   типовТипСпецификатор<info>string</info><return>s</return><info>int</info><return>d</return>, <return>u</return>, <return>c</return>, <return>o</return>, <return>x</return>, <return>X</return>, <return>b</return><info>float</info><return>e</return>, <return>E</return>, <return>f</return>, <return>F</return>, <return>g</return>, <return>G</return>, <return>h</return>, <return>H</return>
  <info>mixed</info>   <strong>$values</strong>  

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

<comment>See Also:</comment>
   * <strong>print()</strong>
   * <strong>sprintf()</strong>
   * <strong>fprintf()</strong>
   * <strong>vprintf()</strong>
   * <strong>vsprintf()</strong>
   * <strong>vfprintf()</strong>
   * <strong>sscanf()</strong>
   * <strong>fscanf()</strong>
   * <strong>number_format()</strong>
   * <strong>date()</strong>
   * <strong>flush()</strong>


id: proc_close
type: function
doc:
<comment>Description:</comment>
  Завершить процесс, открытый proc_open и вернуть код возврата этого процесса
  
  Функция <strong>proc_close()</strong> похожа на функцию <strong>pclose()</strong>, за исключением того, что она работает только с
  процессами, открытыми при помощи функции <strong>proc_open()</strong>. Функция <strong>proc_close()</strong> ожидает завершения
  процесса и возвращает его код возврата. Открытые каналы для этого процесса закрываются при вызове
  этой функции, чтобы избежать полной остановки программы: дочерний процесс не сможет завершиться,
  если есть открытые каналы.

<comment>Param:</comment>
  <info>resource</info>  <strong>$process</strong>  Дескриптор типа <info>resource</info>, открытый при помощи <strong>proc_open()</strong>, который будет
                      закрыт.

<comment>Return:</comment>
  <info>int</info>  Возвращает код завершения процесса, который был запущен. В случае ошибки возвращается <return>-1</return>.
       
       Если PHP собран с опцией --enable-sigchild, возвращаемое значение этой функции не определено.


id: proc_get_status
type: function
doc:
<comment>Description:</comment>
  Получить информацию о процессе, открытом proc_open
  
  <strong>proc_get_status()</strong> получает данные о процессе, открытом при помощи функции <strong>proc_open()</strong>.

<comment>Param:</comment>
  <info>resource</info>  <strong>$process</strong>  Дескриптор типа <info>resource</info>, открытый при помощи <strong>proc_open()</strong>, который будет
                      исследоваться.

<comment>Return:</comment>
  <info>array</info>  Массив (<info>array</info>) с полученной информацией. Получаемый массив содержит следующие элементы:
         
         элементтипописаниеcommand<info>string</info> Строка с командой, которая была передана функции
         <strong>proc_open()</strong>. pid<info>int</info>идентификатор процессаrunning<info>bool</info><info>true</info>, если процесс всё ещё запущен,
         <info>false</info>, если он был завершён. signaled<info>bool</info><info>true</info>, если дочерний процесс был завершён
         неперехваченным сигналом. Всегда устанавливается в <info>false</info> в Windows. stopped<info>bool</info><info>true</info>, если
         дочерний процесс был остановлен сигналом. Всегда устанавливается в <info>false</info> в Windows.
         exitcode<info>int</info> Код возврата, передаваемый процессом (имеет значение только в том случае, если
         <return>running</return> равно <info>false</info>). Только первый вызов этой функции возвратит реальное значение,
         последующие вызовы будут возвращать <return>-1</return>. termsig<info>int</info> Номер сигнала, который заставил дочерний
         процесс прекратить его выполнение (имеет значение только в том случае, если <return>signaled</return> равно
         <info>true</info>). stopsig<info>int</info> Номер сигнала, который заставил дочерний процесс остановить его
         выполнение (имеет значение только в том случае, если  <return>stopped</return> равно <info>true</info>).

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


id: proc_nice
type: function
doc:
<comment>Description:</comment>
  Изменить приоритет текущего процесса
  
  <strong>proc_nice()</strong> изменяет приоритет текущего процесса на значение, указанное в параметре <strong>$priority</strong>.
  Положительное значение параметра <strong>$priority</strong> будет уменьшать приоритет текущего процесса, а
  отрицательное значение параметра <strong>$priority</strong> будет увеличивать приоритет.
  
  Функция <strong>proc_nice()</strong> не связана с функцией <strong>proc_open()</strong> и к относящимся к ней функциям каким-либо
  образом.

<comment>Param:</comment>
  <info>int</info>  <strong>$priority</strong>  Новое значение приоритета процесса. Может отличаться на разных платформах.
                  
                  В Unix, чем ниже эта величина, например <return>-20</return>, тем выше приоритет процесса.
                  
                  В Windows параметр <strong>$priority</strong> может принимать такие значения:

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

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


id: proc_open
type: function
doc:
<comment>Description:</comment>
  Выполнить команду и открыть указатель на файл для ввода/вывода
    
  
  <strong>proc_open()</strong> аналогична <strong>popen()</strong>, но предоставляет намного больше контроля над выполнением
  программы.

<comment>Param:</comment>
  <info>array|string</info>  <strong>$command</strong>          Командная для выполнения, указанная как строка (<info>string</info>).
                                  Специальные символы должны быть должным образом экранированы, и
                                  должны применяться правильные кавычки.
                                  
                                  В Windows, если для <return>bypass_shell</return> не установлено значение <info>true</info> в
                                  <strong>$options</strong>, <strong>$command</strong> передаётся в cmd.exe (точнее, <return>%ComSpec%</return>) с
                                  флагом <return>/c</return> в виде строки  без кавычек (т.е. точно так, как было
                                  задано в <strong>proc_open()</strong>). Это может привести к тому, что cmd.exe
                                  удалит заключающие из <strong>$command</strong> (подробности смотрите в
                                  документации cmd.exe), приводя к неожиданному и потенциально даже
                                  опасному поведению, потому что сообщения об ошибках cmd.exe могут
                                  содержать (частично) переданный параметр <strong>$command</strong> (смотрите пример
                                  ниже).
                                  
                                  Начиная с PHP 7.4.0, <strong>$command</strong> может передаваться как массив
                                  (<info>array</info>) параметров команды. В этом случае процесс будет открыт
                                  напрямую (не проходя через оболочку) и PHP позаботится об
                                  экранировании любого необходимого аргумента.
                                  
                                  В Windows экранирование аргумента массива (<info>array</info>) элементов
                                  предполагает, что синтаксический анализ выполненной команды
                                  совместим с синтаксическим анализом аргументов командной строки,
                                  выполняемых средой выполнения VC.
  <info>array</info>         <strong>$descriptor_spec</strong>  Массив, ключи которого представляют собой номер дескриптора, а
                                  значение описывает, как PHP должен передать этот дескриптор
                                  дочернему процессу. 0 - stdin, 1 - stdout и 2 - stderr.
                                  
                                  Каждый элемент может быть:  Массивом, описывающим канал (pipe) для
                                  передачи процессу. Первый элемент - это дескриптор типа, второй -
                                  настройка для выбранного типа. Возможные типы: <return>pipe</return> (второй
                                  элемент либо <return>r</return> для передачи процессу стороны канала для чтения,
                                  либо <return>w</return> для передачи стороны записи) и <return>file</return> (второй элемент - имя
                                  файла). Обратите внимание, что всё, кроме <return>w</return>, обрабатывается как <return>r</return>.
                                  Ресурсом потока, представляющим дескриптор файла (например,
                                  открытый файл, сокет, <info>STDIN</info>).
                                  
                                  Номера дескрипторов не ограничены только 0, 1 и 2 - вы можете
                                  назначить любой действительный номер дескриптора и он будет
                                  передан дочернему процессу. Это позволяет скрипту
                                  взаимодействовать с другими скриптами, работающими, как
                                  параллельные процессы. В частности, таким образом можно передавать
                                  данные, требующие защиты, в программы вроде PGP, GPG и openssl
                                  более безопасно. Также это может оказаться полезным для чтения
                                  статусной информации, предоставляемой этими программами на
                                  вспомогательных файловых дескрипторах.
  <info>array</info>         <strong>$pipes</strong>            Будет задан массивом указателей на файлы, соответствующие
                                  созданным каналам передачи данных PHP.
  <info>string|null</info>   <strong>$cwd</strong>              Рабочая директория команды. Это должен быть абсолютный путь к
                                  директории или <info>null</info>, если требуется использовать директорию по
                                  умолчанию (рабочая директория текущего процесса PHP).
  <info>array|null</info>    <strong>$env_vars</strong>         Массив переменных окружения для запускаемой команды или <info>null</info>, если
                                  требуется использовать то же самое окружение, что и у текущего
                                  PHP-процесса.
  <info>array|null</info>    <strong>$options</strong>          Позволяет задать дополнительные настройки. На данный момент
                                  поддерживаются следующие настройки: <return>suppress_errors</return> (только для
                                  Windows): при установке в <info>true</info> не будут показываться ошибки,
                                  возникающие в ходе работы функции <return>bypass_shell</return> (только для
                                  Windows): при установке в <info>true</info> процесс будет запущен в обход
                                  оболочки <return>cmd.exe</return> <return>blocking_pipes</return> (только для Windows):
                                  принудительно блокировать поток при значении <info>true</info>
                                  <return>create_process_group</return> (только для Windows): разрешить дочернему
                                  процессу обрабатывать <return>CTRL</return> события, если установлено значение <info>true</info>
                                  <return>create_new_console</return> (только для Windows): новый процесс использует
                                  новую консоль, а не наследует консоль своего родителя

<comment>Return:</comment>
  <info>resource|false</info>  Возвращает ресурс, представляющий процесс. Этот ресурс необходимо освобождать
                  функцией <strong>proc_close()</strong> по завершении работы с ним. В случае возникновения ошибки
                  возвращает <info>false</info>.

<comment>See Also:</comment>
   * <strong>popen()</strong>
   * <strong>exec()</strong>
   * <strong>system()</strong>
   * <strong>passthru()</strong>
   * <strong>stream_select()</strong>
   * Оператор обратный апостроф


id: proc_terminate
type: function
doc:
<comment>Description:</comment>
  Уничтожить процесс, открытый при помощи функции proc_open
  
  Отправляет процессу <strong>$process</strong> (созданному при помощи функции <strong>proc_open()</strong>) сигнал, говорящий о том,
  что он должен завершиться. Функция <strong>proc_terminate()</strong> возвращается немедленно и не ожидает
  завершения процесса.
  
  Функция <strong>proc_terminate()</strong> позволяет завершить процесс и продолжить выполнение других задач. Вы
  можете опрашивать процесс (для того, чтобы проверить, был ли он завершён) при помощи функции
  <strong>proc_get_status()</strong>.

<comment>Param:</comment>
  <info>resource</info>  <strong>$process</strong>  Дескриптор типа <info>resource</info>, открытый при помощи функции <strong>proc_open()</strong>, который
                      будет закрыт.
  <info>int</info>       <strong>$signal</strong>   Этот необязательный параметр полезен только на операционных системах,
                      поддерживающих стандарт POSIX. Вы можете указать сигнал, который будет
                      отправлен процессу, используя системный вызов <return>kill(2)</return>. По умолчанию
                      используется сигнал <return>SIGTERM</return>.

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

<comment>See Also:</comment>
   * <strong>proc_open()</strong>
   * <strong>proc_close()</strong>
   * <strong>proc_get_status()</strong>


id: property_exists
type: function
doc:
<comment>Description:</comment>
  Проверяет, содержит ли объект или класс указанный атрибут
    
  
  Функция проверяет, существует ли атрибут <strong>$property</strong> в указанном классе.
  
  В противоположность <strong>isset()</strong>, <strong>property_exists()</strong> возвращает <info>true</info>, даже если свойство имеет значение
  <info>null</info>.

<comment>Param:</comment>
  <info>object|string</info>  <strong>$object_or_class</strong>  Имя класса или объект класса для проверки
  <info>string</info>         <strong>$property</strong>         Имя свойства

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

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


id: ps_add_bookmark
type: function
doc:
<comment>Description:</comment>
  Добавляет закладку на текущую страницу
  
  Добавляет закладку на текущую страницу. Закладки обычно видны в программах просмотра PDF слева от
  страницы в иерархическом дереве. Нажатие на закладку открывает страницу, на которую она ссылается.
  
  Примечание не будет отображаться при печати или просмотре документа, но будет показано при
  конвертировании документа в pdf с помощью Acrobat Distiller™ или Ghostview.

<comment>Param:</comment>
  <info>resource</info>  <strong>$psdoc</strong>   Идентификатор ресурса, возвращаемый <strong>ps_new()</strong>, ссылающегося на postscript-файл..
  <info>string</info>    <strong>$text</strong>    Описание закладки.
  <info>int</info>       <strong>$parent</strong>  Закладка, созданная этой же функцией, которая будет указана в качестве родителя
                     текущей закладки.
  <info>int</info>       <strong>$open</strong>    Если <strong>$open</strong> не равен нулю, то закладка будет открываться при отображении файла в
                     программе просмотра PDF файлов.

<comment>Return:</comment>
  <info>int</info>  Возвращаемое функцией значение является ссылкой на закладку. Эта ссылка используется в случае
       построения иерархии закладок, если нужно указать созданную закладку как родителя. Если
       функция отработала нормально, возвращаемое значение будет больше нуля. Если функция
       завершилась с ошибкой, то она вернёт ноль.

<comment>See Also:</comment>
   * <strong>ps_add_launchlink()</strong>
   * <strong>ps_add_pdflink()</strong>
   * <strong>ps_add_weblink()</strong>


id: ps_add_launchlink
type: function
doc:
<comment>Description:</comment>
  Добавляет ссылку, запускающую файл
  
  Помещает гиперссылку в заданную позицию, указывающую на файловую программу, которая запускается
  при нажатии. Исходная позиция гиперссылки - это прямоугольник с нижним левым углом в позиции (llx,
  lly) и верхним правым углом в позиции (urx, ury). У прямоугольника по умолчанию тонкая синяя
  рамка.
  
  Примечание не будет отображаться при печати или просмотре документа, но будет показано при
  конвертировании документа в pdf с помощью Acrobat Distiller™ или Ghostview.

<comment>Param:</comment>
  <info>resource</info>  <strong>$psdoc</strong>     Идентификатор ресурса файла postscript, возвращённый <strong>ps_new()</strong>.
  <info>float</info>     <strong>$llx</strong>       Координата X левого нижнего угла.
  <info>float</info>     <strong>$lly</strong>       Координата Y левого нижнего угла.
  <info>float</info>     <strong>$urx</strong>       Координата X правого верхнего угла.
  <info>float</info>     <strong>$ury</strong>       Координата Y правого верхнего угла.
  <info>string</info>    <strong>$filename</strong>  Путь к запускаемой программе при нажатии на ссылку.

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

<comment>See Also:</comment>
   * <strong>ps_add_locallink()</strong>
   * <strong>ps_add_pdflink()</strong>
   * <strong>ps_add_weblink()</strong>


id: ps_add_locallink
type: function
doc:
<comment>Description:</comment>
  Добавляет ссылку на страницу того же документа
  
  Добавляет гиперссылку в заданном месте, указывающую на страницу того же документа. Нажатие по
  ссылке приведёт к переходу на данную страницу. Номер первой страницы документа - 1.
  
  Исходная позиция гиперссылки представляет собой прямоугольник с нижним левым углом в (<strong>$llx</strong>, <strong>$lly</strong>)
  и его правым верхним углом в (<strong>$urx</strong>, <strong>$ury</strong>). У прямоугольника по умолчанию есть тонкая синяя рамка.
  
  Примечание не будет отображаться при печати или просмотре документа, но будет показано при
  конвертировании документа в pdf с помощью Acrobat Distiller™ или Ghostview.

<comment>Param:</comment>
  <info>resource</info>  <strong>$psdoc</strong>  Идентификатор ресурса файла postscript, возвращённый функцией <strong>ps_new()</strong>.
  <info>float</info>     <strong>$llx</strong>    Координата X левого нижнего угла.
  <info>float</info>     <strong>$lly</strong>    Координата Y левого нижнего угла.
  <info>float</info>     <strong>$urx</strong>    Координата X правого верхнего угла.
  <info>float</info>     <strong>$ury</strong>    Координата Y правого верхнего угла.
  <info>int</info>       <strong>$page</strong>   Номер страницы, отображаемой при переходе по ссылке.
  <info>string</info>    <strong>$dest</strong>   Параметр <strong>$dest</strong> определяет способ просмотра документа. Может быть: <return>fitpage</return>,
                    <return>fitwidth</return>, <return>fitheight</return> или <return>fitbbox</return>.

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

<comment>See Also:</comment>
   * <strong>ps_add_launchlink()</strong>
   * <strong>ps_add_pdflink()</strong>
   * <strong>ps_add_weblink()</strong>


id: ps_add_note
type: function
doc:
<comment>Description:</comment>
  Добавляет примечание к текущей странице
  
  Добавляет примечание в определённое место на странице. Примечания похожи на маленькие
  прямоугольные листы с текстом, которые можно разместить в любом месте страницы. Они показаны в
  свёрнутом или развёрнутом виде. В свёрнутом виде указанный значок используется в качестве
  заполнителя.
  
  Примечание не будет отображаться при печати или просмотре документа, но будет показано при
  конвертировании документа в pdf с помощью Acrobat Distiller™ или Ghostview.

<comment>Param:</comment>
  <info>resource</info>  <strong>$psdoc</strong>     Идентификатор ресурса файла postscript, возвращённый функцией <strong>ps_new()</strong>.
  <info>float</info>     <strong>$llx</strong>       Координата X левого нижнего угла.
  <info>float</info>     <strong>$lly</strong>       Координата Y левого нижнего угла.
  <info>float</info>     <strong>$urx</strong>       Координата X правого верхнего угла.
  <info>float</info>     <strong>$ury</strong>       Координата Y правого верхнего угла.
  <info>string</info>    <strong>$contents</strong>  Текст примечания.
  <info>string</info>    <strong>$title</strong>     Название примечания, отображаемое в заголовке примечания.
  <info>string</info>    <strong>$icon</strong>      Значок, отображаемый, если заметка сложена. Может быть: <return>comment</return>, <return>insert</return>,
                       <return>note</return>, <return>paragraph</return>, <return>newparagraph</return>, <return>key</return> или <return>help</return>.
  <info>int</info>       <strong>$open</strong>      Если <strong>$open</strong> не равно нулю, заметка будет отображаться развёрнутой после
                       открытия документа с помощью программы просмотра PDF.

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

<comment>See Also:</comment>
   * <strong>ps_add_pdflink()</strong>
   * <strong>ps_add_launchlink()</strong>
   * <strong>ps_add_locallink()</strong>
   * <strong>ps_add_weblink()</strong>


id: ps_add_pdflink
type: function
doc:
<comment>Description:</comment>
  Добавляет ссылку на страницу в другом PDF-документе
  
  Добавляет гиперссылку в указанном месте, указывающую на другой документ PDF. Нажатие по ссылке
  приведёт к переходу на данную страницу. Номер первой страницы документа - 1.
  
  Исходная позиция гиперссылки представляет собой прямоугольник с нижним левым углом в (<strong>$llx</strong>, <strong>$lly</strong>)
  и его правым верхним углом в (<strong>$urx</strong>, <strong>$ury</strong>). У прямоугольника по умолчанию есть тонкая синяя рамка.
  
  Примечание не будет отображаться при печати или просмотре документа, но будет показано при
  конвертировании документа в pdf с помощью Acrobat Distiller™ или Ghostview.

<comment>Param:</comment>
  <info>resource</info>  <strong>$psdoc</strong>     Идентификатор ресурса файла postscript, возвращённый функцией <strong>ps_new()</strong>.
  <info>float</info>     <strong>$llx</strong>       Координата X левого нижнего угла.
  <info>float</info>     <strong>$lly</strong>       Координата Y левого нижнего угла.
  <info>float</info>     <strong>$urx</strong>       Координата X правого верхнего угла.
  <info>float</info>     <strong>$ury</strong>       Координата Y правого верхнего угла.
  <info>string</info>    <strong>$filename</strong>  Имя PDF-документа, который будет открыт при нажатии на ссылку.
  <info>int</info>       <strong>$page</strong>      Номер страницы, отображаемой при переходе по ссылке.
  <info>string</info>    <strong>$dest</strong>      Параметр <strong>$dest</strong> определяет способ просмотра документа. Может быть: <return>fitpage</return>,
                       <return>fitwidth</return>, <return>fitheight</return> или <return>fitbbox</return>.

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

<comment>See Also:</comment>
   * <strong>ps_add_launchlink()</strong>
   * <strong>ps_add_locallink()</strong>
   * <strong>ps_add_weblink()</strong>


id: ps_add_weblink
type: function
doc:
<comment>Description:</comment>
  Добавляет ссылку на веб-страницу
  
  Добавляет гиперссылку в указанном месте, указывающую на веб-страницу. Исходная позиция гиперссылки
  представляет собой прямоугольник с нижним левым углом в (<strong>$llx</strong>, <strong>$lly</strong>) и его правым верхним углом в
  (<strong>$urx</strong>, <strong>$ury</strong>). У прямоугольника по умолчанию есть тонкая синяя рамка.
  
  Примечание не будет отображаться при печати или просмотре документа, но будет показано при
  конвертировании документа в pdf с помощью Acrobat Distiller™ или Ghostview.

<comment>Param:</comment>
  <info>resource</info>  <strong>$psdoc</strong>  Идентификатор ресурса файла postscript, возвращённый функцией <strong>ps_new()</strong>.
  <info>float</info>     <strong>$llx</strong>    Координата X левого нижнего угла.
  <info>float</info>     <strong>$lly</strong>    Координата Y левого нижнего угла.
  <info>float</info>     <strong>$urx</strong>    Координата X правого верхнего угла.
  <info>float</info>     <strong>$ury</strong>    Координата Y правого верхнего угла.
  <info>string</info>    <strong>$url</strong>    URL-адрес гиперссылки, которая открывается при нажатии на ссылку, например,
                    <return>http://www.php.net</return>.

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

<comment>See Also:</comment>
   * <strong>ps_add_launchlink()</strong>
   * <strong>ps_add_locallink()</strong>
   * <strong>ps_add_pdflink()</strong>


id: ps_arc
type: function
doc:
<comment>Description:</comment>
  Рисует дугу против часовой стрелки
  
  Рисует часть круга со средней точкой в точке (<strong>$x</strong>, <strong>$y</strong>). Дуга начинается под углом <strong>$alpha</strong> и
  заканчивается под углом <strong>$beta</strong>. Она рисуется против часовой стрелки (используйте <strong>ps_arcn()</strong> для
  рисования по часовой стрелке). Дочерний путь, добавленный к текущему пути, начинается на дуге под
  углом <strong>$alpha</strong> и заканчивается на дуге под углом <strong>$beta</strong>.

<comment>Param:</comment>
  <info>resource</info>  <strong>$psdoc</strong>   Идентификатор ресурса файла postscript, возвращённый функцией <strong>ps_new()</strong>.
  <info>float</info>     <strong>$x</strong>       Координата X средней точки круга.
  <info>float</info>     <strong>$y</strong>       Координата Y средней точки круга.
  <info>float</info>     <strong>$radius</strong>  Радиус круга.
  <info>float</info>     <strong>$alpha</strong>   Начальный угол в градусах.
  <info>float</info>     <strong>$beta</strong>    Конечный угол в градусах.

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

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


id: ps_arcn
type: function
doc:
<comment>Description:</comment>
  Рисует дугу по часовой стрелке
  
  Рисует часть круга со средней точкой в точке (<strong>$x</strong>, <strong>$y</strong>). Дуга начинается под углом <strong>$alpha</strong> и
  заканчивается под углом <strong>$beta</strong>. Она рисуется по часовой стрелке (используйте <strong>ps_arc()</strong> для рисования
  против часовой стрелки). Дочерний путь, добавленный к текущему пути, начинается на дуге под углом
  <strong>$alpha</strong> и заканчивается на дуге под углом <strong>$beta</strong>.

<comment>Param:</comment>
  <info>resource</info>  <strong>$psdoc</strong>   Идентификатор ресурса файла postscript, возвращённый функцией <strong>ps_new()</strong>.
  <info>float</info>     <strong>$x</strong>       Координата X средней точки круга.
  <info>float</info>     <strong>$y</strong>       Координата Y средней точки круга.
  <info>float</info>     <strong>$radius</strong>  Радиус круга.
  <info>float</info>     <strong>$alpha</strong>   Начальный угол в градусах.
  <info>float</info>     <strong>$beta</strong>    Конечный угол в градусах.

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

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


id: ps_begin_page
type: function
doc:
<comment>Description:</comment>
  Начинает новую страницу
  
  Начинает новую страницу. Хотя параметры <strong>$width</strong> и <strong>$height</strong> подразумевают различный размер страницы
  для каждой страницы, это невозможно в PostScript. Первый вызов <strong>ps_begin_page()</strong> устанавливает
  размер страницы для всего документа. Последующие вызовы не будут иметь никакого эффекта, кроме
  создания новой страницы. Ситуация иная, если вы собираетесь преобразовать документ PostScript в
  PDF. Функция помещает в документ метки PDF, которые могут индивидуально устанавливать размер
  каждой страницы. Полученный PDF-документ будет иметь разные размеры страниц.
  
  Хотя PostScript не знает разных размеров страниц, pslib помещает в документ ограничительную рамку
  для каждой страницы. Этот размер оценивается некоторыми программами просмотра PostScript и имеет
  приоритет над BoundingBox в заголовке документа. Это может привести к неожиданным результатам,
  если вы установите BoundingBox, нижний левый угол которого не равен (0, 0), потому что у
  ограничивающей рамки страницы всегда будет нижний левый угол (0, 0) и перезапишет глобальную
  настройку.
  
  Каждая страница инкапсулируется в режим сохранения/восстановления. Это означает, что большинство
  настроек, сделанных на одной странице, не будут сохранены на следующей странице.
  
  Если до первого вызова <strong>ps_begin_page()</strong> не было вызова <strong>ps_findfont()</strong>, то будет выведен заголовок
  документа PostScript, а размер ограничивающей рамки будет установлен на первая страница. Нижний
  левый угол ограничивающей рамки установлен в (0, 0). Если <strong>ps_findfont()</strong> была вызвана раньше,
  значит, заголовок уже был выведен и документ не будет иметь корректной ограничительной рамки.
  Чтобы предотвратить это, следует вызвать <strong>ps_set_info()</strong>, чтобы установить информационное поле
  <return>BoundingBox</return> и, возможно, <return>Orientation</return> перед любым вызовом <strong>ps_findfont()</strong> или <strong>ps_begin_page()</strong>.
  
  До версии 0.2.6 pslib функция всегда будет перезаписывать BoundingBox и Orientation, если они была
  установлены ранее с помощью <strong>ps_set_info()</strong> и <strong>ps_findfont()</strong> ранее не вызывалась.

<comment>Param:</comment>
  <info>resource</info>  <strong>$psdoc</strong>   Идентификатор ресурса файла postscript, возвращённый функцией <strong>ps_new()</strong>.
  <info>float</info>     <strong>$width</strong>   Ширина страницы в пикселях, например, 596 для формата А4.
  <info>float</info>     <strong>$height</strong>  Высота страницы в пикселях, например, 842 для формата А4.

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

<comment>See Also:</comment>
   * <strong>ps_end_page()</strong>
   * <strong>ps_findfont()</strong>
   * <strong>ps_set_info()</strong>


id: ps_begin_pattern
type: function
doc:
<comment>Description:</comment>
  Начинает новый узор
  
  Начинает новый узор. Узор похож на страницу, содержащую, например, рисунок, который можно
  использовать для заливки областей. Он используется как цвет, вызывая <strong>ps_setcolor()</strong> и устанавливая
  цветовое пространство в <return>pattern</return>.

<comment>Param:</comment>
  <info>resource</info>  <strong>$psdoc</strong>      Идентификатор ресурса файла postscript, возвращённый функцией <strong>ps_new()</strong>.
  <info>float</info>     <strong>$width</strong>      Ширина узора в пикселях.
  <info>float</info>     <strong>$height</strong>     Высота узора в пикселях.
  <info></info>          <strong>$x-step</strong>     Расстояние в пикселях размещений узора по горизонтали.
  <info></info>          <strong>$y-step</strong>     Расстояние в пикселях размещений узора по вертикали.
  <info>int</info>       <strong>$painttype</strong>  Может быть 1 или 2.

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

<comment>See Also:</comment>
   * <strong>ps_end_pattern()</strong>
   * <strong>ps_setcolor()</strong>
   * <strong>ps_shading_pattern()</strong>


id: ps_begin_template
type: function
doc:
<comment>Description:</comment>
  Начинает новый шаблон
  
  Начинает новый шаблон. На языке postscript шаблон называется формой. Он создаётся аналогично
  узору, но используется как изображение. Шаблоны часто используются для рисунков, которые
  размещаются в документе несколько раз, например как логотип компании. В шаблоне можно использовать
  все функции рисования. Шаблон не будет нарисован, пока он не будет размещён с помощью
  <strong>ps_place_image()</strong>.

<comment>Param:</comment>
  <info>resource</info>  <strong>$psdoc</strong>   Идентификатор ресурса файла postscript, возвращённый функцией <strong>ps_new()</strong>.
  <info>float</info>     <strong>$width</strong>   Ширина шаблона в пикселях.
  <info>float</info>     <strong>$height</strong>  Высота шаблона в пикселях.

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

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


id: ps_circle
type: function
doc:
<comment>Description:</comment>
  Рисует круг
  
  Рисует круг со средней точкой в точке (<strong>$x</strong>, <strong>$y</strong>). Круг начинается и заканчивается в позиции
  (<strong>$x</strong>+<strong>$radius</strong>, <strong>$y</strong>). Если функция вызывается вне пути, она начнёт новый путь. Если функция вызывается
  внутри пути, она добавит круг как дочерний путь. Если последняя операция рисования не
  заканчивается точкой (<strong>$x</strong>+<strong>$radius</strong>, <strong>$y</strong>), тогда на пути будет разрыв.

<comment>Param:</comment>
  <info>resource</info>  <strong>$psdoc</strong>   Идентификатор ресурса файла postscript, возвращённый функцией <strong>ps_new()</strong>.
  <info>float</info>     <strong>$x</strong>       Координата X центра круга.
  <info>float</info>     <strong>$y</strong>       Координата Y центра круга.
  <info>float</info>     <strong>$radius</strong>  Радиус круга.

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

<comment>See Also:</comment>
   * <strong>ps_arc()</strong>
   * <strong>ps_arcn()</strong>


id: ps_clip
type: function
doc:
<comment>Description:</comment>
  Отрисовка клипов по текущему пути
  
  Берёт текущий путь и использует его для определения границы области отсечения. Всё, что нарисовано
  за пределами этой области, не будет видно.

<comment>Param:</comment>
  <info>resource</info>  <strong>$psdoc</strong>  Идентификатор ресурса файла postscript, возвращённый функцией <strong>ps_new()</strong>.

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

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


id: ps_close
type: function
doc:
<comment>Description:</comment>
  Закрывает документ PostScript
  
  Закрывает документ PostScript.
  
  Функция записывает количество страниц в документе PostScript. Она также записывает иерархию
  закладок. <strong>ps_close()</strong> не освобождает ресурсы, как <strong>ps_delete()</strong>.
  
  Функция также вызывается функцией <strong>ps_delete()</strong>, если она не была вызвана ранее.

<comment>Param:</comment>
  <info>resource</info>  <strong>$psdoc</strong>  Идентификатор ресурса файла postscript, возвращённый функцией <strong>ps_new()</strong>.

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

<comment>See Also:</comment>
   * <strong>ps_open_file()</strong>
   * <strong>ps_delete()</strong>


id: ps_close_image
type: function
doc:
<comment>Description:</comment>
  Закрывает изображение и освобождает память
  
  Закрывает изображение и освобождает его ресурсы. Как только изображение было закрыто, его больше
  нельзя использовать.

<comment>Param:</comment>
  <info>resource</info>  <strong>$psdoc</strong>    Идентификатор ресурса файла postscript, возвращённый функцией <strong>ps_new()</strong>.
  <info>int</info>       <strong>$imageid</strong>  Идентификатор ресурса изображения, возвращённый функцией <strong>ps_open_image()</strong> или
                      <strong>ps_open_image_file()</strong>.

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

<comment>See Also:</comment>
   * <strong>ps_open_image()</strong>
   * <strong>ps_open_image_file()</strong>


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

<comment>Param:</comment>
  <info>resource</info>  <strong>$psdoc</strong>  Идентификатор ресурса файла postscript, возвращённый функцией <strong>ps_new()</strong>.

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

<comment>See Also:</comment>
   * <strong>ps_clip()</strong>
   * <strong>ps_closepath_stroke()</strong>


id: ps_closepath_stroke
type: function
doc:
<comment>Description:</comment>
  Замыкает и обводит контур
  
  Соединяет последнюю точку с первой точкой пути и рисует получившуюся замкнутую линию.

<comment>Param:</comment>
  <info>resource</info>  <strong>$psdoc</strong>  Идентификатор ресурса файла postscript, возвращённый функцией <strong>ps_new()</strong>.

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

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


id: ps_continue_text
type: function
doc:
<comment>Description:</comment>
  Продолжает текст в следующей строке
  
  Выводит текст на одну строку ниже последней строки. Межстрочный интервал берётся из значения
  "leading", которое должно быть установлено с помощью <strong>ps_set_value()</strong>. Фактическое положение текста
  определяется значениями "textx" и "texty", которые можно запросить с помощью функции
  <strong>ps_get_value()</strong>.

<comment>Param:</comment>
  <info>resource</info>  <strong>$psdoc</strong>  Идентификатор ресурса файла postscript, возвращённый функцией <strong>ps_new()</strong>.
  <info>string</info>    <strong>$text</strong>   Текст для вывода.

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

<comment>See Also:</comment>
   * <strong>ps_show()</strong>
   * <strong>ps_show_xy()</strong>
   * <strong>ps_show_boxed()</strong>


id: ps_curveto
type: function
doc:
<comment>Description:</comment>
  Рисует кривую
  
  Добавляет отрезок кубической кривой Безье, описанный тремя заданными контрольными точками, к
  текущему пути. points to the current path.

<comment>Param:</comment>
  <info>resource</info>  <strong>$psdoc</strong>  Идентификатор ресурса файла postscript, возвращённый функцией <strong>ps_new()</strong>.
  <info>float</info>     <strong>$x1</strong>     Координата X первой контрольной точки.
  <info>float</info>     <strong>$y1</strong>     Координата Y первой контрольной точки.
  <info>float</info>     <strong>$x2</strong>     Координата X второй контрольной точки.
  <info>float</info>     <strong>$y2</strong>     Координата Y второй контрольной точки.
  <info>float</info>     <strong>$x3</strong>     Координата X третьей контрольной точки.
  <info>float</info>     <strong>$y3</strong>     Координата Y третьей контрольной точки.

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

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


id: ps_delete
type: function
doc:
<comment>Description:</comment>
  Удаляет все ресурсы документа PostScript
  
  В основном освобождает память, используемую документом. Также закрывает файл, если он не был ранее
  закрыт с помощью <strong>ps_close()</strong>. В любом случае вам следует закрыть файл с помощью <strong>ps_close()</strong> раньше,
  потому что <strong>ps_close()</strong> не только закрывает файл, но и выводит данные, содержащие комментарии
  PostScript, такие как количество страниц в документе и добавление иерархии закладок.

<comment>Param:</comment>
  <info>resource</info>  <strong>$psdoc</strong>  Идентификатор ресурса файла postscript, возвращённый <strong>ps_new()</strong>.

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

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


id: ps_end_page
type: function
doc:
<comment>Description:</comment>
  Завершает страницу
  
  Завершает страницу, которая была начата с помощью <strong>ps_begin_page()</strong>. Завершение страницы приведёт к
  выходу из текущего контекста рисования, который, например, требует перезагрузки шрифтов, если они
  загружались на странице и установки многих других параметров рисования, таких как ширина линии или
  цвет.

<comment>Param:</comment>
  <info>resource</info>  <strong>$psdoc</strong>  Идентификатор ресурса файла postscript, возвращённый <strong>ps_new()</strong>.

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

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


id: ps_end_pattern
type: function
doc:
<comment>Description:</comment>
  Завершает шаблон
  
  Завершает шаблон, который был начат с <strong>ps_begin_pattern()</strong>. Когда шаблон закончен, его можно
  использовать как цвет для заливки областей.

<comment>Param:</comment>
  <info>resource</info>  <strong>$psdoc</strong>  Идентификатор ресурса файла postscript, возвращённый <strong>ps_new()</strong>.

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

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


id: ps_end_template
type: function
doc:
<comment>Description:</comment>
  Завершает шаблон
  
  Завершает шаблон, который был начат с помощью <strong>ps_begin_template()</strong>. После завершения шаблона его
  можно использовать как изображение.

<comment>Param:</comment>
  <info>resource</info>  <strong>$psdoc</strong>  Идентификатор ресурса файла postscript, возвращённый <strong>ps_new()</strong>.

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

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


id: ps_fill
type: function
doc:
<comment>Description:</comment>
  Заполняет текущий путь
  
  Заполняет путь, созданный с помощью ранее вызванных функций рисования, таких как <strong>ps_lineto()</strong>.

<comment>Param:</comment>
  <info>resource</info>  <strong>$psdoc</strong>  Идентификатор ресурса файла postscript, возвращённый <strong>ps_new()</strong>.

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

<comment>See Also:</comment>
   * <strong>ps_fill_stroke()</strong>
   * <strong>ps_stroke()</strong>


id: ps_fill_stroke
type: function
doc:
<comment>Description:</comment>
  Заполняет и обводит текущий путь
  
  Заполняет и обводит путь, построенный с помощью ранее вызванных функций рисования, таких как
  <strong>ps_lineto()</strong>.

<comment>Param:</comment>
  <info>resource</info>  <strong>$psdoc</strong>  Идентификатор ресурса файла postscript, возвращённый <strong>ps_new()</strong>.

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

<comment>See Also:</comment>
   * <strong>ps_fill()</strong>
   * <strong>ps_stroke()</strong>


id: ps_findfont
type: function
doc:
<comment>Description:</comment>
  Загружает шрифт
  
  Загружает шрифт для дальнейшего использования. Перед выводом текста с загруженным шрифтом он
  должен быть установлен с помощью <strong>ps_setfont()</strong>. Функция нуждается в файле метрики шрифта Adobe,
  чтобы вычислить пространство, используемое символами. Шрифт, загруженный на страницу, будет
  доступен только на этой странице. Шрифты, которые будут использоваться во всем документе, должны
  быть загружены до первого вызова <strong>ps_begin_page()</strong>. Вызов <strong>ps_findfont()</strong> между страницами сделает
  шрифт доступным для всех следующих страниц.
  
  Имя afm-файла должно быть <strong>$fontname</strong><return>.afm</return>. Если шрифт должен быть встроен, также должен
  присутствовать файл <strong>$fontname</strong><return>.pfb</return>, содержащий контур шрифта.
  
  Вызов <strong>ps_findfont()</strong> перед первой страницей требует вывода заголовка PostScript, который включает
  BoundingBox для всего документа. Обычно BoundingBox устанавливается при первом вызове
  <strong>ps_begin_page()</strong>, который теперь идёт после <strong>ps_findfont()</strong>. Следовательно, BoundingBox не
  установлен, и при вызове <strong>ps_findfont()</strong> будет выдано предупреждение. Чтобы предотвратить эту
  ситуацию, следует вызвать <strong>ps_set_parameter()</strong> для установки BoundingBox до вызова <strong>ps_findfont()</strong>.

<comment>Param:</comment>
  <info>resource</info>  <strong>$psdoc</strong>     Идентификатор ресурса файла postscript, возвращённый функцией <strong>ps_new()</strong>.
  <info>string</info>    <strong>$fontname</strong>  Название шрифта.
  <info>string</info>    <strong>$encoding</strong>  Функция <strong>ps_findfont()</strong> попытается загрузить файл, переданный в параметре
                       <strong>$encoding</strong>. Файлы кодирования имеют тот же синтаксис, что и используемые
                       dvips(1). Они содержат вектор кодировки шрифта (который в настоящее время не
                       используется, но должен присутствовать) и список дополнительных лигатур для
                       расширения списка лигатур, полученных из файла afm.
                       
                       <strong>$encoding</strong> может быть <info>null</info> или пустой строкой, если должна использоваться
                       кодировка по умолчанию (TeXBase1).
                       
                       Если для кодировки установлено значение <return>builtin</return>, то перекодирования не будет
                       и будет использоваться кодировка, специфичная для шрифта. Это очень полезно
                       для символьных шрифтов.
  <info>bool</info>      <strong>$embed</strong>     Если установлено значение &gt; 0, шрифт будет встроен в документ. Для этого
                       требуется наличие контура шрифта (файл .pfb).

<comment>Return:</comment>
  <info>int</info>  Возвращает идентификатор шрифта или ноль в случае возникновения ошибки. Идентификатор -
       положительное число.

<comment>See Also:</comment>
   * <strong>ps_begin_page()</strong>
   * <strong>ps_setfont()</strong>


id: ps_get_buffer
type: function
doc:
<comment>Description:</comment>
  Получает полный буфер, содержащий сгенерированные данные PS
  
  Функция пока не реализована. Она всегда будет возвращать пустую строку. Идея для более поздней
  реализации состоит в том, чтобы записать содержимое файла postscript во внутренний буфер, если
  требуется создание в памяти, и получить содержимое буфера с помощью этой функции. В настоящее
  время документы, созданные в памяти, отправляются в браузер без буферизации.
  
  К настоящему времени эта функция ещё не была документирована; для ознакомления доступен только
  список аргументов.

<comment>Param:</comment>
  <info>resource</info>  <strong>$psdoc</strong>  Идентификатор ресурса файла postscript, возвращённый функцией <strong>ps_new()</strong>.

<comment>Return:</comment>
  <info>string</info>  

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


id: ps_get_parameter
type: function
doc:
<comment>Description:</comment>
  Получает определённые параметры
  
  Получает несколько параметров, которые были прямо установлены <strong>ps_set_parameter()</strong> или косвенно
  одной из других функций. Параметры по определению являются строковыми значениями. Функцию нельзя
  использовать для получения ресурсов, которые также были установлены с помощью <strong>ps_set_parameter()</strong>.
  
  Параметр <strong>$name</strong> может иметь следующие значения:
  
  <return>fontname</return> Имя текущего активного шрифта или шрифта, идентификатор которого передаётся в параметре
  <strong>$modifier</strong>. <return>fontencoding</return> Кодировка текущего активного шрифта. <return>dottedversion</return> Версия базовой
  библиотеки pslib в формате \<major&gt;.\<minor&gt;.\<subminor&gt; <return>scope</return> Текущий объём чертежа. Может быть: object, document, null, page, pattern, path, template, prolog, font, glyph. <return>ligaturedisolvechar</return> Символ, который растворяет лигатуру. Если вы используете шрифт, содержащий лигатуры `ff' и символ для растворения лигатуры `|', тогда `f|f' приведёт к двум `f' вместо лигатуры `ff'. <return>imageencoding</return> Кодировка, используемая для кодирования изображений. Может иметь значение <return>hex</return> или <return>85</return>. Шестнадцатеричное кодирование использует два байта в файле postscript на каждый байт изображения. 85 - это кодировка Ascii85. <return>linenumbermode</return> Установите значение <return>paragraph</return>, если строки пронумерованы внутри абзаца или <return>box</return>, если они пронумерованы в пределах окружающего поля. <return>linebreak</return> Используется, только если текст выводится с помощью <strong>ps_show_boxed()</strong>. Если установлено значение <info>true</info>, возврат каретки добавит разрыв строки. <return>parbreak</return> Используется, только если текст выводится с помощью <strong>ps_show_boxed()</strong>. Если установлено значение <info>true</info>, возврат каретки начнёт новый абзац. <return>hyphenation</return> Используется, только если текст выводится с помощью <strong>ps_show_boxed()</strong>. Если установлено значение <info>true</info>, абзац будет расставлен через дефис, если дефисный словарь установлен и существует. <return>hyphendict</return> Имя файла словаря, используемого для расстановки переносов.
  
  Имя текущего активного шрифта или шрифта, идентификатор которого передаётся в параметре <strong>$modifier</strong>.
  
  Кодировка текущего активного шрифта.
  
  Версия базовой библиотеки pslib в формате \<major&gt;.\<minor&gt;.\<subminor&gt;
  
  Текущий объём чертежа. Может быть: object, document, null, page, pattern, path, template, prolog,
  font, glyph.
  
  Символ, который растворяет лигатуру. Если вы используете шрифт, содержащий лигатуры `ff' и символ
  для растворения лигатуры `|', тогда `f|f' приведёт к двум `f' вместо лигатуры `ff'.
  
  Кодировка, используемая для кодирования изображений. Может иметь значение <return>hex</return> или <return>85</return>.
  Шестнадцатеричное кодирование использует два байта в файле postscript на каждый байт изображения.
  85 - это кодировка Ascii85.
  
  Установите значение <return>paragraph</return>, если строки пронумерованы внутри абзаца или <return>box</return>, если они
  пронумерованы в пределах окружающего поля.
  
  Используется, только если текст выводится с помощью <strong>ps_show_boxed()</strong>. Если установлено значение
  <info>true</info>, возврат каретки добавит разрыв строки.
  
  Используется, только если текст выводится с помощью <strong>ps_show_boxed()</strong>. Если установлено значение
  <info>true</info>, возврат каретки начнёт новый абзац.
  
  Используется, только если текст выводится с помощью <strong>ps_show_boxed()</strong>. Если установлено значение
  <info>true</info>, абзац будет расставлен через дефис, если дефисный словарь установлен и существует.
  
  Имя файла словаря, используемого для расстановки переносов.

<comment>Param:</comment>
  <info>resource</info>  <strong>$psdoc</strong>     Идентификатор ресурса файла postscript, возвращённый функцией <strong>ps_new()</strong>.
  <info>string</info>    <strong>$name</strong>      Имя параметра.
  <info>float</info>     <strong>$modifier</strong>  Идентификатор, необходимый, если запрашивается параметр ресурса, например,
                       размер изображения. В таком случае передаётся идентификатор ресурса.

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

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


id: ps_get_value
type: function
doc:
<comment>Description:</comment>
  Получает определённые значения
  
  Получает несколько значений, установленных <strong>ps_set_value()</strong>. Значения по определению являются
  значениями с плавающей точкой.
  
  Параметр <strong>$name</strong> может иметь следующие значения:
  
  <return>fontsize</return> Размер текущего активного шрифта или шрифта, идентификатор которого передаётся в
  параметре <strong>$modifier</strong>. <return>font</return> Текущий активный шрифт. <return>imagewidth</return> Ширина изображения, идентификатор
  которого передаётся в параметре <strong>$modifier</strong>. <return>imageheight</return> Высота изображения, идентификатор которого
  передаётся в параметре <strong>$modifier</strong>. <return>capheight</return> Высота заглавной буквы M активного шрифта или шрифта,
  идентификатор которого передаётся в параметре <strong>$modifier</strong>. <return>ascender</return> Верхний элемент активного шрифта
  или шрифта, идентификатор которого передаётся в параметре <strong>$modifier</strong>. <return>descender</return> Нисходящий элемент
  активного шрифта или шрифта, идентификатор которого передаётся в параметре <strong>$modifier</strong>. <return>italicangle</return>
  Курсив активного шрифта или шрифта, идентификатор которого передаётся в параметре <strong>$modifier</strong>.
  <return>underlineposition</return> Подчёркивание активного шрифта или шрифта, идентификатор которого передаётся в
  параметре <strong>$modifier</strong>. <return>underlinethickness</return> Толщина подчёркивания активного шрифта или шрифта,
  идентификатор которого передаётся в параметре <strong>$modifier</strong>. <return>textx</return> Текущая позиция по оси X для вывода
  текста. <return>texty</return> Текущая позиция по оси Y для вывода текста. <return>textrendering</return> Текущий режим отрисовки
  текста. <return>textrise</return> Пространство, на которое текст поднимается над базовой линией. <return>leading</return> Расстояние
  между строками текста в точках. <return>wordspacing</return> Расстояние между словами, кратное ширине символа
  пробела. <return>charspacing</return> Пробел между символами. Если charspacing не равно 0.0, лигатуры всегда будут
  растворяться. <return>hyphenminchars</return> Минимальное количество символов в конце слова. <return>parindent</return> Отступ
  первой n строки абзаца. <return>numindentlines</return> Номер строки в абзаце для отступа, если parindent не равно
  0,0. <return>parskip</return> Расстояние между абзацами. <return>linenumberspace</return> Общее пространство перед каждой строкой
  для номера строки. <return>linenumbersep</return> Пробел между строкой и номером строки. <return>major</return> Мажорная версия
  pslib. <return>minor</return> Минорная версия pslib. <return>subminor</return>, <return>revision</return> Патч-версия pslib.
  
  Размер текущего активного шрифта или шрифта, идентификатор которого передаётся в параметре
  <strong>$modifier</strong>.
  
  Текущий активный шрифт.
  
  Ширина изображения, идентификатор которого передаётся в параметре <strong>$modifier</strong>.
  
  Высота изображения, идентификатор которого передаётся в параметре <strong>$modifier</strong>.
  
  Высота заглавной буквы M активного шрифта или шрифта, идентификатор которого передаётся в
  параметре <strong>$modifier</strong>.
  
  Верхний элемент активного шрифта или шрифта, идентификатор которого передаётся в параметре
  <strong>$modifier</strong>.
  
  Нисходящий элемент активного шрифта или шрифта, идентификатор которого передаётся в параметре
  <strong>$modifier</strong>.
  
  Курсив активного шрифта или шрифта, идентификатор которого передаётся в параметре <strong>$modifier</strong>.
  
  Подчёркивание активного шрифта или шрифта, идентификатор которого передаётся в параметре
  <strong>$modifier</strong>.
  
  Толщина подчёркивания активного шрифта или шрифта, идентификатор которого передаётся в параметре
  <strong>$modifier</strong>.
  
  Текущая позиция по оси X для вывода текста.
  
  Текущая позиция по оси Y для вывода текста.
  
  Текущий режим отрисовки текста.
  
  Пространство, на которое текст поднимается над базовой линией.
  
  Расстояние между строками текста в точках.
  
  Расстояние между словами, кратное ширине символа пробела.
  
  Пробел между символами. Если charspacing не равно 0.0, лигатуры всегда будут растворяться.
  
  Минимальное количество символов в конце слова.
  
  Отступ первой n строки абзаца.
  
  Номер строки в абзаце для отступа, если parindent не равно 0,0.
  
  Расстояние между абзацами.
  
  Общее пространство перед каждой строкой для номера строки.
  
  Пробел между строкой и номером строки.
  
  Мажорная версия pslib.
  
  Минорная версия pslib.
  
  Патч-версия pslib.

<comment>Param:</comment>
  <info>resource</info>  <strong>$psdoc</strong>     Идентификатор ресурса файла postscript, возвращённый функцией <strong>ps_new()</strong>.
  <info>string</info>    <strong>$name</strong>      Название значения.
  <info>float</info>     <strong>$modifier</strong>  Параметр <strong>$modifier</strong> указывает ресурс, для которого должно быть получено
                       значение. Это может быть идентификатор шрифта или изображения.

<comment>Return:</comment>
  <info>float</info>  Возвращает значение параметра или <info>false</info>.

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


id: ps_hyphenate
type: function
doc:
<comment>Description:</comment>
  Переносит слово
  
  Переносит указанное слово. Функция <strong>ps_hyphenate()</strong> оценивает дефисы значения (устанавливается
  <strong>ps_set_value()</strong>) и дефисы параметра (устанавливается <strong>ps_set_parameter()</strong>). Перед вызовом этой
  функции необходимо установить дефис.
  
  Для работы функции требуется, чтобы категория языкового стандарта LC_CTYPE была установлена
  корректно. Это делается, при инициализации модуля с использованием переменных окружения. В
  системах Unix для получения дополнительной информации прочтите справочную страницу языковых
  стандартов.

<comment>Param:</comment>
  <info>resource</info>  <strong>$psdoc</strong>  Идентификатор ресурса файла postscript, возвращённый функцией <strong>ps_new()</strong>.
  <info>string</info>    <strong>$text</strong>   <strong>$text</strong> не должен содержать никаких символов, отличных от букв. Возможные позиции
                    для переносов возвращаются в виде массива целых чисел. Каждое число - это
                    позиция символа в <strong>$text</strong>, после которой может быть выполнен перенос.

<comment>Return:</comment>
  <info>array|false</info>  Массив целых чисел, указывающий положение возможных переносов в тексте или <info>false</info> в
               случае возникновения ошибки.

<comment>See Also:</comment>
   * <strong>ps_show_boxed()</strong>
   * locale(1)


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

<comment>Param:</comment>
  <info>resource</info>  <strong>$psdoc</strong>  Идентификатор ресурса файла postscript, возвращённый <strong>ps_new()</strong>.
  <info>string</info>    <strong>$file</strong>   

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


id: ps_lineto
type: function
doc:
<comment>Description:</comment>
  Рисует линию
  
  Добавляет к текущему пути прямую линию от текущей точки до заданных координат. Используйте
  <strong>ps_moveto()</strong>, чтобы установить начальную точку линии.

<comment>Param:</comment>
  <info>resource</info>  <strong>$psdoc</strong>  Идентификатор ресурса файла postscript, возвращённый функцией <strong>ps_new()</strong>.
  <info>float</info>     <strong>$x</strong>      Координата X конечной точки линии.
  <info>float</info>     <strong>$y</strong>      Координата Y конечной точки линии.

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

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


id: ps_makespotcolor
type: function
doc:
<comment>Description:</comment>
  Создаёт плашечный цвет
  
  Создаёт плашечный цвет из текущего цвета заливки. Цвет заливки должен быть определён в цветовом
  пространстве rgb, cmyk или gray. Название плашечного цвета может быть произвольным. Плашечный цвет
  может быть установлен как любой цвет с помощью <strong>ps_setcolor()</strong>. Если документ не печатается, а
  отображается программой просмотра PostScript, используется заданный цвет в указанном цветовом
  пространстве.

<comment>Param:</comment>
  <info>resource</info>  <strong>$psdoc</strong>  Идентификатор ресурса файла PostScript, возвращённый функцией <strong>ps_new()</strong>.
  <info>string</info>    <strong>$name</strong>   Название плашечного цвета, например, Pantone 5565.

<comment>Return:</comment>
  <info>int</info>  Идентификатор нового плашечного цвета или 0 в случае возникновения ошибки.

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


id: ps_moveto
type: function
doc:
<comment>Description:</comment>
  Устанавливает текущую точку
  
  Устанавливает новые координаты текущей точке. Если это первый вызов <strong>ps_moveto()</strong> после того, как
  предыдущий путь был завершён, тогда функция запустит новый путь. Если функция вызывается в
  середине пути, она просто устанавливает текущую точку и запускает дополнительный путь.

<comment>Param:</comment>
  <info>resource</info>  <strong>$psdoc</strong>  Идентификатор ресурса файла postscript, возвращённый <strong>ps_new()</strong>.
  <info>float</info>     <strong>$x</strong>      Координата X точки, в которую нужно переместиться.
  <info>float</info>     <strong>$y</strong>      Координата Y точки, в которую нужно переместиться.

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

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


id: ps_new
type: function
doc:
<comment>Description:</comment>
  Создаёт новый объект документа PostScript
  
  Создаёт новый экземпляр документа. Функция не создаёт файл на диске или в памяти, она просто все
  настраивает. За <strong>ps_new()</strong> обычно следует вызов <strong>ps_open_file()</strong> для фактического создания документа
  postscript.

<comment>Return:</comment>
  <info>resource|false</info>  Ресурс документа PostScript или <info>false</info> в случае возникновения ошибки. Возвращаемое
                  значение передаётся всем остальным функциям в качестве первого аргумента.

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


id: ps_open_file
type: function
doc:
<comment>Description:</comment>
  Открывает файл для вывода
  
  Создаёт новый файл на диске и записывает в него документ PostScript. Файл будет закрыт при вызове
  <strong>ps_close()</strong>.

<comment>Param:</comment>
  <info>resource</info>  <strong>$psdoc</strong>     Идентификатор ресурса файла postscript, возвращённый <strong>ps_new()</strong>.
  <info>string</info>    <strong>$filename</strong>  Имя файла postscript. Если <strong>$filename</strong> не передан, документ будет создан в
                       памяти и весь вывод будет идти прямо в браузер.

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

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


id: ps_open_image
type: function
doc:
<comment>Description:</comment>
  Считывает изображение для последующего размещения
  
  Считывает изображение, которое уже доступно в памяти. Параметр <strong>$source</strong> в настоящее время не
  используется и предполагается, что это <return>memory</return>. Данные изображения представляют собой
  последовательность пикселей, начинающуюся в верхнем левом углу и заканчивающуюся в правом нижнем
  углу. Каждый пиксель состоит из компонентов цвета (<strong>$components</strong>) и у каждого компонента есть биты
  <strong>$bpc</strong>.

<comment>Param:</comment>
  <info>resource</info>  <strong>$psdoc</strong>       Идентификатор ресурса файла PostScript, возвращённый функцией <strong>ps_new()</strong>.
  <info>string</info>    <strong>$type</strong>        Тип изображения. Возможные значения: <return>png</return>, <return>jpeg</return> или <return>eps</return>.
  <info>string</info>    <strong>$source</strong>      Не используется.
  <info>string</info>    <strong>$data</strong>        Данные изображения.
  <info></info>          <strong>$length</strong>      Длина данных изображения.
  <info>int</info>       <strong>$width</strong>       Ширина изображения.
  <info>int</info>       <strong>$height</strong>      Высота изображения.
  <info>int</info>       <strong>$components</strong>  Количество компонентов для каждого пикселя. Может быть: 1 (изображения в
                         градациях серого), 3 (изображения RGB) или 4 (изображения cmyk, rgba).
  <info>int</info>       <strong>$bpc</strong>         Количество бит на компонент (чаще всего 8).
  <info>string</info>    <strong>$params</strong>      

<comment>Return:</comment>
  <info>int</info>  Возвращает идентификатор изображения или ноль в случае возникновения ошибки. Идентификатор -
       положительное число больше 0.

<comment>See Also:</comment>
   * <strong>ps_open_image_file()</strong>
   * <strong>ps_place_image()</strong>
   * <strong>ps_close_image()</strong>


id: ps_open_image_file
type: function
doc:
<comment>Description:</comment>
  Открывает изображение из файла
  
  Загружает изображение для дальнейшего использования.

<comment>Param:</comment>
  <info>resource</info>  <strong>$psdoc</strong>        Идентификатор ресурса файла postscript, возвращённый <strong>ps_new()</strong>.
  <info>string</info>    <strong>$type</strong>         Тип изображения. Возможные значения: <return>png</return>, <return>jpeg</return> или <return>eps</return>.
  <info>string</info>    <strong>$filename</strong>     Имя файла, содержащего данные изображения.
  <info>string</info>    <strong>$stringparam</strong>  Параметр не используется.
  <info>int</info>       <strong>$intparam</strong>     Параметр не используется.

<comment>Return:</comment>
  <info>int</info>  Возвращает идентификатор изображения или ноль в случае возникновения ошибки. Идентификатор -
       положительное число больше 0.

<comment>See Also:</comment>
   * <strong>ps_open_image()</strong>
   * <strong>ps_place_image()</strong>
   * <strong>ps_close_image()</strong>


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

<comment>Param:</comment>
  <info>resource</info>  <strong>$psdoc</strong>  Идентификатор ресурса файла postscript, возвращённый <strong>ps_new()</strong>.
  <info>int</info>       <strong>$gd</strong>     

<comment>Return:</comment>
  <info>int</info>  


id: ps_place_image
type: function
doc:
<comment>Description:</comment>
  Размещает изображение на странице
  
  Помещает ранее загруженное изображение на страницу. Изображение можно масштабировать. Если
  изображение тоже необходимо повернуть, нужно будет сначала повернуть систему координат с помощью
  <strong>ps_rotate()</strong>.

<comment>Param:</comment>
  <info>resource</info>  <strong>$psdoc</strong>    Идентификатор ресурса файла postscript, возвращённый <strong>ps_new()</strong>.
  <info>int</info>       <strong>$imageid</strong>  Идентификатор ресурса изображения, возвращённый <strong>ps_open_image()</strong> или
                      <strong>ps_open_image_file()</strong>.
  <info>float</info>     <strong>$x</strong>        Координата X левого нижнего угла изображения.
  <info>float</info>     <strong>$y</strong>        Координата Y левого нижнего угла изображения.
  <info>float</info>     <strong>$scale</strong>    Коэффициент масштабирования изображения. Масштаб 1.0 даст разрешение 72 точки
                      на дюйм, потому что каждый пиксель эквивалентен 1 точке.

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

<comment>See Also:</comment>
   * <strong>ps_open_image()</strong>
   * <strong>ps_open_image_file()</strong>


id: ps_rect
type: function
doc:
<comment>Description:</comment>
  Рисует прямоугольник
  
  Рисует прямоугольник с нижним левым углом в точке (<strong>$x</strong>, <strong>$y</strong>). Прямоугольник начинается и
  заканчивается в нижнем левом углу. Если функция вызывается вне пути, она начинает новый путь. Если
  вызывается внутри пути, прямоугольник добавится как дополнительный путь. Если последняя операция
  рисования не заканчивается в нижнем левом углу, на пути будет разрыв.

<comment>Param:</comment>
  <info>resource</info>  <strong>$psdoc</strong>   Идентификатор ресурса файла postscript, возвращённый <strong>ps_new()</strong>.
  <info>float</info>     <strong>$x</strong>       Координата X левого нижнего угла прямоугольника.
  <info>float</info>     <strong>$y</strong>       Координата Y левого нижнего угла прямоугольника.
  <info>float</info>     <strong>$width</strong>   Ширина изображения.
  <info>float</info>     <strong>$height</strong>  Высота изображения.

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

<comment>See Also:</comment>
   * <strong>ps_arc()</strong>
   * <strong>ps_cirle()</strong>
   * <strong>ps_lineto()</strong>


id: ps_restore
type: function
doc:
<comment>Description:</comment>
  Восстанавливает ранее сохранённый контекст
  
  Восстанавливает ранее сохранённый графический контекст. Любой вызов <strong>ps_save()</strong> должен
  сопровождаться вызовом <strong>ps_restore()</strong>. Все преобразования координат, настройки стиля линий,
  настройки цвета и т.д. восстанавливаются до состояния до вызова <strong>ps_save()</strong>.

<comment>Param:</comment>
  <info>resource</info>  <strong>$psdoc</strong>  Идентификатор ресурса файла postscript, возвращённый <strong>ps_new()</strong>.

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

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


id: ps_rotate
type: function
doc:
<comment>Description:</comment>
  Устанавливает коэффициент вращения
  
  Устанавливает поворот системы координат.

<comment>Param:</comment>
  <info>resource</info>  <strong>$psdoc</strong>  Идентификатор ресурса файла postscript, возвращённый <strong>ps_new()</strong>.
  <info>float</info>     <strong>$rot</strong>    Угол поворота в градусах.

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

<comment>See Also:</comment>
   * <strong>ps_scale()</strong>
   * <strong>ps_translate()</strong>


id: ps_save
type: function
doc:
<comment>Description:</comment>
  Сохраняет текущий контекст
  
  Сохраняет текущий графический контекст, содержащий цвета, настройки перемещения, поворота и многое
  другое. Сохранённый контекст можно восстановить с помощью <strong>ps_restore()</strong>.

<comment>Param:</comment>
  <info>resource</info>  <strong>$psdoc</strong>  Идентификатор ресурса файла postscript, возвращённый <strong>ps_new()</strong>.

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

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


id: ps_scale
type: function
doc:
<comment>Description:</comment>
  Устанавливает коэффициент масштабирования
  
  Устанавливает горизонтальный и вертикальный масштаб системы координат.

<comment>Param:</comment>
  <info>resource</info>  <strong>$psdoc</strong>  Идентификатор ресурса файла postscript, возвращённый <strong>ps_new()</strong>.
  <info>float</info>     <strong>$x</strong>      Коэффициент масштабирования в горизонтальном направлении.
  <info>float</info>     <strong>$y</strong>      Коэффициент масштабирования по вертикали.

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

<comment>See Also:</comment>
   * <strong>ps_rotate()</strong>
   * <strong>ps_translate()</strong>


id: ps_set_border_color
type: function
doc:
<comment>Description:</comment>
  Устанавливает цвет границы аннотаций
  
  Ссылки, добавленные с помощью одной из функций <strong>ps_add_weblink()</strong>, <strong>ps_add_pdflink()</strong> и т.д., будут
  отображаться с закруглённым прямоугольником, когда документ PostScript преобразуется в PDF и
  просматривается в программе просмотра PDF. Этот прямоугольник не отображается в документе
  PostScript. Функция устанавливает цвет границы прямоугольника.

<comment>Param:</comment>
  <info>resource</info>  <strong>$psdoc</strong>  Идентификатор ресурса файла postscript, возвращённый <strong>ps_new()</strong>.
  <info>float</info>     <strong>$red</strong>    Красный компонент цвета границы.
  <info>float</info>     <strong>$green</strong>  Зелёный компонент цвета границы.
  <info>float</info>     <strong>$blue</strong>   Синий компонент цвета границы.

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

<comment>See Also:</comment>
   * <strong>ps_set_border_dash()</strong>
   * <strong>ps_set_border_style()</strong>


id: ps_set_border_dash
type: function
doc:
<comment>Description:</comment>
  Устанавливает длину тире для границы аннотации
  
  Ссылки, добавленные с помощью одной из функций <strong>ps_add_weblink()</strong>, <strong>ps_add_pdflink()</strong> и т.д., будут
  отображаться с закруглённым прямоугольником, когда документ PostScript преобразуется в PDF и
  просматривается в программе просмотра PDF. Этот прямоугольник не отображается в документе
  PostScript. Функция устанавливает внешний вид и ширину линии границы.

<comment>Param:</comment>
  <info>resource</info>  <strong>$psdoc</strong>  Идентификатор ресурса файла postscript, возвращённый <strong>ps_new()</strong>.
  <info>float</info>     <strong>$black</strong>  Длина чёрточки.
  <info>float</info>     <strong>$white</strong>  Длина промежутка между чёрточками.

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

<comment>See Also:</comment>
   * <strong>ps_set_border_color()</strong>
   * <strong>ps_set_border_style()</strong>


id: ps_set_border_style
type: function
doc:
<comment>Description:</comment>
  Устанавливает стиль границы аннотаций
  
  Ссылки, добавленные с помощью одной из функций <strong>ps_add_weblink()</strong>, <strong>ps_add_pdflink()</strong> и т.д., будут
  отображаться с закруглённым прямоугольником, когда документ PostScript преобразуется в PDF и
  просматривается в программе просмотра PDF. Этот прямоугольник не отображается в документе
  PostScript. Функция устанавливает внешний вид и ширину линии границы.

<comment>Param:</comment>
  <info>resource</info>  <strong>$psdoc</strong>  Идентификатор ресурса файла postscript, возвращённый <strong>ps_new()</strong>.
  <info>string</info>    <strong>$style</strong>  <strong>$style</strong> может быть <return>solid</return> или <return>dashed</return>.
  <info>float</info>     <strong>$width</strong>  Ширина линии границы.

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

<comment>See Also:</comment>
   * <strong>ps_set_border_color()</strong>
   * <strong>ps_set_border_dash()</strong>


id: ps_set_info
type: function
doc:
<comment>Description:</comment>
  Устанавливает информационные поля документа
  
  Устанавливает определённые информационные поля документа. Эти поля будут отображаться в виде
  комментария в заголовке файла PostScript. Если документ конвертируется в pdf, эти поля также будут
  использоваться для информации о документе.
  
  Для <return>BoundingBox</return> обычно устанавливается значение, присвоенное первой странице. Это работает, только
  если <strong>ps_findfont()</strong> не вызывалась раньше. В таких случаях BoundingBox не будет установлен, если вы
  не установите его явно с помощью этой функции.
  
  Функция больше не будет работать, если заголовок файла postscript уже записан. Она должна
  вызываться перед первой страницей или первым вызовом <strong>ps_findfont()</strong>.

<comment>Param:</comment>
  <info></info>        <strong>$psdoc</strong>  Идентификатор ресурса файла postscript, возвращённый функцией <strong>ps_new()</strong>.
  <info>string</info>  <strong>$key</strong>    Имя настраиваемого информационного поля. Можно установить следующие значения:
                  <return>Keywords</return>, <return>Subject</return>, <return>Title</return>, <return>Creator</return>, <return>Author</return>, <return>BoundingBox</return> и <return>Orientation</return>. Имейте в
                  виду, что некоторые из них имеют значение для программ просмотра документов
                  PostScript.
  <info></info>        <strong>$value</strong>  Значение информационного поля. Поле <return>Orientation</return> может быть установлено как
                  <return>Portrait</return> или <return>Landscape</return>. В <return>BoundingBox</return> - это строка, состоящая из четырёх чисел.
                  Первые два числа - координаты левого нижнего угла страницы. Последние два числа -
                  координаты верхнего правого угла.
                  
                  До версии 0.2.6 pslib BoundingBox и Orientation будут перезаписаны функцией
                  <strong>ps_begin_page()</strong>, если функция <strong>ps_findfont()</strong> не была вызвана ранее.

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

<comment>See Also:</comment>
   * <strong>ps_findfont()</strong>
   * <strong>ps_begin_page()</strong>


id: ps_set_parameter
type: function
doc:
<comment>Description:</comment>
  Устанавливает определённые параметры
  
  Устанавливает несколько параметров, которые используются многими функциями. Параметры по
  определению являются строковыми значениями.

<comment>Param:</comment>
  <info>resource</info>  <strong>$psdoc</strong>  Идентификатор ресурса файла postscript, возвращённый <strong>ps_new()</strong>.
  <info>string</info>    <strong>$name</strong>   Список возможных имён смотрите <strong>ps_get_parameter()</strong>.
  <info>string</info>    <strong>$value</strong>  Значение параметра.

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

<comment>See Also:</comment>
   * <strong>ps_get_parameters()</strong>
   * <strong>ps_set_value()</strong>


id: ps_set_text_pos
type: function
doc:
<comment>Description:</comment>
  Устанавливает позицию для вывода текста
  
  Устанавливает позицию для следующего вывода текста. Можно установить значения X и Y отдельно,
  вызвав <strong>ps_set_value()</strong> и выбрав <return>textx</return> или <return>texty</return> соответственно в качестве имени значения.
  
  Для вывода текста в определённом месте, удобнее использовать <strong>ps_show_xy()</strong> вместо установки позиции
  текста и вызова <strong>ps_show()</strong>.

<comment>Param:</comment>
  <info>resource</info>  <strong>$psdoc</strong>  Идентификатор ресурса файла postscript, возвращённый функцией <strong>ps_new()</strong>.
  <info>float</info>     <strong>$x</strong>      Координата X новой позиции текста.
  <info>float</info>     <strong>$y</strong>      Координата Y новой позиции текста.

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

<comment>See Also:</comment>
   * <strong>ps_set_value()</strong>
   * <strong>ps_show()</strong>


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

<comment>Param:</comment>
  <info>resource</info>  <strong>$psdoc</strong>  Идентификатор ресурса файла postscript, возвращённый <strong>ps_new()</strong>.
  <info>string</info>    <strong>$name</strong>   Значение <strong>$name</strong> может быть одно из следующего: textrendering Способ отображения
                    текста. textx Координата X для вывода текста. texty Координата Y для вывода
                    текста. wordspacing Расстояние между словами относительно ширины пробела.
                    leading Расстояние между строками в пикселях.
                    
                    Способ отображения текста.
                    
                    Координата X для вывода текста.
                    
                    Координата Y для вывода текста.
                    
                    Расстояние между словами относительно ширины пробела.
                    
                    Расстояние между строками в пикселях.
  <info>float</info>     <strong>$value</strong>  Значение параметра.

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

<comment>See Also:</comment>
   * <strong>ps_get_value()</strong>
   * <strong>ps_set_parameter()</strong>


id: ps_setcolor
type: function
doc:
<comment>Description:</comment>
  Устанавливает текущий цвет
  
  Устанавливает цвет для рисования, заливки или и того и другого.

<comment>Param:</comment>
  <info>resource</info>  <strong>$psdoc</strong>       Идентификатор ресурса файла PostScript, возвращённый функцией <strong>ps_new()</strong>.
  <info>string</info>    <strong>$type</strong>        Параметр <strong>$type</strong> может быть: <return>both</return>, <return>fill</return> или <return>fillstroke</return>.
  <info>string</info>    <strong>$colorspace</strong>  Цветовое пространство должно быть одним из: <return>gray</return>, <return>rgb</return>, <return>cmyk</return>, <return>spot</return>, <return>pattern</return>.
                         В зависимости от цветового пространства будут использоваться только первый,
                         первые три или все параметры.
  <info>float</info>     <strong>$c1</strong>          В зависимости от цветового пространства параметр может принимать значение:
                         красный компонент (rgb), голубой компонент (cmyk), значение серого (gray),
                         идентификатор плашечного цвета или идентификатор шаблона.
  <info>float</info>     <strong>$c2</strong>          В зависимости от цветового пространства параметр может принимать значение:
                         либо зелёный компонент (rgb), либо пурпурный компонент (cmyk).
  <info>float</info>     <strong>$c3</strong>          В зависимости от цветового пространства параметр может принимать значение:
                         либо синий компонент (rgb), либо жёлтый компонент (cmyk).
  <info>float</info>     <strong>$c4</strong>          Должно быть установлено только в цветовом пространстве cmyk, указывается
                         чёрный компонент.

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


id: ps_setdash
type: function
doc:
<comment>Description:</comment>
  Устанавливает внешний вид пунктирной линии
  
  Устанавливает длину чёрных и белых частей пунктирной линии.

<comment>Param:</comment>
  <info>resource</info>  <strong>$psdoc</strong>  Идентификатор ресурса файла postscript, возвращённый <strong>ps_new()</strong>.
  <info>float</info>     <strong>$on</strong>     Длина чёрточки.
  <info>float</info>     <strong>$off</strong>    Длина промежутка между чёрточками.

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

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


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

<comment>Param:</comment>
  <info>resource</info>  <strong>$psdoc</strong>  Идентификатор ресурса файла postscript, возвращённый <strong>ps_new()</strong>.
  <info>float</info>     <strong>$value</strong>  <strong>$value</strong> должно быть между 0.2 и 1.

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


id: ps_setfont
type: function
doc:
<comment>Description:</comment>
  Устанавливает шрифт, который будет использоваться для следующего вывода
  
  Устанавливает шрифт, который должен быть загружен раньше с помощью <strong>ps_findfont()</strong>. Вывод текста без
  установки шрифта приводит к ошибке.

<comment>Param:</comment>
  <info>resource</info>  <strong>$psdoc</strong>   Идентификатор ресурса файла postscript, возвращённый <strong>ps_new()</strong>.
  <info>int</info>       <strong>$fontid</strong>  Идентификатор шрифта, возвращённый <strong>ps_findfont()</strong>.
  <info>float</info>     <strong>$size</strong>    Размер шрифта.

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

<comment>See Also:</comment>
   * <strong>ps_findfont()</strong>
   * <strong>ps_set_text_pos()</strong> для примера.


id: ps_setgray
type: function
doc:
<comment>Description:</comment>
  Устанавливает значение серого
  
  Устанавливает значение серого для всех последующих операций рисования.

<comment>Param:</comment>
  <info>resource</info>  <strong>$psdoc</strong>  Идентификатор ресурса файла postscript, возвращённый <strong>ps_new()</strong>.
  <info>float</info>     <strong>$gray</strong>   Значение должно быть от 0 (белый) до 1 (чёрный).

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

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


id: ps_setlinecap
type: function
doc:
<comment>Description:</comment>
  Устанавливает внешний вид окончания линии
  
  Устанавливает внешний вид окончания линии.

<comment>Param:</comment>
  <info>resource</info>  <strong>$psdoc</strong>  Идентификатор ресурса файла postscript, возвращённый <strong>ps_new()</strong>.
  <info>int</info>       <strong>$type</strong>   Тип окончания линии. Возможные значения: <return>PS_LINECAP_BUTT</return>, <return>PS_LINECAP_ROUND</return> или
                    <return>PS_LINECAP_SQUARED</return>.

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

<comment>See Also:</comment>
   * <strong>ps_setlinejoin()</strong>
   * <strong>ps_setlinewidth()</strong>
   * <strong>ps_setmiterlimit()</strong>


id: ps_setlinejoin
type: function
doc:
<comment>Description:</comment>
  Устанавливает способ соединения линий
  
  Устанавливает способ соединения линий.

<comment>Param:</comment>
  <info>resource</info>  <strong>$psdoc</strong>  Идентификатор ресурса файла postscript, возвращённый <strong>ps_new()</strong>.
  <info>int</info>       <strong>$type</strong>   Способ соединения линий. Возможные значения: <return>PS_LINEJOIN_MITER</return>,
                    <return>PS_LINEJOIN_ROUND</return> или <return>PS_LINEJOIN_BEVEL</return>.

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

<comment>See Also:</comment>
   * <strong>ps_setlinecap()</strong>
   * <strong>ps_setlinewidth()</strong>
   * <strong>ps_setmiterlimit()</strong>


id: ps_setlinewidth
type: function
doc:
<comment>Description:</comment>
  Устанавливает ширину линии
  
  Устанавливает ширину линии для всех последующих операций рисования.

<comment>Param:</comment>
  <info>resource</info>  <strong>$psdoc</strong>  Идентификатор ресурса файла postscript, возвращённый <strong>ps_new()</strong>.
  <info>float</info>     <strong>$width</strong>  Ширина линий в точках.

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

<comment>See Also:</comment>
   * <strong>ps_setlinecap()</strong>
   * <strong>ps_setlinejoin()</strong>
   * <strong>ps_setmiterlimit()</strong>


id: ps_setmiterlimit
type: function
doc:
<comment>Description:</comment>
  Устанавливает предел скоса
  
  Если две линии соединяются под небольшим углом, а для соединения линий установлено значение
  <return>PS_LINEJOIN_MITER</return>, то результирующий выступ будет очень длинным. Предел скоса - это максимальное
  соотношение длины скоса (длины выступа) и ширины линии.

<comment>Param:</comment>
  <info>resource</info>  <strong>$psdoc</strong>  Идентификатор ресурса файла postscript, возвращённый функцией <strong>ps_new()</strong>.
  <info>float</info>     <strong>$value</strong>  Максимальное соотношение между длиной скоса и шириной линии. Большие значения
                    (&gt; 10) приведут к очень длинным выступам, если две линии пересекаются под
                    небольшим углом. Оставьте значение по умолчанию, если вы не уверены в том, что
                    делаете.

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

<comment>See Also:</comment>
   * <strong>ps_setlinecap()</strong>
   * <strong>ps_setlinejoin()</strong>
   * <strong>ps_setlinewidth()</strong>


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

<comment>Param:</comment>
  <info>resource</info>  <strong>$psdoc</strong>  Идентификатор ресурса файла postscript, возвращённый <strong>ps_new()</strong>.
  <info>int</info>       <strong>$mode</strong>   

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


id: ps_setpolydash
type: function
doc:
<comment>Description:</comment>
  Устанавливает внешний вид пунктирной линии
  
  Устанавливает длину чёрных и белых частей пунктирной линии. <strong>ps_setpolydash()</strong> используется для
  установки более сложных шаблонов тире.

<comment>Param:</comment>
  <info>resource</info>  <strong>$psdoc</strong>  Идентификатор ресурса файла postscript, возвращённый <strong>ps_new()</strong>.
  <info>float</info>     <strong>$arr</strong>    <strong>$arr</strong> - это список элементов длины поочерёдно для чёрной и белой части.

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

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


id: ps_shading
type: function
doc:
<comment>Description:</comment>
  Создаёт затенение для последующего использования
  
  Создаёт затенение, которое может использоваться функцией <strong>ps_shfill()</strong> или <strong>ps_shading_pattern()</strong>.
  
  Цвет затенения может быть в любом цветовом пространстве, кроме <return>pattern</return>.

<comment>Param:</comment>
  <info>resource</info>  <strong>$psdoc</strong>           Идентификатор ресурса файла postscript, возвращённый функцией <strong>ps_new()</strong>.
  <info>string</info>    <strong>$type</strong>            Тип затенения может быть <return>radial</return> или <return>axial</return>. Каждое затенение начинается
                             с текущего цвета заливки и заканчивается заданными значениями цвета,
                             переданными в параметрах от <strong>$c1</strong> до <strong>$c4</strong> (описание их значений смотрите в
                             <strong>ps_setcolor()</strong>).
  <info></info>          <strong>$x0, x1, y0, y1</strong>  Координаты <strong>$x0</strong>, <strong>$y0</strong>, <strong>$x1</strong>, <strong>$y1</strong> - это начальная и конечная точки
                             затенения. Если тип затенения - <return>radial</return>, две точки являются средними
                             точками начальной и конечной окружностей.
  <info></info>          <strong>$c1, c2, c3, c4</strong>  Смотрите описание их значений в <strong>ps_setcolor()</strong>.
  <info>string</info>    <strong>$optlist</strong>         Если тип затенения <return>radial</return>, <strong>$optlist</strong> также должен содержать параметры <return>r0</return>
                             и <return>r1</return> с радиусом начального и конечного круга.

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

<comment>See Also:</comment>
   * <strong>ps_shading_pattern()</strong>
   * <strong>ps_shfill()</strong>


id: ps_shading_pattern
type: function
doc:
<comment>Description:</comment>
  Создаёт узор на основе затенения
  
  Создаёт узор на основе затенения, которое должно быть создано ранее с помощью <strong>ps_shading()</strong>.
  Шаблоны затенения можно использовать как обычные шаблоны.

<comment>Param:</comment>
  <info>resource</info>  <strong>$psdoc</strong>      Идентификатор ресурса файла postscript, возвращённый <strong>ps_new()</strong>.
  <info>int</info>       <strong>$shadingid</strong>  Идентификатор затенения, ранее созданного с помощью <strong>ps_shading()</strong>.
  <info>string</info>    <strong>$optlist</strong>    Аргумент в настоящее время не используется.

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

<comment>See Also:</comment>
   * <strong>ps_shading()</strong>
   * <strong>ps_shfill()</strong>


id: ps_shfill
type: function
doc:
<comment>Description:</comment>
  Заполняет область затенением
  
  Заполняет область затенением, которое должно быть создано ранее с помощью <strong>ps_shading()</strong>. Это
  альтернативный способ создания узора из затенения <strong>ps_shading_pattern()</strong> и использования узора в
  качестве цвета заливки.

<comment>Param:</comment>
  <info>resource</info>  <strong>$psdoc</strong>      Идентификатор ресурса файла postscript, возвращённый <strong>ps_new()</strong>.
  <info>int</info>       <strong>$shadingid</strong>  Идентификатор затенения, ранее созданного с помощью <strong>ps_shading()</strong>.

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

<comment>See Also:</comment>
   * <strong>ps_shading()</strong>
   * <strong>ps_shading_pattern()</strong>


id: ps_show
type: function
doc:
<comment>Description:</comment>
  Выводит текст
  
  Выводит текст в текущей позиции. Положение текста можно установить, erfpfd координаты X и Y в
  значениях <return>textx</return> и <return>texty</return> с помощью функции <strong>ps_set_value()</strong>. Функция выдаст ошибку, если шрифт не был
  установлен ранее с помощью <strong>ps_setfont()</strong>.
  
  Функция <strong>ps_show()</strong> оценивает следующие параметры и значения, установленные <strong>ps_set_parameter()</strong> и
  <strong>ps_set_value()</strong>.
  
  Расстояние между двумя последовательными глифами. Если это значение не равно нулю, все лигатуры
  будут разрешены. Допускаются значения меньше нуля.
  
  Установка параметру значения "false" отключит кернинг. По умолчанию кернинг включён.
  
  Установка параметру значения "false" отключит использование лигатур. По умолчанию лигатуры
  включены.
  
  Установка параметру значения "true" включит подчёркивание. По умолчанию подчёркивание отключено.
  
  Установка параметру значения "true" включит наложение. Наложение по умолчанию отключено.
  
  Установка параметру значения "true" включит зачёркивание. По умолчанию зачёркивание отключено.

<comment>Param:</comment>
  <info>resource</info>  <strong>$psdoc</strong>  Идентификатор ресурса файла postscript, возвращённый функцией <strong>ps_new()</strong>.
  <info>string</info>    <strong>$text</strong>   Текст для вывода.

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

<comment>See Also:</comment>
   * <strong>ps_continue_text()</strong>
   * <strong>ps_show_xy()</strong>
   * <strong>ps_setfont()</strong>


id: ps_show2
type: function
doc:
<comment>Description:</comment>
  Выводит текст в текущей позиции
  
  Выводит текст в текущей позиции. Не выводит более <strong>$len</strong> символов.

<comment>Param:</comment>
  <info>resource</info>  <strong>$psdoc</strong>  Идентификатор ресурса файла postscript, возвращённый <strong>ps_new()</strong>.
  <info>string</info>    <strong>$text</strong>   Текст для вывода.
  <info>int</info>       <strong>$len</strong>    Максимальное количество символов для вывода.

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


id: ps_show_boxed
type: function
doc:
<comment>Description:</comment>
  Выводит текст в поле
  
  Выводит текст в заданном поле. Нижний левый угол поля находится в (<strong>$left</strong>, <strong>$bottom</strong>). При
  необходимости будут вставлены разрывы строк. Несколько пробелов рассматриваются как один.
  Табуляторы рассматриваются как пробелы.
  
  Текст будет переноситься через дефис, если для параметра <strong>$hyphenation</strong> установлено значение <info>true</info>, а
  параметр <strong>$hyphendict</strong> содержит допустимое имя файла для файла расстановки переносов. Межстрочный
  интервал берётся из значения <return>leading</return>. Абзацы можно разделять пустой строкой, как в TeX. Если для
  параметра <return>parindent</return> установлено значение &gt; 0.0, то первые n строк будут с отступом. Количество
  строк n задаётся параметром <return>numindentlines</return>. Чтобы предотвратить отступ первых m абзацев,
  установите положительное число значением параметра <return>parindentkip</return>.

<comment>Param:</comment>
  <info>resource</info>  <strong>$psdoc</strong>       Идентификатор ресурса файла postscript, возвращённый функцией <strong>ps_new()</strong>.
  <info>string</info>    <strong>$text</strong>        Текст, который нужно вывести в данное поле.
  <info>float</info>     <strong>$left</strong>        Координата X левого нижнего угла поля.
  <info>float</info>     <strong>$bottom</strong>      Координата Y левого нижнего угла поля.
  <info>float</info>     <strong>$width</strong>       Ширина поля.
  <info>float</info>     <strong>$height</strong>      Высота поля.
  <info>string</info>    <strong>$hmode</strong>       Параметр <strong>$hmode</strong> может быть <return>fulljustify</return>, <return>right</return>, <return>left</return> или <return>center</return>. Разница
                         между <return>justify</return> и <return>fulljustify</return> влияет только на последнюю строку поля. В
                         режиме <return>fulljustify</return> последняя строка будет выровнена по левому и правому
                         краю, если только это не последняя строка абзаца. В режиме <return>justify</return> она
                         всегда будет выровнена по левому краю.
  <info>string</info>    <strong>$feature</strong>     
  <info></info>          <strong>$hyphendict</strong>  Установите значение <info>true</info>, чтобы включить расстановку переносов. Для этого
                         требуется, чтобы словарь был установлен с параметром <strong>$hyphendict</strong>. По
                         умолчанию <info>false</info>.

<comment>Return:</comment>
  <info>int</info>  Количество символов, которые не удалось записать.

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


id: ps_show_xy
type: function
doc:
<comment>Description:</comment>
  Выводит текст в заданной позиции
  
  Выводит текст в заданной текстовой позиции.

<comment>Param:</comment>
  <info>resource</info>  <strong>$psdoc</strong>  Идентификатор ресурса файла postscript, возвращённый <strong>ps_new()</strong>.
  <info>string</info>    <strong>$text</strong>   Текст для вывода.
  <info>float</info>     <strong>$x</strong>      Координата X левого нижнего угла поля, окружающего текст.
  <info>float</info>     <strong>$y</strong>      Координата Y левого нижнего угла поля, окружающего текст.

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

<comment>See Also:</comment>
   * <strong>ps_continue_text()</strong>
   * <strong>ps_show()</strong>


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

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


id: ps_string_geometry
type: function
doc:
<comment>Description:</comment>
  Получает геометрию строки
  
  Функция похожа на <strong>ps_stringwidth()</strong>, но возвращает массив размеров, содержащий ширину, верхнюю и
  нижнюю границу текста.

<comment>Param:</comment>
  <info>resource</info>  <strong>$psdoc</strong>   Идентификатор ресурса файла postscript, возвращённый функцией <strong>ps_new()</strong>.
  <info>string</info>    <strong>$text</strong>    Текст, для которого должна быть рассчитана геометрия.
  <info>int</info>       <strong>$fontid</strong>  Идентификатор используемого шрифта. Если шрифт не указан, используется текущий
                     шрифт.
  <info>float</info>     <strong>$size</strong>    Размер шрифта. Если размер не указан, используется текущий размер.

<comment>Return:</comment>
  <info>array</info>  Массив размеров строки. Элемент "width" содержит ширину строки, возвращаемую функцией
         <strong>ps_stringwidth()</strong>. Элемент "descender" содержит максимальную нижнюю границу, а "ascender" -
         максимальную верхнюю границу элемента строки.

<comment>See Also:</comment>
   * <strong>ps_continue_text()</strong>
   * <strong>ps_stringwidth()</strong>


id: ps_stringwidth
type: function
doc:
<comment>Description:</comment>
  Получает ширину строки
  
  Вычисляет ширину строки в пунктах, если бы она выводилась с заданным шрифтом и размером шрифта.
  Функции необходим файл метрик шрифтов Adobe для расчёта точной ширины. Если интервал между буквами
  включён, он также будет учтён.

<comment>Param:</comment>
  <info>resource</info>  <strong>$psdoc</strong>   Идентификатор ресурса файла postscript, возвращённый функцией <strong>ps_new()</strong>.
  <info>string</info>    <strong>$text</strong>    Текст, для которого нужно рассчитать ширину.
  <info>int</info>       <strong>$fontid</strong>  Идентификатор используемого шрифта. Если шрифт не указан, используется текущий
                     шрифт.
  <info>float</info>     <strong>$size</strong>    Размер шрифта. Если размер не указан, используется текущий размер.

<comment>Return:</comment>
  <info>float</info>  Ширина строки в пунктах.

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


id: ps_stroke
type: function
doc:
<comment>Description:</comment>
  Рисует текущий путь
  
  Рисует путь, построенный с помощью ранее вызванных функций рисования, таких как <strong>ps_lineto()</strong>.

<comment>Param:</comment>
  <info>resource</info>  <strong>$psdoc</strong>  Идентификатор ресурса файла postscript, возвращённый <strong>ps_new()</strong>.

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

<comment>See Also:</comment>
   * <strong>ps_closepath_stroke()</strong>
   * <strong>ps_fill()</strong>
   * <strong>ps_fill_stroke()</strong>


id: ps_symbol
type: function
doc:
<comment>Description:</comment>
  Выводит глиф
  
  Выводит глиф в позиции <strong>$ord</strong> в векторе кодировки текущего шрифта. Кодировку шрифта можно установить
  при загрузке шрифта с помощью <strong>ps_findfont()</strong>.

<comment>Param:</comment>
  <info>resource</info>  <strong>$psdoc</strong>  Идентификатор ресурса файла postscript, возвращённый <strong>ps_new()</strong>.
  <info>int</info>       <strong>$ord</strong>    Положение глифа в векторе кодировки шрифта.

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

<comment>See Also:</comment>
   * <strong>ps_symbol_name()</strong>
   * <strong>ps_symbol_width()</strong>


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

<comment>Param:</comment>
  <info>resource</info>  <strong>$psdoc</strong>   Идентификатор ресурса файла postscript, возвращённый <strong>ps_new()</strong>.
  <info>int</info>       <strong>$ord</strong>     Параметр <strong>$ord</strong> - это позиция глифа в векторе кодировки шрифта.
  <info>int</info>       <strong>$fontid</strong>  Идентификатор используемого шрифта. Если шрифт не указан, будет использоваться
                     текущий шрифт.

<comment>Return:</comment>
  <info>string</info>  Имя глифа в заданном шрифте.

<comment>See Also:</comment>
   * <strong>ps_symbol()</strong>
   * <strong>ps_symbol_width()</strong>


id: ps_symbol_width
type: function
doc:
<comment>Description:</comment>
  Получает ширину глифа
  
  Вычисляет ширину глифа в точках, если он был выведен с заданным шрифтом и размером шрифта. Функции
  необходим файл метрик шрифтов Adobe для расчёта точной ширины.

<comment>Param:</comment>
  <info>resource</info>  <strong>$psdoc</strong>   Идентификатор ресурса файла postscript, возвращённый <strong>ps_new()</strong>.
  <info>int</info>       <strong>$ord</strong>     Положение глифа в векторе кодировки шрифта.
  <info>int</info>       <strong>$fontid</strong>  Идентификатор используемого шрифта. Если шрифт не указан, будет использоваться
                     текущий шрифт.
  <info>float</info>     <strong>$size</strong>    Размер шрифта. Если размер не указан, используется текущий размер.

<comment>Return:</comment>
  <info>float</info>  Ширина глифа в точках.

<comment>See Also:</comment>
   * <strong>ps_symbol()</strong>
   * <strong>ps_symbol_name()</strong>


id: ps_translate
type: function
doc:
<comment>Description:</comment>
  Изменяет систему координат
  
  Устанавливает новую начальную точку системы координат.

<comment>Param:</comment>
  <info>resource</info>  <strong>$psdoc</strong>  Идентификатор ресурса файла postscript, возвращённый функцией <strong>ps_new()</strong>.
  <info>float</info>     <strong>$x</strong>      Координата X начала изменённой системы координат.
  <info>float</info>     <strong>$y</strong>      Координата Y начала изменённой системы координат.

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

<comment>See Also:</comment>
   * <strong>ps_scale()</strong>
   * <strong>ps_rotate()</strong>


id: pspell_add_to_personal
type: function
doc:
<comment>Description:</comment>
  Добавляет слово в персональный список слов
  
  <strong>pspell_add_to_personal()</strong> добавляет слово в персональный список слов. Если вы использовали
  <strong>pspell_new_config()</strong> вместе с <strong>pspell_config_personal()</strong> для открытия словаря, вы можете сохранить
  список слов позднее с помощью <strong>pspell_save_wordlist()</strong>.

<comment>Param:</comment>
  <info>PSpell\Dictionary</info>  <strong>$dictionary</strong>  Экземпляр <class>PSpell\Dictionary</class>.
  <info>string</info>             <strong>$word</strong>        Добавляемое слово.

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


id: pspell_add_to_session
type: function
doc:
<comment>Description:</comment>
  Добавляет слово в список слов в текущей сессии
  
  <strong>pspell_add_to_session()</strong> добавляет слово в список слов, ассоциированный с текущей сессией. Эта
  функция очень похожа на функцию <strong>pspell_add_to_personal()</strong>

<comment>Param:</comment>
  <info>PSpell\Dictionary</info>  <strong>$dictionary</strong>  Экземпляр <class>PSpell\Dictionary</class>.
  <info>string</info>             <strong>$word</strong>        Добавляемое слово.

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


id: pspell_check
type: function
doc:
<comment>Description:</comment>
  Проверяет слово
  
  <strong>pspell_check()</strong> проверяет орфографию слова.

<comment>Param:</comment>
  <info>PSpell\Dictionary</info>  <strong>$dictionary</strong>  Экземпляр <class>PSpell\Dictionary</class>.
  <info>string</info>             <strong>$word</strong>        Проверяемое слово.

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


id: pspell_clear_session
type: function
doc:
<comment>Description:</comment>
  Очищает текущую сессию
  
  <strong>pspell_clear_session()</strong> очищает текущую сессию. Текущий список слов очищается, и, например, если
  попытаться сохранить его с помощью <strong>pspell_save_wordlist()</strong>, ничего не произойдёт.

<comment>Param:</comment>
  <info>PSpell\Dictionary</info>  <strong>$dictionary</strong>  Экземпляр <class>PSpell\Dictionary</class>.

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


id: pspell_config_create
type: function
doc:
<comment>Description:</comment>
  Создаёт конфигурацию, используемую для открытия словаря
  
  Создаёт конфигурацию, используемую для открытия словаря.
  
  <strong>pspell_config_create()</strong> обладает синтаксисом, очень похожим на синтаксис <strong>pspell_new()</strong>. Фактически,
  использование <strong>pspell_config_create()</strong> сразу после <strong>pspell_new_config()</strong> даст точно такой же
  результат. Однако, после создания новой конфигурации, также можно использовать функции
  <strong>pspell_config_*()</strong> до вызова <strong>pspell_new_config()</strong> для получения преимуществ от некоторой
  дополнительной функциональности.
  
  Более подробную информацию и примеры можно найти в руководстве по pspell на
  сайте:http://aspell.net/.

<comment>Param:</comment>
  <info>string</info>  <strong>$language</strong>  Параметр language - это код языка, который состоит из двухбуквенного кода языка
                     по стандарту ISO 639 и необязательного двубуквенного кода страны по стандарту
                     ISO 3166 после тире или подчёркивания.
  <info>string</info>  <strong>$spelling</strong>  Параметр spelling определяет вариант проверки орфографии для языков с более чем
                     одним вариантом правописания, таких как английский. Известные значения:
                     'american', 'british', и 'canadian'.
  <info>string</info>  <strong>$jargon</strong>    Параметр jargon содержит дополнительную информацию для различения двух
                     различных списков слов, имеющих одинаковые параметры language и spelling.
  <info>string</info>  <strong>$encoding</strong>  Параметр encoding - это кодировка, в которой, как ожидается, даны слова.
                     Допустимые значения: 'utf-8', 'iso8859-*', 'koi8-r', 'viscii', 'cp1252',
                     'machine unsigned 16', 'machine unsigned 32'. Это параметр ещё не проверен
                     достаточно хорошо, поэтому будьте осторожны при его использовании.

<comment>Return:</comment>
  <info>PSpell\Config</info>  Возвращает экземпляр <class>PSpell\Config</class>.


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

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


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

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


id: pspell_config_ignore
type: function
doc:
<comment>Description:</comment>
  Игнорирует слова длиной менее N символов
  
  <strong>pspell_config_ignore()</strong> должна быть использована для конфигурации до вызова <strong>pspell_new_config()</strong>.
  Эта функция позволяет пропускать короткие слова при проверке орфографии.

<comment>Param:</comment>
  <info>PSpell\Config</info>  <strong>$config</strong>      Экземпляр <class>PSpell\Config</class>.
  <info>int</info>            <strong>$min_length</strong>  Слова длиной менее <strong>$min_length</strong> символов будут пропущены.

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


id: pspell_config_mode
type: function
doc:
<comment>Description:</comment>
  Изменяет режим количества возвращаемых вариантов исправления
  
  <strong>pspell_config_mode()</strong> должна быть использована для конфигурации до вызова <strong>pspell_new_config()</strong>. Эта
  функция определяет, сколько вариантов исправления будет возвращать функция <strong>pspell_suggest()</strong>.

<comment>Param:</comment>
  <info>PSpell\Config</info>  <strong>$config</strong>  Экземпляр <class>PSpell\Config</class>.
  <info>int</info>            <strong>$mode</strong>    Параметр mode - это режим, в котором будет работать проверка орфографии.
                          Доступно несколько режимов: <info>PSPELL_FAST</info> - Быстрый режим (наименьшее число
                          вариантов исправления) <info>PSPELL_NORMAL</info> - Нормальный режим (больше вариантов
                          исправления) <info>PSPELL_BAD_SPELLERS</info> - Медленный режим (много вариантов
                          исправления)
                          
                          <info>PSPELL_FAST</info> - Быстрый режим (наименьшее число вариантов исправления)
                          
                          <info>PSPELL_NORMAL</info> - Нормальный режим (больше вариантов исправления)
                          
                          <info>PSPELL_BAD_SPELLERS</info> - Медленный режим (много вариантов исправления)

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


id: pspell_config_personal
type: function
doc:
<comment>Description:</comment>
  Устанавливает файл, содержащий персональный список слов
  
  Устанавливает файл, содержащий персональный список слов. Персональный список слов будет загружен и
  использован в дополнение к стандартному после того, как вы вызовете <strong>pspell_new_config()</strong>. Это тот
  же самый файл, в который функция <strong>pspell_save_wordlist()</strong> сохранит персональный список слов.
  
  <strong>pspell_config_personal()</strong> должна быть использована для конфигурации до вызова <strong>pspell_new_config()</strong>.

<comment>Param:</comment>
  <info>PSpell\Config</info>  <strong>$config</strong>    Экземпляр <class>PSpell\Config</class>.
  <info>string</info>         <strong>$filename</strong>  Персональный список слов. Если файл не существует, он будет создан. Файл
                            должен быть доступен для записи любому, кто запускает PHP (например,
                            nobody).

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


id: pspell_config_repl
type: function
doc:
<comment>Description:</comment>
  Устанавливает файл, содержащий замещающие пары
  
  Устанавливает файл, содержащий замещающие пары.
  
  Замещающие пары повышают качество проверки орфографии. Когда слово написано с ошибками, а
  правильный вариант не найден в списке, <strong>pspell_store_replacement()</strong> может быть использована для
  того, чтобы сохранить замещающую пару, а <strong>pspell_save_wordlist()</strong> - чтобы сохранить список слов
  вместе с замещающими парами.
  
  <strong>pspell_config_repl()</strong> должна быть использована для конфигурации до вызова <strong>pspell_new_config()</strong>.

<comment>Param:</comment>
  <info>PSpell\Config</info>  <strong>$config</strong>    Экземпляр <class>PSpell\Config</class>.
  <info>string</info>         <strong>$filename</strong>  Файл должен быть доступен для записи любому, кто запускает PHP
                            (например, nobody).

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


id: pspell_config_runtogether
type: function
doc:
<comment>Description:</comment>
  Рассматривает объединённые слова как правильные сложные слова
  
  Функция определяет, будут ли объединённые слова рассматриваться как правильные сложные слова. Так,
  "thecat" будет считаться правильным сложным словом, хотя между артиклем и словом должен быть
  пробел. Изменение этой установки влияет только на результаты, возвращаемые функцией
  <strong>pspell_check()</strong>; <strong>pspell_suggest()</strong> будет продолжать выдавать варианты исправления.
  
  <strong>pspell_config_runtogether()</strong> должна быть использована для конфигурации до вызова
  <strong>pspell_new_config()</strong>.

<comment>Param:</comment>
  <info>PSpell\Config</info>  <strong>$config</strong>  Экземпляр <class>PSpell\Config</class>.
  <info>bool</info>           <strong>$allow</strong>   <info>true</info>, если объединённые слова должны рассматриваться как правильные
                          сложные слова, <info>false</info> в противном случае.

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


id: pspell_config_save_repl
type: function
doc:
<comment>Description:</comment>
  Определяет, сохранять ли список замещающих пар
    вместе со списком слов
  
  <strong>pspell_config_save_repl()</strong> определяет, будет ли <strong>pspell_save_wordlist()</strong> сохранять замещающие пары
  вместе со списком слов. Обычно нет необходимости использовать эту функцию, поскольку, если
  используется <strong>pspell_config_repl()</strong>, замещающие пары будут сохранены <strong>pspell_save_wordlist()</strong> в любом
  случае, и, если она не используется, замещающие пары не будут сохраняться.
  
  <strong>pspell_config_save_repl()</strong> должна быть использована для конфигурации до вызова <strong>pspell_new_config()</strong>.

<comment>Param:</comment>
  <info>PSpell\Config</info>  <strong>$config</strong>  Экземпляр <class>PSpell\Config</class>.
  <info>bool</info>           <strong>$save</strong>    <info>true</info>, если замещающие пары должны сохраняться, <info>false</info> в противном случае.

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


id: pspell_new
type: function
doc:
<comment>Description:</comment>
  Загружает новый словарь
  
  <strong>pspell_new()</strong> открывает новый словарь и возвращает экземпляр <class>PSpell\Dictionary</class> для использования в
  других функциях pspell.
  
  Более подробную информацию и примеры можно найти в руководстве по pspell на
  сайте:http://aspell.net/.

<comment>Param:</comment>
  <info>string</info>  <strong>$language</strong>  Параметр language - это код языка, который состоит из двухбуквенного кода языка
                     по стандарту ISO 639 и необязательного двубуквенного кода страны по стандарту
                     ISO 3166 после тире или подчёркивания.
  <info>string</info>  <strong>$spelling</strong>  Параметр spelling определяет вариант проверки орфографии для языков с более чем
                     одним вариантом правописания, таких как английский. Известные значения:
                     'american', 'british', и 'canadian'.
  <info>string</info>  <strong>$jargon</strong>    Параметр jargon содержит дополнительную информацию для различения двух
                     различных списков слов, имеющих одинаковые параметры language и spelling.
  <info>string</info>  <strong>$encoding</strong>  Параметр encoding это кодировка, в которой, как ожидается, даны слова.
                     Допустимые значения: 'utf-8', 'iso8859-*', 'koi8-r', 'viscii', 'cp1252',
                     'machine unsigned 16', 'machine unsigned 32'. Этот параметр ещё не проверен
                     достаточно хорошо, поэтому будьте осторожны при его использовании.
  <info>int</info>     <strong>$mode</strong>      Параметр mode - это режим, в котором будет работать проверка орфографии.
                     Доступно несколько режимов: <info>PSPELL_FAST</info> - Быстрый режим (наименьшее число
                     вариантов исправления) <info>PSPELL_NORMAL</info> - Нормальный режим (больше вариантов
                     исправления) <info>PSPELL_BAD_SPELLERS</info> - Медленный режим (много вариантов
                     исправления) <info>PSPELL_RUN_TOGETHER</info> - рассматривает объединённые слова как
                     правильные сложные слова. То есть, "thecat" будет считаться правильным сложным
                     словом, хотя между артиклем и словом должен быть пробел. Изменение этой
                     установки влияет только на результаты, возвращаемые функцией <strong>pspell_check()</strong>;
                     <strong>pspell_suggest()</strong> будет продолжать выдавать варианты исправления.  Mode - это
                     битовая маска, сконструированная из различных перечисленных выше констант.
                     Однако, <info>PSPELL_FAST</info>, <info>PSPELL_NORMAL</info> и <info>PSPELL_BAD_SPELLERS</info> являются
                     взаимоисключающими, так что вы должны выбрать только одну из них.
                     
                     <info>PSPELL_FAST</info> - Быстрый режим (наименьшее число вариантов исправления)
                     
                     <info>PSPELL_NORMAL</info> - Нормальный режим (больше вариантов исправления)
                     
                     <info>PSPELL_BAD_SPELLERS</info> - Медленный режим (много вариантов исправления)
                     
                     <info>PSPELL_RUN_TOGETHER</info> - рассматривает объединённые слова как правильные сложные
                     слова. То есть, "thecat" будет считаться правильным сложным словом, хотя между
                     артиклем и словом должен быть пробел. Изменение этой установки влияет только на
                     результаты, возвращаемые функцией <strong>pspell_check()</strong>; <strong>pspell_suggest()</strong> будет
                     продолжать выдавать варианты исправления.

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


id: pspell_new_config
type: function
doc:
<comment>Description:</comment>
  Загружает новый словарь с установками на основе заданной конфигурации
    
  
  <strong>pspell_new_config()</strong> открывает новый словарь с параметрами, заданными в <strong>$config</strong>, созданной с
  помощью <strong>pspell_config_create()</strong> и модифицированной с помощью функций <strong>pspell_config_*()</strong>. Этот метод
  даёт наибольшую гибкость и имеет все функциональные возможности, предоставляемые <strong>pspell_new()</strong> и
  <strong>pspell_new_personal()</strong>.

<comment>Param:</comment>
  <info>PSpell\Config</info>  <strong>$config</strong>  Параметр <strong>$config</strong> - это параметр возвращённый функцией
                          <strong>pspell_config_create()</strong> после того, как конфигурация была создана.

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


id: pspell_new_personal
type: function
doc:
<comment>Description:</comment>
  Загружает новый словарь с персональным списком слов
  
  <strong>pspell_new_personal()</strong> открывает новый словарь с персональным списком слов. Список слов может быть
  модифицирован и сохранён функцией <strong>pspell_save_wordlist()</strong>, если потребуется. Однако замещающие пары
  не сохраняются. Для сохранения замещающих пар вы должны создать конфигурацию, используя
  <strong>pspell_config_create()</strong>, установить файл персонального списка слов функцией
  <strong>pspell_config_personal()</strong>, установить файл для замещающих пар функцией <strong>pspell_config_repl()</strong>, и
  открыть новый словарь с помощью <strong>pspell_new_config()</strong>.
  
  Более подробную информацию и примеры можно найти в руководстве по pspell на
  сайте:http://aspell.net/.

<comment>Param:</comment>
  <info>string</info>  <strong>$filename</strong>  Файл, в который будут сохранены слова, добавленные в персональный список. Это
                     должен быть абсолютный путь к файлу, начинающийся с '/', так как иначе он будет
                     относительным к $HOME, которым является "/root" для большинства систем, что,
                     вероятно, не то, что вам нужно.
  <info>string</info>  <strong>$language</strong>  Код языка, который состоит из двухбуквенного кода языка по стандарту ISO 639 и
                     необязательного двубуквенного кода страны по стандарту ISO 3166 после тире или
                     подчёркивания.
  <info>string</info>  <strong>$spelling</strong>  Определяет вариант проверки орфографии для языков с более чем одним вариантом
                     правописания, таких как английский. Известные значения: 'american', 'british',
                     и 'canadian'.
  <info>string</info>  <strong>$jargon</strong>    Дополнительная информацию для различения двух различных списков слов, имеющих
                     одинаковые параметры language и spelling.
  <info>string</info>  <strong>$encoding</strong>  Кодировка, в которой, как ожидается, даны слова. Допустимые значения: <return>utf-8</return>,
                     <return>iso8859-*</return>, <return>koi8-r</return>, <return>viscii</return>, <return>cp1252</return>, <return>machine unsigned 16</return>, <return>machine unsigned 32</return>.
  <info>int</info>     <strong>$mode</strong>      Режим, в котором будет работать проверка орфографии. Доступно несколько
                     режимов: <info>PSPELL_FAST</info> - Быстрый режим (наименьшее число вариантов исправления)
                     <info>PSPELL_NORMAL</info> - Нормальный режим (больше вариантов исправления)
                     <info>PSPELL_BAD_SPELLERS</info> - Медленный режим (много вариантов исправления)
                     <info>PSPELL_RUN_TOGETHER</info> - рассматривает объединённые слова как правильные сложные
                     слова. То есть, "thecat" будет считаться правильным сложным словом, хотя между
                     артиклем и словом должен быть пробел. Изменение этой установки влияет только на
                     результаты, возвращаемые функцией <strong>pspell_check()</strong>; <strong>pspell_suggest()</strong> будет
                     продолжать выдавать варианты исправления.  Mode - это битовая маска,
                     сконструированная из различных перечисленных выше констант. Однако,
                     <info>PSPELL_FAST</info>, <info>PSPELL_NORMAL</info> и <info>PSPELL_BAD_SPELLERS</info> являются взаимоисключающими,
                     так что вы должны выбрать только одну из них.
                     
                     <info>PSPELL_FAST</info> - Быстрый режим (наименьшее число вариантов исправления)
                     
                     <info>PSPELL_NORMAL</info> - Нормальный режим (больше вариантов исправления)
                     
                     <info>PSPELL_BAD_SPELLERS</info> - Медленный режим (много вариантов исправления)
                     
                     <info>PSPELL_RUN_TOGETHER</info> - рассматривает объединённые слова как правильные сложные
                     слова. То есть, "thecat" будет считаться правильным сложным словом, хотя между
                     артиклем и словом должен быть пробел. Изменение этой установки влияет только на
                     результаты, возвращаемые функцией <strong>pspell_check()</strong>; <strong>pspell_suggest()</strong> будет
                     продолжать выдавать варианты исправления.

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


id: pspell_save_wordlist
type: function
doc:
<comment>Description:</comment>
  Сохраняет персональный список слов в файле
  
  <strong>pspell_save_wordlist()</strong> сохраняет персональный список слов текущей сессии. Расположение файлов для
  сохранения указывается с помощью <strong>pspell_config_personal()</strong> и (необязательно) <strong>pspell_config_repl()</strong>.

<comment>Param:</comment>
  <info>PSpell\Dictionary</info>  <strong>$dictionary</strong>  Экземпляр <class>PSpell\Dictionary</class>.

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


id: pspell_store_replacement
type: function
doc:
<comment>Description:</comment>
  Сохраняет замещающую пару для слова
  
  <strong>pspell_store_replacement()</strong> сохраняет замещающую пару для слова, так что замена позднее может быть
  возвращена функцией <strong>pspell_suggest()</strong>. Чтобы использовать преимущества этой функции, следует
  открыть словарь с помощью <strong>pspell_new_personal()</strong>. Чтобы навсегда сохранить замещающую пару,
  необходимо использовать <strong>pspell_config_personal()</strong> и <strong>pspell_config_repl()</strong> для того, чтобы указать
  путь, куда сохранить пользовательские списки слов, а затем воспользоваться <strong>pspell_save_wordlist()</strong>
  для записи изменений на диск.

<comment>Param:</comment>
  <info>PSpell\Dictionary</info>  <strong>$dictionary</strong>  Экземпляр <class>PSpell\Dictionary</class>.
  <info>string</info>             <strong>$misspelled</strong>  Слово с ошибкой.
  <info>string</info>             <strong>$correct</strong>     Исправленное написание для слова с ошибкой (<strong>$misspelled</strong>).

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


id: pspell_suggest
type: function
doc:
<comment>Description:</comment>
  Предлагает варианты исправления слова
  
  <strong>pspell_suggest()</strong> возвращает массив возможных вариантов исправления заданного слова.

<comment>Param:</comment>
  <info>PSpell\Dictionary</info>  <strong>$dictionary</strong>  Экземпляр <class>PSpell\Dictionary</class>.
  <info>string</info>             <strong>$word</strong>        Проверяемое слово.

<comment>Return:</comment>
  <info>array|false</info>  Возвращает массив возможных вариантов исправления.


id: putenv
type: function
doc:
<comment>Description:</comment>
  Устанавливает значение переменной среды
  
  Добавляет <strong>$assignment</strong> в переменные окружения сервера. Переменная будет существовать только на
  время выполнения текущего запроса. По его завершении переменная вернётся в изначальное состояние.

<comment>Param:</comment>
  <info>string</info>  <strong>$assignment</strong>  Установка вида <return>"FOO=BAR"</return>

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

<comment>See Also:</comment>
   * <strong>getenv()</strong>
   * <strong>apache_setenv()</strong>


id: quoted_printable_decode
type: function
doc:
<comment>Description:</comment>
  Преобразует строку, закодированную методом quoted-printable в 8-битную строку
  
  Эта функция возвращает 8-битную бинарную строку, соответствующую указанной строке в кодировке
  quoted-printable (в соответствии с разделом 6.7 RFC2045, а не разделом 4.5.2 RFC2821, то есть
  дополнительные точки не будут вырезаны из начала строки).
  
  Эта функция подобна функции <strong>imap_qprint()</strong>, но не требует для своей работы модуля IMAP.

<comment>Param:</comment>
  <info>string</info>  <strong>$string</strong>  Входная строка.

<comment>Return:</comment>
  <info>string</info>  Возвращает 8-битную бинарную строку.

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


id: quoted_printable_encode
type: function
doc:
<comment>Description:</comment>
  Преобразует 8-битную строку с помощью метода quoted-printable
  
  Возвращает строку, закодированную в формат quoted-printable в соответствии с разделом 6.7 RFC2045.
  
  Эта функция подобна функции <strong>imap_8bit()</strong>, за исключением того, что не требует для своей работы
  модуля IMAP.

<comment>Param:</comment>
  <info>string</info>  <strong>$string</strong>  Входная строка.

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

<comment>See Also:</comment>
   * <strong>quoted_printable_decode()</strong>
   * <strong>iconv_mime_encode()</strong>


id: quotemeta
type: function
doc:
<comment>Description:</comment>
  Экранирует специальные символы
  
  Возвращает модифицированную строку, в которой перед каждым символом из следующего списка: . \ + *
  ? [ ^ ] ( $ ) вставлен обратный слеш (<return>\</return>).

<comment>Param:</comment>
  <info>string</info>  <strong>$string</strong>  Входная строка.

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

<comment>See Also:</comment>
   * <strong>addslashes()</strong>
   * <strong>addcslashes()</strong>
   * <strong>htmlentities()</strong>
   * <strong>htmlspecialchars()</strong>
   * <strong>nl2br()</strong>
   * <strong>stripslashes()</strong>
   * <strong>stripcslashes()</strong>
   * <strong>preg_quote()</strong>


id: rad2deg
type: function
doc:
<comment>Description:</comment>
  Преобразует значение из радианов в градусы
    
  
  Функция преобразует значение <strong>$num</strong> из радианов в градусы.

<comment>Param:</comment>
  <info>float</info>  <strong>$num</strong>  Значение в радианах

<comment>Return:</comment>
  <info>float</info>  Эквивалент <strong>$num</strong> в градусах

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


id: radius_acct_open
type: function
doc:
<comment>Description:</comment>
  Создаёт дескриптор Radius для учёта

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


id: radius_add_server
type: function
doc:
<comment>Description:</comment>
  Добавляет сервер
  
  <strong>radius_add_server()</strong> может вызываться несколько раз и может использоваться вместе с
  <strong>radius_config()</strong>. Можно указать не более 10 серверов. Когда задано несколько серверов, они
  проверяются циклически, пока не будет получен действительный ответ или пока не будет достигнут
  предел <strong>$max_tries</strong> для каждого сервера.

<comment>Param:</comment>
  <info>resource</info>  <strong>$radius_handle</strong>  
  <info>string</info>    <strong>$hostname</strong>       Параметр <strong>$hostname</strong> указывает хост сервера в виде полного доменного имени
                            или IP-адреса, разделённого точками, в текстовом виде.
  <info>int</info>       <strong>$port</strong>           <strong>$port</strong> указывает UDP-порт для связи на сервере. Если порт задан как 0,
                            библиотека ищет сервис radius/udp или radacct/udp в базе данных сетевых
                            сервисов, и использует найденный там порт. Если запись не найдена,
                            библиотека использует стандартные порты Radius, 1812 для аутентификации
                            и 1813 для учёта.
  <info>string</info>    <strong>$secret</strong>         Общий секрет для хоста сервера передаётся в параметре <strong>$secret</strong>. Протокол
                            Radius игнорирует всё, кроме первых 128 байтов общего секрета.
  <info>int</info>       <strong>$timeout</strong>        Время ожидания получения ответов от сервера передаётся в параметре
                            <strong>$timeout</strong> в секундах.
  <info>int</info>       <strong>$max_tries</strong>      Максимальное количество повторных запросов, которые нужно сделать перед
                            отказом, передаётся в <strong>$max_tries</strong>.

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

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


id: radius_auth_open
type: function
doc:
<comment>Description:</comment>
  Создаёт дескриптор Radius для аутентификации

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


id: radius_close
type: function
doc:
<comment>Description:</comment>
  Освобождает все ресурсы
  
  Не нужно вызывать эту функцию, потому что php освобождает все ресурсы в конце каждого запроса.

<comment>Param:</comment>
  <info>resource</info>  <strong>$radius_handle</strong>  Ресурс RADIUS.

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


id: radius_config
type: function
doc:
<comment>Description:</comment>
  Заставляет библиотеку читать данный файл конфигурации
  
  Перед выполнением любых запросов Radius, библиотека должна быть информирована о серверах, с
  которыми она может связаться. Самый простой способ настроить библиотеку - вызвать <strong>radius_config()</strong>.
  <strong>radius_config()</strong> заставляет библиотеку читать файл конфигурации, формат которого описан в
  radius.conf.

<comment>Param:</comment>
  <info>resource</info>  <strong>$radius_handle</strong>  
  <info>string</info>    <strong>$file</strong>           Путь к файлу конфигурации передаётся в качестве аргумента файла в
                            <strong>radius_config()</strong>. Библиотека также может быть настроена программно с
                            помощью вызова <strong>radius_add_server()</strong>.

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

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


id: radius_create_request
type: function
doc:
<comment>Description:</comment>
  Создаёт учётную запись или запрос аутентификации
  
  Запрос Radius состоит из кода, указывающего тип запроса, и нуля или более атрибутов, которые
  предоставляют дополнительную информацию. Чтобы начать создание нового запроса, вызовите
  <strong>radius_create_request()</strong>.
  
  Внимание: вы должны вызвать эту функцию, прежде чем вы сможете поместить любой атрибут!

<comment>Param:</comment>
  <info>resource</info>  <strong>$radius_handle</strong>  
  <info>int</info>       <strong>$type</strong>           Тип <info>RADIUS_ACCESS_REQUEST</info> или <info>RADIUS_ACCOUNTING_REQUEST</info>.

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

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


