# php_manual

id: xml_set_end_namespace_decl_handler
type: function
doc:
<comment>Description:</comment>
  Установка обработчика выхода за пределы пространства имён
  
  Задаёт обработчик, который вызывается при выходе за пределы объявления пространства имён. Этот
  обработчик будет вызываться для каждого объявления пространства имён после того как отработает
  обработчик окончания элемента, в котором это пространство имён было объявлено.
  
  Это событие не поддерживается LibXML, поэтому зарегистрированный обработчик не будет называться.

<comment>Param:</comment>
  <info>XMLParser</info>     <strong>$parser</strong>   Парсер XML.
  <info>callable</info>      <strong>$handler</strong>  Если передаётся значение <info>null</info> или пустая строка, то обработчик
                          возвращается в состояние по умолчанию.
                          
                          Если параметр <strong>$handler</strong> является типом <info>callable</info>, то в качестве обработчика
                          устанавливается callable.
                          
                          Если параметр <strong>$handler</strong> является строкой (<info>string</info>), то это может быть имя
                          метода объекта, заданного с помощью функции <strong>xml_set_object()</strong>.
                          
                          Сигнатура обработчика должна быть:
                          handler<info>XMLParser</info><strong>$parser</strong><info>string</info><info>false</info></info><strong>$prefix</strong> <strong>$parser</strong> XML-парсер, вызывающий
                          обработчик. <strong>$prefix</strong> Префикс - строка, используемая как ссылка на
                          пространство имён в пределах XML объекта. <info>false</info>, если префикс не
                          существует.
                          
                          XML-парсер, вызывающий обработчик.
                          
                          Префикс - строка, используемая как ссылка на пространство имён в пределах
                          XML объекта. <info>false</info>, если префикс не существует.
  <info>XMLParser</info>     <strong>$parser</strong>   XML-парсер, вызывающий обработчик.
  <info>string|false</info>  <strong>$prefix</strong>   Префикс - строка, используемая как ссылка на пространство имён в пределах
                          XML объекта. <info>false</info>, если префикс не существует.

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

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


id: xml_set_external_entity_ref_handler
type: function
doc:
<comment>Description:</comment>
  Установка обработчика внешних сущностей
  
  Задаёт функцию обработчик внешних сущностей для XML-анализатора <strong>$parser</strong>.

<comment>Param:</comment>
  <info>XMLParser</info>     <strong>$parser</strong>             Парсер XML.
  <info>callable</info>      <strong>$handler</strong>            Если передаётся значение <info>null</info> или пустая строка, то обработчик
                                    возвращается в состояние по умолчанию.
                                    
                                    Если параметр <strong>$handler</strong> является типом <info>callable</info>, то в качестве
                                    обработчика устанавливается callable.
                                    
                                    Если параметр <strong>$handler</strong> является строкой (<info>string</info>), то это может
                                    быть имя метода объекта, заданного с помощью функции
                                    <strong>xml_set_object()</strong>.
                                    
                                    Сигнатура обработчика должна быть:
                                    <info>bool</info>handler<info>XMLParser</info><strong>$parser</strong><info>string</info><strong>$open_entity_names</strong><info>string</info><info>false</info></info><strong>$base</strong><info>string</info><strong>$system_id</strong><info>string</info><info>false</info></info><strong>$public_id</strong>
                                    <strong>$parser</strong> XML-парсер, вызывающий обработчик. <strong>$open_entity_names</strong>
                                    Список разделённых пробелами имён сущностей, которые могут
                                    участвовать в разборе текущей сущности (включая текущую
                                    сущность). <strong>$base</strong> Это основа для разрешения системного
                                    идентификатора (<strong>$system_id</strong>) внешней сущности. <strong>$system_id</strong>
                                    Системный идентификатор в том виде, как он представлен в
                                    объявлении сущности. <strong>$public_id</strong> Общедоступный идентификатор в
                                    том виде, как он представлен в объявлении сущности, либо пустая
                                    строка, если такового нет; пробелы в идентификаторе будут
                                    нормализованы в соответствии с требованиями XML-спецификации.
                                    
                                    XML-парсер, вызывающий обработчик.
                                    
                                    Список разделённых пробелами имён сущностей, которые могут
                                    участвовать в разборе текущей сущности (включая текущую
                                    сущность).
                                    
                                    Это основа для разрешения системного идентификатора (<strong>$system_id</strong>)
                                    внешней сущности.
                                    
                                    Системный идентификатор в том виде, как он представлен в
                                    объявлении сущности.
                                    
                                    Общедоступный идентификатор в том виде, как он представлен в
                                    объявлении сущности, либо пустая строка, если такового нет;
                                    пробелы в идентификаторе будут нормализованы в соответствии с
                                    требованиями XML-спецификации.
                                    
                                    Обработчик должен вернуть <info>true</info>, если сущность была обработана, в
                                    противном случае он должен вернуть <info>false</info>. При возврате значения
                                    <info>false</info>, XML-парсер прекращает разбор, а функция
                                    <strong>xml_get_error_code()</strong> возвращает константу
                                    <info>XML_ERROR_EXTERNAL_ENTITY_HANDLING</info>.
  <info>XMLParser</info>     <strong>$parser</strong>             XML-парсер, вызывающий обработчик.
  <info>string</info>        <strong>$open_entity_names</strong>  Список разделённых пробелами имён сущностей, которые могут
                                    участвовать в разборе текущей сущности (включая текущую
                                    сущность).
  <info>string|false</info>  <strong>$base</strong>               Это основа для разрешения системного идентификатора (<strong>$system_id</strong>)
                                    внешней сущности.
  <info>string</info>        <strong>$system_id</strong>          Системный идентификатор в том виде, как он представлен в
                                    объявлении сущности.
  <info>string|false</info>  <strong>$public_id</strong>          Общедоступный идентификатор в том виде, как он представлен в
                                    объявлении сущности, либо пустая строка, если такового нет;
                                    пробелы в идентификаторе будут нормализованы в соответствии с
                                    требованиями XML-спецификации.

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


id: xml_set_notation_decl_handler
type: function
doc:
<comment>Description:</comment>
  Установка обработчика объявления условных обозначений
  
  Задаёт обработчик объявления обозначений для XML-анализатора <strong>$parser</strong>.
  
  Раздел объявления обозначений является частью DTD документа и имеет следующий формат: $name</strong>
  { <strong>$systemId</strong> | <strong>$publicId</strong>?>
  ]]> Смотрите раздел 4.7 спецификации XML 1.0 для более полного описания обозначений (нотаций).

<comment>Param:</comment>
  <info>XMLParser</info>     <strong>$parser</strong>         Парсер XML.
  <info>callable</info>      <strong>$handler</strong>        Если передаётся значение <info>null</info> или пустая строка, то обработчик
                                возвращается в состояние по умолчанию.
                                
                                Если параметр <strong>$handler</strong> является типом <info>callable</info>, то в качестве
                                обработчика устанавливается callable.
                                
                                Если параметр <strong>$handler</strong> является строкой (<info>string</info>), то это может быть
                                имя метода объекта, заданного с помощью функции <strong>xml_set_object()</strong>.
                                
                                Сигнатура обработчика должна быть:
                                <info>void</info>handler<info>XMLParser</info><strong>$parser</strong><info>string</info><strong>$notation_name</strong><info>string</info><info>false</info></info><strong>$base</strong><info>string</info><strong>$system_id</strong><info>string</info><info>false</info></info><strong>$public_id</strong>
                                <strong>$parser</strong> XML-парсер, вызывающий обработчик. <strong>$notation_name</strong> Имя
                                обозначения в том же виде, как описано выше. <strong>$base</strong> Это основа для
                                разрешения системного идентификатора (<strong>$system_id</strong>) внешней сущности.
                                <strong>$system_id</strong> Системный идентификатор объявления внешнего обозначения.
                                <strong>$public_id</strong> Общедоступный идентификатор объявления внешнего
                                обозначения.
                                
                                XML-парсер, вызывающий обработчик.
                                
                                Имя обозначения в том же виде, как описано выше.
                                
                                Это основа для разрешения системного идентификатора (<strong>$system_id</strong>)
                                внешней сущности.
                                
                                Системный идентификатор объявления внешнего обозначения.
                                
                                Общедоступный идентификатор объявления внешнего обозначения.
  <info>XMLParser</info>     <strong>$parser</strong>         XML-парсер, вызывающий обработчик.
  <info>string</info>        <strong>$notation_name</strong>  Имя обозначения в том же виде, как описано выше.
  <info>string|false</info>  <strong>$base</strong>           Это основа для разрешения системного идентификатора (<strong>$system_id</strong>)
                                внешней сущности.
  <info>string</info>        <strong>$system_id</strong>      Системный идентификатор объявления внешнего обозначения.
  <info>string|false</info>  <strong>$public_id</strong>      Общедоступный идентификатор объявления внешнего обозначения.

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


id: xml_set_object
type: function
doc:
<comment>Description:</comment>
  Использование XML-анализатора внутри объекта
  
  Эта функция позволяет использовать <strong>$parser</strong> внутри объекта <strong>$object</strong>. Все callback-функции могут быть
  установлены функциями <strong>xml_set_element_handler()</strong> и т.п. и использоваться как методы объекта
  <strong>$object</strong>.

