# php_manual

id: imagesetpixel
type: function
doc:
<comment>Description:</comment>
  Рисование точки
  
  <strong>imagesetpixel()</strong> рисует точку (пиксел) на заданных координатах.

<comment>Param:</comment>
  <info>GdImage</info>  <strong>$image</strong>  Объект <class>GdImage</class>, возвращаемый одной из функций создания изображений,
                   например, такой как <strong>imagecreatetruecolor()</strong>.
  <info>int</info>      <strong>$x</strong>      x-координата.
  <info>int</info>      <strong>$y</strong>      y-координата.
  <info>int</info>      <strong>$color</strong>  Идентификатор цвета, созданный функцией <strong>imagecolorallocate()</strong>.

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

<comment>See Also:</comment>
   * <strong>imagecreatetruecolor()</strong>
   * <strong>imagecolorallocate()</strong>
   * <strong>imagecolorat()</strong>


id: imagesetstyle
type: function
doc:
<comment>Description:</comment>
  Установка стиля рисования линий
    
  
  <strong>imagesetstyle()</strong> задаёт стиль, который будет использоваться функциями рисования линий (такими как
  <strong>imageline()</strong> и <strong>imagepolygon()</strong>) при задании специального цвета <info>IMG_COLOR_STYLED</info> или
  <info>IMG_COLOR_STYLEDBRUSHED</info>.

<comment>Param:</comment>
  <info>GdImage</info>  <strong>$image</strong>  Объект <class>GdImage</class>, возвращаемый одной из функций создания изображений,
                   например, такой как <strong>imagecreatetruecolor()</strong>.
  <info>array</info>    <strong>$style</strong>  Массив с цветами пикселов. Можно использовать константу <info>IMG_COLOR_TRANSPARENT</info> для
                   добавления прозрачной точки. Обратите внимание, что <strong>$style</strong> не должен быть пустым
                   массивом.

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

<comment>See Also:</comment>
   * <strong>imagesetbrush()</strong>
   * <strong>imageline()</strong>


id: imagesetthickness
type: function
doc:
<comment>Description:</comment>
  Установка толщины линий
  
  <strong>imagesetthickness()</strong> задаёт значение толщины линий для рисования отрезков, прямоугольников,
  многоугольников, эллипсов и т.п. в <strong>$thickness</strong> пикселов.

<comment>Param:</comment>
  <info>GdImage</info>  <strong>$image</strong>      Объект <class>GdImage</class>, возвращаемый одной из функций создания изображений,
                       например, такой как <strong>imagecreatetruecolor()</strong>.
  <info>int</info>      <strong>$thickness</strong>  Толщина в пикселах.

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


id: imagesettile
type: function
doc:
<comment>Description:</comment>
  Установка изображения, которое будет использовано в качестве элемента мозаичной
     заливки
    
  
  <strong>imagesettile()</strong> задаёт изображение, которое будет использовано в качестве элемента мозаичной
  заливки такими функциями, как <strong>imagefill()</strong> и <strong>imagefilledpolygon()</strong> при использовании специального
  цвета <info>IMG_COLOR_TILED</info>.
  
  Это изображение используется для замощения области изображения его копиями. Может использовать
  любое GD изображение. А если задать прозрачный цвет для этого изображения функцией
  <strong>imagecolortransparent()</strong>, некоторые части нижележащего изображения будут просвечивать через
  созданную мозаику.
  
  Дополнительных действий после завершения работы с мозаичным элементом не требуется, однако если
  это изображение будет удалено (или позволить PHP удалить его), нельзя использовать цвет
  <info>IMG_COLOR_TILED</info> до тех пор, пока не будет задано новое изображение!

<comment>Param:</comment>
  <info>GdImage</info>  <strong>$image</strong>  Объект <class>GdImage</class>, возвращаемый одной из функций создания изображений,
                   например, такой как <strong>imagecreatetruecolor()</strong>.
  <info>GdImage</info>  <strong>$tile</strong>   Объект изображения для использования в мозаике.

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


id: imagestring
type: function
doc:
<comment>Description:</comment>
  Рисование строки текста горизонтально
  
  Рисует текст <strong>$string</strong> на заданных координатах.

<comment>Param:</comment>
  <info>GdImage</info>     <strong>$image</strong>   Объект <class>GdImage</class>, возвращаемый одной из функций создания изображений,
                       например, такой как <strong>imagecreatetruecolor()</strong>.
  <info>GdFont|int</info>  <strong>$font</strong>    Может принимать значения 1, 2, 3, 4, 5 для встроенных шрифтов в кодировке
                       latin2 (более высокое число соответствует большему шрифту) или экземпляр
                       <class>GdFont</class>,
                       возвращаемый функцией <strong>imageloadfont()</strong>..
  <info>int</info>         <strong>$x</strong>       x-координата верхнего левого угла.
  <info>int</info>         <strong>$y</strong>       y-координата верхнего левого угла.
  <info>string</info>      <strong>$string</strong>  Строка текста.
  <info>int</info>         <strong>$color</strong>   Идентификатор цвета, созданный функцией <strong>imagecolorallocate()</strong>.

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

<comment>See Also:</comment>
   * <strong>imagestringup()</strong>
   * <strong>imageloadfont()</strong>
   * <strong>imagettftext()</strong>


id: imagestringup
type: function
doc:
<comment>Description:</comment>
  Рисование строки текста вертикально
  
  Рисует текст <strong>$string</strong> вертикально на заданных координатах.

<comment>Param:</comment>
  <info>GdImage</info>     <strong>$image</strong>   Объект <class>GdImage</class>, возвращаемый одной из функций создания изображений,
                       например, такой как <strong>imagecreatetruecolor()</strong>.
  <info>GdFont|int</info>  <strong>$font</strong>    Может принимать значения 1, 2, 3, 4, 5 для встроенных шрифтов в кодировке
                       latin2 (более высокое число соответствует большему шрифту) или экземпляр
                       <class>GdFont</class>,
                       возвращаемый функцией <strong>imageloadfont()</strong>..
  <info>int</info>         <strong>$x</strong>       x-координата нижнего левого угла.
  <info>int</info>         <strong>$y</strong>       y-координата нижнего левого угла.
  <info>string</info>      <strong>$string</strong>  Текст надписи.
  <info>int</info>         <strong>$color</strong>   Идентификатор цвета, созданный функцией <strong>imagecolorallocate()</strong>.

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

<comment>See Also:</comment>
   * <strong>imagestring()</strong>
   * <strong>imageloadfont()</strong>


id: imagesx
type: function
doc:
<comment>Description:</comment>
  Получение ширины изображения
  
  Возвращает ширину заданного изображения <strong>$image</strong>.

<comment>Param:</comment>
  <info>GdImage</info>  <strong>$image</strong>  Объект <class>GdImage</class>, возвращаемый одной из функций создания изображений,
                   например, такой как <strong>imagecreatetruecolor()</strong>.

<comment>Return:</comment>
  <info>int</info>  Возвращает ширину изображения <strong>$image</strong>.

<comment>See Also:</comment>
   * <strong>imagecreatetruecolor()</strong>
   * <strong>getimagesize()</strong>
   * <strong>imagesy()</strong>


id: imagesy
type: function
doc:
<comment>Description:</comment>
  Получение высоты изображения
  
  Возвращает высоту заданного изображения <strong>$image</strong>.

<comment>Param:</comment>
  <info>GdImage</info>  <strong>$image</strong>  Объект <class>GdImage</class>, возвращаемый одной из функций создания изображений,
                   например, такой как <strong>imagecreatetruecolor()</strong>.

<comment>Return:</comment>
  <info>int</info>  Возвращает высоту изображения <strong>$image</strong>.

<comment>See Also:</comment>
   * <strong>imagecreatetruecolor()</strong>
   * <strong>getimagesize()</strong>
   * <strong>imagesx()</strong>


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

<comment>Param:</comment>
  <info>GdImage</info>  <strong>$image</strong>       Объект <class>GdImage</class>, возвращаемый одной из функций создания изображений,
                        например, такой как <strong>imagecreatetruecolor()</strong>.
  <info>bool</info>     <strong>$dither</strong>      Если задано <info>true</info>, изображение будет сглаживаться. Сглаживание увеличивает
                        шумность картинки, но в то же время обеспечивает лучшую передачу цветов.
  <info>int</info>      <strong>$num_colors</strong>  Задаёт максимальное количество цветов в палитре.

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


id: imagettfbbox
type: function
doc:
<comment>Description:</comment>
  Получение параметров рамки обрамляющей текст написанный TrueType шрифтом
    
  
  Эта функция рассчитывает и возвращает параметры рамки вокруг TrueType текста в пикселах.
  
  До PHP 8.0.0 <strong>imageftbbox()</strong> - это расширенный вариант <strong>imagettfbbox()</strong> который дополнительно
  поддерживает <strong>$extrainfo</strong>. Начиная с PHP 8.0.0, <strong>imagettfbbox()</strong> является псевдонимом <strong>imageftbbox()</strong>.

<comment>Param:</comment>
  <info>float</info>   <strong>$size</strong>      Размер шрифта в типографских пунктах.
  <info>float</info>   <strong>$angle</strong>     Угол в градусах в котором будет измерен <strong>$string</strong>.
  <info></info>        <strong>$fontfile</strong>  Путь к шрифту TrueType, который вы хотите использовать.
                     
                     В зависимости от того, какая библиотека GD используется в PHP, если <strong>$fontfile</strong>
                     не начинается с символа <return>/</return>, то к имени файла будет добавлено <return>.ttf</return> и библиотека
                     будет пытаться искать это имя файла по определённому библиотекой пути шрифтов.
                     
                     При использовании библиотеки GD версии ниже 2.0.18, в качестве разделителя
                     путей для разных файлов шрифтов используется <return>пробел</return>, а не точка с запятой.
                     Непреднамеренное использование этой особенности приведёт к предупреждению:
                     <return>Warning: Could not find/open font</return>. Единственным корректным решением для этих
                     версий библиотек будет перемещение файлов шрифтов в директорию не содержащую
                     пробелов.
                     
                     Во многих случаях, когда шрифт находится в том же каталоге, что и скрипт PHP,
                     поможет следующий трюк.
                     ]]>
                     
                     Обратите внимание, что open_basedir не применяется к <strong>$fontfile</strong>.
  <info>string</info>  <strong>$string</strong>    Измеряемая строка.

<comment>Return:</comment>
  <info>array|false</info>  <strong>imagettfbbox()</strong> возвращает массив из 8 элементов представляющих координаты четырёх
               точек - вершин рамки вокруг текста. В случае ошибки функция вернёт <info>false</info>.
               ключсодержимое0нижний левый угол, X координата1нижний левый угол, Y координата2нижний
               правый угол, X координата3нижний правый угол, Y координата4верхний правый угол, X
               координата5верхний правый угол, Y координата6верхний левый угол, X координата7верхний
               левый угол, Y координата
               
               Точки рассчитаны относительно текста text и независимо от угла <strong>$angle</strong>. То есть
               "верхний левый" означает верхний левый угол, если смотреть на текст горизонтально.

<comment>See Also:</comment>
   * <strong>imagettftext()</strong>
   * <strong>imageftbbox()</strong>


id: imagettftext
type: function
doc:
<comment>Description:</comment>
  Рисование текста на изображении шрифтом TrueType
    
  
  Наносит текст <strong>$text</strong> поверх изображения, используя TrueType шрифт.
  
  До PHP 8.0.0 <strong>imagefttext()</strong> - это расширенный вариант <strong>imagettftext()</strong>, который дополнительно
  поддерживает <strong>$extrainfo</strong>. Начиная с PHP 8.0.0, <strong>imagettftext()</strong> является псевдонимом <strong>imagefttext()</strong>.