<comment>Param:</comment>
  <info>XMLParser</info>  <strong>$parser</strong>  Ссылка на XML-анализатор.
  <info>object</info>     <strong>$object</strong>  Объект, в котором будет использоваться XML-анализатор.

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


id: xml_set_processing_instruction_handler
type: function
doc:
<comment>Description:</comment>
  Установка обработчика инструкций препроцессора (PI)
    
  
  Задаёт обработчик инструкций препроцессора (PI) для XML-анализатора. <strong>$parser</strong>.
  
  Инструкции имеют следующий формат: 
  ]]>
  
  PHP-код разграничивается инструкцией обработки <return>\<?php</return>. Таким образом, в XML-документе можно располагать PHP-код. Однако конечный тег PI (<return>?&gt;</return>) не должен быть частью данных. Если завершающий тег PI является частью встроенного PHP-кода, то остальная часть PHP-кода и "настоящий" тег PI end будут рассматриваться как символьные данные.

<comment>Param:</comment>
  <info>XMLParser</info>  <strong>$parser</strong>   Парсер XML.
  <info>callable</info>   <strong>$handler</strong>  Если передаётся значение <info>null</info> или пустая строка, то обработчик возвращается в
                       состояние по умолчанию.
                       
                       Если параметр <strong>$handler</strong> является типом <info>callable</info>, то в качестве обработчика
                       устанавливается callable.
                       
                       Если параметр <strong>$handler</strong> является строкой (<info>string</info>), то это может быть имя
                       метода объекта, заданного с помощью функции <strong>xml_set_object()</strong>.
                       
                       Сигнатура обработчика должна быть:
                       <info>void</info>handler<info>XMLParser</info><strong>$parser</strong><info>string</info><strong>$target</strong><info>string</info><strong>$data</strong> <strong>$parser</strong> XML-парсер,
                       вызывающий обработчик. <strong>$target</strong> Цель применения PI. <strong>$data</strong> PI-данные.
                       
                       XML-парсер, вызывающий обработчик.
                       
                       Цель применения PI.
                       
                       PI-данные.
  <info>XMLParser</info>  <strong>$parser</strong>   XML-парсер, вызывающий обработчик.
  <info>string</info>     <strong>$target</strong>   Цель применения PI.
  <info>string</info>     <strong>$data</strong>     PI-данные.

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


id: xml_set_start_namespace_decl_handler
type: function
doc:
<comment>Description:</comment>
  Установка обработчика входа в пределы пространства имён
    
  
  Задаёт обработчик события входа в пространство имён. То есть обработчик вызывается анализатор
  находит объявление пространства имён. Подобные объявления находятся в открывающих тэгах элементов.
  Этот обработчик вызывается до обработчика начала тэга.

<comment>Param:</comment>
  <info>XMLParser</info>  <strong>$parser</strong>   Ссылка на XML-анализатор.
  <info>callable</info>   <strong>$handler</strong>  <strong>$handler</strong> - строка содержащая имя функции, которая должна быть определена на
                       момент вызова функции <strong>xml_parse()</strong> из анализатора <strong>$parser</strong>.
                       
                       Функция с именем <strong>$handler</strong> должна принимать три аргумента и возвращать
                       целочисленный результат. Если обработчик вернёт <info>false</info> (равно как и ничего не
                       вернёт), XML-анализатор прекратит работу, а функция <strong>xml_get_error_code()</strong>
                       будет возвращать константу <info>XML_ERROR_EXTERNAL_ENTITY_HANDLING</info>.
                       handler<info>XMLParser</info><strong>$parser</strong><info>string</info><strong>$prefix</strong><info>string</info><strong>$uri</strong> <strong>$parser</strong> Первый аргумент parser
                       является ссылкой на XML-анализатор вызывающий обработчик. <strong>$prefix</strong> Префикс -
                       строка, используемая как ссылка на пространство имён в пределах XML-объекта.
                       <strong>$uri</strong> Универсальный идентификатор ресурса (URI) пространства имён.
                       
                       Первый аргумент parser является ссылкой на XML-анализатор вызывающий
                       обработчик.
                       
                       Префикс - строка, используемая как ссылка на пространство имён в пределах
                       XML-объекта.
                       
                       Универсальный идентификатор ресурса (URI) пространства имён.
                       
                       Если в качестве обработчика передана пустая строка или <info>false</info>, этот обработчик
                       отключается.
                       
                       В качестве аргумента вместо имени функции может быть передан массив,
                       содержащий ссылку на объект
                       и имя метода.
  <info>XMLParser</info>  <strong>$parser</strong>   Первый аргумент parser является ссылкой на XML-анализатор вызывающий
                       обработчик.
  <info>string</info>     <strong>$prefix</strong>   Префикс - строка, используемая как ссылка на пространство имён в пределах
                       XML-объекта.
  <info>string</info>     <strong>$uri</strong>      Универсальный идентификатор ресурса (URI) пространства имён.

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

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


id: xml_set_unparsed_entity_decl_handler
type: function
doc:
<comment>Description:</comment>
  Установка обработчика неразобранных объявлений сущностей
    
  
  Задаёт функцию обработчик неразобранных объявлений сущностей для XML-анализатора <strong>$parser</strong>.
  
  Обработчик <strong>$handler</strong> будет вызван, если XML-анализатор обнаружит NDATA-объявление внешней сущности
  вида: $name</strong> {<strong>$publicId</strong> | <strong>$systemId</strong>} NDATA <strong>$notationName</strong>
  ]]>
  
  Смотрите раздел 4.2.2 XML 1.0 спецификации, чтобы получить точное определение обозначений внешних
  сущностей.

<comment>Param:</comment>
  <info>XMLParser</info>     <strong>$parser</strong>         Парсер XML.
  <info>callable</info>      <strong>$handler</strong>        Если передаётся значение <info>null</info> или пустая строка, то обработчик
                                возвращается в состояние по умолчанию.
                                
                                Если параметр <strong>$handler</strong> является типом <info>callable</info>, то в качестве
                                обработчика устанавливается callable.
                                
                                Если параметр <strong>$handler</strong> является строкой (<info>string</info>), то это может быть
                                имя метода объекта, заданного с помощью функции <strong>xml_set_object()</strong>.
                                
                                Сигнатура обработчика должна быть:
                                <info>void</info>handler<info>XMLParser</info><strong>$parser</strong><info>string</info><strong>$entity_name</strong><info>string</info><info>false</info></info><strong>$base</strong><info>string</info><strong>$system_id</strong><info>string</info><info>false</info></info><strong>$public_id</strong><info>string</info><info>false</info></info><strong>$notation_name</strong>
                                <strong>$parser</strong> XML-парсер, вызывающий обработчик. <strong>$entity_name</strong> Имя
                                сущности, которой требуется дать определение. <strong>$base</strong> Это основа для
                                разрешения системного идентификатора (<strong>$system_id</strong>) внешней сущности.
                                <strong>$system_id</strong> Системный идентификатор внешней сущности. <strong>$public_id</strong>
                                Общедоступный идентификатор внешней сущности. <strong>$notation_name</strong> Имя
                                обозначения этой сущности (смотрите
                                <strong>xml_set_notation_decl_handler()</strong>).
                                
                                XML-парсер, вызывающий обработчик.
                                
                                Имя сущности, которой требуется дать определение.
                                
                                Это основа для разрешения системного идентификатора (<strong>$system_id</strong>)
                                внешней сущности.
                                
                                Системный идентификатор внешней сущности.
                                
                                Общедоступный идентификатор внешней сущности.
                                
                                Имя обозначения этой сущности (смотрите
                                <strong>xml_set_notation_decl_handler()</strong>).
  <info>XMLParser</info>     <strong>$parser</strong>         XML-парсер, вызывающий обработчик.
  <info>string</info>        <strong>$entity_name</strong>    Имя сущности, которой требуется дать определение.
  <info>string|false</info>  <strong>$base</strong>           Это основа для разрешения системного идентификатора (<strong>$system_id</strong>)
                                внешней сущности.
  <info>string</info>        <strong>$system_id</strong>      Системный идентификатор внешней сущности.
  <info>string|false</info>  <strong>$public_id</strong>      Общедоступный идентификатор внешней сущности.
  <info>string|false</info>  <strong>$notation_name</strong>  Имя обозначения этой сущности (смотрите
                                <strong>xml_set_notation_decl_handler()</strong>).

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


id: xmlrpc_decode
type: function
doc:
<comment>Description:</comment>
  Декодирует XML в нативные типы PHP
  
  Эта функция является ЭКСПЕРИМЕНТАЛЬНОЙ. Поведение этой функции, её имя и относящаяся к ней
  документация могут измениться в последующих версиях PHP без уведомления. Используйте эту функцию
  на свой страх и риск.

<comment>Param:</comment>
  <info>string</info>  <strong>$xml</strong>       XML-ответ, возвращаемый методом XMLRPC.
  <info>string</info>  <strong>$encoding</strong>  Входящая кодировка, поддерживаемая iconv.

<comment>Return:</comment>
  <info>mixed</info>  Возвращает массив, или число, или строку, или логическое значение в соответствии с ответом,
         возвращаемым методом XMLRPC.

<comment>See Also:</comment>
   * <strong>xmlrpc_encode_request()</strong>
   * <strong>xmlrpc_is_fault()</strong>


id: xmlrpc_decode_request
type: function
doc:
<comment>Description:</comment>
  Декодирует XML в нативные типы PHP
  
  Эта функция является ЭКСПЕРИМЕНТАЛЬНОЙ. Поведение этой функции, её имя и относящаяся к ней
  документация могут измениться в последующих версиях PHP без уведомления. Используйте эту функцию
  на свой страх и риск.
  
  К настоящему времени эта функция ещё не была документирована; для ознакомления доступен только
  список аргументов.

<comment>Return:</comment>
  <info>mixed</info>  


id: xmlrpc_encode
type: function
doc:
<comment>Description:</comment>
  Генерирует XML для PHP значения
  
  Эта функция является ЭКСПЕРИМЕНТАЛЬНОЙ. Поведение этой функции, её имя и относящаяся к ней
  документация могут измениться в последующих версиях PHP без уведомления. Используйте эту функцию
  на свой страх и риск.
  
  К настоящему времени эта функция ещё не была документирована; для ознакомления доступен только
  список аргументов.

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


id: xmlrpc_encode_request
type: function
doc:
<comment>Description:</comment>
  Генерирует XML для метода запроса
  
  Эта функция является ЭКСПЕРИМЕНТАЛЬНОЙ. Поведение этой функции, её имя и относящаяся к ней
  документация могут измениться в последующих версиях PHP без уведомления. Используйте эту функцию
  на свой страх и риск.

<comment>Param:</comment>
  <info>string</info>  <strong>$method</strong>          Имя метода для вызова.
  <info>mixed</info>   <strong>$params</strong>          Параметры метода, совместимые с сигнатурой вызова.
  <info>array</info>   <strong>$output_options</strong>  Массив, уточняющий параметры вывода, может содержать (значения по
                           умолчанию выделены): output_type: php, xmlverbosity: no_white_space,
                           newlines_only, prettyescaping: cdata, non-ascii, non-print, markup (может
                           быть строка с одним значением или массив с несколькими
                           значениями)version: simple, xmlrpc, soap 1.1, autoencoding: iso-8859-1,
                           другой набор символов, поддерживаемый iconv
                           
                           output_type: php, xml
                           
                           verbosity: no_white_space, newlines_only, pretty
                           
                           escaping: cdata, non-ascii, non-print, markup (может быть строка с одним
                           значением или массив с несколькими значениями)
                           
                           version: simple, xmlrpc, soap 1.1, auto
                           
                           encoding: iso-8859-1, другой набор символов, поддерживаемый iconv

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

<comment>See Also:</comment>
   * <strong>stream_context_create()</strong>
   * <strong>file_get_contents()</strong>
   * <strong>xmlrpc_decode()</strong>


id: xmlrpc_get_type
type: function
doc:
<comment>Description:</comment>
  Получает XML-RPC тип для значения PHP
  
  Эта функция является ЭКСПЕРИМЕНТАЛЬНОЙ. Поведение этой функции, её имя и относящаяся к ней
  документация могут измениться в последующих версиях PHP без уведомления. Используйте эту функцию
  на свой страх и риск.
  
  Эта функция особенно полезна для base64 и строки, содержащей дату.

<comment>Param:</comment>
  <info>mixed</info>  <strong>$value</strong>  Значение PHP

<comment>Return:</comment>
  <info>string</info>  Возвращает тип XML-RPC.

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


id: xmlrpc_is_fault
type: function
doc:
<comment>Description:</comment>
  Определяет, является ли массив значений представлением ошибки XMLRPC
  
  Эта функция является ЭКСПЕРИМЕНТАЛЬНОЙ. Поведение этой функции, её имя и относящаяся к ней
  документация могут измениться в последующих версиях PHP без уведомления. Используйте эту функцию
  на свой страх и риск.

<comment>Param:</comment>
  <info>array</info>  <strong>$arg</strong>  Массив, возвращаемый <strong>xmlrpc_decode()</strong>.

<comment>Return:</comment>
  <info>bool</info>  Возвращает <info>true</info>, если аргумент означает ошибку, в противном случае - <info>false</info>. Описание ошибки
        доступно в <return>$arg["faultString"]</return>,а код ошибки в <return>$arg["faultCode"]</return>.

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


id: xmlrpc_parse_method_descriptions
type: function
doc:
<comment>Description:</comment>
  Декодирует XML в список описаний методов
  
  Эта функция является ЭКСПЕРИМЕНТАЛЬНОЙ. Поведение этой функции, её имя и относящаяся к ней
  документация могут измениться в последующих версиях PHP без уведомления. Используйте эту функцию
  на свой страх и риск.
  
  К настоящему времени эта функция ещё не была документирована; для ознакомления доступен только
  список аргументов.

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


id: xmlrpc_server_add_introspection_data
type: function
doc:
<comment>Description:</comment>
  Добавляет документацию самоанализа
  
  Эта функция является ЭКСПЕРИМЕНТАЛЬНОЙ. Поведение этой функции, её имя и относящаяся к ней
  документация могут измениться в последующих версиях PHP без уведомления. Используйте эту функцию
  на свой страх и риск.
  
  К настоящему времени эта функция ещё не была документирована; для ознакомления доступен только
  список аргументов.

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


id: xmlrpc_server_call_method
type: function
doc:
<comment>Description:</comment>
  Разбирает XML-запросы и вызывающие методы
  
  Эта функция является ЭКСПЕРИМЕНТАЛЬНОЙ. Поведение этой функции, её имя и относящаяся к ней
  документация могут измениться в последующих версиях PHP без уведомления. Используйте эту функцию
  на свой страх и риск.
  
  К настоящему времени эта функция ещё не была документирована; для ознакомления доступен только
  список аргументов.

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


id: xmlrpc_server_create
type: function
doc:
<comment>Description:</comment>
  Создаёт сервер XML-RPC
  
  Эта функция является ЭКСПЕРИМЕНТАЛЬНОЙ. Поведение этой функции, её имя и относящаяся к ней
  документация могут измениться в последующих версиях PHP без уведомления. Используйте эту функцию
  на свой страх и риск.
  
  К настоящему времени эта функция ещё не была документирована; для ознакомления доступен только
  список аргументов.

<comment>Return:</comment>
  <info>resource</info>  


id: xmlrpc_server_destroy
type: function
doc:
<comment>Description:</comment>
  Уничтожает серверные ресурсы
  
  Эта функция является ЭКСПЕРИМЕНТАЛЬНОЙ. Поведение этой функции, её имя и относящаяся к ней
  документация могут измениться в последующих версиях PHP без уведомления. Используйте эту функцию
  на свой страх и риск.
  
  К настоящему времени эта функция ещё не была документирована; для ознакомления доступен только
  список аргументов.

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


id: xmlrpc_server_register_introspection_callback
type: function
doc:
<comment>Description:</comment>
  Регистрирует функцию PHP для генерации документации
  
  Эта функция является ЭКСПЕРИМЕНТАЛЬНОЙ. Поведение этой функции, её имя и относящаяся к ней
  документация могут измениться в последующих версиях PHP без уведомления. Используйте эту функцию
  на свой страх и риск.
  
  К настоящему времени эта функция ещё не была документирована; для ознакомления доступен только
  список аргументов.

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


id: xmlrpc_server_register_method
type: function
doc:
<comment>Description:</comment>
  Регистрирует функцию PHP к методу ресурса, соответствующему method_name
  
  Эта функция является ЭКСПЕРИМЕНТАЛЬНОЙ. Поведение этой функции, её имя и относящаяся к ней
  документация могут измениться в последующих версиях PHP без уведомления. Используйте эту функцию
  на свой страх и риск.
  
  К настоящему времени эта функция ещё не была документирована; для ознакомления доступен только
  список аргументов.

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


id: xmlrpc_set_type
type: function
doc:
<comment>Description:</comment>
  Устанавливает тип XML-RPC, base64 или datetime для значения строки PHP
  
  Устанавливает тип XML-RPC, base64 или datetime для значения строки PHP.
  
  Эта функция является ЭКСПЕРИМЕНТАЛЬНОЙ. Поведение этой функции, её имя и относящаяся к ней
  документация могут измениться в последующих версиях PHP без уведомления. Используйте эту функцию
  на свой страх и риск.

<comment>Param:</comment>
  <info>string</info>  <strong>$value</strong>  Значение для установки типа.
  <info>string</info>  <strong>$type</strong>   'base64' или 'datetime'

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


id: yaml_emit
type: function
doc:
<comment>Description:</comment>
  Возвращает YAML-представление значения
  
  Возвращает YAML-представление переданных в параметре <strong>$data</strong> данных.