<comment>Param:</comment>
  <info>GdImage</info>  <strong>$image</strong>     Объект <class>GdImage</class>, возвращаемый одной из функций создания изображений,
                      например, такой как <strong>imagecreatetruecolor()</strong>.
  <info>float</info>    <strong>$size</strong>      Размер шрифта в типографских пунктах.
  <info>float</info>    <strong>$angle</strong>     Угол в градусах, 0 градусов означает расположение текста слева направо.
                      Положительные значения означают поворот текста против часовой стрелки.
                      Например, текст повёрнутый на 90 градусов нужно будет читать снизу вверх.
  <info>int</info>      <strong>$x</strong>         Координаты <strong>$x</strong> и <strong>$y</strong> определяют отправную точку для первого символа текста
                      (конкретно, левый нижний угол символа). Здесь есть отличие от функции
                      <strong>imagestring()</strong>, в которой <strong>$x</strong> и <strong>$y</strong> определяют верхний левый угол первого
                      символа. Например, "верхний левый" имеет координаты 0,0.
  <info>int</info>      <strong>$y</strong>         y-координата. Это позиция базовой линии шрифта, в общем случае она не
                      совпадает с низшей точкой в символе.
  <info>int</info>      <strong>$color</strong>     Индекс цвета. Использование отрицательных индексов создаёт эффект выключенного
                      сглаживания. Смотрите <strong>imagecolorallocate()</strong>.
  <info></info>         <strong>$fontfile</strong>  Путь к шрифту TrueType, который вы хотите использовать.
                      
                      В зависимости от того, какая библиотека GD используется в PHP, если <strong>$fontfile</strong>
                      не начинается с символа <return>/</return>, то к имени файла будет добавлено <return>.ttf</return> и библиотека
                      будет пытаться искать это имя файла по определённому библиотекой пути шрифтов.
                      
                      При использовании библиотеки GD версии ниже 2.0.18, в качестве разделителя
                      путей для разных файлов шрифтов используется <return>пробел</return>, а не точка с запятой.
                      Непреднамеренное использование этой особенности приведёт к предупреждению:
                      <return>Warning: Could not find/open font</return>. Единственным корректным решением для этих
                      версий библиотек будет перемещение файлов шрифтов в директорию не содержащую
                      пробелов.
                      
                      Во многих случаях, когда шрифт находится в том же каталоге, что и скрипт PHP,
                      поможет следующий трюк.
                      ]]>
                      
                      Обратите внимание, что open_basedir не применяется к <strong>$fontfile</strong>.
  <info>string</info>   <strong>$text</strong>      Текстовая строка в кодировке UTF-8.
                      
                      Для доступа к символам после 127го можно использовать числовые ссылки (в
                      формате: &#8364;). Также поддерживается шестнадцатеричный формат (&#xA9;).
                      Строки в кодировке UTF-8 можно передавать напрямую.
                      
                      Именованные сущности, вроде &copy;, не поддерживаются. Используйте функцию
                      <strong>html_entity_decode()</strong>, чтобы декодировать их в UTF-8 строки.
                      
                      Если символ не поддерживается шрифтом, вместо него будет нарисован
                      незакрашенный прямоугольник.

<comment>Return:</comment>
  <info>array|false</info>  Возвращает массив из 8 элементов, представляющих 4 точки - координаты углов рамки
               обрамляющей текст. Точки представлены в таком порядке: левый нижний угол, правый
               нижний, верхний правый, верхний левый. Углы указаны относительно текста, то есть
               "верхний левый" означает верхний левый угол текста, если расположить его
               горизонтально. В случае возникновения ошибки функция вернёт <info>false</info>.

<comment>See Also:</comment>
   * <strong>imagettfbbox()</strong>
   * <strong>imagefttext()</strong>


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

<comment>Return:</comment>
  <info>int</info>  Возвращает битовое поле соответствующее форматам изображений, которые поддерживаются текущей
       версией GD прилинкованной к PHP. Возвращаются следующие биты: <info>IMG_AVIF</info> | <info>IMG_BMP</info> | <info>IMG_GIF</info> |
       <info>IMG_JPG</info> | <info>IMG_PNG</info> | <info>IMG_WBMP</info> | <info>IMG_XPM</info> | <info>IMG_WEBP</info>.

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


id: imagewbmp
type: function
doc:
<comment>Description:</comment>
  Выводит изображение в браузер или пишет в файл
  
  <strong>imagewbmp()</strong> выводит или сохраняет в формате WBMP заданное изображение <strong>$image</strong>.

<comment>Param:</comment>
  <info>GdImage</info>               <strong>$image</strong>             Объект <class>GdImage</class>, возвращаемый одной из функций создания
                                           изображений,
                                           например, такой как <strong>imagecreatetruecolor()</strong>.
  <info>resource|string|null</info>  <strong>$file</strong>              Путь, или открытый потоковый ресурс (который
                                           автоматически закрывается после завершения функции), для
                                           сохранения файла. Если не установлен или равен <info>null</info>,
                                           изображение будет выведено в поток вывода в бинарном
                                           виде.
  <info>int|null</info>              <strong>$foreground_color</strong>  Можно задать цвет верхнего слоя. Цвет задаётся
                                           идентификатором, созданным функцией <strong>imagecolorallocate()</strong>.
                                           По умолчанию цвет чёрный.

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

<comment>See Also:</comment>
   * <strong>image2wbmp()</strong>
   * <strong>imagepng()</strong>
   * <strong>imagegif()</strong>
   * <strong>imagejpeg()</strong>
   * <strong>imagetypes()</strong>


id: imagewebp
type: function
doc:
<comment>Description:</comment>
  Вывод изображения WebP в браузер или файл
  
  Выведет или сохранит WebP-версию данного изображения (<strong>$image</strong>).

<comment>Param:</comment>
  <info>GdImage</info>               <strong>$image</strong>    Объект <class>GdImage</class>, возвращаемый одной из функций создания
                                  изображений,
                                  например, такой как <strong>imagecreatetruecolor()</strong>.
  <info>resource|string|null</info>  <strong>$file</strong>     Путь, или открытый потоковый ресурс (который автоматически
                                  закрывается после завершения функции), для сохранения файла. Если
                                  не установлен или равен <info>null</info>, изображение будет выведено в поток
                                  вывода в бинарном виде.
  <info>int</info>                   <strong>$quality</strong>  <strong>$quality</strong> варьируется от 0 (худшее качество, меньший размер файла)
                                  до 100 (наилучшее качество, большой файл).

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


id: imagexbm
type: function
doc:
<comment>Description:</comment>
  Вывод XBM изображения в браузер или файл
  
  Вывод или сохранение в формате XBM изображения <strong>$image</strong>.
  
  <strong>imagexbm()</strong> не использует дополнение, так что ширина изображения должна быть кратна 8. Это
  ограничение не накладывается с версий PHP 7.0.9.

<comment>Param:</comment>
  <info>GdImage</info>      <strong>$image</strong>             Объект <class>GdImage</class>, возвращаемый одной из функций создания
                                  изображений,
                                  например, такой как <strong>imagecreatetruecolor()</strong>.
  <info>string|null</info>  <strong>$filename</strong>          Путь, по которому сохранять файл, заданный как строка (<info>string</info>)
                                  Если не установлено, или равно <info>null</info>, будет произведён прямой вывод
                                  необработанного потока изображения.
                                  
                                  <strong>$filename</strong> (без расширения .xbm) также используется как
                                  идентификатор C XBM, при этом символы, не являющиеся в текущей
                                  локали цифрами или буквами, заменяются на подчёркивание. Если
                                  <strong>$filename</strong> задан как <info>null</info>, <return>image</return> будет использован для создания
                                  идентификатора C.
  <info>int|null</info>     <strong>$foreground_color</strong>  Можно задать цвет верхнего слоя. Цвет задаётся идентификатором
                                  созданным функцией <strong>imagecolorallocate()</strong>. По умолчанию цвет чёрный.
                                  Все остальные цвета интерпретируются как цвета подложки
                                  (background).

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


id: imagick::ALPHACHANNEL_ACTIVATE
type: constant
doc:
<comment>Description:</comment>
  Эта константа доступна, если Imagick был скомпилирован с версией ImageMagick  6.3.8 или выше.


id: imagick::ALPHACHANNEL_ASSOCIATE
type: constant
doc:
<comment>Description:</comment>
  Эта константа доступна, если Imagick был скомпилирован с версией ImageMagick  6.9.0 или выше.


id: imagick::ALPHACHANNEL_BACKGROUND
type: constant
doc:
<comment>Description:</comment>
  Эта константа доступна, если Imagick был скомпилирован с версией ImageMagick  6.5.3 или выше.


id: imagick::ALPHACHANNEL_COPY
type: constant
doc:
<comment>Description:</comment>
  Эта константа доступна, если Imagick был скомпилирован с версией ImageMagick  6.4.6 или выше.


id: imagick::ALPHACHANNEL_DISCRETE
type: constant
doc:
<comment>Description:</comment>
  Эта константа доступна, если Imagick был скомпилирован с версией ImageMagick  7.0.0 или выше.


id: imagick::ALPHACHANNEL_REMOVE
type: constant
doc:
<comment>Description:</comment>
  Эта константа доступна, если Imagick был скомпилирован с версией ImageMagick  6.7.8 или выше.


id: imagick::COLORSPACE_CMY
type: constant
doc:
<comment>Description:</comment>
  Эта константа доступна, если Imagick был скомпилирован с версией ImageMagick  6.4.2 или выше.


id: imagick::COMPOSITE_ATOP
type: constant
doc:
<comment>Description:</comment>
  Результатом будет изображение такой же формы с наложением изображения затемняя его в местах
  перекрытия


id: imagick::COMPOSITE_BUMPMAP
type: constant
doc:
<comment>Description:</comment>
  Так же, как COMPOSITE_MULTIPLY, за исключением того, что источник сначала преобразуется в оттенки
  серого.


id: imagick::COMPOSITE_COLORDODGE
type: constant
doc:
<comment>Description:</comment>
  Повышенная яркость конечного изображения с учётом исходного изображения


id: imagick::COMPOSITE_DISPLACE
type: constant
doc:
<comment>Description:</comment>
  Смещение пикселей заданного изображения по аналогии с исходным изображением


id: imagick::COMPOSITE_DSTATOP
type: constant
doc:
<comment>Description:</comment>
  Область назначения, которая находится внутри исходного изображения накладывается поверх исходного
  и заменяет назначение


id: imagick::COMPOSITE_DSTIN
type: constant
doc:
<comment>Description:</comment>
  Область внутри исходного изображения заменяется заданным изображением


id: imagick::COMPOSITE_DSTOUT
type: constant
doc:
<comment>Description:</comment>
  Область снаружи исходного изображения заменяется заданным изображением


id: imagick::COMPOSITE_EXCLUSION
type: constant
doc:
<comment>Description:</comment>
  Создание эффекта, похожего на imagick::COMPOSITE_DIFFERENCE, но с более низким контрастом


id: imagick::COMPOSITE_HARDLIGHT
type: constant
doc:
<comment>Description:</comment>
  Умножает или осветляет цвет, в зависимости от исходного значения цвета


id: imagick::COMPOSITE_HUE
type: constant
doc:
<comment>Description:</comment>
  Изменение оттенка заданного изображения по аналогии с исходным изображением


id: imagick::COMPOSITE_LIGHTEN
type: constant
doc:
<comment>Description:</comment>
  Освещает заданное изображение по аналогии с исходным изображением


id: imagick::COMPOSITE_LUMINIZE
type: constant
doc:
<comment>Description:</comment>
  Изменение яркости заданного изображения по аналогии с исходным изображением


id: imagick::COMPOSITE_MODULATE
type: constant
doc:
<comment>Description:</comment>
  Модулирует целевые яркость, насыщенности и тон по аналогии с исходным изображением


id: imagick::COMPOSITE_SCREEN
type: constant
doc:
<comment>Description:</comment>
  Источник и цель сначала дополняются, потом перемножаются, а потом источник заменяет цель.


id: imagick::COMPOSITE_XOR
type: constant
doc:
<comment>Description:</comment>
  Часть источника, лежащая вне цели комбинируется с частью цели, лежащей вне источника


id: imagick::COMPRESSION_DXT1
type: constant
doc:
<comment>Description:</comment>
  Эта константа доступна, если Imagick был скомпилирован с версией ImageMagick  6.4.0 или выше.


id: imagick::DISTORTION_AFFINE
type: constant
doc:
<comment>Description:</comment>
  Эта константа доступна, если Imagick был скомпилирован с версией ImageMagick  6.3.6 или выше.


id: imagick::EVALUATE_ADDMODULUS
type: constant
doc:
<comment>Description:</comment>
  Эта константа доступна, если Imagick был скомпилирован с версией ImageMagick  6.4.4 или выше.


id: imagick::FUNCTION_POLYNOMIAL
type: constant
doc:
<comment>Description:</comment>
  Эта константа доступна, если Imagick был скомпилирован с версией ImageMagick  6.4.9 или выше.


id: imagick::INTERLACE_GIF
type: constant
doc:
<comment>Description:</comment>
  Эта константа доступна, если Imagick был скомпилирован с версией ImageMagick  6.3.4 или выше.


id: imagick::INTERPOLATE_AVERAGE
type: constant
doc:
<comment>Description:</comment>
  Эта константа доступна, если Imagick был скомпилирован с версией ImageMagick  6.3.2 или выше.


id: imagick::LAYERMETHOD_COALESCE
type: constant
doc:
<comment>Description:</comment>
  Эта константа доступна, если Imagick был скомпилирован с версией ImageMagick  6.2.9 или выше.


id: imagick::LAYERMETHOD_COMPOSITE
type: constant
doc:
<comment>Description:</comment>
  Эта константа доступна, если Imagick был скомпилирован с версией ImageMagick  6.3.0 или выше.


id: imagick::LAYERMETHOD_FLATTEN
type: constant
doc:
<comment>Description:</comment>
  Эта константа доступна, если Imagick был скомпилирован с версией ImageMagick  6.3.7 или выше.


id: imagick::RESOURCETYPE_AREA
type: constant
doc:
<comment>Description:</comment>
  Определяет максимальную ширину * высоту изображения, которое может находиться в пиксеном кеше.


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


id: imagick::RESOURCETYPE_FILE
type: constant
doc:
<comment>Description:</comment>
  Определяет максимальное количество открытых файлов пиксельного кеша..


id: imagick::RESOURCETYPE_MAP
type: constant
doc:
<comment>Description:</comment>
  Определяет максимальное количество памяти, в байтах, под пиксельный кеш.


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


id: imagick::RESOURCETYPE_THREAD
type: constant
doc:
<comment>Description:</comment>
  Определяет максимальное количество параллельных потоков. Эта константа доступна, если Imagick был
  скомпилирован с версией ImageMagick  6.7.8 или выше.


id: imagick::VIRTUALPIXELMETHOD_HORIZONTALTILE
type: constant
doc:
<comment>Description:</comment>
  Эта константа доступна, если Imagick был скомпилирован с версией ImageMagick  6.4.3 или выше.


id: imap_8bit
type: function
doc:
<comment>Description:</comment>
  Конвертирует 8-битную строку в строку в формате quoted-printable
  
  Конвертирует 8-битную строку в строку, закодированную механизмом quoted-printable (в соответствии
  с RFC2045, раздел 6.7).

<comment>Param:</comment>
  <info>string</info>  <strong>$string</strong>  8-битная строка для конвертации

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

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


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

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

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


id: imap_append
type: function
doc:
<comment>Description:</comment>
  Добавляет строковое сообщение в указанный почтовый ящик
  
  Добавляет строку <strong>$message</strong> в указанный <strong>$folder</strong>.

<comment>Param:</comment>
  <info>IMAP\Connection</info>  <strong>$imap</strong>           Экземпляр <class>IMAP\Connection</class>.
  <info>string</info>           <strong>$folder</strong>         Имя почтового ящика. Смотрите <strong>imap_open()</strong> для подробной
                                   информации.
                                   
                                   Если imap.enable_insecure_rsh не отключён, то передача в этот
                                   параметр не проверенных данных не безопасна.
  <info>string</info>           <strong>$message</strong>        Добавляемое сообщение в виде строки
                                   
                                   При обращении к серверу Cyrus IMAP следует использовать "\r\n"
                                   как завершающий символ строки вместо "\n", иначе операция будет
                                   неудачна.
  <info>string|null</info>      <strong>$options</strong>        Если указан, то параметр <strong>$options</strong> также будет записан в <strong>$folder</strong>
  <info>string|null</info>      <strong>$internal_date</strong>  Если этот параметр указан, он установит INTERNALDATE в
                                   добавляемом сообщении.  Параметр должен содержать дату,
                                   представленную строкой, которая соответствует спецификации
                                   rfc2060 для значения date_time.

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


id: imap_base64
type: function
doc:
<comment>Description:</comment>
  Декодировать текст закодированный BASE64
  
  Декодирует текст <strong>$string</strong>, закодированный BASE64.

<comment>Param:</comment>
  <info>string</info>  <strong>$string</strong>  Закодированный текст

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

<comment>See Also:</comment>
   * <strong>imap_binary()</strong>
   * <strong>base64_encode()</strong>
   * <strong>base64_decode()</strong>
   * RFC2045, секция 6.8


id: imap_binary
type: function
doc:
<comment>Description:</comment>
  Конвертирует 8-битную строку в строку base64
  
  Конвертирует 8-битную строку в строку base64 в соответствии с RFC2045, Секция 6.8.

<comment>Param:</comment>
  <info>string</info>  <strong>$string</strong>  8-битная строка

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

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


id: imap_body
type: function
doc:
<comment>Description:</comment>
  Прочитать тело сообщения
  
  <strong>imap_body()</strong> возвращает тело сообщения с номером  <strong>$message_num</strong> в текущем почтовом ящике.
  
  <strong>imap_body()</strong> вернёт точную копию тела сообщения. Для извлечения одной части составного
  MIME-сообщения используйте <strong>imap_fetchstructure()</strong> для анализа структуры и <strong>imap_fetchbody()</strong> для
  извлечения копии одной из частей тела.

<comment>Param:</comment>
  <info>IMAP\Connection</info>  <strong>$imap</strong>         Экземпляр <class>IMAP\Connection</class>.
  <info>int</info>              <strong>$message_num</strong>  Номер сообщения
  <info>int</info>              <strong>$flags</strong>        Опциональный параметр <strong>$flags</strong>, являющийся битовой маской одной или
                                 нескольких констант: <info>FT_UID</info> -  <strong>$message_num</strong> является UID <info>FT_PEEK</info> -
                                 Не устанавливать флаг Просмотрено (\Seen), если он уже не
                                 установлен. <info>FT_INTERNAL</info> - возвращаемая строка будет во внутреннем
                                 формате, а не канонизирована к CRLF.
                                 
                                 <info>FT_UID</info> -  <strong>$message_num</strong> является UID
                                 
                                 <info>FT_PEEK</info> - Не устанавливать флаг Просмотрено (\Seen), если он уже не
                                 установлен.
                                 
                                 <info>FT_INTERNAL</info> - возвращаемая строка будет во внутреннем формате, а не
                                 канонизирована к CRLF.

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


id: imap_bodystruct
type: function
doc:
<comment>Description:</comment>
  Прочитать структуру указанной секции тела
     заданного сообщения
  
  Читает структуру указанной секции тела заданного сообщения.

<comment>Param:</comment>
  <info>IMAP\Connection</info>  <strong>$imap</strong>         Экземпляр <class>IMAP\Connection</class>.
  <info>int</info>              <strong>$message_num</strong>  Номер сообщения
  <info>string</info>           <strong>$section</strong>      Секция тела для чтения

<comment>Return:</comment>
  <info>stdClass|false</info>  Возвращает информацию в виде объекта или <info>false</info> в случае возникновения ошибки.
                  Описание структуры и свойств объекта читайте в разделе, посвящённом функции
                  <strong>imap_fetchstructure()</strong>.

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


id: imap_check
type: function
doc:
<comment>Description:</comment>
  Проверить текущий почтовый ящик
  
  Проверяет информацию текущего почтового ящика.

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

<comment>Return:</comment>
  <info>stdClass|false</info>  Возвращает объект со следующими свойствами: <info>Date</info> - текущее системное время в
                  формате соответствующем RFC2822 <info>Driver</info> - протокол, используемый для доступа к
                  почтовому ящику: POP3, IMAP, NNTP <info>Mailbox</info> - имя почтового ящика <info>Nmsgs</info> - количество
                  сообщений <info>Recent</info> - количество новых сообщений
                  
                  <info>Date</info> - текущее системное время в формате соответствующем RFC2822
                  
                  <info>Driver</info> - протокол, используемый для доступа к почтовому ящику: POP3, IMAP, NNTP
                  
                  <info>Mailbox</info> - имя почтового ящика
                  
                  <info>Nmsgs</info> - количество сообщений
                  
                  <info>Recent</info> - количество новых сообщений
                  
                  В случае возникновения ошибки возвращает <info>false</info>.


id: imap_clearflag_full
type: function
doc:
<comment>Description:</comment>
  Снять с сообщения установленные флаги
  
  Эта функция оповещает хранилище, что необходимо снять заданный флаг <strong>$flag</strong> для указанной
  последовательности сообщений <strong>$sequence</strong>.

<comment>Param:</comment>
  <info>IMAP\Connection</info>  <strong>$imap</strong>      Экземпляр <class>IMAP\Connection</class>.
  <info>string</info>           <strong>$sequence</strong>  Последовательность номеров сообщений. Вы можете перечислить номера
                              через запятую <return>X,Y</return>, или задать диапазон номеров с помощью двоеточия <return>X:Y</return>
  <info>string</info>           <strong>$flag</strong>      Флаги, которые можно удалить: "\\Seen", "\\Answered", "\\Flagged",
                              "\\Deleted" и "\\Draft" (как определено в RFC2060)
  <info>int</info>              <strong>$options</strong>   <strong>$options</strong> - битовая маска, которая может принимать единственное
                              значение: <info>ST_UID</info> - аргумент sequence содержит список UID, а не
                              последовательность номеров
                              
                              <info>ST_UID</info> - аргумент sequence содержит список UID, а не
                              последовательность номеров

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

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


id: imap_close
type: function
doc:
<comment>Description:</comment>
  Закрыть поток IMAP
  
  Закрывает поток IMAP.

<comment>Param:</comment>
  <info>IMAP\Connection</info>  <strong>$imap</strong>   Экземпляр <class>IMAP\Connection</class>.
  <info>int</info>              <strong>$flags</strong>  Если установлен <info>CL_EXPUNGE</info>, то эта функция молча применит все внесённые
                           изменения, в частности удалит все сообщения помеченные для удаления. По
                           сути сделает то же, что и функция <strong>imap_expunge()</strong>

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

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


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


id: imap_createmailbox
type: function
doc:
<comment>Description:</comment>
  Создать новый почтовый ящик
  
  Создаёт новый почтовый ящик, указанный в <strong>$mailbox</strong>.

<comment>Param:</comment>
  <info>IMAP\Connection</info>  <strong>$imap</strong>     Экземпляр <class>IMAP\Connection</class>.
  <info>string</info>           <strong>$mailbox</strong>  Имя почтового ящика. Более подробно смотрите <strong>imap_open()</strong>. Имена
                             почтовых ящиков, содержащие интернациональные символы должны быть
                             закодированы с помощью <strong>imap_utf7_encode()</strong>.
                             
                             Если imap.enable_insecure_rsh не отключён, то передача в этот параметр
                             не проверенных данных не безопасна.

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

<comment>See Also:</comment>
   * <strong>imap_renamemailbox()</strong>
   * <strong>imap_deletemailbox()</strong>


id: imap_delete
type: function
doc:
<comment>Description:</comment>
  Пометить сообщение для удаления
  
  Помечает сообщения, перечисленные в <strong>$message_nums</strong> для удаления. Помеченные сообщения будут
  оставаться в ящике пока не будет вызвана функция <strong>imap_expunge()</strong>, либо <strong>imap_close()</strong> с установленным
  параметром <info>CL_EXPUNGE</info>.

<comment>Param:</comment>
  <info>IMAP\Connection</info>  <strong>$imap</strong>          Экземпляр <class>IMAP\Connection</class>.
  <info>string</info>           <strong>$message_nums</strong>  Строка (<info>string</info>), состоящая из одного или нескольких сообщений в
                                  формате последовательности в стиле IMAP4 (<return>"n"</return>, <return>"n:m"</return> или их
                                  комбинация, разделённая запятыми).
  <info>int</info>              <strong>$flags</strong>         Можно задать как <info>FT_UID</info>, тогда функция будет ожидать в параметре
                                  <strong>$message_nums</strong> не номер сообщения, а <return>UID</return>.

<comment>Return:</comment>
  <info>bool</info>  Возвращает <info>true</info>.

<comment>See Also:</comment>
   * <strong>imap_undelete()</strong>
   * <strong>imap_expunge()</strong>
   * <strong>imap_close()</strong>


id: imap_deletemailbox
type: function
doc:
<comment>Description:</comment>
  Удалить почтовый ящик
  
  Удаляет почтовый ящик <strong>$mailbox</strong>.

<comment>Param:</comment>
  <info>IMAP\Connection</info>  <strong>$imap</strong>     Экземпляр <class>IMAP\Connection</class>.
  <info>string</info>           <strong>$mailbox</strong>  Имя ящика. Более подробно читайте в описании <strong>imap_open()</strong>
                             
                             Если imap.enable_insecure_rsh не отключён, то передача в этот параметр
                             не проверенных данных не безопасна.

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

<comment>See Also:</comment>
   * <strong>imap_createmailbox()</strong>
   * <strong>imap_renamemailbox()</strong>
   * <strong>imap_open()</strong> для формата <strong>$mbox</strong>
    


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

<comment>Return:</comment>
  <info>array|false</info>  Эта функция возвращает массив всех ошибок IMAP, возникших с момента последнего
               запуска <strong>imap_errors()</strong> или с начала страницы. Если таковых нет, возвращает <info>false</info>.

<comment>See Also:</comment>
   * <strong>imap_last_error()</strong>
   * <strong>imap_alerts()</strong>


id: imap_expunge
type: function
doc:
<comment>Description:</comment>
  Удалить все помеченные для удаления сообщения
  
  Удаляет все помеченные для удаления сообщения. Пометить для удаления можно с помощью функций
  <strong>imap_delete()</strong>, <strong>imap_mail_move()</strong> или <strong>imap_setflag_full()</strong>.

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

<comment>Return:</comment>
  <info>bool</info>  Возвращает <info>true</info>.


id: imap_fetch_overview
type: function
doc:
<comment>Description:</comment>
  Обзор информации, содержащейся в заголовках сообщений
  
  Эта функция читает заголовки сообщений, заданных в <strong>$sequence</strong> и возвращает обзорную информацию об
  их контенте.

<comment>Param:</comment>
  <info>IMAP\Connection</info>  <strong>$imap</strong>      Экземпляр <class>IMAP\Connection</class>.
  <info>string</info>           <strong>$sequence</strong>  Последовательность номеров сообщений.Вы можете перечислить несколько
                              сообщений, используя как разделитель запятую (<return>X,Y</return>), или задать
                              интервал сообщений с помощью двоеточия <return>X:Y</return>
  <info>int</info>              <strong>$flags</strong>     Параметр <strong>$sequence</strong> должен содержать номера сообщений. Если вы хотите
                              задать в нем их UID, то этот параметр необходимо задать значением
                              <info>FT_UID</info>.

<comment>Return:</comment>
  <info>array|false</info>  Возвращает массив объектов, каждый из которых описывает заголовок одного сообщения.
               Объекты содержат соответствующие свойства только если они присутствуют. Возможные
               свойства: <return>subject</return> - тема письма <return>from</return> - кто его послал <return>to</return> - получатель <return>date</return> - когда
               оно было послано <return>message_id</return> - Идентификатор сообщения <return>references</return> - является ссылкой
               на этот идентификатор сообщения <return>in_reply_to</return> - является ответом на письмо с этим
               идентификатором <return>size</return> - размер в байтах <return>uid</return> - UID сообщения в ящике <return>msgno</return> - номер
               сообщения в ящике <return>recent</return> - письмо помечено как новое <return>flagged</return> -  это сообщение
               помечено (обычно является признаком "важности") <return>answered</return> -  сообщение помечено как
               отвеченное <return>deleted</return> -  помечено для удаления <return>seen</return> -  помечено как прочитанное <return>draft</return> -
               помечено как черновик <return>udate</return> -  временная метка UNIX даты получения  Функция
               возвращает <info>false</info> в случае возникновения ошибки.
               
               <return>subject</return> - тема письма
               
               <return>from</return> - кто его послал
               
               <return>to</return> - получатель
               
               <return>date</return> - когда оно было послано
               
               <return>message_id</return> - Идентификатор сообщения
               
               <return>references</return> - является ссылкой на этот идентификатор сообщения
               
               <return>in_reply_to</return> - является ответом на письмо с этим идентификатором
               
               <return>size</return> - размер в байтах
               
               <return>uid</return> - UID сообщения в ящике
               
               <return>msgno</return> - номер сообщения в ящике
               
               <return>recent</return> - письмо помечено как новое
               
               <return>flagged</return> -  это сообщение помечено (обычно является признаком "важности")
               
               <return>answered</return> -  сообщение помечено как отвеченное
               
               <return>deleted</return> -  помечено для удаления
               
               <return>seen</return> -  помечено как прочитанное
               
               <return>draft</return> -  помечено как черновик
               
               <return>udate</return> -  временная метка UNIX даты получения

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


id: imap_fetchbody
type: function
doc:
<comment>Description:</comment>
  Извлечь конкретную секцию тела сообщения
  
  Извлекает конкретную секцию тела сообщения. Секции сообщения в этой функции не декодируются.

<comment>Param:</comment>
  <info>IMAP\Connection</info>  <strong>$imap</strong>         Экземпляр <class>IMAP\Connection</class>.
  <info>int</info>              <strong>$message_num</strong>  Номер сообщения
  <info>string</info>           <strong>$section</strong>      Номер секции сообщения. Строка целых чисел, разделённых точками,
                                 определяющая часть тела сообщения в соответствии со спецификацией
                                 IMAP4
  <info>int</info>              <strong>$flags</strong>        Битовая маска из одной или нескольких опций: <info>FT_UID</info> - параметр
                                 <strong>$message_num</strong> является UID <info>FT_PEEK</info> - Не устанавливать флаг \Seen,
                                 если он уже не установлен <info>FT_INTERNAL</info> - возвращать строку во
                                 внутреннем формате, без преобразования концов строк к CRLF.
                                 
                                 <info>FT_UID</info> - параметр  <strong>$message_num</strong> является UID
                                 
                                 <info>FT_PEEK</info> - Не устанавливать флаг \Seen, если он уже не установлен
                                 
                                 <info>FT_INTERNAL</info> - возвращать строку во внутреннем формате, без
                                 преобразования концов строк к CRLF.

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

<comment>See Also:</comment>
   * <strong>imap_savebody()</strong>
   * <strong>imap_fetchstructure()</strong>


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

<comment>Param:</comment>
  <info>IMAP\Connection</info>  <strong>$imap</strong>         Экземпляр <class>IMAP\Connection</class>.
  <info>int</info>              <strong>$message_num</strong>  Номер сообщения
  <info>int</info>              <strong>$flags</strong>        Допустимые значения <strong>$flags</strong>: <info>FT_UID</info> - параметр <strong>$message_num</strong> является
                                 UID <info>FT_INTERNAL</info> - возвращать строку во внутреннем формате, без
                                 преобразования концов строк к CRLF. <info>FT_PREFETCHTEXT</info> - одновременно
                                 должен быть подгружён RFC822.TEXT. Это позволяет избежать лишнего
                                 RTT при соединении IMAP, если выбран полный текст сообщения
                                 (например при операции "сохранить в файл")
                                 
                                 <info>FT_UID</info> - параметр <strong>$message_num</strong> является UID
                                 
                                 <info>FT_INTERNAL</info> - возвращать строку во внутреннем формате, без
                                 преобразования концов строк к CRLF.
                                 
                                 <info>FT_PREFETCHTEXT</info> - одновременно должен быть подгружён RFC822.TEXT.
                                 Это позволяет избежать лишнего RTT при соединении IMAP, если выбран
                                 полный текст сообщения (например при операции "сохранить в файл")

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

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


id: imap_fetchmime
type: function
doc:
<comment>Description:</comment>
  Извлечь MIME-заголовки для конкретной секции сообщения
  
  Извлекает MIME-заголовки для конкретной секции сообщения.

<comment>Param:</comment>
  <info>IMAP\Connection</info>  <strong>$imap</strong>         Экземпляр <class>IMAP\Connection</class>.
  <info>int</info>              <strong>$message_num</strong>  Номер сообщения
  <info>string</info>           <strong>$section</strong>      Номер секции сообщения. Строка целых чисел, разделённых точками,
                                 определяющая часть тела сообщения в соответствии со спецификацией
                                 IMAP4
  <info>int</info>              <strong>$flags</strong>        Битовая маска из одной или нескольких опций: <info>FT_UID</info> - параметр
                                 <strong>$message_num</strong> является UID <info>FT_PEEK</info> - Не устанавливать флаг \Seen,
                                 если он уже не установлен <info>FT_INTERNAL</info> - возвращать строку во
                                 внутреннем формате, без преобразования концов строк к CRLF.
                                 
                                 <info>FT_UID</info> - параметр <strong>$message_num</strong> является UID
                                 
                                 <info>FT_PEEK</info> - Не устанавливать флаг \Seen, если он уже не установлен
                                 
                                 <info>FT_INTERNAL</info> - возвращать строку во внутреннем формате, без
                                 преобразования концов строк к CRLF.

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

<comment>See Also:</comment>
   * <strong>imap_fetchbody()</strong>
   * <strong>imap_fetchstructure()</strong>
   * <strong>imap_fetchheader()</strong>


id: imap_fetchstructure
type: function
doc:
<comment>Description:</comment>
  Прочитать структуру указанного сообщения
  
  Извлекает информацию о структуре указанного сообщения.

<comment>Param:</comment>
  <info>IMAP\Connection</info>  <strong>$imap</strong>         Экземпляр <class>IMAP\Connection</class>.
  <info>int</info>              <strong>$message_num</strong>  Номер сообщения
  <info>int</info>              <strong>$flags</strong>        Если задано как <info>FT_UID</info>, то в <strong>$message_num</strong> должны быть <return>UID</return>
                                 сообщений, а не их номера.

<comment>Return:</comment>
  <info>stdClass|false</info>  Возвращает объект со свойствами, перечисленными в таблице ниже или <info>false</info> в случае
                  возникновения ошибки.
                  
                   Объект, возвращаемый <strong>imap_fetchstructure()</strong> typeПервичный тип
                  телаencodingКодировка телаifsubtype<info>true</info>, если есть строка
                  подтипаsubtypeMIME-подтипifdescription<info>true</info>, если есть строка
                  описанияdescriptionКонтент строки описанияifid<info>true</info>, если есть строка
                  идентификаторidСтрока идентификаторlinesКоличество строкbytesКоличество
                  байтifdisposition<info>true</info>, если есть строка расположенияdispositionСтрока
                  расположенияifdparameters<info>true</info>, если есть массив dparametersdparametersМассив
                  объектов, каждый из которых имеет свойства <return>"attribute"</return> и <return>"value"</return>, соответствующие
                  параметрам <return>Content-disposition</return> заголовка MIME.ifparameters<info>true</info>, если есть массив
                  параметровparametersМассив объектов, каждый из которых имеет свойства <return>"attribute"</return>
                  и <return>"value"</return>.partsМассив объектов идентичных по структуре с верхнеуровневым объектом,
                  каждый из которых соответствует MIME части тела.
                  
                  Первичный тип тела (значения могут отличаться в зависимости от используемой
                  библиотеки, так что рекомендуется использовать
                  константы)ЗначениеТипКонстанта0textTYPETEXT1multipartTYPEMULTIPART2messageTYPEMESSAGE3applicationTYPEAPPLICATION4audioTYPEAUDIO5imageTYPEIMAGE6videoTYPEVIDEO7modelTYPEMODEL8otherTYPEOTHER
                  
                  Кодировка (значения могут отличаться в зависимости от используемой библиотеки, так
                  что рекомендуется использовать
                  константы)ЗначениеТипКонстанта07bitENC7BIT18bitENC8BIT2BinaryENCBINARY3Base64ENCBASE644Quoted-PrintableENCQUOTEDPRINTABLE5otherENCOTHER

<comment>See Also:</comment>
   * <strong>imap_fetchbody()</strong>
   * <strong>imap_bodystruct()</strong>


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


id: imap_gc
type: function
doc:
<comment>Description:</comment>
  Очистить кеш IMAP
  
  Удаляет из кеша записи заданного типа.

<comment>Param:</comment>
  <info>IMAP\Connection</info>  <strong>$imap</strong>   Экземпляр <class>IMAP\Connection</class>.
  <info>int</info>              <strong>$flags</strong>  Задаёт кеш для чистки. Может быть любой комбинацией констант: <info>IMAP_GC_ELT</info>
                           (элементы кеша сообщений), <info>IMAP_GC_ENV</info> (обёртки и тела), <info>IMAP_GC_TEXTS</info>
                           (тексты).

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


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

<comment>Param:</comment>
  <info>IMAP\Connection</info>  <strong>$imap</strong>        Экземпляр <class>IMAP\Connection</class>.
  <info>string</info>           <strong>$quota_root</strong>  <strong>$quota_root</strong> должно соответствовать формату <return>user.name</return>, где name - имя
                                ящика, информация по которому нужна.

<comment>Return:</comment>
  <info>array|false</info>  Возвращает ассоциативный массив целых чисел с ключами "limit" и "usage". Число с
               ключом "limit" определяет максимальный допустимый размер ящика. Число с ключом
               "usage" определяет текущий уровень использования. В случае возникновения ошибки
               вернёт <info>false</info>.
               
               Начиная с PHP 4.3 и выше, функция более точно соответствует стандарту, описанному в
               RFC2087. Значение возвращаемого массива изменилось для поддержки неограниченного
               количества возвращаемых ресурсов (т.е. сообщений или подпапок), где каждый
               именованный ресурс будет представлен индивидуальным массивом. Каждый элемент массива
               будет содержать другой массив к ключами "limit" и "usage".
               
               Для обеспечения обратной совместимости, оригинальный метод доступа всё ещё доступен,
               хотя предполагается это поправить.

<comment>See Also:</comment>
   * <strong>imap_open()</strong>
   * <strong>imap_set_quota()</strong>
   * <strong>imap_get_quotaroot()</strong>


id: imap_get_quotaroot
type: function
doc:
<comment>Description:</comment>
  Получить настройки квоты для каждого пользователя
  
  Возвращает настройки квоты для каждого пользователя. Число с ключом "limit" определяет
  максимальный допустимый размер ящика. Число с ключом "usage" определяет текущий уровень
  использования.

<comment>Param:</comment>
  <info>IMAP\Connection</info>  <strong>$imap</strong>     Экземпляр <class>IMAP\Connection</class>.
  <info>string</info>           <strong>$mailbox</strong>  <strong>$mailbox</strong> должно содержать имя ящика (например INBOX).

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

<comment>See Also:</comment>
   * <strong>imap_open()</strong>
   * <strong>imap_set_quota()</strong>
   * <strong>imap_get_quota()</strong>


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

<comment>Param:</comment>
  <info>IMAP\Connection</info>  <strong>$imap</strong>     Экземпляр <class>IMAP\Connection</class>.
  <info>string</info>           <strong>$mailbox</strong>  Имя почтового ящика. Более подробно читайте в разделе, посвящённом
                             функции <strong>imap_open()</strong>
                             
                             Если imap.enable_insecure_rsh не отключён, то передача в этот параметр
                             не проверенных данных не безопасна.

<comment>Return:</comment>
  <info>array|false</info>  Возвращает ассоциативный массив вида "folder" =&gt; "acl" или <info>false</info> в случае
               возникновения ошибки.

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


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

<comment>Param:</comment>
  <info>IMAP\Connection</info>  <strong>$imap</strong>       Экземпляр <class>IMAP\Connection</class>.
  <info>string</info>           <strong>$reference</strong>  <strong>$reference</strong> обычно должен быть только спецификацией сервера, как
                               описано в <strong>imap_open()</strong>
                               
                               Если imap.enable_insecure_rsh не отключён, то передача в этот
                               параметр не проверенных данных не безопасна.
  <info>string</info>           <strong>$pattern</strong>    Определяет начало поиска в иерархии почтовых ящиков.
                               
                               Есть два специальных символа, которые можно использовать при передаче
                               как часть <strong>$pattern</strong>:
                               '<return>*</return>' и '<return>%</return>'.
                               '<return>*</return>' возвращает все почтовые ящики. Если вы передадите
                               <strong>$pattern</strong> как '<return>*</return>', то получите полный список иерархии почтовых ящиков.
                               '<return>%</return>' вернёт только текущий уровень.
                               '<return>%</return>', переданный как параметр <strong>$pattern</strong>, вернёт почтовые ящики
                               только на самом верхнем уровне; '<return>~/mail/%</return>'
                               на <return>UW_IMAPD</return> вернёт все ящики в директории ~/mail, кроме тех, которые
                               находятся в её поддиректориях.

<comment>Return:</comment>
  <info>array|false</info>  Возвращает массив объектов, содержащих информацию о ящиках. Каждый объект имеет
               свойства: <strong>$name</strong>, содержащее полное имя ящика; <strong>$delimiter</strong>, содержащее разделитель для
               той части иерархии, в которой содержится ящик; и <strong>$attributes</strong>. Параметр <strong>$Attributes</strong>
               является битовой маской, следующих допустимых констант: <info>LATT_NOINFERIORS</info> - этот ящик
               не имеет и не может иметь потомков (содержать вложенные ящики). Вызов функции
               <strong>imap_createmailbox()</strong> не будет работать для этого ящика. <info>LATT_NOSELECT</info> - это только
               контейнер, а не почтовый ящик. Вы не можете его открыть. <info>LATT_MARKED</info> - Этот ящик
               помечен. Означает, что в нем могут быть новые письма, появившиеся с момента последней
               проверки. Работает не со всеми серверами IMAP. <info>LATT_UNMARKED</info> - Этот ящик не помечен,
               т.е. в нем нет новых писем. Если один из флагов <info>MARKED</info> или <info>UNMARKED</info> выставлен -
               можете считать, что сервер поддерживает этот функционал. <info>LATT_REFERRAL</info> - Этот
               контейнер имеет направления (referral) на удалённый почтовый ящик. <info>LATT_HASCHILDREN</info> -
               Этот почтовый ящик имеет выбираемые подчинённые (inferiors). <info>LATT_HASNOCHILDREN</info> -
               Этот почтовый ящик не имеет выбираемые подчинённые (inferiors).  Функция возвращает
               <info>false</info> в случае возникновения ошибки.
               
               <info>LATT_NOINFERIORS</info> - этот ящик не имеет и не может иметь потомков (содержать вложенные
               ящики). Вызов функции <strong>imap_createmailbox()</strong> не будет работать для этого ящика.
               
               <info>LATT_NOSELECT</info> - это только контейнер, а не почтовый ящик. Вы не можете его открыть.
               
               <info>LATT_MARKED</info> - Этот ящик помечен. Означает, что в нем могут быть новые письма,
               появившиеся с момента последней проверки. Работает не со всеми серверами IMAP.
               
               <info>LATT_UNMARKED</info> - Этот ящик не помечен, т.е. в нем нет новых писем. Если один из флагов
               <info>MARKED</info> или <info>UNMARKED</info> выставлен - можете считать, что сервер поддерживает этот
               функционал.
               
               <info>LATT_REFERRAL</info> - Этот контейнер имеет направления (referral) на удалённый почтовый
               ящик.
               
               <info>LATT_HASCHILDREN</info> - Этот почтовый ящик имеет выбираемые подчинённые (inferiors).
               
               <info>LATT_HASNOCHILDREN</info> - Этот почтовый ящик не имеет выбираемые подчинённые (inferiors).

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


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

<comment>Param:</comment>
  <info>IMAP\Connection</info>  <strong>$imap</strong>       Экземпляр <class>IMAP\Connection</class>.
  <info>string</info>           <strong>$reference</strong>  В <strong>$reference</strong>, как правило, должна быть указана только спецификация
                               сервера, как описано в <strong>imap_open()</strong>
                               
                               Если imap.enable_insecure_rsh не отключён, то передача в этот
                               параметр не проверенных данных не безопасна.
  <info>string</info>           <strong>$pattern</strong>    Определяет начало поиска в иерархии почтовых ящиков.
                               
                               Есть два специальных символа, которые можно использовать при передаче
                               как часть <strong>$pattern</strong>:
                               '<return>*</return>' и '<return>%</return>'.
                               '<return>*</return>' возвращает все почтовые ящики. Если вы передадите
                               <strong>$pattern</strong> как '<return>*</return>', то получите полный список иерархии почтовых ящиков.
                               '<return>%</return>' вернёт только текущий уровень.
                               '<return>%</return>', переданный как параметр <strong>$pattern</strong>, вернёт почтовые ящики
                               только на самом верхнем уровне; '<return>~/mail/%</return>'
                               на <return>UW_IMAPD</return> вернёт все ящики в директории ~/mail, кроме тех, которые
                               находятся в её поддиректориях.

<comment>Return:</comment>
  <info>array|false</info>  Возвращает массив объектов, содержащих информацию о ящиках. Каждый объект имеет
               свойства: <strong>$name</strong>, содержащее полное имя ящика; <strong>$delimiter</strong>, содержащее разделитель для
               той части иерархии, в которой содержится ящик; и <strong>$attributes</strong>. Параметр <strong>$Attributes</strong>
               является битовой маской, следующих допустимых констант: <info>LATT_NOINFERIORS</info> - этот ящик
               не имеет потомков (нет ни одного ящика ниже этого). <info>LATT_NOSELECT</info> - это только
               контейнер, а не почтовый ящик. Вы не можете его открыть. <info>LATT_MARKED</info> - Этот ящик
               помечен. Используется только UW-IMAPD. <info>LATT_UNMARKED</info> - Этот ящик не помечен.
               Используется только UW-IMAPD. <info>LATT_REFERRAL</info> - Этот контейнер имеет направления
               (referral) на удалённый почтовый ящик. <info>LATT_HASCHILDREN</info> - Этот почтовый ящик имеет
               выбираемые подчинённые (inferiors). <info>LATT_HASNOCHILDREN</info> - Этот почтовый ящик не имеет
               выбираемые подчинённые (inferiors).  Функция возвращает <info>false</info> в случае возникновения
               ошибки.
               
               <info>LATT_NOINFERIORS</info> - этот ящик не имеет потомков (нет ни одного ящика ниже этого).
               
               <info>LATT_NOSELECT</info> - это только контейнер, а не почтовый ящик. Вы не можете его открыть.
               
               <info>LATT_MARKED</info> - Этот ящик помечен. Используется только UW-IMAPD.
               
               <info>LATT_UNMARKED</info> - Этот ящик не помечен. Используется только UW-IMAPD.
               
               <info>LATT_REFERRAL</info> - Этот контейнер имеет направления (referral) на удалённый почтовый
               ящик.
               
               <info>LATT_HASCHILDREN</info> - Этот почтовый ящик имеет выбираемые подчинённые (inferiors).
               
               <info>LATT_HASNOCHILDREN</info> - Этот почтовый ящик не имеет выбираемые подчинённые (inferiors).


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


id: imap_headerinfo
type: function
doc:
<comment>Description:</comment>
  Прочитать заголовок сообщения
  
  Извлекает информацию о сообщении из его заголовка.

<comment>Param:</comment>
  <info>IMAP\Connection</info>  <strong>$imap</strong>            Экземпляр <class>IMAP\Connection</class>.
  <info>int</info>              <strong>$message_num</strong>     Номер сообщения
  <info>int</info>              <strong>$from_length</strong>     Количество символов в свойстве <return>fetchfrom</return>. Должно быть больше или
                                    равно нулю.
  <info>int</info>              <strong>$subject_length</strong>  Количество символов в свойстве <return>fetchsubject</return>. Должно быть больше
                                    или равно нулю.
  <info></info>                 <strong>$defaulthost</strong>     

<comment>Return:</comment>
  <info>stdClass|false</info>  В случае возникновения ошибки возвращает <info>false</info>. В случае успешного выполнения
                  возвращает объект со следующими свойствами:  toaddress - полная строка to:,
                  максимум 1024 символов  to - массив объектов из поля To:, со следующими
                  свойствами: <return>personal</return>, <return>adl</return>, <return>mailbox</return> и <return>host</return>  fromaddress - полная строка from:,
                  максимум 1024 символов  from - массив объектов из поля From:, со следующими
                  свойствами: <return>personal</return>, <return>adl</return>, <return>mailbox</return> и <return>host</return>  ccaddress - полная строка cc:, максимум
                  1024 символов  cc - массив объектов из поля Cc:, со следующими свойствами:
                  <return>personal</return>, <return>adl</return>, <return>mailbox</return> и <return>host</return>  bccaddress - полная строка bcc:, максимум 1024
                  символов  bcc - массив объектов из поля Bcc:, со следующими свойствами: <return>personal</return>,
                  <return>adl</return>, <return>mailbox</return> и <return>host</return>  reply_toaddress - полная строка Reply-To:, максимум 1024
                  символов  reply_to - массив объектов из поля Reply-To:, со следующими свойствами:
                  <return>personal</return>, <return>adl</return>, <return>mailbox</return> и <return>host</return>  senderaddress - полная строка sender:, максимум
                  1024 символов  sender - массив объектов из поля Sender:, со следующими свойствами:
                  <return>personal</return>, <return>adl</return>, <return>mailbox</return> и <return>host</return>  return_pathaddress - полная строка Return-Path:,
                  максимум 1024 символов  return_path - массив объектов из поля Return-Path:, со
                  следующими свойствами: <return>personal</return>, <return>adl</return>, <return>mailbox</return> и <return>host</return>  remail -  date - Дата
                  письма, как она указана в заголовке  Date - То же, что и date  subject - Тема
                  письма  Subject - То же, что и subject  in_reply_to -  message_id -  newsgroups -
                  followup_to -  references -  Recent - <return>R</return> если новое и прочитанное, <return>N</return> если новое и
                  не прочитанное, ' ' если не новое.  Unseen - <return>U</return> если НЕ прочитано и НЕ новое, ' '
                  если прочитано ИЛИ не прочитано и новое  Flagged - <return>F</return> если отмечено, ' ' если нет
                  Answered - <return>A</return> если отвечено, ' ' если нет  Deleted - <return>D</return> если удалено, ' ' если нет
                  Draft - <return>X</return> если черновик, ' ' если нет  Msgno - Номер сообщения  MailDate -  Size -
                  Размер сообщения  udate - время отсылки в виде временной метки Unix  fetchfrom -
                  поле from, отформатированное в соответствии с <strong>$from_length</strong>  fetchsubject - поле
                  subject, отформатированное в соответствии с <strong>$subject_length</strong>
                  
                  toaddress - полная строка to:, максимум 1024 символов
                  
                  to - массив объектов из поля To:, со следующими свойствами: <return>personal</return>, <return>adl</return>, <return>mailbox</return>
                  и <return>host</return>
                  
                  fromaddress - полная строка from:, максимум 1024 символов
                  
                  from - массив объектов из поля From:, со следующими свойствами: <return>personal</return>, <return>adl</return>,
                  <return>mailbox</return> и <return>host</return>
                  
                  ccaddress - полная строка cc:, максимум 1024 символов
                  
                  cc - массив объектов из поля Cc:, со следующими свойствами: <return>personal</return>, <return>adl</return>, <return>mailbox</return>
                  и <return>host</return>
                  
                  bccaddress - полная строка bcc:, максимум 1024 символов
                  
                  bcc - массив объектов из поля Bcc:, со следующими свойствами: <return>personal</return>, <return>adl</return>,
                  <return>mailbox</return> и <return>host</return>
                  
                  reply_toaddress - полная строка Reply-To:, максимум 1024 символов
                  
                  reply_to - массив объектов из поля Reply-To:, со следующими свойствами: <return>personal</return>,
                  <return>adl</return>, <return>mailbox</return> и <return>host</return>
                  
                  senderaddress - полная строка sender:, максимум 1024 символов
                  
                  sender - массив объектов из поля Sender:, со следующими свойствами: <return>personal</return>, <return>adl</return>,
                  <return>mailbox</return> и <return>host</return>
                  
                  return_pathaddress - полная строка Return-Path:, максимум 1024 символов
                  
                  return_path - массив объектов из поля Return-Path:, со следующими свойствами:
                  <return>personal</return>, <return>adl</return>, <return>mailbox</return> и <return>host</return>
                  
                  remail -
                  
                  date - Дата письма, как она указана в заголовке
                  
                  Date - То же, что и date
                  
                  subject - Тема письма
                  
                  Subject - То же, что и subject
                  
                  in_reply_to -
                  
                  message_id -
                  
                  newsgroups -
                  
                  followup_to -
                  
                  references -
                  
                  Recent - <return>R</return> если новое и прочитанное, <return>N</return> если новое и не прочитанное, ' ' если не
                  новое.
                  
                  Unseen - <return>U</return> если НЕ прочитано и НЕ новое, ' ' если прочитано ИЛИ не прочитано и
                  новое
                  
                  Flagged - <return>F</return> если отмечено, ' ' если нет
                  
                  Answered - <return>A</return> если отвечено, ' ' если нет
                  
                  Deleted - <return>D</return> если удалено, ' ' если нет
                  
                  Draft - <return>X</return> если черновик, ' ' если нет
                  
                  Msgno - Номер сообщения
                  
                  MailDate -
                  
                  Size - Размер сообщения
                  
                  udate - время отсылки в виде временной метки Unix
                  
                  fetchfrom - поле from, отформатированное в соответствии с <strong>$from_length</strong>
                  
                  fetchsubject - поле subject, отформатированное в соответствии с <strong>$subject_length</strong>

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


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

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

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


id: imap_is_open
type: function
doc:
<comment>Description:</comment>
  Проверяет, является ли поток IMAP всё ещё корректным
  
  Проверяет, является ли поток IMAP всё ещё корректным.

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

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


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

<comment>Return:</comment>
  <info>string|false</info>  Возвращает полный текст ошибки IMAP, возникшей на текущей странице. Если ошибок не
                было - возвратит <info>false</info>.

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


id: imap_list
type: function
doc:
<comment>Description:</comment>
  Прочитать список почтовых ящиков
  
  Читает список почтовых ящиков.

<comment>Param:</comment>
  <info>IMAP\Connection</info>  <strong>$imap</strong>       Экземпляр <class>IMAP\Connection</class>.
  <info>string</info>           <strong>$reference</strong>  В <strong>$reference</strong>, как правило, должна быть указана только спецификация
                               сервера, как описано в <strong>imap_open()</strong>.
                               
                               Если imap.enable_insecure_rsh не отключён, то передача в этот
                               параметр не проверенных данных не безопасна.
  <info>string</info>           <strong>$pattern</strong>    Определяет начало поиска в иерархии почтовых ящиков.
                               
                               Есть два специальных символа, которые можно использовать при передаче
                               как часть <strong>$pattern</strong>:
                               '<return>*</return>' и '<return>%</return>'.
                               '<return>*</return>' возвращает все почтовые ящики. Если вы передадите
                               <strong>$pattern</strong> как '<return>*</return>', то получите полный список иерархии почтовых ящиков.
                               '<return>%</return>' вернёт только текущий уровень.
                               '<return>%</return>', переданный как параметр <strong>$pattern</strong>, вернёт почтовые ящики
                               только на самом верхнем уровне; '<return>~/mail/%</return>'
                               на <return>UW_IMAPD</return> вернёт все ящики в директории ~/mail, кроме тех, которые
                               находятся в её поддиректориях.

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

<comment>See Also:</comment>
   * <strong>imap_getmailboxes()</strong>
   * <strong>imap_lsub()</strong>


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


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

<comment>Param:</comment>
  <info>IMAP\Connection</info>  <strong>$imap</strong>       Экземпляр <class>IMAP\Connection</class>.
  <info>string</info>           <strong>$reference</strong>  В <strong>$reference</strong>, как правило, должна быть указана только спецификация
                               сервера, как описано в <strong>imap_open()</strong>
                               
                               Если imap.enable_insecure_rsh не отключён, то передача в этот
                               параметр не проверенных данных не безопасна.
  <info>string</info>           <strong>$pattern</strong>    Определяет начало поиска в иерархии почтовых ящиков.
                               
                               Есть два специальных символа, которые можно использовать при передаче
                               как часть <strong>$pattern</strong>:
                               '<return>*</return>' и '<return>%</return>'.
                               '<return>*</return>' возвращает все почтовые ящики. Если вы передадите
                               <strong>$pattern</strong> как '<return>*</return>', то получите полный список иерархии почтовых ящиков.
                               '<return>%</return>' вернёт только текущий уровень.
                               '<return>%</return>', переданный как параметр <strong>$pattern</strong>, вернёт почтовые ящики
                               только на самом верхнем уровне; '<return>~/mail/%</return>'
                               на <return>UW_IMAPD</return> вернёт все ящики в директории ~/mail, кроме тех, которые
                               находятся в её поддиректориях.
  <info>string</info>           <strong>$content</strong>    Искомая строка

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

<comment>See Also:</comment>
   * <strong>imap_listmailbox()</strong>
   * <strong>imap_search()</strong>


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


id: imap_lsub
type: function
doc:
<comment>Description:</comment>
  Список всех подписанных почтовых ящиков
  
  Возвращает массив всех почтовых ящиков на которые вы подписаны.

<comment>Param:</comment>
  <info>IMAP\Connection</info>  <strong>$imap</strong>       Экземпляр <class>IMAP\Connection</class>.
  <info>string</info>           <strong>$reference</strong>  В <strong>$reference</strong>, как правило, должна быть указана только спецификация
                               сервера, как описано в <strong>imap_open()</strong>.
                               
                               Если imap.enable_insecure_rsh не отключён, то передача в этот
                               параметр не проверенных данных не безопасна.
  <info>string</info>           <strong>$pattern</strong>    Определяет начало поиска в иерархии почтовых ящиков.
                               
                               Есть два специальных символа, которые можно использовать при передаче
                               как часть <strong>$pattern</strong>:
                               '<return>*</return>' и '<return>%</return>'.
                               '<return>*</return>' возвращает все почтовые ящики. Если вы передадите
                               <strong>$pattern</strong> как '<return>*</return>', то получите полный список иерархии почтовых ящиков.
                               '<return>%</return>' вернёт только текущий уровень.
                               '<return>%</return>', переданный как параметр <strong>$pattern</strong>, вернёт почтовые ящики
                               только на самом верхнем уровне; '<return>~/mail/%</return>'
                               на <return>UW_IMAPD</return> вернёт все ящики в директории ~/mail, кроме тех, которые
                               находятся в её поддиректориях.

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

<comment>See Also:</comment>
   * <strong>imap_list()</strong>
   * <strong>imap_getmailboxes()</strong>


id: imap_mail
type: function
doc:
<comment>Description:</comment>
  Отправить email
  
  Эта функция позволяет отправлять сообщения с корректной обработкой получателей Cc и Bcc.
  
  Параметры <strong>$to</strong>, <strong>$cc</strong> и <strong>$bcc</strong> - строки, которые будут разобраны в соответствии с RFC822.

<comment>Param:</comment>
  <info>string</info>       <strong>$to</strong>                  Получатель
  <info>string</info>       <strong>$subject</strong>             Тема письма
  <info>string</info>       <strong>$message</strong>             Тело письма, смотрите <strong>imap_mail_compose()</strong>
  <info>string|null</info>  <strong>$additional_headers</strong>  Строка с дополнительными заголовками
  <info>string|null</info>  <strong>$cc</strong>                  
  <info>string|null</info>  <strong>$bcc</strong>                 Получатели <strong>$bcc</strong> получат письмо, но не будут указаны в
                                    заголовках.
  <info>string|null</info>  <strong>$return_path</strong>         Используйте этот параметр для указания обратного адреса для
                                    отсылки отчёта в случае неудачной доставки. Это удобно, когда
                                    PHP используется как почтовый клиент несколькими пользователями.

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

<comment>See Also:</comment>
   * <strong>mail()</strong>
   * <strong>imap_mail_compose()</strong>


id: imap_mail_compose
type: function
doc:
<comment>Description:</comment>
  Создать MIME-сообщение на основе заданных обёртки и тела
  
  Создаёт MIME-сообщение на основе обёртки <strong>$envelope</strong> и тела <strong>$bodies</strong>.

<comment>Param:</comment>
  <info>array</info>  <strong>$envelope</strong>  Ассоциативный массив с полями заголовка. Допустимые ключи: <return>"remail"</return>,
                    <return>"return_path"</return>, <return>"date"</return>, <return>"from"</return>, <return>"reply_to"</return>, <return>"in_reply_to"</return>, <return>"subject"</return>, <return>"to"</return>, <return>"cc"</return>,
                    <return>"bcc"</return> и <return>"message_id"</return>, которые устанавливают соответствующие заголовки сообщений
                    в заданную строку (<info>string</info>). Для установки дополнительных заголовков
                    поддерживается ключ <return>"custom_headers"</return>, который содержит ассоциативный массив
                    прочих заголовков, например, ["User-Agent: My Mail Client"].
  <info>array</info>  <strong>$bodies</strong>    Индексированный массив тел. Первое тело - это основная часть сообщения;
                    дальнейшие тела обрабатываются, только если оно с типом <info>TYPEMULTIPART</info>; эти тела
                    составляют тела частей.
                    
                    Структура массива телаКлючТипОписание<return>type</return><info>int</info> Тип MIME. Один из <info>TYPETEXT</info> (по
                    умолчанию), <info>TYPEMULTIPART</info>, <info>TYPEMESSAGE</info>, <info>TYPEAPPLICATION</info>, <info>TYPEAUDIO</info>, <info>TYPEIMAGE</info>,
                    <info>TYPEMODEL</info> или <info>TYPEOTHER</info>. <return>encoding</return><info>int</info> Значение <return>Content-Transfer-Encoding</return>. Одно из
                    <info>ENC7BIT</info> (default), <info>ENC8BIT</info>, <info>ENCBINARY</info>, <info>ENCBASE64</info>, <info>ENCQUOTEDPRINTABLE</info> или
                    <info>ENCOTHER</info>. <return>charset</return><info>string</info>Параметр charset типа
                    MIME.<return>type.parameters</return><info>array</info>Ассоциативный массив (<info>array</info>) имён параметров
                    <return>Content-Type</return> и их значений.<return>subtype</return><info>string</info>Подтип MIME, например, <return>'jpeg'</return> для
                    <info>TYPEIMAGE</info>.<return>id</return><info>string</info>Значение <return>Content-ID</return>.<return>description</return><info>string</info>Значение
                    <return>Content-Description</return>.<return>disposition.type</return><info>string</info>Значение <return>Content-Disposition</return>,
                    например, <return>'attachment'</return>.<return>disposition</return><info>array</info>Ассоциативный массив (<info>array</info>) имён
                    параметров <return>Content-Disposition</return> и их значений.<return>contents.data</return><info>string</info>Полезная
                    нагрузка.<return>lines</return><info>int</info>Размер полезной нагрузки в строках.<return>bytes</return><info>int</info>Размер полезной
                    нагрузки в байтах.<return>md5</return><info>string</info>Контрольная сумма MD5 полезной нагрузки.

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


id: imap_mail_copy
type: function
doc:
<comment>Description:</comment>
  Скопировать сообщения в указанный почтовый ящик
  
  Копирует заданные в <strong>$message_nums</strong> письма в указанный почтовый ящик.

<comment>Param:</comment>
  <info>IMAP\Connection</info>  <strong>$imap</strong>          Экземпляр <class>IMAP\Connection</class>.
  <info>string</info>           <strong>$message_nums</strong>  <strong>$message_nums</strong> - это диапазон, а не просто номера сообщений (как
                                  определено в RFC2060).
  <info>string</info>           <strong>$mailbox</strong>       Имя почтового ящика. Более подробно читайте в разделе, посвящённом
                                  функции <strong>imap_open()</strong>
                                  
                                  Если imap.enable_insecure_rsh не отключён, то передача в этот
                                  параметр не проверенных данных не безопасна.
  <info>int</info>              <strong>$flags</strong>         <strong>$flags</strong> - битовая маска одной или нескольких констант: <info>CP_UID</info> -
                                  означает, что в первом параметре не номера сообщений, а их UID.
                                  <info>CP_MOVE</info> - удалить оригинальные сообщения после копирования. Если
                                  этот флаг установлен, функция ведёт себя идентично функции
                                  <strong>imap_mail_move()</strong>.
                                  
                                  <info>CP_UID</info> - означает, что в первом параметре не номера сообщений, а
                                  их UID.
                                  
                                  <info>CP_MOVE</info> - удалить оригинальные сообщения после копирования. Если
                                  этот флаг установлен, функция ведёт себя идентично функции
                                  <strong>imap_mail_move()</strong>.

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

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


id: imap_mail_move
type: function
doc:
<comment>Description:</comment>
  Переместить указанные сообщения в указанный почтовый ящик
  
  Перемещает письма, заданные в <strong>$message_nums</strong> в указанный почтовый ящик <strong>$mailbox</strong>. Обратите внимание,
  что почтовые сообщения фактически копируются в <strong>$mailbox</strong>, а исходные сообщения помечаются для
  удаления. Это означает, что сообщениям в <strong>$mailbox</strong> назначаются новые UID.

<comment>Param:</comment>
  <info>IMAP\Connection</info>  <strong>$imap</strong>          Экземпляр <class>IMAP\Connection</class>.
  <info>string</info>           <strong>$message_nums</strong>  <strong>$message_nums</strong> - это диапазон, а не просто номера сообщений (как
                                  определено в RFC2060).
  <info>string</info>           <strong>$mailbox</strong>       Имя почтового ящика. Более подробно читайте в разделе, посвящённом
                                  функции <strong>imap_open()</strong>
                                  
                                  Если imap.enable_insecure_rsh не отключён, то передача в этот
                                  параметр не проверенных данных не безопасна.
  <info>int</info>              <strong>$flags</strong>         <strong>$flags</strong> - битовая маска, которая может принимать всего одно
                                  значение: <info>CP_UID</info> - означает, что в первом параметре не номера
                                  сообщений, а их UID
                                  
                                  <info>CP_UID</info> - означает, что в первом параметре не номера сообщений, а
                                  их UID

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

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


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

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

<comment>Return:</comment>
  <info>stdClass</info>  Возвращает объект со следующими полями: Свойства почтового ящикаDateдата последнего
            изменения (текущие дата и время)DriverдрайверMailboxимя почтового ящикаNmsgsколичество
            писемRecentколичество новыхUnreadколичество непрочитанныхDeletedколичество
            удалённыхSizeразмер ящика


id: imap_mime_header_decode
type: function
doc:
<comment>Description:</comment>
  Декодировать элементы заголовка
  
  Декодирует MIME-расширения заголовка, не являющиеся текстом ASCII (смотри RFC2047).

<comment>Param:</comment>
  <info>string</info>  <strong>$string</strong>  MIME-текст

<comment>Return:</comment>
  <info>array|false</info>  Декодированные элементы возвращаются в массиве объектов, где каждый объект имеет два
               свойства, <return>charset</return> и <return>text</return>.
               
               Если элемент не был декодирован, или, другими словами, он является текстом US-ASCII,
               свойство <return>charset</return> будет установлено в значение <return>default</return>.
               
               Функция возвращает <info>false</info> в случае возникновения ошибки.

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


id: imap_msgno
type: function
doc:
<comment>Description:</comment>
  Получить номер сообщения с заданным UID
  
  Возвращает номер сообщения для указанного <strong>$message_uid</strong>.
  
  Эта функция обратная к <strong>imap_uid()</strong>.

<comment>Param:</comment>
  <info>IMAP\Connection</info>  <strong>$imap</strong>         Экземпляр <class>IMAP\Connection</class>.
  <info>int</info>              <strong>$message_uid</strong>  UID сообщения

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

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


id: imap_mutf7_to_utf8
type: function
doc:
<comment>Description:</comment>
  Декодировать изменённую строку UTF-7 в UTF-8
  
  Декодировать изменённую строку UTF-7 (в соответствии с RFC 2060, раздел 5.1.3) в UTF-8.
  
  Эта функция доступна только в случае, если libcclient экспортирует utf8_to_mutf7().

<comment>Param:</comment>
  <info>string</info>  <strong>$string</strong>  Изменённая строка, закодированная в UTF-7.

<comment>Return:</comment>
  <info>string|false</info>  Возвращает <strong>$string</strong>, конвертированную в UTF-8 или <info>false</info> в случае возникновения
                ошибки.

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


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

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

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

<comment>See Also:</comment>
   * <strong>imap_num_recent()</strong>
   * <strong>imap_status()</strong>


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

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

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

<comment>See Also:</comment>
   * <strong>imap_num_msg()</strong>
   * <strong>imap_status()</strong>


id: imap_open
type: function
doc:
<comment>Description:</comment>
  Открывает поток IMAP к почтовому ящику
  
  Открывает поток IMAP к <strong>$mailbox</strong>.
  
  Данная функция также может использоваться для открытия потока к серверам POP3 и NNTP, но часть
  функций и особенностей будет работать только с серверами IMAP.

<comment>Param:</comment>
  <info>string</info>  <strong>$mailbox</strong>   Имя почтового ящика состоит из сервера и пути к почтовому ящику на нем.
                     Специальное имя <return>INBOX</return> используется для почтового ящика текущего пользователя.
                     Имена почтовых ящиков, содержащих интернациональные символы кроме входящих в
                     печатное пространство ASCII, должны быть закодированы с помощью
                     <strong>imap_utf7_encode()</strong>.
                     
                     Если imap.enable_insecure_rsh не отключён, то передача в этот параметр не
                     проверенных данных не безопасна.
                     
                     Серверная часть, заключённая в фигурные скобки '{' и '}', состоит из имени или
                     IP-адреса сервера, опционального порта (предварённого двоеточием) и
                     опциональных спецификаций протокола (предварённых слешем '/').
                     
                     Серверная часть является обязательной во всех параметрах почтового ящика.
                     
                     Все имена, начинающиеся с <return>{</return> являются удалёнными именами и имеют такой синтаксис
                     <return>"{" remote_system_name [":" port] [flags] "}" [mailbox_name]</return> где:
                     <return>remote_system_name</return> - полное доменное имя сервера, либо IP-адрес в квадратных
                     скобках. <return>port</return> - необязательный параметр. Определяет порт сервера <return>flags</return> -
                     опциональные флаги, смотри таблицу ниже <return>mailbox_name</return> - имя почтового ящика. По
                     умолчанию INBOX
                     
                     <return>remote_system_name</return> - полное доменное имя сервера, либо IP-адрес в квадратных
                     скобках.
                     
                     <return>port</return> - необязательный параметр. Определяет порт сервера
                     
                     <return>flags</return> - опциональные флаги, смотри таблицу ниже
                     
                     <return>mailbox_name</return> - имя почтового ящика. По умолчанию INBOX
                     
                     Опциональные флагиФлагОписание<return>/service=</return>serviceсервис доступа к почтовому ящику.
                     По умолчанию "imap"<return>/user=</return>userимя пользователя для входа на
                     сервер<return>/authuser=</return>userудалённый пользователь для аутентификации; если указано, то
                     это будет тот пользователь, чей пароль используется (например
                     administrator)<return>/anonymous</return>удалённый доступ под анонимным
                     пользователем<return>/debug</return>записывать телеметрию протокола в специальный лог-файл
                     приложения<return>/secure</return>не передавать пароль по сети в виде нешифрованного
                     текста<return>/imap</return>, <return>/imap2</return>, <return>/imap2bis</return>, <return>/imap4</return>, <return>/imap4rev1</return>эквивалентно
                     <return>/service=imap</return><return>/pop3</return>эквивалентно <return>/service=pop3</return><return>/nntp</return>эквивалентно
                     <return>/service=nntp</return><return>/norsh</return>не использовать rsh или ssh для установки преавторизованной
                     сессии IMAP<return>/ssl</return>использовать <return>SSL</return> для шифрования сессии<return>/validate-cert</return>проверять
                     сертификаты серверов TLS/SSL (поведение по умолчанию)<return>/novalidate-cert</return>не
                     проверять сертификаты от серверов TLS/SSL. полезно для серверов с
                     самоподписанным сертификатом<return>/tls</return>принудительно использовать <return>start-TLS</return> для
                     шифрования сессии и отвергать соединения с серверами его не
                     поддерживающими<return>/notls</return>не применять <return>start-TLS</return> для шифрования сессии, даже если
                     сервер его поддерживает<return>/readonly</return>запрос открытия в режиме "только чтение"
                     (только IMAP; игнорируется для NNTP и выдаёт ошибку для SMTP и POP3)
  <info>string</info>  <strong>$user</strong>      Имя пользователя
  <info>string</info>  <strong>$password</strong>  Пароль пользователя <strong>$user</strong>
  <info>int</info>     <strong>$flags</strong>     <strong>$flags</strong> - битовая маска из одной или нескольких констант: <info>OP_READONLY</info> - открыть
                     почтовый ящик только для чтения <info>OP_ANONYMOUS</info> - не использовать и не обновлять
                     .newsrc для новостей (только NNTP) <info>OP_HALFOPEN</info> - открыть соединение, но не
                     подключаться к почтовому ящику для имён IMAP и NNTP. <info>CL_EXPUNGE</info> - автоматически
                     удалять все помеченные для удаления сообщения при закрытии почтового ящика
                     (смотрите <strong>imap_delete()</strong> и <strong>imap_expunge()</strong>) <info>OP_DEBUG</info> - договорённости по
                     протоколу отладки <info>OP_SHORTCACHE</info> - короткое кеширование (только <return>elt</return>) <info>OP_SILENT</info> -
                     не передавать события (внутреннее использование) <info>OP_PROTOTYPE</info> - вернуть
                     прототип драйвера <info>OP_SECURE</info> - не производить безопасную аутентификацию
                     
                     <info>OP_READONLY</info> - открыть почтовый ящик только для чтения
                     
                     <info>OP_ANONYMOUS</info> - не использовать и не обновлять .newsrc для новостей (только
                     NNTP)
                     
                     <info>OP_HALFOPEN</info> - открыть соединение, но не подключаться к почтовому ящику для имён
                     IMAP и NNTP.
                     
                     <info>CL_EXPUNGE</info> - автоматически удалять все помеченные для удаления сообщения при
                     закрытии почтового ящика (смотрите <strong>imap_delete()</strong> и <strong>imap_expunge()</strong>)
                     
                     <info>OP_DEBUG</info> - договорённости по протоколу отладки
                     
                     <info>OP_SHORTCACHE</info> - короткое кеширование (только <return>elt</return>)
                     
                     <info>OP_SILENT</info> - не передавать события (внутреннее использование)
                     
                     <info>OP_PROTOTYPE</info> - вернуть прототип драйвера
                     
                     <info>OP_SECURE</info> - не производить безопасную аутентификацию
  <info>int</info>     <strong>$retries</strong>   Максимальное количество попыток соединения
  <info>array</info>   <strong>$options</strong>   Параметры для соединения. Для установки одного или нескольких параметров
                     соединения можно использовать следующие (строки) ключи: <return>DISABLE_AUTHENTICATOR</return> -
                     запрещает свойства аутентификации
                     
                     <return>DISABLE_AUTHENTICATOR</return> - запрещает свойства аутентификации

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

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


id: imap_ping
type: function
doc:
<comment>Description:</comment>
  Проверить, активен ли ещё поток IMAP
  
  <strong>imap_ping()</strong> проверяет, активен ли ещё открытый поток. С помощью него можно узнавать, есть ли новая
  почта. Это предпочтительный метод проверять есть ли новые сообщения и аналог "keep alive" для
  серверов с настроенным временем ожидания неактивности.

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

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


id: imap_qprint
type: function
doc:
<comment>Description:</comment>
  Преобразовать строку из формата "quoted-printable" в 8-битную строку
  
  Преобразует строку из формата "quoted-printable" в 8-битную строку в соответствии с RFC2045,
  секция 6.7.

<comment>Param:</comment>
  <info>string</info>  <strong>$string</strong>  Строка в формате "quoted-printable"

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

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


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


id: imap_renamemailbox
type: function
doc:
<comment>Description:</comment>
  Переименовать почтовый ящик
  
  Эта функция переименовывает old_mbox в new_mbox (формат имени <strong>$mbox</strong> смотрите в описании
  <strong>imap_open()</strong>).

<comment>Param:</comment>
  <info>IMAP\Connection</info>  <strong>$imap</strong>  Экземпляр <class>IMAP\Connection</class>.
  <info>string</info>           <strong>$from</strong>  Старое имя. Более подробно читайте в описании <strong>imap_open()</strong>
                          
                          Если imap.enable_insecure_rsh не отключён, то передача в этот параметр не
                          проверенных данных не безопасна.
  <info>string</info>           <strong>$to</strong>    Новое имя. Более подробно читайте в описании <strong>imap_open()</strong>
                          
                          Если imap.enable_insecure_rsh не отключён, то передача в этот параметр не
                          проверенных данных не безопасна.

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

<comment>See Also:</comment>
   * <strong>imap_createmailbox()</strong>
   * <strong>imap_deletemailbox()</strong>


id: imap_reopen
type: function
doc:
<comment>Description:</comment>
  Переоткрывает поток IMAP к новому ящику
  
  Переоткрывает указанный поток к ящику <strong>$mailbox</strong> на сервере IMAP или NNTP.

<comment>Param:</comment>
  <info>IMAP\Connection</info>  <strong>$imap</strong>     Экземпляр <class>IMAP\Connection</class>.
  <info>string</info>           <strong>$mailbox</strong>  Имя почтового ящика. Более подробно читайте в разделе про функцию
                             <strong>imap_open()</strong>
                             
                             Если imap.enable_insecure_rsh не отключён, то передача в этот параметр
                             не проверенных данных не безопасна.
  <info>int</info>              <strong>$flags</strong>    <strong>$flags</strong> - битовая маска из одной или нескольких констант: <info>OP_READONLY</info> -
                             открыть почтовый ящик только для чтения <info>OP_ANONYMOUS</info> - не использовать
                             и не обновлять .newsrc для новостей (только NNTP) <info>OP_HALFOPEN</info> - открыть
                             соединение, но не подключаться к почтовому ящику для имён IMAP и NNTP.
                             <info>OP_EXPUNGE</info> - молча выполнить удаление помеченных для удаления сообщений
                             в потоке <info>CL_EXPUNGE</info> - автоматически удалять все помеченные для удаления
                             сообщения при закрытии почтового ящика (смотрите <strong>imap_delete()</strong> и
                             <strong>imap_expunge()</strong>)
                             
                             <info>OP_READONLY</info> - открыть почтовый ящик только для чтения
                             
                             <info>OP_ANONYMOUS</info> - не использовать и не обновлять .newsrc для новостей
                             (только NNTP)
                             
                             <info>OP_HALFOPEN</info> - открыть соединение, но не подключаться к почтовому ящику
                             для имён IMAP и NNTP.
                             
                             <info>OP_EXPUNGE</info> - молча выполнить удаление помеченных для удаления сообщений
                             в потоке
                             
                             <info>CL_EXPUNGE</info> - автоматически удалять все помеченные для удаления
                             сообщения при закрытии почтового ящика (смотрите <strong>imap_delete()</strong> и
                             <strong>imap_expunge()</strong>)
  <info>int</info>              <strong>$retries</strong>  Максимально количество попыток соединения

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


id: imap_rfc822_parse_adrlist
type: function
doc:
<comment>Description:</comment>
  Разбор адресной строки
  
  Разбирает адресную строку в соответствии с RFC2822 для каждого адреса.

<comment>Param:</comment>
  <info>string</info>  <strong>$string</strong>            Строка с адресами
  <info>string</info>  <strong>$default_hostname</strong>  Имя хоста по умолчанию

<comment>Return:</comment>
  <info>array</info>  Возвращает массив объектов со следующими свойствами:
         
          mailbox  - имя ящика (пользователя)  host - имя хоста  personal - персональное имя  adl -
         "at-domain-list".  Не используется.
         
         mailbox  - имя ящика (пользователя)
         
         host - имя хоста
         
         personal - персональное имя
         
         adl - "at-domain-list".  Не используется.

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


id: imap_rfc822_parse_headers
type: function
doc:
<comment>Description:</comment>
  Разбор строки заголовка письма
  
  Извлекает объект различных элементов заголовка, аналогично <strong>imap_header()</strong>.

<comment>Param:</comment>
  <info>string</info>  <strong>$headers</strong>           Данные для разбора
  <info>string</info>  <strong>$default_hostname</strong>  Имя хоста по умолчанию

<comment>Return:</comment>
  <info>stdClass</info>  Возвращает объект, аналогичный возвращаемым функцией <strong>imap_header()</strong>, за исключением
            флагов и прочих свойств, получаемых с сервера IMAP.

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


id: imap_rfc822_write_address
type: function
doc:
<comment>Description:</comment>
  Получить корректно сформированный e-mail адрес, заданный именем ящика, хоста и персональной
  информацией
  
  Возвращает почтовый адрес сформированный в соответствии с RFC2822.

<comment>Param:</comment>
  <info>string</info>  <strong>$mailbox</strong>   Имя почтового ящика. Более подробно читайте в описании <strong>imap_open()</strong>
                     
                     Если imap.enable_insecure_rsh не отключён, то передача в этот параметр не
                     проверенных данных не безопасна.
  <info>string</info>  <strong>$hostname</strong>  Часть e-mail, описывающая хост
  <info>string</info>  <strong>$personal</strong>  Имя владельца аккаунта

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


id: imap_savebody
type: function
doc:
<comment>Description:</comment>
  Сохранить часть тела сообщения в файл
  
  Записывает часть тела сообщения в файл.

<comment>Param:</comment>
  <info>IMAP\Connection</info>      <strong>$imap</strong>         Экземпляр <class>IMAP\Connection</class>.
  <info>resource|string|int</info>  <strong>$file</strong>         Путь к файлу в виде строки, либо открытый с помощью <strong>fopen()</strong>
                                     файловый дескриптор.
  <info>int</info>                  <strong>$message_num</strong>  Номер сообщения
  <info>string</info>               <strong>$section</strong>      Номер секции сообщения. Строка целых чисел, разделённых
                                     точками, определяющая часть тела сообщения в соответствии со
                                     спецификацией IMAP4
  <info>int</info>                  <strong>$flags</strong>        Битовая маска из одной или нескольких опций: <info>FT_UID</info> - The
                                     <strong>$message_num</strong> is a UID <info>FT_PEEK</info> - Не устанавливать флаг \Seen,
                                     если он уже не установлен <info>FT_INTERNAL</info> - возвращать строку во
                                     внутреннем формате, без преобразования концов строк к CRLF.
                                     
                                     <info>FT_UID</info> - The <strong>$message_num</strong> is a UID
                                     
                                     <info>FT_PEEK</info> - Не устанавливать флаг \Seen, если он уже не
                                     установлен
                                     
                                     <info>FT_INTERNAL</info> - возвращать строку во внутреннем формате, без
                                     преобразования концов строк к CRLF.

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

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


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


id: imap_search
type: function
doc:
<comment>Description:</comment>
  Получить сообщения, удовлетворяющие заданным критериям
  
  Эта функция производит поиск в текущем почтовом ящике открытом в потоке IMAP.
  
  К примеру, чтобы найти все неотвеченные сообщения посланные от мамы (Mom), нужно будет
  использовать "UNANSWERED FROM mom". Поиск регистронезависимый. Приведённый список критериев
  извлечён из исходных кодов UW c-client и может быть неполным или не совсем точным (дополнительно
  смотрите RFC1176, секция "tag SEARCH search_criteria").

<comment>Param:</comment>
  <info>IMAP\Connection</info>  <strong>$imap</strong>      Экземпляр <class>IMAP\Connection</class>.
  <info>string</info>           <strong>$criteria</strong>  Строка, разделённая пробелами, в которой допустимо использовать
                              следующие ключевые слова. Любые аргументы, состоящие из нескольких
                              слов, должны быть заключены в двойные кавычки (например <return>FROM "joey
                              smith"</return>). Результат будет совпадать со всеми заданными в параметре
                              <strong>$criteria</strong> критериями.  ALL - возвращать все сообщения, соответствующие
                              остальным критериям  ANSWERED - сообщения с выставленным флагом
                              \\ANSWERED  BCC "string" - сообщения в поле Bcc: которых присутствует
                              "string"  BEFORE "date" - сообщения с Date: до "date"  BODY "string" -
                              сообщения содержащие "string" в теле  CC "string" - сообщения в поле
                              Cc: которых присутствует "string"  DELETED - удалённые сообщения
                              FLAGGED - сообщения с установленным флагом \\FLAGGED (иногда называют
                              "Срочное" или "Важное")  FROM "string" - сообщения в поле From:
                              которых присутствует "string"  KEYWORD "string" - сообщения с ключевым
                              словом "string"  NEW - новые сообщения  OLD - старые сообщения  ON
                              "date" - сообщения с Date: равным "date"  RECENT - означает сообщения
                              с выставленным флагом \\RECENT  SEEN - прочтённые сообщения
                              (установлен флаг \\SEEN)  SINCE "date" - сообщения с Date: после
                              "date"  SUBJECT "string" - сообщения в поле Subject: которых
                              присутствует "string"  TEXT "string" - сообщения с текстом "string"
                              TO "string" - сообщения в поле To: которых присутствует "string"
                              UNANSWERED - неотвеченные сообщения  UNDELETED - не удалённые
                              сообщения  UNFLAGGED - сообщения без установленных флагов  UNKEYWORD
                              "string" - сообщения, не имеющие ключевого слова "string"  UNSEEN -
                              непрочитанные сообщения
                              
                              ALL - возвращать все сообщения, соответствующие остальным критериям
                              
                              ANSWERED - сообщения с выставленным флагом \\ANSWERED
                              
                              BCC "string" - сообщения в поле Bcc: которых присутствует "string"
                              
                              BEFORE "date" - сообщения с Date: до "date"
                              
                              BODY "string" - сообщения содержащие "string" в теле
                              
                              CC "string" - сообщения в поле Cc: которых присутствует "string"
                              
                              DELETED - удалённые сообщения
                              
                              FLAGGED - сообщения с установленным флагом \\FLAGGED (иногда называют
                              "Срочное" или "Важное")
                              
                              FROM "string" - сообщения в поле From: которых присутствует "string"
                              
                              KEYWORD "string" - сообщения с ключевым словом "string"
                              
                              NEW - новые сообщения
                              
                              OLD - старые сообщения
                              
                              ON "date" - сообщения с Date: равным "date"
                              
                              RECENT - означает сообщения с выставленным флагом \\RECENT
                              
                              SEEN - прочтённые сообщения (установлен флаг \\SEEN)
                              
                              SINCE "date" - сообщения с Date: после "date"
                              
                              SUBJECT "string" - сообщения в поле Subject: которых присутствует
                              "string"
                              
                              TEXT "string" - сообщения с текстом "string"
                              
                              TO "string" - сообщения в поле To: которых присутствует "string"
                              
                              UNANSWERED - неотвеченные сообщения
                              
                              UNDELETED - не удалённые сообщения
                              
                              UNFLAGGED - сообщения без установленных флагов
                              
                              UNKEYWORD "string" - сообщения, не имеющие ключевого слова "string"
                              
                              UNSEEN - непрочитанные сообщения
  <info>int</info>              <strong>$flags</strong>     Корректные значения <strong>$flags</strong> - это <info>SE_UID</info>, что приведёт к тому, что в
                              возвращённом массиве вместо номеров сообщений будут содержаться их
                              UID.
  <info>string</info>           <strong>$charset</strong>   Кодировка MIME, в которой будет происходить поиск.

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

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


id: imap_set_quota
type: function
doc:
<comment>Description:</comment>
  Установить квоту для заданного почтового ящика
  
  Устанавливает верхний предел квоты для заданного почтового ящика

<comment>Param:</comment>
  <info>IMAP\Connection</info>  <strong>$imap</strong>          Экземпляр <class>IMAP\Connection</class>.
  <info>string</info>           <strong>$quota_root</strong>    Почтовый ящик, для которого устанавливается квота в виде строки в
                                  формате IMAP: <return>user.name</return>.
  <info>int</info>              <strong>$mailbox_size</strong>  Максимальный размер (в килобайтах) для <strong>$quota_root</strong>

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

<comment>See Also:</comment>
   * <strong>imap_open()</strong>
   * <strong>imap_get_quota()</strong>


id: imap_setacl
type: function
doc:
<comment>Description:</comment>
  Установка ACL для заданного почтового ящика
  
  Устанавливает ACL для заданного почтового ящика.

<comment>Param:</comment>
  <info>IMAP\Connection</info>  <strong>$imap</strong>     Экземпляр <class>IMAP\Connection</class>.
  <info>string</info>           <strong>$mailbox</strong>  Имя почтового ящика, более подробно смотрите в описании <strong>imap_open()</strong>
                             
                             Если imap.enable_insecure_rsh не отключён, то передача в этот параметр
                             не проверенных данных не безопасна.
  <info>string</info>           <strong>$user_id</strong>  Идентификатор пользователя, которому выдаются права.
  <info>string</info>           <strong>$rights</strong>   Права для выдачи. Передача пустой строки означает удаление всех прав.

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

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


id: imap_setflag_full
type: function
doc:
<comment>Description:</comment>
  Установить флаги на сообщения
  
  Сообщает серверу, что надо добавить флаг <strong>$flag</strong> к набору флагов, заданным в <strong>$sequence</strong> сообщениям.

<comment>Param:</comment>
  <info>IMAP\Connection</info>  <strong>$imap</strong>      Экземпляр <class>IMAP\Connection</class>.
  <info>string</info>           <strong>$sequence</strong>  Последовательность номеров сообщений.Вы можете перечислить несколько
                              сообщений, используя как разделитель запятую (<return>X,Y</return>), или задать
                              интервал сообщений с помощью двоеточия <return>X:Y</return>
  <info>string</info>           <strong>$flag</strong>      Флаги, которые можно установить: <return>\Seen</return>, <return>\Answered</return>, <return>\Flagged</return>, <return>\Deleted</return>
                              и <return>\Draft</return>, как определено в RFC2060.
  <info>int</info>              <strong>$options</strong>   Битовая маска, которая может принимать только одно значение: <info>ST_UID</info> -
                              последовательность сообщений задана не их номерами, а с помощью UID
                              
                              <info>ST_UID</info> - последовательность сообщений задана не их номерами, а с
                              помощью UID

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

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


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

<comment>Param:</comment>
  <info>IMAP\Connection</info>  <strong>$imap</strong>             Экземпляр <class>IMAP\Connection</class>.
  <info>int</info>              <strong>$criteria</strong>         Одно (и только одно) из следующих значений: <info>SORTDATE</info> -
                                     сортировать по дате <info>SORTARRIVAL</info> - дата получения <info>SORTFROM</info> - по
                                     первому адресу в поле From <info>SORTSUBJECT</info> - по теме письма <info>SORTTO</info>
                                     - по первому адресу в поле To <info>SORTCC</info> - по первому адресу в поле
                                     cc <info>SORTSIZE</info> - по размеру сообщения
                                     
                                     <info>SORTDATE</info> - сортировать по дате
                                     
                                     <info>SORTARRIVAL</info> - дата получения
                                     
                                     <info>SORTFROM</info> - по первому адресу в поле From
                                     
                                     <info>SORTSUBJECT</info> - по теме письма
                                     
                                     <info>SORTTO</info> - по первому адресу в поле To
                                     
                                     <info>SORTCC</info> - по первому адресу в поле cc
                                     
                                     <info>SORTSIZE</info> - по размеру сообщения
  <info>bool</info>             <strong>$reverse</strong>          Определяет сортировку в обратном порядке.
  <info>int</info>              <strong>$flags</strong>            Параметр <strong>$flags</strong> задаётся битовой маской одной или нескольких
                                     констант: <info>SE_UID</info> - возвращать UID, а не номера сообщений
                                     <info>SE_NOPREFETCH</info> - не извлекать найденные сообщения
                                     
                                     <info>SE_UID</info> - возвращать UID, а не номера сообщений
                                     
                                     <info>SE_NOPREFETCH</info> - не извлекать найденные сообщения
  <info>string|null</info>      <strong>$search_criteria</strong>  Строка с поисковым критерием в формате IMAP2. Подробнее
                                     смотрите в описании функции <strong>imap_search()</strong>.
  <info>string|null</info>      <strong>$charset</strong>          Кодировка MIME для использования при сортировке строк.

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


id: imap_status
type: function
doc:
<comment>Description:</comment>
  Получить информацию по статусу почтового ящика
  
  Возвращает информацию по статусу заданного ящика <strong>$mailbox</strong>.

<comment>Param:</comment>
  <info>IMAP\Connection</info>  <strong>$imap</strong>     Экземпляр <class>IMAP\Connection</class>.
  <info>string</info>           <strong>$mailbox</strong>  Имя почтового ящика, более подробно смотрите в описании <strong>imap_open()</strong>
                             
                             Если imap.enable_insecure_rsh не отключён, то передача в этот параметр
                             не проверенных данных не безопасна.
  <info>int</info>              <strong>$flags</strong>    Допустимые опции: <info>SA_MESSAGES</info> - установить $status-&gt;messages, равным
                             количеству писем в ящике <info>SA_RECENT</info> - установить $status-&gt;recent,
                             равным количеству новых писем <info>SA_UNSEEN</info> - установить
                             $status-&gt;unseen, равным количеству непрочитанных писем <info>SA_UIDNEXT</info> -
                             установить $status-&gt;uidnext равным следующему uid, который будет
                             использован в ящике <info>SA_UIDVALIDITY</info> - установить $status-&gt;uidvalidity
                             в значение константы, которая меняется, когда UID для почтового ящика
                             больше не могут быть действительным <info>SA_ALL</info> - использовать все
                             перечисленные опции
                             
                             <info>SA_MESSAGES</info> - установить $status-&gt;messages, равным количеству писем
                             в ящике
                             
                             <info>SA_RECENT</info> - установить $status-&gt;recent, равным количеству новых
                             писем
                             
                             <info>SA_UNSEEN</info> - установить $status-&gt;unseen, равным количеству
                             непрочитанных писем
                             
                             <info>SA_UIDNEXT</info> - установить $status-&gt;uidnext равным следующему uid,
                             который будет использован в ящике
                             
                             <info>SA_UIDVALIDITY</info> - установить $status-&gt;uidvalidity в значение
                             константы, которая меняется, когда UID для почтового ящика больше не
                             могут быть действительным
                             
                             <info>SA_ALL</info> - использовать все перечисленные опции

<comment>Return:</comment>
  <info>stdClass|false</info>  Функция возвращает объект, содержащий информацию по статусу или <info>false</info> в случае
                  возникновения ошибки. Объект имеет следующие свойства: <return>messages</return>, <return>recent</return>, <return>unseen</return>,
                  <return>uidnext</return> и <return>uidvalidity</return>.
                  
                  <return>flags</return> также установлен, он содержит битовую маску которая может быть проверена с
                  помощью перечисленных выше констант.


id: imap_subscribe
type: function
doc:
<comment>Description:</comment>
  Подписаться на почтовый ящик
  
  Подписаться на новый почтовый ящик.

<comment>Param:</comment>
  <info>IMAP\Connection</info>  <strong>$imap</strong>     Экземпляр <class>IMAP\Connection</class>.
  <info>string</info>           <strong>$mailbox</strong>  Имя почтового ящика. Более подробно читай в разделе про <strong>imap_open()</strong>
                             
                             Если imap.enable_insecure_rsh не отключён, то передача в этот параметр
                             не проверенных данных не безопасна.

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

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


id: imap_thread
type: function
doc:
<comment>Description:</comment>
  Получить дерево связанных сообщений
  
  Возвращает дерево связанных сообщений.

<comment>Param:</comment>
  <info>IMAP\Connection</info>  <strong>$imap</strong>   Экземпляр <class>IMAP\Connection</class>.
  <info>int</info>              <strong>$flags</strong>  

<comment>Return:</comment>
  <info>array|false</info>  <strong>imap_thread()</strong> возвращает ассоциативный массив содержащий дерево сообщений, связанных
               с помощью <return>REFERENCES</return>, или <info>false</info> в случае возникновения ошибки.
               
               Каждое сообщение в текущем почтовом ящике будет представлено как запись в дереве в
               результирующем массиве: $thread["XX.num"] - номер текущего сообщения
               $thread["XX.next"]$thread["XX.branch"]
               
               $thread["XX.num"] - номер текущего сообщения
               
               $thread["XX.next"]
               
               $thread["XX.branch"]


id: imap_timeout
type: function
doc:
<comment>Description:</comment>
  Установить или получить время ожидания imap
  
  Устанавливает или получает время ожидания imap.

<comment>Param:</comment>
  <info>int</info>  <strong>$timeout_type</strong>  Одна из констант: <info>IMAP_OPENTIMEOUT</info>, <info>IMAP_READTIMEOUT</info>, <info>IMAP_WRITETIMEOUT</info> или
                      <info>IMAP_CLOSETIMEOUT</info>.
  <info>int</info>  <strong>$timeout</strong>       Время ожидания в секундах.

<comment>Return:</comment>
  <info>int|bool</info>  Если задан параметр <strong>$timeout</strong>, эта функция вернёт <info>true</info> или <info>false</info> в зависимости от
            успешности выполнения.
            
            Если параметр <strong>$timeout</strong> не задан, или выставлен равным -1, то будет возвращено целое
            число, равное текущей величине времени ожидания, соответствующей заданному типу
            <strong>$timeout_type</strong>.


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

<comment>Param:</comment>
  <info>IMAP\Connection</info>  <strong>$imap</strong>         Экземпляр <class>IMAP\Connection</class>.
  <info>int</info>              <strong>$message_num</strong>  Номер сообщения.

<comment>Return:</comment>
  <info>int|false</info>  UID заданного письма.

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


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

<comment>Param:</comment>
  <info>IMAP\Connection</info>  <strong>$imap</strong>          Экземпляр <class>IMAP\Connection</class>.
  <info>string</info>           <strong>$message_nums</strong>  Строка (<info>string</info>), состоящая из одного или нескольких сообщений в
                                  формате последовательности в стиле IMAP4 (<return>"n"</return>, <return>"n:m"</return> или их
                                  комбинация, разделённая запятыми).
  <info>int</info>              <strong>$flags</strong>         

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

<comment>See Also:</comment>
   * <strong>imap_delete()</strong>
   * <strong>imap_mail_move()</strong>


id: imap_unsubscribe
type: function
doc:
<comment>Description:</comment>
  Отписаться от почтового ящика
  
  Отписаться от почтового ящика <strong>$mailbox</strong>.

<comment>Param:</comment>
  <info>IMAP\Connection</info>  <strong>$imap</strong>     Экземпляр <class>IMAP\Connection</class>.
  <info>string</info>           <strong>$mailbox</strong>  Имя почтового ящика. Более подробно смотрите в разделе про <strong>imap_open()</strong>
                             
                             Если imap.enable_insecure_rsh не отключён, то передача в этот параметр
                             не проверенных данных не безопасна.

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

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


id: imap_utf7_decode
type: function
doc:
<comment>Description:</comment>
  Декодирует строку из модифицированной кодировки UTF-7
  
  Декодирует <strong>$string</strong> из модифицированной кодировки UTF-7 в ISO-8859-1.
  
  Это нужно для декодирования имён почтовых ящиков, содержащих в имени символы, не входящие в
  печатный диапазон ASCII.

<comment>Param:</comment>
  <info>string</info>  <strong>$string</strong>  Текст в модифицированной кодировке UTF-7, как определено в RFC 2060, раздел
                   5.1.3.

<comment>Return:</comment>
  <info>string|false</info>  Возвращает строку в кодировке ISO-8859-1, которая содержит ту же последовательность
                символов, что и <strong>$string</strong>, или <info>false</info>, если <strong>$string</strong> содержит некорректные символы или
                если <strong>$string</strong> содержит символы не входящие в набор символов ISO-8859-1.

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


id: imap_utf7_encode
type: function
doc:
<comment>Description:</comment>
  Преобразует строку ISO-8859-1 в модифицированную UTF-7
  
  Преобразует <strong>$string</strong> в текст в модифицированной кодировке UTF-7.
  
  Это нужно для кодирования имён почтовых ящиков, содержащих в имени символы, не входящие в печатный
  диапазон ASCII.

<comment>Param:</comment>
  <info>string</info>  <strong>$string</strong>  Строка в кодировке ISO-8859-1.

<comment>Return:</comment>
  <info>string</info>  Возвращает данные <strong>$string</strong> кодированные в модифицированной кодировке UTF-7, как определено
          в RFC 2060, раздел 5.1.3.

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


id: imap_utf8
type: function
doc:
<comment>Description:</comment>
  Преобразует MIME-кодированный текст в UTF-8
  
  Преобразует заданный <strong>$mime_encoded_text</strong> в UTF-8, если заявленная кодировка известна libc-client. В
  противном случае данный текст декодируется, но не преобразуется в UTF-8.

<comment>Param:</comment>
  <info>string</info>  <strong>$mime_encoded_text</strong>  MIME-кодированная строка. Метод кодирования MIME и спецификация UTF-8
                              описаны в RFC2047 и RFC2044 соответственно.

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

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


id: imap_utf8_to_mutf7
type: function
doc:
<comment>Description:</comment>
  Кодировать строку UTF-8 в изменённую UTF-7
  
  Кодировать строку UTF-8 в изменённую строку UTF-7 (в соответствии с RFC 2060, раздел 5.1.3).
  
  Эта функция доступна только в случае, если libcclient экспортирует utf8_to_mutf7().

<comment>Param:</comment>
  <info>string</info>  <strong>$string</strong>  Закодированная в UTF-8 строка.

<comment>Return:</comment>
  <info>string|false</info>  Возвращает <strong>$string</strong>, конвертированную в изменённую UTF-7 или <info>false</info> в случае
                возникновения ошибки.

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


id: implode
type: function
doc:
<comment>Description:</comment>
  Объединяет элементы массива в строку
  
  Альтернативная сигнатура (не поддерживается с именованными аргументами):
  
  Устаревшая сигнатура (устарела с PHP 7.4.0, удалена в PHP 8.0.0):
  
  Объединяет элементы массива с помощью строки <strong>$separator</strong>.

<comment>Param:</comment>
  <info>string</info>  <strong>$separator</strong>  Необязательный. По умолчанию равен пустой строке.
  <info>array</info>   <strong>$array</strong>      Массив объединяемых строк.

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

<comment>See Also:</comment>
   * <strong>explode()</strong>
   * <strong>preg_split()</strong>
   * <strong>http_build_query()</strong>


id: in_array
type: function
doc:
<comment>Description:</comment>
  Проверяет, присутствует ли в массиве значение
  
  Ищет в <strong>$haystack</strong> значение <strong>$needle</strong>. Если <strong>$strict</strong> не установлен, то при поиске будет использовано
  нестрогое сравнение.

<comment>Param:</comment>
  <info>mixed</info>  <strong>$needle</strong>    Искомое значение.
                    
                    Если <strong>$needle</strong> - строка, сравнение будет произведено с учётом регистра.
  <info>array</info>  <strong>$haystack</strong>  Массив.
  <info>bool</info>   <strong>$strict</strong>    Если третий параметр <strong>$strict</strong> установлен в <info>true</info>, тогда функция <strong>in_array()</strong> также
                    проверит соответствие типов параметра <strong>$needle</strong> и соответствующего значения
                    массива <strong>$haystack</strong>.
                    
                    До PHP 8.0.0 <return>строковое</return> значение параметра <strong>$needle</strong> будет соответствовать значению
                    массива <return>0</return> в нестрогом режиме, и наоборот. Это может привести к нежелательным
                    результатам. Подобные крайние случаи существуют и для других типов. Если нет
                    полной уверенности в типах значений, всегда используйте флаг <strong>$strict</strong>, чтобы
                    избежать неожиданного поведения.

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

<comment>See Also:</comment>
   * <strong>array_search()</strong>
   * <strong>isset()</strong>
   * <strong>array_key_exists()</strong>


id: inet_ntop
type: function
doc:
<comment>Description:</comment>
  Конвертирует упакованный интернет-адрес в читаемый формат
  
  Эта функция конвертирует 32-битный IPv4 или 128-битный IPv6-адрес (если PHP был собран с
  поддержкой IPv6) в соответствующее строковое представление адреса.

<comment>Param:</comment>
  <info>string</info>  <strong>$ip</strong>  32-битный IPv4-адрес или 128-битный IPv6-адрес.

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

<comment>See Also:</comment>
   * <strong>long2ip()</strong>
   * <strong>ip2long()</strong>
   * <strong>inet_pton()</strong>


id: inet_pton
type: function
doc:
<comment>Description:</comment>
  Конвертирует читаемый IP-адрес в его упакованное представление in_addr
  
  Эта функция конвертирует читаемый IPv4- или IPv6-адрес (если PHP был собран с поддержкой IPv6) в
  адрес, соответствующий 32-битной или 128-битной бинарной структуре.

<comment>Param:</comment>
  <info>string</info>  <strong>$ip</strong>  Читаемый IPv4- или IPv6-адрес.

<comment>Return:</comment>
  <info>string|false</info>  Возвращает представление <return>in_addr</return> заданного в параметре <strong>$ip</strong> адреса, или <info>false</info> если
                задан синтаксически неверный <strong>$ip</strong> (к примеру,  IPv4-адрес без точек или IPv6-адрес
                без двоеточий).

<comment>See Also:</comment>
   * <strong>ip2long()</strong>
   * <strong>long2ip()</strong>
   * <strong>inet_ntop()</strong>


id: inflate_add
type: function
doc:
<comment>Description:</comment>
  Инкрементальное распаковать закодированные данные
  
  Инкрементальное распаковывает закодированные данные в указанном контексте <strong>$context</strong>.
  
  Ограничение: информация заголовка из сжатых данных GZIP не доступны.

<comment>Param:</comment>
  <info>InflateContext</info>  <strong>$context</strong>     Контекст, созданный с помощью <strong>inflate_init()</strong>.
  <info>string</info>          <strong>$data</strong>        Блок сжатых данных.
  <info>int</info>             <strong>$flush_mode</strong>  Одна из констант: <info>ZLIB_BLOCK</info>, <info>ZLIB_NO_FLUSH</info>, <info>ZLIB_PARTIAL_FLUSH</info>,
                               <info>ZLIB_SYNC_FLUSH</info> (по умолчанию), <info>ZLIB_FULL_FLUSH</info>, <info>ZLIB_FINISH</info>. Обычно
                               требуется установить <info>ZLIB_NO_FLUSH</info> для максимальной компрессии и
                               <info>ZLIB_FINISH</info> для завершения работы с последним блоком данных.
                               Детальное описание констант смотрите в руководство zlib.

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

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


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

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

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


id: inflate_get_status
type: function
doc:
<comment>Description:</comment>
  Получает статус декомпрессии
  
  Обычно возвращает <info>ZLIB_OK</info> или <info>ZLIB_STREAM_END</info>.

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

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


id: inflate_init
type: function
doc:
<comment>Description:</comment>
  Инициализация контекста инкрементальной распаковки
  
  Инициализирует контекст инкрементальной распаковки с указанной кодировкой <strong>$encoding</strong>.

<comment>Param:</comment>
  <info>int</info>    <strong>$encoding</strong>  Одна из констант <info>ZLIB_ENCODING_*</info>.
  <info>array</info>  <strong>$options</strong>   Ассоциативный массив, который может содержать следующие элементы: level Уровень
                    сжатия в диапазоне -1..9; по умолчанию -1. memory Уровень памяти сжатия в
                    диапазоне 1..9; по умолчанию 8. window Размер окна zlib (логарифмический) в
                    диапазоне 8..15; по умолчанию 15. strategy Одна из констант: <info>ZLIB_FILTERED</info>,
                    <info>ZLIB_HUFFMAN_ONLY</info>, <info>ZLIB_RLE</info>, <info>ZLIB_FIXED</info> или <info>ZLIB_DEFAULT_STRATEGY</info> (по
                    умолчанию). dictionary Строка (<info>string</info>) или массив (<info>array</info>) строк текущего словаря
                    (по умолчанию предустановленного словаря нет).
                    
                    Уровень сжатия в диапазоне -1..9; по умолчанию -1.
                    
                    Уровень памяти сжатия в диапазоне 1..9; по умолчанию 8.
                    
                    Размер окна zlib (логарифмический) в диапазоне 8..15; по умолчанию 15.
                    
                    Одна из констант: <info>ZLIB_FILTERED</info>, <info>ZLIB_HUFFMAN_ONLY</info>, <info>ZLIB_RLE</info>, <info>ZLIB_FIXED</info> или
                    <info>ZLIB_DEFAULT_STRATEGY</info> (по умолчанию).
                    
                    Строка (<info>string</info>) или массив (<info>array</info>) строк текущего словаря (по умолчанию
                    предустановленного словаря нет).

<comment>Return:</comment>
  <info>InflateContext|false</info>  Возвращает ресурс контекста распаковки (<return>zlib.inflate</return>) или <info>false</info> в случае
                        возникновения ошибки.

<comment>See Also:</comment>
   * <strong>inflate_add()</strong>
   * <strong>deflate_init()</strong>


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


id: ini_get
type: function
doc:
<comment>Description:</comment>
  Получает значение настройки конфигурации
  
  В случае успешного выполнения возвращает значение настройки конфигурации.

<comment>Param:</comment>
  <info>string</info>  <strong>$option</strong>  Имя настройки конфигурации.

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

<comment>See Also:</comment>
   * <strong>get_cfg_var()</strong>
   * <strong>ini_get_all()</strong>
   * <strong>ini_restore()</strong>
   * <strong>ini_set()</strong>


id: ini_get_all
type: function
doc:
<comment>Description:</comment>
  Получает все настройки конфигурации
  
  Возвращает все зарегистрированные настройки конфигурации.

<comment>Param:</comment>
  <info>string|null</info>  <strong>$extension</strong>  Необязательное имя модуля. Если не <info>null</info> и не строка (<info>string</info>) <return>core</return>,
                           функция возвращает только параметры.
  <info>bool</info>         <strong>$details</strong>    Выводить детальные сведения о настройках или только текущие значения. По
                           умолчанию <info>true</info> (выводить детальные сведения).

<comment>Return:</comment>
  <info>array|false</info>  Возвращает ассоциативный массив с именами директив в качестве ключей. Возвращает
               <info>false</info> и вызывает ошибку уровня <info>E_WARNING</info>, если <strong>$extension</strong> не существует.
               
               Если <strong>$details</strong> равен <info>true</info> (по умолчанию), в массиве будут содержаться <return>global_value</return>
               (значение настройки php.ini), <return>local_value</return> (например, заданное с помощью <strong>ini_set()</strong> или
               .htaccess) и <return>access</return> (уровень доступа).
               
               Если <strong>$details</strong> равен <info>false</info>, значением массива будет соответствующее текущее значение
               настройки.
               
               Смотрите соответствующий раздел руководства, в котором приводится описание уровней
               доступа.
               
               Директива может иметь несколько уровней доступа, в этом случае <return>access</return> будет содержать
               соответствующую битовую маску.

<comment>See Also:</comment>
   * 
   * <strong>ini_get()</strong>
   * <strong>ini_restore()</strong>
   * <strong>ini_set()</strong>
   * <strong>get_loaded_extensions()</strong>
   * <strong>phpinfo()</strong>
   * ReflectionExtension::getINIEntries


id: ini_parse_quantity
type: function
doc:
<comment>Description:</comment>
  Get interpreted size from ini shorthand syntax
  
  В случае успешного выполнения возвращает интерпретируемый размер в байтах из сокращений байтовых
  значений.

<comment>Param:</comment>
  <info>string</info>  <strong>$shorthand</strong>  Сокращение байтовых значений для разбора, должно быть числом, за которым
                      следует необязательный множитель.
                       Поддерживаются следующие множители: <return>k</return>/<return>K</return> (<return>1024</return>), <return>m</return>/<return>M</return> (<return>1048576</return>), <return>g</return>/<return>G</return>
                      (<return>1073741824</return>).
                       Число может быть десятичным, шестнадцатеричным (с префиксом <return>0x</return> или <return>0X</return>),
                      восьмеричным (с префиксом <return>0o</return>, <return>0O</return> или <return>0</return>) или двоичным (с префиксом <return>0b</return> или <return>0B</return>).

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

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


id: ini_restore
type: function
doc:
<comment>Description:</comment>
  Восстанавливает значение настройки конфигурации
    
  
  Восстанавливает исходное значение настройки конфигурации.

<comment>Param:</comment>
  <info>string</info>  <strong>$option</strong>  Имя настройки.

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

<comment>See Also:</comment>
   * <strong>ini_get()</strong>
   * <strong>ini_get_all()</strong>
   * <strong>ini_set()</strong>


id: ini_set
type: function
doc:
<comment>Description:</comment>
  Устанавливает значение настройки конфигурации
    
  
  Устанавливает значение заданной настройки конфигурации. Настройка будет хранить установленное
  значение пока выполняется скрипт. После завершения работы скрипта значение настройки вернётся к
  исходному.

<comment>Param:</comment>
  <info>string</info>                      <strong>$option</strong>  Не все доступные настройки можно изменять функцией <strong>ini_set()</strong>.
                                       Список доступных настроек приведён в приложении.
  <info>string|int|float|bool|null</info>  <strong>$value</strong>   Новое значение настройки.

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

<comment>See Also:</comment>
   * <strong>get_cfg_var()</strong>
   * <strong>ini_get()</strong>
   * <strong>ini_get_all()</strong>
   * <strong>ini_restore()</strong>
   * Как изменить настройки конфигурации


id: inotify_add_watch
type: function
doc:
<comment>Description:</comment>
  Добавить наблюдателя для экземпляра inotify
  
  <strong>inotify_add_watch()</strong> добавляет нового наблюдателя или изменяет существующего для файла или
  директории, заданных в <strong>$pathname</strong>.
  
  Использование <strong>inotify_add_watch()</strong> на уже отслеживаемом объекте заменит текущего наблюдателя.
  использование константы <info>IN_MASK_ADD</info> добавит (OR) события существующему наблюдателю.

<comment>Param:</comment>
  <info>resource</info>  <strong>$inotify_instance</strong>  Ресурс, возвращаемый
                               <strong>inotify_init()</strong>
  <info>string</info>    <strong>$pathname</strong>          Файл или директория для отслеживания
  <info>int</info>       <strong>$mask</strong>              События, которые надо отслеживать. Смотрите Предопределённые
                               константы.

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

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


id: inotify_init
type: function
doc:
<comment>Description:</comment>
  Инициализирует экземпляр inotify
  
  Инициализирует экземпляр inotify для использования в <strong>inotify_add_watch()</strong>

<comment>Return:</comment>
  <info>resource</info>  Потоковый ресурс или <info>false</info>.

<comment>See Also:</comment>
   * <strong>inotify_add_watch()</strong>
   * <strong>inotify_rm_watch()</strong>
   * <strong>inotify_queue_len()</strong>
   * <strong>inotify_read()</strong>
   * <strong>fclose()</strong>


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

<comment>Param:</comment>
  <info>resource</info>  <strong>$inotify_instance</strong>  Ресурс, возвращаемый
                               <strong>inotify_init()</strong>

<comment>Return:</comment>
  <info>int</info>  Возвращает число ожидающих сообщений в очереди.

<comment>See Also:</comment>
   * <strong>inotify_init()</strong>
   * <strong>stream_select()</strong>
   * <strong>stream_set_blocking()</strong>


id: inotify_read
type: function
doc:
<comment>Description:</comment>
  Читает ожидающие сообщения из очереди
  
  Читает ожидающие сообщения из очереди.

<comment>Param:</comment>
  <info>resource</info>  <strong>$inotify_instance</strong>  Ресурс, возвращаемый
                               <strong>inotify_init()</strong>

<comment>Return:</comment>
  <info>array</info>  Массив событий inotify или <info>false</info>, если событий в очереди нет и <strong>$inotify_instance</strong> не
         блокирующий. Каждый элемент массива состоит из: wd - дескриптор наблюдателя, возвращённый
         <strong>inotify_add_watch()</strong>mask - битовая маска событийcookie - уникальный идентификатор для
         объединения связанных событий (например <info>IN_MOVE_FROM</info> и <info>IN_MOVE_TO</info>)name - имя файла
         (например если в наблюдаемой директории изменился файл)

<comment>See Also:</comment>
   * <strong>inotify_init()</strong>
   * <strong>stream_select()</strong>
   * <strong>stream_set_blocking()</strong>
   * <strong>inotify_queue_len()</strong>


id: inotify_rm_watch
type: function
doc:
<comment>Description:</comment>
  Удалить наблюдателя
  
  <strong>inotify_rm_watch()</strong> удаляет наблюдателя <strong>$watch_descriptor</strong> из экземпляра inotify <strong>$inotify_instance</strong>.

<comment>Param:</comment>
  <info>resource</info>  <strong>$inotify_instance</strong>  Ресурс, возвращаемый
                               <strong>inotify_init()</strong>
  <info>int</info>       <strong>$watch_descriptor</strong>  Наблюдатель для удаления

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

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


id: intdiv
type: function
doc:
<comment>Description:</comment>
  Целочисленное деление
  
  Возвращает результат целочисленного деления <strong>$num1</strong> на <strong>$num2</strong>.

<comment>Param:</comment>
  <info>int</info>  <strong>$num1</strong>  Числитель (то, что делится).
  <info>int</info>  <strong>$num2</strong>  Знаменатель. Число, на которое делится <strong>$num1</strong>

<comment>Return:</comment>
  <info>int</info>  Целое частное от деления <strong>$num1</strong> на <strong>$num2</strong>.

<comment>See Also:</comment>
   * <return>/</return> - деление рациональных чисел
   * <return>%</return> - остаток от деления
   * <strong>fmod()</strong> - остаток от деления рациональных чисел


id: interface_exists
type: function
doc:
<comment>Description:</comment>
  Проверяет, определён ли интерфейс
  
  Проверяет, определён ли указанный интерфейс.

<comment>Param:</comment>
  <info>string</info>  <strong>$interface</strong>  Имя интерфейса
  <info>bool</info>    <strong>$autoload</strong>   Нужно ли автоматически подгружать интерфейс, если он ещё не загружен.

<comment>Return:</comment>
  <info>bool</info>  Возвращает <info>true</info>, если интерфейс c заданным именем <strong>$interface</strong> был определён или <info>false</info> в
        противном случае.

<comment>See Also:</comment>
   * <strong>get_declared_interfaces()</strong>
   * <strong>class_implements()</strong>
   * <strong>class_exists()</strong>
   * <strong>enum_exists()</strong>


id: intl_error_name
type: function
doc:
<comment>Description:</comment>
  Получить имя ошибки по её коду
  
  Возвращает имя ошибки ICU.

<comment>Param:</comment>
  <info>int</info>  <strong>$errorCode</strong>  Код ошибки ICU.

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

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


id: intl_get_error_code
type: function
doc:
<comment>Description:</comment>
  Получить код последней ошибки
  
  Полезно для обработки ошибок статических методов, когда отсутствует объект для извлечения ошибки
  из него.

<comment>Return:</comment>
  <info>int</info>  Код ошибки, возвращённый последним вызовом функции API.

<comment>See Also:</comment>
   * <strong>intl_is_failure()</strong>
   * <strong>intl_error_name()</strong>
   * <strong>intl_get_error_message()</strong>
   * <strong>collator_get_error_code()</strong>
   * <strong>numfmt_get_error_code()</strong>


id: intl_get_error_message
type: function
doc:
<comment>Description:</comment>
  Получить описание ошибки
  
  Получить описание последней произошедшей ошибки в функциях ICU.

<comment>Return:</comment>
  <info>string</info>  Описание последней произошедшей ошибки в функциях ICU.

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


id: intl_is_failure
type: function
doc:
<comment>Description:</comment>
  Проверить, является ли код ошибки признаком сбоя
  
  

<comment>Param:</comment>
  <info>int</info>  <strong>$errorCode</strong>  Значение, возвращённое функциями: <strong>intl_get_error_code()</strong>,
                   <strong>collator_get_error_code()</strong> .

<comment>Return:</comment>
  <info>bool</info>  <info>true</info>, если произошёл сбой, и <info>false</info>, если все успешно, либо просто предупреждение.

<comment>See Also:</comment>
   * <strong>intl_get_error_code()</strong>
   * <strong>collator_get_error_code()</strong>
   * <strong>Collator-getErrorCode()</strong>


id: intval
type: function
doc:
<comment>Description:</comment>
  Возвращает целочисленное значение переменной
  
  Возвращает целочисленное значение (<info>int</info>) переменной <strong>$value</strong>, рассматривая ее как значение в системе
  счисления с основанием, которое определено в параметре <strong>$base</strong> (по умолчанию основание равно 10).
  Функцию <strong>intval()</strong> нельзя использовать с объектами, попытка это сделать вызовет ошибку уровня
  <info>E_WARNING</info> и вернёт значение 1.

<comment>Param:</comment>
  <info>mixed</info>  <strong>$value</strong>  Скалярное значение для конвертации в целое
  <info>int</info>    <strong>$base</strong>   Основание системы счисления для преобразования
                 
                 Если значение параметра <strong>$base</strong> равно 0, основание системы счисления будет определено
                 форматом параметра <strong>$value</strong>:  если строка включает префикс "0x" (или "0X"), будет
                 взято основание 16 (шестнадцатеричное);  иначе, если строка начинается с "0b" (или
                 "0B"), будет взято основание 2 (двоичное);  иначе, если строка начинается с "0",
                 будет взято основание 8 (восьмеричное);  иначе основание будет равно 10
                 (десятичая).
                 
                 если строка включает префикс "0x" (или "0X"), будет взято основание 16
                 (шестнадцатеричное);
                 
                 иначе, если строка начинается с "0b" (или "0B"), будет взято основание 2
                 (двоичное);
                 
                 иначе, если строка начинается с "0", будет взято основание 8 (восьмеричное);
                 
                 иначе основание будет равно 10 (десятичая).

<comment>Return:</comment>
  <info>int</info>  Функция возвращает целочисленное значение переменной <strong>$value</strong> в случае успешного выполнения,
       или 0 в случае возникновения ошибки. Для пустых массивов возвращается 0, для непустых
       возвращается 1.
       
       Максимальное значение зависит от операционной системы. В 32-битных системах максимальное
       знаковое целое лежит в диапазоне от -2 147 483 648 до 2 147 483 647. Так, например, в такой
       системе, <return>intval('1000000000000')</return> вернёт 2 147 483 647. Максимальное знаковое целое значение
       для 64-битных систем — 9 223 372 036 854 775 807.
       
       Для строк функция, скорее всего, вернёт 0, хотя это зависит от первого символа в строке.
       Будут применены общие правила преобразования в целые.

<comment>See Also:</comment>
   * <strong>boolval()</strong>
   * <strong>floatval()</strong>
   * <strong>strval()</strong>
   * <strong>settype()</strong>
   * <strong>is_numeric()</strong>
   * Манипуляции с типами
   * Математические функции произвольной точности BCMath


id: ip2long
type: function
doc:
<comment>Description:</comment>
  Конвертирует строку, содержащую IPv4-адрес в целое число
  
  Функция <strong>ip2long()</strong> преобразует IPv4-адрес сети Интернет из стандартного формата (строка с точками)
  в целое число.
  
  Функция <strong>ip2long()</strong> также будет работать с неполными IP-адресами. Смотрите
  http://ps-2.kev009.com/wisclibrary/aix52/usr/share/man/info/en_US/a_doc_lib/libs/commtrf2/inet_addr.htm
  для более подробной информации.

<comment>Param:</comment>
  <info>string</info>  <strong>$ip</strong>  Адрес в стандартном формате.

<comment>Return:</comment>
  <info>int|false</info>  Возвращает целое число или <info>false</info>, если параметр <strong>$ip</strong> содержит ошибку.

<comment>See Also:</comment>
   * <strong>long2ip()</strong>
   * <strong>sprintf()</strong>


id: iptcembed
type: function
doc:
<comment>Description:</comment>
  Встраивание двоичных IPTC данных в JPEG изображение
  
  Включает двоичные IPTC данные в JPEG изображение.

<comment>Param:</comment>
  <info>string</info>  <strong>$iptc_data</strong>  Данные.
  <info>string</info>  <strong>$filename</strong>   Путь к JPEG изображению.
  <info>int</info>     <strong>$spool</strong>      Если значение этого флага больше 2, то JPEG будет возвращён в виде строки. В
                      противном случае, JPEG будет напечатан в STDOUT.

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


id: iptcparse
type: function
doc:
<comment>Description:</comment>
  Разбор двоичных IPTC данных на отдельные теги
    
  
  Разбирает IPTC данные на отдельные теги.

<comment>Param:</comment>
  <info>string</info>  <strong>$iptc_block</strong>  Двоичные данные IPTC.

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


id: is_a
type: function
doc:
<comment>Description:</comment>
  Проверяет, является ли объект указанным типом или подтипом
  
  Проверяет, относится ли объект <strong>$object_or_class</strong> к указанному типу объекта или имеет этот тип
  объекта в качестве одного из своих супертипов.

<comment>Param:</comment>
  <info>mixed</info>   <strong>$object_or_class</strong>  Имя класса или объект
  <info>string</info>  <strong>$class</strong>            Имя класса или интерфейса.
  <info>bool</info>    <strong>$allow_string</strong>     Если параметр установлен в <info>false</info>, то не допускается имя класса в виде
                            строки в качестве параметра <strong>$object_or_class</strong>. Это также предотвращает
                            вызов автозагрузчика, если класс не существует.

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

<comment>See Also:</comment>
   * <strong>get_class()</strong>
   * <strong>get_parent_class()</strong>
   * <strong>is_subclass_of()</strong>


id: is_array
type: function
doc:
<comment>Description:</comment>
  Определяет, является ли переменная массивом
  
  Определяет, является ли данная переменная массивом.

<comment>Param:</comment>
  <info>mixed</info>  <strong>$value</strong>  Проверяемая переменная.

<comment>Return:</comment>
  <info>bool</info>  Возвращает <info>true</info>, если переменная <strong>$value</strong> является массивом (<info>array</info>), или <info>false</info> в противном
        случае.

<comment>See Also:</comment>
   * <strong>array_is_list()</strong>
   * <strong>is_float()</strong>
   * <strong>is_int()</strong>
   * <strong>is_string()</strong>
   * <strong>is_object()</strong>


id: is_bool
type: function
doc:
<comment>Description:</comment>
  Проверяет, является ли переменная булевой
    
  
  Проверяет, является ли данная переменная булевой.

<comment>Param:</comment>
  <info>mixed</info>  <strong>$value</strong>  Проверяемая переменная.

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

<comment>See Also:</comment>
   * <strong>is_float()</strong>
   * <strong>is_int()</strong>
   * <strong>is_string()</strong>
   * <strong>is_object()</strong>
   * <strong>is_array()</strong>


id: is_callable
type: function
doc:
<comment>Description:</comment>
  Проверяет, что значение может быть вызвано как функция в текущей области видимости
    
  
  Проверяет, что значение является <info>callable</info>.

<comment>Param:</comment>
  <info>mixed</info>   <strong>$value</strong>          Значение для проверки
  <info>bool</info>    <strong>$syntax_only</strong>    Если равен <info>true</info>, функция только проверяет, что <strong>$value</strong> может быть функцией
                          или методом. В этом случае будут отклоняться переменные, которые не
                          являются ни строкой, ни массивом c корректной структурой для использования
                          в качестве callback-функции. Корректная структура массива предполагает
                          наличие только двух элементов, первый из которых - объект или строка, а
                          второй - только строка.
  <info>string</info>  <strong>$callable_name</strong>  Получает "вызываемое имя". В примере ниже это "someClass::someMethod".
                          Следует иметь в виду, что хотя запись someClass::SomeMethod() означает
                          вызываемый статический метод, это не так.

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

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


id: is_countable
type: function
doc:
<comment>Description:</comment>
  Проверить, что содержимое переменной является счётным значением
    
  
  Проверить, что содержимое переменной массив (<info>array</info>) или объект, реализующий <class>Countable</class>

<comment>Param:</comment>
  <info>mixed</info>  <strong>$value</strong>  Значение для проверки

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

<comment>See Also:</comment>
   * <strong>is_array()</strong>
   * <strong>is_object()</strong>
   * <strong>is_iterable()</strong>
   * <strong>is_bool()</strong>


id: is_dir
type: function
doc:
<comment>Description:</comment>
  Определяет, является ли имя файла директорией
  
  Определяет, является ли имя файла директорией.

<comment>Param:</comment>
  <info>string</info>  <strong>$filename</strong>  Путь к файлу. Если <strong>$filename</strong> является относительным именем, он будет
                     проверяться относительно текущей рабочей директории. Если <strong>$filename</strong> является
                     символической или жёсткой ссылкой, то ссылка будет раскрыта и проверена. При
                     включённом open_basedir могут применяться дальнейшие ограничения.

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

<comment>See Also:</comment>
   * <strong>chdir()</strong>
   * <strong>dir()</strong>
   * <strong>opendir()</strong>
   * <strong>is_file()</strong>
   * <strong>is_link()</strong>


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


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

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

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

<comment>See Also:</comment>
   * <strong>is_file()</strong>
   * <strong>is_link()</strong>


id: is_file
type: function
doc:
<comment>Description:</comment>
  Определяет, является ли файл обычным файлом
  
  Определяет, является ли файл обычным файлом.

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

<comment>Return:</comment>
  <info>bool</info>  Возвращает <info>true</info>, если файл существует и является обычным файлом, иначе возвращает <info>false</info>.
        
        Так как тип integer в PHP является целым числом со знаком, и многие платформы используют
        32-х битные целые числа,
        то некоторые функции файловых систем могут возвращать неожиданные результаты для файлов
        размером больше 2 Гб.

<comment>See Also:</comment>
   * <strong>is_dir()</strong>
   * <strong>is_link()</strong>
   * <class>SplFileInfo</class>


id: is_finite
type: function
doc:
<comment>Description:</comment>
  Проверяет, является ли число с плавающей точкой допустимым конечным числом
  
  Возвращает результат проверки того, является ли переданное в параметр <strong>$num</strong> значение допустимым
  конечным числом с плавающей точкой.
  
  Допустимое конечное число с плавающей точкой не может быть ни нечислом (<return>NAN</return>), как его вычисляет
  функция <strong>is_nan()</strong>, ни бесконечностью, как её вычисляет функция <strong>is_infinite()</strong>.

<comment>Param:</comment>
  <info>float</info>  <strong>$num</strong>  Проверяемое число с плавающей точкой (<info>float</info>)

<comment>Return:</comment>
  <info>bool</info>  Возвращает <info>true</info>, если значение <strong>$num</strong> не нечисло <return>NAN</return>, не положительная бесконечность <return>INF</return>, не
        отрицательная бесконечность <return>-INF</return>, иначе <info>false</info>.

<comment>See Also:</comment>
   * <strong>is_infinite()</strong>
   * <strong>is_nan()</strong>


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

<comment>Param:</comment>
  <info>mixed</info>  <strong>$value</strong>  Проверяемая переменная.

<comment>Return:</comment>
  <info>bool</info>  Возвращает <info>true</info>, если <strong>$value</strong> является переменной типа <info>float</info>, <info>false</info> в противном случае.

<comment>See Also:</comment>
   * <strong>is_bool()</strong>
   * <strong>is_int()</strong>
   * <strong>is_numeric()</strong>
   * <strong>is_string()</strong>
   * <strong>is_array()</strong>
   * <strong>is_object()</strong>


id: is_infinite
type: function
doc:
<comment>Description:</comment>
  Проверяет, является ли число с плавающей точкой бесконечным
  
  Возвращает результат проверки того, является ли переданное в параметр <strong>$num</strong> значение положительной
  (<return>INF</return>) или отрицательной бесконечностью (<return>-INF</return>).

<comment>Param:</comment>
  <info>float</info>  <strong>$num</strong>  Проверяемое число с плавающей точкой (<info>float</info>)

<comment>Return:</comment>
  <info>bool</info>  Возвращает <info>true</info>, если параметр <strong>$num</strong> является бесконечным положительным числом (<return>INF</return>) или
        отрицательным бесконечным числом (<return>-INF</return>), иначе <info>false</info>.

<comment>See Also:</comment>
   * <strong>is_finite()</strong>
   * <strong>is_nan()</strong>


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

<comment>Param:</comment>
  <info>mixed</info>  <strong>$value</strong>  Проверяемая переменная.

<comment>Return:</comment>
  <info>bool</info>  Возвращает <info>true</info>, если <strong>$value</strong> является целым числом (<info>int</info>), или <info>false</info> в противном случае.

<comment>See Also:</comment>
   * <strong>is_bool()</strong>
   * <strong>is_float()</strong>
   * <strong>is_numeric()</strong>
   * <strong>is_string()</strong>
   * <strong>is_array()</strong>
   * <strong>is_object()</strong>


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


id: is_iterable
type: function
doc:
<comment>Description:</comment>
  Проверяет, является ли переменная итерируемой
    
  
  Проверяет, соответствует ли содержимое переменной псевдотипу <info>iterable</info>, то есть является ли она
  либо массивом (<info>array</info>), либо объектом, реализующим <class>Traversable</class>

<comment>Param:</comment>
  <info>mixed</info>  <strong>$value</strong>  Переменная для проверки

<comment>Return:</comment>
  <info>bool</info>  Возвращает <info>true</info>, если <strong>$value</strong> итерируемая или <info>false</info>, если нет.

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


id: is_link
type: function
doc:
<comment>Description:</comment>
  Определяет, является ли файл символической ссылкой
  
  Определяет, является ли файл символической ссылкой.

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

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

<comment>See Also:</comment>
   * <strong>is_dir()</strong>
   * <strong>is_file()</strong>
   * <strong>readlink()</strong>


id: is_nan
type: function
doc:
<comment>Description:</comment>
  Проверяет, является ли число с плавающей точкой нечислом
  
  Возвращает результат проверки того, является ли переданное в параметр <strong>$num</strong> значение нечислом (<return>NAN</return>)
  (не числом).
  
  Нечисло (<return>NAN</return>) — неопределённый результат математического вычисления, бывает, например, тогда,
  когда передаваемые параметры выходят за пределы области входных данных функции. Квадратный корень
  числа (функция <strong>sqrt()</strong>) может быть определён только для положительных чисел, передача (в функцию)
  отрицательного числа приведёт к состоянию нечисла (<return>NAN</return>). Другие примеры операций, возвращающих
  нечисло (<return>NAN</return>), — деление положительного бесконечного числа (<return>INF</return>) на другое бесконечное
  положительное число (<return>INF</return>) или любая операция, аргументами которой будет нечисло (<return>NAN</return>).
  
  Несмотря на сказанное выше, нечисло (<return>NAN</return>) — это допустимое значение для типа <info>float</info>.
  
  Нечисло (<return>NAN</return>) не тождественно другому нечислу (<return>NAN</return>). Соответствие числа с плавающей точкой нечислу
  (<return>NAN</return>) проверяют функцией <strong>is_nan()</strong>. Проверка $float === NAN не сработает.

<comment>Param:</comment>
  <info>float</info>  <strong>$num</strong>  Проверяемое число с плавающей точкой (<info>float</info>)

<comment>Return:</comment>
  <info>bool</info>  Возвращает <info>true</info>, если параметр <strong>$num</strong> — нечисло (<return>NAN</return>), иначе <info>false</info>.

<comment>See Also:</comment>
   * <strong>is_finite()</strong>
   * <strong>is_infinite()</strong>


id: is_null
type: function
doc:
<comment>Description:</comment>
  Проверяет, является ли значение переменной равным null
    
  
  Проверяет, является ли значение данной переменной равным <info>null</info>.

<comment>Param:</comment>
  <info>mixed</info>  <strong>$value</strong>  Проверяемая переменная.

<comment>Return:</comment>
  <info>bool</info>  Возвращает <info>true</info>, если значение <strong>$value</strong> равно <info>null</info>, или <info>false</info> в противном случае.

<comment>See Also:</comment>
   * Тип <info>null</info>
   * <strong>isset()</strong>
   * <strong>is_bool()</strong>
   * <strong>is_numeric()</strong>
   * <strong>is_float()</strong>
   * <strong>is_int()</strong>
   * <strong>is_string()</strong>
   * <strong>is_object()</strong>
   * <strong>is_array()</strong>


id: is_numeric
type: function
doc:
<comment>Description:</comment>
  Проверяет, является ли переменная числом или строкой, содержащей число
    
  
  Определяет, является ли данная переменная числом или строкой, содержащей число.

<comment>Param:</comment>
  <info>mixed</info>  <strong>$value</strong>  Проверяемая переменная.

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

<comment>See Also:</comment>
   * Строки, содержащие числа
   * <strong>ctype_digit()</strong>
   * <strong>is_bool()</strong>
   * <strong>is_null()</strong>
   * <strong>is_float()</strong>
   * <strong>is_int()</strong>
   * <strong>is_string()</strong>
   * <strong>is_object()</strong>
   * <strong>is_array()</strong>
   * <strong>filter_var()</strong>


id: is_object
type: function
doc:
<comment>Description:</comment>
  Проверяет, является ли переменная объектом
  
  Проверяет, является ли данная переменная объектом.

<comment>Param:</comment>
  <info>mixed</info>  <strong>$value</strong>  Проверяемая переменная.

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

<comment>See Also:</comment>
   * <strong>is_bool()</strong>
   * <strong>is_int()</strong>
   * <strong>is_float()</strong>
   * <strong>is_string()</strong>
   * <strong>is_array()</strong>


id: is_readable
type: function
doc:
<comment>Description:</comment>
  Определяет существование файла и доступен ли он для чтения
  
  Возвращает <info>true</info>, если файл существует и доступен для чтения.

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

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

<comment>See Also:</comment>
   * <strong>is_writable()</strong>
   * <strong>file_exists()</strong>
   * <strong>fgets()</strong>


id: is_real
type: function
doc:
<comment>Description:</comment>
  Псевдоним is_float
  
  Функция является псевдонимом:  <strong>is_float()</strong>.
  
  Псевдоним объявлен
  УСТАРЕВШИМ в PHP 7.4.0 и УДАЛЁН в PHP 8.0.0.


id: is_resource
type: function
doc:
<comment>Description:</comment>
  Проверяет, является ли переменная ресурсом
    
  
  Проверяет, является ли данная переменная ресурсом (<info>resource</info>).

<comment>Param:</comment>
  <info>mixed</info>  <strong>$value</strong>  Проверяемая переменная.

<comment>Return:</comment>
  <info>bool</info>  Возвращает <info>true</info>, если <strong>$value</strong> является ресурсом (<info>resource</info>), или <info>false</info> в противном случае.

<comment>See Also:</comment>
   * Тип resource
   * <strong>get_resource_type()</strong>


id: is_scalar
type: function
doc:
<comment>Description:</comment>
  Проверяет, является ли переменная скалярным значением
    
  
  Проверяет, является ли данная переменная скалярным значением.
  
  Скалярные переменные - это переменные с типами <info>int</info>, <info>float</info>, <info>string</info> и <info>bool</info>. Типы <info>array</info>, <info>object</info>,
  <info>resource</info> и <info>null</info> не являются скалярными.
  
  <strong>is_scalar()</strong> не считает переменные типа <info>resource</info> скалярными, так как ресурсы являются абстрактными
  типами данных, которые в настоящее время основаны на целом типе. Не стоит полагаться на данную
  деталь реализации, так как она может измениться.
  
  <strong>is_scalar()</strong> не считает NULL скаляром.

<comment>Param:</comment>
  <info>mixed</info>  <strong>$value</strong>  Проверяемая переменная.

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

<comment>See Also:</comment>
   * <strong>is_float()</strong>
   * <strong>is_int()</strong>
   * <strong>is_numeric()</strong>
   * <strong>is_real()</strong>
   * <strong>is_string()</strong>
   * <strong>is_bool()</strong>
   * <strong>is_object()</strong>
   * <strong>is_array()</strong>


id: is_soap_fault
type: function
doc:
<comment>Description:</comment>
  Проверяет, произошла ли ошибка при вызове SOAP
  
  Эта функция полезна для проверки неудачи вызова SOAP, но тогда, когда не используются исключения.
  Для того, чтобы её использовать, создайте объект <class>SoapClient</class> с опцией <return>exceptions</return>, равной нулю или
  <info>false</info>. В этом случае метод SOAP вернёт специальный объект <class>SoapFault</class>, который инкапсулирует детали
  ошибки (код ошибки, строка ошибки, получатель и детали).
  
  Если опция <return>exceptions</return> не установлена, то вызов SOAP будет выбрасывать исключение в случае
  возникновения ошибки. Функция <strong>is_soap_fault()</strong> проверяет, является ли переданный параметр объектом
  <class>SoapFault</class>.

<comment>Param:</comment>
  <info>mixed</info>  <strong>$object</strong>  Объект для проверки.

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

<comment>See Also:</comment>
   * SoapClient::__construct
   * SoapFault::__construct


id: is_string
type: function
doc:
<comment>Description:</comment>
  Проверяет, является ли переменная строкой
  
  Проверяет, является ли данная переменная строкой.

<comment>Param:</comment>
  <info>mixed</info>  <strong>$value</strong>  Проверяемая переменная.

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

<comment>See Also:</comment>
   * <strong>is_float()</strong>
   * <strong>is_int()</strong>
   * <strong>is_bool()</strong>
   * <strong>is_object()</strong>
   * <strong>is_array()</strong>


id: is_subclass_of
type: function
doc:
<comment>Description:</comment>
  Проверяет, содержит ли объект в своём дереве предков указанный класс либо прямо реализует его
  
  Проверяет, содержит ли объект <strong>$object_or_class</strong> в своём дереве предков класс <strong>$class</strong> либо прямо
  реализует его.

<comment>Param:</comment>
  <info>mixed</info>   <strong>$object_or_class</strong>  Имя класса или экземпляр объекта. В случае отсутствия такого класса
                            никакой ошибки сгенерировано не будет.
  <info>string</info>  <strong>$class</strong>            Имя класса
  <info>bool</info>    <strong>$allow_string</strong>     Если параметр установлен в false, то не допускается имя класса в виде
                            строки в качестве параметра <strong>$object_or_class</strong>. Это также предотвращает
                            вызов автозагрузчика, если класс не существует.

<comment>Return:</comment>
  <info>bool</info>  Эта функция возвращает <info>true</info>, если объект <strong>$object_or_class</strong> принадлежит к классу, наследующему
        от <strong>$class</strong>, иначе она возвращает <info>false</info>.

<comment>See Also:</comment>
   * <strong>get_class()</strong>
   * <strong>get_parent_class()</strong>
   * <strong>is_a()</strong>
   * <strong>class_parents()</strong>


id: is_tainted
type: function
doc:
<comment>Description:</comment>
  Проверяет, испорчена ли строка
  
  Проверяет, является ли строка испорченной

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

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


id: is_uploaded_file
type: function
doc:
<comment>Description:</comment>
  Определяет, был ли файл загружен при помощи HTTP POST
  
  Возвращает <info>true</info>, если файл <strong>$filename</strong> был загружен при помощи HTTP POST. Это полезно для
  удостоверения того, что злонамеренный пользователь не пытается обмануть скрипт так, чтобы он
  работал с файлами, с которыми работать не должен - к примеру, /etc/passwd.
  
  Такие проверки особенно полезны, если существует вероятность того, что операции над файлом могут
  показать его содержимое пользователю или даже другим пользователям той же системы.
  
  Для правильной работы функции <strong>is_uploaded_file()</strong> нужен аргумент вида
  $_FILES['userfile']['tmp_name'], - имя загруженного файла на клиентской машине
  $_FILES['userfile']['name'] не подходит.

<comment>Param:</comment>
  <info>string</info>  <strong>$filename</strong>  Имя проверяемого файла.

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

<comment>See Also:</comment>
   * <strong>move_uploaded_file()</strong>
   * $_FILES
   * Простой пример использования можно найти в разделе
     "Загрузка файлов на сервер".


id: is_writable
type: function
doc:
<comment>Description:</comment>
  Определяет, доступен ли файл для записи
  
  Возвращает <info>true</info>, если файл <strong>$filename</strong> существует и доступен для записи. Аргумент filename может
  быть именем директории, что позволяет вам проверять директории на доступность для записи.
  
  Не забывайте, что PHP может обращаться к файлу от имени того пользователя, от которого запущен
  веб-сервер (обычно 'nobody').

<comment>Param:</comment>
  <info>string</info>  <strong>$filename</strong>  Проверяемый файл.

<comment>Return:</comment>
  <info>bool</info>  Возвращает <info>true</info>, если <strong>$filename</strong> существует и доступен для записи.

<comment>See Also:</comment>
   * <strong>is_readable()</strong>
   * <strong>file_exists()</strong>
   * <strong>fwrite()</strong>


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


id: isset
type: function
doc:
<comment>Description:</comment>
  Определяет, была ли установлена переменная значением, отличным от null
  
  Определяет, была ли установлена переменная значением отличным от <info>null</info>
  
  Если переменная была удалена с помощью <strong>unset()</strong>, то она больше не считается установленной.
  
  <strong>isset()</strong> вернёт <info>false</info> при проверке переменной которая была установлена значением <info>null</info>. Также
  учтите, что NULL-символ (<return>"\0"</return>) не равен константе <info>null</info> в PHP.
  
  Если были переданы несколько параметров, то <strong>isset()</strong> вернёт <info>true</info> только в том случае, если все
  параметры определены. Проверка происходит слева направо и заканчивается, как только будет
  встречена неопределённая переменная.

<comment>Param:</comment>
  <info>mixed</info>  <strong>$var</strong>   Проверяемая переменная.
  <info>mixed</info>  <strong>$vars</strong>  Следующие переменные.

<comment>Return:</comment>
  <info>bool</info>  Возвращает <info>true</info>, если <strong>$var</strong> определена и её значение отлично от <info>null</info>, и <info>false</info> в противном
        случае.

<comment>See Also:</comment>
   * <strong>empty()</strong>
   * __isset()
   * <strong>unset()</strong>
   * <strong>defined()</strong>
   * Таблица сравнения типов
   * <strong>array_key_exists()</strong>
   * <strong>is_null()</strong>
   * Оператор управления ошибками @


id: iterator_apply
type: function
doc:
<comment>Description:</comment>
  Вызывает функцию для каждого элемента в итераторе
  
  Вызывает функцию для каждого элемента в итераторе.

<comment>Param:</comment>
  <info>Traversable</info>  <strong>$iterator</strong>  Объект итератора для перебора.
  <info>callable</info>     <strong>$callback</strong>  Функция обратного вызова, которая применяется к каждому элементу. Эта
                          функция принимает только переданный <strong>$args</strong>, поэтому он null по умолчанию.
                          Например, если <return>count($args) === 3</return>, функция обратного вызова - тернарная.
                          Функция должна возвращать <info>true</info> для того, чтобы продолжать процесс итерации
                          над <strong>$iterator</strong>.
                          
                          Функция должна возвращать <info>true</info> для того, чтобы продолжать процесс итерации
                          над <strong>$iterator</strong>.
  <info>array|null</info>   <strong>$args</strong>      Аргументы для передачи в функцию обратного вызова. Массив (<info>array</info>)
                          аргументов; каждый элемент <strong>$args</strong> передаётся в функцию обратной функции
                          (<strong>$callback</strong>) в виде отдельного аргумента.

<comment>Return:</comment>
  <info>int</info>  Возвращает количество итераций.

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


id: iterator_count
type: function
doc:
<comment>Description:</comment>
  Подсчитывает количество элементов в итераторе
  
  Подсчитывает количество элементов в итераторе. <strong>iterator_count()</strong> не гарантирует сохранение текущей
  позиции <strong>$iterator</strong>.

<comment>Param:</comment>
  <info>Traversable|array</info>  <strong>$iterator</strong>  Итератор, в котором производится подсчёт.

<comment>Return:</comment>
  <info>int</info>  Количество элементов в итераторе (<strong>$iterator</strong>).


id: iterator_to_array
type: function
doc:
<comment>Description:</comment>
  Копирует итератор в массив
  
  Копирует элементы итератора в массив.

<comment>Param:</comment>
  <info>Traversable|array</info>  <strong>$iterator</strong>       Копируемый итератор.
  <info>bool</info>               <strong>$preserve_keys</strong>  Следует ли использовать ключи элементов итератора как индексы.
                                     
                                     Если ключ является массивом (<info>array</info>) или объектом (<info>object</info>), то
                                     бросается предупреждение. Ключи со значением <info>null</info> преобразуются
                                     в пустую строку, ключи в виде чисел с плавающей точкой (<info>float</info>)
                                     обрезаются до их целочисленных (<info>int</info>) частей, ключи с ресурсами
                                     (<info>resource</info>) бросают предупреждение и преобразуются в их
                                     идентификаторы ресурса, а логические (<info>bool</info>) ключи преобразуются
                                     в целые числа.
                                     
                                     Если параметр не задан, либо задан как <info>true</info>, дублирующиеся
                                     ключи будут перезаписаны. Последнее значение с заданным ключом
                                     будет в результирующем массиве. Установите этот параметр равным
                                     <info>false</info> для получения всех значений.

<comment>Return:</comment>
  <info>array</info>  Массив, содержащий элементы <strong>$iterator</strong>.


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

<comment>Param:</comment>
  <info>int</info>  <strong>$julian_day</strong>  День в виде числа в юлианском летоисчислении
  <info>int</info>  <strong>$mode</strong>        

<comment>Return:</comment>
  <info>int|string</info>  День недели по григорианскому календарю в виде строки или числа.


id: jdmonthname
type: function
doc:
<comment>Description:</comment>
  Возвращает название месяца
    
  
  Возвращает строку, содержащую название месяца. <strong>$mode</strong> задаёт режим работы функции преобразования из
  числа дней в юлианском летоисчислении, а также определяет тип возвращаемого значения названия
  месяца. Режимы работыРежимНазвание месяцаЗначения<info>CAL_MONTH_GREGORIAN_SHORT</info> Григорианское -
  сокращённое Jan, Feb, Mar, Apr, May, Jun, Jul, Aug, Sep, Oct, Nov,
  Dec<info>CAL_MONTH_GREGORIAN_LONG</info>ГригорианскоеJanuary, February, March, April, May, June, July, August,
  September, October, November, December<info>CAL_MONTH_JULIAN_SHORT</info> Юлианское - сокращённое Jan, Feb,
  Mar, Apr, May, Jun, Jul, Aug, Sep, Oct, Nov, Dec<info>CAL_MONTH_JULIAN_LONG</info>ЮлианскоеJanuary, February,
  March, April, May, June, July, August, September, October, November,
  December<info>CAL_MONTH_JEWISH</info>ЕврейскоеTishri, Heshvan, Kislev, Tevet, Shevat, Adar, Adar I, Adar II,
  Nisan, Iyyar, Sivan, Tammuz, Av, Elul<info>CAL_MONTH_FRENCH</info> Французское республиканское Vendemiaire,
  Brumaire, Frimaire, Nivose, Pluviose, Ventose, Germinal, Floreal, Prairial, Messidor, Thermidor,
  Fructidor, Extra

<comment>Param:</comment>
  <info></info>     <strong>$jday</strong>  Число дней в юлианском летоисчислении, которое требуется преобразовать
  <info>int</info>  <strong>$mode</strong>  Режим календаря (смотрите таблицу выше)

<comment>Return:</comment>
  <info>string</info>  Название месяца для заданного Юлианского Дня, соответствующее календарю <strong>$mode</strong>.


id: jdtofrench
type: function
doc:
<comment>Description:</comment>
  Переводит число дней в юлианском летоисчислении в дату по
     французскому республиканскому календарю
    
  
  Переводит число дней в юлианском летоисчислении в дату по французскому республиканскому календарю

<comment>Param:</comment>
  <info>int</info>  <strong>$julian_day</strong>  Номер дня в юлианском летоисчислении

<comment>Return:</comment>
  <info>string</info>  Дата со дня французской революции в виде строки формата "месяц/день/год"

<comment>See Also:</comment>
   * <strong>frenchtojd()</strong>
   * <strong>cal_from_jd()</strong>


id: jdtogregorian
type: function
doc:
<comment>Description:</comment>
  Переводит число дней в юлианском летоисчислении в дату по
     Григорианскому календарю
    
  
  Переводит число дней в юлианском летоисчислении в строку, содержащую григорианскую дату в формате
  "месяц/день/год".

<comment>Param:</comment>
  <info>int</info>  <strong>$julian_day</strong>  Номер дня в юлианском летоисчислении в виде целого числа

<comment>Return:</comment>
  <info>string</info>  Дата по григорианскому календарю в виде строки формата "месяц/день/год"

<comment>See Also:</comment>
   * <strong>gregoriantojd()</strong>
   * <strong>cal_from_jd()</strong>


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

<comment>Param:</comment>
  <info>int</info>   <strong>$julian_day</strong>  Номер дня в юлианском летоисчислении в виде целого числа
  <info>bool</info>  <strong>$hebrew</strong>      Если аргумент <strong>$hebrew</strong> установлен в <info>true</info>, дата будет возвращена в виде
                     закодированной строки ISO-8859-8 в еврейском формате, заданном аргументом
                     <strong>$flags</strong>.
  <info>int</info>   <strong>$flags</strong>       Битовая маска может состоять из: <info>CAL_JEWISH_ADD_ALAFIM_GERESH</info>,
                     <info>CAL_JEWISH_ADD_ALAFIM</info> и     <info>CAL_JEWISH_ADD_GERESHAYIM</info>.

<comment>Return:</comment>
  <info>string</info>  Еврейская дата в виде строки формата "месяц/день/год" или закодированная строка ISO-8859-8
          даты на иврите в соответствии с параметром <strong>$hebrew</strong>.

<comment>See Also:</comment>
   * <strong>jewishtojd()</strong>
   * <strong>cal_from_jd()</strong>


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

<comment>Param:</comment>
  <info>int</info>  <strong>$julian_day</strong>  Номер дня в юлианском летоисчислении

<comment>Return:</comment>
  <info>string</info>  Дата по юлианскому календарю в виде строки формата "месяц/день/год"

<comment>See Also:</comment>
   * <strong>juliantojd()</strong>
   * <strong>cal_from_jd()</strong>


id: jdtounix
type: function
doc:
<comment>Description:</comment>
  Переводит число дней в юлианском летоисчислении в метку времени Unix
    
  
  Эта функция вернёт метку времени Unix, соответствующую номеру дня в юлианском летоисчислении,
  заданному в <strong>$julian_day</strong>. Будет возвращено UTC.

<comment>Param:</comment>
  <info>int</info>  <strong>$julian_day</strong>  Номер дня в юлианском летоисчислении между <return>2440588</return> и <return>106751993607888</return> в 64-битных
                    системах или между <return>2440588</return> и <return>2465443</return> в 32-битных системах.

<comment>Return:</comment>
  <info>int</info>  Метка времени Unix на момент начала (полночь) юлианского дня.

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


id: jewishtojd
type: function
doc:
<comment>Description:</comment>
  Переводит дату по еврейскому календарю в число дней в юлианском
     летоисчислении
    
  
  Несмотря на то, что функция может обрабатывать даты вплоть до 1-го года (3761 до н.э.),
  практически преобразование для таких ранних дат не имеет смысла. Еврейский календарь использовался
  несколько тысяч лет, но давние времена не было формулы для расчёта начала месяца. Новый месяц
  начинался с того момента как впервые можно было наблюдать новую луну.

<comment>Param:</comment>
  <info>int</info>  <strong>$month</strong>  Номер месяца в виде числа от 1 до 13, где <return>1</return> означает <return>Тишрей</return>, <return>13</return> означает <return>Элул</return>, и <return>6</return> и
               <return>7</return> означает <return>Адар</return> в обычном году, но <return>Адар I</return> и <return>Адар II</return>, соответственно, в високосном.
  <info>int</info>  <strong>$day</strong>    Номер дня в виде числа от 1 до 30. Если в месяце всего 29 дней, то будет
               подразумеваться первый день следующего месяца.
  <info>int</info>  <strong>$year</strong>   Год в виде числа от 1 до 9999

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

<comment>See Also:</comment>
   * <strong>jdtojewish()</strong>
   * <strong>cal_to_jd()</strong>


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


id: jpeg2wbmp
type: function
doc:
<comment>Description:</comment>
  Конвертирует изображение из формата JPEG в WBMP
  
  Конвертирует JPEG-файл в WBMP.

<comment>Param:</comment>
  <info>string</info>  <strong>$jpegname</strong>     Путь к JPEG-файлу.
  <info>string</info>  <strong>$wbmpname</strong>     Путь для размещения WBMP-файла.
  <info>int</info>     <strong>$dest_height</strong>  Высота WBMP-изображения.
  <info>int</info>     <strong>$dest_width</strong>   Ширина WBMP-изображения.
  <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>png2wbmp()</strong>


id: json_decode
type: function
doc:
<comment>Description:</comment>
  Декодирует строку JSON
  
  Принимает закодированную в JSON строку и преобразует её в PHP-значение.

<comment>Param:</comment>
  <info>string</info>     <strong>$json</strong>         Строка (<info>string</info>) <strong>$json</strong> для декодирования.
                           
                           Функция работает только со строками в кодировке UTF-8.
                           
                           PHP реализует надмножество JSON, который описан в первоначальном RFC
                           7159.
  <info>bool|null</info>  <strong>$associative</strong>  Если <info>true</info>, объекты JSON будут возвращены как ассоциативные массивы
                           (<info>array</info>); если <info>false</info>, объекты JSON будут возвращены как объекты (<info>object</info>).
                           Если <info>null</info>, объекты JSON будут возвращены как ассоциативные массивы
                           (<info>array</info>) или объекты (<info>object</info>) в зависимости от того, установлена ли
                           <info>JSON_OBJECT_AS_ARRAY</info> в <strong>$flags</strong>.
  <info>int</info>        <strong>$depth</strong>        Максимальная глубина вложенности структуры, для которой будет
                           производиться декодирование. Значение должно быть больше <return>0</return> и меньше или
                           равно <return>2147483647</return>.
  <info>int</info>        <strong>$flags</strong>        Битовая маска из констант <info>JSON_BIGINT_AS_STRING</info>,
                           <info>JSON_INVALID_UTF8_IGNORE</info>, <info>JSON_INVALID_UTF8_SUBSTITUTE</info>,
                           <info>JSON_OBJECT_AS_ARRAY</info>, <info>JSON_THROW_ON_ERROR</info>. Поведение этих констант
                           описаны на странице JSON-констант.

<comment>Return:</comment>
  <info>mixed</info>  Возвращает данные <strong>$json</strong>, преобразованные в типы PHP. Не заключённые в кавычки значения
         <return>true</return>, <return>false</return> и <return>null</return> возвращаются как типизированные значения <info>true</info>, <info>false</info> и <info>null</info>. Значение с
         типом <info>null</info> также возвращается в случаях, когда параметр <strong>$json</strong> не может быть преобразован
         или глубина вложенности структуры превышет установленный предел.

<comment>See Also:</comment>
   * <strong>json_encode()</strong>
   * <strong>json_last_error()</strong>


id: json_encode
type: function
doc:
<comment>Description:</comment>
  Возвращает JSON-представление данных
  
  Возвращает строку, содержащую JSON-представление для указанного <strong>$value</strong>. Если параметр является
  массивом (<info>array</info>) или объектом (<info>object</info>), он будет рекурсивно сериализован.
  
  Если сериализуемое значение является объектом, то по умолчанию будут включены только публично
  видимые свойства. В качестве альтернативы класс может реализовать интерфейс JsonSerializable для
  управления тем, как его значения сериализуются в JSON.
  
  На кодирование влияет параметр <strong>$flags</strong> и, кроме того, кодирование значений типа float зависит от
  значения serialize_precision.

<comment>Param:</comment>
  <info>mixed</info>  <strong>$value</strong>  <strong>$value</strong> - значение, которое будет закодировано. Может быть любого типа, кроме
                 resource.
                 
                 Функция работает только с кодировкой UTF-8.
                 
                 PHP реализует надмножество JSON, который описан в первоначальном RFC 7159.
  <info>int</info>    <strong>$flags</strong>  Битовая маска, составляемая из значений <info>JSON_FORCE_OBJECT</info>, <info>JSON_HEX_QUOT</info>,
                 <info>JSON_HEX_TAG</info>, <info>JSON_HEX_AMP</info>, <info>JSON_HEX_APOS</info>, <info>JSON_INVALID_UTF8_IGNORE</info>,
                 <info>JSON_INVALID_UTF8_SUBSTITUTE</info>, <info>JSON_NUMERIC_CHECK</info>, <info>JSON_PARTIAL_OUTPUT_ON_ERROR</info>,
                 <info>JSON_PRESERVE_ZERO_FRACTION</info>, <info>JSON_PRETTY_PRINT</info>, <info>JSON_UNESCAPED_LINE_TERMINATORS</info>,
                 <info>JSON_UNESCAPED_SLASHES</info>, <info>JSON_UNESCAPED_UNICODE</info>, <info>JSON_THROW_ON_ERROR</info>. Смысл этих
                 констант объясняется на странице JSON-констант.
  <info>int</info>    <strong>$depth</strong>  Устанавливает максимальную глубину. Должен быть больше нуля.

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

<comment>See Also:</comment>
   * JsonSerializable
   * <strong>json_decode()</strong>
   * <strong>json_last_error()</strong>
   * <strong>serialize()</strong>


id: json_last_error
type: function
doc:
<comment>Description:</comment>
  Возвращает последнюю ошибку
  
  Возвращает последнюю ошибку (если она есть), произошедшую во время последнего
  кодирования/декодирования JSON если при вызове не использовался флаг <info>JSON_THROW_ON_ERROR</info>.

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

<comment>See Also:</comment>
   * <strong>json_last_error_msg()</strong>
   * <strong>json_decode()</strong>
   * <strong>json_encode()</strong>


id: json_last_error_msg
type: function
doc:
<comment>Description:</comment>
  Возвращает строку с сообщением об ошибке последнего вызова json_encode() или json_decode()
  
  Возвращает текстовое описание последней ошибки, произошедшей при выполнении <strong>json_encode()</strong> или
  <strong>json_decode()</strong> без флага <info>JSON_THROW_ON_ERROR</info>.

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

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


id: json_validate
type: function
doc:
<comment>Description:</comment>
  Проверяет, содержит ли строка допустимый JSON
  
  Возвращает результат проверки соответствия формата входной строки (<info>string</info>) допустимому JSON. Если
  функция <strong>json_validate()</strong> вернёт <info>true</info>, функция <strong>json_decode()</strong> успешно декодирует входную строку при
  использовании тех же параметров <strong>$depth</strong> и <strong>$flags</strong>.
  
  Если функция <strong>json_validate()</strong> вернёт <info>false</info>, причину можно будет установить с помощью функции
  <strong>json_last_error()</strong> и <strong>json_last_error_msg()</strong>.
  
  Функция <strong>json_validate()</strong> использует меньше памяти, чем функция <strong>json_decode()</strong>, поскольку ей не нужно
  декодировать полезную нагрузку JSON или создавать содержащую её структуру массива или объекта.
  
  Вызов функции <strong>json_validate()</strong> непосредственно перед функцией <strong>json_decode()</strong> приведёт к ненужному
  двойному разбору строки, поскольку функция <strong>json_decode()</strong> неявно выполняет такую проверку во время
  декодирования.
  
  Использовать функцию <strong>json_validate()</strong> надо только в случае, когда данные декодирования полезной
  нагрузки JSON не нужно использовать немедленно, и необходимо знать, содержит ли строка допустимый
  JSON.

<comment>Param:</comment>
  <info>string</info>  <strong>$json</strong>   Строка для проверки.
                  
                  Эта функция работает только со строками в кодировке UTF-8.
                  
                  PHP реализует надмножество JSON, который описан в первоначальном RFC 7159.
  <info>int</info>     <strong>$depth</strong>  Максимальная глубина вложенности структуры, для которой будет производиться
                  декодирование. Значение должно быть больше <return>0</return> и меньше или равно <return>2147483647</return>.
  <info>int</info>     <strong>$flags</strong>  В настоящее время принимается только <info>JSON_INVALID_UTF8_IGNORE</info>.

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

<comment>See Also:</comment>
   * <strong>json_decode()</strong>
   * <strong>json_last_error()</strong>
   * <strong>json_last_error_msg()</strong>


id: juliantojd
type: function
doc:
<comment>Description:</comment>
  Переводит дату по юлианскому календарю в число дней в юлианском
     летоисчислении
    
  
  Диапазон возможных дат для юлианского календаря: с 4713 года до н.э. по 9999 год н.э.
  
  Несмотря на то, что функция может обрабатывать даты вплоть до 4713 года до н.э., практически
  преобразование для таких ранних дат не имеет смысла. Календарь был создан в 46 году до н.э., но
  некоторые детали ещё дорабатывались по крайней мере до 8 года н.э., а по некоторым данным до 4
  века. Также, начало года различалось от одной культуры к другой - не везде Январь был первым
  месяцем года.
  
  Помните, что на данный момент общепринятым в мире считается григорианский календарь. Функция
  <strong>gregoriantojd()</strong> может преобразовывать даты по этому календарю в число дней в юлианском
  летоисчислении.

<comment>Param:</comment>
  <info>int</info>  <strong>$month</strong>  Месяц в виде числа от 1 (январь) до 12 (декабрь)
  <info>int</info>  <strong>$day</strong>    День в виде числа от 1 до 31
  <info>int</info>  <strong>$year</strong>   Год в виде числа между -4713 и 9999

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

<comment>See Also:</comment>
   * <strong>jdtojulian()</strong>
   * <strong>cal_to_jd()</strong>


id: key
type: function
doc:
<comment>Description:</comment>
  Выбирает ключ из массива
  
  <strong>key()</strong> возвращает индекс текущего элемента массива.

<comment>Param:</comment>
  <info>array|object</info>  <strong>$array</strong>  Массив.

<comment>Return:</comment>
  <info>int|string|null</info>  Функция <strong>key()</strong> просто возвращает ключ того элемента массива, на который в данный
                   момент указывает внутренний указатель массива. Она не сдвигает указатель ни в
                   каком направлении. Если внутренний указатель указывает вне границ массива или
                   массив пуст, <strong>key()</strong> возвратит <info>null</info>.

<comment>See Also:</comment>
   * <strong>current()</strong>
   * <strong>next()</strong>
   * <strong>array_key_first()</strong>
   * foreach


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


id: krsort
type: function
doc:
<comment>Description:</comment>
  Сортирует массив по ключу в порядке убывания
  
  Сортирует <strong>$array</strong> по ключу в порядке убывания.
  
  Если оба сравниваемых значения эквивалентны, они сохраняют свой первоначальный порядок.
  До PHP 8.0.0 их относительный порядок в отсортированном массиве не был определён.
  
  Сбрасывает внутренний указатель массива на первый элемент.

<comment>Param:</comment>
  <info>array</info>  <strong>$array</strong>  Входной массив.
  <info>int</info>    <strong>$flags</strong>  Необязательный второй параметр <strong>$flags</strong> изменяет поведение сортировки и может
                 принимать следующие значения:
                 
                 Флаги типа сортировки: <info>SORT_REGULAR</info> — обычное сравнение элементов; подробности
                 описаны в разделе операторы сравнения<info>SORT_NUMERIC</info> — числовое сравнение
                 элементов<info>SORT_STRING</info> — строковое сравнение элементов<info>SORT_LOCALE_STRING</info> — сравнение
                 элементов как строки на основе текущего языкового стандарта. Используется языковой
                 стандарт, который можно изменить с помощью <strong>setlocale()</strong> <info>SORT_NATURAL</info> — сравнение
                 элементов как строки, используя "естественный порядок", например <strong>natsort()</strong>
                 <info>SORT_FLAG_CASE</info> — можно объединять (побитовое ИЛИ) с <info>SORT_STRING</info> или <info>SORT_NATURAL</info>
                 для сортировки строк без учёта регистра
                 
                 <info>SORT_REGULAR</info> — обычное сравнение элементов; подробности описаны в разделе операторы
                 сравнения
                 
                 <info>SORT_NUMERIC</info> — числовое сравнение элементов
                 
                 <info>SORT_STRING</info> — строковое сравнение элементов
                 
                 <info>SORT_LOCALE_STRING</info> — сравнение элементов как строки на основе текущего языкового
                 стандарта. Используется языковой стандарт, который можно изменить с помощью
                 <strong>setlocale()</strong>
                 
                 <info>SORT_NATURAL</info> — сравнение элементов как строки, используя "естественный порядок",
                 например <strong>natsort()</strong>
                 
                 <info>SORT_FLAG_CASE</info> — можно объединять (побитовое ИЛИ) с <info>SORT_STRING</info> или <info>SORT_NATURAL</info>
                 для сортировки строк без учёта регистра

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

<comment>See Also:</comment>
   * <strong>sort()</strong>
   * <strong>ksort()</strong>
   * Сравнение функций сортировки массивов


id: ksort
type: function
doc:
<comment>Description:</comment>
  Сортирует массив по ключу в порядке возрастания
  
  Сортирует <strong>$array</strong> по ключу в порядке возрастания.
  
  Если оба сравниваемых значения эквивалентны, они сохраняют свой первоначальный порядок.
  До PHP 8.0.0 их относительный порядок в отсортированном массиве не был определён.
  
  Сбрасывает внутренний указатель массива на первый элемент.

<comment>Param:</comment>
  <info>array</info>  <strong>$array</strong>  Входной массив.
  <info>int</info>    <strong>$flags</strong>  Необязательный второй параметр <strong>$flags</strong> изменяет поведение сортировки и может
                 принимать следующие значения:
                 
                 Флаги типа сортировки: <info>SORT_REGULAR</info> — обычное сравнение элементов; подробности
                 описаны в разделе операторы сравнения<info>SORT_NUMERIC</info> — числовое сравнение
                 элементов<info>SORT_STRING</info> — строковое сравнение элементов<info>SORT_LOCALE_STRING</info> — сравнение
                 элементов как строки на основе текущего языкового стандарта. Используется языковой
                 стандарт, который можно изменить с помощью <strong>setlocale()</strong> <info>SORT_NATURAL</info> — сравнение
                 элементов как строки, используя "естественный порядок", например <strong>natsort()</strong>
                 <info>SORT_FLAG_CASE</info> — можно объединять (побитовое ИЛИ) с <info>SORT_STRING</info> или <info>SORT_NATURAL</info>
                 для сортировки строк без учёта регистра
                 
                 <info>SORT_REGULAR</info> — обычное сравнение элементов; подробности описаны в разделе операторы
                 сравнения
                 
                 <info>SORT_NUMERIC</info> — числовое сравнение элементов
                 
                 <info>SORT_STRING</info> — строковое сравнение элементов
                 
                 <info>SORT_LOCALE_STRING</info> — сравнение элементов как строки на основе текущего языкового
                 стандарта. Используется языковой стандарт, который можно изменить с помощью
                 <strong>setlocale()</strong>
                 
                 <info>SORT_NATURAL</info> — сравнение элементов как строки, используя "естественный порядок",
                 например <strong>natsort()</strong>
                 
                 <info>SORT_FLAG_CASE</info> — можно объединять (побитовое ИЛИ) с <info>SORT_STRING</info> или <info>SORT_NATURAL</info>
                 для сортировки строк без учёта регистра

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

<comment>See Also:</comment>
   * <strong>sort()</strong>
   * <strong>krsort()</strong>
   * Сравнение функций сортировки массивов


id: lcfirst
type: function
doc:
<comment>Description:</comment>
  Преобразует первый символ строки в нижний регистр
  
  Возвращает строку <strong>$string</strong>, первый символ которой был преобразован в нижний регистр, если этот
  символ является ASCII-символом в диапазоне от <return>"A"</return> (0x41) до <return>"Z"</return> (0x5a).

<comment>Param:</comment>
  <info>string</info>  <strong>$string</strong>  Входная строка.

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

<comment>See Also:</comment>
   * <strong>ucfirst()</strong>
   * <strong>strtolower()</strong>
   * <strong>strtoupper()</strong>
   * <strong>ucwords()</strong>


id: lcg_value
type: function
doc:
<comment>Description:</comment>
  Генерирует псевдослучайное число, применяя комбинированный линейный конгруэнтный метод
  
  Функция <strong>lcg_value()</strong> возвращает псевдослучайное значение в диапазоне (0, 1). Функция комбинирует
  два конгруэнтных генератора с периодами 2^31 - 85 и 2^31 - 249. Период этой функции равен
  произведению обоих простых чисел.
  
  Функция не создаёт криптографически защищённые значения и не должна использоваться для
  криптографических целей или целей, требующих, чтобы возвращаемые значения были недоступны для
  разгадывания.
  
  Если нужна криптографически безопасная случайная последовательность, можно использовать класс
  <class>Random\Randomizer</class> с движком <class>Random\Engine\Secure</class>. Для простых сценариев существуют функции
  <strong>random_int()</strong> и <strong>random_bytes()</strong> с удобным API криптографически безопасного генератора
  псевдослучайных чисел (CSPRNG), поддерживаемого операционной системой.
  
  Масштабирование возвращаемого значения для разных интервалов путём умножения или сложения
  (аффинного преобразования) может сместить результирующее значение, так как числа с плавающей
  точкой не одинаково плотные по всему ряду чисел. Поскольку не все значения можно точно представить
  числом с плавающей точкой, результат афинного преобразования также может вернуть значения,
  выходящие за пределы запрошенного интервала.
  
  Чтобы сгенерировать случайное число с плавающей точкой в пределах произвольного интервала,
  вызывают метод Random\Randomizer::getFloat. Для генерации случайного целого числа в пределах
  произвольного интервала вызывают метод Random\Randomizer::getInt.

<comment>Return:</comment>
  <info>float</info>  Возвращает псевдослучайное число с плавающей точкой в диапазоне от 0.0 до 1.0 включительно.

<comment>See Also:</comment>
   * Random\Randomizer::getFloat
   * Random\Randomizer::getInt
   * <strong>random_int()</strong>


id: lchgrp
type: function
doc:
<comment>Description:</comment>
  Изменяет группу, которой принадлежит символическая ссылка
  
  Пытается изменить группу, которой принадлежит символическая ссылка <strong>$filename</strong> на указанную в
  <strong>$group</strong>.
  
  Только суперпользователь может изменять группу символической ссылки произвольно, другие
  пользователи могут изменять группу символической ссылки на какую-либо, в которой пользователь
  является членом.

<comment>Param:</comment>
  <info>string</info>      <strong>$filename</strong>  Путь к ссылке.
  <info>string|int</info>  <strong>$group</strong>     Группа, указанная по имени или номеру.

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

<comment>See Also:</comment>
   * <strong>chgrp()</strong>
   * <strong>lchown()</strong>
   * <strong>chown()</strong>
   * <strong>chmod()</strong>


id: lchown
type: function
doc:
<comment>Description:</comment>
  Изменяет владельца символической ссылки
  
  Пытается изменить владельца символической ссылки <strong>$filename</strong> на указанного в <strong>$user</strong> пользователя.
  
  Только суперпользователь может изменять владельца символической ссылки.

<comment>Param:</comment>
  <info>string</info>      <strong>$filename</strong>  Путь к файлу.
  <info>string|int</info>  <strong>$user</strong>      Имя пользователя или номер.

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

<comment>See Also:</comment>
   * <strong>chown()</strong>
   * <strong>lchgrp()</strong>
   * <strong>chgrp()</strong>
   * <strong>chmod()</strong>


id: ldap_8859_to_t61
type: function
doc:
<comment>Description:</comment>
  Переводит символы из кодировки ISO-8859 в t61
  
  Переводит символы из кодировки <return>ISO-8859</return> в <return>t61</return>.
  
  Эта функция полезна, если необходимо работать с устаревшим сервером <return>LDAPv2</return>.

<comment>Param:</comment>
  <info>string</info>  <strong>$value</strong>  Текст, которые должен быть переведён.

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

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


id: ldap_add
type: function
doc:
<comment>Description:</comment>
  Добавить запись в LDAP директорию
  
  Добавляет запись в LDAP-директорию.

<comment>Param:</comment>
  <info>LDAP\Connection</info>  <strong>$ldap</strong>      Экземпляр <class>LDAP\Connection</class>, возвращаемый функцией <strong>ldap_connect()</strong>.
  <info>string</info>           <strong>$dn</strong>        Отличительное имя LDAP-объекта.
  <info>array</info>            <strong>$entry</strong>     Массив, который определяет информацию о записи. Значения в записи
                              индексируются индивидуальными атрибутами. В случае множественных
                              значений для атрибута, они индексируются с использованием целых чисел,
                              начиная с 0.
                              ]]>
  <info>array|null</info>       <strong>$controls</strong>  Массив управляющих констант LDAP для отправки в запросе.

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

<comment>See Also:</comment>
   * <strong>ldap_add_ext()</strong>
   * <strong>ldap_delete()</strong>


id: ldap_add_ext
type: function
doc:
<comment>Description:</comment>
  Добавить записи в каталог LDAP
  
  Делает то же самое, что и <strong>ldap_add()</strong>, но возвращает экземпляр <class>LDAP\Result</class> для разбора с помощью
  <strong>ldap_parse_result()</strong>.

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

<comment>See Also:</comment>
   * <strong>ldap_add()</strong>
   * <strong>ldap_parse_result()</strong>


id: ldap_bind
type: function
doc:
<comment>Description:</comment>
  Привязать к LDAP директории
  
  Связывает LDAP-директорию с указанным RDN и паролем.

<comment>Param:</comment>
  <info>LDAP\Connection</info>  <strong>$ldap</strong>      Экземпляр <class>LDAP\Connection</class>, возвращаемый функцией <strong>ldap_connect()</strong>.
  <info>string|null</info>      <strong>$dn</strong>        
  <info>string|null</info>      <strong>$password</strong>  

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

<comment>See Also:</comment>
   * <strong>ldap_bind_ext()</strong>
   * <strong>ldap_unbind()</strong>


id: ldap_bind_ext
type: function
doc:
<comment>Description:</comment>
  Привязать к директории LDAP
  
  Делает то же самое, что и <strong>ldap_bind()</strong>, но возвращает экземпляр <class>LDAP\Result</class> для разбора с помощью
  <strong>ldap_parse_result()</strong>.

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

<comment>See Also:</comment>
   * <strong>ldap_bind()</strong>
   * <strong>ldap_parse_result()</strong>


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


id: ldap_compare
type: function
doc:
<comment>Description:</comment>
  Сравнить значение атрибута, найденного в записи определённой DN
  
  Сравнивает значение (<strong>$value</strong>) атрибута (<strong>$attribute</strong>) со значением того же атрибута в записи
  LDAP-директории.

<comment>Param:</comment>
  <info>LDAP\Connection</info>  <strong>$ldap</strong>       Экземпляр <class>LDAP\Connection</class>, возвращаемый функцией <strong>ldap_connect()</strong>.
  <info>string</info>           <strong>$dn</strong>         Отличительное имя LDAP-объекта.
  <info>string</info>           <strong>$attribute</strong>  Имя атрибута.
  <info>string</info>           <strong>$value</strong>      Сравниваемое значение.
  <info>array|null</info>       <strong>$controls</strong>   Массив управляющих констант LDAP для отправки в запросе.

<comment>Return:</comment>
  <info>bool|int</info>  Возвращает <info>true</info> если <strong>$value</strong> совпадают в противном случае <info>false</info>. Возвращает -1 в случае
            возникновения ошибки.


id: ldap_connect
type: function
doc:
<comment>Description:</comment>
  Подключиться  к серверу LDAP
  
  Следующий синтаксис всё ещё поддерживается для обеспечения обратной совместимости (кроме
  использования именованных аргументов), но он объявлен устаревшим и больше не должен
  использоваться!
  
  Создаёт <class>LDAP\Connection</class> и проверяет правдоподобность заданного <strong>$uri</strong>.
  
  Эта функция НЕ открывает соединение. Она проверяет, правдоподобны ли заданные параметры и могут ли
  они использоваться для подключения, когда в нем возникнет нужна.

<comment>Param:</comment>
  <info>string|null</info>  <strong>$host</strong>  Полный LDAP URI вида <return>ldap://hostname:port</return> или <return>ldaps://hostname:port</return>.
                      
                      Также вы можете указать несколько LDAP-URI, разделённых пробелом.
                      
                      Обратите внимание, что <return>hostname:port</return> - это неподдерживаемый LDAP URI, так как
                      отсутствует схема.
  <info>string|null</info>  <strong>$uri</strong>   Имя сервера для соединения.
  <info>int</info>          <strong>$port</strong>  Порт для соединения.

<comment>Return:</comment>
  <info>LDAP\Connection|false</info>  Возвращает экземпляр <class>LDAP\Connection</class>, если LDAP URI правдоподобен. Она
                         производит синтаксический разбор и проверку переданных параметров, но
                         соединения с сервером не происходит. Если проверка синтаксиса провалилась -
                         возвращается <info>false</info>. <strong>ldap_connect()</strong> будет всегда возвращать экземпляр
                         <class>LDAP\Connection</class>, поскольку она фактически не соединяется, а только
                         инициализирует параметры соединения. Фактическое подключение происходит при
                         последующих вызовах ldap_* функций, обычно при вызове <strong>ldap_bind()</strong>.
                         
                         Если никакие параметры не будут определены, тогда будет возвращён экземпляр
                         <class>LDAP\Connection</class> открытого соединения.

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


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

<comment>Param:</comment>
  <info>string|null</info>  <strong>$uri</strong>        
  <info>string</info>       <strong>$wallet</strong>     
  <info>string</info>       <strong>$password</strong>   
  <info>int</info>          <strong>$auth_mode</strong>  

<comment>Return:</comment>
  <info>LDAP\Connection|false</info>  

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


id: ldap_control_paged_result
type: function
doc:
<comment>Description:</comment>
  Послать серверу LDAP данные для использования постраничного извлечения результата
  
  Разрешает работу с LDAP в постраничном режиме, путём отправки желаемых настроек (размер страницы,
  куки и т.д.)

<comment>Param:</comment>
  <info>resource</info>  <strong>$link</strong>        Ресурс LDAP, возвращаемый функцией <strong>ldap_connect()</strong>.
  <info>int</info>       <strong>$pagesize</strong>    Количество записей на страницу.
  <info>bool</info>      <strong>$iscritical</strong>  Определяет, является ли постраничный режим критичным или нет. Если <info>true</info> и
                         если сервер не поддерживает постраничную работу, поиск вернёт пустой
                         результат.
  <info>string</info>    <strong>$cookie</strong>      Непрозрачная структура, посылаемая сервером
                         (<strong>ldap_control_paged_result_response()</strong>).

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

<comment>See Also:</comment>
   * <strong>ldap_control_paged_result_response()</strong>
   * RFC2696 : Управляющий модуль LDAP для простых
     манипуляций постранично возвращаемым результатом


id: ldap_control_paged_result_response
type: function
doc:
<comment>Description:</comment>
  Получить указатель на текущую страницу результирующего набора LDAP
  
  Получить указатель на текущую страницу результирующего набора LDAP.

<comment>Param:</comment>
  <info>resource</info>  <strong>$link</strong>       Ресурс LDAP, возвращаемый функцией <strong>ldap_connect()</strong>.
  <info>resource</info>  <strong>$result</strong>     
  <info>string</info>    <strong>$cookie</strong>     Непрозрачная структура полученная с сервера.
  <info>int</info>       <strong>$estimated</strong>  Предполагаемое количество записей для извлечения.

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

<comment>See Also:</comment>
   * <strong>ldap_control_paged_result()</strong>
   * RFC2696 : Управляющий модуль LDAP для простых
     манипуляций постранично возвращаемым результатом


id: ldap_count_entries
type: function
doc:
<comment>Description:</comment>
  Посчитать число записей в результатах поиска
  
  Возвращает число записей, сохранённых в результате предыдущей операции поиска.

<comment>Param:</comment>
  <info>LDAP\Connection</info>  <strong>$ldap</strong>    Экземпляр <class>LDAP\Connection</class>, возвращаемый функцией <strong>ldap_connect()</strong>.
  <info>LDAP\Result</info>      <strong>$result</strong>  Экземпляр <class>LDAP\Result</class>, возвращаемый <strong>ldap_list()</strong> или <strong>ldap_search()</strong>.

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


id: ldap_count_references
type: function
doc:
<comment>Description:</comment>
  Подсчитывает количество ссылок в результатах поиска
  
  Подсчитывает количество ссылок в результатах поиска.

<comment>Param:</comment>
  <info>LDAP\Connection</info>  <strong>$ldap</strong>    Экземпляр <class>LDAP\Connection</class>, возвращаемый функцией <strong>ldap_connect()</strong>.
  <info>LDAP\Result</info>      <strong>$result</strong>  Экземпляр <class>LDAP\Result</class>, возвращаемый <strong>ldap_list()</strong> или <strong>ldap_search()</strong>.

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

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


id: ldap_delete
type: function
doc:
<comment>Description:</comment>
  Удаляет запись из директории LDAP
  
  Удаление конкретной записи из директории LDAP.

<comment>Param:</comment>
  <info>LDAP\Connection</info>  <strong>$ldap</strong>      Экземпляр <class>LDAP\Connection</class>, возвращаемый функцией <strong>ldap_connect()</strong>.
  <info>string</info>           <strong>$dn</strong>        Уникальное имя LDAP-записи.
  <info>array|null</info>       <strong>$controls</strong>  Массив управляющих констант LDAP для отправки в запросе.

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

<comment>See Also:</comment>
   * <strong>ldap_delete_ext()</strong>
   * <strong>ldap_add()</strong>


id: ldap_delete_ext
type: function
doc:
<comment>Description:</comment>
  Удалить запись из директории
  
  Делает то же самое, что и <strong>ldap_delete()</strong>, но возвращает экземпляр <class>LDAP\Result</class> для разбора с помощью
  <strong>ldap_parse_result()</strong>.

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

<comment>See Also:</comment>
   * <strong>ldap_delete()</strong>
   * <strong>ldap_parse_result()</strong>


id: ldap_dn2ufn
type: function
doc:
<comment>Description:</comment>
  Преобразовать DN в удобный для пользователя формат именования
  
  Переключает указанный <strong>$dn</strong> в более удобную для пользователя форму, снимая изоляцию с имён типов.

<comment>Param:</comment>
  <info>string</info>  <strong>$dn</strong>  Отличительное имя объекта LDAP.

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


id: ldap_err2str
type: function
doc:
<comment>Description:</comment>
  Преобразовать код ошибки LDAP в строковое сообщение об ошибке
  
  Возвращает строковое сообщение об ошибке, объясняющее код ошибки <strong>$errno</strong>. В то время как LDAP числа
  errno стандартизированы, различные библиотеки возвращают отличающиеся или даже локализованные
  текстовые сообщения об ошибках. Никогда не проверяйте на определённый текст сообщения об ошибке,
  всегда пользуйтесь кодами ошибок для проверки.

<comment>Param:</comment>
  <info>int</info>  <strong>$errno</strong>  Номер ошибки.

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

<comment>See Also:</comment>
   * <strong>ldap_errno()</strong>
   * <strong>ldap_error()</strong>


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

<comment>Param:</comment>
  <info>LDAP\Connection</info>  <strong>$ldap</strong>  Экземпляр <class>LDAP\Connection</class>, возвращаемый функцией <strong>ldap_connect()</strong>.

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

<comment>See Also:</comment>
   * <strong>ldap_err2str()</strong>
   * <strong>ldap_error()</strong>


id: ldap_error
type: function
doc:
<comment>Description:</comment>
  Возвратить сообщение об ошибке LDAP последней команды
  
  Возвращает строковое сообщение об ошибке, объясняя ошибку, сгенерированную последней командой LDAP
  для данного идентификатора соединения <strong>$ldap</strong>. В то время как LDAP errno числа стандартизированы,
  различные библиотеки возвращают отличающийся или даже локализованные текстовые сообщения об
  ошибках. Никогда не проверяйте на определённый текст сообщения об ошибке, всегда используйте
  кодами ошибок для проверки.
  
  Если вы не снизите достаточно уровень предупреждений в php.ini, или префикс ваших LDAP-команд не
  будет с символом @ для подавления вывода предупреждений, генерируемые ошибки будут также
  отображаться в вашем HTML выводе.

<comment>Param:</comment>
  <info>LDAP\Connection</info>  <strong>$ldap</strong>  Экземпляр <class>LDAP\Connection</class>, возвращаемый функцией <strong>ldap_connect()</strong>.

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

<comment>See Also:</comment>
   * <strong>ldap_err2str()</strong>
   * <strong>ldap_errno()</strong>


id: ldap_escape
type: function
doc:
<comment>Description:</comment>
  Экранирование строки для использования в фильтре LDAP или в DN
  
  Экранирует <strong>$value</strong> для использования в контексте заданном в <strong>$flags</strong>.

<comment>Param:</comment>
  <info>string</info>  <strong>$value</strong>   Значение для экранирования.
  <info>string</info>  <strong>$ignore</strong>  Символы, которые необходимо игнорировать при экранировании.
  <info>int</info>     <strong>$flags</strong>   Контекст, для которого экранируется строка: <info>LDAP_ESCAPE_FILTER</info> для фильтров,
                   используемых в <strong>ldap_search()</strong> или <info>LDAP_ESCAPE_DN</info> для DN. Если не переданы никакие
                   флаги, то все символы будут экранированы.

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


id: ldap_exop
type: function
doc:
<comment>Description:</comment>
  Выполняет расширенную операцию
  
  Выполняет расширенную операцию для заданного соединения <strong>$ldap</strong> с OID операции <strong>$request_oid</strong> и
  данными <strong>$request_data</strong>.

<comment>Param:</comment>
  <info>LDAP\Connection</info>  <strong>$ldap</strong>           Экземпляр <class>LDAP\Connection</class>, возвращаемый функцией <strong>ldap_connect()</strong>.
  <info>string</info>           <strong>$request_oid</strong>    Идентификатор расширенной операции OID. Можно использовать одну
                                   из констант <info>LDAP_EXOP_START_TLS</info>, <info>LDAP_EXOP_MODIFY_PASSWD</info>,
                                   <info>LDAP_EXOP_REFRESH</info>, <info>LDAP_EXOP_WHO_AM_I</info>, <info>LDAP_EXOP_TURN</info> или строку
                                   с OID необходимой операции.
  <info>string</info>           <strong>$request_data</strong>   Данные для запроса расширенной операции. Может быть <info>null</info> для
                                   операций типа <info>LDAP_EXOP_WHO_AM_I</info>. Может потребоваться
                                   закодировать BER.
  <info>array</info>            <strong>$controls</strong>       Массив управляющих констант LDAP для посылки в запросе.
  <info>string</info>           <strong>$response_data</strong>  Если задано, то будет заполнено данными, полученными в результате
                                   выполнения операции. Если не задано, то для получения данных
                                   можно использовать ldap_parse_exop для полученного объекта.
  <info></info>                 <strong>$retoid</strong>         Если задано, то будет заполнено OID ответа. Обычно совпадает с
                                   OID запроса.

<comment>Return:</comment>
  <info>mixed</info>  Если используется с <strong>$response_data</strong>, то возвращает <info>true</info> или <info>false</info>. Если используется без
         <strong>$response_data</strong>, то возвращает идентификатор ресурса или <info>false</info>.

<comment>See Also:</comment>
   * <strong>ldap_parse_result()</strong>
   * <strong>ldap_parse_exop()</strong>
   * <strong>ldap_exop_whoami()</strong>
   * <strong>ldap_exop_refresh()</strong>
   * <strong>ldap_exop_passwd()</strong>


id: ldap_exop_passwd
type: function
doc:
<comment>Description:</comment>
  Обёртка для расширенной операции PASSWD
  
  Выполняет расширенную операцию PASSWD.

<comment>Param:</comment>
  <info>LDAP\Connection</info>  <strong>$ldap</strong>          Экземпляр <class>LDAP\Connection</class>, возвращаемый функцией <strong>ldap_connect()</strong>.
  <info>string</info>           <strong>$user</strong>          Уникальное имя (DN) пользователя, для которого меняется пароль.
  <info>string</info>           <strong>$old_password</strong>  Старый пароль. В зависимости от конфигурации может быть опущен.
  <info>string</info>           <strong>$new_password</strong>  Новый пароль. Может быть опущен, либо задан пустым для
                                  автогенерации пароля.
  <info>array</info>            <strong>$controls</strong>      Если задано, то с запросом будет передан запрос парольной политики
                                  и это поле будет заполнено массивом управляющих констант LDAP,
                                  возвращённым запросом.

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

<comment>See Also:</comment>
   * <strong>ldap_exop()</strong>
   * <strong>ldap_parse_exop()</strong>


id: ldap_exop_refresh
type: function
doc:
<comment>Description:</comment>
  Обёртка для расширенной операции Refresh
  
  Выполняет расширенную операцию Performs и возвращает результат.

<comment>Param:</comment>
  <info>LDAP\Connection</info>  <strong>$ldap</strong>  Экземпляр <class>LDAP\Connection</class>, возвращаемый функцией <strong>ldap_connect()</strong>.
  <info>string</info>           <strong>$dn</strong>    Уникальное имя (DN) записи для которой выполняется операция.
  <info>int</info>              <strong>$ttl</strong>   Время в секундах (от 1 до 31557600) существования записи в каталоге,
                          запрошенное клиентом. По истечении этого времени она будет автоматически
                          удалена.

<comment>Return:</comment>
  <info>int|false</info>  Из RFC: Поле responseTtl содержит время в секундах считаемое сервером временем жизни
             записи. Оно не может быть меньше запрошенного клиентом, но может быть больше. Однако,
             чтобы позволить серверам поддерживать каталог в относительно консистентном состоянии и
             для предотвращения злоупотребления клиентами постоянным продлением, серверу дозволено
             уменьшать запрошенное клиентом значение до, но не меньше чем, 86400 секунд (один день).
              В случае возникновения ошибки вернёт <info>false</info>.

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


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

<comment>Param:</comment>
  <info>LDAP\Connection</info>  <strong>$ldap</strong>           Экземпляр <class>LDAP\Connection</class>, возвращаемый функцией <strong>ldap_connect()</strong>.
  <info>string</info>           <strong>$request_oid</strong>    
  <info>string</info>           <strong>$request_data</strong>   
  <info>array</info>            <strong>$controls</strong>       
  <info>string</info>           <strong>$response_data</strong>  
  <info>string</info>           <strong>$response_oid</strong>   

<comment>Return:</comment>
  <info>LDAP\Result|bool</info>  

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


id: ldap_exop_whoami
type: function
doc:
<comment>Description:</comment>
  Обёртка для расширенной операции WHOAMI
  
  Выполняет расширенную операцию WHOAMI и возвращает данные.

<comment>Param:</comment>
  <info>LDAP\Connection</info>  <strong>$ldap</strong>  Экземпляр <class>LDAP\Connection</class>, возвращаемый функцией <strong>ldap_connect()</strong>.

<comment>Return:</comment>
  <info>string|false</info>  Данные, возвращённые сервером, либо <info>false</info>.

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


id: ldap_explode_dn
type: function
doc:
<comment>Description:</comment>
  Разделить DN на его составные части
  
  Разделяет DN, возвращённый функцией <strong>ldap_get_dn()</strong>, и разбивает его на составные части. Каждая
  часть известна как относительное отличительное имя или RDN.

<comment>Param:</comment>
  <info>string</info>  <strong>$dn</strong>           Отличительное имя объекта LDAP.
  <info>int</info>     <strong>$with_attrib</strong>  Используется для запроса, если RDNs возвращены только со значениями или
                        также с их атрибутами. Для получения RDNs с атрибутами (то есть в формате
                        attribute=value) установите параметр <strong>$with_attrib</strong> в 0 и для получения только
                        значений установите его в 1.

<comment>Return:</comment>
  <info>array|false</info>  Возвращает массив всех компонентов DN или <info>false</info> в случае возникновения ошибки. У
               первого элемента в этом массиве есть ключ <return>count</return>, и он представляет собой число
               возвращённых значений. Следующие элементы - это компоненты DN с цифровыми индексами.


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

<comment>Param:</comment>
  <info>LDAP\Connection</info>   <strong>$ldap</strong>   Экземпляр <class>LDAP\Connection</class>, возвращаемый функцией <strong>ldap_connect()</strong>.
  <info>LDAP\ResultEntry</info>  <strong>$entry</strong>  Экземпляр <class>LDAP\ResultEntry</class>.

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

<comment>See Also:</comment>
   * <strong>ldap_next_attribute()</strong>
   * <strong>ldap_get_attributes()</strong>


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

<comment>Param:</comment>
  <info>LDAP\Connection</info>  <strong>$ldap</strong>    Экземпляр <class>LDAP\Connection</class>, возвращаемый функцией <strong>ldap_connect()</strong>.
  <info>LDAP\Result</info>      <strong>$result</strong>  Экземпляр <class>LDAP\Result</class>, возвращаемый <strong>ldap_list()</strong> или <strong>ldap_search()</strong>.

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

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


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

<comment>Return:</comment>
  <info>LDAP\ResultEntry|false</info>  


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

<comment>Param:</comment>
  <info>LDAP\Result</info>  <strong>$result</strong>  Экземпляр <class>LDAP\Result</class>, возвращаемый <strong>ldap_list()</strong> или <strong>ldap_search()</strong>.

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


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

<comment>Param:</comment>
  <info>LDAP\Connection</info>   <strong>$ldap</strong>   Экземпляр <class>LDAP\Connection</class>, возвращаемый функцией <strong>ldap_connect()</strong>.
  <info>LDAP\ResultEntry</info>  <strong>$entry</strong>  Экземпляр <class>LDAP\ResultEntry</class>.

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

<comment>See Also:</comment>
   * <strong>ldap_first_attribute()</strong>
   * <strong>ldap_next_attribute()</strong>


id: ldap_get_dn
type: function
doc:
<comment>Description:</comment>
  Получить DN результирующей записи
  
  Обнаружить DN записи в результате.

<comment>Param:</comment>
  <info>LDAP\Connection</info>   <strong>$ldap</strong>   Экземпляр <class>LDAP\Connection</class>, возвращаемый функцией <strong>ldap_connect()</strong>.
  <info>LDAP\ResultEntry</info>  <strong>$entry</strong>  Экземпляр <class>LDAP\ResultEntry</class>.

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


id: ldap_get_entries
type: function
doc:
<comment>Description:</comment>
  Получает все записи результата
  
  Читает множественные записи из заданного результата, и затем читает атрибуты и множественные
  значения.

<comment>Param:</comment>
  <info>LDAP\Connection</info>  <strong>$ldap</strong>    Экземпляр <class>LDAP\Connection</class>, возвращаемый функцией <strong>ldap_connect()</strong>.
  <info>LDAP\Result</info>      <strong>$result</strong>  Экземпляр <class>LDAP\Result</class>, возвращаемый <strong>ldap_list()</strong> или <strong>ldap_search()</strong>.

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

<comment>See Also:</comment>
   * <strong>ldap_first_entry()</strong>
   * <strong>ldap_next_entry()</strong>


id: ldap_get_option
type: function
doc:
<comment>Description:</comment>
  Получить текущее значение данной опции
  
  Устанавливает <strong>$value</strong> в значение указанной опции.

<comment>Param:</comment>
  <info>LDAP\Connection</info>   <strong>$ldap</strong>    Экземпляр <class>LDAP\Connection</class>, возвращаемый функцией <strong>ldap_connect()</strong>.
  <info>int</info>               <strong>$option</strong>  Опция <strong>$option</strong> может быть одной из: ОпцияТипНачиная с
                             версии<info>LDAP_OPT_DEREF</info><info>int</info><info>LDAP_OPT_SIZELIMIT</info><info>int</info><info>LDAP_OPT_TIMELIMIT</info><info>int</info><info>LDAP_OPT_NETWORK_TIMEOUT</info><info>int</info><info>LDAP_OPT_PROTOCOL_VERSION</info><info>int</info><info>LDAP_OPT_ERROR_NUMBER</info><info>int</info><info>LDAP_OPT_DIAGNOSTIC_MESSAGE</info><info>string</info><info>LDAP_OPT_REFERRALS</info><info>int</info><info>LDAP_OPT_RESTART</info><info>int</info><info>LDAP_OPT_HOST_NAME</info><info>string</info><info>LDAP_OPT_ERROR_STRING</info><info>string</info><info>LDAP_OPT_MATCHED_DN</info><info>string</info><info>LDAP_OPT_SERVER_CONTROLS</info><info>array</info><info>LDAP_OPT_CLIENT_CONTROLS</info><info>array</info><info>LDAP_OPT_X_KEEPALIVE_IDLE</info><info>int</info>7.1<info>LDAP_OPT_X_KEEPALIVE_PROBES</info><info>int</info>7.1<info>LDAP_OPT_X_KEEPALIVE_INTERVAL</info><info>int</info>7.1<info>LDAP_OPT_X_TLS_CACERTDIR</info><info>string</info>7.1<info>LDAP_OPT_X_TLS_CACERTFILE</info><info>string</info>7.1<info>LDAP_OPT_X_TLS_CERTFILE</info><info>string</info>7.1<info>LDAP_OPT_X_TLS_CIPHER_SUITE</info><info>string</info>7.1<info>LDAP_OPT_X_TLS_CRLCHECK</info><info>int</info>7.1<info>LDAP_OPT_X_TLS_CRL_NONE</info><info>int</info>7.1<info>LDAP_OPT_X_TLS_CRL_PEER</info><info>int</info>7.1<info>LDAP_OPT_X_TLS_CRL_ALL</info><info>int</info>7.1<info>LDAP_OPT_X_TLS_CRLFILE</info><info>string</info>7.1<info>LDAP_OPT_X_TLS_DHFILE</info><info>string</info>7.1<info>LDAP_OPT_X_TLS_KEYFILE</info><info>string</info>7.1<info>LDAP_OPT_X_TLS_PACKAGE</info><info>string</info>7.1<info>LDAP_OPT_X_TLS_PROTOCOL_MIN</info><info>int</info>7.1<info>LDAP_OPT_X_TLS_RANDOM_FILE</info><info>string</info>7.1<info>LDAP_OPT_X_TLS_REQUIRE_CERT</info><info>int</info>
  <info>array|string|int</info>  <strong>$value</strong>   Будет установлен в значение опции.

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

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


id: ldap_get_values
type: function
doc:
<comment>Description:</comment>
  Получает все значения из записи результата
  
  Читает все значения атрибута в записи результата.
  
  Эта функция требует <strong>$entry</strong>, а следовательно, перед ней должны быть запущена одна из функций ldap
  поиска и один из результатов их вызова для получения отдельной записи.
  
  В создаваемом приложении необходимо будет использовать сложные конструкции для поиска определённых
  атрибутов (таких как "фамилия" или "почта") или необходимо будет использовать функцию
  <strong>ldap_get_attributes()</strong>, чтобы разобрать, какие атрибуты существуют для данной записи.

<comment>Param:</comment>
  <info>LDAP\Connection</info>   <strong>$ldap</strong>       Экземпляр <class>LDAP\Connection</class>, возвращаемый функцией <strong>ldap_connect()</strong>.
  <info>LDAP\ResultEntry</info>  <strong>$entry</strong>      Экземпляр <class>LDAP\ResultEntry</class>.
  <info>string</info>            <strong>$attribute</strong>  

<comment>Return:</comment>
  <info>array|false</info>  Возвращает массив значений для атрибута в случае успешного выполнения или <info>false</info> в
               случае возникновения ошибки. Число значений может быть найдено по индексу "count" в
               результирующем массиве. Отдельные значения могут быть доступны по целочисленным
               индексам в массиве. Первый индекс 0.
               
               LDAP позволяет хранить больше чем одну запись для атрибута, таким образом, можно,
               например, сохранить много адресов электронной почты для записи каталога одного
               человека, все маркированные атрибутом "mail"  return_value["count"] = число значений
               атрибута return_value[0] = первое значение атрибута return_value[i] = i-ое значение
               атрибута

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


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

<comment>Param:</comment>
  <info>LDAP\Connection</info>   <strong>$ldap</strong>       Экземпляр <class>LDAP\Connection</class>, возвращаемый функцией <strong>ldap_connect()</strong>.
  <info>LDAP\ResultEntry</info>  <strong>$entry</strong>      Экземпляр <class>LDAP\ResultEntry</class>.
  <info>string</info>            <strong>$attribute</strong>  

<comment>Return:</comment>
  <info>array|false</info>  Возвращает массив значений для атрибута в случае успешного выполнения и <info>false</info> в
               случае возникновения ошибки. Отдельные значения доступны по целочисленному индексу в
               массиве. Первый индекс 0. Число значений может быть найдено по индексу "count" в
               результирующем массиве.

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


id: ldap_list
type: function
doc:
<comment>Description:</comment>
  Одноуровневый поиск
  
  Выполняет поиск для указанного <strong>$filter</strong> в директории в рамках <info>LDAP_SCOPE_ONELEVEL</info>.
  
  <info>LDAP_SCOPE_ONELEVEL</info> означает, что поиск должен возвратить только информацию, которая является
  следующим уровнем ниже <strong>$base</strong>, заданного при вызове. (Эквивалент вводу "ls" и получения списка
  файлов и папок в текущем рабочем каталоге.)
  
  Также можно выполнять параллельный поиск. В этом случае первым аргументом должен быть массив
  экземпляров <class>LDAP\Connection</class>, а не один экземпляр.
  Если поиск не должен использовать один и тот же базовый DN и фильтр, в качестве аргументов можно
  передать массив базовых DN и/или массив фильтров.
  Количество элементов в массивах должно совпадать с количеством экземпляров <class>LDAP\Connection</class>,
  поскольку первые записи массивов используются для одного поиска, вторые — для другого и так далее.
  При параллельном поиске возвращается массив экземпляров <class>LDAP\Result</class>, за исключением возникновения
  ошибки, когда возвращается значение <info>false</info>.

<comment>Param:</comment>
  <info>LDAP\Connection|array</info>  <strong>$ldap</strong>             Экземпляр <class>LDAP\Connection</class>, возвращаемый функцией
                                           <strong>ldap_connect()</strong>.
  <info>array|string</info>           <strong>$base</strong>             Базовое DN для каталога.
  <info>array|string</info>           <strong>$filter</strong>           
  <info>array</info>                  <strong>$attributes</strong>       Массив необходимых атрибутов, например, <return>array("mail",
                                           "sn", "cn")</return>. Обратите внимание, что "dn" возвращается
                                           всегда, независимо от того, какие типы атрибутов
                                           требуются.
                                           
                                           Использование этого параметра намного более эффективно
                                           чем действие по умолчанию (которое должно возвратить все
                                           атрибуты и их присвоенные значения). Поэтому
                                           использование этого параметра нужно считать хорошей
                                           практикой.
  <info>int</info>                    <strong>$attributes_only</strong>  Должен быть равен 1, только если требуются типы атрибута.
                                           Если установлено 0, то, по умолчанию, выбираются и типы
                                           атрибутов и значения атрибута.
  <info>int</info>                    <strong>$sizelimit</strong>        Позволяет ограничить количество выбранных записей.
                                           Установка этого параметра как 0 означает, что ограничение
                                           отсутствует.
                                           
                                           Этот параметр НЕ может переопределять предустановку
                                           sizelimit на стороне сервера. Хотя его можно установить
                                           ниже.
                                           
                                           Некоторые хосты серверов каталогов будут сконфигурированы
                                           так, чтобы возвратить не больше, чем предварительно
                                           установленное число записей. Если это произойдёт, то
                                           сервер укажет, что возвратил только частичный набор
                                           результатов. Это также происходит, если Вы используете
                                           этот параметр, чтобы ограничить количество выбранных
                                           записей.
  <info>int</info>                    <strong>$timelimit</strong>        Устанавливает число секунд, ограничивающее процесс
                                           поиска. Установка этого параметра как 0 означает, что
                                           ограничение отсутствует.
                                           
                                           Этот параметр НЕ может переопределять предустановку
                                           timelimit на стороне сервера. Хотя его можно установить
                                           ниже.
  <info>int</info>                    <strong>$deref</strong>            Определяет, как псевдонимы должны быть обработаны во
                                           время поиска. Может быть одним из следующих:
                                           <info>LDAP_DEREF_NEVER</info> - (по умолчанию) псевдонимы никогда не
                                           разыменовываться. <info>LDAP_DEREF_SEARCHING</info> - псевдонимы
                                           должны быть разыменованы во время поиска, но не при
                                           определении местоположения базового объекта поиска.
                                           <info>LDAP_DEREF_FINDING</info> - псевдонимы должны быть разыменованы
                                           при определении местоположения базового объекта, но не во
                                           время поиска. <info>LDAP_DEREF_ALWAYS</info> - псевдонимы должны
                                           всегда разыменовываться всегда.
                                           
                                           <info>LDAP_DEREF_NEVER</info> - (по умолчанию) псевдонимы никогда не
                                           разыменовываться.
                                           
                                           <info>LDAP_DEREF_SEARCHING</info> - псевдонимы должны быть
                                           разыменованы во время поиска, но не при определении
                                           местоположения базового объекта поиска.
                                           
                                           <info>LDAP_DEREF_FINDING</info> - псевдонимы должны быть разыменованы
                                           при определении местоположения базового объекта, но не во
                                           время поиска.
                                           
                                           <info>LDAP_DEREF_ALWAYS</info> - псевдонимы должны всегда
                                           разыменовываться всегда.
  <info>array|null</info>             <strong>$controls</strong>         Массив управляющих констант LDAP для отправки в запросе.

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

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


id: ldap_mod_add
type: function
doc:
<comment>Description:</comment>
  Добавить значения атрибута к текущим атрибутам
  
  Добавляет один или более атрибутов к указанному <strong>$dn</strong>. Для добавления полноценного нового объекта
  используйте <strong>ldap_add()</strong>.

<comment>Param:</comment>
  <info>LDAP\Connection</info>  <strong>$ldap</strong>      Экземпляр <class>LDAP\Connection</class>, возвращаемый функцией <strong>ldap_connect()</strong>.
  <info>string</info>           <strong>$dn</strong>        Отличительное имя LDAP-объекта.
  <info>array</info>            <strong>$entry</strong>     Ассоциативный массив со списком добавляемых значений атрибутов. Если
                              какой-либо атрибут ещё не существует, то он будет добавлен. Если
                              атрибут уже существует, то вы можете только добавить к нему значение,
                              если он поддерживает множественные значения.
  <info>array|null</info>       <strong>$controls</strong>  Массив управляющих констант LDAP для отправки в запросе.

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

<comment>See Also:</comment>
   * <strong>ldap_mod_add_ext()</strong>
   * <strong>ldap_mod_del()</strong>
   * <strong>ldap_mod_replace()</strong>
   * <strong>ldap_modify_batch()</strong>


id: ldap_mod_add_ext
type: function
doc:
<comment>Description:</comment>
  Добавить значения атрибута к текущим атрибутам
  
  Делает то же самое, что и <strong>ldap_mod_add()</strong>, но возвращает экземпляр <class>LDAP\Result</class> для разбора с
  помощью <strong>ldap_parse_result()</strong>.

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

<comment>See Also:</comment>
   * <strong>ldap_mod_add()</strong>
   * <strong>ldap_parse_result()</strong>


id: ldap_mod_del
type: function
doc:
<comment>Description:</comment>
  Удалить значения атрибута из текущих атрибутов
  
  Удаляет один или более атрибутов из указанного <strong>$dn</strong>. Удаление объектов осуществляется функцией
  <strong>ldap_delete()</strong>.

<comment>Param:</comment>
  <info>LDAP\Connection</info>  <strong>$ldap</strong>      Экземпляр <class>LDAP\Connection</class>, возвращаемый функцией <strong>ldap_connect()</strong>.
  <info>string</info>           <strong>$dn</strong>        Отличительное имя LDAP-объекта.
  <info>array</info>            <strong>$entry</strong>     
  <info>array|null</info>       <strong>$controls</strong>  Массив управляющих констант LDAP для отправки в запросе.

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

<comment>See Also:</comment>
   * <strong>ldap_mod_del_ext()</strong>
   * <strong>ldap_mod_add()</strong>
   * <strong>ldap_mod_replace()</strong>
   * <strong>ldap_modify_batch()</strong>


id: ldap_mod_del_ext
type: function
doc:
<comment>Description:</comment>
  Удалить значения атрибутов из текущих атрибутов
  
  Делает то же самое, что и <strong>ldap_mod_del()</strong>, но возвращает экземпляр <class>LDAP\Result</class> для разбора с
  помощью <strong>ldap_parse_result()</strong>.

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

<comment>See Also:</comment>
   * <strong>ldap_mod_del()</strong>
   * <strong>ldap_parse_result()</strong>


id: ldap_mod_replace
type: function
doc:
<comment>Description:</comment>
  Заменить значения атрибутов на новые
  
  Заменяет один или более атрибутов из указанного <strong>$dn</strong>. Также её можно использовать для удаления или
  добавления атрибутов.

<comment>Param:</comment>
  <info>LDAP\Connection</info>  <strong>$ldap</strong>      Экземпляр <class>LDAP\Connection</class>, возвращаемый функцией <strong>ldap_connect()</strong>.
  <info>string</info>           <strong>$dn</strong>        Отличительное имя LDAP-объекта.
  <info>array</info>            <strong>$entry</strong>     Ассоциативный массив со списком заменяемых атрибутов. Если задать
                              пустой массив, то атрибут будет удалён. Если какой либо атрибут
                              отсутствует, то он будет добавлен.
  <info>array|null</info>       <strong>$controls</strong>  Массив управляющих констант LDAP для отправки в запросе.

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

<comment>See Also:</comment>
   * <strong>ldap_mod_replace_ext()</strong>
   * <strong>ldap_mod_del()</strong>
   * <strong>ldap_mod_add()</strong>
   * <strong>ldap_modify_batch()</strong>


id: ldap_mod_replace_ext
type: function
doc:
<comment>Description:</comment>
  Заменить значения атрибута на новые
  
  Делает то же самое, что и <strong>ldap_mod_replace()</strong>, но возвращает экземпляр <class>LDAP\Result</class> для разбора с
  помощью <strong>ldap_parse_result()</strong>.

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

<comment>See Also:</comment>
   * <strong>ldap_mod_replace()</strong>
   * <strong>ldap_parse_result()</strong>


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

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


id: ldap_modify_batch
type: function
doc:
<comment>Description:</comment>
  Формирования и запуск пакетного изменения записи LDAP
  
  Модифицирует существующую запись в каталоге LDAP. Допустимо детальное описание модификации.

<comment>Param:</comment>
  <info>LDAP\Connection</info>  <strong>$ldap</strong>                Экземпляр <class>LDAP\Connection</class>, возвращаемый функцией
                                        <strong>ldap_connect()</strong>.
  <info>string</info>           <strong>$dn</strong>                  Характерное имя объекта LDAP.
  <info>array</info>            <strong>$modifications_info</strong>  Массив, описывающий необходимую модификацию. Каждая запись
                                        этого массива представляет собой ассоциативный массив с
                                        двумя или тремя ключами: <return>attrib</return> задаёт имя атрибута для
                                        изменения, <return>modtype</return> задаёт тип модификации и (в зависимости
                                        от типа модификации) <return>values</return> задаёт массив значений
                                        атрибутов, соответствующий данной модификации.
                                        
                                        Допустимые значения для <return>modtype</return>: <info>LDAP_MODIFY_BATCH_ADD</info>
                                        Каждое значение заданное в <return>values</return> будет добавлено (как
                                        дополнительное значение) к атрибуту <return>attrib</return>.
                                        <info>LDAP_MODIFY_BATCH_REMOVE</info> Каждое значение заданное в <return>values</return>
                                        будет удалено из атрибута заданного в<return>attrib</return>. Ни одно
                                        значение не указанное в <return>values</return> не будет затронуто.
                                        <info>LDAP_MODIFY_BATCH_REMOVE_ALL</info> Все значения будут удалены у
                                        атрибута <return>attrib</return>. Параметр <return>values</return> не нужен.
                                        <info>LDAP_MODIFY_BATCH_REPLACE</info> Все существующие значения атрибута
                                        <return>attrib</return> будут заменены значениями указанными в <return>values</return>.
                                        
                                        Каждое значение заданное в <return>values</return> будет добавлено (как
                                        дополнительное значение) к атрибуту <return>attrib</return>.
                                        
                                        Каждое значение заданное в <return>values</return> будет удалено из атрибута
                                        заданного в<return>attrib</return>. Ни одно значение не указанное в <return>values</return> не
                                        будет затронуто.
                                        
                                        Все значения будут удалены у атрибута <return>attrib</return>. Параметр
                                        <return>values</return> не нужен.
                                        
                                        Все существующие значения атрибута <return>attrib</return> будут заменены
                                        значениями указанными в <return>values</return>.
                                        
                                        Обратите внимание, что все значения <return>attrib</return> должны быть
                                        строками, все значения <return>values</return> должны быть массивами строк и
                                        любые значения <return>modtype</return> должны быть одной из констант
                                        LDAP_MODIFY_BATCH_*, перечисленных выше.
  <info>array|null</info>       <strong>$controls</strong>            Массив управляющих констант LDAP для отправки в запросе.

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


id: ldap_next_attribute
type: function
doc:
<comment>Description:</comment>
  Получить следующий атрибут из результата
  
  Возвращает атрибуты записи. Первый вызов <strong>ldap_next_attribute()</strong> производится с параметром <strong>$entry</strong>,
  который возвращается <strong>ldap_first_attribute()</strong>.

<comment>Param:</comment>
  <info>LDAP\Connection</info>   <strong>$ldap</strong>   Экземпляр <class>LDAP\Connection</class>, возвращаемый функцией <strong>ldap_connect()</strong>.
  <info>LDAP\ResultEntry</info>  <strong>$entry</strong>  Экземпляр <class>LDAP\ResultEntry</class>.

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

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


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

<comment>Param:</comment>
  <info>LDAP\Connection</info>   <strong>$ldap</strong>   Экземпляр <class>LDAP\Connection</class>, возвращаемый функцией <strong>ldap_connect()</strong>.
  <info>LDAP\ResultEntry</info>  <strong>$entry</strong>  Экземпляр <class>LDAP\ResultEntry</class>.

<comment>Return:</comment>
  <info>LDAP\ResultEntry|false</info>  Возвращает экземпляр <class>LDAP\ResultEntry</class> для следующей записи в результате,
                          содержимое которого начинают читаться, запуская <strong>ldap_first_entry()</strong>. Если
                          нет больше записей в результате, тогда возвращается <info>false</info>.

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


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

<comment>Return:</comment>
  <info>LDAP\ResultEntry|false</info>  


id: ldap_parse_exop
type: function
doc:
<comment>Description:</comment>
  Разбор результирующего объекта выполнения расширенной операции LDAP
  
  Разбирает <strong>$result</strong>, полученный после выполнения расширенной операции LDAP

<comment>Param:</comment>
  <info>LDAP\Connection</info>  <strong>$ldap</strong>           Экземпляр <class>LDAP\Connection</class>, возвращаемый функцией <strong>ldap_connect()</strong>.
  <info>LDAP\Result</info>      <strong>$result</strong>         Экземпляр <class>LDAP\Result</class>, возвращаемый <strong>ldap_list()</strong> или
                                   <strong>ldap_search()</strong>.
  <info>string</info>           <strong>$response_data</strong>  Будет заполнен разобранными данными.
  <info>string</info>           <strong>$response_oid</strong>   Будет заполнен возвращённым OID.

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

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


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

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


id: ldap_parse_result
type: function
doc:
<comment>Description:</comment>
  Извлечь информацию из результата
  
  Обрабатывает результат поиска LDAP.

<comment>Param:</comment>
  <info>LDAP\Connection</info>  <strong>$ldap</strong>           Экземпляр <class>LDAP\Connection</class>, возвращаемый функцией <strong>ldap_connect()</strong>.
  <info>LDAP\Result</info>      <strong>$result</strong>         Экземпляр <class>LDAP\Result</class>, возвращаемый <strong>ldap_list()</strong> или
                                   <strong>ldap_search()</strong>.
  <info>int</info>              <strong>$error_code</strong>     Ссылка на переменную, которой присваивается код ошибки LDAP, или
                                   <return>0</return>, если нет ошибки.
  <info>string</info>           <strong>$matched_dn</strong>     Ссылка на переменную, которой присваивается найденный DN, если он
                                   определяется в запросе, иначе присваивается <info>null</info>.
  <info>string</info>           <strong>$error_message</strong>  Ссылка на переменную, которой присваивается сообщение об
                                   LDAP-ошибке, или пустая строка, если нет ошибки.
  <info>array</info>            <strong>$referrals</strong>      Ссылка на переменную, которой присваивается массив (<info>array</info>) со
                                   всеми отсылками (referral) в виде строк, или пустой массив, если
                                   они не были возвращены.
  <info>array</info>            <strong>$controls</strong>       Массив (<info>array</info>) LDAP Controls, которые были отправлены вместо с
                                   ответом.

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


id: ldap_read
type: function
doc:
<comment>Description:</comment>
  Читает запись
  
  Выполняет поиск для указанного <strong>$filter</strong> в директории в рамках <info>LDAP_SCOPE_BASE</info>. Эквивалентно чтению
  записи из директории.
  
  Также можно выполнять параллельный поиск. В этом случае первым аргументом должен быть массив
  экземпляров <class>LDAP\Connection</class>, а не один экземпляр.
  Если поиск не должен использовать один и тот же базовый DN и фильтр, в качестве аргументов можно
  передать массив базовых DN и/или массив фильтров.
  Количество элементов в массивах должно совпадать с количеством экземпляров <class>LDAP\Connection</class>,
  поскольку первые записи массивов используются для одного поиска, вторые — для другого и так далее.
  При параллельном поиске возвращается массив экземпляров <class>LDAP\Result</class>, за исключением возникновения
  ошибки, когда возвращается значение <info>false</info>.

<comment>Param:</comment>
  <info>LDAP\Connection|array</info>  <strong>$ldap</strong>             Экземпляр <class>LDAP\Connection</class>, возвращаемый функцией
                                           <strong>ldap_connect()</strong>.
  <info>array|string</info>           <strong>$base</strong>             Базовое DN для каталога.
  <info>array|string</info>           <strong>$filter</strong>           Пустой фильтр не допустим. Если необходимо получить
                                           абсолютно всю информацию для этой записи, используйте
                                           фильтр <return>objectClass=*</return>. Если известно какие типы записи
                                           используются на сервере каталогов, то можно использовать
                                           соответствующий фильтр, такой как
                                           <return>objectClass=inetOrgPerson</return>.
  <info>array</info>                  <strong>$attributes</strong>       Массив необходимых атрибутов, например, <return>array("mail",
                                           "sn", "cn")</return>. Обратите внимание, что "dn" всегда
                                           возвращается, независимо от того, какие типы атрибутов
                                           требуются.
                                           
                                           Использование этого параметра намного более эффективно
                                           чем действие по умолчанию (которое возвращает все
                                           атрибуты и их присвоенные значения). Поэтому
                                           использование этого параметра нужно считать хорошей
                                           практикой.
  <info>int</info>                    <strong>$attributes_only</strong>  Должен быть равен 1, только если требуются типы атрибута.
                                           Если равен 0, то, по умолчанию, выбираются и типы
                                           атрибутов и значения.
  <info>int</info>                    <strong>$sizelimit</strong>        Позволяет ограничить количество выбранных записей.
                                           Установка этого параметра равным 0 означает, что
                                           ограничение отсутствует.
                                           
                                           Этот параметр НЕ может переопределять предустановку
                                           sizelimit на стороне сервера. Хотя его можно установить
                                           ниже.
                                           
                                           Некоторые хосты серверов каталогов будут сконфигурированы
                                           так, чтобы возвратить не больше, чем предварительно
                                           установленное число записей. Если это произойдёт, то
                                           сервер укажет, что только возвратил частичный набор
                                           результатов. Это также происходит, если используется этот
                                           параметр, чтобы ограничить количество выбранных записей.
  <info>int</info>                    <strong>$timelimit</strong>        Устанавливает число секунд, ограничивающее процесс
                                           поиска. Установка этого параметра равным 0 означает, что
                                           ограничение отсутствует.
                                           
                                           Этот параметр НЕ может переопределять предустановку
                                           timelimit на стороне сервера. Хотя его можно установить
                                           ниже.
  <info>int</info>                    <strong>$deref</strong>            Определяет то, как псевдонимы должны быть обработаны во
                                           время поиска. Может быть одним из следующих:
                                           <info>LDAP_DEREF_NEVER</info> - (по умолчанию) псевдонимы никогда не
                                           разыменовываются. <info>LDAP_DEREF_SEARCHING</info> - псевдонимы
                                           должны быть разыменованы во время поиска, но не при
                                           определении местоположения базового объекта поиска.
                                           <info>LDAP_DEREF_FINDING</info> - псевдонимы должны быть разыменованы
                                           при определении местоположения базового объекта, но не во
                                           время поиска. <info>LDAP_DEREF_ALWAYS</info> - псевдонимы должны
                                           всегда разыменовываться.
                                           
                                           <info>LDAP_DEREF_NEVER</info> - (по умолчанию) псевдонимы никогда не
                                           разыменовываются.
                                           
                                           <info>LDAP_DEREF_SEARCHING</info> - псевдонимы должны быть
                                           разыменованы во время поиска, но не при определении
                                           местоположения базового объекта поиска.
                                           
                                           <info>LDAP_DEREF_FINDING</info> - псевдонимы должны быть разыменованы
                                           при определении местоположения базового объекта, но не во
                                           время поиска.
                                           
                                           <info>LDAP_DEREF_ALWAYS</info> - псевдонимы должны всегда
                                           разыменовываться.
  <info>array|null</info>             <strong>$controls</strong>         Массив управляющих констант LDAP для отправки в запросе.

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


id: ldap_rename
type: function
doc:
<comment>Description:</comment>
  Изменить имя записи
  
  Переименование/перемещение записи, определённой <strong>$dn</strong>.

<comment>Param:</comment>
  <info>LDAP\Connection</info>  <strong>$ldap</strong>            Экземпляр <class>LDAP\Connection</class>, возвращаемый функцией <strong>ldap_connect()</strong>.
  <info>string</info>           <strong>$dn</strong>              Отличительное имя LDAP-объекта.
  <info>string</info>           <strong>$new_rdn</strong>         Новое RDN.
  <info>string</info>           <strong>$new_parent</strong>      Новая родительская/превосходящая запись.
  <info>bool</info>             <strong>$delete_old_rdn</strong>  Если <info>true</info>, старые значения RDN удаляются, иначе старые значения
                                    RDN сохраняются как неуникальные значения записи.
  <info>array|null</info>       <strong>$controls</strong>        Массив управляющих констант LDAP для отправки в запросе.

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

<comment>See Also:</comment>
   * <strong>ldap_rename_ext()</strong>
   * <strong>ldap_modify()</strong>


id: ldap_rename_ext
type: function
doc:
<comment>Description:</comment>
  Модифицировать название записи
  
  Делает то же самое, что и <strong>ldap_rename()</strong>, но возвращает экземпляр <class>LDAP\Result</class> для разбора с помощью
  <strong>ldap_parse_result()</strong>.

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

<comment>See Also:</comment>
   * <strong>ldap_rename()</strong>
   * <strong>ldap_parse_result()</strong>


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

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


id: ldap_search
type: function
doc:
<comment>Description:</comment>
  Поиск по LDAP дереву
  
  Выполняет поиск для указанного фильтра в директории с границами <info>LDAP_SCOPE_SUBTREE</info>. Эквивалентно
  поиску по всему каталогу.
  
  Также можно выполнять параллельный поиск. В этом случае первым аргументом должен быть массив
  экземпляров <class>LDAP\Connection</class>, а не один экземпляр.
  Если поиск не должен использовать один и тот же базовый DN и фильтр, в качестве аргументов можно
  передать массив базовых DN и/или массив фильтров.
  Количество элементов в массивах должно совпадать с количеством экземпляров <class>LDAP\Connection</class>,
  поскольку первые записи массивов используются для одного поиска, вторые — для другого и так далее.
  При параллельном поиске возвращается массив экземпляров <class>LDAP\Result</class>, за исключением возникновения
  ошибки, когда возвращается значение <info>false</info>.

<comment>Param:</comment>
  <info>LDAP\Connection|array</info>  <strong>$ldap</strong>             Экземпляр <class>LDAP\Connection</class>, возвращаемый функцией
                                           <strong>ldap_connect()</strong>.
  <info>array|string</info>           <strong>$base</strong>             Базовое DN для каталога.
  <info>array|string</info>           <strong>$filter</strong>           Поисковый фильтр может быть простым или расширенным,
                                           используя булевы операторы в формате, описанном в
                                           документации LDAP (смотрите Netscape Directory SDK или
                                           RFC4515 для полной информации о фильтрах).
  <info>array</info>                  <strong>$attributes</strong>       Массив необходимых атрибутов, например, <return>array("mail",
                                           "sn", "cn")</return>. Обратите внимание, что "dn" всегда
                                           возвращается, независимо от того, какие типы атрибутов
                                           требуются.
                                           
                                           Использование этого параметра намного более эффективно,
                                           чем действие по умолчанию (которое должно возвратить все
                                           атрибуты и присвоенные им значения). Поэтому
                                           использование этого параметра считается хорошей
                                           практикой.
  <info>int</info>                    <strong>$attributes_only</strong>  Должен быть равен 1, если требуются только типы атрибута.
                                           Если равен 0, то, по умолчанию, выбираются и типы
                                           атрибутов и значения.
  <info>int</info>                    <strong>$sizelimit</strong>        Позволяет ограничить количество выбранных записей.
                                           Установка этого параметра равным 0 означает, что
                                           ограничение отсутствует.
                                           
                                           Этот параметр НЕ может переопределять предустановку
                                           sizelimit на стороне сервера. Хотя его можно установить
                                           ниже.
                                           
                                           Некоторые хосты серверов каталогов будут сконфигурированы
                                           так, чтобы возвратить не больше, чем предварительно
                                           установленное число записей. Если это произойдёт, то
                                           сервер укажет, что возвратил только частичный набор
                                           результатов. Это также происходит, если Вы используете
                                           этот параметр чтобы ограничить количество выбранных
                                           записей.
  <info>int</info>                    <strong>$timelimit</strong>        Устанавливает число секунд, ограничивающее процесс
                                           поиска. Установка этого параметра равным 0 означает, что
                                           ограничение отсутствует.
                                           
                                           Этот параметр НЕ может переопределять предустановку
                                           timelimit на стороне сервера. Хотя его можно установить
                                           ниже.
  <info>int</info>                    <strong>$deref</strong>            Определяет как псевдонимы должны быть обработаны во время
                                           поиска. Может быть одним из следующих: <info>LDAP_DEREF_NEVER</info> -
                                           (по умолчанию) псевдонимы никогда не разыменовываются.
                                           <info>LDAP_DEREF_SEARCHING</info> - псевдонимы должны быть
                                           разыменованы во время поиска, но не при определении
                                           местоположения базового объекта поиска.
                                           <info>LDAP_DEREF_FINDING</info> - псевдонимы должны быть разыменованы
                                           при определении местоположения базового объекта, но не во
                                           время поиска. <info>LDAP_DEREF_ALWAYS</info> - псевдонимы должны
                                           разыменовываться всегда.
                                           
                                           <info>LDAP_DEREF_NEVER</info> - (по умолчанию) псевдонимы никогда не
                                           разыменовываются.
                                           
                                           <info>LDAP_DEREF_SEARCHING</info> - псевдонимы должны быть
                                           разыменованы во время поиска, но не при определении
                                           местоположения базового объекта поиска.
                                           
                                           <info>LDAP_DEREF_FINDING</info> - псевдонимы должны быть разыменованы
                                           при определении местоположения базового объекта, но не во
                                           время поиска.
                                           
                                           <info>LDAP_DEREF_ALWAYS</info> - псевдонимы должны разыменовываться
                                           всегда.
  <info>array|null</info>             <strong>$controls</strong>         Массив управляющих констант LDAP для отправки в запросе.

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


id: ldap_set_option
type: function
doc:
<comment>Description:</comment>
  Установить значение данной опции
  
  Устанавливает значение указанной опции в <strong>$value</strong>.

<comment>Param:</comment>
  <info>LDAP\Connection|null</info>   <strong>$ldap</strong>    Либо экземпляр <class>LDAP\Connection</class>, возвращаемый функцией
                                  <strong>ldap_connect()</strong> для установки опции для этого соединения, либо <info>null</info>
                                  для установки опции глобально.
  <info>int</info>                    <strong>$option</strong>  Опция <strong>$option</strong> может быть одной из: ОпцияТипДоступна
                                  с<info>LDAP_OPT_DEREF</info><info>int</info><info>LDAP_OPT_SIZELIMIT</info><info>int</info><info>LDAP_OPT_TIMELIMIT</info><info>int</info><info>LDAP_OPT_NETWORK_TIMEOUT</info><info>int</info><info>LDAP_OPT_PROTOCOL_VERSION</info><info>int</info><info>LDAP_OPT_ERROR_NUMBER</info><info>int</info><info>LDAP_OPT_REFERRALS</info><info>bool</info><info>LDAP_OPT_RESTART</info><info>bool</info><info>LDAP_OPT_HOST_NAME</info><info>string</info><info>LDAP_OPT_ERROR_STRING</info><info>string</info><info>LDAP_OPT_DIAGNOSTIC_MESSAGE</info><info>string</info><info>LDAP_OPT_MATCHED_DN</info><info>string</info><info>LDAP_OPT_SERVER_CONTROLS</info><info>array</info><info>LDAP_OPT_CLIENT_CONTROLS</info><info>array</info><info>LDAP_OPT_X_KEEPALIVE_IDLE</info><info>int</info>PHP
                                  7.1.0<info>LDAP_OPT_X_KEEPALIVE_PROBES</info><info>int</info>PHP
                                  7.1.0<info>LDAP_OPT_X_KEEPALIVE_INTERVAL</info><info>int</info>PHP
                                  7.1.0<info>LDAP_OPT_X_TLS_CACERTDIR</info><info>string</info>PHP
                                  7.1.0<info>LDAP_OPT_X_TLS_CACERTFILE</info><info>string</info>PHP
                                  7.1.0<info>LDAP_OPT_X_TLS_CERTFILE</info><info>string</info>PHP
                                  7.1.0<info>LDAP_OPT_X_TLS_CIPHER_SUITE</info><info>string</info>PHP
                                  7.1.0<info>LDAP_OPT_X_TLS_CRLCHECK</info><info>int</info>PHP
                                  7.1.0<info>LDAP_OPT_X_TLS_CRLFILE</info><info>string</info>PHP
                                  7.1.0<info>LDAP_OPT_X_TLS_DHFILE</info><info>string</info>PHP
                                  7.1.0<info>LDAP_OPT_X_TLS_KEYFILE</info><info>string</info>PHP
                                  7.1.0<info>LDAP_OPT_X_TLS_PROTOCOL_MIN</info><info>int</info>PHP
                                  7.1.0<info>LDAP_OPT_X_TLS_RANDOM_FILE</info><info>string</info>PHP
                                  7.1.0<info>LDAP_OPT_X_TLS_REQUIRE_CERT</info><info>int</info>PHP 7.0.5
                                  
                                  <info>LDAP_OPT_SERVER_CONTROLS</info> и <info>LDAP_OPT_CLIENT_CONTROLS</info> требуют список
                                  элементов управления. Это означает, что значение должно быть
                                  массивом элементов управления. Элемент управления состоит из oid,
                                  определяющего элемент управления, опционального значения, и
                                  дополнительного флага для критичности. В PHP элемент управления
                                  задаётся массивом, содержащим элемент с ключом oid и строковым
                                  значением, и двумя необязательными элементами. Необязательные
                                  элементы являются ключом value со строковым значением и ключом
                                  iscritical с логическим значением. iscritical по умолчанию
                                  устанавливается в <info>false</info>, если не указан. Для более подробной
                                  информации смотрите draft-ietf-ldapext-ldap-c-api-xx.txt. Смотрите
                                  также второй пример, расположенный ниже.
  <info>array|string|int|bool</info>  <strong>$value</strong>   Новое значение для указанной <strong>$option</strong> (опции).

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

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


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

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


id: ldap_sort
type: function
doc:
<comment>Description:</comment>
  Сортирует записи LDAP
  
  Сортирует результат запроса LDAP, возвращаемый функцией <strong>ldap_search()</strong>.
  
  Так как эта функция сортирует результат на клиентской стороне, вы можете получить не те
  результаты, которые ожидали в случае, если был превышен лимит <strong>$sizelimit</strong> на стороне сервера либо
  указанный в <strong>ldap_search()</strong>.

<comment>Param:</comment>
  <info>resource</info>  <strong>$link</strong>        Ресурс LDAP, возвращаемый функцией <strong>ldap_connect()</strong>.
  <info>resource</info>  <strong>$result</strong>      Дескриптор результата поиска, возвращаемый функцией <strong>ldap_search()</strong>.
  <info>string</info>    <strong>$sortfilter</strong>  Атрибут, используемый в качестве ключа при сортировке.

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


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

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


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

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


id: ldap_unbind
type: function
doc:
<comment>Description:</comment>
  Разорвать привязку к директории LDAP
  
  Разрывает привязку к LDAP-директории.

<comment>Param:</comment>
  <info>LDAP\Connection</info>  <strong>$ldap</strong>  Экземпляр <class>LDAP\Connection</class>, возвращаемый функцией <strong>ldap_connect()</strong>.

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

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


id: levenshtein
type: function
doc:
<comment>Description:</comment>
  Вычисляет расстояние Левенштейна между двумя строками
  
  Расстояние Левенштейна - это минимальное количество вставок, замен и удалений символов,
  необходимое для преобразования <strong>$string1</strong> в <strong>$string2</strong>. Сложность алгоритма равна <return>O(m*n)</return>, где <return>n</return> и <return>m</return> -
  длины строк <strong>$string1</strong> и <strong>$string2</strong> (неплохо по сравнению с <strong>similar_text()</strong>, имеющей сложность
  <return>O(max(n,m)**3)</return>, но всё же довольно много).
  
  Если <strong>$insertion_cost</strong>, <strong>$replacement_cost</strong> и/или <strong>$deletion_cost</strong> не равны <return>1</return>, алгоритм адаптируется для
  выбора самых дешёвых преобразований. Например. если $insertion_cost + $deletion_cost
  \< $replacement_cost, замены не будут выполняться, вместо этого будут выполняться вставки и удаления.

<comment>Param:</comment>
  <info>string</info>  <strong>$string1</strong>           Одна из строк, для которых вычисляется расстояние Левенштейна.
  <info>string</info>  <strong>$string2</strong>           Одна из строк, для которых вычисляется расстояние Левенштейна.
  <info>int</info>     <strong>$insertion_cost</strong>    Определяет стоимость вставки.
  <info>int</info>     <strong>$replacement_cost</strong>  Определяет стоимость замены.
  <info>int</info>     <strong>$deletion_cost</strong>     Определяет стоимость удаления.

<comment>Return:</comment>
  <info>int</info>  Эта функция возвращает расстояние Левенштейна между двумя строками.

<comment>See Also:</comment>
   * <strong>soundex()</strong>
   * <strong>similar_text()</strong>
   * <strong>metaphone()</strong>


id: libXMLError
type: class
doc:
<comment>Description:</comment>
  Содержит различную информацию об ошибках, выбрасываемых libxml. Коды ошибок описаны в официальной
  xmlError API документации.


id: libxml_clear_errors
type: function
doc:
<comment>Description:</comment>
  Очистка буфера ошибок libxml
    
  
  <strong>libxml_clear_errors()</strong> очищает буфер ошибок libxml.

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

<comment>See Also:</comment>
   * <strong>libxml_get_errors()</strong>
   * <strong>libxml_get_last_error()</strong>


id: libxml_disable_entity_loader
type: function
doc:
<comment>Description:</comment>
  Отключение возможности загрузки сущностей из внешних источников
    
  
  Отключение/включение возможности загружать внешние сущности. Обратите внимание, что отключение
  загрузки внешних сущностей может вызвать общие проблемы с загрузкой XML-документов. Однако в
  libxml 2.9.0 подстановка сущностей отключена по умолчанию, поэтому нет необходимости отключать
  загрузку внешних сущностей, если нет необходимости разрешать ссылки на внутренние сущности с
  помощью <info>LIBXML_NOENT</info>. Как правило, лучше использовать <strong>libxml_set_external_entity_loader()</strong> для
  подавления загрузки внешних сущностей.

<comment>Param:</comment>
  <info>bool</info>  <strong>$disable</strong>  Отключение (<info>true</info>) или включение (<info>false</info>) модулей libxml (таких как ,  и ) для
                  загрузки внешних сущностей.

<comment>Return:</comment>
  <info>bool</info>  Возвращает предыдущее значение.

<comment>See Also:</comment>
   * <strong>libxml_use_internal_errors()</strong>
   * <strong>libxml_set_external_entity_loader()</strong>
   * Константа <info>LIBXML_NOENT</info>


id: libxml_get_errors
type: function
doc:
<comment>Description:</comment>
  Получение массива произошедших ошибок
    
  
  Получение массива произошедших ошибок.

<comment>Return:</comment>
  <info>array</info>  Возвращает массив объектов <info>LibXMLError</info>, если в буфере есть ошибки, либо пустой массив в
         противном случае.

<comment>See Also:</comment>
   * <strong>libxml_get_last_error()</strong>
   * <strong>libxml_clear_errors()</strong>


id: libxml_get_external_entity_loader
type: function
doc:
<comment>Description:</comment>
  Получает текущий внешний загрузчик сущностей
  
  Получает внешний загрузчик сущностей, ранее установленный с помощью функции
  <strong>libxml_set_external_entity_loader()</strong>.

<comment>Return:</comment>
  <info>callable|null</info>  Внешний загрузчик сущностей, ранее установленный с помощью функции
                 <strong>libxml_set_external_entity_loader()</strong>. Если эта функция никогда не вызывалась или
                 если она была вызвана с <info>null</info>, будет возвращён <info>null</info>.

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


id: libxml_get_last_error
type: function
doc:
<comment>Description:</comment>
  Извлечение последней ошибки из libxml
    
  
  Извлечение последней ошибки из libxml.

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

<comment>See Also:</comment>
   * <strong>libxml_get_errors()</strong>
   * <strong>libxml_clear_errors()</strong>


id: libxml_set_external_entity_loader
type: function
doc:
<comment>Description:</comment>
  Изменение загрузчика по умолчанию для внешних объектов
  
  Изменение загрузчика по умолчанию для внешних объектов. Можно использовать для подавления
  расширения произвольных внешних сущностей, чтобы избежать XXE-атак, даже если для соответствующей
  операции установлено значение <info>LIBXML_NOENT</info>. Обычно это лучше, чем вызов
  <strong>libxml_disable_entity_loader()</strong>.

<comment>Param:</comment>
  <info>callable|null</info>  <strong>$resolver_function</strong>  Callback-функция (<info>callable</info>) со следующей сигнатурой:
                                     <info>resource</info><info>string</info><info>null</info></info>resolver<info>string</info><info>null</info></info><strong>$public_id</strong><info>string</info><strong>$system_id</strong><info>array</info><strong>$context</strong>
                                     <strong>$public_id</strong> Публичный идентификатор. <strong>$system_id</strong> Системный
                                     идентификатор. <strong>$context</strong> Массив из четырёх элементов:
                                     <return>"directory"</return>, <return>"intSubName"</return>, <return>"extSubURI"</return> и <return>"extSubSystem"</return>.  Эта
                                     callback-функция должна возвращать ресурс (resource) или строку
                                     (<info>string</info>) из которой можно открыть ресурс. Если возвращается
                                     <info>null</info>, разрешение ссылки на сущность завершится ошибкой.
                                     
                                     Публичный идентификатор.
                                     
                                     Системный идентификатор.
                                     
                                     Массив из четырёх элементов: <return>"directory"</return>, <return>"intSubName"</return>,
                                     <return>"extSubURI"</return> и <return>"extSubSystem"</return>.
  <info>string|null</info>    <strong>$public_id</strong>          Публичный идентификатор.
  <info>string</info>         <strong>$system_id</strong>          Системный идентификатор.
  <info>array</info>          <strong>$context</strong>            Массив из четырёх элементов: <return>"directory"</return>, <return>"intSubName"</return>,
                                     <return>"extSubURI"</return> и <return>"extSubSystem"</return>.

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

<comment>See Also:</comment>
   * <strong>libxml_disable_entity_loader()</strong>
   * <strong>libxml_get_external_entity_loader()</strong>


id: libxml_set_streams_context
type: function
doc:
<comment>Description:</comment>
  Установка контекста потоков для следующей загрузки или записи
     документа посредством libxml
    
  
  Установка контекста потока для следующей загрузки или записи документа посредством libxml.

<comment>Param:</comment>
  <info>resource</info>  <strong>$context</strong>  Ресурс контекста потока (созданный функцией <strong>stream_context_create()</strong>)

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

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


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

<comment>Param:</comment>
  <info>bool|null</info>  <strong>$use_errors</strong>  Включает (<info>true</info>) пользовательскую обработку ошибок или отключает её
                          (<info>false</info>). Отключение также очищает все текущие ошибки libxml.

<comment>Return:</comment>
  <info>bool</info>  Эта функция возвращает предыдущее значение параметра <strong>$use_errors</strong>.

<comment>See Also:</comment>
   * <strong>libxml_clear_errors()</strong>
   * <strong>libxml_get_errors()</strong>


id: link
type: function
doc:
<comment>Description:</comment>
  Создаёт жёсткую ссылку
  
  <strong>link()</strong> создаёт жёсткую ссылку.

<comment>Param:</comment>
  <info>string</info>  <strong>$target</strong>  Цель ссылки.
  <info>string</info>  <strong>$link</strong>    Имя ссылки.

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

<comment>See Also:</comment>
   * <strong>symlink()</strong>
   * <strong>readlink()</strong>
   * <strong>linkinfo()</strong>
   * <strong>unlink()</strong>


id: linkinfo
type: function
doc:
<comment>Description:</comment>
  Возвращает информацию о ссылке
  
  Возвращает информацию о ссылке.
  
  Эта функция используется для определения, существует ли ссылка (на которую указывает <strong>$path</strong>) на
  самом деле (используя тот же метод, что и макрос S_ISLNK, определённый в stat.h).

<comment>Param:</comment>
  <info>string</info>  <strong>$path</strong>  Путь к ссылке.

<comment>Return:</comment>
  <info>int|false</info>  <strong>linkinfo()</strong> возвращает поле <return>st_dev</return> структуры stat из Unix C, которую возвращает
             системный вызов <return>lstat</return>. Возвращает неотрицательное целое число в случае успешного
             выполнения, -1 в случае, если ссылка не была найдена, или <info>false</info> в случае возникновения
             ошибки open.base_dir.

<comment>See Also:</comment>
   * <strong>symlink()</strong>
   * <strong>link()</strong>
   * <strong>readlink()</strong>


id: list
type: function
doc:
<comment>Description:</comment>
  Присваивает переменным из списка значения подобно массиву
  
  Подобно <strong>array()</strong>, это не функция, а языковая конструкция. <strong>list()</strong> используется для того, чтобы
  присвоить списку переменных значения за одну операцию. Строки нельзя распаковать, а выражения
  <strong>list()</strong> не могут быть полностью пустыми.
  
  До PHP 7.1.0, <strong>list()</strong> работала только с индексированными массивами и принимала числовые индексы
  начиная с 0.

<comment>Param:</comment>
  <info>mixed</info>  <strong>$var</strong>   Переменная.
  <info>mixed</info>  <strong>$vars</strong>  Дополнительные переменные.

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

<comment>See Also:</comment>
   * <strong>each()</strong>
   * <strong>array()</strong>
   * <strong>extract()</strong>


id: localeconv
type: function
doc:
<comment>Description:</comment>
  Возвращает информацию о форматировании чисел
  
  Возвращает ассоциативный массив с информацией о числовых и денежных форматах в текущей локали.

<comment>Return:</comment>
  <info>array</info>  <strong>localeconv()</strong> возвращает данные, основанные на текущей локали, установленной функцией
         <strong>setlocale()</strong>. Возвращаемый массив содержит следующие элементы:
         ЭлементОписаниеdecimal_pointСимвол десятичной точкиthousands_sepРазделитель
         группgroupingМассив, содержащий количества цифр в группах для числовых
         данныхint_curr_symbolМеждународное обозначение валюты (например,
         RUB)currency_symbolНациональное обозначение валюты (например, руб)mon_decimal_pointСимвол
         десятичной точки в денежном форматеmon_thousands_sepРазделитель групп в денежном
         форматеmon_groupingМассив, содержащий количества цифр в группах для денежных
         данныхpositive_signЗнак для положительных чиселnegative_signЗнак для отрицательных
         чиселint_frac_digitsЧисло разрядов после точки (международное)frac_digitsЧисло разрядов
         после точки (национальное)p_cs_precedes<info>true</info>, если currency_symbol записывается перед
         положительным значением, иначе <info>false</info> p_sep_by_space<info>true</info>, если currency_symbol отделяется от
         положительного значения пробелом, иначе <info>false</info> n_cs_precedes<info>true</info>, если currency_symbol
         записывается перед отрицательным значением, иначе <info>false</info> n_sep_by_space<info>true</info>, если
         currency_symbol отделяется от отрицательного значения пробелом, иначе <info>false</info> p_sign_posn Для
         положительных чисел: 0 - Число и обозначение валюты заключаются в скобки1 - Знак
         записывается перед числом и обозначением валюты2 - Знак записывается после числа и
         обозначения валюты3 - Знак записывается перед обозначением валюты4 - Знак записывается
         после обозначения валюты n_sign_posn Для отрицательных чисел: 0 - Число и обозначение
         валюты заключаются в скобки1 - Знак записывается перед числом и обозначением валюты2 - Знак
         записывается после числа и обозначения валюты3 - Знак записывается перед обозначением
         валюты4 - Знак записывается после обозначения валюты
         
         <return>p_sign_posn</return> и <return>n_sign_posn</return> содержат строку с опциями форматирования. Каждое число
         представляет собой одно из вышеперечисленных условий.
         
         Элементы группировки содержат массивы, которые описывают способ группировки цифр. Например,
         поле группировки денежных величин в локали nl_NL (в режиме UTF-8 со знаком евро) содержит
         массив из двух элементов со значениями 3 и 3. Больший индекс массива соответствует
         группировке цифр, расположенных левее. Если элемент массива равен <info>CHAR_MAX</info>, последующие
         цифры не группируются. Если элемент массива равен 0, используется значение предыдущего
         элемента.

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


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

<comment>Param:</comment>
  <info>int|null</info>  <strong>$timestamp</strong>    Необязательный параметр <strong>$timestamp</strong> представляет собой метку времени типа
                          <info>int</info>, по умолчанию равную текущему локальному времени, если <strong>$timestamp</strong> не
                          указан или <info>null</info>. Другими словами, значение по умолчанию равно результату
                          функции <strong>time()</strong>.
  <info>bool</info>      <strong>$associative</strong>  Определяет, должна ли функция возвращать обычный массив с числовыми
                          индексами или ассоциативный.

<comment>Return:</comment>
  <info>array</info>  Если <strong>$associative</strong> установлен в <info>false</info> или не передан, то возвращается обычный массив с
         числовыми индексами. Если для параметра <strong>$associative</strong> установлено значение <info>true</info>, то функция
         <strong>localtime()</strong> вернёт ассоциативный массив, содержащий элементы структуры, возвращённые
         вызовом C-функции localtime. Ключи ассоциативного массива следующие:
         
          "tm_sec" - секунды, с <return>0</return> до <return>59</return>  "tm_min" - минуты, с <return>0</return> до <return>59</return>  "tm_hour" - часы, с <return>0</return> до <return>23</return>
         "tm_mday" - день месяца, с <return>1</return> до <return>31</return>  "tm_mon" - месяц года, с <return>0</return> (январь) до <return>11</return> (декабрь)
         "tm_year" - количество лет, прошедших с 1900 г.  "tm_wday" - день недели, с <return>0</return> (воскресенье)
         до <return>6</return> (суббота)  "tm_yday" - порядковый номер дня в году, с <return>0</return> до <return>365</return>  "tm_isdst" - действует
         ли летнее время?  Положительное значение, если учитывается, <return>0</return>, если не учитывается,
         отрицателен, если неизвестно.
         
         "tm_sec" - секунды, с <return>0</return> до <return>59</return>
         
         "tm_min" - минуты, с <return>0</return> до <return>59</return>
         
         "tm_hour" - часы, с <return>0</return> до <return>23</return>
         
         "tm_mday" - день месяца, с <return>1</return> до <return>31</return>
         
         "tm_mon" - месяц года, с <return>0</return> (январь) до <return>11</return> (декабрь)
         
         "tm_year" - количество лет, прошедших с 1900 г.
         
         "tm_wday" - день недели, с <return>0</return> (воскресенье) до <return>6</return> (суббота)
         
         "tm_yday" - порядковый номер дня в году, с <return>0</return> до <return>365</return>
         
         "tm_isdst" - действует ли летнее время?
         
         Положительное значение, если учитывается, <return>0</return>, если не учитывается, отрицателен, если
         неизвестно.

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


id: log
type: function
doc:
<comment>Description:</comment>
  Натуральный логарифм
  
  Если указан необязательный параметр <strong>$base</strong>, <strong>log()</strong> возвращает logbase от <strong>$num</strong>, иначе <strong>log()</strong>
  возвращает натуральный логарифм числа <strong>$num</strong>.

<comment>Param:</comment>
  <info>float</info>  <strong>$num</strong>   Число, для которого необходимо вычислить логарифм
  <info>float</info>  <strong>$base</strong>  Необязательное основание логарифма (по умолчанию основание 'e', что соответствует
                натуральному логарифму).

<comment>Return:</comment>
  <info>float</info>  Логарифм числа <strong>$num</strong> по основанию <strong>$base</strong>, если указано, или натуральный логарифм.

<comment>See Also:</comment>
   * <strong>log10()</strong>
   * <strong>exp()</strong>
   * <strong>pow()</strong>
   * <strong>error_log()</strong>


id: log10
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>log()</strong>


id: log1p
type: function
doc:
<comment>Description:</comment>
  Возвращает log(1 + number), рассчитанный так, что результат точен,
     даже если значение number близко к нулю
    
  
  <strong>log1p()</strong> возвращает log(1 + <strong>$num</strong>), рассчитанное таким образом, что результат точен, даже когда
  значение <strong>$num</strong> близко к нулю. Из-за недостатка точности <strong>log()</strong> в этом случае может вернуть просто
  log(1).

<comment>Param:</comment>
  <info>float</info>  <strong>$num</strong>  Входное значение

<comment>Return:</comment>
  <info>float</info>  log(1 + <strong>$num</strong>)

<comment>See Also:</comment>
   * <strong>expm1()</strong>
   * <strong>log()</strong>
   * <strong>log10()</strong>


id: long2ip
type: function
doc:
<comment>Description:</comment>
  Конвертирует целое число в IPv4-адрес
  
  Функция <strong>long2ip()</strong> преобразует из представления в виде целого числа интернет-адреса в формат с
  точками (то есть aaa.bbb.ccc.ddd).

<comment>Param:</comment>
  <info>int</info>  <strong>$ip</strong>  Правильное представление адреса в виде целого числа.

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

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


id: lstat
type: function
doc:
<comment>Description:</comment>
  Возвращает информацию о файле или символической ссылке
  
  Собирает статистику на файл или символическую ссылку с именем <strong>$filename</strong>.

<comment>Param:</comment>
  <info>string</info>  <strong>$filename</strong>  Путь к файлу или символической ссылке.

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

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


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

<comment>Param:</comment>
  <info>string</info>  <strong>$string</strong>      Входная строка.
  <info>string</info>  <strong>$characters</strong>  С помощью параметра <strong>$characters</strong> можно также указать удаляемые символы. Просто
                       перечислите все символы, которые вы хотите удалить. Можно указать конструкцию
                       <return>..</return> для обозначения диапазона символов.

<comment>Return:</comment>
  <info>string</info>  Эта функция возвращает строку <strong>$string</strong> с удалёнными из начала строки пробелами. Если второй
          параметр не передан, <strong>ltrim()</strong> удаляет следующие символы:   " " (ASCII <return>32</return> (<return>0x20</return>)), обычный
          пробел.  "\t" (ASCII <return>9</return> (<return>0x09</return>)), символ табуляции.  "\n" (ASCII <return>10</return> (<return>0x0A</return>)), символ перевода
          строки.  "\r" (ASCII <return>13</return> (<return>0x0D</return>)), символ возврата каретки.  "\0" (ASCII <return>0</return> (<return>0x00</return>)),
          <return>NUL</return>-байт.  "\v" (ASCII <return>11</return> (<return>0x0B</return>)), вертикальная табуляция.
          
          " " (ASCII <return>32</return> (<return>0x20</return>)), обычный пробел.
          
          "\t" (ASCII <return>9</return> (<return>0x09</return>)), символ табуляции.
          
          "\n" (ASCII <return>10</return> (<return>0x0A</return>)), символ перевода строки.
          
          "\r" (ASCII <return>13</return> (<return>0x0D</return>)), символ возврата каретки.
          
          "\0" (ASCII <return>0</return> (<return>0x00</return>)), <return>NUL</return>-байт.
          
          "\v" (ASCII <return>11</return> (<return>0x0B</return>)), вертикальная табуляция.

<comment>See Also:</comment>
   * <strong>trim()</strong>
   * <strong>rtrim()</strong>


id: lzf_compress
type: function
doc:
<comment>Description:</comment>
  Сжатие LZF
    
  
  <strong>lzf_compress()</strong> сжимает строку данных <strong>$data</strong> используя алгоритм LZF.

<comment>Param:</comment>
  <info>string</info>  <strong>$data</strong>  Строка для сжатия.

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

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


id: lzf_decompress
type: function
doc:
<comment>Description:</comment>
  Разархивация LZF
    
  
  <strong>lzf_compress()</strong> разархивирует строку <strong>$data</strong>, содержащую данные сжатые алгоритмом lzf.

<comment>Param:</comment>
  <info>string</info>  <strong>$data</strong>  Строка со сжатыми данными.

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

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


id: lzf_optimized_for
type: function
doc:
<comment>Description:</comment>
  Определяет режим оптимизации модуля LZF
    
  
  Определяет, с какими настройками оптимизации скомпилирован модуль LZF.

<comment>Return:</comment>
  <info>int</info>  Возвращает 1, если LZF оптимизирован под скорость работы и 0, если под эффективность сжатия.


id: mail
type: function
doc:
<comment>Description:</comment>
  Отправляет электронную почту
  
  Отправляет электронную почту.

<comment>Param:</comment>
  <info>string</info>        <strong>$to</strong>                  Получатель, или получатели письма.
                                     
                                     Формат этого параметра должен соответствовать RFC 2822.
                                     Несколько примеров: user@example.comuser@example.com,
                                     anotheruser@example.comUser \<user@example.com&gt;User \<user@example.com&gt;, Another User \<anotheruser@example.com&gt;
  <info>string</info>        <strong>$subject</strong>             Тема отправляемого письма.
                                     
                                     Тема должна соответствовать RFC 2047.
  <info>string</info>        <strong>$message</strong>             Отправляемое сообщение.
                                     
                                     Каждая строка должна быть отделена символом CRLF (\r\n). Строки
                                     не должны быть длиннее 70 символов.
                                     
                                     (Только для Windows) Если PHP передаёт данные напрямую
                                     SMTP-серверу и в начале строки стоит точка, то она будет
                                     удалена. Чтобы избежать этого замените все такие точки на две.
                                     ]]>
  <info>array|string</info>  <strong>$additional_headers</strong>  Строка или массив, которые будут вставлены в конец отправляемых
                                     заголовков письма.
                                     
                                     Обычно используется для добавления дополнительных заголовков
                                     (From, Cc, and Bcc). Несколько дополнительных заголовков должны
                                     быть разделены CRLF (\r\n). Если для составления этого
                                     заголовка используются внешние данные, то они должны быть
                                     проверены для избежания инъекций нежелательных заголовков.
                                     
                                     Если передан массив, то его ключи будут именами заголовка, а
                                     значения значениями.
                                     
                                     До PHP 5.4.42 и 5.5.27, параметр <strong>$additional_headers</strong> не имел
                                     защиты от инъекции. Так что пользователи должны удостовериться,
                                     что передаваемые заголовки безопасны и содержат только
                                     заголовки. т.е. не содержат несколько переводов строк подряд,
                                     что стартует тело сообщения.
                                     
                                     При отправке письмо должно  содержать заголовок <return>From</return>. Он может
                                     быть установлен с помощью параметра <strong>$additional_headers</strong>, или
                                     значение по умолчанию может быть установлено в php.ini.
                                     
                                     Если заголовок отсутствует, будет сгенерировано сообщение об
                                     ошибке вида <return>Warning: mail(): "sendmail_from" not set in php.ini
                                     or custom "From:" header missing</return>. Заголовок <return>From</return> также
                                     определяет заголовок <return>Return-Path</return> при отправке напрямую через
                                     SMTP (только Windows).
                                     
                                     Если сообщения не отправляются, попробуйте использовать только
                                     LF (\n). Некоторые агенты пересылки сообщений Unix (особенно
                                     qmail) автоматически заменяют LF на CRLF (что приводит к
                                     двойному CR, если использовалось CRLF). Используйте эту меру в
                                     крайнем случае, так как это нарушает RFC 2822.
  <info>string</info>        <strong>$additional_params</strong>   Параметр <strong>$additional_params</strong>  может быть использован для
                                     передачи дополнительных флагов в виде аргументов командной
                                     строки для программы сконфигурированной для отправки писем,
                                     указанной директивой <return>sendmail_path</return>. Например, можно установить
                                     отправителя письма при использовании sendmail с помощью опции
                                     <return>-f</return>.
                                     
                                     Параметр автоматически экранируется функцией <strong>escapeshellcmd()</strong>,
                                     чтобы не допустить выполнение команд. Но <strong>escapeshellcmd()</strong>
                                     позволяет добавлять дополнительные параметры. В целях
                                     безопасности рекомендуется проверять и очищать этот параметр.
                                     
                                     Так как <strong>escapeshellcmd()</strong> применяется автоматически, то нельзя
                                     использовать некоторые символы, допустимые к использованию в
                                     email-адресах некоторыми RFC. <strong>mail()</strong> не допускает такие
                                     символы, поэтому в программах, в которых они требуются,
                                     рекомендуется использовать альтернативы для их отправки
                                     (например фреймворки или библиотеки).
                                     
                                     Пользователь, под которым работает веб-сервер должен быть
                                     добавлен в список доверенных в конфигурации sendmail для того
                                     чтобы избежать добавления заголовка 'X-Warning' при указании
                                     отправителя с помощью опции (-f). Для пользователей sendmail -
                                     это файл /etc/mail/trusted-users.

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

<comment>See Also:</comment>
   * <strong>mb_send_mail()</strong>
   * <strong>imap_mail()</strong>
   * PEAR::Mail
   * PEAR::Mail_Mime


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

<comment>Param:</comment>
  <info>resource</info>  <strong>$fp</strong>  Корректный указатель на файл, который должен быть перематываемым.

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


id: mailparse_msg_create
type: function
doc:
<comment>Description:</comment>
  Создаёт почтовый MIME-ресурс
  
  Создаёт почтовый <return>MIME</return>-ресурс.

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

<comment>See Also:</comment>
   * <strong>mailparse_msg_free()</strong>
   * <strong>mailparse_msg_parse_file()</strong>


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

<comment>Param:</comment>
  <info>resource</info>  <strong>$mimemail</strong>      Корректный <return>MIME</return>-ресурс
  <info>string</info>    <strong>$msgbody</strong>       
  <info>callable</info>  <strong>$callbackfunc</strong>  

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

<comment>See Also:</comment>
   * <strong>mailparse_msg_extract_part_file()</strong>
   * <strong>mailparse_msg_extract_whole_part_file()</strong>


id: mailparse_msg_extract_part_file
type: function
doc:
<comment>Description:</comment>
  Извлечь/декодировать секцию с сообщением из файла
  
  Извлечь/декодировать секцию с сообщением из указанного файла.
  
  Контент сообщения будет декодирован в соответствии с кодировкой пересылки. Поддерживаются
  следующие кодировки: base64, quoted-printable и uuencoded.