<comment>Param:</comment>
  <info>mixed</info>  <strong>$data</strong>       Данные <strong>$data</strong> для кодирования. Параметр может быть любого типа, за исключением
                     ресурса (<info>resource</info>).
  <info>int</info>    <strong>$encoding</strong>   Выходная кодировка выбираемая из <info>YAML_ANY_ENCODING</info>, <info>YAML_UTF8_ENCODING</info>,
                     <info>YAML_UTF16LE_ENCODING</info>, <info>YAML_UTF16BE_ENCODING</info>.
  <info>int</info>    <strong>$linebreak</strong>  Символ перевода строки в выводе <info>YAML_ANY_BREAK</info>, <info>YAML_CR_BREAK</info>, <info>YAML_LN_BREAK</info>,
                     <info>YAML_CRLN_BREAK</info>.
  <info>array</info>  <strong>$callbacks</strong>  Обработчики контента для создания узлов YAML. Ассоциативный массив (<info>array</info>), где
                     в качестве ключей используются имена классов, а в качестве значений
                     callback-функции (<info>callable</info>), которые будут создавать узлы для этих классов.
                     Больше подробностей можно узнать в разделе про публикующие callback-функции.

<comment>Return:</comment>
  <info>string</info>  Возвращает YAML-закодированную строку (<info>string</info>) в случае успешного выполнения.

<comment>See Also:</comment>
   * <strong>yaml_emit_file()</strong>
   * <strong>yaml_parse()</strong>


id: yaml_emit_file
type: function
doc:
<comment>Description:</comment>
  Отправляет YAML-представление значения в файл
  
  Генерирует YAML-представление из данных <strong>$data</strong> и отправляет в <strong>$filename</strong>.

<comment>Param:</comment>
  <info>string</info>  <strong>$filename</strong>   Путь к файлу.
  <info>mixed</info>   <strong>$data</strong>       Параметр <strong>$data</strong> будет кодирован. Допускается любой тип данных кроме ресурса
                      (<info>resource</info>).
  <info>int</info>     <strong>$encoding</strong>   Кодировка вывода выбирается из <info>YAML_ANY_ENCODING</info>, <info>YAML_UTF8_ENCODING</info>,
                      <info>YAML_UTF16LE_ENCODING</info>, <info>YAML_UTF16BE_ENCODING</info>.
  <info>int</info>     <strong>$linebreak</strong>  Символ конца строки вывода выбирается из <info>YAML_ANY_BREAK</info>, <info>YAML_CR_BREAK</info>,
                      <info>YAML_LN_BREAK</info>, <info>YAML_CRLN_BREAK</info>.
  <info>array</info>   <strong>$callbacks</strong>  Обработчики контента для создания узлов YAML. Ассоциативный массив (<info>array</info>),
                      где в качестве ключей используются имена классов, а в качестве значений
                      callback-функции (<info>callable</info>), которые будут создавать узлы для этих классов.
                      Больше подробностей можно узнать в разделе про публикующие callback-функции.

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

<comment>See Also:</comment>
   * <strong>yaml_emit()</strong>
   * <strong>yaml_parse()</strong>


id: yaml_parse
type: function
doc:
<comment>Description:</comment>
  Разбирает поток YAML
  
  Конвертирует весь поток YAML или его часть и записывает в переменную.

<comment>Param:</comment>
  <info>string</info>  <strong>$input</strong>      <info>Строка</info> для парсинга как поток YAML.
  <info>int</info>     <strong>$pos</strong>        Документ для разбора (<return>-1</return> для всех документов, <return>0</return> для первого документа, ...).
  <info>int</info>     <strong>$ndocs</strong>      Если <strong>$ndocs</strong> найден, тогда он будет заменён на количество документов в потоке
                      YAML.
  <info>array</info>   <strong>$callbacks</strong>  Обработчики содержимого для узлов YAML. Ассоциативный массив (<info>array</info>), ключи
                      которого являются тегами YAML, а значения callback-функциями (<info>callable</info>),
                      которые будут их обрабатывать. Более подробно этот механизм описан в разделе
                      callback-функции разбора.

<comment>Return:</comment>
  <info>mixed</info>  Возвращает значение, закодированное в <strong>$input</strong>,  в соответствующем типе PHP или <info>false</info> в
         случае возникновения ошибки. Если параметр <strong>$pos</strong> равен <return>-1</return>, будет возвращён массив,
         содержащий по одной записи для каждого документа, найденного в потоке.

<comment>See Also:</comment>
   * <strong>yaml_parse_file()</strong>
   * <strong>yaml_parse_url()</strong>
   * <strong>yaml_emit()</strong>


id: yaml_parse_file
type: function
doc:
<comment>Description:</comment>
  Разбирает YAML-поток из файла
  
  Конвертирует полностью или частично поток YAML-документов, читаемых из файла, в переменную PHP.

<comment>Param:</comment>
  <info>string</info>  <strong>$filename</strong>   Путь к файлу.
  <info>int</info>     <strong>$pos</strong>        Индекс документа для извлечения из потока (<return>-1</return> для всех документов, <return>0</return> для
                      первого документа, ...).
  <info>int</info>     <strong>$ndocs</strong>      Если <strong>$ndocs</strong> передан, то он будет заполнен количеством документов, найденных в
                      потоке.
  <info>array</info>   <strong>$callbacks</strong>  Обработчики содержимого для узлов YAML. Ассоциативный массив (<info>array</info>), ключи
                      которого являются тегами YAML, а значения callback-функциями (<info>callable</info>),
                      которые будут их обрабатывать. Более подробно этот механизм описан в разделе
                      callback-функции разбора.

<comment>Return:</comment>
  <info>mixed</info>  Возвращает значение, закодированное в <strong>$input</strong>, в соответствующем PHP типе или <info>false</info> в случае
         возникновения ошибки. Если параметр <strong>$pos</strong> равен <return>-1</return>, то будет возвращён массив (<info>array</info>),
         содержащий по одной записи для каждого документа, найденного в потоке.

<comment>See Also:</comment>
   * <strong>yaml_parse()</strong>
   * <strong>yaml_parse_url()</strong>
   * <strong>yaml_emit()</strong>


id: yaml_parse_url
type: function
doc:
<comment>Description:</comment>
  Разбирает YAML-поток из URL
  
  Конвертирует полностью или частично поток YAML-документов, читаемых из URL, в переменную PHP.

<comment>Param:</comment>
  <info>string</info>  <strong>$url</strong>        <strong>$url</strong> должен быть в форме "scheme://...". PHP будет искать обработчик протокола
                      (также известная как обёртка) для указанной схемы. Если адаптеры для этого
                      протокола не зарегистрированы,  PHP сгенерирует уведомление, чтобы помочь вам
                      отследить потенциальные проблемы в вашем скрипте, а затем продолжит выполнение
                      так, как будто был указан обычный файл.
  <info>int</info>     <strong>$pos</strong>        Индекс документа для извлечения из потока (<return>-1</return> для всех документов, <return>0</return> для
                      первого документа, ...).
  <info>int</info>     <strong>$ndocs</strong>      Если <strong>$ndocs</strong> передан, то он будет заполнен количеством документов, найденных в
                      потоке.
  <info>array</info>   <strong>$callbacks</strong>  Обработчики содержимого для узлов YAML. Ассоциативный массив (<info>array</info>), ключи
                      которого являются тегами YAML, а значения callback-функциями (<info>callable</info>),
                      которые будут их обрабатывать. Более подробно этот механизм описан в разделе
                      callback-функции разбора.

<comment>Return:</comment>
  <info>mixed</info>  Возвращает значение, закодированное в <strong>$input</strong>, в соответствующем PHP типе или <info>false</info> в случае
         возникновения ошибки. Если параметр <strong>$pos</strong> равен <return>-1</return>, то будет возвращён массив (<info>array</info>),
         содержащий по одной записи для каждого документа, найденного в потоке.

<comment>See Also:</comment>
   * <strong>yaml_parse()</strong>
   * <strong>yaml_parse_file()</strong>
   * <strong>yaml_emit()</strong>


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

<comment>Param:</comment>
  <info>resource</info>  <strong>$id</strong>  Дескриптор соединения, возвращаемый функцией <strong>yaz_connect()</strong>.

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

<comment>See Also:</comment>
   * <strong>yaz_error()</strong>
   * <strong>yaz_errno()</strong>


id: yaz_ccl_conf
type: function
doc:
<comment>Description:</comment>
  Конфигурирует CCL-парсер
  
  Функция конфигурирует CCL-парсер запросов для сервера с определениями точек доступа
  (CCL-квалификаторов) и их отображения в RPN.
  
  Для отображения специфического CCL-запроса к RPN вызовите затем функцию <strong>yaz_ccl_parse()</strong>.

<comment>Param:</comment>
  <info>resource</info>  <strong>$id</strong>      Идентификатор ресурса, возвращаемый функцией <strong>yaz_connect()</strong>.
  <info>array</info>     <strong>$config</strong>  Массив настроек. Каждый ключ массива - это имя CCL-поля и соответствующее
                     значение, содержащее строку, которая определяет отображение в RPN.
                     
                     Отображение - это последовательность пар атрибут-тип, атрибут-значение.
                     Атрибут-тип и атрибут-значение разделены знаком равенства (<return>=</return>). Каждая пара
                     отделяется пробелом.
                     
                     Дополнительную информация можно найти на странице CCL.

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

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