<comment>Param:</comment>
  <info>resource</info>  <strong>$mimemail</strong>      Корректный <return>MIME</return>-ресурс, созданный <strong>mailparse_msg_create()</strong>.
  <info>mixed</info>     <strong>$filename</strong>      Имя файла или корректный потоковый ресурс.
  <info>callable</info>  <strong>$callbackfunc</strong>  Если задано, то в эту функцию будет передано извлечённое сообщение. Если
                           <info>null</info>, то извлечённое сообщение будет просто возвращено.
                           
                           Если не задано, то контент будет направлен на стандартный вывод (stdout).

<comment>Return:</comment>
  <info>string</info>  Если <strong>$callbackfunc</strong> не <info>null</info>, то вернёт <info>true</info> в случае успешного выполнения.
          
          Если <strong>$callbackfunc</strong> задана как <info>null</info>, вернёт извлечённую секцию сообщения в виде строки.
          
          Вернёт <info>false</info> в случае возникновения ошибки.

<comment>See Also:</comment>
   * <strong>mailparse_msg_extract_part()</strong>
   * <strong>mailparse_msg_extract_whole_part_file()</strong>


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

<comment>Param:</comment>
  <info>resource</info>  <strong>$mimemail</strong>      Корректный <return>MIME</return>-ресурс
  <info>string</info>    <strong>$filename</strong>      
  <info>callable</info>  <strong>$callbackfunc</strong>  

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