id: yaz_ccl_parse
type: function
doc:
<comment>Description:</comment>
  Вызывает парсер CCL
  
  Функция вызывает синтаксический анализатор CCL. Он преобразует данный запрос CCL FIND в запрос
  RPN, который можно передать функции <strong>yaz_search()</strong> для выполнения поиска.
  
  Чтобы определить набор допустимых полей CCL, вызовите <strong>yaz_ccl_conf()</strong> перед этой функцией.

<comment>Param:</comment>
  <info>resource</info>  <strong>$id</strong>      Ресурс соединения, возвращённый <strong>yaz_connect()</strong>.
  <info>string</info>    <strong>$query</strong>   Запрос CCL FIND.
  <info>array</info>     <strong>$result</strong>  Если функция была выполнена успешно, это будет массив, содержащий корректный
                     запрос RPN в ключе <return>rpn</return>.
                     
                     После сбоя в этом массиве устанавливаются три индекса, указывающие причину
                     возникновения ошибки: <return>errorcode</return> - код ошибки CCL (целое число) <return>errorstring</return> -
                     строка ошибки CCL <return>errorpos</return> - приблизительная позиция в запросе ошибки (целое
                     число - позиция символа)
                     
                     <return>errorcode</return> - код ошибки CCL (целое число)
                     
                     <return>errorstring</return> - строка ошибки CCL
                     
                     <return>errorpos</return> - приблизительная позиция в запросе ошибки (целое число - позиция
                     символа)

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


id: yaz_close
type: function
doc:
<comment>Description:</comment>
  Закрывает соединение YAZ
  
  Закрывает соединение, определяемое параметром <strong>$id</strong>.
  
  Функция закроет только непостоянные соединения, открытые функцией <strong>yaz_connect()</strong> с параметром
  <return>persistent</return> установленным в значение  <info>false</info>.

<comment>Param:</comment>
  <info>resource</info>  <strong>$id</strong>  Дескриптор соединения, возвращаемый <strong>yaz_connect()</strong>.

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

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


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

<comment>Param:</comment>
  <info>string</info>  <strong>$zurl</strong>     Строка, принимающая форму <return>host[:port][/database]</return>. Если порт опущен, то по
                    умолчанию используется 210 порт. Если опущено название базы данных, используется
                    база с именем <return>Default</return>.
  <info>mixed</info>   <strong>$options</strong>  Если задаётся строка, то она рассматривается как строка аутентификации Z39.50 V2
                    (OpenAuth).
                    
                    Если задан массив, то содержимое массива выступает в качестве параметров. user
                    Имя пользователя для аутентификации. group Название группы для аутентификации.
                    password Пароль для аутентификации. cookie Cookie для сессии (YAZ proxy). proxy
                    Прокси для подключения (YAZ proxy). persistent Имеет логический тип. Если
                    принимает <info>true</info> - соединение постоянное, если <info>false</info> - непостоянное соединение. По
                    умолчанию соединение постоянное.  Если вы открыли постоянное соединение, вы не
                    сможете закрыть его позднее с помощью <strong>yaz_close()</strong>. piggyback Имеет логический
                    тип. Если принимает <info>true</info>, то режим передачи прямых и обратных пакетов включён;
                    если <info>false</info>, то данный режим отключён. По умолчанию режим передачи прямых и
                    обратных пакетов включён.  Включение режима передачи прямых и обратных пакетов
                    более эффективно и обычно снижает нагрузку в сети для впервые выбранных записей.
                    Однако некоторые сервера Z39.50 не поддерживают режим прямых и обратных пакетов
                    или игнорируют эту настройку. Для них данный режим должен быть отключён. charset
                    Строка, определяющая кодировку используемую в Z39.50 и при передаче данных.
                    Возможны такие значения как: <return>ISO-8859-1</return>, <return>UTF-8</return>, <return>UTF-16</return>.  Большинство серверов
                    Z39.50 не поддерживают данную настройку (и таким образом она игнорируется).
                    Много серверов используют кодировку ISO-8859-1 для запросов и сообщений.
                    Кодировки записей в форматах MARC21/USMARC не затрагиваются данной опцией.
                    preferredMessageSize Целочисленный параметр, определяющий максимальный размер
                    всех записей, возвращаемых сервером при поиске, в байтах. Для более подробной
                    информации смотрите стандарт Z39.50.  Опция поддерживается в версии PECL YAZ
                    1.0.5 и более поздних. maximumRecordSize Целочисленный параметр, определяющий
                    максимальное количество байт в отдельной записи, возвращаемой сервером в
                    результате поиска. Данный параметр относится к Exceptional-record-size в
                    стандарте Z39.50.  Опция поддерживается в версии PECL YAZ 1.0.5 и более поздних.
                    
                    Имя пользователя для аутентификации.
                    
                    Название группы для аутентификации.
                    
                    Пароль для аутентификации.
                    
                    Cookie для сессии (YAZ proxy).
                    
                    Прокси для подключения (YAZ proxy).
                    
                    Имеет логический тип. Если принимает <info>true</info> - соединение постоянное, если <info>false</info> -
                    непостоянное соединение. По умолчанию соединение постоянное.
                    
                    Если вы открыли постоянное соединение, вы не сможете закрыть его позднее с
                    помощью <strong>yaz_close()</strong>.
                    
                    Имеет логический тип. Если принимает <info>true</info>, то режим передачи прямых и обратных
                    пакетов включён; если <info>false</info>, то данный режим отключён. По умолчанию режим
                    передачи прямых и обратных пакетов включён.
                    
                    Включение режима передачи прямых и обратных пакетов более эффективно и обычно
                    снижает нагрузку в сети для впервые выбранных записей. Однако некоторые сервера
                    Z39.50 не поддерживают режим прямых и обратных пакетов или игнорируют эту
                    настройку. Для них данный режим должен быть отключён.
                    
                    Строка, определяющая кодировку используемую в Z39.50 и при передаче данных.
                    Возможны такие значения как: <return>ISO-8859-1</return>, <return>UTF-8</return>, <return>UTF-16</return>.
                    
                    Большинство серверов Z39.50 не поддерживают данную настройку (и таким образом
                    она игнорируется). Много серверов используют кодировку ISO-8859-1 для запросов и
                    сообщений. Кодировки записей в форматах MARC21/USMARC не затрагиваются данной
                    опцией.
                    
                    Целочисленный параметр, определяющий максимальный размер всех записей,
                    возвращаемых сервером при поиске, в байтах. Для более подробной информации
                    смотрите стандарт Z39.50.
                    
                    Опция поддерживается в версии PECL YAZ 1.0.5 и более поздних.
                    
                    Целочисленный параметр, определяющий максимальное количество байт в отдельной
                    записи, возвращаемой сервером в результате поиска. Данный параметр относится к
                    Exceptional-record-size в стандарте Z39.50.
                    
                    Опция поддерживается в версии PECL YAZ 1.0.5 и более поздних.

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

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


id: yaz_database
type: function
doc:
<comment>Description:</comment>
  Определяет базы данных в сеансе
    
  
  Функция позволяет изменять базы данных в течение сеанса, указав одну или несколько баз данных,
  которые будут использоваться при поиске, поиске и т.д. - переопределение баз данных, указанных в
  вызове <strong>yaz_connect()</strong>.

<comment>Param:</comment>
  <info>resource</info>  <strong>$id</strong>         Ресурс соединения, возвращённый <strong>yaz_connect()</strong>.
  <info>string</info>    <strong>$databases</strong>  Строка, содержащая одну или несколько баз данных. Несколько баз данных,
                        разделённые знаком плюс <return>+</return>.

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


id: yaz_element
type: function
doc:
<comment>Description:</comment>
  Указывает имя набора элементов для поиска
    
  
  Функция устанавливает имя набора элементов для поиска.
  
  Вызовите эту функцию перед <strong>yaz_search()</strong> или <strong>yaz_present()</strong>, чтобы указать имя набора элементов для
  извлекаемых записей.
  
  Если кажется, что не происходит никакого эффекта, смотрите описание опции <return>piggybacking</return> в
  <strong>yaz_connect()</strong>.

<comment>Param:</comment>
  <info>resource</info>  <strong>$id</strong>          Ресурс соединения, возвращённый <strong>yaz_connect()</strong>.
  <info>string</info>    <strong>$elementset</strong>  Большинство серверов поддерживают <return>F</return> (для полных записей) и <return>B</return> (для кратких
                         записей).

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


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

<comment>Param:</comment>
  <info>resource</info>  <strong>$id</strong>  Ресурс подключения, возвращаемый <strong>yaz_connect()</strong>.

<comment>Return:</comment>
  <info>int</info>  Возвращает код ошибки. Код ошибки - это либо диагностический код Z39.50 (обычно диагностика
       Bib-1), либо код ошибки на стороне клиента, который генерируется самим PHP/YAZ, например
       "Connect failed", "Init Rejected" и т.д.

<comment>See Also:</comment>
   * <strong>yaz_error()</strong>
   * <strong>yaz_addinfo()</strong>


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

<comment>Param:</comment>
  <info>resource</info>  <strong>$id</strong>  Ресурс подключения, возвращаемый <strong>yaz_connect()</strong>.

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