<comment>See Also:</comment>
   * <strong>mailparse_msg_extract_part()</strong>
   * <strong>mailparse_msg_extract_part_file()</strong>


id: mailparse_msg_free
type: function
doc:
<comment>Description:</comment>
  Высвободить MIME-ресурс
  
  Высвобождает <return>MIME</return>-ресурс.

<comment>Param:</comment>
  <info>resource</info>  <strong>$mimemail</strong>  Корректный <return>MIME</return>-ресурс, созданный <strong>mailparse_msg_create()</strong> или
                       <strong>mailparse_msg_parse_file()</strong>.

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

<comment>See Also:</comment>
   * <strong>mailparse_msg_create()</strong>
   * <strong>mailparse_msg_parse_file()</strong>


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

<comment>Param:</comment>
  <info>resource</info>  <strong>$mimemail</strong>     Корректный <return>MIME</return>-ресурс.
  <info>string</info>    <strong>$mimesection</strong>  

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


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

<comment>Param:</comment>
  <info>resource</info>  <strong>$mimemail</strong>  Корректный <return>MIME</return>-ресурс.

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


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

<comment>Param:</comment>
  <info>resource</info>  <strong>$mimemail</strong>  Корректный <return>MIME</return>-ресурс.

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


id: mailparse_msg_parse
type: function
doc:
<comment>Description:</comment>
  Инкрементальное разбирает данные в буфер
  
  Инкрементальное разбирает данные в заданный MIME-ресурс.
  
  Функция позволяет обрабатывать файл по частям, вместо того, чтобы читать и обрабатывать сразу весь
  массив данных.

<comment>Param:</comment>
  <info>resource</info>  <strong>$mimemail</strong>  Корректный <return>MIME</return>-ресурс.
  <info>string</info>    <strong>$data</strong>      Сообщение, содержащееся в <strong>$filename</strong>, должно заканчиваться новой строкой
                       (<return>CRLF</return>); иначе последняя строка сообщения не будет проанализирована.

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


id: mailparse_msg_parse_file
type: function
doc:
<comment>Description:</comment>
  Разобрать файл
  
  Разбирает файл. Это оптимальный путь для разбора файла с почтовым сообщением.

<comment>Param:</comment>
  <info>string</info>  <strong>$filename</strong>  Путь к файлу. Файл будет открыт и пропущен через анализатор.
                     
                     Сообщение, содержащееся в <strong>$filename</strong>, должно заканчиваться новой строкой (<return>CRLF</return>);
                     иначе последняя строка сообщения не будет проанализирована.

<comment>Return:</comment>
  <info>resource</info>  Возвращает <return>MIME</return>-ресурс, представляющий структуру, или <info>false</info> в случае возникновения
            ошибки.

<comment>See Also:</comment>
   * <strong>mailparse_msg_free()</strong>
   * <strong>mailparse_msg_create()</strong>


id: mailparse_rfc822_parse_addresses
type: function
doc:
<comment>Description:</comment>
  Разобрать адреса в соответствии с RFC 822
  
  Разбирает список получателей в соответствии с RFC 822. Список получателей обычно находится в
  заголовке <return>To:</return>.