<comment>See Also:</comment>
   * <strong>yaz_errno()</strong>
   * <strong>yaz_addinfo()</strong>


id: yaz_es
type: function
doc:
<comment>Description:</comment>
  Подготавливает Extended Service Request
  
  Функция подготавливает Extended Service Request. Extended Services - это семейство различных
  средств Z39.50, таких как обновление записей, порядок элементов, администрирование баз данных и
  т.д.
  
  Многие серверы Z39.50 не поддерживают Extended Services.
  
  <strong>yaz_es()</strong> создаёт пакеты Extended Service Request и помещает их в очередь операций. Используйте
  <strong>yaz_wait()</strong> для отправки запроса(ов) на сервер. После завершения <strong>yaz_wait()</strong>, результата операций
  Extended Service следует ожидать с помощью вызова <strong>yaz_es_result()</strong>.

<comment>Param:</comment>
  <info>resource</info>  <strong>$id</strong>    Ресурс подключения, возвращаемый <strong>yaz_connect()</strong>.
  <info>string</info>    <strong>$type</strong>  Строка, представляющая тип Extended Service: <return>itemorder</return> (Item Order), <return>create</return>
                   (Create Database), <return>drop</return> (Drop Database), <return>commit</return> (Commit Operation), <return>update</return>
                   (Update Record), <return>xmlupdate</return> (XML Update). Каждый тип указан в следующем разделе.
  <info>array</info>     <strong>$args</strong>  Массив с Extended Service и параметрами для конкретных пакетов. Параметры
                   идентичны тем, которые предлагаются в C API ZOOM C. Смотрите ZOOM Extended
                   Services.

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

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


id: yaz_es_result
type: function
doc:
<comment>Description:</comment>
  Проверяет результат Extended Service
  
  Функция проверяет последний возвращённый сервером результат Extended Service. Extended Service
  инициируется либо с помощью <strong>yaz_item_order()</strong>, либо с помощью <strong>yaz_es()</strong>.

<comment>Param:</comment>
  <info>resource</info>  <strong>$id</strong>  Идентификатор подключения, возвращаемый <strong>yaz_connect()</strong>.

<comment>Return:</comment>
  <info>array</info>  Возвращает массив с элементом <return>targetReference</return> для ссылки на операцию Extended Service
         (сгенерированной и возвращённой с сервера).

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


id: yaz_get_option
type: function
doc:
<comment>Description:</comment>
  Возвращает значение параметра для подключения
  
  Возвращает значение параметра, указанного в <strong>$name</strong>.

<comment>Param:</comment>
  <info>resource</info>  <strong>$id</strong>    Ресурс подключения, возвращаемый <strong>yaz_connect()</strong>.
  <info>string</info>    <strong>$name</strong>  Название параметра.

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

<comment>See Also:</comment>
   * 
     Описание <strong>yaz_set_option()</strong> для просмотра доступных параметров
    


id: yaz_hits
type: function
doc:
<comment>Description:</comment>
  Возвращает количество совпадений для последнего поиска
  
  <strong>yaz_hits()</strong> возвращает количество совпадений для последнего поиска.

<comment>Param:</comment>
  <info>resource</info>  <strong>$id</strong>            Ресурс подключения, возвращаемый <strong>yaz_connect()</strong>.
  <info>array</info>     <strong>$searchresult</strong>  Массив результатов для детальной информации о результатах поиска.

<comment>Return:</comment>
  <info>int</info>  Возвращает количество совпадений для последнего поиска или 0, если поиск не производился.
       
       Массив результатов поиска (если предоставлен) содержит информацию, возвращаемую сервером
       Z39.50 в части ответа на поисковый запрос в формате SearchResult-1. Формат SearchResult-1
       может использоваться для получения информации о количестве совпадений для различных частей
       запроса (подзапроса). В частности, можно получить количество совпадений для отдельных условий
       поиска в запросе. Информация для первого подзапроса находится в $array[0], второго подзапроса
       - в $array[1] и т.д.
       
       Для работы SearchResult требуется PECL YAZ 1.0.5 или новее и YAZ 2.1.9 или новее.
       
       Очень немногие реализации Z39.50 поддерживают функцию SearchResult.


id: yaz_itemorder
type: function
doc:
<comment>Description:</comment>
  Подготавливает запрос к Z39.50 Item Order с пакетом ILL-Request
  
  Функция подготавливает запрос Extended Services с использованием профиля для использования Item
  Order Extended Service для Transport ILL (Profile/1). Смотрите это и спецификацию.

<comment>Param:</comment>
  <info>resource</info>  <strong>$id</strong>    Ресурс подключения, возвращаемый <strong>yaz_connect()</strong>.
  <info>array</info>     <strong>$args</strong>  Должен быть ассоциативным массивом с информацией об отправляемом запросе Item
                   Order. Ключ хеша - это имя соответствующего пути тега ASN.1. Например, у ISBN под
                   Item-ID будет ключ item-id,ISBN.
                   
                   Параметры ILL-запроса:
                   
                   Есть также несколько параметров, которые являются частью пакетов запроса Extended
                   Services и пакета ItemOrder:

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


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

<comment>Param:</comment>
  <info>resource</info>  <strong>$id</strong>  Ресурс соединения, возвращённый <strong>yaz_connect()</strong>.

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


id: yaz_range
type: function
doc:
<comment>Description:</comment>
  Определяет диапазон записей для извлечения
    
  
  Определяет диапазон записей для извлечения.
  
  Функция должна быть вызвана перед <strong>yaz_search()</strong> или <strong>yaz_present()</strong>.

<comment>Param:</comment>
  <info>resource</info>  <strong>$id</strong>      Ресурс соединения, возвращённый <strong>yaz_connect()</strong>.
  <info>int</info>       <strong>$start</strong>   Определяет позицию первой записи, которую нужно получить. Номера записей идут
                     от 1 до <strong>yaz_hits()</strong>.
  <info>int</info>       <strong>$number</strong>  Определяет диапазон записей для извлечения.

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


id: yaz_record
type: function
doc:
<comment>Description:</comment>
  Возвращает запись
  
  Функция <strong>yaz_record()</strong> проверяет запись в текущем результирующем наборе на позиции, определённой
  параметром  <strong>$pos</strong>.

<comment>Param:</comment>
  <info>resource</info>  <strong>$id</strong>      Дескриптор соединения, возвращаемый <strong>yaz_connect()</strong>.
  <info>int</info>       <strong>$pos</strong>     Позиция записи. Записи в результирующем наборе нумеруются как 1, 2, ... $hits,
                     где $hits - число записей в результирующем наборе, которое возвращается
                     функцией <strong>yaz_hits()</strong>.
  <info>string</info>    <strong>$type</strong>    <strong>$type</strong> определяет форму возвращаемой записи.
                     
                     Только приложение несёт ответственность за достоверность того, что возвращаемые
                     записи с сервера Z39.50/SRW в надлежащем формате. Задаваемый тип только
                     определяет преобразование, которое имеет место на стороне клиента (в PHP/YAZ).
                     
                     Помимо преобразования переданной записи в строку/массив, PHP/YAZ так же может
                     преобразовывать кодировку записи. Особенно это актуально для форматов
                     USMARC/MARC21, которые рекомендуется преобразовывать, поскольку они обычно
                     возвращаются в кодировке MARC-8, которую не понимают браузеры и другие
                     приложения. Чтобы определить преобразование, добавьте <return>; charset=</return>from<return>, </return>to, где
                     from текущая кодировка записи и to результирующая кодировка, которая будет
                     доступна PHP.
                     
                     Запись возвращается в виде строки для отображения. В этом режиме все
                     MARC-записи преобразуются в построчное представление, поскольку в формате
                     ISO2709 их трудно прочитать. Записи XML и SUTRS возвращаются в их родном
                     формате. GRS-1 возвращается в (безобразном) построчном представлении.
                     
                     Данный формат применим для быстрого вывода записей на экран, для отладки, или в
                     случае, когда корректное отображение невозможно.
                     
                     Запись возвращается как строка XML, если это возможно. В этом режиме все
                     MARC-записи преобразовываются в формат MARCXML. Записи XML и SUTRS возвращаются
                     в их родном формате. GRS-1 не поддерживается.
                     
                     Этот формат схож с <strong>$string</strong>, за исключением того, что MARC-записи преобразуются
                     в MARCXML.
                     
                     Данный формат применим, если запись будет передана парсеру XML или
                     XSLT-процессору.
                     
                     Запись возвращается в виде строки в исходной форме. Данный тип применим для
                     MARC, XML и SUTRS, но не работает для GRS-1.
                     
                     MARC-запись возвращается в формате ISO2709, XML и SUTRS возвращаются как
                     строка.
                     
                     Синтаксис возвращаемой записи, например <return>USmarc</return>, <return>GRS-1</return>, <return>XML</return>, и д.р.
                     
                     Имя базы данных, сопоставленное с записью.
                     
                     Запись возвращается в виде массива, сопоставленного со структурой GRS-1. Данный
                     тип применим для MARC и GRS-1. XML, SUTRS не поддерживаются и, если исходная
                     запись в формате XML или SUTRS, возвращается пустая строка.
                     
                     Возвращаемый массив состоит из списка, который соответствует каждому
                     внутреннему узлу или конечному элементу(leaf) формата GRS-1. Каждый список
                     состоит из подсписка, первым элементом которого будет путь и дата (если она
                     доступна).
                     
                     Путь, представленный в виде строки, содержит список каждой компоненты дерева
                     (для структуры записи GRS-1) от корневого элемента до конечного. Каждая
                     компонента представлена парой тип поля и значение, в форме (<return>тип</return>, <return>значение</return>).
                     
                     Начальное поле обычно сопоставлено типу 3. MARC-записи тоже могут быть
                     возвращены в виде массива (они конвертируются в GRS-1).
  <info></info>          <strong>$string</strong>  Запись возвращается как строка XML, если это возможно. В этом режиме все
                     MARC-записи преобразовываются в формат MARCXML. Записи XML и SUTRS возвращаются
                     в их родном формате. GRS-1 не поддерживается.
                     
                     Этот формат схож с <strong>$string</strong>, за исключением того, что MARC-записи преобразуются
                     в MARCXML.
                     
                     Данный формат применим, если запись будет передана парсеру XML или
                     XSLT-процессору.