<comment>Param:</comment>
  <info>string</info>  <strong>$addresses</strong>  Строка, содержащая адреса. Например: <return>Wez Furlong \<wez@example.com&gt;, doe@example.com</return>
                      
                      Эта строка не должна содержать название заголовка.

<comment>Return:</comment>
  <info>array</info>  Возвращает ассоциативный массив для каждого получателя со следующими ключами: <return>display</return> Имя
         получателя. Если эта часть адреса не задана, то будет использовано то же значение, что и
         для <return>address</return>. <return>address</return>Адрес электронной почты<return>is_group</return><info>true</info>, если получатель является группой
         рассылки и <info>false</info>, если нет.


id: mailparse_stream_encode
type: function
doc:
<comment>Description:</comment>
  Кодирует поток из файла источника и пишет в файл получатель.
    
  
  Кодирует с помощью <strong>$encoding</strong> поток из файла источника и пишет в файл получатель.

<comment>Param:</comment>
  <info>resource</info>  <strong>$sourcefp</strong>  Корректный файловый дескриптор источника.
  <info>resource</info>  <strong>$destfp</strong>    Корректный файловый дескриптор получателя.
  <info>string</info>    <strong>$encoding</strong>  Одна из кодировок, поддерживаемых модулем mbstring.

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


id: mailparse_uudecode_all
type: function
doc:
<comment>Description:</comment>
  Сканирует данные из указанного файла и извлекает все вложенные файлы, кодированные в uuencode
    
  
  Сканирует данные из указанного файла и извлекает все вложенные файлы, кодированные в uuencode, во
  временные файлы.

<comment>Param:</comment>
  <info>resource</info>  <strong>$fp</strong>  Файловый дескриптор.

<comment>Return:</comment>
  <info>array</info>  Возвращает ассоциативный массив, содержащий информацию по извлечённым файлам. <return>filename</return>Путь
         к созданному временному файлу<return>origfilename</return>Оригинальное имя файла, только для кодированных
         uuencode Первый элемент будет содержать тело сообщения. Все последующие - информацию по
         извлечённым вложениям.


id: max
type: function
doc:
<comment>Description:</comment>
  Возвращает наибольшее значение
  
  Альтернативная сигнатура (не поддерживается с именованными аргументами):
  
  Если первый и единственный параметр — массив, то функция <strong>max()</strong> вернёт наибольшее значение из этого
  массива. Если переданы хотя бы два параметра, функция <strong>max()</strong> вернёт наибольший из них.
  
  Значения разных типов будут сравниваться в соответствии со стандартными правилами сравнения. К
  примеру, нечисловая строка (<info>string</info>) будет сравниваться с целым числом (<info>int</info>) так, как будто это <return>0</return>,
  а множество нечисловых строк (<info>string</info>) будут сравниваться алфавитно-цифровым порядком. Выбранное
  значение будет возвращено без конвертации типа.
  
  Соблюдают осторожность при передаче аргументов разных типов, поскольку результат функции <strong>max()</strong>
  может оказаться непредсказуемым.

<comment>Param:</comment>
  <info>mixed</info>  <strong>$value</strong>        Любое поддающееся сравнению значение.
  <info>mixed</info>  <strong>$values</strong>       Любые поддающиеся сравнению значения.
  <info>array</info>  <strong>$value_array</strong>  Массив, содержащий значения.

<comment>Return:</comment>
  <info>mixed</info>  Функция <strong>max()</strong> вернёт значение «наибольшего» из элементов массива, в соответствии со
         стандартными правилами сравнения. Если несколько разнотипных значений посчитаются
         идентичными  (например <return>0</return> и <return>'abc'</return>), функция вернёт первое из них.

<comment>See Also:</comment>
   * <strong>min()</strong>
   * <strong>count()</strong>


id: mb_check_encoding
type: function
doc:
<comment>Description:</comment>
  Проверяет, что кодировка строк выбрана верно
  
  Проверяет, что для потока данных подходит выбранная кодировка. Если <strong>$value</strong> является массивом
  (<info>array</info>), все ключи и значения проверяются рекурсивно. Функция может быть полезной для
  предотвращения так называемой "Атаки неправильной кодировкой".

<comment>Param:</comment>
  <info>array|string|null</info>  <strong>$value</strong>     Поток данных или массив (<info>array</info>) для проверки. Если не задан, функция
                                проверит все входные данные с начала запроса.
                                
                                Начиная с PHP 8.1.0, опускание этого параметра или передача <info>null</info>
                                устарело.
  <info>string|null</info>        <strong>$encoding</strong>  Ожидаемая кодировка.

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


id: mb_chr
type: function
doc:
<comment>Description:</comment>
  Возвращает символ по значению кодовой точки Unicode
  
  Возвращает строку, содержащую символ, указанный значением кодовой точки Unicode, закодированный в
  указанной кодировке.
  
  Функция дополняет <strong>mb_ord()</strong>.

<comment>Param:</comment>
  <info>int</info>          <strong>$codepoint</strong>  Значение кодовой точки Unicode, например <return>128024</return> для U+1F418 ELEPHANT
  <info>string|null</info>  <strong>$encoding</strong>   Параметр <strong>$encoding</strong>
                           представляет собой символьную кодировку. Если он опущен или равен <info>null</info>,
                           вместо него будет использовано значение внутренней кодировки.

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

<comment>See Also:</comment>
   * <strong>mb_internal_encoding()</strong>
   * <strong>mb_ord()</strong>
   * <strong>IntlChar::ord()</strong>
   * <strong>chr()</strong>


id: mb_convert_case
type: function
doc:
<comment>Description:</comment>
  Производит смену регистра символов в строке
    
  
  Производит смену регистра символов в строке (<info>string</info>) в соответствии с режимом <strong>$mode</strong>.

<comment>Param:</comment>
  <info>string</info>       <strong>$string</strong>    Строка (<info>string</info>) для преобразования.
  <info>int</info>          <strong>$mode</strong>      Режим смены регистра. Это может быть одна из констант <info>MB_CASE_UPPER</info>,
                          <info>MB_CASE_LOWER</info>, <info>MB_CASE_TITLE</info>, <info>MB_CASE_FOLD</info>, <info>MB_CASE_UPPER_SIMPLE</info>,
                          <info>MB_CASE_LOWER_SIMPLE</info>, <info>MB_CASE_TITLE_SIMPLE</info> или <info>MB_CASE_FOLD_SIMPLE</info>.
  <info>string|null</info>  <strong>$encoding</strong>  Параметр <strong>$encoding</strong>
                          представляет собой символьную кодировку. Если он опущен или равен <info>null</info>,
                          вместо него будет использовано значение внутренней кодировки.

<comment>Return:</comment>
  <info>string</info>  Строка <strong>$string</strong>, преобразованная в соответствии с режимом <strong>$mode</strong>.

<comment>See Also:</comment>
   * <strong>mb_strtolower()</strong>
   * <strong>mb_strtoupper()</strong>
   * <strong>strtolower()</strong>
   * <strong>strtoupper()</strong>
   * <strong>ucfirst()</strong>
   * <strong>ucwords()</strong>


id: mb_convert_encoding
type: function
doc:
<comment>Description:</comment>
  Преобразует строку из одной кодировки символов в другую
  
  Преобразует параметр <strong>$string</strong> из кодировки <strong>$from_encoding</strong> или текущей внутренней кодировки в
  <strong>$to_encoding</strong>. Также можно указать необязательный параметр <strong>$from_encoding</strong>. Если <strong>$string</strong> является
  массивом (<info>array</info>), все его строковые (<info>string</info>) значения будут преобразованы рекурсивно.

<comment>Param:</comment>
  <info>array|string</info>       <strong>$string</strong>         Строка (<info>string</info>) или массив (<info>array</info>), для преобразования.
  <info>string</info>             <strong>$to_encoding</strong>    Требуемая кодировка результата.
  <info>array|string|null</info>  <strong>$from_encoding</strong>  Текущая кодировка, используемая для интерпретации строки
                                     <strong>$string</strong>. Несколько кодировок могут быть указаны в виде массива
                                     (<info>array</info>) или в виде строки через запятую, в этом случае
                                     правильная кодировка будет определена по тому же алгоритму, что
                                     и в функции <strong>mb_detect_encoding()</strong>.
                                     
                                     Если параметр <strong>$from_encoding</strong> опущен или равен <info>null</info>, то будет
                                     использоваться mbstring.internal_encoding setting, если она
                                     установлена, иначе кодировка по умолчанию.
                                     
                                     Допустимые значения <strong>$to_encoding</strong> и <strong>$from_encoding</strong> указаны на
                                     странице поддерживаемые кодировки.

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

<comment>See Also:</comment>
   * <strong>mb_detect_order()</strong>
   * UConverter::transcode
   * <strong>iconv()</strong>


id: mb_convert_kana
type: function
doc:
<comment>Description:</comment>
  Преобразует одну кодировку "kana" в другую ("zen-kaku", "han-kaku" и другие)
  
  Производит преобразование "han-kaku" - "zen-kaku" для строкового аргумента <strong>$string</strong>. Эта функция
  может быть полезной только для японского языка.

<comment>Param:</comment>
  <info>string</info>       <strong>$string</strong>    Исходная строка (<info>string</info>).
  <info>string</info>       <strong>$mode</strong>      Настройка конвертации.
                          
                          Задаётся комбинацией следующих настроек. Возможные настройки
                          преобразованияНастройкаОписание<return>r</return> Преобразование "zen-kaku" букв в
                          "han-kaku" <return>R</return> Преобразование "han-kaku" букв в "zen-kaku" <return>n</return> Преобразование
                          "zen-kaku" чисел в "han-kaku" <return>N</return> Преобразование "han-kaku" чисел в
                          "zen-kaku" <return>a</return> Преобразование "zen-kaku" букв и чисел в "han-kaku" <return>A</return>
                          Преобразование "han-kaku" букв и чисел в "zen-kaku" (Для настроек "a", "A"
                          символы берутся из диапазона U+0021 - U+007E, исключая U+0022, U+0027,
                          U+005C, U+007E) <return>s</return> Преобразование "zen-kaku" пробела в "han-kaku" (U+3000
                          -&gt; U+0020) <return>S</return> Преобразование "han-kaku" пробела в "zen-kaku" (U+0020
                          -&gt; U+3000) <return>k</return> Преобразование "zen-kaku kata-kana" в "han-kaku kata-kana"
                          <return>K</return> Преобразование "han-kaku kata-kana" в "zen-kaku kata-kana" <return>h</return>
                          Преобразование "zen-kaku hira-gana" в "han-kaku kata-kana" <return>H</return>
                          Преобразование "han-kaku kata-kana" в "zen-kaku hira-gana" <return>c</return>
                          Преобразование "zen-kaku kata-kana" в "zen-kaku hira-gana" <return>C</return>
                          Преобразование "zen-kaku hira-gana" в "zen-kaku kata-kana" <return>V</return> Производит
                          свёртку фонем и преобразует их в символ. Используется с "K","H"
  <info>string|null</info>  <strong>$encoding</strong>  Параметр <strong>$encoding</strong>
                          представляет собой символьную кодировку. Если он опущен или равен <info>null</info>,
                          вместо него будет использовано значение внутренней кодировки.

<comment>Return:</comment>
  <info>string</info>  Преобразованная строка (<info>string</info>).


id: mb_convert_variables
type: function
doc:
<comment>Description:</comment>
  Преобразует символы в переменной(-ых) из одной кодировки в другую
    
  
  Конвертирует символы в переменных <strong>$var</strong> и <strong>$vars</strong> из кодировки <strong>$from_encoding</strong> в кодировку
  <strong>$to_encoding</strong>.
  
  <strong>mb_convert_variables()</strong> объединяет строки из массива или объекта для определения их кодировки, так
  как в случае коротких строк определить кодировку зачастую не удаётся. Вследствие этого,
  недопустимо помещать в один массив или объект строки в разных кодировках.

<comment>Param:</comment>
  <info>string</info>        <strong>$to_encoding</strong>    Кодировка, в которую необходимо перекодировать строку (<info>string</info>).
  <info>array|string</info>  <strong>$from_encoding</strong>  <strong>$from_encoding</strong> задаётся в виде массива (<info>array</info>) или строки (<info>string</info>) с
                                разделёнными запятой кодировками. Функция попытается определить
                                кодировку исходной строки на основе списка возможных кодировок в
                                аргументе <strong>$from-coding</strong>. Если <strong>$from_encoding</strong> опущен, используется
                                <return>detect_order</return>.
  <info>mixed</info>         <strong>$var</strong>            <strong>$var</strong> - ссылка на переменную, содержимое которой необходимо
                                преобразовать. Это может быть строка, массив или объект.
                                <strong>mb_convert_variables()</strong> принимает, что все эти аргументы имеют
                                одинаковую кодировку.
  <info>mixed</info>         <strong>$vars</strong>           Дополнительные <strong>$var</strong>.

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


id: mb_decode_mimeheader
type: function
doc:
<comment>Description:</comment>
  Декодирует строку в MIME-заголовке
  
  Декодирует закодированную строку (<info>string</info>) <strong>$string</strong> в MIME-заголовке.

<comment>Param:</comment>
  <info>string</info>  <strong>$string</strong>  Строка (<info>string</info>) для декодирования.

<comment>Return:</comment>
  <info>string</info>  Декодированная строка (<info>string</info>) во внутренней кодировке скрипта.

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


id: mb_decode_numericentity
type: function
doc:
<comment>Description:</comment>
  Декодирует ссылку на числовую строку HTML в символ
  
  Преобразует строку чисел <strong>$string</strong> (<info>string</info>) в заданном блоке в символ.

<comment>Param:</comment>
  <info>string</info>       <strong>$string</strong>    Строка (<info>string</info>) для декодирования.
  <info>array</info>        <strong>$map</strong>       <strong>$map</strong> - массив (<info>array</info>), который задаёт диапазон кодов символов.
  <info>string|null</info>  <strong>$encoding</strong>  Параметр <strong>$encoding</strong>
                          представляет собой символьную кодировку. Если он опущен или равен <info>null</info>,
                          вместо него будет использовано значение внутренней кодировки.
  <info></info>             <strong>$is_hex</strong>    Параметр не используется.

<comment>Return:</comment>
  <info>string</info>  Преобразованная строка (<info>string</info>).

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


id: mb_detect_encoding
type: function
doc:
<comment>Description:</comment>
  Определение кодировки символов
  
  Определяет наиболее вероятную кодировку символов для строки (<info>string</info>) <strong>$string</strong> из упорядоченного
  списка кандидатов.
  
  Автоматическое определение предполагаемой кодировки символов не может быть полностью надёжным; без
  дополнительной информации это похоже на расшифровку зашифрованной строки без ключа. Всегда
  предпочтительно использовать индикацию кодировки символов, хранящуюся или передаваемую с данными,
  такую как HTTP-заголовок "Content-Type".
  
  Функция наиболее полезна с многобайтовыми кодировками, когда не все последовательности байтов
  образуют допустимую строку. Если входная строка содержит такую последовательность, эта кодировка
  будет отклонена, и будет проверена следующая кодировка.

<comment>Param:</comment>
  <info>string</info>             <strong>$string</strong>     Проверяемая строка (<info>string</info>).
  <info>array|string|null</info>  <strong>$encodings</strong>  Упорядоченный список кодировок символов. Список может быть указан
                                 как массив строк или как строка кодировок, разделённых запятыми.
                                 
                                 Если <strong>$encodings</strong> не задан или является <info>null</info>, будет использоваться
                                 текущий detect_order (установленный с помощью параметра
                                 конфигурации mbstring.detect_order или функции <strong>mb_detect_order()</strong>).
  <info>bool</info>               <strong>$strict</strong>     Управляет поведением, когда <strong>$string</strong> недопустима ни в одной из
                                 перечисленных <strong>$encodings</strong>. Если для <strong>$strict</strong> установлено значение
                                 <info>false</info>, будет возвращена наиболее подходящая кодировка; если для
                                 <strong>$strict</strong> установлено значение <info>true</info>, будет возвращено <info>false</info>.
                                 
                                 Значение по умолчанию для <strong>$strict</strong> можно установить с помощью
                                 параметра конфигурации mbstring.strict_detection.

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

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


id: mb_detect_order
type: function
doc:
<comment>Description:</comment>
  Установка/получение списка кодировок для механизмов определения кодировки
    
  
  В <strong>$encoding</strong> задаётся порядок, в котором механизмы автоматического определения кодировок будут их
  проверять.

<comment>Param:</comment>
  <info>array|string|null</info>  <strong>$encoding</strong>  <strong>$encoding</strong> - массив (<info>array</info>) или строка, в которой перечислены
                                кодировки через запятую. Смотрите Поддерживаемые кодировки.
                                
                                Если <strong>$encoding</strong> опущен, функция вернёт текущий список кодировок в
                                виде массива.
                                
                                Эта настройка влияет на работу функций <strong>mb_detect_encoding()</strong> и
                                <strong>mb_send_mail()</strong>.
                                
                                В <return>mbstring</return> на данный момент реализованы следующие фильтры для
                                определения кодировок. Если последовательность байт в исходной
                                строке не будет соответствовать ни одной из перечисленных кодировок,
                                определение кодировки завершится неудачей.
                                
                                <return>UTF-8</return>, <return>UTF-7</return>, <return>ASCII</return>, <return>EUC-JP</return>,<return>SJIS</return>, <return>eucJP-win</return>, <return>SJIS-win</return>, <return>JIS</return>,
                                <return>ISO-2022-JP</return>
                                
                                Кодировку <return>ISO-8859-*</return>, <return>mbstring</return> всегда определяет как <return>ISO-8859-*</return>.
                                
                                Для кодировок <return>UTF-16</return>, <return>UTF-32</return>, <return>UCS2</return> и <return>UCS4</return> автоматическое определение
                                всегда будет завершаться неудачей.

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

<comment>See Also:</comment>
   * <strong>mb_internal_encoding()</strong>
   * <strong>mb_http_input()</strong>
   * <strong>mb_http_output()</strong>
   * <strong>mb_send_mail()</strong>


id: mb_encode_mimeheader
type: function
doc:
<comment>Description:</comment>
  Кодирует строку для MIME-заголовка
  
  Кодирует строку (<strong>$string</strong>) (<info>string</info>) по схеме кодирования MIME-заголовка.

<comment>Param:</comment>
  <info>string</info>       <strong>$string</strong>             Кодируемая строка типа <info>string</info>. Её кодировка должна
                                   соответствовать <strong>mb_internal_encoding()</strong>.
  <info>string|null</info>  <strong>$charset</strong>            <strong>$charset</strong> задаёт имя кодировки, в котором представлена строка
                                   <strong>$string</strong>. По умолчанию значение определяется настройкой NLS
                                   (<return>mbstring.language</return>).
  <info>string|null</info>  <strong>$transfer_encoding</strong>  <strong>$transfer_encoding</strong> задаёт схему MIME-кодирования. Это может быть
                                   либо <return>"B"</return> (Base64), либо <return>"Q"</return> (Quoted-Printable). По умолчанию <return>"B"</return>.
  <info>string</info>       <strong>$newline</strong>            <strong>$newline</strong> задаёт метку EOL (конец строки, end-of-line), с помощью
                                   которой <strong>mb_encode_mimeheader()</strong> осуществляет завершение строк
                                   ("line-folding" - термин RFC, означающий разделение строк, длина
                                   которых превышает заданное значение. Значение длины на данный
                                   момент жёстко задано как 74 символа). По умолчанию <return>"\r\n"</return> (CRLF).
  <info>int</info>          <strong>$indent</strong>             Отступ первой строки (число символов в заголовке перед <strong>$string</strong>).

<comment>Return:</comment>
  <info>string</info>  Конвертированная строка (<info>string</info>), преобразованная в ASCII.

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


id: mb_encode_numericentity
type: function
doc:
<comment>Description:</comment>
  Кодирует символ в числовую HTML-ссылку
  
  Преобразует заданные коды символов в строке (<info>string</info>) <strong>$string</strong> из кодов в числовые HTML-ссылки.

<comment>Param:</comment>
  <info>string</info>       <strong>$string</strong>    Кодируемая строка (<info>string</info>).
  <info>array</info>        <strong>$map</strong>       <strong>$map</strong> - массив, задающий диапазон кодов.
  <info>string|null</info>  <strong>$encoding</strong>  Параметр <strong>$encoding</strong>
                          представляет собой символьную кодировку. Если он опущен или равен <info>null</info>,
                          вместо него будет использовано значение внутренней кодировки.
  <info>bool</info>         <strong>$hex</strong>       Должна ли возвращаемая сущность быть представлена в шестнадцатеричной
                          нотации (иначе в десятичной)

<comment>Return:</comment>
  <info>string</info>  Сконвертированная строка (<info>string</info>).

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


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

<comment>Param:</comment>
  <info>string</info>  <strong>$encoding</strong>  Кодировка, для которой ищутся псевдонимы.

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

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


id: mb_ereg
type: function
doc:
<comment>Description:</comment>
  Совпадение с регулярным выражением с поддержкой многобайтовых кодировок
  
  Выполняет поиск совпадения с регулярным выражением с поддержкой многобайтовых кодировок.

<comment>Param:</comment>
  <info>string</info>  <strong>$pattern</strong>  Шаблон поиска.
  <info>string</info>  <strong>$string</strong>   Строка (<info>string</info>), в которой производится поиск.
  <info>array</info>   <strong>$matches</strong>  Если найдены совпадения для подстроки в скобках шаблона <strong>$pattern</strong> и функция
                    вызвана с третьим аргументом <strong>$matches</strong>, совпадения будут сохранены в массиве
                    <strong>$matches</strong>. Если подобных совпадений найдено не будет, то <strong>$matches</strong> установится как
                    пустой массив.
                    
                    $matches[1] будет содержать первую слева подстроку в скобках; $matches[2] -
                    вторую, и так далее. $matches[0] будет содержать копию всей строки.

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

<comment>See Also:</comment>
   * <strong>mb_regex_encoding()</strong>
   * <strong>mb_eregi()</strong>


id: mb_ereg_match
type: function
doc:
<comment>Description:</comment>
  Совпадение с регулярным выражением для многобайтовой строки
  
  Совпадение с регулярным выражением для многобайтовой строки. <strong>$pattern</strong> сопоставляется только в
  начале <strong>$string</strong>.
  
  <strong>$pattern</strong> сопоставляется только в начале <strong>$string</strong>.

<comment>Param:</comment>
  <info>string</info>       <strong>$pattern</strong>  Шаблон регулярного выражения.
  <info>string</info>       <strong>$string</strong>   Оцениваемая строка (<info>string</info>).
  <info>string|null</info>  <strong>$options</strong>  Опция поиска. Подробнее смотрите <strong>mb_regex_set_options()</strong>.

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

<comment>See Also:</comment>
   * <strong>mb_regex_encoding()</strong>
   * <strong>mb_ereg()</strong>


id: mb_ereg_replace
type: function
doc:
<comment>Description:</comment>
  Осуществляет замену по регулярному выражению с поддержкой многобайтовых кодировок
  
  Сканирует строку <strong>$string</strong> для поиска совпадений с <strong>$pattern</strong>, затем заменяет совпавший текст на
  <strong>$replacement</strong>

<comment>Param:</comment>
  <info>string</info>       <strong>$pattern</strong>      Шаблон регулярного выражения.
                             
                             В <strong>$pattern</strong> могут использоваться многобайтовые символы.
  <info>string</info>       <strong>$replacement</strong>  Текст замены.
  <info>string</info>       <strong>$string</strong>       Проверяемая строка (<info>string</info>).
  <info>string|null</info>  <strong>$options</strong>      Опция поиска. Подробнее смотрите <strong>mb_regex_set_options()</strong>.

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

<comment>See Also:</comment>
   * <strong>mb_regex_encoding()</strong>
   * <strong>mb_eregi_replace()</strong>


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

<comment>Param:</comment>
  <info>string</info>       <strong>$pattern</strong>   Шаблон регулярного выражения.
                          
                          Мультибайтовые символы могут использоваться в <strong>$pattern</strong>.
  <info>callable</info>     <strong>$callback</strong>  Функция, которая будет вызвана для получения и передачи массива совпадений
                          в строку <strong>$subject</strong>. Callback-функция должна возвращать строку для замены.
                          
                          Часто может потребоваться объявлять функцию <strong>$callback</strong> для
                          <strong>mb_ereg_replace_callback()</strong> только в одном месте. В таком случае
                          используйте анонимные функции для определения callback-функции внутри
                          вызова <strong>mb_ereg_replace_callback()</strong>. При таком подходе у вас будет вся
                          информация про вызов в одном месте и вы не загрязните пространство имён
                          функции именем своей callback-функции, которое больше нигде не
                          используется.
  <info>string</info>       <strong>$string</strong>    Строка (<info>string</info>) для проверки.
  <info>string|null</info>  <strong>$options</strong>   Опция поиска. Подробнее смотрите <strong>mb_regex_set_options()</strong>.

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

<comment>See Also:</comment>
   * <strong>mb_regex_encoding()</strong>
   * <strong>mb_ereg_replace()</strong>
   * Анонимные функции


id: mb_ereg_search
type: function
doc:
<comment>Description:</comment>
  Поиск соответствий регулярному выражению для строк в многобайтовых кодировках
    
  
  Выполняет поиск соответствий регулярному выражению в многобайтовой строке.

<comment>Param:</comment>
  <info>string|null</info>  <strong>$pattern</strong>  Шаблон для поиска, текст регулярного выражения.
  <info>string|null</info>  <strong>$options</strong>  Опция поиска. Подробнее смотрите <strong>mb_regex_set_options()</strong>.

<comment>Return:</comment>
  <info>bool</info>  <strong>mb_ereg_search()</strong> возвращает <info>true</info>, если многобайтная строка соответствует регулярному
        выражению, либо <info>false</info> в противном случае. Строка (<info>string</info>) для поиска соответствий задаётся
        функцией <strong>mb_ereg_search_init()</strong>. Если аргумент <strong>$pattern</strong> не задан, будет использовано
        предыдущее выражение.

<comment>See Also:</comment>
   * <strong>mb_regex_encoding()</strong>
   * <strong>mb_ereg_search_init()</strong>


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

<comment>Return:</comment>
  <info>int</info>  <strong>mb_ereg_search_getpos()</strong> возвращает начальную позицию следующего совпадения с регулярным
       выражением для функций <strong>mb_ereg_search()</strong>, <strong>mb_ereg_search_pos()</strong>, <strong>mb_ereg_search_regs()</strong>. Позиция
       представляется в виде числа байт с начала строки.

<comment>See Also:</comment>
   * <strong>mb_regex_encoding()</strong>
   * <strong>mb_ereg_search_setpos()</strong>


id: mb_ereg_search_getregs
type: function
doc:
<comment>Description:</comment>
  Выводит результат последнего сравнения с регулярным выражением
    
  
  Получение результата выполнения функций сравнения многобайтных строк с регулярным выражением

<comment>Return:</comment>
  <info>array|false</info>  Массив (<info>array</info>) содержащий совпавшие с регулярным выражением подстроки в результате
               выполнения функций <strong>mb_ereg_search()</strong>, <strong>mb_ereg_search_pos()</strong>, <strong>mb_ereg_search_regs()</strong>.
               Если совпадений несколько, то первый элемент будет содержать совпавшую подстроку,
               второй будет содержать первую часть в квадратных скобках, третий элемент будет
               содержать вторую часть в квадратных скобках и так далее. Функция вернёт <info>false</info> в
               случае возникновения ошибки.

<comment>See Also:</comment>
   * <strong>mb_regex_encoding()</strong>
   * <strong>mb_ereg_search_init()</strong>


id: mb_ereg_search_init
type: function
doc:
<comment>Description:</comment>
  Инициализация поиска соответствий регулярному выражению многобайтовой
     строкой и текстом регулярного выражения
    
  
  <strong>mb_ereg_search_init()</strong> задаёт значения параметров <strong>$string</strong> и <strong>$pattern</strong> для функций регулярных
  выражений. Эти значения будут использоваться в функциях <strong>mb_ereg_search()</strong>, <strong>mb_ereg_search_pos()</strong> и
  <strong>mb_ereg_search_regs()</strong>.

<comment>Param:</comment>
  <info>string</info>       <strong>$string</strong>   Строка, в которой будет осуществляться поиск соответствий.
  <info>string|null</info>  <strong>$pattern</strong>  Шаблон, регулярное выражение.
  <info>string|null</info>  <strong>$options</strong>  Опция поиска. Подробнее смотрите <strong>mb_regex_set_options()</strong>.

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

<comment>See Also:</comment>
   * <strong>mb_regex_encoding()</strong>
   * <strong>mb_ereg_search_regs()</strong>


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

<comment>Param:</comment>
  <info>string|null</info>  <strong>$pattern</strong>  Шаблон, текст регулярного выражения.
  <info>string|null</info>  <strong>$options</strong>  Опция поиска. Подробнее смотрите <strong>mb_regex_set_options()</strong>.

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

<comment>See Also:</comment>
   * <strong>mb_regex_encoding()</strong>
   * <strong>mb_ereg_search_init()</strong>


id: mb_ereg_search_regs
type: function
doc:
<comment>Description:</comment>
  Возвращает совпавшую с регулярным выражением часть строки
    
  
  Возвращает совпавшую с регулярным выражением часть строки.

<comment>Param:</comment>
  <info>string|null</info>  <strong>$pattern</strong>  Шаблон, текст регулярного выражения.
  <info>string|null</info>  <strong>$options</strong>  Опция поиска. Подробнее смотрите <strong>mb_regex_set_options()</strong>.

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

<comment>See Also:</comment>
   * <strong>mb_regex_encoding()</strong>
   * <strong>mb_ereg_search_init()</strong>


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

<comment>Param:</comment>
  <info>int</info>  <strong>$offset</strong>  Устанавливаемая позиция. Если значение отрицательно, отсчёт идёт с конца строки.

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

<comment>See Also:</comment>
   * <strong>mb_regex_encoding()</strong>
   * <strong>mb_ereg_search_init()</strong>


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

<comment>Param:</comment>
  <info>string</info>  <strong>$pattern</strong>  Шаблон, текст регулярного выражения.
  <info>string</info>  <strong>$string</strong>   Строка (<info>string</info>), в которой производится поиск.
  <info>array</info>   <strong>$matches</strong>  Если найдены совпадения для подстроки <strong>$pattern</strong>, заключённой в скобки, и функция
                    вызвана с заданным третьим аргументом <strong>$matches</strong>, эти совпадения будут сохранены в
                    массиве <strong>$matches</strong>. Если подобных совпадений не найдено, <strong>$matches</strong> установится как
                    пустой массив.
                    
                    $matches[1] будет содержать первую (слева) подстроку заключённую в скобки;
                    $regs[2] - вторую, и так далее. $matches[0] будет содержать копию всей найденной
                    строки.

<comment>Return:</comment>
  <info>bool</info>  Возвращает <info>true</info> если совпадение шаблона <strong>$pattern</strong> найдено в <strong>$string</strong>, или <info>false</info>, если
        совпадения не найдены.

<comment>See Also:</comment>
   * <strong>mb_regex_encoding()</strong>
   * <strong>mb_ereg()</strong>


id: mb_eregi_replace
type: function
doc:
<comment>Description:</comment>
  Осуществляет замену по регулярному выражению с поддержкой многобайтовых символов без учёта
  регистра
  
  Сканирует строку <strong>$string</strong> для поиска совпадений с <strong>$pattern</strong>, затем заменяет совпавший текст на
  <strong>$replacement</strong>.

<comment>Param:</comment>
  <info>string</info>       <strong>$pattern</strong>      Шаблон регулярного выражения. Могут использоваться многобайтовые
                             символы. Регистр будет игнорироваться.
  <info>string</info>       <strong>$replacement</strong>  Текст замены.
  <info>string</info>       <strong>$string</strong>       Строка (<info>string</info>) для поиска.
  <info>string|null</info>  <strong>$options</strong>      Опция поиска. Подробнее смотрите <strong>mb_regex_set_options()</strong>.

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

<comment>See Also:</comment>
   * <strong>mb_regex_encoding()</strong>
   * <strong>mb_ereg_replace()</strong>


id: mb_get_info
type: function
doc:
<comment>Description:</comment>
  Получает внутренние настройки mbstring
  
  <strong>mb_get_info()</strong> возвращает внутренние параметры настроек mbstring.

<comment>Param:</comment>
  <info>string</info>  <strong>$type</strong>  Если <strong>$type</strong> не указан, или указан как <return>"all"</return>, будет возвращён массив (<info>array</info>),
                 содержащий элементы <return>"internal_encoding"</return>, <return>"http_input"</return>, <return>"http_output"</return>,
                 <return>"http_output_conv_mimetypes"</return>, <return>"mail_charset"</return>, <return>"mail_header_encoding"</return>,
                 <return>"mail_body_encoding"</return>, <return>"illegal_chars"</return>, <return>"encoding_translation"</return>, <return>"language"</return>,
                 <return>"detect_order"</return>, <return>"substitute_character"</return> и <return>"strict_detection"</return>.
                 
                 Если <strong>$type</strong> указан как <return>"internal_encoding"</return>, <return>"http_input"</return>, <return>"http_output"</return>,
                 <return>"http_output_conv_mimetypes"</return>, <return>"mail_charset"</return>, <return>"mail_header_encoding"</return>,
                 <return>"mail_body_encoding"</return>, <return>"illegal_chars"</return>, <return>"encoding_translation"</return>, <return>"language"</return>,
                 <return>"detect_order"</return>, <return>"substitute_character"</return> или <return>"strict_detection"</return>, будет возвращена
                 настройка указанного параметра.

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

<comment>See Also:</comment>
   * <strong>mb_regex_encoding()</strong>
   * <strong>mb_http_output()</strong>