<comment>Return:</comment>
  <info>string</info>  Возвращает запись на позиции <strong>$pos</strong> или пустую строку, если на заданной позиции нет записей.
          
          Если на заданной позиции в базе данных нет записей, будет возвращена пустая строка.


id: yaz_scan
type: function
doc:
<comment>Description:</comment>
  Подготовка сканирования
  
  Функция подготавливает запрос сканирования для установленного соединения по протоколу Z39.50.
  
  Чтобы передать запрос сканирования на сервер и получить ответ нужно вызвать функцию <strong>yaz_wait()</strong>. По
  заверению <strong>yaz_wait()</strong> вызовите <strong>yaz_error()</strong> для получения ошибки и <strong>yaz_scan_result()</strong> для получения
  результата.

<comment>Param:</comment>
  <info>resource</info>  <strong>$id</strong>         Дескриптор соединения, возвращённый <strong>yaz_connect()</strong>.
  <info>string</info>    <strong>$type</strong>       В настоящее время поддерживается только <return>rpn</return>.
  <info>string</info>    <strong>$startterm</strong>  Начальная элемент для сканирования
                        
                        Форма в которой представлен начальный элемент сканирования задаётся
                        параметром <strong>$type</strong>.
                        
                        Синтаксис этого параметра схож с запросом RPN, который описан для
                        <strong>yaz_search()</strong>. Он состоит из нуля или более операторных настроек <return>@attr</return>, за
                        которыми следует единственная лексема.
  <info>array</info>     <strong>$flags</strong>      Этот необязательный параметр определяет дополнительную информацию для
                        управления поведением запроса сканирования. Из массива флагов доступны три
                        индекса: <return>number</return> (количество запрашиваемых термов), <return>position</return> (позиция терма)
                        и <return>stepSize</return> (размер шага).

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


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

<comment>Param:</comment>
  <info>resource</info>  <strong>$id</strong>      Дескриптор соединения, возвращённый <strong>yaz_connect()</strong>.
  <info>array</info>     <strong>$result</strong>  Если задан, то этот массив будет содержать дополнительную информацию из запроса
                     сканирования: <return>number</return> - Количество возвращённых элементов <return>stepsize</return> - Размер шага
                     <return>position</return> - Позиция терма <return>status</return> - Статус сканирования
                     
                     <return>number</return> - Количество возвращённых элементов
                     
                     <return>stepsize</return> - Размер шага
                     
                     <return>position</return> - Позиция терма
                     
                     <return>status</return> - Статус сканирования

<comment>Return:</comment>
  <info>array</info>  Возвращает массив (0..n-1), где n - количество возвращённых термов. Каждое значение массива
         представляет собой пару, первый элемент которой - терм, второй - количество результатов.


id: yaz_schema
type: function
doc:
<comment>Description:</comment>
  Устанавливает схему для возвращаемых значений
    
  
  <strong>yaz_schema()</strong> устанавливает схему для возвращаемых значений.
  
  Функция должна быть вызвана до <strong>yaz_search()</strong> или <strong>yaz_present()</strong>.

<comment>Param:</comment>
  <info>resource</info>  <strong>$id</strong>      Дескриптор соединения, возвращённый <strong>yaz_connect()</strong>.
  <info>string</info>    <strong>$schema</strong>  Схема должна быть определена как OID (Object Identifier) в исходном
                     представлении с разделителями в виде точек (например <return>1.2.840.10003.13.4</return>) или
                     как одна из известных форм имени схемы: <return>GILS-schema</return>, <return>Holdings</return>, <return>Zthes</return>, ...

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


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

<comment>Param:</comment>
  <info>resource</info>  <strong>$id</strong>     Дескриптор соединения, возвращаемый функцией <strong>yaz_connect()</strong>.
  <info>string</info>    <strong>$type</strong>   Данный параметр представляет собой тип запроса. Поддерживается только тип <return>"rpn"</return>.
                    В этом случае третий аргумент определяет запрос Type-1 в префиксной нотации
                    запросов.
  <info>string</info>    <strong>$query</strong>  Запрос RPN является текстовым представлением запроса Type-1, как указано в
                    стандарте Z39.50. Тем не менее в текстовом представлении, используемом в YAZ,
                    применяется префиксная нотация, т.е. оператор предшествует операнду. Строка
                    запроса представляет собой последовательность лексем(токенов), в которой
                    игнорируются пробельные символы, кроме тех, что находятся между двойными
                    кавычками. Лексемы, которые начинаются с символа <return>@</return> являются операторами, иначе
                    они воспринимаются как поисковый термин.
                    
                    Всю информацию о доступных атрибутах вы можете найти на сайте Z39.50 Maintenance
                    Agency
                    
                    Если вы хотите использовать более дружественную нотацию, используйте CCL парсер
                    - функции <strong>yaz_ccl_conf()</strong> и <strong>yaz_ccl_parse()</strong>.

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


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

<comment>Param:</comment>
  <info>resource</info>  <strong>$id</strong>     Дескриптор соединения, возвращённый <strong>yaz_connect()</strong>.
  <info>string</info>    <strong>$name</strong>   Может быть строкой или массивом.
                    
                    Если задана строка, то она будет воспринята как название параметра, которое
                    нужно установить. Нужно задать значение <strong>$value</strong>.
                    
                    Если задан массив, то он должен быть ассоциативным (название параметра =&gt;
                    значение).
  <info>string</info>    <strong>$value</strong>  Новое значение для настройки. Используется только когда предыдущий аргумент
                    является строкой.

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


id: yaz_sort
type: function
doc:
<comment>Description:</comment>
  Задаёт критерий сортировки
  
  Функция задаёт критерий сортировки и включает сортировку по Z39.50.
  
  Эта функция должна быть вызвана до <strong>yaz_search()</strong>. Вызов этой функции отдельно не имеет никакого
  смысла. Когда она используется совместно с <strong>yaz_search()</strong>, параметры сортировки будут отосланы после
  поискового запроса и до того, как какая-либо запись будет получена по Z39.50 (<strong>yaz_present()</strong>).

<comment>Param:</comment>
  <info>resource</info>  <strong>$id</strong>        Дескриптор соединения, возвращаемый <strong>yaz_connect()</strong>.
  <info>string</info>    <strong>$criteria</strong>  Строка, принимающая вид поле1 флаг1 поле2 флаг2, где поле1 устанавливает
                       первый атрибут сортировки, поле2 - второй и т.д.
                       
                       Поле может определяться либо как числовая комбинация, состоящая из пары
                       тип=значение и разделяемое запятой (например, <return>1=4,2=1</return>), либо как строковый
                       параметр (например, <return>title</return>). Флаг представляет собой последовательность
                       символов, которая не может быть разделена пробелом.
                       
                       Флаги сортировки<return>a</return> Сортировка по возрастанию <return>d</return> Сортировка по убыванию <return>i</return>
                       Сортировка без учёта регистра символов <return>s</return> Сортировка с учётом регистра
                       символов
                       
                       Сортировка по возрастанию
                       
                       Сортировка по убыванию
                       
                       Сортировка без учёта регистра символов
                       
                       Сортировка с учётом регистра символов

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


id: yaz_syntax
type: function
doc:
<comment>Description:</comment>
  Задаёт предпочитаемый синтаксис для извлекаемой записи
    
  
  <strong>yaz_syntax()</strong> задаёт предпочитаемый синтаксис для извлекаемой записи
  
  Функция должна быть вызвана до <strong>yaz_search()</strong> или <strong>yaz_present()</strong>.

<comment>Param:</comment>
  <info>resource</info>  <strong>$id</strong>      Дескриптор соединения, возвращаемый <strong>yaz_connect()</strong>.
  <info>string</info>    <strong>$syntax</strong>  Синтаксис должен быть задан как OID (Object Identifier, идентификатор объекта)
                     в исходном формате, разделённым точками (например <return>1.2.840.10003.5.10</return>) или в
                     качестве известного зарегистрированного формата записи (sutrs, usmarc, grs1,
                     xml и др.).

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


id: yaz_wait
type: function
doc:
<comment>Description:</comment>
  Ожидает выполнения запросов Z39.50 серверами
  
  Функция выполняет сетевое (блокирующее) действие до завершения запроса, подготовленного функциями
  <strong>yaz_connect()</strong>, <strong>yaz_search()</strong>, <strong>yaz_present()</strong>, <strong>yaz_scan()</strong> and <strong>yaz_itemorder()</strong>.
  
  <strong>yaz_wait()</strong> прекращает работу и возвращает результат после того как все сервера или завершат
  выполнение всех запросов или прервут их (в случае ошибок).

<comment>Param:</comment>
  <info>array</info>  <strong>$options</strong>  Ассоциативный массив параметров: <return>timeout</return> Устанавливает время ожидания в секундах.
                   Если сервер не отвечает по прошествии этого времени, он считается нерабочим и
                   <strong>yaz_wait()</strong> прекращает работу. По умолчанию ожидание составляет 15 секунд. <return>event</return>
                   Имеет логический тип.
                   
                   Устанавливает время ожидания в секундах. Если сервер не отвечает по прошествии
                   этого времени, он считается нерабочим и <strong>yaz_wait()</strong> прекращает работу. По
                   умолчанию ожидание составляет 15 секунд.
                   
                   Имеет логический тип.

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


id: zend_thread_id
type: function
doc:
<comment>Description:</comment>
  Возвращает уникальный идентификатор текущего потока выполнения
    
  
  Эта функция возвращает уникальный идентификатор текущего потока выполнения.

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


id: zend_version
type: function
doc:
<comment>Description:</comment>
  Получает версию движка Zend
    
  
  Возвращает строку с номером версии работающего в данный момент ядра Zend Engine.

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

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


id: zip_close
type: function
doc:
<comment>Description:</comment>
  Закрывает дескриптор ZIP-архива
  
  Закрывает дескриптор ZIP-архива.

<comment>Param:</comment>
  <info>resource</info>  <strong>$zip</strong>  ZIP-файл должен быть открыт с помощью функции <strong>zip_open()</strong>.

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

<comment>See Also:</comment>
   * <strong>zip_open()</strong>
   * <strong>zip_read()</strong>


id: zip_entry_close
type: function
doc:
<comment>Description:</comment>
  Закрывает дескриптор директории
  
  Закрывает заданный дескриптор директории.

<comment>Param:</comment>
  <info>resource</info>  <strong>$zip_entry</strong>  Дескриптор директории, ранее открытый функцией <strong>zip_entry_open()</strong>.

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

<comment>See Also:</comment>
   * <strong>zip_entry_open()</strong>
   * <strong>zip_entry_read()</strong>


id: zip_entry_compressedsize
type: function
doc:
<comment>Description:</comment>
  Возвращает сжатый размер файла для дескриптора директории
  
  Возвращает сжатый размер заданного дескриптора директории.

<comment>Param:</comment>
  <info>resource</info>  <strong>$zip_entry</strong>  Дескриптор директории, возвращаемый функцией <strong>zip_read()</strong>.

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

<comment>See Also:</comment>
   * <strong>zip_open()</strong>
   * <strong>zip_read()</strong>


id: zip_entry_compressionmethod
type: function
doc:
<comment>Description:</comment>
  Возвращает метод сжатия дескриптора директории
  
  Возвращает метод сжатия дескриптора директории, заданного в <strong>$zip_entry</strong>.

<comment>Param:</comment>
  <info>resource</info>  <strong>$zip_entry</strong>  Дескриптор директории, возвращаемый функцией <strong>zip_read()</strong>.

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

<comment>See Also:</comment>
   * <strong>zip_open()</strong>
   * <strong>zip_read()</strong>


id: zip_entry_filesize
type: function
doc:
<comment>Description:</comment>
  Возвращает реальный размер файла для дескриптора директории
  
  Возвращает реальный размер заданного дескриптора директории.

<comment>Param:</comment>
  <info>resource</info>  <strong>$zip_entry</strong>  Дескриптор директории, возвращаемый функцией <strong>zip_read()</strong>.

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

<comment>See Also:</comment>
   * <strong>zip_open()</strong>
   * <strong>zip_read()</strong>


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

<comment>Param:</comment>
  <info>resource</info>  <strong>$zip_entry</strong>  Дескриптор директории, возвращаемый функцией <strong>zip_read()</strong>.

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

<comment>See Also:</comment>
   * <strong>zip_open()</strong>
   * <strong>zip_read()</strong>


id: zip_entry_open
type: function
doc:
<comment>Description:</comment>
  Открывает директорию для чтения
  
  Открывает директорию в ZIP-архиве для чтения.

<comment>Param:</comment>
  <info>resource</info>  <strong>$zip_dp</strong>     Дескриптор, возвращаемый функцией <strong>zip_open()</strong>.
  <info>resource</info>  <strong>$zip_entry</strong>  Дескриптор директории, возвращаемый функцией <strong>zip_read()</strong>.
  <info>string</info>    <strong>$mode</strong>       Доступные режимы приведены в документации к функции <strong>fopen()</strong>.
                        
                        В настоящее время параметр <strong>$mode</strong> игнорируется и всегда имеет значение <return>"rb"</return>.
                        Это связано с тем, что ZIP в PHP поддерживается только в режиме чтения.

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

<comment>See Also:</comment>
   * <strong>zip_entry_close()</strong>
   * <strong>zip_entry_read()</strong>


id: zip_entry_read
type: function
doc:
<comment>Description:</comment>
  Читает данные из открытого ранее дескриптора директории
  
  Читает данные из открытого ранее дескриптора директории.

<comment>Param:</comment>
  <info>resource</info>  <strong>$zip_entry</strong>  Дескриптор директории, возвращаемый функцией <strong>zip_read()</strong>.
  <info>int</info>       <strong>$len</strong>        Число байт, которое нужно считать.
                        
                        В параметре необходимо указывать объем данных, которые вы хотите считать,
                        без учёта сжатия.

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

<comment>See Also:</comment>
   * <strong>zip_entry_open()</strong>
   * <strong>zip_entry_close()</strong>
   * <strong>zip_entry_filesize()</strong>


id: zip_open
type: function
doc:
<comment>Description:</comment>
  Открывает ZIP-архив
  
  Открывает ZIP-архив для чтения.

<comment>Param:</comment>
  <info>string</info>  <strong>$filename</strong>  Имя файла ZIP-архива для открытия.

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

<comment>See Also:</comment>
   * <strong>zip_read()</strong>
   * <strong>zip_close()</strong>


id: zip_read
type: function
doc:
<comment>Description:</comment>
  Считывает следующую запись в ZIP-архиве
  
  Считывает следующую запись в ZIP-архиве.

<comment>Param:</comment>
  <info>resource</info>  <strong>$zip</strong>  ZIP-файл, предварительно открытый с помощью функции <strong>zip_open()</strong>.

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

<comment>See Also:</comment>
   * <strong>zip_open()</strong>
   * <strong>zip_close()</strong>
   * <strong>zip_entry_open()</strong>
   * <strong>zip_entry_read()</strong>


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

<comment>Param:</comment>
  <info>string</info>  <strong>$data</strong>        
  <info>int</info>     <strong>$max_length</strong>  

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

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


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

<comment>Param:</comment>
  <info>string</info>  <strong>$data</strong>      Данные для сжатия.
  <info>int</info>     <strong>$encoding</strong>  Алгоритм сжатия. Одна из констант <info>ZLIB_ENCODING_RAW</info>, <info>ZLIB_ENCODING_DEFLATE</info> или
                     <info>ZLIB_ENCODING_GZIP</info>.
  <info>int</info>     <strong>$level</strong>     

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

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


id: zlib_get_coding_type
type: function
doc:
<comment>Description:</comment>
  Возвращает способ кодирования, используемый для сжатия вывода
  
  Возвращает способ кодирования, используемый для сжатия вывода.

<comment>Return:</comment>
  <info>string|false</info>  Возможные значения: <return>gzip</return>, <return>deflate</return> или <info>false</info>.

<comment>See Also:</comment>
   * 
     Директива zlib.output_compression
    


id: zookeeper_dispatch
type: function
doc:
<comment>Description:</comment>
  Вызвать callback-функции для ожидающих операций
  
  Функция <strong>zookeeper_dispatch()</strong> вызывает callback-функции, переданные операциями, такими как
  Zookeeper::get или Zookeeper::exists.
  
  С версии 0.4.0 эта функция должна вызываться вручную для асинхронных операций. Если вы хотите,
  чтобы это было сделано автоматически, вы можете объявить тики в самом начале скрипта, используя
  директиву declare.
  
  После PHP 7.1 вы можете игнорировать эту функцию. Модуль использует EG (vm_interrupt) для
  реализации асинхронного вызова callback-функций.

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

<comment>See Also:</comment>
   * Zookeeper::addAuth
   * Zookeeper::connect
   * Zookeeper::__construct
   * Zookeeper::exists
   * Zookeeper::get
   * Zookeeper::getChildren
   * Zookeeper::setWatcher


