# php_manual

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

<comment>Param:</comment>
  <info>array|object</info>  <strong>$array</strong>  Массив. Передаётся по ссылке, потому что он модифицируется данной функцией.
                        Это означает, что необходимо передать его как реальную переменную, а не как
                        функцию, возвращающую массив, так как по ссылке можно передавать только
                        фактические переменные.

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

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


id: enum_exists
type: function
doc:
<comment>Description:</comment>
  Проверяет, определено ли перечисление
  
  Функция проверяет, определено ли данное перечисление.

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

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

<comment>See Also:</comment>
   * <strong>function_exists()</strong>
   * <strong>class_exists()</strong>
   * <strong>interface_exists()</strong>
   * <strong>get_declared_classes()</strong>


id: error_clear_last
type: function
doc:
<comment>Description:</comment>
  Очистить самую последнюю ошибку

<comment>Return:</comment>
  <info>void</info>  Очищает самую последнюю ошибку, делая невозможным получение её с помощью <strong>error_get_last()</strong>.

<comment>See Also:</comment>
   * Константы ошибок


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

<comment>Return:</comment>
  <info>array|null</info>  Возвращает ассоциативный массив с описанием последней произошедшей ошибки. Ключи
              массива: "type", "message", "file" и "line". Если ошибка произошла во внутренней
              функции PHP, элемент с ключом "message" будет начинаться с имени этой функции.
              Возвращает <info>null</info>, если ошибок ещё не произошло.

<comment>See Also:</comment>
   * Константы ошибок
   * Переменная $php_errormsg
   * <strong>error_clear_last()</strong>
   * Директива <strong>$display_errors</strong>
   * Директива <strong>$html_errors</strong>
   * Директива <strong>$xmlrpc_errors</strong>


id: error_log
type: function
doc:
<comment>Description:</comment>
  Отправляет сообщение об ошибке заданному обработчику ошибок
  
  Отправляет сообщение об ошибке в лог веб-сервера или в пользовательский файл.

<comment>Param:</comment>
  <info>string</info>       <strong>$message</strong>             Сообщение об ошибке, которое должно быть логировано.
  <info>int</info>          <strong>$message_type</strong>        Определяет куда отправлять ошибку. Возможны следующие значения:
                                    
                                    Типы журналов <strong>error_log()</strong>0 Сообщение <strong>$message</strong> отправляется в
                                    системный регистратор PHP, используя механизм логирования
                                    операционной системы, или файл, в зависимости от значения
                                    директивы error_log в конфигурационном файле.  Это значение по
                                    умолчанию. 1 Сообщение <strong>$message</strong> отправляется электронной почтой
                                    на адрес, установленный в параметре <strong>$destination</strong>.  Это
                                    единственный тип сообщения, где используется четвёртый параметр
                                    <strong>$additional_headers</strong>. 2 Больше не используется. 3<strong>$message</strong>
                                    применяется к указанному в <strong>$destination</strong> файлу. Перенос строки
                                    автоматически не добавляется в конец <strong>$message</strong>. 4 Сообщение
                                    <strong>$message</strong> отправляется напрямую в обработчик логера SAPI.
  <info>string|null</info>  <strong>$destination</strong>         Назначение. Устанавливается в зависимости от параметра
                                    <strong>$message_type</strong>.
  <info>string|null</info>  <strong>$additional_headers</strong>  Дополнительные заголовки. Используется, когда значение параметра
                                    <strong>$message_type</strong> - <return>1</return>. Данный тип сообщения использует ту же
                                    внутреннюю функцию, что и <strong>mail()</strong>.

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


id: error_reporting
type: function
doc:
<comment>Description:</comment>
  Задаёт, какие ошибки PHP попадут в отчёт
    
  
  Функция <strong>error_reporting()</strong> задаёт значение директивы error_reporting во время выполнения. В PHP
  есть много уровней ошибок. Используя эту функцию, можно задать уровень ошибок времени выполнения
  скрипта, которые попадут в отчёт. Если необязательный аргумент <strong>$error_level</strong> не задан,
  <strong>error_reporting()</strong> вернёт текущее значение уровня протоколирования ошибок.

<comment>Param:</comment>
  <info>int|null</info>  <strong>$error_level</strong>  Новое значение уровня error_reporting. Это может быть битовая маска или
                          именованные константы. При использовании именованных констант нужно будет
                          следить за совместимостью с новыми версиями PHP. В новых версиях могут
                          добавиться новые уровни ошибок, увеличиться диапазон целочисленных типов.
                          Все это может привести к нестабильной работе при использовании старых
                          целочисленных обозначений уровней ошибок.
                          
                          Доступные константы уровней ошибок и их описания приведены в разделе
                          Предопределённые константы.

<comment>Return:</comment>
  <info>int</info>  Функция возвращает значение директивы error_reporting, которое в ней хранилось до того, как
       оно было изменено на значение параметра <strong>$error_level</strong>.
       
       Оператор управления ошибками (<return>@</return>) изменяет значение параметра <strong>$error_level</strong> во время обработки
       ошибки.

<comment>See Also:</comment>
   * Директива display_errors
   * Директива html_errors
   * Директива xmlrpc_errors
   * Оператор управления ошибками
   * Функция <strong>ini_set()</strong> — Устанавливает значение настройи конфигурации


id: escapeshellarg
type: function
doc:
<comment>Description:</comment>
  Экранировать строку для того, чтобы она могла быть использована как аргумент командной строки
  
  Функция <strong>escapeshellarg()</strong> добавляет одинарные кавычки вокруг строки и кавычек и экранирует любые
  существующие одинарные кавычки, позволяя вам передать строку непосредственно в функцию оболочки и
  рассматривать её как один безопасный аргумент. Эта функция должна использоваться для того, чтобы
  экранировать отдельные аргументы для функций оболочки, полученные из пользовательского ввода.
  Экранирование аргумента необходимо в таких функциях оболочки как <strong>exec()</strong>, <strong>system()</strong> и оператор
  "обратный апостроф".
  
  В Windows <strong>escapeshellarg()</strong> заменяет восклицательный знак, знак процента (позднее связывание
  переменных) и двойные кавычки на пробелы и добавляет двойные кавычки вокруг строки. Кроме того,
  каждая серия последовательных обратных слешей (<return>\</return>) экранируется одним дополнительным обратным
  слешем.

<comment>Param:</comment>
  <info>string</info>  <strong>$arg</strong>  Аргумент, который будет экранирован.

<comment>Return:</comment>
  <info>string</info>  Экранированная строка.

<comment>See Also:</comment>
   * <strong>escapeshellcmd()</strong>
   * <strong>exec()</strong>
   * <strong>popen()</strong>
   * <strong>system()</strong>
   * Оператор исполнения


id: escapeshellcmd
type: function
doc:
<comment>Description:</comment>
  Экранировать метасимволы командной строки
  
  Команда <strong>escapeshellcmd()</strong> экранирует любые символы в строке, которые могут быть использованы для
  обмана команды оболочки при выполнении произвольных команд. Эта функция должна быть использована,
  чтобы убедиться, что любые данные, вводимые пользователем, будут экранированы перед передачей их
  функциям <strong>exec()</strong> или <strong>system()</strong> или оператору "обратный апостроф".
  
  Следующие символы будут экранированы при помощи обратного слеша: <return>&#;`|*?~\<&gt;^()[]{}$\</return>, <return>\x0A</return> и <return>\xFF</return>. Символы <return>'</return> и <return>"</return> экранируются только в том случае, если они  встречаются не попарно. В Windows все этим символам, плюс <return>!</return> и <return>%</return> предшествует символ каретки (<return>^</return>).

<comment>Param:</comment>
  <info>string</info>  <strong>$command</strong>  Команда, которая будет экранирована.

<comment>Return:</comment>
  <info>string</info>  Экранированная строка.

<comment>See Also:</comment>
   * <strong>escapeshellarg()</strong>
   * <strong>exec()</strong>
   * <strong>popen()</strong>
   * <strong>system()</strong>
   * Оператор исполнения


id: eval
type: function
doc:
<comment>Description:</comment>
  Расценивает строку как PHP-код и выполняет его
  
  Выполняет переданную в параметре <strong>$code</strong> строку как код PHP.
  
  Выполняемый код наследует ту же область видимости переменной, что и строка, на которой языковая
  конструкция <strong>eval()</strong> была вызвана. Любые доступные на этой строке переменные будут доступны для
  чтения и изменения в выполняемом коде. Однако все объявленные в этом коде функции и классы получат
  глобальную область видимости. Говоря по-другому, компилятор расценит выполняемый код так, как если
  бы это был подключёный файл.
  
  Языковая конструкция <strong>eval()</strong> может быть очень опасной, поскольку может выполнять произвольный код.
  Поэтому от работы с ней воздерживаются. Если тщательный поиск других решений показал, что
  альтернативы нет, внимательно проверяют, чтобы в неё не передавались пользовательские данные без
  их правильной предварительной проверки.

<comment>Param:</comment>
  <info>string</info>  <strong>$code</strong>  Выполняемая строка кода PHP.
                 
                 Код не должен быть обёрнут открывающимся и закрывающимся тегами PHP, то есть строка
                 должна быть, например, такой: <return>'echo "Привет!";'</return>, но не такой <return>'\<?php echo "Привет!"; &gt;'</return>. Можно переключаться между режимами PHP- и HTML-кода, например: <return>'echo "Код PHP!"; ?&gt;Код HTML\<?php echo "Снова код PHP!";'</return>.
                 
                 Передаваемый код должен быть верным выполняемым кодом PHP. Это значит, что
                 операторы должны быть разделены точкой с запятой (;). При выполнении строки <return>'echo
                 "Привет!"'</return> будет сгенерирована ошибка, а строка <return>'echo "Привет!";'</return> будет успешно
                 выполнена.
                 
                 Указание в строке кода ключевого слова <return>return</return> прекращает выполнение.
                 
                 Код из строки будет выполнен в той области видимости, в которой вызвана конструкция
                 <strong>eval()</strong>. Поэтому переменные, которые определены или изменены в ней, сохранят
                 видимость после завершения вызова конструкции <strong>eval()</strong>.

<comment>Return:</comment>
  <info>mixed</info>  Языковая конструкция <strong>eval()</strong> возвращает значение <info>null</info>, или значение, которое вернул
         вызванный в выполняемом коде оператор <return>return</return>. Начиная с PHP 7, если в выполняемом коде
         присутствует ошибка, то конструкция <strong>eval()</strong> вызывает исключение "ParseError". До PHP 7 в
         таких случаях возвращалось булево значение <info>false</info> и продолжалось нормальное выполнение
         последующего кода. Невозможно поймать ошибку парсера в конструкции <strong>eval()</strong> функцией
         <strong>set_error_handler()</strong>.

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


id: exec
type: function
doc:
<comment>Description:</comment>
  Выполнить внешнюю программу
  
  <strong>exec()</strong> выполняет команду <strong>$command</strong>.

<comment>Param:</comment>
  <info>string</info>  <strong>$command</strong>      Команда, которая будет исполнена.
  <info>array</info>   <strong>$output</strong>       Если параметр <strong>$output</strong> указан, то массив будет заполнен строками вывода
                        программы. Завершающие пробелы, такие как <return>\n</return>, не будут включены в массив.
                        Обратите внимание, что если массив уже содержит какие-либо элементы, то
                        <strong>exec()</strong> добавит новые элементы в конец массива. Если же вы не хотите, чтобы
                        функция добавляла новые элементы в конец, вызовите <strong>unset()</strong> на этом массиве,
                        прежде чем передать его в <strong>exec()</strong>.
  <info>int</info>     <strong>$result_code</strong>  Если аргумент <strong>$result_code</strong> присутствует вместе с <strong>$output</strong>, тогда статус
                        возврата выполненной команды будет записан в этой переменной.

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

<comment>See Also:</comment>
   * <strong>system()</strong>
   * <strong>passthru()</strong>
   * <strong>escapeshellcmd()</strong>
   * <strong>pcntl_exec()</strong>
   * Оператор исполнения


id: exif_imagetype
type: function
doc:
<comment>Description:</comment>
  Determine the type of an image
  
  <strong>exif_imagetype()</strong> считывает начальные байты изображения и проверяет их сигнатуру.
  
  <strong>exif_imagetype()</strong> может использоваться, чтобы избежать вызовов других exif-функций с
  неподдерживаемыми аргументами. Также при взаимодействии с $_SERVER['HTTP_ACCEPT'] можно проверять,
  будет ли изображение отображаться в браузере.

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

<comment>Return:</comment>
  <info>int|false</info>  Если корректная сигнатура обнаружена, функция вернёт соответствующую типу изображения
             константу. В противном случае функция вернёт <info>false</info>. Возвращаемое значение то же, что и
             во втором аргументе при возврате из функции <strong>getimagesize()</strong>, однако <strong>exif_imagetype()</strong>
             значительно быстрее.
             
             Следующие определённые константы представляют возможные возвращаемые значения функции
             <strong>exif_imagetype()</strong>: Константы
             ImagetypeЗначениеКонстанта1<info>IMAGETYPE_GIF</info>2<info>IMAGETYPE_JPEG</info>3<info>IMAGETYPE_PNG</info>4<info>IMAGETYPE_SWF</info>5<info>IMAGETYPE_PSD</info>6<info>IMAGETYPE_BMP</info>7<info>IMAGETYPE_TIFF_II</info>
             (порядок байт intel)8<info>IMAGETYPE_TIFF_MM</info> (порядок байт motorola)
             9<info>IMAGETYPE_JPC</info>10<info>IMAGETYPE_JP2</info>11<info>IMAGETYPE_JPX</info>12<info>IMAGETYPE_JB2</info>13<info>IMAGETYPE_SWC</info>14<info>IMAGETYPE_IFF</info>15<info>IMAGETYPE_WBMP</info>16<info>IMAGETYPE_XBM</info>17<info>IMAGETYPE_ICO</info>18<info>IMAGETYPE_WEBP</info>19<info>IMAGETYPE_AVIF</info>
             
             В случаях, когда невозможно считать количество байтов из файла достаточное для
             определения типа изображения, функция <strong>exif_imagetype()</strong> вызовет предупреждение уровня
             <info>E_NOTICE</info> и вернёт <info>false</info>.

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


id: exif_read_data
type: function
doc:
<comment>Description:</comment>
  Читает заголовки EXIF из файлов изображений
    
  
  <strong>exif_read_data()</strong> читает заголовки EXIF из файлов изображений. Таким образом можно читать
  метаданные, генерируемые цифровыми фотоаппаратами.
  
  По идее, EXIF-заголовки должны идти первыми в JPEG/TIFF файлах, генерируемых фотоаппаратами. Но, к
  сожалению, каждый производитель имеет своё представление того, каким образом компоновать
  метаданные изображения. Поэтому будьте готовы к ситуации, когда перед Exif-заголовком есть ещё
  что-то.
  
  <return>Height</return> и <return>Width</return> вычисляются аналогично вычислениям <strong>getimagesize()</strong>, так что эти параметры не обязаны
  присутствовать в заголовке. <return>html</return> - текстовая строка, задающая высоту/ширину, которую можно
  использовать в обычном HTML.
  
  Если Exif-заголовок содержит сообщение об авторских правах (Copyright), само сообщение может
  содержать 2 значения. Эта ситуация не описана в стандарте Exif 2.10, поэтому раздел <return>COMPUTED</return> будет
  содержать оба этих значения в полях <return>Copyright.Photographer</return> и <return>Copyright.Editor</return>. В то же время
  разделы <return>IFD0</return> будут содержать массив байт с NULL-символом в качестве разделителя этих двух значений
  либо только первое значение, если тип файла определён неверно (нормальная ситуация для Exif).
  Раздел <return>COMPUTED</return> будет также содержать <return>Copyright</return>, это может быть либо исходная строка, либо список
  из владельца фотографии и редактора через запятую.
  
  Тег <return>UserComment</return> имеет те же проблемы, что и Copyright. Он может хранить 2 значения. Первое -
  использованную кодировку, второе - само значение. В этом случае раздел <return>IFD</return> содержит либо
  кодировку, либо массив байт. Раздел <return>COMPUTED</return> будет хранить оба этих значения в полях
  <return>UserCommentEncoding</return> и <return>UserComment</return>. Содержимое <return>UserComment</return> будет доступно в любом случае, поэтому
  предпочтительней использовать его вместо раздела <return>IFD0</return>.
  
  Также <strong>exif_read_data()</strong> проверяет EXIF теги на соответствие спецификации EXIF
  (http://exif.org/Exif2-2.PDF, стр. 20).

<comment>Param:</comment>
  <info>resource|string</info>  <strong>$file</strong>               Местоположение файла с изображением. Может быть как путём к
                                       файлу, так и потоковым ресурсом (можно использовать обёртки).
  <info>string|null</info>      <strong>$required_sections</strong>  Список разделённых запятой разделов, которые должны быть
                                       представлены в результирующем массиве (<info>array</info>). Если ни один
                                       из разделов найти не удастся, функция вернёт <info>false</info>.
                                       FILEFileName, FileSize, FileDateTime, SectionsFoundCOMPUTED
                                       html, Width, Height, IsColor, и другие. Height и Width
                                       вычисляются аналогично <strong>getimagesize()</strong>, поэтому их не
                                       обязательно включать в заголовок. <return>html</return> - текстовая строка,
                                       задающая высоту/ширину, которую можно использовать в обычном
                                       HTML. ANY_TAGЛюбая информация заключённая в тег, например,
                                       <return>IFD0</return>, <return>EXIF</return>, ...IFD0 Все данные тега IFD0. В обычных
                                       изображениях в нем хранится размер изображения. THUMBNAIL
                                       Если файл содержит второй раздел <return>IFD</return>, то считается, что у
                                       изображения есть эскиз. Вся информация об эскизе хранится в
                                       этом разделе. COMMENTЗаголовки комментариев JPEG
                                       изображений.EXIF Раздел EXIF является подразделом <return>IFD0</return>. Он
                                       содержит более детальную информацию об изображении.
                                       Большинство его записей зависят от фотоаппарата.
  <info>bool</info>             <strong>$as_arrays</strong>          Определяет, формировать ли разделы в виде массивов. Разделы
                                       <strong>$required_sections</strong>, <return>COMPUTED</return>, <return>THUMBNAIL</return> и <return>COMMENT</return> всегда
                                       делаются массивами, так как они могут содержать значения,
                                       имена которых будут конфликтовать с именами в других
                                       разделах.
  <info>bool</info>             <strong>$read_thumbnail</strong>     Если <info>true</info>, будет прочитан сам эскиз. В противном случае будет
                                       прочитана только информация в тегах.

<comment>Return:</comment>
  <info>array|false</info>  Возвращает ассоциативный массив (<info>array</info>), в котором ключами будут имена заголовков, а
               значениями - значения соответствующие этим заголовкам. Если никаких данных вернуть
               нельзя, <strong>exif_read_data()</strong> вернёт <info>false</info>.

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


id: exif_tagname
type: function
doc:
<comment>Description:</comment>
  Получение имени заголовка по его индексу

<comment>Param:</comment>
  <info>int</info>  <strong>$index</strong>  ID тега, имя которого требуется получить.

<comment>Return:</comment>
  <info>string|false</info>  Возвращает имя заголовка или <info>false</info>, если <strong>$index</strong> не является ранее определённым
                идентификатором EXIF тега.

<comment>See Also:</comment>
   * <strong>exif_imagetype()</strong>
   * EXIF спецификация
   * EXIF теги


id: exif_thumbnail
type: function
doc:
<comment>Description:</comment>
  Получает встроенное превью изображения
  
  <strong>exif_thumbnail()</strong> считывает встроенное превью изображения.
  
  Если вы хотите получить эскиз посредством этой функции, вам необходимо отправить
  mimetype-информацию, использовав <strong>header()</strong> функцию.
  
  Иногда <strong>exif_thumbnail()</strong> не может создать изображение, но может определить его размер. В таких
  случаях она возвращает <info>false</info>, но задаёт аргументам <strong>$width</strong> и <strong>$height</strong> правильные значения.

<comment>Param:</comment>
  <info>resource|string</info>  <strong>$file</strong>        Местоположение файла с изображением. Может быть как путём к файлу,
                                так и потоковым ресурсом.
  <info>int</info>              <strong>$width</strong>       Возвращаемая ширина эскиза.
  <info>int</info>              <strong>$height</strong>      Возвращаемая высота эскиза.
  <info>int</info>              <strong>$image_type</strong>  Возвращаемый тип эскиза. Это либо TIFF, либо JPEG.

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

<comment>See Also:</comment>
   * <strong>exif_read_data()</strong>
   * <strong>image_type_to_mime_type()</strong>


id: exit
type: function
doc:
<comment>Description:</comment>
  Вывести сообщение и прекратить выполнение текущего скрипта
  
  Прекращает выполнение скрипта. Функции отключения и деструкторы объекта будут запущены, даже если
  была вызвана конструкция <return>exit</return>.
  
  <return>exit</return> - это конструкция языка, и она может быть вызвана без круглых скобок, если не передаётся
  параметр <strong>$status</strong>.

<comment>Param:</comment>
  <info>string</info>  <strong>$status</strong>  Если <strong>$status</strong> задан в виде строки, то эта конструкция выведет содержимое <strong>$status</strong>
                   перед выходом.
                   
                   Если <strong>$status</strong> задан в виде целого числа (<info>int</info>), то это значение будет использовано
                   как статус выхода и не будет выведено. Статусы выхода должны быть в диапазоне от
                   0 до 254, статус выхода 255 зарезервирован PHP и не должен использоваться. Статус
                   выхода 0 используется для успешного завершения программы.

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

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


id: exp
type: function
doc:
<comment>Description:</comment>
  Вычисляет степень числа e
  
  Возвращает <info>e</info> в степени <strong>$num</strong>.
  
  Число <info>e</info> - основание натурального логарифма. Приблизительно равно 2.718282.

<comment>Param:</comment>
  <info>float</info>  <strong>$num</strong>  Степень для возведения

<comment>Return:</comment>
  <info>float</info>  'e' возводится в степень <strong>$num</strong>

<comment>See Also:</comment>
   * <strong>log()</strong>
   * <strong>pow()</strong>


id: expect_expectl
type: function
doc:
<comment>Description:</comment>
  Ожидает, пока вывод потока не совпадёт с одним из шаблонов, либо пока не
     закончится максимальное время ожидания, либо вернётся EOF
    
  
  Ожидает, пока вывод потока не совпадёт с одним из шаблонов, либо пока не закончится максимальное
  время ожидания, либо вернётся EOF.
  
  Если задан параметр <strong>$match</strong>, то он заполняется с результатами поиска. Совпавшая строка будет
  сохранена в <strong>$match[0]</strong>. Совпавшие подстроки (в зависимости от скобок) в оригинальном шаблоне будут
  сохранены в <strong>$match[1]</strong>, <strong>$match[2]</strong>, вплоть до <strong>$match[9]</strong> (ограничения libexpect).

<comment>Param:</comment>
  <info>resource</info>  <strong>$expect</strong>  Поток Expect, открытый с помощью <strong>expect_popen()</strong>.
  <info>array</info>     <strong>$cases</strong>   Массив ожидаемых значений. Каждое ожидаемое значение представляет из себя
                     индексированный массив, описанный в этой таблице: Expect Case ArrayИндексТип
                     значенияОписаниеОбязательныйЗначение по умолчанию0stringшаблон, который будет
                     сравниваться с потоком выводада1mixedзначение, которое вернёт функция, если
                     совпадение найденода2integer тип шаблона: <info>EXP_GLOB</info>, <info>EXP_EXACT</info> или <info>EXP_REGEXP</info>
                     нет<info>EXP_GLOB</info>

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

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


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

<comment>Param:</comment>
  <info>string</info>  <strong>$command</strong>  Команда для запуска.

<comment>Return:</comment>
  <info>resource</info>  Возвращает поток PTY для <return>stdio</return>, <return>stdout</return>, и <return>stderr</return> процесса.
            
            В случае возникновения ошибки возвращает <info>false</info>.

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


id: explode
type: function
doc:
<comment>Description:</comment>
  Разбивает строку с помощью разделителя
  
  Возвращает массив строк, полученных разбиением строки <strong>$string</strong> с использованием <strong>$separator</strong> в
  качестве разделителя.

<comment>Param:</comment>
  <info>string</info>  <strong>$separator</strong>  Разделитель.
  <info>string</info>  <strong>$string</strong>     Входная строка.
  <info>int</info>     <strong>$limit</strong>      Если аргумент <strong>$limit</strong> является положительным, возвращаемый массив будет
                      содержать максимум <strong>$limit</strong> элементов, при этом последний элемент будет
                      содержать остаток строки <strong>$string</strong>.
                      
                      Если параметр <strong>$limit</strong> отрицателен, то будут возвращены все компоненты, кроме
                      последних -<strong>$limit</strong>.
                      
                      Если <strong>$limit</strong> равен нулю, то он расценивается как 1.

<comment>Return:</comment>
  <info>array</info>  Возвращает массив (<info>array</info>) строк (<info>string</info>), созданный делением параметра <strong>$string</strong> по границам,
         указанным параметром <strong>$separator</strong>.
         
         Если <strong>$separator</strong> является пустой строкой (""), <strong>explode()</strong> выбрасывает <class>ValueError</class>. Если
         <strong>$separator</strong> не содержится в <strong>$string</strong>, и используется отрицательный <strong>$limit</strong>, то будет возвращён
         пустой массив (<info>array</info>), иначе будет возвращён массив, содержащий <strong>$string</strong>. Если значения
         <strong>$separator</strong> появляются в начале или в конце <strong>$string</strong>, указанные значения будут добавлены как
         пустое значение массива (<info>array</info>), либо в первой, либо в последней позиции возвращённого
         массива (<info>array</info>) соответственно.

<comment>See Also:</comment>
   * <strong>preg_split()</strong>
   * <strong>str_split()</strong>
   * <strong>mb_split()</strong>
   * <strong>str_word_count()</strong>
   * <strong>strtok()</strong>
   * <strong>implode()</strong>


id: expm1
type: function
doc:
<comment>Description:</comment>
  Возвращает exp($num) - 1, рассчитанное таким образом, что результат
     точен, даже если значение number близко к нулю.
    
  
  <strong>expm1()</strong> возвращает эквивалент выражения 'exp(<strong>$num</strong>) -  1', рассчитанный таким образом, что
  результат точен, даже если значение <strong>$num</strong> близко к нулю, тогда как 'exp (<strong>$num</strong>) - 1' будет неточно
  из-за вычитания двух почти равных чисел.

<comment>Param:</comment>
  <info>float</info>  <strong>$num</strong>  Входное значение

<comment>Return:</comment>
  <info>float</info>  'e' в степени <strong>$num</strong> минус один

<comment>See Also:</comment>
   * <strong>log1p()</strong>
   * <strong>exp()</strong>


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

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

<comment>Return:</comment>
  <info>object</info>  


id: extension_loaded
type: function
doc:
<comment>Description:</comment>
  Определяет, загружен ли модуль
  
  Определяет, загружен ли указанный модуль.

<comment>Param:</comment>
  <info>string</info>  <strong>$extension</strong>  Имя модуля. Этот параметр регистронезависимый.
                      
                      Чтобы посмотреть все имена модулей, воспользуйтесь функцией <strong>phpinfo()</strong>. Если вы
                      работаете с <return>CGI</return>- или <return>CLI</return>-версией PHP, используйте параметр -m для отображения
                      списка доступных модулей:

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

<comment>See Also:</comment>
   * <strong>get_loaded_extensions()</strong>
   * <strong>get_extension_funcs()</strong>
   * <strong>phpinfo()</strong>
   * <strong>dl()</strong>
   * <strong>function_exists()</strong>


id: extract
type: function
doc:
<comment>Description:</comment>
  Импортирует переменные из массива в текущую таблицу символов
  
  Импортирует переменные из массива в текущую таблицу символов.
  
  Каждый ключ проверяется на предмет корректного имени переменной. Также проверяются совпадения с
  существующими переменными в символьной таблице.
  
  Не используйте <strong>extract()</strong> на непроверенных данных, таких как пользовательский ввод (например,
  $_GET, $_FILES).

<comment>Param:</comment>
  <info>array</info>   <strong>$array</strong>   Ассоциативный массив. Функция рассматривает ключи массива в качестве имён
                   переменных, а их значения - в качестве значений этих переменных. Для каждой пары
                   ключ/значение будет создана переменная в текущей таблице символов, в соответствии
                   с параметрами <strong>$flags</strong> и <strong>$prefix</strong>.
                   
                   Вы должны использовать ассоциативный массив, использование числовых массивов не
                   приведёт ни к каким результатам, если вы не используете <info>EXTR_PREFIX_ALL</info> или
                   <info>EXTR_PREFIX_INVALID</info>.
  <info>int</info>     <strong>$flags</strong>   Параметр <strong>$flags</strong> определяет способ трактования неправильных/числовых ключей и
                   коллизий. Он может принимать следующие значения: <info>EXTR_OVERWRITE</info> Если переменная с
                   таким именем существует, она будет перезаписана. <info>EXTR_SKIP</info> Если переменная с
                   таким именем существует, её текущее значение не будет перезаписано.
                   <info>EXTR_PREFIX_SAME</info>Если переменная с таким именем существует, к её имени будет
                   добавлен префикс, определённый параметром <strong>$prefix</strong>. <info>EXTR_PREFIX_ALL</info> Добавить
                   префикс <strong>$prefix</strong> ко всем именам переменных. <info>EXTR_PREFIX_INVALID</info> Добавить префикс
                   <strong>$prefix</strong> только к некорректным/числовым именам переменных. <info>EXTR_IF_EXISTS</info>
                   Перезаписать только переменные, уже имеющиеся в текущей таблице символов, в
                   противном случае не делать ничего. Данная возможность полезна для определения
                   списка приемлемых переменных и для извлечения только тех переменных, которые вы
                   уже определили из массивов типа $_REQUEST, например. <info>EXTR_PREFIX_IF_EXISTS</info>
                   Создать только префикс-версии переменных, если версия данной переменной без
                   префикса уже существует в текущей символьной таблице. <info>EXTR_REFS</info> Извлечь
                   переменные как ссылки. Это означает, что значения таких переменных будут всё ещё
                   ссылаться на значения массива <strong>$array</strong>. Вы можете использовать этот флаг отдельно
                   или комбинировать его с другими значениями <strong>$flags</strong> с помощью побитового 'или'.
                   
                   Если переменная с таким именем существует, она будет перезаписана.
                   
                   Если переменная с таким именем существует, её текущее значение не будет
                   перезаписано.
                   
                   Если переменная с таким именем существует, к её имени будет добавлен префикс,
                   определённый параметром <strong>$prefix</strong>.
                   
                   Добавить префикс <strong>$prefix</strong> ко всем именам переменных.
                   
                   Добавить префикс <strong>$prefix</strong> только к некорректным/числовым именам переменных.
                   
                   Перезаписать только переменные, уже имеющиеся в текущей таблице символов, в
                   противном случае не делать ничего. Данная возможность полезна для определения
                   списка приемлемых переменных и для извлечения только тех переменных, которые вы
                   уже определили из массивов типа $_REQUEST, например.
                   
                   Создать только префикс-версии переменных, если версия данной переменной без
                   префикса уже существует в текущей символьной таблице.
                   
                   Извлечь переменные как ссылки. Это означает, что значения таких переменных будут
                   всё ещё ссылаться на значения массива <strong>$array</strong>. Вы можете использовать этот флаг
                   отдельно или комбинировать его с другими значениями <strong>$flags</strong> с помощью побитового
                   'или'.
                   
                   Если <strong>$flags</strong> не указан, он трактуется как <info>EXTR_OVERWRITE</info>.
  <info>string</info>  <strong>$prefix</strong>  Если переменная с таким именем существует, к её имени будет добавлен префикс,
                   определённый параметром <strong>$prefix</strong>.
  <info>string</info>  <strong>$prefix</strong>  Добавить префикс <strong>$prefix</strong> ко всем именам переменных.
  <info>string</info>  <strong>$prefix</strong>  Добавить префикс <strong>$prefix</strong> только к некорректным/числовым именам переменных.
  <info>array</info>   <strong>$array</strong>   Извлечь переменные как ссылки. Это означает, что значения таких переменных будут
                   всё ещё ссылаться на значения массива <strong>$array</strong>. Вы можете использовать этот флаг
                   отдельно или комбинировать его с другими значениями <strong>$flags</strong> с помощью побитового
                   'или'.
  <info>string</info>  <strong>$prefix</strong>  Обратите внимание, что <strong>$prefix</strong> имеет значение, только если <strong>$flags</strong> установлен в
                   <info>EXTR_PREFIX_SAME</info>, <info>EXTR_PREFIX_ALL</info>, <info>EXTR_PREFIX_INVALID</info> или <info>EXTR_PREFIX_IF_EXISTS</info>.
                   Если в результате добавления префикса, не будет получено допустимое имя для
                   переменной, она не будет импортирована в текущую символьную таблицу.

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

<comment>See Also:</comment>
   * <strong>compact()</strong>
   * <strong>list()</strong>


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

<comment>Param:</comment>
  <info>string</info>  <strong>$addr</strong>  Хешируемый адрес электронной почты.

<comment>Return:</comment>
  <info>int</info>  Хеш-сумма параметра <strong>$addr</strong>.


id: fann_cascadetrain_on_data
type: function
doc:
<comment>Description:</comment>
  Обучение на всем наборе данных в течение определённого периода времени с помощью алгоритма
  Cascade2
  
  Фракция каскадного вывода является числом от 0 до 1 и определяет, насколько сильно должно
  измениться значение <strong>fann_get_MSE()</strong> в <strong>fann_get_cascade_output_stagnation_epochs()</strong> во время обучения
  выходных соединений, для того, чтобы обучение не стагнировало. Если обучение стагнировало, то
  обучение выходных соединений будет завершено и будут подготовлены новые кандидаты.
  
  Это обучение использует параметры, установленные fann_set_cascade_..., но также оно использует
  другой обучающий алгоритм в качестве внутреннего обучающего алгоритма. Этот алгоритм может быть
  задан как <info>FANN_TRAIN_RPROP</info> или <info>FANN_TRAIN_QUICKPROP</info> с помощью <strong>fann_set_training_algorithm()</strong>, и
  параметры, заданные для этих обучающих алгоритмов, также будут учитываться в каскадном обучении.

<comment>Param:</comment>
  <info>resource</info>  <strong>$ann</strong>                      Ресурс (<info>resource</info>) нейронной сети.
  <info>resource</info>  <strong>$data</strong>                     Ресурс (<info>resource</info>) обучающих данных нейронной сети.
  <info>int</info>       <strong>$max_neurons</strong>              Максимальное количество нейронов для добавления в сеть.
  <info>int</info>       <strong>$neurons_between_reports</strong>  Печать отчёта о статусе будет происходить через заданное в
                                      этом параметре число нейронов. Если задан ноль, то печать
                                      происходить не будет.
  <info>float</info>     <strong>$desired_error</strong>            Желаемая <strong>fann_get_MSE()</strong> или <strong>fann_get_bit_fail()</strong>, в зависимости
                                      от выбранной с помощью <strong>fann_set_train_stop_function()</strong>
                                      остановочной функции.

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

<comment>See Also:</comment>
   * <strong>fann_train_on_data()</strong>
   * <strong>fann_cascadetrain_on_file()</strong>


id: fann_cascadetrain_on_file
type: function
doc:
<comment>Description:</comment>
  Обучение на данных прочтённых из файла с помощью алгоритма Cascade2
  
  Делает то же, что и <strong>fann_cascadetrain_on_data()</strong>, но читает данные напрямую из файла.

<comment>Param:</comment>
  <info>resource</info>  <strong>$ann</strong>                      Ресурс (<info>resource</info>) нейронной сети.
  <info>string</info>    <strong>$filename</strong>                 Файл с данными.
  <info>int</info>       <strong>$max_neurons</strong>              Максимальное количество нейронов в сети.
  <info>int</info>       <strong>$neurons_between_reports</strong>  Количество нейронов между выводом отчётов о состоянии. Если
                                      задать 0, то отчёты печататься не будут.
  <info>float</info>     <strong>$desired_error</strong>            Выбранные <strong>fann_get_MSE()</strong> или <strong>fann_get_bit_fail()</strong>, в
                                      зависимости от выбранной с помощью
                                      <strong>fann_set_train_stop_function()</strong> функции остановки.

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

<comment>See Also:</comment>
   * <strong>fann_train_on_data()</strong>
   * <strong>fann_cascadetrain_on_data()</strong>


id: fann_clear_scaling_params
type: function
doc:
<comment>Description:</comment>
  Очистка параметров масштабирования
  
  Очистка параметров масштабирования.

<comment>Param:</comment>
  <info>resource</info>  <strong>$ann</strong>  Ресурс (<info>resource</info>) нейронной сети.

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


id: fann_copy
type: function
doc:
<comment>Description:</comment>
  Создаёт копию структуры fann
  
  Создаёт копию структуры fann.

<comment>Param:</comment>
  <info>resource</info>  <strong>$ann</strong>  Ресурс (<info>resource</info>) нейронной сети.

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

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


id: fann_create_from_file
type: function
doc:
<comment>Description:</comment>
  Создаёт нейронную сеть с обратным распространением ошибки из конфигурационного файла
  
  Создаёт нейронную сеть с обратным распространением ошибки из конфигурационного файла, созданного
  ранее с помощью <strong>fann_save()</strong>.

<comment>Param:</comment>
  <info>string</info>  <strong>$configuration_file</strong>  Конфигурационный файл.

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

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


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

<comment>Param:</comment>
  <info>int</info>  <strong>$num_layers</strong>    Общее количество слоёв, включая входной и выходной слой.
  <info>int</info>  <strong>$num_neurons1</strong>  Количество нейронов в первом слое.
  <info>int</info>  <strong>$num_neurons2</strong>  Количество нейронов во втором слое.
  <info>int</info>  <strong>$num_neuronsN</strong>  Количество нейронов в последующих слоях.

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

<comment>See Also:</comment>
   * <strong>fann_create_shortcut_array()</strong>
   * <strong>fann_create_sparse()</strong>
   * <strong>fann_create_standard()</strong>


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

<comment>Param:</comment>
  <info>int</info>    <strong>$num_layers</strong>  Общее количество слоёв, включая входной и выходной слой.
  <info>array</info>  <strong>$layers</strong>      Массив размеров слоёв.

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

<comment>See Also:</comment>
   * <strong>fann_create_shortcut()</strong>
   * <strong>fann_create_sparse()</strong>
   * <strong>fann_create_standard()</strong>


id: fann_create_sparse
type: function
doc:
<comment>Description:</comment>
  Создаёт стандартную нейронную сеть обратного распространения, которая не полностью подключена
  
  Создаёт стандартную нейронную сеть обратного распространения, которая не полностью подключена.

<comment>Param:</comment>
  <info>float</info>  <strong>$connection_rate</strong>  Скорость соединения определяет, сколько соединений будет в сети. Если
                           скорость соединения установлена на 1, сеть будет полностью подключена, но
                           если она установлена на 0,5, будет установлена только половина
                           соединений. Скорость соединения 1 даст тот же результат, что и
                           <strong>fann_create_standard()</strong>.
  <info>int</info>    <strong>$num_layers</strong>       Общее количество слоёв, включая входной и выходной слой.
  <info>int</info>    <strong>$num_neurons1</strong>     Количество нейронов в первом слое.
  <info>int</info>    <strong>$num_neurons2</strong>     Количество нейронов во втором слое.
  <info>int</info>    <strong>$num_neuronsN</strong>     Количество нейронов в других слоях.

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

<comment>See Also:</comment>
   * <strong>fann_create_sparse_array()</strong>
   * <strong>fann_create_standard()</strong>
   * <strong>fann_create_shortcut()</strong>


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

<comment>Param:</comment>
  <info>float</info>  <strong>$connection_rate</strong>  Скорость соединения определяет, сколько соединений будет в сети. Если
                           скорость соединения установлена на 1, сеть будет полностью подключена, но
                           если она установлена на 0,5, будет установлена только половина
                           соединений. Скорость соединения 1 даст тот же результат, что и
                           <strong>fann_create_standard()</strong>.
  <info>int</info>    <strong>$num_layers</strong>       Общее количество слоёв, включая входной и выходной слой.
  <info>array</info>  <strong>$layers</strong>           Массив размеров слоёв.

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

<comment>See Also:</comment>
   * <strong>fann_create_sparse()</strong>
   * <strong>fann_create_standard()</strong>
   * <strong>fann_create_shortcut()</strong>


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

<comment>Param:</comment>
  <info>int</info>  <strong>$num_layers</strong>    Общее количество слоёв, включая входной и выходной слой.
  <info>int</info>  <strong>$num_neurons1</strong>  Количество нейронов в первом слое.
  <info>int</info>  <strong>$num_neurons2</strong>  Количество нейронов во втором слое.
  <info>int</info>  <strong>$num_neuronsN</strong>  Количество нейронов в других слоях.

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

<comment>See Also:</comment>
   * <strong>fann_create_standard_array()</strong>
   * <strong>fann_create_sparse()</strong>
   * <strong>fann_create_shortcut()</strong>


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

<comment>Param:</comment>
  <info>int</info>    <strong>$num_layers</strong>  Общее количество слоёв, включая входной и выходной слой.
  <info>array</info>  <strong>$layers</strong>      Массив размеров слоёв.

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

<comment>See Also:</comment>
   * <strong>fann_create_standard()</strong>
   * <strong>fann_create_sparse()</strong>
   * <strong>fann_create_shortcut()</strong>


id: fann_create_train
type: function
doc:
<comment>Description:</comment>
  Создаёт пустую структуру данных для обучения
  
  Создаёт пустую структуру данных для обучения.

<comment>Param:</comment>
  <info>int</info>  <strong>$num_data</strong>    Количество тренировочных данных
  <info>int</info>  <strong>$num_input</strong>   Количество входов на тренировочных данных
  <info>int</info>  <strong>$num_output</strong>  Количество выходов на тренировочных данных

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

<comment>See Also:</comment>
   * <strong>fann_read_train_from_file()</strong>
   * <strong>fann_train_on_data()</strong>
   * <strong>fann_destroy_train()</strong>
   * <strong>fann_save_train()</strong>


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

<comment>Param:</comment>
  <info>int</info>       <strong>$num_data</strong>       Количество тренировочных данных
  <info>int</info>       <strong>$num_input</strong>      Количество входов на тренировочных данных
  <info>int</info>       <strong>$num_output</strong>     Количество выходов на тренировочных данных
  <info>callable</info>  <strong>$user_function</strong>  Функция, предоставленная пользователем со следующими параметрами: <return>num</return> -
                            Количество обучающих данных<return>num_input</return> - Количество входов на
                            тренировочных данных<return>num_output</return> - Количество выходов на тренировочных
                            данных
                            
                            Функция должна возвращать ассоциативный массив с ключами <return>input</return> и <return>output</return>
                            и двумя значениями массива input и output.

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

<comment>See Also:</comment>
   * <strong>fann_read_train_from_file()</strong>
   * <strong>fann_train_on_data()</strong>
   * <strong>fann_destroy_train()</strong>
   * <strong>fann_save_train()</strong>


id: fann_descale_input
type: function
doc:
<comment>Description:</comment>
  Масштабирует данные во входном векторе после получения их на основе ранее рассчитанных параметров
  
  Масштабирует данные во входном векторе после получения их на основе ранее рассчитанных параметров.

<comment>Param:</comment>
  <info>resource</info>  <strong>$ann</strong>           Ресурс (<info>resource</info>) нейронной сети.
  <info>array</info>     <strong>$input_vector</strong>  Входной вектор, который будет масштабирован

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

<comment>See Also:</comment>
   * <strong>fann_scale_input()</strong>
   * <strong>fann_descale_output()</strong>


id: fann_descale_output
type: function
doc:
<comment>Description:</comment>
  Масштабирует данные в выходном векторе после получения их ина основе ранее рассчитанных параметров
  
  Масштабирует данные в выходном векторе после получения их ина основе ранее рассчитанных
  параметров.

<comment>Param:</comment>
  <info>resource</info>  <strong>$ann</strong>            Ресурс (<info>resource</info>) нейронной сети.
  <info>array</info>     <strong>$output_vector</strong>  Выходной вектор, который будет масштабирован

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

<comment>See Also:</comment>
   * <strong>fann_scale_output()</strong>
   * <strong>fann_descale_input()</strong>


id: fann_descale_train
type: function
doc:
<comment>Description:</comment>
  Масштабирование входных и выходных данных на основе предварительно рассчитанных параметров
  
  Масштабирование входных и выходных данных на основе предварительно рассчитанных параметров.

<comment>Param:</comment>
  <info>resource</info>  <strong>$ann</strong>         Ресурс (<info>resource</info>) нейронной сети.
  <info>resource</info>  <strong>$train_data</strong>  Ресурс (<info>resource</info>) обучающих данных нейронной сети.

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

<comment>See Also:</comment>
   * <strong>fann_scale_train()</strong>
   * <strong>fann_set_scaling_params()</strong>


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

<comment>Param:</comment>
  <info>resource</info>  <strong>$ann</strong>  Ресурс (<info>resource</info>) нейронной сети.

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


id: fann_destroy_train
type: function
doc:
<comment>Description:</comment>
  Уничтожает тренировочные данные
  
  Уничтожает тренировочные данные

<comment>Param:</comment>
  <info>resource</info>  <strong>$train_data</strong>  Ресурс (<info>resource</info>) обучающих данных нейронной сети.

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


id: fann_duplicate_train_data
type: function
doc:
<comment>Description:</comment>
  Возвращает точную копию тренировочных данных
  
  Возвращает ресурс (<info>resource</info>) с точной копией тренировочных данных

<comment>Param:</comment>
  <info>resource</info>  <strong>$data</strong>  Ресурс (<info>resource</info>) обучающих данных нейронной сети.

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


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

<comment>Param:</comment>
  <info>resource</info>  <strong>$ann</strong>  Ресурс (<info>resource</info>) нейронной сети.

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

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


id: fann_get_activation_function
type: function
doc:
<comment>Description:</comment>
  Возвращает функцию активации
  
  Получает функцию активации для номера нейрона <return>neuron</return> в слое номер <return>layer</return>, считая входной слой как
  слой 0.
  
  Невозможно получить функции активации для нейронов во входном слое.
  
  Возвращаемое значение является одной из констант функций активации.

<comment>Param:</comment>
  <info>resource</info>  <strong>$ann</strong>     Ресурс (<info>resource</info>) нейронной сети.
  <info>int</info>       <strong>$layer</strong>   Номер слоя.
  <info>int</info>       <strong>$neuron</strong>  Номер нейрона.

<comment>Return:</comment>
  <info>int</info>  Константа функций обучения или -1, если нейрон не определён в нейронной сети или <info>false</info> в
       случае возникновения ошибки.

<comment>See Also:</comment>
   * <strong>fann_set_activation_function_layer()</strong>
   * <strong>fann_set_activation_function_hidden()</strong>
   * <strong>fann_set_activation_function_output()</strong>
   * <strong>fann_set_activation_steepness()</strong>
   * <strong>fann_set_activation_function()</strong>


id: fann_get_activation_steepness
type: function
doc:
<comment>Description:</comment>
  Возвращает крутизну активации для поставляемого нейрона и номера слоя
  
  Получает крутизну активации для нейрона с номером <return>neuron</return> в слое с номером <return>layer</return>, считая входной
  слой, как слой 0.
  
  Невозможно получить крутизну активации для нейронов во входном слое.
  
  Крутизна функции активации говорит о том, как быстро функция активации переходит от минимума к
  максимуму. Высокое значение для функции активации также даст более агрессивное обучение.
  
  При обучении нейронных сетей, где выходные значения должны быть на предельных значениях (обычно 0
  и 1, в зависимости от функции активации), может использоваться крутая функция активации (например,
  1,0).
  
  Крутизна активации по умолчанию - 0,5.

<comment>Param:</comment>
  <info>resource</info>  <strong>$ann</strong>     Ресурс (<info>resource</info>) нейронной сети.
  <info>int</info>       <strong>$layer</strong>   Номер слоя
  <info>int</info>       <strong>$neuron</strong>  Номер нейрона

<comment>Return:</comment>
  <info>float</info>  Крутизна активации для нейрона или -1, если нейрон не определён в нейронной сети, или <info>false</info>
         в случае возникновения ошибки.

<comment>See Also:</comment>
   * <strong>fann_set_activation_function()</strong>
   * <strong>fann_set_activation_steepness_layer()</strong>
   * <strong>fann_set_activation_steepness_hidden()</strong>
   * <strong>fann_set_activation_steepness_output()</strong>
   * <strong>fann_set_activation_steepness()</strong>


id: fann_get_bias_array
type: function
doc:
<comment>Description:</comment>
  Получает количество смещений в каждом слое в сети
  
  Получает количество смещений в каждом слое в сети.

<comment>Param:</comment>
  <info>resource</info>  <strong>$ann</strong>  Ресурс (<info>resource</info>) нейронной сети.

<comment>Return:</comment>
  <info>array</info>  Массив чисел смещения в каждом слое


id: fann_get_bit_fail
type: function
doc:
<comment>Description:</comment>
  Количество битов сбоя
  
  Количество битов сбоя; означает число выходных нейронов, которые отличаются больше, чем предел
  сбоя битов (смотрите <strong>fann_get_bit_fail_limit()</strong>, <strong>fann_set_bit_fail_limit()</strong>). Биты учитываются во
  всех обучающих данных, поэтому это число может быть больше количества обучающих данных.
  
  Это значение сбрасывается <strong>fann_reset_MSE()</strong> и обновляется всеми теми же функциями, которые также
  обновляют значение MSE (например, <strong>fann_test_data()</strong>, <strong>fann_train_epoch()</strong>)

<comment>Param:</comment>
  <info>resource</info>  <strong>$ann</strong>  Ресурс (<info>resource</info>) нейронной сети.

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

<comment>See Also:</comment>
   * <strong>fann_get_MSE()</strong>
   * <strong>fann_reset_MSE()</strong>
   * <strong>fann_test_data()</strong>
   * <strong>fann_train_epoch()</strong>
   * <strong>fann_get_bit_fail_limit()</strong>
   * <strong>fann_set_bit_fail_limit()</strong>


id: fann_get_bit_fail_limit
type: function
doc:
<comment>Description:</comment>
  Возвращает предел сбоя битов, использованный во время обучения
  
  Возвращает предел сбоя битов, использованный во время обучения.
  
  Предел сбоя битов используется во время обучения, когда функция остановки имеет значение
  <info>FANN_STOPFUNC_BIT</info>.
  
  Предел - это максимально допустимая разница между желаемым результатом и фактическим результатом
  во время тренировки. Каждый выход, который расходится больше этого предела, считается как бит со
  сбоем. Эта разница делится на два при работе с симметричными функциями активации, так что
  симметричные и не симметричные функции активации могут использовать один и тот же предел.
  
  Предельное значение сбоя по умолчанию составляет 0,35.

<comment>Param:</comment>
  <info>resource</info>  <strong>$ann</strong>  Ресурс (<info>resource</info>) нейронной сети.

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

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


id: fann_get_cascade_activation_functions
type: function
doc:
<comment>Description:</comment>
  Возвращает функции каскадной активации
  
  Массив функций каскадной активации - это массив различных функций активации, используемых
  кандидатами.
  
  Смотрите <strong>fann_get_cascade_num_candidates()</strong> для описания того, какие нейроны кандидата будут
  генерироваться этим массивом.
  
  Функции активации по умолчанию: <info>FANN_SIGMOID</info>, <info>FANN_SIGMOID_SYMMETRIC</info>, <info>FANN_GAUSSIAN</info>,
  <info>FANN_GAUSSIAN_SYMMETRIC</info>, <info>FANN_ELLIOT</info>, <info>FANN_ELLIOT_SYMMETRIC</info>.

<comment>Param:</comment>
  <info>resource</info>  <strong>$ann</strong>  Ресурс (<info>resource</info>) нейронной сети.

<comment>Return:</comment>
  <info>array</info>  Функции каскадной активации или <info>false</info> в случае возникновения ошибки.

<comment>See Also:</comment>
   * <strong>fann_get_cascade_activation_functions_count()</strong>
   * <strong>fann_set_cascade_activation_functions()</strong>


id: fann_get_cascade_activation_functions_count
type: function
doc:
<comment>Description:</comment>
  Возвращает количество функций каскадной активации
  
  Количество функций активации в массиве <strong>fann_get_cascade_activation_functions()</strong>.
  
  Количество функций активации по умолчанию - 6.

<comment>Param:</comment>
  <info>resource</info>  <strong>$ann</strong>  Ресурс (<info>resource</info>) нейронной сети.

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

<comment>See Also:</comment>
   * <strong>fann_get_cascade_activation_functions()</strong>
   * <strong>fann_set_cascade_activation_functions()</strong>


id: fann_get_cascade_activation_steepnesses
type: function
doc:
<comment>Description:</comment>
  Возвращает крутизну каскадной активации
  
  Массив крутизны каскадной активации - это массив различных функций активации, используемых
  кандидатами.
  
  Смотрите <strong>fann_get_cascade_num_candidates()</strong> для описания того, какие кандидатные нейроны будут
  генерироваться этим массивом.
  
  Крутизна активации по умолчанию: {0,25, 0,50, 0,75, 1,00}.

<comment>Param:</comment>
  <info>resource</info>  <strong>$ann</strong>  Ресурс (<info>resource</info>) нейронной сети.

<comment>Return:</comment>
  <info>array</info>  Крутизна каскадной активации или <info>false</info> в случае возникновения ошибки.

<comment>See Also:</comment>
   * <strong>fann_get_cascade_activation_steepnesses_count()</strong>
   * <strong>fann_set_cascade_activation_steepnesses()</strong>


id: fann_get_cascade_activation_steepnesses_count
type: function
doc:
<comment>Description:</comment>
  Количество крутизны активации
  
  Количество крутизны активации в массиве <strong>fann_get_cascade_activation_functions()</strong>.
  
  Количество крутизны активации по умолчанию - 4.

<comment>Param:</comment>
  <info>resource</info>  <strong>$ann</strong>  Ресурс (<info>resource</info>) нейронной сети.

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

<comment>See Also:</comment>
   * <strong>fann_get_cascade_activation_steepnesses()</strong>
   * <strong>fann_set_cascade_activation_functions()</strong>


id: fann_get_cascade_candidate_change_fraction
type: function
doc:
<comment>Description:</comment>
  Возвращает долю изменения каскада кандидата
  
  Доля изменения каскада кандидата - это число от 0 до 1, определяющее, насколько велико значение
  <strong>fann_get_MSE()</strong>, которое должно измениться в пределах
  <strong>fann_get_cascade_candidate_stagnation_epochs()</strong> во время обучения нейронов-кандидатов, чтобы
  обучение не застаивалось. Если обучение застаивается, обучение нейронов-кандидатов прекращается и
  выбирается лучший кандидат.
  
  Это означает, что если MSE не изменяется на долю <strong>fann_get_cascade_candidate_change_fraction()</strong> в
  течение периода <strong>fann_get_cascade_candidate_stagnation_epochs()</strong>, обучение нейронов-кандидатов
  прекращается, потому что обучение застопорилось.
  
  Если доля изменения каскада кандидатов мала, нейроны-кандидаты будут обучаться больше, а если доля
  высокая, они будут обучаться меньше.
  
  Доля изменения каскада кандидата по умолчанию составляет 0.01, что эквивалентно изменению MSE на
  1%.

<comment>Param:</comment>
  <info>resource</info>  <strong>$ann</strong>  Ресурс (<info>resource</info>) нейронной сети.

<comment>Return:</comment>
  <info>float</info>  Доля изменения каскада кандидата или <info>false</info> в случае возникновения ошибки.

<comment>See Also:</comment>
   * <strong>fann_set_cascade_candidate_change_fraction()</strong>
   * <strong>fann_get_MSE()</strong>
   * <strong>fann_get_cascade_candidate_stagnation_epochs()</strong>


id: fann_get_cascade_candidate_limit
type: function
doc:
<comment>Description:</comment>
  Возвращает предел кандидата
  
  Предел кандидата - это предел того, сколько нейронов кандидата может быть обучено. Ограничение -
  это ограничение на соотношение между MSE и баллом кандидата.
  
  Устанавливает это на более низкое значение, чтобы избежать переоснащения, и на более высокое, если
  переоснащение не является проблемой.
  
  Предельное число кандидатов по умолчанию составляет 1000.0.

<comment>Param:</comment>
  <info>resource</info>  <strong>$ann</strong>  Ресурс (<info>resource</info>) нейронной сети.

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

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


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

<comment>Param:</comment>
  <info>resource</info>  <strong>$ann</strong>  Ресурс (<info>resource</info>) нейронной сети.

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

<comment>See Also:</comment>
   * <strong>fann_set_cascade_candidate_stagnation_epochs()</strong>
   * <strong>fann_get_cascade_candidate_change_fraction()</strong>


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

<comment>Param:</comment>
  <info>resource</info>  <strong>$ann</strong>  Ресурс (<info>resource</info>) нейронной сети.

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

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


id: fann_get_cascade_max_out_epochs
type: function
doc:
<comment>Description:</comment>
  Возвращает максимальное количество периодов
  
  Максимальное количество периодов определяет количество периодов, в которых выходные соединения
  могут быть обучены после добавления нового нейрона-кандидата.
  
  Максимальное количество периодов равно 150.

<comment>Param:</comment>
  <info>resource</info>  <strong>$ann</strong>  Ресурс (<info>resource</info>) нейронной сети.

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

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


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

<comment>Param:</comment>
  <info>resource</info>  <strong>$ann</strong>  Ресурс (<info>resource</info>) нейронной сети.

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

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


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

<comment>Param:</comment>
  <info>resource</info>  <strong>$ann</strong>  Ресурс (<info>resource</info>) нейронной сети.

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

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


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

<comment>Param:</comment>
  <info>resource</info>  <strong>$ann</strong>  Ресурс (<info>resource</info>) нейронной сети.

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

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


id: fann_get_cascade_num_candidates
type: function
doc:
<comment>Description:</comment>
  Возвращает количество кандидатов, использованных во время обучения
  
  Количество кандидатов, использованных во время обучения (рассчитывается путём перемножения
  <strong>fann_get_cascade_activation_functions_count()</strong>, <strong>fann_get_cascade_activation_steepnesses_count()</strong> и
  <strong>fann_get_cascade_num_candidate_groups()</strong>).
  
  Фактические кандидаты определяются массивами <strong>fann_get_cascade_activation_functions()</strong> и
  <strong>fann_get_cascade_activation_steepnesses()</strong>. Эти массивы определяют функции активации и крутизны
  активации, используемые для нейронов-кандидатов. Если есть 2 функции активации в массиве функций
  активации и 3 крутизны в массиве крутизны, тогда будет 2 x 3 = 6 различных кандидатов, которые
  будут обучены. Эти 6 разных кандидатов могут быть скопированы в несколько групп кандидатов, где
  единственное различие между этими группами - начальные веса. Если количество групп равно 2, то
  количество нейронов-кандидатов будет 2 x 3 x 2 = 12. Количество групп кандидатов определяется
  <strong>fann_set_cascade_num_candidate_groups()</strong>.
  
  Количество кандидатов по умолчанию - 6 x 4 x 2 = 48.

<comment>Param:</comment>
  <info>resource</info>  <strong>$ann</strong>  Ресурс (<info>resource</info>) нейронной сети.

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

<comment>See Also:</comment>
   * <strong>fann_get_cascade_activation_functions()</strong>
   * <strong>fann_get_cascade_activation_functions_count()</strong>
   * <strong>fann_get_cascade_activation_steepnesses()</strong>
   * <strong>fann_get_cascade_activation_steepnesses_count()</strong>
   * <strong>fann_get_cascade_num_candidate_groups()</strong>


id: fann_get_cascade_output_change_fraction
type: function
doc:
<comment>Description:</comment>
  Возвращает долю изменения выхода каскада
  
  Доля изменения выхода каскада - это число от 0 до 1, определяющее, насколько большая часть
  значения <strong>fann_get_MSE()</strong> должна измениться в <strong>fann_get_cascade_output_stagnation_epochs()</strong> во время
  обучения выходных соединений, чтобы обучение, чтобы не застаивалось. Если обучение застопорится,
  обучение выходных соединений будет прекращено и будут подготовлены новые кандидаты.
  
  Это означает, что если MSE не изменяется на долю <strong>fann_get_cascade_output_change_fraction()</strong> в
  течение периода <strong>fann_get_cascade_output_stagnation_epochs()</strong>, обучение выходных соединений
  прекратится, потому что обучение застопорилось.
  
  Если доля изменения выхода каскада мала, выходные соединения будут обучаться больше, а если доля
  высокая, они будут обучаться меньше.
  
  Доля изменения выхода каскада по умолчанию составляет 0.01, что эквивалентно изменению MSE на 1%.

<comment>Param:</comment>
  <info>resource</info>  <strong>$ann</strong>  Ресурс (<info>resource</info>) нейронной сети.

<comment>Return:</comment>
  <info>float</info>  Доля изменения выхода каскада или <info>false</info> в случае возникновения ошибки.

<comment>See Also:</comment>
   * <strong>fann_set_cascade_output_change_fraction()</strong>
   * <strong>fann_get_MSE()</strong>
   * <strong>fann_get_cascade_output_stagnation_epochs()</strong>


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

<comment>Param:</comment>
  <info>resource</info>  <strong>$ann</strong>  Ресурс (<info>resource</info>) нейронной сети.

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

<comment>See Also:</comment>
   * <strong>fann_set_cascade_output_stagnation_epochs()</strong>
   * <strong>fann_get_cascade_output_change_fraction()</strong>


id: fann_get_cascade_weight_multiplier
type: function
doc:
<comment>Description:</comment>
  Возвращает множитель веса
  
  Множитель веса - это параметр, который используется для умножения веса нейрона-кандидата перед
  добавлением нейрона в нейронную сеть. Этот параметр обычно находится в диапазоне от 0 до 1 и
  используется, чтобы сделать тренировку менее агрессивной.
  
  Множитель веса по умолчанию равен 0.4.

<comment>Param:</comment>
  <info>resource</info>  <strong>$ann</strong>  Ресурс (<info>resource</info>) нейронной сети.

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

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


id: fann_get_connection_array
type: function
doc:
<comment>Description:</comment>
  Получает соединения в сети
  
  Получает соединения в сети.

<comment>Param:</comment>
  <info>resource</info>  <strong>$ann</strong>  Ресурс (<info>resource</info>) нейронной сети.

<comment>Return:</comment>
  <info>array</info>  Массив соединений в сети.


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

<comment>Param:</comment>
  <info>resource</info>  <strong>$ann</strong>  Ресурс (<info>resource</info>) нейронной сети.

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


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

<comment>Param:</comment>
  <info>resource</info>  <strong>$errdat</strong>  Или ресурс (<info>resource</info>) нейронной сети, или ресурс (<info>resource</info>) обучающих данных
                     нейронной сети.

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

<comment>See Also:</comment>
   * <strong>fann_reset_errno()</strong>
   * <strong>fann_get_errstr()</strong>


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

<comment>Param:</comment>
  <info>resource</info>  <strong>$errdat</strong>  Или ресурс (<info>resource</info>) нейронной сети, или ресурс (<info>resource</info>) обучающих данных
                     нейронной сети.

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

<comment>See Also:</comment>
   * <strong>fann_reset_errstr()</strong>
   * <strong>fann_get_errno()</strong>


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

<comment>Param:</comment>
  <info>resource</info>  <strong>$ann</strong>  Ресурс (<info>resource</info>) нейронной сети.

<comment>Return:</comment>
  <info>array</info>  Массив чисел нейтронов в каждом слое.


id: fann_get_learning_momentum
type: function
doc:
<comment>Description:</comment>
  Возвращает импульс обучения
  
  Импульс обучения можно использовать для ускорения обучения <info>FANN_TRAIN_INCREMENTAL</info>. Однако слишком
  высокий импульс не принесёт пользы тренировкам. Установка импульса на 0 будет равносильна
  отключению параметра импульса. Рекомендуемое значение этого параметра составляет от 0.0 до 1.0.
  
  Импульс по умолчанию равен 0.

<comment>Param:</comment>
  <info>resource</info>  <strong>$ann</strong>  Ресурс (<info>resource</info>) нейронной сети.

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

<comment>See Also:</comment>
   * <strong>fann_set_learning_momentum()</strong>
   * <strong>fann_set_training_algorithm()</strong>


id: fann_get_learning_rate
type: function
doc:
<comment>Description:</comment>
  Возвращает скорость обучения
  
  Скорость обучения используется для определения того, насколько агрессивным должно быть обучение
  для некоторых алгоритмов обучения (<info>FANN_TRAIN_INCREMENTAL</info>, <info>FANN_TRAIN_BATCH</info>,
  <info>FANN_TRAIN_QUICKPROP</info>). Однако обратите внимание, что она не используется в <info>FANN_TRAIN_RPROP</info>.
  
  Скорость обучения по умолчанию равна 0.7.

<comment>Param:</comment>
  <info>resource</info>  <strong>$ann</strong>  Ресурс (<info>resource</info>) нейронной сети.

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

<comment>See Also:</comment>
   * <strong>fann_set_learning_rate()</strong>
   * <strong>fann_set_training_algorithm()</strong>


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

<comment>Param:</comment>
  <info>resource</info>  <strong>$ann</strong>  Ресурс (<info>resource</info>) нейронной сети.

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


id: fann_get_num_input
type: function
doc:
<comment>Description:</comment>
  Получает количество входных нейронов
  
  Получает количество входных нейронов.

<comment>Param:</comment>
  <info>resource</info>  <strong>$ann</strong>  Ресурс (<info>resource</info>) нейронной сети.

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


id: fann_get_num_layers
type: function
doc:
<comment>Description:</comment>
  Получает количество слоёв в нейронной сети
  
  Получает количество слоёв в нейронной сети.

<comment>Param:</comment>
  <info>resource</info>  <strong>$ann</strong>  Ресурс (<info>resource</info>) нейронной сети.

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


id: fann_get_num_output
type: function
doc:
<comment>Description:</comment>
  Получает количество выходных нейронов
  
  Получает количество выходных нейронов.

<comment>Param:</comment>
  <info>resource</info>  <strong>$ann</strong>  Ресурс (<info>resource</info>) нейронной сети.

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


id: fann_get_quickprop_decay
type: function
doc:
<comment>Description:</comment>
  Возвращает снижение, которое является фактором, при котором веса должны уменьшаться на каждой
  итерации во время обучения quickprop
  
  Снижение - это небольшое число с отрицательными значениями, которое является фактором, по которому
  веса должны уменьшаться на каждой итерации во время обучения quickprop. Используется для того,
  чтобы во время обучения веса не становились слишком высокими.
  
  The default decay is -0.0001.

<comment>Param:</comment>
  <info>resource</info>  <strong>$ann</strong>  Ресурс (<info>resource</info>) нейронной сети.

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

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


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

<comment>Param:</comment>
  <info>resource</info>  <strong>$ann</strong>  Ресурс (<info>resource</info>) нейронной сети.

<comment>Return:</comment>
  <info>float</info>  Коэффициент mu или <info>false</info> в случае возникновения ошибки.

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


id: fann_get_rprop_decrease_factor
type: function
doc:
<comment>Description:</comment>
  Возвращает коэффициент уменьшения, используемый во время обучения RPROP
  
  Коэффициент уменьшения - это значение меньше 1, которое используется для уменьшения размера шага
  во время обучения RPROP.
  
  Коэффициент уменьшения по умолчанию составляет 0.5.

<comment>Param:</comment>
  <info>resource</info>  <strong>$ann</strong>  Ресурс (<info>resource</info>) нейронной сети.

<comment>Return:</comment>
  <info>float</info>  Коэффициент уменьшения или <info>false</info> в случае возникновения ошибки.

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


id: fann_get_rprop_delta_max
type: function
doc:
<comment>Description:</comment>
  Возвращает максимальный размер шага
  
  Максимальный размер шага - это положительное число, определяющее, насколько большим может быть
  максимальный размер шага.
  
  Максимальное значение дельты по умолчанию составляет 50.0.

<comment>Param:</comment>
  <info>resource</info>  <strong>$ann</strong>  Ресурс (<info>resource</info>) нейронной сети.

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

<comment>See Also:</comment>
   * <strong>fann_set_rprop_delta_max()</strong>
   * <strong>fann_get_rprop_delta_min()</strong>


id: fann_get_rprop_delta_min
type: function
doc:
<comment>Description:</comment>
  Возвращает минимальный размер шага
  
  Минимальный размер шага - это небольшое положительное число, определяющее, насколько маленьким
  может быть минимальный размер шага.
  
  Значение дельты по умолчанию min равно 0.0.

<comment>Param:</comment>
  <info>resource</info>  <strong>$ann</strong>  Ресурс (<info>resource</info>) нейронной сети.

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

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


id: fann_get_rprop_delta_zero
type: function
doc:
<comment>Description:</comment>
  Возвращает начальный размер шага
  
  Первоначальный размер шага - это положительное число, определяющее начальный размер шага.
  
  По умолчанию нулевое значение дельты равно 0.1.

<comment>Param:</comment>
  <info>resource</info>  <strong>$ann</strong>  Ресурс (<info>resource</info>) нейронной сети.

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

<comment>See Also:</comment>
   * <strong>fann_set_rprop_delta_zero()</strong>
   * <strong>fann_get_rprop_delta_min()</strong>
   * <strong>fann_get_rprop_delta_max()</strong>


id: fann_get_rprop_increase_factor
type: function
doc:
<comment>Description:</comment>
  Возвращает коэффициент увеличения, используемый во время обучения RPROP
  
  Коэффициент увеличения - это значение больше 1, которое используется для увеличения размера шага
  во время обучения RPROP.
  
  Коэффициент увеличения по умолчанию составляет 1.2.

<comment>Param:</comment>
  <info>resource</info>  <strong>$ann</strong>  Ресурс (<info>resource</info>) нейронной сети.

<comment>Return:</comment>
  <info>float</info>  Коэффициент увеличения или <info>false</info> в случае возникновения ошибки.

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


id: fann_get_sarprop_step_error_shift
type: function
doc:
<comment>Description:</comment>
  Возвращает сдвиг ошибки шага sarprop
  
  Возвращает сдвиг ошибки шага sarprop.
  
  Сдвиг ошибки шага по умолчанию составляет 1.385.

<comment>Param:</comment>
  <info>resource</info>  <strong>$ann</strong>  Ресурс (<info>resource</info>) нейронной сети.

<comment>Return:</comment>
  <info>float</info>  Сдвиг ошибки шага sarprop или <info>false</info> в случае возникновения ошибки.

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


id: fann_get_sarprop_step_error_threshold_factor
type: function
doc:
<comment>Description:</comment>
  Возвращает пороговый коэффициент ошибки шага sarprop
  
  Возвращает пороговый коэффициент ошибки шага sarprop.
  
  Коэффициент по умолчанию составляет 0.1.

<comment>Param:</comment>
  <info>resource</info>  <strong>$ann</strong>  Ресурс (<info>resource</info>) нейронной сети.

<comment>Return:</comment>
  <info>float</info>  Пороговый коэффициент ошибки шага или <info>false</info> в случае возникновения ошибки.

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


id: fann_get_sarprop_temperature
type: function
doc:
<comment>Description:</comment>
  Возвращает температуру sarprop
  
  Возвращает температуру sarprop.
  
  Температура по умолчанию составляет 0.015.

<comment>Param:</comment>
  <info>resource</info>  <strong>$ann</strong>  Ресурс (<info>resource</info>) нейронной сети.

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

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


id: fann_get_sarprop_weight_decay_shift
type: function
doc:
<comment>Description:</comment>
  Возвращает сдвиг уменьшения веса sarprop
  
  Возвращает сдвиг уменьшения веса sarprop.
  
  Максимальная дельта по умолчанию составляет -6.644.

<comment>Param:</comment>
  <info>resource</info>  <strong>$ann</strong>  Ресурс (<info>resource</info>) нейронной сети.

<comment>Return:</comment>
  <info>float</info>  Сдвиг уменьшения веса sarprop или <info>false</info> в случае возникновения ошибки.

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


id: fann_get_total_connections
type: function
doc:
<comment>Description:</comment>
  Получает общее количество соединений во всей сети
  
  Получает общее количество соединений во всей сети.

<comment>Param:</comment>
  <info>resource</info>  <strong>$ann</strong>  Ресурс (<info>resource</info>) нейронной сети.

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


id: fann_get_total_neurons
type: function
doc:
<comment>Description:</comment>
  Получает общее количество нейронов во всей сети
  
  Получает общее количество нейронов во всей сети. Число также включает нейроны смещения, поэтому у
  сети 2-4-2 есть 2+4+2 +2 (смещение) = 10 нейронов.

<comment>Param:</comment>
  <info>resource</info>  <strong>$ann</strong>  Ресурс (<info>resource</info>) нейронной сети.

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


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

<comment>Param:</comment>
  <info>resource</info>  <strong>$ann</strong>  Ресурс (<info>resource</info>) нейронной сети.

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

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


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

<comment>Param:</comment>
  <info>resource</info>  <strong>$ann</strong>  Ресурс (<info>resource</info>) нейронной сети.

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

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


id: fann_get_training_algorithm
type: function
doc:
<comment>Description:</comment>
  Возвращает алгоритм обучения
  
  Возвращает алгоритм обучения. Этот алгоритм обучения используется <strong>fann_train_on_data()</strong> и
  связанными функциями.
  
  Обратите внимание, что этот алгоритм также используется во время <strong>fann_cascadetrain_on_data()</strong>, хотя
  во время каскадного обучения разрешены только <info>FANN_TRAIN_RPROP</info> and <info>FANN_TRAIN_QUICKPROP</info>.

<comment>Param:</comment>
  <info>resource</info>  <strong>$ann</strong>  Ресурс (<info>resource</info>) нейронной сети.

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

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


id: fann_init_weights
type: function
doc:
<comment>Description:</comment>
  Инициализирует веса с помощью алгоритма Widrow + Nguyen
  
  Инициализирует веса с помощью алгоритма Widrow + Nguyen.
  
  Функция ведёт себя аналогично <strong>fann_randomize_weights()</strong>. Она будет использовать алгоритм,
  разработанный Дерриком Нгуеном и Бернардом Видроу, чтобы установить веса таким образом, чтобы
  ускорить обучение. Метод не всегда бывает успешным, а в некоторых случаях может быть менее
  эффективным, чем чисто случайная инициализация.
  
  Алгоритм требует доступа к диапазону входных данных (например, наибольшим и наименьшим входным
  данным) и, следовательно, принимает второй аргумент, data, который является обучающими данными,
  которые будут использоваться для обучения сети.

<comment>Param:</comment>
  <info>resource</info>  <strong>$ann</strong>         Ресурс (<info>resource</info>) нейронной сети.
  <info>resource</info>  <strong>$train_data</strong>  Ресурс (<info>resource</info>) обучающих данных нейронной сети.

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

<comment>See Also:</comment>
   * <strong>fann_randomize_weights()</strong>
   * <strong>fann_read_train_from_file()</strong>


id: fann_length_train_data
type: function
doc:
<comment>Description:</comment>
  Возвращает количество шаблонов в обучающих данных
  
  Возвращает количество шаблонов в ресурсе (<info>resource</info>) обучающих данных.

<comment>Param:</comment>
  <info>resource</info>  <strong>$data</strong>  Ресурс (<info>resource</info>) обучающих данных нейронной сети.

<comment>Return:</comment>
  <info>int</info>  Количество элементов в ресурсе (<info>resource</info>) обучающих данных или <info>false</info> в случае возникновения
       ошибки.


id: fann_merge_train_data
type: function
doc:
<comment>Description:</comment>
  Объединяет обучающие данные
  
  Объединяет данные из data1 и data2 в новый ресурс (<info>resource</info>) обучающих данных.

<comment>Param:</comment>
  <info>resource</info>  <strong>$data1</strong>  Ресурс (<info>resource</info>) обучающих данных нейронной сети.
  <info>resource</info>  <strong>$data2</strong>  Ресурс (<info>resource</info>) обучающих данных нейронной сети.

<comment>Return:</comment>
  <info>resource</info>  Новый ресурс (<info>resource</info>) объединённых обучающих данных или <info>false</info> в случае возникновения
            ошибки.


id: fann_num_input_train_data
type: function
doc:
<comment>Description:</comment>
  Возвращает количество входных данных в каждом из шаблонов в обучающих данных
  
  Возвращает количество входных данных в каждом из шаблонов в ресурсе (<info>resource</info>) обучающих данных.

<comment>Param:</comment>
  <info>resource</info>  <strong>$data</strong>  Ресурс (<info>resource</info>) обучающих данных нейронной сети.

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

<comment>See Also:</comment>
   * <strong>fann_length_train_data()</strong>
   * <strong>fann_num_output_train_data()</strong>


id: fann_num_output_train_data
type: function
doc:
<comment>Description:</comment>
  Возвращает количество выходных данных в каждом из шаблонов в обучающих данных
  
  Возвращает количество выходных данных в каждом из шаблонов в ресурсе (<info>resource</info>) обучающих данных.

<comment>Param:</comment>
  <info>resource</info>  <strong>$data</strong>  Ресурс (<info>resource</info>) обучающих данных нейронной сети.

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

<comment>See Also:</comment>
   * <strong>fann_length_train_data()</strong>
   * <strong>fann_num_input_train_data()</strong>


id: fann_print_error
type: function
doc:
<comment>Description:</comment>
  Выводит строку ошибки
  
  Выводит строку ошибки.

<comment>Param:</comment>
  <info>resource</info>  <strong>$errdat</strong>  Или ресурс (<info>resource</info>) нейронной сети, или ресурс (<info>resource</info>) обучающих данных
                     нейронной сети.

<comment>Return:</comment>
  <info>void</info>  Не возвращает никакого значения.

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


id: fann_randomize_weights
type: function
doc:
<comment>Description:</comment>
  Присваивает каждому соединению случайный вес между min_weight и max_weight
  
  Присваивает каждому соединению случайный вес между <strong>$min_weight</strong> и <strong>$max_weight</strong>
  
  С самого начала случайный вес в диапазоне от -0,1 до 0,1.

<comment>Param:</comment>
  <info>resource</info>  <strong>$ann</strong>         Ресурс (<info>resource</info>) нейронной сети.
  <info>float</info>     <strong>$min_weight</strong>  Минимальное значение веса.
  <info>float</info>     <strong>$max_weight</strong>  Максимальное значение веса.

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

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


id: fann_read_train_from_file
type: function
doc:
<comment>Description:</comment>
  Читает файл, в котором хранятся данные обучения
  
  Читает файл, в котором хранятся данные обучения.

<comment>Param:</comment>
  <info>string</info>  <strong>$filename</strong>  Входной файл в следующем формате:

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

<comment>See Also:</comment>
   * <strong>fann_train_on_data()</strong>
   * <strong>fann_destroy_train()</strong>
   * <strong>fann_save_train()</strong>


id: fann_reset_MSE
type: function
doc:
<comment>Description:</comment>
  Сбрасывает среднеквадратичную ошибку из сети
  
  Сбрасывает среднеквадратичную ошибку из сети.
  
  Функция также сбрасывает количество вышедших из строя битов.

<comment>Param:</comment>
  <info>string</info>  <strong>$ann</strong>  Ресурс (<info>resource</info>) нейронной сети.

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

<comment>See Also:</comment>
   * <strong>fann_get_MSE()</strong>
   * <strong>fann_get_bit_fail()</strong>
   * <strong>fann_get_bit_fail_limit()</strong>


id: fann_reset_errno
type: function
doc:
<comment>Description:</comment>
  Сбрасывает номер последней ошибки
  
  Сбрасывает номер последней ошибки.

<comment>Param:</comment>
  <info>resource</info>  <strong>$errdat</strong>  Или ресурс (<info>resource</info>) нейронной сети, или ресурс (<info>resource</info>) обучающих данных
                     нейронной сети.

<comment>Return:</comment>
  <info>void</info>  Не возвращает никакого значения.

<comment>See Also:</comment>
   * <strong>fann_get_errno()</strong>
   * <strong>fann_reset_errstr()</strong>


id: fann_reset_errstr
type: function
doc:
<comment>Description:</comment>
  Сбрасывает последнюю строку ошибки
  
  Сбрасывает последнюю строку ошибки.

<comment>Param:</comment>
  <info>resource</info>  <strong>$errdat</strong>  Или ресурс (<info>resource</info>) нейронной сети, или ресурс (<info>resource</info>) обучающих данных
                     нейронной сети.

<comment>Return:</comment>
  <info>void</info>  Не возвращает никакого значения.

<comment>See Also:</comment>
   * <strong>fann_get_errstr()</strong>
   * <strong>fann_reset_errno()</strong>


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

<comment>Param:</comment>
  <info>resource</info>  <strong>$ann</strong>    Ресурс (<info>resource</info>) нейронной сети.
  <info>array</info>     <strong>$input</strong>  Массив входных данных

<comment>Return:</comment>
  <info>array</info>  Массив выходных данных, либо <info>false</info> в случае возникновения ошибки.


id: fann_save
type: function
doc:
<comment>Description:</comment>
  Сохраняет всю сеть в файл конфигурации
  
  Сохраняет всю сеть в файл конфигурации.
  
  Файл конфигурации содержит всю информацию о нейронной сети и позволяет функции
  <strong>fann_create_from_file()</strong> создавать точную копию нейронной сети и всех параметров, связанных с
  нейронной сетью.
  
  Три параметра (<strong>fann_set_callback()</strong>, <strong>fann_set_error_log()</strong>, <strong>fann_set_user_data()</strong>) НЕ сохраняются в
  файл, потому что их нельзя безопасно перенести в другое место. Также не сохраняются временные
  параметры, сгенерированные во время обучения, такие как <strong>fann_get_MSE()</strong>.

<comment>Param:</comment>
  <info>resource</info>  <strong>$ann</strong>                 Ресурс (<info>resource</info>) нейронной сети.
  <info>string</info>    <strong>$configuration_file</strong>  Путь к файлу конфигурации.

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

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


id: fann_save_train
type: function
doc:
<comment>Description:</comment>
  Сохраняет структуру обучения в файл
  
  Сохраняет данные обучения в файл в формате, указанном в <strong>fann_read_train_from_file()</strong>.

<comment>Param:</comment>
  <info>resource</info>  <strong>$data</strong>       Ресурс (<info>resource</info>) обучающих данных нейронной сети.
  <info>string</info>    <strong>$file_name</strong>  Имя файла, в котором сохраняются данные обучения.

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

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


id: fann_scale_input
type: function
doc:
<comment>Description:</comment>
  Масштабирует данные во входном векторе перед подачей их в ann на основе ранее рассчитанных
  параметров
  
  Масштабирует данные во входном векторе перед подачей их в ann на основе ранее рассчитанных
  параметров.

<comment>Param:</comment>
  <info>resource</info>  <strong>$ann</strong>           Ресурс (<info>resource</info>) нейронной сети.
  <info>array</info>     <strong>$input_vector</strong>  Входной вектор, который будет масштабирован.

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

<comment>See Also:</comment>
   * <strong>fann_descale_input()</strong>
   * <strong>fann_scale_output()</strong>


id: fann_scale_input_train_data
type: function
doc:
<comment>Description:</comment>
  Масштабирует входные данные в обучающих данных до указанного диапазона
  
  Масштабирует входные данные в обучающих данных до указанного диапазона.

<comment>Param:</comment>
  <info>resource</info>  <strong>$train_data</strong>  Ресурс (<info>resource</info>) обучающих данных нейронной сети.
  <info>float</info>     <strong>$new_min</strong>     Новый минимум после масштабирования входных данных в обучающих данных.
  <info>float</info>     <strong>$new_max</strong>     Новый максимум после масштабирования входных данных в обучающих данных.

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

<comment>See Also:</comment>
   * <strong>fann_scale_output_train_data()</strong>
   * <strong>fann_scale_train_data()</strong>


id: fann_scale_output
type: function
doc:
<comment>Description:</comment>
  Масштабирует данные в выходном векторе перед их передачей в ann на основе ранее рассчитанных
  параметров
  
  Масштабирует данные в выходном векторе перед их передачей в ann на основе ранее рассчитанных
  параметров.

<comment>Param:</comment>
  <info>resource</info>  <strong>$ann</strong>            Ресурс (<info>resource</info>) нейронной сети.
  <info>array</info>     <strong>$output_vector</strong>  Выходной вектор, который будет масштабирован.

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

<comment>See Also:</comment>
   * <strong>fann_descale_output()</strong>
   * <strong>fann_scale_input()</strong>


id: fann_scale_output_train_data
type: function
doc:
<comment>Description:</comment>
  Масштабирует выходные данные в обучающих данных до указанного диапазона
  
  Масштабирует выходные данные в обучающих данных до указанного диапазона.

<comment>Param:</comment>
  <info>resource</info>  <strong>$train_data</strong>  Ресурс (<info>resource</info>) обучающих данных нейронной сети.
  <info>float</info>     <strong>$new_min</strong>     Новый минимум после масштабирования выходных данных в обучающих данных.
  <info>float</info>     <strong>$new_max</strong>     Новый максимум после масштабирования выходных данных в обучающих данных.

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

<comment>See Also:</comment>
   * <strong>fann_scale_input_train_data()</strong>
   * <strong>fann_scale_train_data()</strong>


id: fann_scale_train
type: function
doc:
<comment>Description:</comment>
  Масштабирует входные и выходные данные на основе ранее рассчитанных параметров
  
  Масштабирует входные и выходные данные на основе ранее рассчитанных параметров.

<comment>Param:</comment>
  <info>resource</info>  <strong>$ann</strong>         Ресурс (<info>resource</info>) нейронной сети.
  <info>resource</info>  <strong>$train_data</strong>  Ресурс (<info>resource</info>) обучающих данных нейронной сети.

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

<comment>See Also:</comment>
   * <strong>fann_descale_train()</strong>
   * <strong>fann_set_scaling_params()</strong>


id: fann_scale_train_data
type: function
doc:
<comment>Description:</comment>
  Масштабирует входные и выходные данные в обучающих данных до указанного диапазона
  
  Масштабирует входные и выходные данные в обучающих данных до указанного диапазона.

<comment>Param:</comment>
  <info>resource</info>  <strong>$train_data</strong>  Ресурс (<info>resource</info>) обучающих данных нейронной сети.
  <info>float</info>     <strong>$new_min</strong>     Новый минимум после масштабирования входных и выходных данных в обучающих
                         данных.
  <info>float</info>     <strong>$new_max</strong>     Новый максимум после масштабирования входных и выходных данных в обучающих
                         данных.

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

<comment>See Also:</comment>
   * <strong>fann_scale_output_train_data()</strong>
   * <strong>fann_scale_input_train_data()</strong>


id: fann_set_activation_function
type: function
doc:
<comment>Description:</comment>
  Устанавливает функцию активации для указанного нейрона и слоя
  
  Установите функцию активации для нейрона номер <return>neuron</return> в слое номер <return>layer</return>, считая входной слой как
  слой 0.
  
  Невозможно установить функции активации для нейронов во входном слое.
  
  При выборе функции активации важно учитывать, что у функций активации разный диапазон.
  <info>FANN_SIGMOID</info>, например, в диапазоне от 0 до 1, в то время как <info>FANN_SIGMOID_SYMMETRIC</info> находится в
  диапазоне от -1 до 1, а <info>FANN_LINEAR</info> без ограничений.
  
  Предоставленное значение activation_function должно быть одной из констант функций активации.
  
  Возвращаемое значение - одна из констант функций активации.

<comment>Param:</comment>
  <info>resource</info>  <strong>$ann</strong>                  Ресурс (<info>resource</info>) нейронной сети.
  <info>int</info>       <strong>$activation_function</strong>  Константа функций активации.
  <info>int</info>       <strong>$layer</strong>                Номер слоя.
  <info>int</info>       <strong>$neuron</strong>               Номер нейрона.

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

<comment>See Also:</comment>
   * <strong>fann_set_activation_function_layer()</strong>
   * <strong>fann_set_activation_function_hidden()</strong>
   * <strong>fann_set_activation_function_output()</strong>
   * <strong>fann_set_activation_steepness()</strong>
   * <strong>fann_get_activation_function()</strong>


id: fann_set_activation_function_hidden
type: function
doc:
<comment>Description:</comment>
  Устанавливает функцию активации для всех скрытых слоёв
  
  Устанавливает функцию активации для всех скрытых слоёв.

<comment>Param:</comment>
  <info>resource</info>  <strong>$ann</strong>                  Ресурс (<info>resource</info>) нейронной сети.
  <info>int</info>       <strong>$activation_function</strong>  Константа функций активации.

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

<comment>See Also:</comment>
   * <strong>fann_set_activation_function()</strong>
   * <strong>fann_set_activation_function_layer()</strong>
   * <strong>fann_set_activation_function_output()</strong>
   * <strong>fann_set_activation_steepness()</strong>


id: fann_set_activation_function_layer
type: function
doc:
<comment>Description:</comment>
  Устанавливает функцию активации для всех нейронов в предоставленном слое
  
  Установите функцию активации для всех нейронов в слое номер <return>layer</return>, считая входной слой слоем 0.
  
  Невозможно установить функции активации для нейронов во входном слое.

<comment>Param:</comment>
  <info>resource</info>  <strong>$ann</strong>                  Ресурс (<info>resource</info>) нейронной сети.
  <info>int</info>       <strong>$activation_function</strong>  Константа функций активации.
  <info>int</info>       <strong>$layer</strong>                Номер слоя.

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

<comment>See Also:</comment>
   * <strong>fann_set_activation_function()</strong>
   * <strong>fann_set_activation_function_hidden()</strong>
   * <strong>fann_set_activation_function_output()</strong>
   * <strong>fann_set_activation_steepness()</strong>


id: fann_set_activation_function_output
type: function
doc:
<comment>Description:</comment>
  Устанавливает функцию активации для выходного слоя
  
  Устанавливает функцию активации для выходного слоя.

<comment>Param:</comment>
  <info>resource</info>  <strong>$ann</strong>                  Ресурс (<info>resource</info>) нейронной сети.
  <info>int</info>       <strong>$activation_function</strong>  Константа функций активации.

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

<comment>See Also:</comment>
   * <strong>fann_set_activation_function()</strong>
   * <strong>fann_set_activation_function_layer()</strong>
   * <strong>fann_set_activation_function_hidden()</strong>
   * <strong>fann_set_activation_steepness()</strong>


id: fann_set_activation_steepness
type: function
doc:
<comment>Description:</comment>
  Устанавливает крутизну активации для указанного нейрона и номера слоя
  
  Установите крутизну активации для нейрона номер <return>neuron</return> в слое номер <return>layer</return>, считая входной слой как
  слой 0.
  
  Невозможно установить крутизну активации нейронов во входном слое.
  
  Крутизна функции активации кое-что говорит о том, насколько быстро функция активации переходит от
  минимума к максимуму. Высокое значение функции активации также даст более агрессивное обучение.
  
  При обучении нейронных сетей, в которых выходные значения должны быть крайними (обычно 0 и 1, в
  зависимости от функции активации), может использоваться крутая функция активации (например, 1.0).
  
  По умолчанию крутизна активации составляет 0.5.

<comment>Param:</comment>
  <info>resource</info>  <strong>$ann</strong>                   Ресурс (<info>resource</info>) нейронной сети.
  <info>float</info>     <strong>$activation_steepness</strong>  Крутизна активации.
  <info>int</info>       <strong>$layer</strong>                 Номер слоя.
  <info>int</info>       <strong>$neuron</strong>                Номер нейрона.

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

<comment>See Also:</comment>
   * <strong>fann_set_activation_steepness_layer()</strong>
   * <strong>fann_set_activation_steepness_hidden()</strong>
   * <strong>fann_set_activation_steepness_output()</strong>
   * <strong>fann_get_activation_steepness()</strong>
   * <strong>fann_set_activation_function()</strong>


id: fann_set_activation_steepness_hidden
type: function
doc:
<comment>Description:</comment>
  Устанавливает крутизну крутизны активации для всех нейронов во всех скрытых слоях
  
  Устанавливает крутизну крутизны активации для всех нейронов во всех скрытых слоях.

<comment>Param:</comment>
  <info>resource</info>  <strong>$ann</strong>                   Ресурс (<info>resource</info>) нейронной сети.
  <info>float</info>     <strong>$activation_steepness</strong>  Крутизна активации.

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

<comment>See Also:</comment>
   * <strong>fann_set_activation_steepness()</strong>
   * <strong>fann_set_activation_steepness_layer()</strong>
   * <strong>fann_set_activation_steepness_output()</strong>
   * <strong>fann_get_activation_steepness()</strong>
   * <strong>fann_set_activation_function()</strong>


id: fann_set_activation_steepness_layer
type: function
doc:
<comment>Description:</comment>
  Устанавливает крутизну активации для всех нейронов в указанном номере слоя
  
  Установите крутизну активации для всех нейронов в слое номер <return>layer</return>, считая входной слой как слой
  0.
  
  Невозможно установить крутизну активации нейронов во входном слое.

<comment>Param:</comment>
  <info>resource</info>  <strong>$ann</strong>                   Ресурс (<info>resource</info>) нейронной сети.
  <info>float</info>     <strong>$activation_steepness</strong>  Крутизна активации.
  <info>int</info>       <strong>$layer</strong>                 Номер слоя.

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

<comment>See Also:</comment>
   * <strong>fann_set_activation_steepness()</strong>
   * <strong>fann_set_activation_steepness_hidden()</strong>
   * <strong>fann_set_activation_steepness_output()</strong>
   * <strong>fann_get_activation_steepness()</strong>
   * <strong>fann_set_activation_function()</strong>


id: fann_set_activation_steepness_output
type: function
doc:
<comment>Description:</comment>
  Устанавливает крутизну активации в выходном слое
  
  Устанавливает крутизну активации в выходном слое.

<comment>Param:</comment>
  <info>resource</info>  <strong>$ann</strong>                   Ресурс (<info>resource</info>) нейронной сети.
  <info>float</info>     <strong>$activation_steepness</strong>  Крутизна активации.

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

<comment>See Also:</comment>
   * <strong>fann_set_activation_steepness()</strong>
   * <strong>fann_set_activation_steepness_layer()</strong>
   * <strong>fann_set_activation_steepness_hidden()</strong>
   * <strong>fann_get_activation_steepness()</strong>
   * <strong>fann_set_activation_function()</strong>


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

<comment>Param:</comment>
  <info>resource</info>  <strong>$ann</strong>             Ресурс (<info>resource</info>) нейронной сети.
  <info>float</info>     <strong>$bit_fail_limit</strong>  Предел ошибок.

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

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


id: fann_set_callback
type: function
doc:
<comment>Description:</comment>
  Устанавливает callback-функцию для использования во время обучения
  
  Устанавливает callback-функцию для использования во время обучения. Это означает, что она
  вызывается из <strong>fann_train_on_data()</strong> или <strong>fann_train_on_file()</strong>.

<comment>Param:</comment>
  <info>resource</info>  <strong>$ann</strong>       Ресурс (<info>resource</info>) нейронной сети.
  <info>callable</info>  <strong>$callback</strong>  Поставляемая callback-функция принимает следующие параметры: <return>ann</return> - Ресурс
                       (<info>resource</info>) нейронной сети<return>train</return> - Ресурс (<info>resource</info>) данных для обучения или
                       <info>null</info>, если вызывается из <strong>fann_train_on_file()</strong><return>max_epochs</return> - Максимальное
                       количество периодов, в которых должно продолжаться
                       обучение<return>epochs_between_reports</return> - Количество периодов между вызовами этой
                       функции<return>desired_error</return> - Желаемая функция <strong>fann_get_MSE()</strong> или
                       <strong>fann_get_bit_fail()</strong>, в зависимости от функции остановки, выбранной
                       <strong>fann_set_train_stop_function()</strong><return>epochs</return> - Текущий период
                       
                       Callback-функция должна вернуть <info>true</info>. Если она вернёт <info>false</info>, обучение будет
                       прекращено.

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

<comment>See Also:</comment>
   * <strong>fann_train_on_data()</strong>
   * <strong>fann_train_on_file()</strong>


id: fann_set_cascade_activation_functions
type: function
doc:
<comment>Description:</comment>
  Устанавливает массив каскадных функций активации кандидатов
  
  Устанавливает массив каскадных функций активации кандидатов.
  
  Смотрите <strong>fann_get_cascade_num_candidates()</strong> для описания того, какие нейроны-кандидаты будут
  сгенерированы этим массивом.

<comment>Param:</comment>
  <info>resource</info>  <strong>$ann</strong>                           Ресурс (<info>resource</info>) нейронной сети.
  <info>array</info>     <strong>$cascade_activation_functions</strong>  Массив каскадных функций активации кандидатов.

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

<comment>See Also:</comment>
   * <strong>fann_get_cascade_activation_functions_count()</strong>
   * <strong>fann_set_cascade_activation_functions()</strong>


id: fann_set_cascade_activation_steepnesses
type: function
doc:
<comment>Description:</comment>
  Устанавливает массив крутизны включения кандидатов в каскад
  
  Устанавливает массив крутизны включения кандидатов в каскад.
  
  Смотрите <strong>fann_get_cascade_num_candidates()</strong> для описания того, какие нейроны-кандидаты будут
  сгенерированы этим массивом.

<comment>Param:</comment>
  <info>resource</info>  <strong>$ann</strong>                                   Ресурс (<info>resource</info>) нейронной сети.
  <info>array</info>     <strong>$cascade_activation_steepnesses_count</strong>  Массив крутизны включения кандидатов в каскад.

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

<comment>See Also:</comment>
   * <strong>fann_get_cascade_activation_steepnesses()</strong>
   * <strong>fann_get_cascade_activation_steepnesses_count()</strong>


id: fann_set_cascade_candidate_change_fraction
type: function
doc:
<comment>Description:</comment>
  Устанавливает долю каскадного изменения кандидата
  
  Устанавливает долю каскадного изменения кандидата.

<comment>Param:</comment>
  <info>resource</info>  <strong>$ann</strong>                                Ресурс (<info>resource</info>) нейронной сети.
  <info>float</info>     <strong>$cascade_candidate_change_fraction</strong>  Доля каскадного изменения кандидата.

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

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


id: fann_set_cascade_candidate_limit
type: function
doc:
<comment>Description:</comment>
  Устанавливает лимит кандидатов
  
  Устанавливает лимит кандидатов.

<comment>Param:</comment>
  <info>resource</info>  <strong>$ann</strong>                      Ресурс (<info>resource</info>) нейронной сети.
  <info>float</info>     <strong>$cascade_candidate_limit</strong>  Лимит кандидатов.

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

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


id: fann_set_cascade_candidate_stagnation_epochs
type: function
doc:
<comment>Description:</comment>
  Устанавливает количество каскадных периодов застоя кандидатов
  
  Устанавливает количество каскадных периодов застоя кандидатов.

<comment>Param:</comment>
  <info>resource</info>  <strong>$ann</strong>                                  Ресурс (<info>resource</info>) нейронной сети.
  <info>int</info>       <strong>$cascade_candidate_stagnation_epochs</strong>  Количество каскадных периодов застоя кандидатов.

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

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


id: fann_set_cascade_max_cand_epochs
type: function
doc:
<comment>Description:</comment>
  Устанавливает наибольший период кандидата
  
  Устанавливает наибольший период кандидата.

<comment>Param:</comment>
  <info>resource</info>  <strong>$ann</strong>                      Ресурс (<info>resource</info>) нейронной сети.
  <info>int</info>       <strong>$cascade_max_cand_epochs</strong>  Наибольший период кандидата.

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

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


id: fann_set_cascade_max_out_epochs
type: function
doc:
<comment>Description:</comment>
  Устанавливает максимальное количество эпох
  
  Устанавливает максимальное количество эпох.

<comment>Param:</comment>
  <info>resource</info>  <strong>$ann</strong>                     Ресурс (<info>resource</info>) нейронной сети.
  <info>int</info>       <strong>$cascade_max_out_epochs</strong>  Максимальное количество эпох.

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

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


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

<comment>Param:</comment>
  <info>resource</info>  <strong>$ann</strong>                      Ресурс (<info>resource</info>) нейронной сети.
  <info>int</info>       <strong>$cascade_min_cand_epochs</strong>  Наименьший период кандидата.

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

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


id: fann_set_cascade_min_out_epochs
type: function
doc:
<comment>Description:</comment>
  Устанавливает минимальные эпохи выходных данных
  
  Устанавливает минимальные эпохи выходных данных.

<comment>Param:</comment>
  <info>resource</info>  <strong>$ann</strong>                     Ресурс (<info>resource</info>) нейронной сети.
  <info>int</info>       <strong>$cascade_min_out_epochs</strong>  Минимальные эпохи выходных данных.

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

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


id: fann_set_cascade_num_candidate_groups
type: function
doc:
<comment>Description:</comment>
  Устанавливает количество групп кандидатов
  
  Устанавливает количество групп кандидатов.

<comment>Param:</comment>
  <info>resource</info>  <strong>$ann</strong>                           Ресурс (<info>resource</info>) нейронной сети.
  <info>int</info>       <strong>$cascade_num_candidate_groups</strong>  Количество групп кандидатов.

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

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


id: fann_set_cascade_output_change_fraction
type: function
doc:
<comment>Description:</comment>
  Устанавливает долю изменения каскадных выходных данных
  
  Устанавливает долю изменения каскадных выходных данных.

<comment>Param:</comment>
  <info>resource</info>  <strong>$ann</strong>                             Ресурс (<info>resource</info>) нейронной сети.
  <info>float</info>     <strong>$cascade_output_change_fraction</strong>  Доля изменения каскадных выходных данных.

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

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


id: fann_set_cascade_output_stagnation_epochs
type: function
doc:
<comment>Description:</comment>
  Устанавливает количество периодов стагнации каскадного вывода
  
  Устанавливает количество периодов стагнации каскадного вывода.

<comment>Param:</comment>
  <info>resource</info>  <strong>$ann</strong>                               Ресурс (<info>resource</info>) нейронной сети.
  <info>int</info>       <strong>$cascade_output_stagnation_epochs</strong>  Количество эпох стагнации каскадного выхода.

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

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


id: fann_set_cascade_weight_multiplier
type: function
doc:
<comment>Description:</comment>
  Устанавливает множитель веса
  
  Устанавливает множитель веса.

<comment>Param:</comment>
  <info>resource</info>  <strong>$ann</strong>                        Ресурс (<info>resource</info>) нейронной сети.
  <info>float</info>     <strong>$cascade_weight_multiplier</strong>  Множитель веса.

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

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


id: fann_set_error_log
type: function
doc:
<comment>Description:</comment>
  Устанавливает, где регистрируются ошибки
  
  Устанавливает, где регистрируются ошибки.

<comment>Param:</comment>
  <info>resource</info>  <strong>$errdat</strong>    Или ресурс (<info>resource</info>) нейронной сети, или ресурс (<info>resource</info>) обучающих данных
                       нейронной сети.
  <info>string</info>    <strong>$log_file</strong>  Путь к файлу логов.

<comment>Return:</comment>
  <info>void</info>  Не возвращает никакого значения.


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

<comment>Param:</comment>
  <info>resource</info>  <strong>$ann</strong>            Ресурс (<info>resource</info>) нейронной сети.
  <info>resource</info>  <strong>$train_data</strong>     Ресурс (<info>resource</info>) обучающих данных нейронной сети.
  <info>float</info>     <strong>$new_input_min</strong>  Желаемая нижняя граница во входных данных после масштабирования (строго
                            не соблюдается)
  <info>float</info>     <strong>$new_input_max</strong>  Желаемая верхняя граница во входных данных после масштабирования (строго
                            не соблюдается)

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

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


id: fann_set_learning_momentum
type: function
doc:
<comment>Description:</comment>
  Устанавливает импульс обучения
  
  Устанавливает импульс обучения.
  
  Более подробная информация доступна в <strong>fann_get_learning_momentum()</strong>.

<comment>Param:</comment>
  <info>resource</info>  <strong>$ann</strong>                Ресурс (<info>resource</info>) нейронной сети.
  <info>float</info>     <strong>$learning_momentum</strong>  Импульс обучения.

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

<comment>See Also:</comment>
   * <strong>fann_get_learning_momentum()</strong>
   * <strong>fann_set_training_algorithm()</strong>


id: fann_set_learning_rate
type: function
doc:
<comment>Description:</comment>
  Устанавливает скорость обучения
  
  Устанавливает скорость обучения.
  
  Более подробная информация доступна в <strong>fann_get_learning_rate()</strong>.

<comment>Param:</comment>
  <info>resource</info>  <strong>$ann</strong>            Ресурс (<info>resource</info>) нейронной сети.
  <info>float</info>     <strong>$learning_rate</strong>  Скорость обучения.

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

<comment>See Also:</comment>
   * <strong>fann_get_learning_rate()</strong>
   * <strong>fann_set_training_algorithm()</strong>


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

<comment>Param:</comment>
  <info>resource</info>  <strong>$ann</strong>             Ресурс (<info>resource</info>) нейронной сети.
  <info>resource</info>  <strong>$train_data</strong>      Ресурс (<info>resource</info>) обучающих данных нейронной сети.
  <info>float</info>     <strong>$new_output_min</strong>  Желаемая нижняя граница в выходных данных после масштабирования (строго
                             не соблюдается)
  <info>float</info>     <strong>$new_output_max</strong>  Желаемая верхняя граница в выходных данных после масштабирования
                             (строго не соблюдается)

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

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


id: fann_set_quickprop_decay
type: function
doc:
<comment>Description:</comment>
  Устанавливает коэффициент затухания quickprop
  
  Устанавливает коэффициент затухания quickprop.

<comment>Param:</comment>
  <info>resource</info>  <strong>$ann</strong>              Ресурс (<info>resource</info>) нейронной сети.
  <info>float</info>     <strong>$quickprop_decay</strong>  Коэффициент затухания quickprop.

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

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


id: fann_set_quickprop_mu
type: function
doc:
<comment>Description:</comment>
  Устанавливает МЮ-фактор quickprop
  
  Устанавливает МЮ-фактор quickprop.

<comment>Param:</comment>
  <info>resource</info>  <strong>$ann</strong>           Ресурс (<info>resource</info>) нейронной сети.
  <info>float</info>     <strong>$quickprop_mu</strong>  МЮ-фактор quickprop.

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

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


id: fann_set_rprop_decrease_factor
type: function
doc:
<comment>Description:</comment>
  Устанавливает коэффициент уменьшения, используемый во время обучения RPROP
  
  Устанавливает коэффициент уменьшения, используемый во время обучения RPROP.

<comment>Param:</comment>
  <info>resource</info>  <strong>$ann</strong>                    Ресурс (<info>resource</info>) нейронной сети.
  <info>float</info>     <strong>$rprop_decrease_factor</strong>  Коэффициент уменьшения.

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

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


id: fann_set_rprop_delta_max
type: function
doc:
<comment>Description:</comment>
  Устанавливает максимальный размер шага
  
  Максимальный размер шага - это положительное число, определяющее, насколько большим может быть
  максимальный размер шага.

<comment>Param:</comment>
  <info>resource</info>  <strong>$ann</strong>              Ресурс (<info>resource</info>) нейронной сети.
  <info>float</info>     <strong>$rprop_delta_max</strong>  Максимальный размер шага.

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

<comment>See Also:</comment>
   * <strong>fann_get_rprop_delta_max()</strong>
   * <strong>fann_get_rprop_delta_min()</strong>


id: fann_set_rprop_delta_min
type: function
doc:
<comment>Description:</comment>
  Устанавливает минимальный размер шага
  
  Минимальный размер шага - это небольшое положительное число, определяющее, насколько маленьким
  может быть минимальный размер шага.

<comment>Param:</comment>
  <info>resource</info>  <strong>$ann</strong>              Ресурс (<info>resource</info>) нейронной сети.
  <info>float</info>     <strong>$rprop_delta_min</strong>  Минимальный размер шага.

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

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


id: fann_set_rprop_delta_zero
type: function
doc:
<comment>Description:</comment>
  Устанавливает начальный размер шага
  
  Начальный размер шага - это положительное число, определяющее начальный размер шага.

<comment>Param:</comment>
  <info>resource</info>  <strong>$ann</strong>               Ресурс (<info>resource</info>) нейронной сети.
  <info>float</info>     <strong>$rprop_delta_zero</strong>  Начальный размер шага.

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

<comment>See Also:</comment>
   * <strong>fann_get_rprop_delta_zero()</strong>
   * <strong>fann_get_rprop_delta_min()</strong>
   * <strong>fann_get_rprop_delta_max()</strong>


id: fann_set_rprop_increase_factor
type: function
doc:
<comment>Description:</comment>
  Устанавливает коэффициент увеличения, используемый во время обучения Rprop
  
  Устанавливает коэффициент увеличения, используемый во время обучения Rprop

<comment>Param:</comment>
  <info>resource</info>  <strong>$ann</strong>                    Ресурс (<info>resource</info>) нейронной сети.
  <info>float</info>     <strong>$rprop_increase_factor</strong>  Коэффициент увеличения.

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

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


id: fann_set_sarprop_step_error_shift
type: function
doc:
<comment>Description:</comment>
  Устанавливает сдвиг ошибки шага sarprop
  
  Устанавливает сдвиг ошибки шага sarprop.

<comment>Param:</comment>
  <info>resource</info>  <strong>$ann</strong>                       Ресурс (<info>resource</info>) нейронной сети.
  <info>float</info>     <strong>$sarprop_step_error_shift</strong>  Сдвиг ошибки шага sarprop.

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

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


id: fann_set_sarprop_step_error_threshold_factor
type: function
doc:
<comment>Description:</comment>
  Устанавливает пороговый коэффициент ошибки шага sarprop
  
  Устанавливает пороговый коэффициент ошибки шага sarprop.

<comment>Param:</comment>
  <info>resource</info>  <strong>$ann</strong>                                  Ресурс (<info>resource</info>) нейронной сети.
  <info>float</info>     <strong>$sarprop_step_error_threshold_factor</strong>  Пороговый коэффициент ошибки шага sarprop.

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

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


id: fann_set_sarprop_temperature
type: function
doc:
<comment>Description:</comment>
  Устанавливает температуру sarprop
  
  Устанавливает температуру sarprop.

<comment>Param:</comment>
  <info>resource</info>  <strong>$ann</strong>                  Ресурс (<info>resource</info>) нейронной сети.
  <info>float</info>     <strong>$sarprop_temperature</strong>  Температура sarprop.

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

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


id: fann_set_sarprop_weight_decay_shift
type: function
doc:
<comment>Description:</comment>
  Устанавливает смещение затухания sarprop
  
  Устанавливает смещение затухания sarprop.

<comment>Param:</comment>
  <info>resource</info>  <strong>$ann</strong>                         Ресурс (<info>resource</info>) нейронной сети.
  <info>float</info>     <strong>$sarprop_weight_decay_shift</strong>  Смещение затухания sarprop.

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

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


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

<comment>Param:</comment>
  <info>resource</info>  <strong>$ann</strong>             Ресурс (<info>resource</info>) нейронной сети.
  <info>resource</info>  <strong>$train_data</strong>      Ресурс (<info>resource</info>) обучающих данных нейронной сети.
  <info>float</info>     <strong>$new_input_min</strong>   Желаемая нижняя граница во входных данных после масштабирования (строго
                             не соблюдается)
  <info>float</info>     <strong>$new_input_max</strong>   Желаемая верхняя граница во входных данных после масштабирования
                             (строго не соблюдается)
  <info>float</info>     <strong>$new_output_min</strong>  Желаемая нижняя граница в выходных данных после масштабирования (строго
                             не соблюдается)
  <info>float</info>     <strong>$new_output_max</strong>  Желаемая верхняя граница в выходных данных после масштабирования
                             (строго не соблюдается)

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

<comment>See Also:</comment>
   * <strong>fann_set_input_scaling_params()</strong>
   * <strong>fann_set_output_scaling_params()</strong>


id: fann_set_train_error_function
type: function
doc:
<comment>Description:</comment>
  Устанавливает функцию ошибки, используемую во время тренировки
  
  Устанавливает функцию ошибки, используемую во время тренировки.
  
  Функции ошибок описаны далее в константах функций ошибок.

<comment>Param:</comment>
  <info>resource</info>  <strong>$ann</strong>             Ресурс (<info>resource</info>) нейронной сети.
  <info>int</info>       <strong>$error_function</strong>  Константа функций ошибок

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

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


id: fann_set_train_stop_function
type: function
doc:
<comment>Description:</comment>
  Устанавливает функцию остановки, используемую во время тренировки
  
  Устанавливает функцию остановки, используемую во время тренировки.
  
  Функции останова описаны далее в константах функции остановки.

<comment>Param:</comment>
  <info>resource</info>  <strong>$ann</strong>            Ресурс (<info>resource</info>) нейронной сети.
  <info>int</info>       <strong>$stop_function</strong>  Константа функции остановки.

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

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


id: fann_set_training_algorithm
type: function
doc:
<comment>Description:</comment>
  Устанавливает алгоритм обучения
  
  Устанавливает алгоритм обучения.
  
  Более подробная информация доступна в <strong>fann_get_training_algorithm()</strong>.

<comment>Param:</comment>
  <info>resource</info>  <strong>$ann</strong>                 Ресурс (<info>resource</info>) нейронной сети.
  <info>int</info>       <strong>$training_algorithm</strong>  Константа Алгоритма обучения

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

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


id: fann_set_weight
type: function
doc:
<comment>Description:</comment>
  Создание связи в сети
  
  Создаёт связь в сети.

<comment>Param:</comment>
  <info>resource</info>  <strong>$ann</strong>          Ресурс (<info>resource</info>) нейронной сети.
  <info>int</info>       <strong>$from_neuron</strong>  Начальный нейрон
  <info>int</info>       <strong>$to_neuron</strong>    Конечный нейрон
  <info>float</info>     <strong>$weight</strong>       Вес связи

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


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

<comment>Param:</comment>
  <info>resource</info>  <strong>$ann</strong>          Ресурс (<info>resource</info>) нейронной сети.
  <info>array</info>     <strong>$connections</strong>  Массив объектов <class>FANNConnection</class>

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


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

<comment>Param:</comment>
  <info>resource</info>  <strong>$train_data</strong>  Ресурс (<info>resource</info>) обучающих данных нейронной сети.

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


id: fann_subset_train_data
type: function
doc:
<comment>Description:</comment>
  Получить копию подмножества из обучающих данных
  
  Возвращает копию подмножества из обучающих данных <info>resource</info>, начинающихся с <return>pos</return> и длиной <return>length</return>
  элементов.
  
  <return>fann_subset_train_data(train_data, 0, fann_length_train_data(train_data))</return> делает тоже самое, что и
  <strong>fann_duplicate_train_data()</strong>

<comment>Param:</comment>
  <info>resource</info>  <strong>$data</strong>    Ресурс (<info>resource</info>) обучающих данных нейронной сети.
  <info>int</info>       <strong>$pos</strong>     Начальная позиция.
  <info>int</info>       <strong>$length</strong>  Количество копируемых элементов.

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

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


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

<comment>Param:</comment>
  <info>resource</info>  <strong>$ann</strong>             Ресурс (<info>resource</info>) нейронной сети.
  <info>array</info>     <strong>$input</strong>           Массив входных данных. Размер массива должен точно соответствовать
                             <strong>fann_get_num_input()</strong>.
  <info>array</info>     <strong>$desired_output</strong>  Массив желаемых результатов. Размер массива должен точно
                             соответствовать <strong>fann_get_num_output()</strong>.

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

<comment>See Also:</comment>
   * <strong>fann_test_data()</strong>
   * <strong>fann_train()</strong>
   * <strong>fann_get_num_input()</strong>
   * <strong>fann_get_num_output()</strong>


id: fann_test_data
type: function
doc:
<comment>Description:</comment>
  Тестирование набора обучающих данных и вычисление MSE для него
  
  Тестирование набора обучающих данных и вычисление MSE для него.
  
  Эта функция обновляет MSE и значения бит неудачи.

<comment>Param:</comment>
  <info>resource</info>  <strong>$ann</strong>   Ресурс (<info>resource</info>) нейронной сети.
  <info>resource</info>  <strong>$data</strong>  Ресурс (<info>resource</info>) обучающих данных нейронной сети.

<comment>Return:</comment>
  <info>float</info>  Обновлённая MSE, или <info>false</info> в случае возникновения ошибки.

<comment>See Also:</comment>
   * <strong>fann_train_on_data()</strong>
   * <strong>fann_train_epoch()</strong>
   * <strong>fann_get_bit_fail()</strong>
   * <strong>fann_get_MSE()</strong>
   * <strong>fann_set_training_algorithm()</strong>


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

<comment>Param:</comment>
  <info>resource</info>  <strong>$ann</strong>             Ресурс (<info>resource</info>) нейронной сети.
  <info>array</info>     <strong>$input</strong>           Массив входных данных. Размер массива должен точно соответствовать
                             <strong>fann_get_num_input()</strong>.
  <info>array</info>     <strong>$desired_output</strong>  Массив желаемых результатов. Размер массива должен точно
                             соответствовать <strong>fann_get_num_output()</strong>.

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

<comment>See Also:</comment>
   * <strong>fann_train_on_data()</strong>
   * <strong>fann_train_epoch()</strong>
   * <strong>fann_get_num_input()</strong>
   * <strong>fann_get_num_output()</strong>


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

<comment>Param:</comment>
  <info>resource</info>  <strong>$ann</strong>   Ресурс (<info>resource</info>) нейронной сети.
  <info>resource</info>  <strong>$data</strong>  Ресурс (<info>resource</info>) обучающих данных нейронной сети.

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

<comment>See Also:</comment>
   * <strong>fann_train_on_data()</strong>
   * <strong>fann_test_data()</strong>
   * <strong>fann_get_MSE()</strong>
   * <strong>fann_set_training_algorithm()</strong>


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

<comment>Param:</comment>
  <info>resource</info>  <strong>$ann</strong>                     Ресурс (<info>resource</info>) нейронной сети.
  <info>resource</info>  <strong>$data</strong>                    Ресурс (<info>resource</info>) обучающих данных нейронной сети.
  <info>int</info>       <strong>$max_epochs</strong>              Максимальное количество эпох, которое должно продолжаться
                                     обучение
  <info>int</info>       <strong>$epochs_between_reports</strong>  Количество эпох между вызовами пользовательской функции. Если
                                     равно нулю, то функция не будет запускаться.
  <info>float</info>     <strong>$desired_error</strong>           Желаемая <strong>fann_get_MSE()</strong> или <strong>fann_get_bit_fail()</strong>, в зависимости
                                     от выбранной функции остановки <strong>fann_set_train_stop_function()</strong>

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

<comment>See Also:</comment>
   * <strong>fann_train_on_file()</strong>
   * <strong>fann_train_epoch()</strong>
   * <strong>fann_get_bit_fail()</strong>
   * <strong>fann_get_MSE()</strong>
   * <strong>fann_set_train_stop_function()</strong>
   * <strong>fann_set_training_algorithm()</strong>
   * <strong>fann_set_callback()</strong>


id: fann_train_on_file
type: function
doc:
<comment>Description:</comment>
  Обучение на полном наборе данных, прочитанном из файла, на временном интервале
  
  Обучение на полном наборе данных, прочитанном из файла, на временном интервале.
  
  Это обучение использует алгоритм, выбранный функцией <strong>fann_set_training_algorithm()</strong> и набор
  параметров для этих алгоритмов.

<comment>Param:</comment>
  <info>resource</info>  <strong>$ann</strong>                     Ресурс (<info>resource</info>) нейронной сети.
  <info>string</info>    <strong>$filename</strong>                Файл, содержащий обучающие данные
  <info>int</info>       <strong>$max_epochs</strong>              Максимальное количество эпох, которое должно продолжаться
                                     обучение
  <info>int</info>       <strong>$epochs_between_reports</strong>  Количество эпох между вызовами пользовательской функции. Если
                                     равно нулю, то функция не будет запускаться.
  <info>float</info>     <strong>$desired_error</strong>           Желаемая <strong>fann_get_MSE()</strong> или <strong>fann_get_bit_fail()</strong>, в зависимости
                                     от выбранной функции остановки <strong>fann_set_train_stop_function()</strong>

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

<comment>See Also:</comment>
   * <strong>fann_train_on_data()</strong>
   * <strong>fann_train_epoch()</strong>
   * <strong>fann_get_bit_fail()</strong>
   * <strong>fann_get_MSE()</strong>
   * <strong>fann_set_train_stop_function()</strong>
   * <strong>fann_set_training_algorithm()</strong>
   * <strong>fann_set_callback()</strong>


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

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


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

<comment>See Also:</comment>
   * <strong>fbird_modify_user()</strong>
   * <strong>fbird_delete_user()</strong>


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

<comment>See Also:</comment>
   * <strong>fbird_query()</strong>
   * <strong>fbird_execute()</strong>


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


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

<comment>See Also:</comment>
   * <strong>fbird_blob_cancel()</strong>
   * <strong>fbird_blob_close()</strong>
   * <strong>fbird_blob_create()</strong>
   * <strong>fbird_blob_import()</strong>


id: fbird_blob_cancel
type: function
doc:
<comment>Description:</comment>
  Отменяет создание BLOB
  
  Эта функция прекращает использование BLOB, если он ещё не был закрыт <strong>fbird_blob_close()</strong>.

<comment>Param:</comment>
  <info>resource</info>  <strong>$blob_handle</strong>  Дескриптор BLOB, открытый с помощью <strong>fbird_blob_create()</strong>.

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

<comment>See Also:</comment>
   * <strong>fbird_blob_close()</strong>
   * <strong>fbird_blob_create()</strong>
   * <strong>fbird_blob_import()</strong>


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

<comment>See Also:</comment>
   * <strong>fbird_blob_create()</strong>
   * <strong>fbird_blob_cancel()</strong>
   * <strong>fbird_blob_open()</strong>
   * <strong>fbird_blob_import()</strong>


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

<comment>See Also:</comment>
   * <strong>fbird_blob_add()</strong>
   * <strong>fbird_blob_cancel()</strong>
   * <strong>fbird_blob_close()</strong>
   * <strong>fbird_blob_import()</strong>


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

<comment>See Also:</comment>
   * <strong>fbird_blob_open()</strong>
   * <strong>fbird_blob_close()</strong>
   * <strong>fbird_blob_get()</strong>


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

<comment>See Also:</comment>
   * <strong>fbird_blob_open()</strong>
   * <strong>fbird_blob_close()</strong>
   * <strong>fbird_blob_echo()</strong>


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

<comment>See Also:</comment>
   * <strong>fbird_blob_add()</strong>
   * <strong>fbird_blob_cancel()</strong>
   * <strong>fbird_blob_close()</strong>
   * <strong>fbird_blob_create()</strong>


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


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

<comment>See Also:</comment>
   * <strong>fbird_blob_close()</strong>
   * <strong>fbird_blob_echo()</strong>
   * <strong>fbird_blob_get()</strong>


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

<comment>See Also:</comment>
   * <strong>fbird_connect()</strong>
   * <strong>fbird_pconnect()</strong>


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


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


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

<comment>See Also:</comment>
   * <strong>fbird_pconnect()</strong>
   * <strong>fbird_close()</strong>


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


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

<comment>See Also:</comment>
   * <strong>fbird_add_user()</strong>
   * <strong>fbird_modify_user()</strong>


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

<comment>See Also:</comment>
   * <strong>fbird_connect()</strong>
   * <strong>fbird_pconnect()</strong>


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

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


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

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


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

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


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

<comment>See Also:</comment>
   * <strong>fbird_fetch_row()</strong>
   * <strong>fbird_fetch_object()</strong>


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

<comment>See Also:</comment>
   * <strong>fbird_fetch_row()</strong>
   * <strong>fbird_fetch_assoc()</strong>


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

<comment>See Also:</comment>
   * <strong>fbird_fetch_assoc()</strong>
   * <strong>fbird_fetch_object()</strong>


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

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


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

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


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


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


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


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


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

<comment>See Also:</comment>
   * <strong>fbird_add_user()</strong>
   * <strong>fbird_delete_user()</strong>


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

<comment>See Also:</comment>
   * <strong>fbird_prepare()</strong>
   * <strong>fbird_execute()</strong>


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

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


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

<comment>See Also:</comment>
   * <strong>fbird_prepare()</strong>
   * <strong>fbird_param_info()</strong>


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

<comment>See Also:</comment>
   * <strong>fbird_field_info()</strong>
   * <strong>fbird_num_params()</strong>


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

<comment>See Also:</comment>
   * <strong>fbird_close()</strong>
   * <strong>fbird_connect()</strong>


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


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

<comment>See Also:</comment>
   * <strong>fbird_errmsg()</strong>
   * <strong>fbird_fetch_row()</strong>
   * <strong>fbird_fetch_object()</strong>
   * <strong>fbird_free_result()</strong>


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


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


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


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


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


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


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

<comment>See Also:</comment>
   * <strong>fbird_free_event_handler()</strong>
   * <strong>fbird_wait_event()</strong>


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


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

<comment>See Also:</comment>
   * <strong>fbird_set_event_handler()</strong>
   * <strong>fbird_free_event_handler()</strong>


id: fclose
type: function
doc:
<comment>Description:</comment>
  Закрывает открытый дескриптор файла
  
  Функция закрывает файл, на который указывает дескриптор <strong>$stream</strong>.

<comment>Param:</comment>
  <info>resource</info>  <strong>$stream</strong>  Дескриптор должен быть корректным и указывать на файл, открытый ранее с помощью
                     функции <strong>fopen()</strong> или <strong>fsockopen()</strong>.

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

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


id: fdatasync
type: function
doc:
<comment>Description:</comment>
  Синхронизирует данные (но не метаданные) с файлом
  
  Функция синхронизирует содержимое <strong>$stream</strong> с накопителем, как и <strong>fsync()</strong>, но не синхронизирует
  метаданные файла. Стоит обратить внимание, что данная функция фактически отличается только в
  системах POSIX. В Windows она является псевдонимом <strong>fsync()</strong>.

<comment>Param:</comment>
  <info>resource</info>  <strong>$stream</strong>  Указатель на файл должен быть корректным и указывать
                     на файл, успешно открытый функциями <strong>fopen()</strong> или
                     <strong>fsockopen()</strong> (и всё ещё не закрытый функцией <strong>fclose()</strong>).

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

<comment>See Also:</comment>
   * <strong>fflush()</strong>
   * <strong>fsync()</strong>


id: fdf_add_doc_javascript
type: function
doc:
<comment>Description:</comment>
  Добавляет код javascript в документ FDF
  
  Добавляет скрипт в FDF, который Acrobat затем добавляет в скрипт документа на уровне документа
  после того, как в него будет импортирован FDF.

<comment>Param:</comment>
  <info>resource</info>  <strong>$fdf_document</strong>  Дескриптор документа FDF, возвращаемый <strong>fdf_create()</strong>, <strong>fdf_open()</strong> или
                           <strong>fdf_open_string()</strong>.
  <info>string</info>    <strong>$script_name</strong>   Имя скрипта.
  <info>string</info>    <strong>$script_code</strong>   Код скрипта. Настоятельно рекомендуется использовать <return>\r</return> для переноса
                           строк в коде скрипта.

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


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

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


id: fdf_close
type: function
doc:
<comment>Description:</comment>
  Закрывает FDF-документ
  
  Закрывает FDF-документ.

<comment>Param:</comment>
  <info>resource</info>  <strong>$fdf_document</strong>  Дескриптор FDF-документа, возвращённый функциями <strong>fdf_create()</strong>, <strong>fdf_open()</strong>
                           или <strong>fdf_open_string()</strong>.

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

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


id: fdf_create
type: function
doc:
<comment>Description:</comment>
  Создаёт новый документ FDF
  
  Создаёт новый документ FDF.
  
  Функция необходима, если нужно заполнить данными поля ввода в документе PDF.

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

<comment>See Also:</comment>
   * <strong>fdf_close()</strong>
   * <strong>fdf_save()</strong>
   * <strong>fdf_open()</strong>


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

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


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

<comment>Return:</comment>
  <info>int</info>  Возвращает код ошибки как целое число или ноль, если ошибок не было.

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


id: fdf_error
type: function
doc:
<comment>Description:</comment>
  Возвращает описание ошибки для кода ошибки FDF
  
  Получает текстовое описание кода ошибки FDF, указанного в <strong>$error_code</strong>.

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

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

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


id: fdf_get_ap
type: function
doc:
<comment>Description:</comment>
  Получает вид поля
  
  Получает вид <strong>$field</strong> (т.е. значение ключа /AP) и сохраняет его в файле.

<comment>Param:</comment>
  <info>resource</info>  <strong>$fdf_document</strong>  Дескриптор документа FDF, возвращаемый <strong>fdf_create()</strong>, <strong>fdf_open()</strong> или
                           <strong>fdf_open_string()</strong>.
  <info>string</info>    <strong>$field</strong>         
  <info>int</info>       <strong>$face</strong>          Возможные значения: <info>FDFNormalAP</info>, <info>FDFRolloverAP</info> и <info>FDFDownAP</info>.
  <info>string</info>    <strong>$filename</strong>      Внешний вид будет сохранён в этом параметре.

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


id: fdf_get_attachment
type: function
doc:
<comment>Description:</comment>
  Извлекает загруженный файл, встроенный в FDF
  
  Извлекает файл, загруженный с помощью поля "выбор файла" <strong>$fieldname</strong>, и сохраняет его в <strong>$savepath</strong>.

<comment>Param:</comment>
  <info>resource</info>  <strong>$fdf_document</strong>  Дескриптор документа FDF, возвращаемый <strong>fdf_create()</strong>, <strong>fdf_open()</strong> или
                           <strong>fdf_open_string()</strong>.
  <info>string</info>    <strong>$fieldname</strong>     
  <info>string</info>    <strong>$savepath</strong>      Может быть, это имя простого файла или существующего каталога, в котором
                           файл должен быть создан под его исходным именем. Любой существующий файл
                           с таким же именем будет перезаписан.
                           
                           Кажется, нет другого способа узнать исходное имя файла, кроме как
                           сохранить файл, используя каталог как <strong>$savepath</strong> и проверить базовое имя,
                           под которым он был сохранён.

<comment>Return:</comment>
  <info>array</info>  Возвращённый массив содержит следующие поля: <strong>$path</strong> - путь, где хранится файл<strong>$size</strong> - размер
         сохраняемого файла в байтах<strong>$type</strong> - mimetype, если он указан в FDF
         
         <strong>$path</strong> - путь, где хранится файл
         
         <strong>$size</strong> - размер сохраняемого файла в байтах
         
         <strong>$type</strong> - mimetype, если он указан в FDF


id: fdf_get_encoding
type: function
doc:
<comment>Description:</comment>
  Получает значение ключа /Encoding
  
  Получает значение ключа <return>/Encoding</return>.

<comment>Param:</comment>
  <info>resource</info>  <strong>$fdf_document</strong>  Дескриптор FDF-документа, возвращённый функциями <strong>fdf_create()</strong>, <strong>fdf_open()</strong>
                           или <strong>fdf_open_string()</strong>.

<comment>Return:</comment>
  <info>string</info>  Возвращает кодировку в виде строки. Возвращается пустая строка, если используется схема по
          умолчанию <return>PDFDocEncoding/Unicode</return>.

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


id: fdf_get_file
type: function
doc:
<comment>Description:</comment>
  Получает значение ключа /F
  
  Получает значение ключа <return>/F</return>.

<comment>Param:</comment>
  <info>resource</info>  <strong>$fdf_document</strong>  Дескриптор FDF-документа, возвращённый функциями <strong>fdf_create()</strong>, <strong>fdf_open()</strong>
                           или <strong>fdf_open_string()</strong>.

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

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


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

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


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

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


id: fdf_get_status
type: function
doc:
<comment>Description:</comment>
  Получает значение ключа /STATUS
  
  Получает значение ключа <return>/STATUS</return>.

<comment>Param:</comment>
  <info>resource</info>  <strong>$fdf_document</strong>  Дескриптор FDF-документа, возвращённый функциями <strong>fdf_create()</strong>, <strong>fdf_open()</strong>
                           или <strong>fdf_open_string()</strong>.

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

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


id: fdf_get_value
type: function
doc:
<comment>Description:</comment>
  Получает значение поля
  
  Получает значение для запрошенного поля.

<comment>Param:</comment>
  <info>resource</info>  <strong>$fdf_document</strong>  Дескриптор документа FDF, возвращаемый <strong>fdf_create()</strong>, <strong>fdf_open()</strong> или
                           <strong>fdf_open_string()</strong>.
  <info>string</info>    <strong>$fieldname</strong>     Имя поля FDF в виде строки.
  <info>int</info>       <strong>$which</strong>         Элементы поля массива можно получить, передав этот необязательный
                           параметр, начиная с нуля. Для полей без массива этот параметр будет
                           проигнорирован.

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

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


id: fdf_get_version
type: function
doc:
<comment>Description:</comment>
  Получает номер версии для FDF API или файла
  
  Возвращает версию FDF для данного документа или номер версии API набора инструментов, если
  параметр не указан.

<comment>Param:</comment>
  <info>resource</info>  <strong>$fdf_document</strong>  Дескриптор документа FDF, возвращаемый <strong>fdf_create()</strong>, <strong>fdf_open()</strong> или
                           <strong>fdf_open_string()</strong>.

<comment>Return:</comment>
  <info>string</info>  Возвращает версию в виде строки. Для текущего набора инструментов FDF 5.0 номер версии API
          - <return>5.0</return>, а номер версии документа - <return>1.2</return>, <return>1.3</return> или <return>1.4</return>.

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


id: fdf_header
type: function
doc:
<comment>Description:</comment>
  Устанавливает специфичные для FDF выходные заголовки
  
  Это удобная функция для установки соответствующих HTTP-заголовков для вывода FDF. Она
  устанавливает для <return>Content-type:</return> значение <return>application/vnd.fdf</return>.

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


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

<comment>Param:</comment>
  <info>resource</info>  <strong>$fdf_document</strong>  Дескриптор документа FDF, возвращаемый <strong>fdf_create()</strong>, <strong>fdf_open()</strong> или
                           <strong>fdf_open_string()</strong>.
  <info>string</info>    <strong>$fieldname</strong>     Имя поля FDF в виде строки. Если не указано, будет использоваться первое
                           поле.

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

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


id: fdf_open
type: function
doc:
<comment>Description:</comment>
  Открывает документ FDF
  
  Открывает файл с данными формы.
  
  Вы также можете использовать <strong>fdf_open_string()</strong> для обработки результатов POST-запроса PDF-формы.

<comment>Param:</comment>
  <info>string</info>  <strong>$filename</strong>  Путь к файлу FDF. Файл должен содержать данные, возвращённые из PDF формы или
                     созданные с помощью <strong>fdf_create()</strong> и <strong>fdf_save()</strong>.

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

<comment>See Also:</comment>
   * <strong>fdf_open_string()</strong>
   * <strong>fdf_close()</strong>
   * <strong>fdf_create()</strong>
   * <strong>fdf_save()</strong>


id: fdf_open_string
type: function
doc:
<comment>Description:</comment>
  Читает FDF документ из строки
  
  Считывает данные формы из строки.
  
  Вы можете использовать <strong>fdf_open_string()</strong> вместе с $HTTP_FDF_DATA для обработки ввода FDF формы от
  удалённого клиента.

<comment>Param:</comment>
  <info>string</info>  <strong>$fdf_data</strong>  Данные, возвращённые из PDF формы или созданные с помощью <strong>fdf_create()</strong> и
                     <strong>fdf_save_string()</strong>.

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

<comment>See Also:</comment>
   * <strong>fdf_open()</strong>
   * <strong>fdf_close()</strong>
   * <strong>fdf_create()</strong>
   * <strong>fdf_save_string()</strong>


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

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


id: fdf_save
type: function
doc:
<comment>Description:</comment>
  Сохраняет документ FDF
  
  Сохраняет документ FDF.

<comment>Param:</comment>
  <info>resource</info>  <strong>$fdf_document</strong>  Дескриптор документа FDF, возвращаемый <strong>fdf_create()</strong>, <strong>fdf_open()</strong> or
                           <strong>fdf_open_string()</strong>.
  <info>string</info>    <strong>$filename</strong>      Если указано, FDF будет записан в этот параметр. В противном случае
                           функция запишет FDF в выходной поток PHP по умолчанию.

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

<comment>See Also:</comment>
   * <strong>fdf_close()</strong>
   * <strong>fdf_create()</strong>
   * <strong>fdf_save_string()</strong>


id: fdf_save_string
type: function
doc:
<comment>Description:</comment>
  Возвращает документ FDF в виде строки
  
  Возвращает документ FDF в виде строки.

<comment>Param:</comment>
  <info>resource</info>  <strong>$fdf_document</strong>  Дескриптор документа FDF, возвращаемый <strong>fdf_create()</strong>, <strong>fdf_open()</strong> or
                           <strong>fdf_open_string()</strong>.

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

<comment>See Also:</comment>
   * <strong>fdf_open_string()</strong>
   * <strong>fdf_close()</strong>
   * <strong>fdf_create()</strong>
   * <strong>fdf_save()</strong>


id: fdf_set_ap
type: function
doc:
<comment>Description:</comment>
  Устанавливает внешний вид поля
  
  Устанавливает внешний вид поля (т.е. значение ключа <return>/AP</return>).

<comment>Param:</comment>
  <info>resource</info>  <strong>$fdf_document</strong>  Дескриптор документа FDF, возвращаемый <strong>fdf_create()</strong>, <strong>fdf_open()</strong> or
                           <strong>fdf_open_string()</strong>.
  <info>string</info>    <strong>$field_name</strong>    
  <info>int</info>       <strong>$face</strong>          Допустимые значения: <info>FDFNormalAP</info>, <info>FDFRolloverAP</info> и <info>FDFDownAP</info>.
  <info>string</info>    <strong>$filename</strong>      
  <info>int</info>       <strong>$page_number</strong>   

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


id: fdf_set_encoding
type: function
doc:
<comment>Description:</comment>
  Устанавливает кодировку символов FDF
  
  Устанавливает кодировку символов для документа FDF.

<comment>Param:</comment>
  <info>resource</info>  <strong>$fdf_document</strong>  Дескриптор документа FDF, возвращаемый <strong>fdf_create()</strong>, <strong>fdf_open()</strong> or
                           <strong>fdf_open_string()</strong>.
  <info>string</info>    <strong>$encoding</strong>      Название кодировки. Поддерживаются следующие значения: "<return>Shift-JIS</return>",
                           "<return>UHC</return>", "<return>GBK</return>" и "<return>BigFive</return>".
                           
                           Пустая строка сбрасывает кодировку по умолчанию в схему
                           <return>PDFDocEncoding/Unicode</return>.

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


id: fdf_set_file
type: function
doc:
<comment>Description:</comment>
  Устанавливает PDF-документ для отображения данных FDF
  
  Выбирает другой документ PDF для отображения результатов формы в той форме, из которой он был
  создан.

<comment>Param:</comment>
  <info>resource</info>  <strong>$fdf_document</strong>  Дескриптор документа FDF, возвращаемый <strong>fdf_create()</strong>, <strong>fdf_open()</strong> or
                           <strong>fdf_open_string()</strong>.
  <info>string</info>    <strong>$url</strong>           Должен быть указан абсолютный URL.
  <info>string</info>    <strong>$target_frame</strong>  Используйте этот параметр, чтобы указать фрейм, в котором будет
                           отображаться документ. Вы также можете установить значение по умолчанию
                           для этого параметра с помощью <strong>fdf_set_target_frame()</strong>.

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

<comment>See Also:</comment>
   * <strong>fdf_get_file()</strong>
   * <strong>fdf_set_target_frame()</strong>


id: fdf_set_flags
type: function
doc:
<comment>Description:</comment>
  Устанавливает флаг поля
  
  Устанавливает определённые флаги данного поля.

<comment>Param:</comment>
  <info>resource</info>  <strong>$fdf_document</strong>  Дескриптор документа FDF, возвращаемый <strong>fdf_create()</strong>, <strong>fdf_open()</strong> or
                           <strong>fdf_open_string()</strong>.
  <info>string</info>    <strong>$fieldname</strong>     Имя поля FDF в виде строки.
  <info>int</info>       <strong>$whichFlags</strong>    
  <info>int</info>       <strong>$newFlags</strong>      

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

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


id: fdf_set_javascript_action
type: function
doc:
<comment>Description:</comment>
  Устанавливает действие javascript для поля
  
  Устанавливает действие javascript для заданного поля

<comment>Param:</comment>
  <info>resource</info>  <strong>$fdf_document</strong>  Дескриптор документа FDF, возвращаемый <strong>fdf_create()</strong>, <strong>fdf_open()</strong> or
                           <strong>fdf_open_string()</strong>.
  <info>string</info>    <strong>$fieldname</strong>     Имя поля FDF в виде строки.
  <info>int</info>       <strong>$trigger</strong>       
  <info>string</info>    <strong>$script</strong>        

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

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


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

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

<comment>See Also:</comment>
   * <strong>fdf_add_doc_javascript()</strong>
   * <strong>fdf_set_javascript_action()</strong>


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

<comment>Param:</comment>
  <info>resource</info>  <strong>$fdf_document</strong>  Дескриптор документа FDF, возвращаемый <strong>fdf_create()</strong>, <strong>fdf_open()</strong> or
                           <strong>fdf_open_string()</strong>.
  <info>string</info>    <strong>$fieldname</strong>     Имя поля FDF в виде строки.
  <info>int</info>       <strong>$element</strong>       
  <info>string</info>    <strong>$str1</strong>          
  <info>string</info>    <strong>$str2</strong>          

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

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


id: fdf_set_status
type: function
doc:
<comment>Description:</comment>
  Устанавливает значение ключа /STATUS
  
  Устанавливает значение ключа <return>/STATUS</return>. Когда клиент получает FDF с установленным статусом, он
  представляет значение в окне предупреждения.

<comment>Param:</comment>
  <info>resource</info>  <strong>$fdf_document</strong>  Дескриптор документа FDF, возвращаемый <strong>fdf_create()</strong>, <strong>fdf_open()</strong> or
                           <strong>fdf_open_string()</strong>.
  <info>string</info>    <strong>$status</strong>        

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

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


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

<comment>Param:</comment>
  <info>resource</info>  <strong>$fdf_document</strong>  Дескриптор документа FDF, возвращаемый <strong>fdf_create()</strong>, <strong>fdf_open()</strong> или
                           <strong>fdf_open_string()</strong>.
  <info>string</info>    <strong>$fieldname</strong>     Имя поля FDF в виде строки.
  <info>int</info>       <strong>$trigger</strong>       
  <info>string</info>    <strong>$script</strong>        
  <info>int</info>       <strong>$flags</strong>         

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

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


id: fdf_set_target_frame
type: function
doc:
<comment>Description:</comment>
  Устанавливает целевой фрейм для отображения формы
  
  Устанавливает целевой фрейм для отображения PDF-файла, определённого с помощью <strong>fdf_save_file()</strong>.

<comment>Param:</comment>
  <info>resource</info>  <strong>$fdf_document</strong>  Дескриптор документа FDF, возвращаемый <strong>fdf_create()</strong>, <strong>fdf_open()</strong> или
                           <strong>fdf_open_string()</strong>.
  <info>string</info>    <strong>$frame_name</strong>    Имя фрейма в виде строки.

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

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


id: fdf_set_value
type: function
doc:
<comment>Description:</comment>
  Устанавливает значение поля
  
  Устанавливает <strong>$value</strong> для заданного поля.

<comment>Param:</comment>
  <info>resource</info>  <strong>$fdf_document</strong>  Дескриптор документа FDF, возвращаемый <strong>fdf_create()</strong>, <strong>fdf_open()</strong> or
                           <strong>fdf_open_string()</strong>.
  <info>string</info>    <strong>$fieldname</strong>     Имя поля FDF в виде строки.
  <info>mixed</info>     <strong>$value</strong>         Этот параметр будет храниться в виде строки, если он не является
                           массивом. В этом случае все элементы массива будут сохранены как массив
                           значений.
  <info>int</info>       <strong>$isName</strong>        В более старых версиях набора инструментов FDF последний параметр
                           определял, должно ли значение поля быть преобразовано в PDF Name (= 1)
                           или установлено PDF String (= 0).
                           
                           Это значение больше не используется в текущей версии 5.0. Для
                           совместимости оно по-прежнему поддерживается как необязательный параметр,
                           но внутренне игнорируется.

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

<comment>See Also:</comment>
   * <strong>fdf_get_value()</strong>
   * <strong>fdf_remove_item()</strong>


id: fdf_set_version
type: function
doc:
<comment>Description:</comment>
  Устанавливает номер версии для файла FDF
  
  Устанавливает <strong>$version</strong> FDF для данного документа.
  
  Некоторые функции, поддерживаемые модулем, доступны только в новых версиях FDF.

<comment>Param:</comment>
  <info>resource</info>  <strong>$fdf_document</strong>  Дескриптор документа FDF, возвращаемый <strong>fdf_create()</strong>, <strong>fdf_open()</strong> or
                           <strong>fdf_open_string()</strong>.
  <info>string</info>    <strong>$version</strong>       Номер версии. Для текущего набора инструментов FDF 5.0 это может быть
                           <return>1.2</return>, <return>1.3</return> или <return>1.4</return>.

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

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


id: fdiv
type: function
doc:
<comment>Description:</comment>
  Делит одно число на другое в соответствии с IEEE 754
  
  Возвращает результат деления <strong>$num1</strong> на <strong>$num2</strong> в виде числа с плавающей точкой. Если <strong>$num2</strong> равен
  нулю, то будет возвращено либо <return>INF</return>, либо <return>-INF</return>, либо <return>NAN</return>.
  
  Обратите внимание, что при сравнении <return>NAN</return> с помощью == или === с чем угодно, включая его самого,
  результат всегда будет <info>false</info>.

<comment>Param:</comment>
  <info>float</info>  <strong>$num1</strong>  Делимое
  <info>float</info>  <strong>$num2</strong>  Делитель

<comment>Return:</comment>
  <info>float</info>  Число с плавающей точкой, являющееся результатом деления <strong>$num1</strong> на <strong>$num2</strong>.

<comment>See Also:</comment>
   * <return>/</return> - Деление чисел с плавающей точкой
   * <strong>intdiv()</strong> - Целочисленное деление
   * <strong>fmod()</strong> - Модуль


id: feof
type: function
doc:
<comment>Description:</comment>
  Проверяет, достигнут ли конец файла
  
  Проверяет, достигнут ли конец файла.

<comment>Param:</comment>
  <info>resource</info>  <strong>$stream</strong>  Указатель на файл должен быть корректным и указывать
                     на файл, успешно открытый функциями <strong>fopen()</strong> или
                     <strong>fsockopen()</strong> (и всё ещё не закрытый функцией <strong>fclose()</strong>).

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


id: fflush
type: function
doc:
<comment>Description:</comment>
  Сбрасывает буфер вывода в файл
  
  Данная функция осуществляет сброс буферизованных данных в файл, на который указывает <strong>$stream</strong>.

<comment>Param:</comment>
  <info>resource</info>  <strong>$stream</strong>  Указатель на файл должен быть корректным и указывать
                     на файл, успешно открытый функциями <strong>fopen()</strong> или
                     <strong>fsockopen()</strong> (и всё ещё не закрытый функцией <strong>fclose()</strong>).

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

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


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

<comment>Param:</comment>
  <info>resource</info>  <strong>$stream</strong>  Указатель на файл должен быть корректным и указывать
                     на файл, успешно открытый функциями <strong>fopen()</strong> или
                     <strong>fsockopen()</strong> (и всё ещё не закрытый функцией <strong>fclose()</strong>).

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

<comment>See Also:</comment>
   * <strong>fread()</strong>
   * <strong>fopen()</strong>
   * <strong>popen()</strong>
   * <strong>fsockopen()</strong>
   * <strong>fgets()</strong>


id: fgetcsv
type: function
doc:
<comment>Description:</comment>
  Читает строку из файла и производит разбор данных CSV
  
  Данная функция похожа на функцию <strong>fgets()</strong>, с той разницей, что она производит анализ строки на
  наличие записей в формате CSV и возвращает найденные поля в качестве массива.
  
  Эта функция принимает во внимание настройки локали. К примеру, если <return>LANG</return> установлена в
  <return>en_US.UTF-8</return>, то файлы в однобайтовой кодировке будут неправильно прочитаны этой функцией.

<comment>Param:</comment>
  <info>resource</info>  <strong>$stream</strong>     Корректный файловый указатель на файл, успешно открытый при помощи <strong>fopen()</strong>,
                        <strong>popen()</strong> или <strong>fsockopen()</strong>.
  <info>int|null</info>  <strong>$length</strong>     Должен быть больше самой длинной строки (в символах), найденной в CSV-файле
                        (включая завершающий символ конца строки). В противном случае, строка будет
                        разбита на куски длиной в <strong>$length</strong> символов, если только место разрыва не
                        будет внутри ограничителей полей (enclosure).
                        
                        Отсутствие этого параметра (или установка его в 0 или <info>null</info>, начиная с PHP
                        8.0.0) приведёт к тому, что длина строки будет не ограничена. Это может
                        сказаться на скорости выполнения.
  <info>string</info>    <strong>$separator</strong>  Необязательный параметр <strong>$separator</strong> устанавливает разделитель поля (только
                        один однобайтовый символ).
  <info>string</info>    <strong>$enclosure</strong>  Необязательный параметр <strong>$enclosure</strong> устанавливает символ ограничителя поля
                        (только один однобайтовый символ).
  <info>string</info>    <strong>$escape</strong>     Необязательный параметр <strong>$escape</strong> устанавливает экранирующий символ (не более
                        одного однобайтового символа). Пустая строка (<return>""</return>) отключает проприетарный
                        механизм экранирования.
                        
                        Обычно символ <strong>$enclosure</strong> экранируется внутри поля путём его удваивания;
                        однако, символ <strong>$escape</strong> в качестве альтернативы. Поэтому значения по
                        умолчанию этих параметров <return>""</return> и <return>\"</return> имеют одинаковое значение. Помимо
                        разрешения экранировать символ <strong>$enclosure</strong> символ <strong>$escape</strong> не имеет особого
                        смысла; он даже не предназначен для самого экранирования.

<comment>Return:</comment>
  <info>array|false</info>  Возвращает индексированный массив с прочтёнными полями в случае успешного выполнения
               или <info>false</info> в случае возникновения ошибки.
               
               Пустая строка CSV-файла будет возвращена в качестве массива, содержащего единственный
               элемент <info>null</info>, ошибки в данном случае не возникнет.
               
               Если у вас возникают проблемы с распознаванием PHP концов строк при чтении или
               создании файлов на Macintosh-совместимом компьютере, включение опции
               auto_detect_line_endings может помочь решить проблему.

<comment>See Also:</comment>
   * <strong>str_getcsv()</strong>
   * <strong>explode()</strong>
   * <strong>file()</strong>
   * <strong>pack()</strong>
   * <strong>fputcsv()</strong>


id: fgets
type: function
doc:
<comment>Description:</comment>
  Читает строку из файла
  
  Читает строку из файлового указателя.

<comment>Param:</comment>
  <info>resource</info>  <strong>$stream</strong>  Указатель на файл должен быть корректным и указывать
                     на файл, успешно открытый функциями <strong>fopen()</strong> или
                     <strong>fsockopen()</strong> (и всё ещё не закрытый функцией <strong>fclose()</strong>).
  <info>int|null</info>  <strong>$length</strong>  Чтение заканчивается при достижении <strong>$length</strong> - 1 байт, либо если встретилась
                     новая строка (которая включается в возвращаемый результат) или конец файла (в
                     зависимости от того, что наступит раньше). Если длина не указана, чтение из
                     потока будет продолжаться до тех пор, пока не достигнет конца строки.

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

<comment>See Also:</comment>
   * <strong>fgetss()</strong>
   * <strong>fread()</strong>
   * <strong>fgetc()</strong>
   * <strong>stream_get_line()</strong>
   * <strong>fopen()</strong>
   * <strong>popen()</strong>
   * <strong>fsockopen()</strong>
   * <strong>stream_set_timeout()</strong>


id: fgetss
type: function
doc:
<comment>Description:</comment>
  Читает строку из файла и удаляет HTML-теги
  
  Функция идентична функции <strong>fgets()</strong>, за исключением того, что <strong>fgetss()</strong> удаляет любые NULL-байты,
  HTML- и PHP-теги из прочитанной строки. Функция сохраняет состояние синтаксического анализа от
  вызова к вызову и поэтому не эквивалентна вызову <strong>strip_tags()</strong> для возвращаемого значения <strong>fgets()</strong>.

<comment>Param:</comment>
  <info>resource</info>  <strong>$handle</strong>          Указатель на файл должен быть корректным и указывать
                             на файл, успешно открытый функциями <strong>fopen()</strong> или
                             <strong>fsockopen()</strong> (и всё ещё не закрытый функцией <strong>fclose()</strong>).
  <info>int</info>       <strong>$length</strong>          Длина получаемых данных.
  <info>string</info>    <strong>$allowable_tags</strong>  Можно использовать третий необязательный параметр для указания тегов,
                             которые не нужно вырезать. Смотрите описание <strong>strip_tags()</strong> для более
                             подробной информации о <strong>$allowable_tags</strong>.

<comment>Return:</comment>
  <info>string</info>  Возвращает строку длиной до <strong>$length</strong> - 1 байт, прочтённых из файла, на который указывает
          дескриптор <strong>$handle</strong>, с вырезанными тегами HTML и PHP.
          
          В случае возникновения ошибки возвращает <info>false</info>.

<comment>See Also:</comment>
   * <strong>fgets()</strong>
   * <strong>fopen()</strong>
   * <strong>popen()</strong>
   * <strong>fsockopen()</strong>
   * <strong>strip_tags()</strong>
   * SplFileObject::fgetss
   * Фильтр string.strip_tags


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

<comment>Param:</comment>
  <info>string</info>         <strong>$filename</strong>  Путь к файлу.
                            
                            Для этой функции вы можете использовать URL в качестве имени файла, если
                            была включена опция fopen wrappers. Смотрите более подробную информацию
                            об определении имени файла в описании функции <strong>fopen()</strong>. Смотрите также
                            список поддерживаемых обёрток URL, их возможности, замечания по
                            использованию и список предопределённых констант в разделе .
  <info>int</info>            <strong>$flags</strong>     В качестве необязательного параметра <strong>$flags</strong> может можно указать одну или
                            более следующих констант: <info>FILE_USE_INCLUDE_PATH</info> Ищет файл в
                            include_path. <info>FILE_IGNORE_NEW_LINES</info> Пропускать новую строку в конце
                            каждого элемента массива <info>FILE_SKIP_EMPTY_LINES</info> Пропускать пустые строки
                            <info>FILE_NO_DEFAULT_CONTEXT</info> Не использовать контекст по умолчанию
                            
                            Ищет файл в include_path.
                            
                            Пропускать новую строку в конце каждого элемента массива
                            
                            Пропускать пустые строки
                            
                            Не использовать контекст по умолчанию
  <info>resource|null</info>  <strong>$context</strong>   Ресурс (<info>resource</info>) с контекстом потока.

<comment>Return:</comment>
  <info>array|false</info>  Возвращает файл в виде массива. Каждый элемент массива соответствует строке файла, с
               символами новой строки включительно. В случае ошибки <strong>file()</strong> возвращает <info>false</info>.
               
               Каждая строка в полученном массиве будет завершаться символами конца строки, если
               только не используется <info>FILE_IGNORE_NEW_LINES</info>).
               
               Если у вас возникают проблемы с распознаванием PHP концов строк при чтении или
               создании файлов на Macintosh-совместимом компьютере, включение опции
               auto_detect_line_endings может помочь решить проблему.

<comment>See Also:</comment>
   * <strong>file_get_contents()</strong>
   * <strong>readfile()</strong>
   * <strong>fopen()</strong>
   * <strong>fsockopen()</strong>
   * <strong>popen()</strong>
   * <strong>include()</strong>
   * <strong>stream_context_create()</strong>


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

<comment>Param:</comment>
  <info>string</info>  <strong>$filename</strong>  Путь к файлу или каталогу.
                     
                     На платформах Windows, для проверки наличия файлов на сетевых ресурсах,
                     используйте имена, подобные //computername/share/filename или
                     \\computername\share\filename.

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

<comment>See Also:</comment>
   * <strong>is_readable()</strong>
   * <strong>is_writable()</strong>
   * <strong>is_file()</strong>
   * <strong>file()</strong>
   * <class>SplFileInfo</class>


id: file_get_contents
type: function
doc:
<comment>Description:</comment>
  Читает содержимое файла в строку
  
  Данная функция похожа на функцию <strong>file()</strong> с той лишь разницей, что <strong>file_get_contents()</strong> возвращает
  содержимое файла в строке, начиная с указанного смещения <strong>$offset</strong> и до <strong>$length</strong> байт. В случае
  неудачи, <strong>file_get_contents()</strong> вернёт <info>false</info>.
  
  Использование функции <strong>file_get_contents()</strong> наиболее предпочтительно в случае необходимости получить
  содержимое файла целиком, поскольку для улучшения производительности функция использует технику
  отображения файла в память (memory mapping), если она поддерживается вашей операционной системой.
  
  Если вы открываете URI, содержащий спецсимволы, такие как пробел, вам нужно закодировать URI при
  помощи <strong>urlencode()</strong>.

<comment>Param:</comment>
  <info>string</info>         <strong>$filename</strong>          Имя читаемого файла.
  <info>bool</info>           <strong>$use_include_path</strong>  Можно использовать константу <info>FILE_USE_INCLUDE_PATH</info> для поиска
                                    файла в include path. Только помните, что если вы используете
                                    строгую типизацию, то так сделать не получится, поскольку
                                    <info>FILE_USE_INCLUDE_PATH</info> имеет тип <info>int</info>. В таком случае используйте
                                    <info>true</info>.
  <info>resource|null</info>  <strong>$context</strong>           Корректный ресурс контекста, созданный с помощью функции
                                    <strong>stream_context_create()</strong>. Если в использовании особого контекста
                                    нет необходимости, можно пропустить этот параметр передав в него
                                    значение <info>null</info>.
  <info>int</info>            <strong>$offset</strong>            Смещение, с которого начнётся чтение оригинального потока.
                                    Отрицательное значение смещения будет отсчитываться с конца
                                    потока.
                                    
                                    Поиск смещения (<strong>$offset</strong>) не поддерживается при работе с
                                    удалёнными файлами. Попытка поиска смещения на нелокальных
                                    файлах может работать при небольших смещениях, но результат
                                    будет непредсказуемым, так как функция работает на
                                    буферизованном потоке.
  <info>int|null</info>       <strong>$length</strong>            Максимальный размер читаемых данных. По умолчанию чтение
                                    осуществляется пока не будет достигнут конец файла. Учтите, что
                                    этот параметр применяется и к потоку с фильтрами.

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

<comment>See Also:</comment>
   * <strong>file()</strong>
   * <strong>fgets()</strong>
   * <strong>fread()</strong>
   * <strong>readfile()</strong>
   * <strong>file_put_contents()</strong>
   * <strong>stream_get_contents()</strong>
   * <strong>stream_context_create()</strong>
   * $http_response_header


id: file_put_contents
type: function
doc:
<comment>Description:</comment>
  Пишет данные в файл
  
  Функция идентична последовательным успешным вызовам функций <strong>fopen()</strong>, <strong>fwrite()</strong> и <strong>fclose()</strong>.
  
  Если <strong>$filename</strong> не существует, файл будет создан. Иначе, существующий файл будет перезаписан, за
  исключением случая, если указан флаг <info>FILE_APPEND</info>.

<comment>Param:</comment>
  <info>string</info>         <strong>$filename</strong>  Путь к записываемому файлу.
  <info>mixed</info>          <strong>$data</strong>      Записываемые данные. Может быть типа <info>string</info>, <info>array</info> или ресурсом потока.
                            
                            Если <strong>$data</strong> является потоковым ресурсом (<info>stream</info>), оставшийся буфер этого
                            потока будет скопирован в указанный файл. Это похоже на использование
                            функции <strong>stream_copy_to_stream()</strong>.
                            
                            Также вы можете передать одномерный массив в качестве параметра <strong>$data</strong>.
                            Это будет эквивалентно вызову <return>file_put_contents($filename, implode('',
                            $array))</return>.
  <info>int</info>            <strong>$flags</strong>     Значением параметра <strong>$flags</strong> может быть любая комбинация следующих флагов,
                            соединённых бинарным оператором ИЛИ (<return>|</return>).
                            
                            Доступные флагиФлагОписание<info>FILE_USE_INCLUDE_PATH</info> Ищет <strong>$filename</strong> в
                            подключаемых директориях. Подробнее смотрите директиву include_path.
                            <info>FILE_APPEND</info> Если файл <strong>$filename</strong> уже существует, данные будут дописаны в
                            конец файла вместо того, чтобы его перезаписать. <info>LOCK_EX</info> Получить
                            эксклюзивную блокировку на файл на время записи. Другими словами, между
                            вызовами <strong>fopen()</strong> и <strong>fwrite()</strong> произойдёт вызов функции <strong>flock()</strong>. Это не
                            одно и то же, что  вызов <strong>fopen()</strong> с флагом "x".
  <info>resource|null</info>  <strong>$context</strong>   Корректный ресурс контекста, созданный с помощью функции
                            <strong>stream_context_create()</strong>.

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

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


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

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

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

<comment>See Also:</comment>
   * <strong>filemtime()</strong>
   * <strong>fileinode()</strong>
   * <strong>date()</strong>


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

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

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

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


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

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

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

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


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

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

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

<comment>See Also:</comment>
   * <strong>getmyinode()</strong>
   * <strong>stat()</strong>


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

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

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

<comment>See Also:</comment>
   * <strong>filectime()</strong>
   * <strong>stat()</strong>
   * <strong>touch()</strong>
   * <strong>getlastmod()</strong>


id: fileowner
type: function
doc:
<comment>Description:</comment>
  Возвращает идентификатор владельца файла
  
  Возвращает идентификатор владельца файла

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

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

<comment>See Also:</comment>
   * <strong>filegroup()</strong>
   * <strong>stat()</strong>
   * <strong>posix_getpwuid()</strong>


id: fileperms
type: function
doc:
<comment>Description:</comment>
  Возвращает информацию о правах на файл
  
  Возвращает информацию о правах доступа на файл.

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

<comment>Return:</comment>
  <info>int|false</info>  Возвращает права доступа на указанный файл в числовом виде. Младшие биты этого значения
             такие же, как и биты прав доступа для использования в функции <strong>chmod()</strong>, однако, на
             большинстве платформ, возвращаемое значение будет также включать информацию о типе
             файла, который передан в качестве параметра <strong>$filename</strong>. Примеры ниже демонстрируют как
             проверить возвращаемое значение на наличие определённых прав и типа файла на
             POSIX-системах, включая Linux и macOS.
             
             Для локальных файлов, возвращаемое значение является частью структуры <return>st_mode</return>, которая
             возвращается функцией С-библиотеки <strong>stat()</strong>. Какие в точности биты установлены может
             варьироваться от платформы к платформе. Рекомендуется поискать документацию к вашей
             платформе, если требуется обработка битов возвращаемого значения, не относящихся к
             правам доступа.
             
             Возвращает <info>false</info> в случае возникновения ошибки.

<comment>See Also:</comment>
   * <strong>chmod()</strong>
   * <strong>is_readable()</strong>
   * <strong>stat()</strong>


id: filesize
type: function
doc:
<comment>Description:</comment>
  Возвращает размер файла
  
  Возвращает размер указанного файла.

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

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

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


id: filetype
type: function
doc:
<comment>Description:</comment>
  Возвращает тип файла
  
  Возвращает тип указанного файла.

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

<comment>Return:</comment>
  <info>string|false</info>  Возвращает тип файла. Возможными значениями являются fifo, char, dir, block, link,
                file, socket и unknown.
                
                Возвращает <info>false</info> в случае возникновения ошибки. <strong>filetype()</strong> также вызовет ошибку
                уровня <info>E_NOTICE</info>, если системный вызов stat завершится ошибкой или тип файла
                неизвестен.

<comment>See Also:</comment>
   * <strong>is_dir()</strong>
   * <strong>is_file()</strong>
   * <strong>is_link()</strong>
   * <strong>file_exists()</strong>
   * <strong>mime_content_type()</strong>
   * <strong>pathinfo()</strong>
   * <strong>stat()</strong>


id: filter_has_var
type: function
doc:
<comment>Description:</comment>
  Проверяет существование переменной указанного типа

<comment>Param:</comment>
  <info>int</info>     <strong>$input_type</strong>  Один из <info>INPUT_GET</info>, <info>INPUT_POST</info>, <info>INPUT_COOKIE</info>, <info>INPUT_SERVER</info>, <info>INPUT_ENV</info>.
  <info>string</info>  <strong>$var_name</strong>    Имя проверяемой переменной.

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


id: filter_id
type: function
doc:
<comment>Description:</comment>
  Возвращает идентификатор, принадлежащий именованному фильтру

<comment>Param:</comment>
  <info>string</info>  <strong>$name</strong>  Имя фильтра.

<comment>Return:</comment>
  <info>int|false</info>  Идентификатор фильтра в случае успешного выполнения или <info>false</info>, если фильтр не
             существует.

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


id: filter_input
type: function
doc:
<comment>Description:</comment>
  Принимает переменную извне PHP и, при необходимости, фильтрует её

<comment>Param:</comment>
  <info>int</info>        <strong>$type</strong>      Одна из констант <info>INPUT_GET</info>, <info>INPUT_POST</info>, <info>INPUT_COOKIE</info>, <info>INPUT_SERVER</info> или
                        <info>INPUT_ENV</info>.
  <info>string</info>     <strong>$var_name</strong>  Имя получаемой переменной.
  <info>int</info>        <strong>$filter</strong>    Идентификатор (ID) применяемого фильтра. На странице  приведён список
                        доступных фильтров.
                        
                        Если не указан, то используется <info>FILTER_DEFAULT</info>, который равнозначен
                        <info>FILTER_UNSAFE_RAW</info>. Это значит, что по умолчанию не применяется никакого
                        фильтра.
  <info>array|int</info>  <strong>$options</strong>   Ассоциативный массив параметров или логическое ИЛИ флагов. Если фильтр
                        принимает параметры, флаги могут быть указаны в элементе массива "flags".

<comment>Return:</comment>
  <info>mixed</info>  Значение запрашиваемой переменной в случае успешного выполнения, <info>false</info>, если фильтрация
         завершилась неудачей, или <info>null</info>, если переменная <strong>$var_name</strong> не определена. Если установлен
         флаг <info>FILTER_NULL_ON_FAILURE</info>, функция возвращает <info>false</info>, если переменная не определена и
         <info>null</info>, если фильтрация завершилась неудачей.

<comment>See Also:</comment>
   * <strong>filter_var()</strong>
   * <strong>filter_input_array()</strong>
   * <strong>filter_var_array()</strong>
   * 


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

<comment>Param:</comment>
  <info>int</info>        <strong>$type</strong>       Одна из констант <info>INPUT_GET</info>, <info>INPUT_POST</info>, <info>INPUT_COOKIE</info>, <info>INPUT_SERVER</info> или
                         <info>INPUT_ENV</info>.
  <info>array|int</info>  <strong>$options</strong>    Массив, определяющий аргументы. Допустимый ключ - строка (<info>string</info>),
                         содержащая имя переменной, а допустимое значение - либо тип фильтра, либо
                         массив (<info>array</info>), при необходимости определяющий фильтр, флаги и параметры.
                         Если значение является массивом, допустимыми ключами являются <return>filter</return>,
                         который определяет (тип фильтра ), <return>flags</return>, который определяет любые флаги,
                         применяемые к фильтру и <return>options</return>, который определяет любые параметры,
                         применяемые к фильтру. Смотрите пример ниже для лучшего понимания.
                         
                         Этот параметр также может быть целым числом, содержащим предопределённую
                         фильтровую константу. Затем все значения во входном массиве фильтруются
                         этим фильтром.
  <info>bool</info>       <strong>$add_empty</strong>  Добавляет в результат отсутствующие ключи со значением <info>null</info>.

<comment>Return:</comment>
  <info>array|false|null</info>  Массив, содержащий значения запрошенных переменных в случае успешного
                    выполнения. Если входной массив, определяемый параметром <strong>$type</strong>, не заполнен, то
                    функция вернёт <info>null</info>, если флаг <info>FILTER_NULL_ON_FAILURE</info> не задан, <info>false</info> в
                    противном случае. Для других неудачных выполнений возвращается <info>false</info>
                    
                    Значение массива будет <info>false</info>, если фильтрация завершилась неудачей, или <info>null</info>,
                    если переменная не определена. Либо, если установлен флаг
                    <info>FILTER_NULL_ON_FAILURE</info>, возвращается <info>false</info>, если переменная не определена и
                    <info>null</info>, если фильтрация завершилась неудачей. Если параметр <strong>$add_empty</strong> равен
                    <info>false</info>, элемент массива не будет добавлен для удалённых переменных.

<comment>See Also:</comment>
   * <strong>filter_input()</strong>
   * <strong>filter_var_array()</strong>
   * 


id: filter_list
type: function
doc:
<comment>Description:</comment>
  Возвращает список всех поддерживаемых фильтров

<comment>Return:</comment>
  <info>array</info>  Возвращает массив имён всех поддерживаемых фильтров, пустой массив, если таких фильтров не
         существует. Идентификаторы (ID) фильтров не являются ключами этого массива, они могут быть
         получены с помощью функции <strong>filter_id()</strong> по имени фильтра.


id: filter_var
type: function
doc:
<comment>Description:</comment>
  Фильтрует переменную с помощью определённого фильтра

<comment>Param:</comment>
  <info>mixed</info>      <strong>$value</strong>    Значение переменной для фильтрации. Обратите внимание, что скалярные значения
                       перед фильтрацией преобразуются к строкам.
  <info>int</info>        <strong>$filter</strong>   Идентификатор (ID) применяемого фильтра. На странице  приведён список
                       доступных фильтров.
                       
                       Если не указан, то используется <info>FILTER_DEFAULT</info>, который равнозначен
                       <info>FILTER_UNSAFE_RAW</info>. Это значит, что по умолчанию не применяется никакого
                       фильтра.
  <info>array|int</info>  <strong>$options</strong>  Ассоциативный массив параметров либо логическая дизъюнкция (операция ИЛИ)
                       флагов. Если фильтр принимает параметры, флаги могут быть указаны в элементе
                       массива "flags". Для фильтра "callback" должен быть указан тип <info>callable</info>.
                       Фильтр "callback" должен принимать один аргумент, значение для фильтрации, и
                       возвращать значение после фильтрации.
                       
                        array( 'default' => 3, // значение, возвращаемое, если фильтрация
                       завершилась неудачей // другие параметры 'min_range' => 0 ), 'flags' =>
                       FILTER_FLAG_ALLOW_OCTAL,
                       );
                       $var = filter_var('0755', FILTER_VALIDATE_INT, $options);
                       
                       // для фильтров, который принимает только флаги, вы можете передать их
                       непосредственно
                       $var = filter_var('oops', FILTER_VALIDATE_BOOLEAN, FILTER_NULL_ON_FAILURE);
                       
                       // для фильтров, который принимает только флаги, вы также можете передать их
                       как массив
                       $var = filter_var('oops', FILTER_VALIDATE_BOOLEAN, array('flags' =>
                       FILTER_NULL_ON_FAILURE));
                       
                       // callback-функция фильтра валидации
                       function foo($value)
                       { // Ожидаемый формат: Фамилия, Имена if (strpos($value, ", ") === false)
                       return false; list($surname, $givennames) = explode(", ", $value, 2); $empty
                       = (empty($surname) || empty($givennames)); $notstrings =
                       (!is_string($surname) || !is_string($givennames)); if ($empty || $notstrings)
                       { return false; } else { return $value; }
                       }
                       $var = filter_var('Doe, Jane Sue', FILTER_CALLBACK, array('options' =>
                       'foo'));
                       ?>
                       ]]>

<comment>Return:</comment>
  <info>mixed</info>  Возвращает отфильтрованные данные или <info>false</info>, если фильтрация завершилась неудачей.

<comment>See Also:</comment>
   * <strong>filter_var_array()</strong>
   * <strong>filter_input()</strong>
   * <strong>filter_input_array()</strong>
   * 


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

<comment>Param:</comment>
  <info>array</info>      <strong>$array</strong>      Массив со строковыми ключами, содержащий данные для фильтрации.
  <info>array|int</info>  <strong>$options</strong>    Массив, определяющий параметры. Допустимый ключ - строка <info>string</info>, содержащая
                         имя переменной, а допустимое значение - тип фильтра, или массив (<info>array</info>),
                         при необходимости определяющий фильтр, флаги и параметры. Если значение
                         является массивом, допустимыми ключами являются <return>filter</return>, который определяет
                         тип фильтра, <return>flags</return>, который определяет любые флаги, применяемые к фильтру,
                         и <return>options</return>, который определяет любые параметры, применяемые к фильтру.
                         Смотрите пример ниже для лучшего понимания.
                         
                         Этот параметр также может быть целым числом, содержащим предопределённую
                         константу фильтра. Затем все значения во входном массиве фильтруются этим
                         фильтром.
  <info>bool</info>       <strong>$add_empty</strong>  Добавляет в результат отсутствующие ключи со значением <info>null</info>.

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

<comment>See Also:</comment>
   * <strong>filter_input_array()</strong>
   * <strong>filter_var()</strong>
   * <strong>filter_input()</strong>
   * 


id: finfo
type: class
doc:
<comment>Description:</comment>
  Этот класс предоставляет объектно-ориентированный интерфейс к функциям fileinfo.


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


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

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


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

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


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

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


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

<comment>Param:</comment>
  <info>finfo</info>          <strong>$finfo</strong>    Экземпляр <class>finfo</class>, возвращаемый функцией <strong>finfo_open()</strong>.
  <info>string</info>         <strong>$string</strong>   Содержимое проверяемого файла.
  <info>int</info>            <strong>$flags</strong>    Одна или несколько объединённых через бинарное ИЛИ констант Fileinfo.
  <info>resource|null</info>  <strong>$context</strong>  

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

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


id: finfo_close
type: function
doc:
<comment>Description:</comment>
  Закрывает экземпляр finfo
  
  Функция закрывает экземпляр, который был открыт функцией <strong>finfo_open()</strong>.

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

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


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

<comment>Param:</comment>
  <info>finfo</info>          <strong>$finfo</strong>     Экземпляр <class>finfo</class>, возвращаемый функцией <strong>finfo_open()</strong>.
  <info>string</info>         <strong>$filename</strong>  Название проверяемого файла.
  <info>int</info>            <strong>$flags</strong>     Одна или несколько объединённых через бинарное ИЛИ констант Fileinfo.
  <info>resource|null</info>  <strong>$context</strong>   Для описания <return>contexts</return>, смотрите .

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

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


id: finfo_open
type: function
doc:
<comment>Description:</comment>
  Создаёт экземпляр finfo
  
  Процедурный стиль
  
  Объектно-ориентированный стиль (конструктор):
  
  Данная функция открывает магическую базу данных и возвращает экземпляр.

<comment>Param:</comment>
  <info>int</info>          <strong>$flags</strong>           Одна или несколько объединённых через бинарное ИЛИ констант
                                Fileinfo.
  <info>string|null</info>  <strong>$magic_database</strong>  Имя файла магической базы данных, обычно что-то наподобие этого:
                                /path/to/magic.mime. Если не указан полный путь, будет использована
                                переменная окружения <return>MAGIC</return>. Если переменная окружения не указана, то
                                будет использоваться встроенная в PHP магическая база данных.
                                
                                Передача <info>null</info> или пустой строки эквивалентно значению по умолчанию.

<comment>Return:</comment>
  <info>finfo|false</info>  (Только процедурный стиль) Возвращает экземпляр <class>finfo</class> в случае успешного выполнения
               или <info>false</info> в случае возникновения ошибки.

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


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

<comment>Param:</comment>
  <info>finfo</info>  <strong>$finfo</strong>  Экземпляр <class>finfo</class>, возвращаемый функцией <strong>finfo_open()</strong>.
  <info>int</info>    <strong>$flags</strong>  Одна или несколько объединённых через бинарное ИЛИ констант Fileinfo.

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


id: floatval
type: function
doc:
<comment>Description:</comment>
  Возвращает значение переменной в виде числа с плавающей точкой
  
  Возвращает значение переменной <strong>$value</strong> в виде числа с плавающей точкой (<info>float</info>).

<comment>Param:</comment>
  <info>mixed</info>  <strong>$value</strong>  Может быть любого скалярного типа. <strong>floatval()</strong> нельзя использовать с объектами, в
                 этом случае возникнет ошибка уровня <info>E_WARNING</info> и функция вернёт 1.

<comment>Return:</comment>
  <info>float</info>  Значение заданной переменной в виде числа с плавающей точкой. Пустые массивы в качестве
         аргумента возвращают 0, непустые массивы возвращают 1.
         
         Строки чаще всего возвращают 0, тем не менее результат зависит от самых левых символов
         строки. Применяются правила приведения к float.

<comment>See Also:</comment>
   * <strong>boolval()</strong>
   * <strong>intval()</strong>
   * <strong>strval()</strong>
   * <strong>settype()</strong>
   * Манипуляции с типами


id: flock
type: function
doc:
<comment>Description:</comment>
  Портируемая консультативная блокировка файлов
  
  <strong>flock()</strong> позволяет осуществить простую модель чтения/записи, которая может быть использована
  практически на любой платформе (включая большинство вариантов Unix и даже Windows).
  
  Блокировка также снимается с помощью <strong>fclose()</strong> или когда <strong>$stream</strong> собирается сборщиком мусора.
  
  PHP поддерживает портируемый способ консультативной блокировки (advisory locking) полностью всего
  файла (что означает, что все программы, осуществляющие доступ к файлу, должны использовать один и
  тот же способ блокировки, иначе блокировка не будет работать). По умолчанию данная функция будет
  ждать получения блокировки; это поведение можно изменить с помощью описанного ниже параметра
  <info>LOCK_NB</info>.

<comment>Param:</comment>
  <info>resource</info>  <strong>$stream</strong>       Указатель (<info>resource</info>)
                          на файл, обычно создаваемый с помощью функции <strong>fopen()</strong>.
  <info>int</info>       <strong>$operation</strong>    <strong>$operation</strong> может принимать следующие значения: <info>LOCK_SH</info> для получения
                          разделяемой блокировки (чтение). <info>LOCK_EX</info> для получения эксклюзивной
                          блокировки (запись). <info>LOCK_UN</info> для снятия блокировки (разделяемой или
                          эксклюзивной).
                          
                          <info>LOCK_SH</info> для получения разделяемой блокировки (чтение).
                          
                          <info>LOCK_EX</info> для получения эксклюзивной блокировки (запись).
                          
                          <info>LOCK_UN</info> для снятия блокировки (разделяемой или эксклюзивной).
                          
                          Также возможно добавить константу <info>LOCK_NB</info> в качестве битовой маски к любой
                          из вышеуказанных операций, если <strong>flock()</strong> не должна блокироваться во время
                          попытки блокировки.
  <info>int</info>       <strong>$would_block</strong>  Необязательный третий параметр будет установлен в 1, если блокировка будет
                          блокирующей (код ошибки EWOULDBLOCK).

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


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

<comment>Param:</comment>
  <info>int|float</info>  <strong>$num</strong>  Числовое значение для округления

<comment>Return:</comment>
  <info>float</info>  Возвращает значение <strong>$num</strong>, округлённое в меньшую сторону до ближайшего целого числа.
         Возвращаемое значение функции <strong>floor()</strong> по-прежнему принимает тип <info>float</info>.

<comment>See Also:</comment>
   * <strong>ceil()</strong>
   * <strong>round()</strong>


id: flush
type: function
doc:
<comment>Description:</comment>
  Сброс системного буфера вывода
  
  Функция очищает системный буфер вывода PHP, при этом всё содержимое буфера отправляется в браузер
  пользователя (с некоторыми исключениями), независимо от используемого бекенда PHP (CGI, веб-сервер
  и т. д.).
  
  <strong>flush()</strong> не сможет переопределить схему буферизации вашего веб-сервера и никак не влияет на
  буферизацию браузера на стороне клиента. Функция также не влияет на механизм буферизации
  пользовательского PHP-кода. Это означает, что <strong>ob_flush()</strong> должен быть вызван перед <strong>flush()</strong>, чтобы
  очистить выходные буферы, если они используются.
  
  Некоторые серверы, особенно под управлением Win32, будут по-прежнему продолжать буферизировать
  вывод вашего скрипта до передачи результатов в браузер.
  
  Серверные модули для Apache, такие как mod_gzip, могут сами выполнять буферизацию, поэтому <strong>flush()</strong>
  не приводит к немедленной передаче данных клиенту.
  
  Браузер может также буферизировать поступающие к нему данные перед отображением. Например,
  Netscape, буферизирует текст до тех пор, пока не получит конец строки или начало тега, и не будет
  отображать таблицы пока не будет замечен тег \</table&gt; самой внешней таблицы.
  
  Некоторые версии Microsoft Internet Explorer начинают отображать страницу только после получения
  256 байт вывода, поэтому может понадобиться отправить дополнительные пробелы перед сбросом, чтобы
  такие браузеры отобразили страницу.

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

<comment>See Also:</comment>
   * <strong>ob_flush()</strong>
   * <strong>ob_clean()</strong>
   * <strong>ob_end_flush()</strong>
   * <strong>ob_end_clean()</strong>


id: fmod
type: function
doc:
<comment>Description:</comment>
  Возвращает дробный остаток от деления по модулю
  
  Возвращает дробный остаток от деления делимого (<strong>$num1</strong>) и делителя (<strong>$num2</strong>). Остаток (r)
  определяется так: x = i * y + r, где i - некоторое целое. Если <strong>$y</strong> не равен нулю, то r имеет такой
  же знак, как <strong>$num1</strong> и величину, меньшую или равную величине <strong>$num2</strong>.

<comment>Param:</comment>
  <info>float</info>  <strong>$num1</strong>  Делимое.
  <info>float</info>  <strong>$num2</strong>  Делитель.

<comment>Return:</comment>
  <info>float</info>  Остаток от операции деления <strong>$num1</strong>/<strong>$num2</strong>

<comment>See Also:</comment>
   * <return>/</return> - деление с плавающей точкой
   * <return>%</return> - целочисленный остаток
   * <strong>intdiv()</strong> - целочисленное деление


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

<comment>Param:</comment>
  <info>string</info>  <strong>$pattern</strong>   Шаблон подстановки оболочки операционной системы.
  <info>string</info>  <strong>$filename</strong>  Проверяемая строка. Данная функция особенно полезна для имён файлов, но также
                     может быть использована с обычными строками.
                     
                     Среднестатистический пользователь знаком с подстановками оболочки, как минимум
                     с самыми простыми из них - <return>'?'</return> и <return>'*'</return>, так что использование <strong>fnmatch()</strong> вместо
                     <strong>preg_match()</strong> для поиска в пользовательской части сайта может быть намного
                     удобнее для пользователей, не являющихся программистами.
  <info>int</info>     <strong>$flags</strong>     Значением параметра <strong>$flags</strong> может быть любая комбинация следующих флагов,
                     объединённых с помощью бинарного оператора ИЛИ (|).  Перечень возможных флагов
                     для функции <strong>fnmatch()</strong> <strong>$Флаг</strong>Описание<info>FNM_NOESCAPE</info> Отключить экранирование
                     обратных слешей. <info>FNM_PATHNAME</info> Слеш в строке совпадает только со слешем в
                     указанном шаблоне. <info>FNM_PERIOD</info> Ведущая точка в строке должна точно совпадать с
                     точкой в указанном шаблоне. <info>FNM_CASEFOLD</info> Совпадение без учёта регистра.
                     Является частью расширения GNU.

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

<comment>See Also:</comment>
   * <strong>glob()</strong>
   * <strong>preg_match()</strong>
   * <strong>sscanf()</strong>
   * <strong>printf()</strong>
   * <strong>sprintf()</strong>


id: fopen
type: function
doc:
<comment>Description:</comment>
  Открывает файл или URL
  
  <strong>fopen()</strong> закрепляет именованный ресурс, указанный в аргументе <strong>$filename</strong>, за потоком.

<comment>Param:</comment>
  <info>string</info>         <strong>$filename</strong>          Если <strong>$filename</strong> передан в форме "scheme://...", он считается URL
                                    и PHP проведёт поиск обработчика протокола (также известного как
                                    "обёртка") для этой схемы. Если ни одна обёртка не закреплена за
                                    протоколом, PHP выдаст замечание, чтобы помочь вам отследить
                                    потенциальную проблему в вашем скрипте и затем продолжит
                                    выполнение, как если бы <strong>$filename</strong> указывал на обыкновенный файл.
                                    
                                    Если PHP установлено, что <strong>$filename</strong> указывает на локальный файл,
                                    тогда выполняется попытка открыть поток к этому файлу. Файл
                                    должен быть доступен PHP, так что вам следует убедиться, что
                                    права доступа на файл это разрешают. Если вы включили
                                    open_basedir, то накладываются дальнейшие ограничения.
                                    
                                    Если PHP установил, что <strong>$filename</strong> указывает на
                                    зарегистрированный протокол и этот протокол зарегистрирован как
                                    сетевой URL, PHP выполняет проверку состояния директивы
                                    allow_url_fopen. Если она выключена, PHP выдаст предупреждение и
                                    вызов fopen закончится неудачей.
                                    
                                    Список поддерживаемых протоколов доступен в разделе . Некоторые
                                    протоколы (<return>обёртки</return>) поддерживают <return>контекст</return> и/или опции php.ini.
                                    Обратитесь к соответствующей странице с описанием используемого
                                    протокола для получения списка опций, которые могут быть
                                    установлены. (например, значение php.ini <return>user_agent</return> используется
                                    обёрткой <return>http</return>).
                                    
                                    На платформе Windows, необходимо экранировать все обратные слеши
                                    в пути к файлу или использовать прямые слеши.
                                    ]]>
  <info>string</info>         <strong>$mode</strong>              Параметр <strong>$mode</strong> указывает тип доступа, который вы запрашиваете у
                                    потока. Он может быть одним из следующих вариантов:  Список
                                    возможных режимов для <strong>fopen()</strong>, используя <strong>$mode</strong> <strong>$mode</strong>Описание<return>'r'</return>
                                    Открывает файл только для чтения; помещает указатель в начало
                                    файла. <return>'r+'</return> Открывает файл для чтения и записи; помещает
                                    указатель в начало файла. <return>'w'</return> Открывает файл только для записи;
                                    в противном случае ведёт себя так же, как и <return>'w+'</return>. <return>'w+'</return> Открывает
                                    файл для чтения и записи; помещает указатель в начало файла и
                                    обрезает файл до нулевой длины. Если файл не существует -
                                    пытается его создать. <return>'a'</return> Открывает файл только для записи;
                                    помещает указатель в конец файла. Если файл не существует -
                                    пытается его создать. В данном режиме функция <strong>fseek()</strong> не
                                    применима, записи всегда добавляются в конец. <return>'a+'</return> Открывает
                                    файл для чтения и записи; помещает указатель в конец файла. Если
                                    файл не существует - пытается его создать. В данном режиме
                                    функция  <strong>fseek()</strong> влияет только на позицию чтения, записи всегда
                                    добавляются в конец. <return>'x'</return> Создаёт и открывает только для записи;
                                    помещает указатель в начало файла. Если файл уже существует,
                                    вызов <strong>fopen()</strong> закончится неудачей, вернёт <info>false</info> и выдаст ошибку
                                    уровня <info>E_WARNING</info>. Если файл не существует, попытается его
                                    создать. Это эквивалентно указанию флагов <return>O_EXCL|O_CREAT</return> для
                                    внутреннего системного вызова <return>open(2)</return>. <return>'x+'</return> Создаёт и открывает
                                    для чтения и записи; в остальном имеет то же поведение, что
                                    и<return>'x'</return>. <return>'c'</return> Открывает файл только для записи. Если файл не
                                    существует, то он создаётся. Если же файл существует, то он не
                                    обрезается (в отличие от <return>'w'</return>), и вызов к этой функции не
                                    вызывает ошибку (также как и в случае с <return>'x'</return>). Указатель на файл
                                    будет установлен на начало файла. Это может быть полезно при
                                    желании заблокировать файл (смотрите <strong>flock()</strong>) перед изменением,
                                    так как использование <return>'w'</return> может обрезать файл ещё до того как
                                    была получена блокировка (если вы желаете обрезать файл, можно
                                    использовать функцию <strong>ftruncate()</strong> после запроса на блокировку).
                                    <return>'c+'</return> Открывает файл для чтения и записи; в остальном имеет то же
                                    поведение, что и <return>'c'</return>. <return>'e'</return> Установить флаг close-on-exec (закрыть
                                    при запуске) на открытый файловый дескриптор. Доступно только в
                                    PHP скомпилированном на системах поддерживающих POSIX.1-2008.
                                    
                                    Разные семейства операционных систем имеют разные соглашения
                                    относительно окончания строк. Когда вы пишете текст и хотите
                                    вставить разрыв строки, вы должны использовать правильные
                                    символы (или символ) для вашей операционной системы. Системы
                                    семейства Unix используют <return>\n</return> в качестве символа конца строки,
                                    системы семейства Windows используют <return>\r\n</return> в качестве символов
                                    окончания строки и системы семейства Macintosh (Mac OS Classic)
                                    используют <return>\r</return> в качестве символа конца строки.
                                    
                                    Если вы используете неверный символ конца строки при
                                    редактировании файлов, вы можете обнаружить, что при открытии
                                    эти файлы "странно выглядят".
                                    
                                    Windows предлагает флаг режима текстовой трансляции (<return>'t'</return>),
                                    который автоматически переведёт <return>\n</return> в <return>\r\n</return> во время работы с
                                    файлом. И наоборот - вы также можете использовать <return>'b'</return>, чтобы
                                    принудительно включить бинарный режим, в котором ваши данные не
                                    будут преобразовываться. Чтобы использовать эти режимы, укажите
                                    <return>'b'</return> или <return>'t'</return> последней буквой параметра <strong>$mode</strong>.
                                    
                                    Флагом трансляции по умолчанию является <return>'b'</return>. Вы можете
                                    использовать режим <return>'t'</return>, если работаете с текстовыми файлами и
                                    используете <return>\n</return> для обозначения конца строки в вашем скрипте, но
                                    при этом предполагаете, что ваши файлы будут использоваться в
                                    таких приложениях, как "Блокнот" (в устаревших версиях). Во всех
                                    остальных случаях используйте флаг <return>'b'</return>.
                                    
                                    Если вы укажете флаг 't' во время работы с бинарными файлами, вы
                                    можете столкнуться со странными проблемами с вашими данными,
                                    включая повреждённые файлы изображений и проблемы с символами
                                    <return>\r\n</return>.
                                    
                                    Опять же из соображений портируемости крайне рекомендуется
                                    переписать старый код, который полагается на режим <return>'t'</return>, чтобы
                                    вместо этого он использовал правильные концы строк и режим <return>'b'</return>.
                                    
                                    Параметр <strong>$mode</strong> игнорируется при работе с обёртками потока
                                    php://output, php://input, php://stdin, php://stdout,
                                    php://stderr и php://fd.
  <info>bool</info>           <strong>$use_include_path</strong>  Необязательный третий параметр <strong>$use_include_path</strong> может быть
                                    установлен в '1' или <info>true</info>, если вы также хотите провести поиск
                                    файла в include_path.
  <info>resource|null</info>  <strong>$context</strong>           Ресурс (<info>resource</info>) с контекстом потока.

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

<comment>See Also:</comment>
   * 
   * <strong>fclose()</strong>
   * <strong>fgets()</strong>
   * <strong>fread()</strong>
   * <strong>fwrite()</strong>
   * <strong>fsockopen()</strong>
   * <strong>file()</strong>
   * <strong>file_exists()</strong>
   * <strong>is_readable()</strong>
   * <strong>stream_set_timeout()</strong>
   * <strong>popen()</strong>
   * <strong>stream_context_create()</strong>
   * <strong>umask()</strong>
   * <class>SplFileObject</class>


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

<comment>Param:</comment>
  <info>callable</info>  <strong>$callback</strong>  Функция или метод для вызова. Этот параметр может быть массивом с именем
                       класса и метода, либо строкой с именем функции.
  <info>mixed</info>     <strong>$args</strong>      Ноль или более параметров, которые будут переданы вызываемой функции.

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

<comment>See Also:</comment>
   * <strong>forward_static_call_array()</strong>
   * <strong>call_user_func_array()</strong>
   * <strong>call_user_func()</strong>
   * <strong>is_callable()</strong>


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

<comment>Param:</comment>
  <info>callable</info>  <strong>$callback</strong>   Функция или метод для вызова. Этот параметр может быть массивом с именем
                        класса и метода, либо строкой с именем функции.
  <info></info>          <strong>$parameter</strong>  Массив, содержащий все аргументы вызова функции.
                        
                        Помните, что аргументы <strong>forward_static_call_array()</strong> не передаются по ссылке.

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

<comment>See Also:</comment>
   * <strong>forward_static_call()</strong>
   * <strong>call_user_func()</strong>
   * <strong>call_user_func_array()</strong>
   * <strong>is_callable()</strong>


id: fpassthru
type: function
doc:
<comment>Description:</comment>
  Выводит все оставшиеся данные из файлового указателя
  
  Читает указанный файловый указатель с текущей позиции до EOF (конца файла) и записывает результат
  в буфер вывода.
  
  Вам может понадобиться вызвать <strong>rewind()</strong>, чтобы сбросить файловый указатель на начало файла, если
  вы уже записывали данные в файл.
  
  Если вы хотите просто сбросить содержимое файла в буфер вывода, предварительно не модифицируя его
  и не начиная с определённого смещения, вы можете воспользоваться <strong>readfile()</strong>, которая избавит вас
  от лишнего вызова <strong>fopen()</strong>.

<comment>Param:</comment>
  <info>resource</info>  <strong>$stream</strong>  Указатель на файл должен быть корректным и указывать
                     на файл, успешно открытый функциями <strong>fopen()</strong> или
                     <strong>fsockopen()</strong> (и всё ещё не закрытый функцией <strong>fclose()</strong>).

<comment>Return:</comment>
  <info>int</info>  Возвращает количество символов, прочтённых из <strong>$stream</strong> и переданных на вывод.

<comment>See Also:</comment>
   * <strong>readfile()</strong>
   * <strong>fopen()</strong>
   * <strong>popen()</strong>
   * <strong>fsockopen()</strong>


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

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


id: fprintf
type: function
doc:
<comment>Description:</comment>
  Записывает отформатированную строку в поток
  
  Записывает строку, созданную с использованием строки формата <strong>$format</strong>, в поток, дескриптор которого
  передаётся в параметре <strong>$stream</strong>.

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

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

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


id: fputcsv
type: function
doc:
<comment>Description:</comment>
  Форматирует строку в виде CSV и записывает её в файловый указатель
  
  <strong>fputcsv()</strong> форматирует строку (переданную в виде массива <strong>$fields</strong>) в виде CSV и записывает её
  (заканчивая переводом строки) в указанный файл <strong>$stream</strong>.

<comment>Param:</comment>
  <info>resource</info>  <strong>$stream</strong>     Указатель на файл должен быть корректным и указывать
                        на файл, успешно открытый функциями <strong>fopen()</strong> или
                        <strong>fsockopen()</strong> (и всё ещё не закрытый функцией <strong>fclose()</strong>).
  <info>array</info>     <strong>$fields</strong>     Массив строк (<info>string</info>).
  <info>string</info>    <strong>$separator</strong>  Дополнительный параметр <strong>$separator</strong> устанавливает разделитель полей (только
                        один однобайтовый символ).
  <info>string</info>    <strong>$enclosure</strong>  Дополнительный параметр <strong>$enclosure</strong> устанавливает ограничитель полей (только
                        один однобайтовый символ).
  <info>string</info>    <strong>$escape</strong>     Необязательный параметр <strong>$escape</strong> задаёт экранирующий символ (не более одного
                        однобайтового символа). Пустая строка (<return>""</return>) отключает проприетарный механизм
                        экранирования.
  <info>string</info>    <strong>$eol</strong>        Необязательный параметр <strong>$eol</strong> задаёт настраиваемую последовательность конца
                        строки.

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

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


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


id: fread
type: function
doc:
<comment>Description:</comment>
  Бинарно-безопасное чтение файла
  
  <strong>fread()</strong> читает до <strong>$length</strong> байт из файлового указателя <strong>$stream</strong> и смещает указатель. Чтение
  останавливается как только было достигнуто одно из следующих условий:  было прочитано <strong>$length</strong> байт
  достигнут EOF (конец файла)  стал доступен пакет или истекло  время ожидания сокета (для сетевых
  потоков)  если читаемый поток является буферизованным и не представляет собой обычный файл, то за
  один раз максимум читается количество байт, равное размеру одной порции данных (обычно это 8192),
  однако, в зависимости от ранее буферизованных данных размер возвращаемых данных может быть больше
  размера одной порции данных.
  
  было прочитано <strong>$length</strong> байт
  
  достигнут EOF (конец файла)
  
  стал доступен пакет или истекло  время ожидания сокета (для сетевых потоков)
  
  если читаемый поток является буферизованным и не представляет собой обычный файл, то за один раз
  максимум читается количество байт, равное размеру одной порции данных (обычно это 8192), однако, в
  зависимости от ранее буферизованных данных размер возвращаемых данных может быть больше размера
  одной порции данных.

<comment>Param:</comment>
  <info>resource</info>  <strong>$stream</strong>  Указатель (<info>resource</info>)
                     на файл, обычно создаваемый с помощью функции <strong>fopen()</strong>.
  <info>int</info>       <strong>$length</strong>  <strong>$length</strong> указывает размер прочитанных данных в байтах.

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

<comment>See Also:</comment>
   * <strong>fwrite()</strong>
   * <strong>fopen()</strong>
   * <strong>fsockopen()</strong>
   * <strong>popen()</strong>
   * <strong>fgets()</strong>
   * <strong>fgetss()</strong>
   * <strong>fscanf()</strong>
   * <strong>file()</strong>
   * <strong>fpassthru()</strong>
   * <strong>fseek()</strong>
   * <strong>ftell()</strong>
   * <strong>rewind()</strong>
   * <strong>unpack()</strong>


id: frenchtojd
type: function
doc:
<comment>Description:</comment>
  Преобразует дату Французского республиканского календаря в количество
     дней в Юлианском летоисчислении
    
  
  Преобразует дату Французского республиканского календаря в количество дней в Юлианском
  летоисчислении.
  
  Функция преобразует даты только с 1 по 14 годов (григорианские даты с 22 сентября 1792 г. по 22
  сентября 1806 г.) Это более чем охватывает период, когда этот календарь использовался.

<comment>Param:</comment>
  <info>int</info>  <strong>$month</strong>  Месяц в виде числа от 1 (для месяца Vendémiaire) до 13 (для периода 5-6 дней в конце
               каждого года)
  <info>int</info>  <strong>$day</strong>    День в виде числа от 1 до 30
  <info>int</info>  <strong>$year</strong>   Год в виде числа между 1 и 14

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

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


id: fscanf
type: function
doc:
<comment>Description:</comment>
  Обрабатывает данные из файла в соответствии с форматом
  
  Функция <strong>fscanf()</strong> похожа на <strong>sscanf()</strong>, но берёт данные для обработки из файла, связанного с <strong>$stream</strong>,
  и интерпретирует их согласно формату <strong>$format</strong>.
  
  Любой пробельный символ в строке формата эквивалентен любому пробельному символу во входящем
  потоке. Это означает, что даже табуляция (<return>\t</return>) в строке формата может быть сопоставлена одному
  символу пробела во входящем потоке данных.
  
  Каждый вызов <strong>fscanf()</strong> читает одну строку из файла.

<comment>Param:</comment>
  <info>resource</info>  <strong>$stream</strong>  Указатель (<info>resource</info>)
                     на файл, обычно создаваемый с помощью функции <strong>fopen()</strong>.
  <info>string</info>    <strong>$format</strong>  Интерпретируемый формат для параметра <strong>$string</strong>, который описан в документации
                     функции <strong>sprintf()</strong> со следующими отличиями:  Функция не ориентирована на
                     локализацию.  Не поддерживаются значения <return>F</return>, <return>g</return>, <return>G</return> и <return>b</return>. <return>D</return> обозначает десятичное
                     число. <return>i</return> обозначает целое число с определением системы счисления. <return>n</return> обозначает
                     количество символов, обработанных на данный момент. <return>s</return> останавливает чтение на
                     любом символе пробела. <return>*</return> вместо <return>argnum$</return> подавляет присвоение данной
                     спецификации преобразования.
  <info>mixed</info>     <strong>$vars</strong>    Необязательные присваиваемые значения.

<comment>Return:</comment>
  <info>array|int|false|null</info>  Если в функцию переданы только два аргумента, обработанные значения будут
                        возвращены в виде массива. В ином случае, если были переданы необязательные
                        аргументы, функция вернёт количество присвоенных значений. Необязательные
                        аргументы должны быть переданы по ссылке.
                        
                        Если в <strong>$format</strong> ожидается больше подстрок, чем доступно в <strong>$string</strong>, будет
                        возвращён <info>null</info>. В случае возникновения других ошибок будет возвращено <info>false</info>.

<comment>See Also:</comment>
   * <strong>fread()</strong>
   * <strong>fgets()</strong>
   * <strong>fgetss()</strong>
   * <strong>sscanf()</strong>
   * <strong>printf()</strong>
   * <strong>sprintf()</strong>


id: fseek
type: function
doc:
<comment>Description:</comment>
  Устанавливает смещение в файловом указателе
  
  Устанавливает смещение в файле, на который ссылается <strong>$stream</strong>. Новое смещение, измеряемое в байтах
  от начала файла, получается путём прибавления параметра <strong>$offset</strong> к позиции, указанной в параметре
  <strong>$whence</strong>.
  
  В общей сложности разрешается указывать смещение за пределами конца файла, если данные потом будут
  записаны в этой позиции, чтение любой незаписанной области между концом файла и указанной позицией
  возвратит нулевые байты. Однако, определённые потоки могут не поддерживать это поведение, особенно
  если у них есть основное хранилище фиксированного размера.

<comment>Param:</comment>
  <info>resource</info>  <strong>$stream</strong>  Указатель (<info>resource</info>)
                     на файл, обычно создаваемый с помощью функции <strong>fopen()</strong>.
  <info>int</info>       <strong>$offset</strong>  Смещение.
                     
                     Для смещения позиции перед концом файла необходимо передать отрицательное
                     значение <strong>$offset</strong> и установить параметр <strong>$whence</strong> в <info>SEEK_END</info>.
  <info>int</info>       <strong>$whence</strong>  Значениями <strong>$whence</strong> являются: <info>SEEK_SET</info> - Установить смещение в <strong>$offset</strong> байт.
                     <info>SEEK_CUR</info> - Установить смещение в текущее положение плюс <strong>$offset</strong>. <info>SEEK_END</info> -
                     Установить смещение в конец файла плюс <strong>$offset</strong>.

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

<comment>See Also:</comment>
   * <strong>ftell()</strong>
   * <strong>rewind()</strong>


id: fsockopen
type: function
doc:
<comment>Description:</comment>
  Открывает соединение с интернет-сокетом или доменным сокетом Unix
    
  
  Устанавливает соединение с сокетом ресурса <strong>$hostname</strong>.
  
  PHP поддерживает целевые ресурсы в интернете и Unix-доменах в том виде, как они описаны в . Список
  поддерживаемых транспортов можно получить с помощью функции <strong>stream_get_transports()</strong>.
  
  По умолчанию сокет будет открыт в блокирующем режиме. Переключить его в неблокирующих режим можно
  функцией <strong>stream_set_blocking()</strong>.
  
  <strong>stream_socket_client()</strong> выполняет аналогичную функцию, но предоставляет более широкий выбор
  настроек соединения, включающий установку неблокирующего режима и возможность предоставления
  потокового контекста.

<comment>Param:</comment>
  <info>string</info>      <strong>$hostname</strong>       Если установлена поддержка OpenSSL, можно использовать SSL- или
                              TLS-протоколы соединений поверх TCP/IP при подключении к удалённому
                              хосту. Для этого перед <strong>$hostname</strong> нужно добавить префикс <return>ssl://</return> или
                              <return>tls://</return>.
  <info>int</info>         <strong>$port</strong>           Номер порта. Его можно не указывать, передав <return>-1</return> для тех протоколов,
                              которые не используют порты, например <return>unix://</return>.
  <info>int</info>         <strong>$error_code</strong>     Если этот параметр предоставить, то в случае возникновения ошибки
                              системного вызова функции <return>connect()</return> он будет принимать номер этой
                              ошибки.
                              
                              Если значение параметра <strong>$error_code</strong> равно <return>0</return>, а функция вернула <info>false</info>,
                              значит ошибка произошла до вызова <return>connect()</return>. В большинстве случаев это
                              свидетельствует о проблемах при инициализации сокета.
  <info>string</info>      <strong>$error_message</strong>  Сообщение об ошибке в виде строки.
  <info>float|null</info>  <strong>$timeout</strong>        Время ожидания соединения в секундах. Если <info>null</info>, используется
                              настройка php.ini default_socket_timeout.
                              
                              Если требуется установить время ожидания чтения/записи данных через
                              сокет, используйте функцию <strong>stream_set_timeout()</strong>, т.к. параметр
                              <strong>$timeout</strong> функции <strong>fsockopen()</strong> ограничивает только время процесса
                              установки соединения с сокетом.

<comment>Return:</comment>
  <info>resource|false</info>  <strong>fsockopen()</strong> возвращает файловый указатель, который можно использовать с функциями,
                  работающие с файлами (такие как <strong>fgets()</strong>, <strong>fgetss()</strong>, <strong>fwrite()</strong>, <strong>fclose()</strong> и <strong>feof()</strong>).
                  Если вызов завершится неудачно, функция вернёт <info>false</info>.

<comment>See Also:</comment>
   * <strong>pfsockopen()</strong>
   * <strong>stream_socket_client()</strong>
   * <strong>stream_set_blocking()</strong>
   * <strong>stream_set_timeout()</strong>
   * <strong>fgets()</strong>
   * <strong>fgetss()</strong>
   * <strong>fwrite()</strong>
   * <strong>fclose()</strong>
   * <strong>feof()</strong>
   * <strong>socket_connect()</strong>
   * Модуль Curl


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

<comment>Param:</comment>
  <info>resource</info>  <strong>$stream</strong>  Указатель (<info>resource</info>)
                     на файл, обычно создаваемый с помощью функции <strong>fopen()</strong>.

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


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

<comment>Param:</comment>
  <info>resource</info>  <strong>$stream</strong>  Указатель на файл должен быть корректным и указывать
                     на файл, успешно открытый функциями <strong>fopen()</strong> или
                     <strong>fsockopen()</strong> (и всё ещё не закрытый функцией <strong>fclose()</strong>).

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

<comment>See Also:</comment>
   * <strong>fdatasync()</strong>
   * <strong>fflush()</strong>


id: ftell
type: function
doc:
<comment>Description:</comment>
  Возвращает текущую позицию указателя чтения/записи файла
  
  Возвращает позицию файлового указателя <strong>$stream</strong>.

<comment>Param:</comment>
  <info>resource</info>  <strong>$stream</strong>  Файловый указатель должен быть действующим указателем на поток, открытый
                     функциями <strong>fopen()</strong> или <strong>popen()</strong>. <strong>ftell()</strong> возвращает неопределённые результаты для
                     потоков, разрешающих только запись в конец (открытых с флагом "a").

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

<comment>See Also:</comment>
   * <strong>fopen()</strong>
   * <strong>popen()</strong>
   * <strong>fseek()</strong>
   * <strong>rewind()</strong>


id: ftok
type: function
doc:
<comment>Description:</comment>
  Преобразование пути и идентификатора проекта в ключ System V IPC
  
  Функция преобразует <strong>$filename</strong> существующего, доступного файла и идентификатор проекта в <return>целое</return> для
  использования, например, в <strong>shmop_open()</strong> и других ключах System V IPC.

<comment>Param:</comment>
  <info>string</info>  <strong>$filename</strong>    Путь к файлу
  <info>string</info>  <strong>$project_id</strong>  Идентификатор проекта. Это должен быть один символ.

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

<comment>See Also:</comment>
   * <strong>shmop_open()</strong>
   * <strong>sem_get()</strong>


id: ftp_alloc
type: function
doc:
<comment>Description:</comment>
  Резервирует место на диске для закачиваемого файла
  
  Посылает команду <return>ALLO</return> FTP-серверу для резервирования места под загружаемый файл.
  
  Многие FTP-серверы не поддерживают эту команду. Такие серверы возвращают код неудачи (<info>false</info>), что
  означает отсутствие поддержки этой команды, или код успешного выполнения (<info>true</info>), означающий, что в
  резервировании нет необходимости и клиенту следует продолжать, будто операция была выполнена
  успешно. По этой причине эту функцию следует использовать с серверами, которые требуют
  обязательного резервирования.

<comment>Param:</comment>
  <info>FTP\Connection</info>  <strong>$ftp</strong>       An <class>FTP\Connection</class> instance.
  <info>int</info>             <strong>$size</strong>      Количество резервируемых байт.
  <info>string</info>          <strong>$response</strong>  Текстовое представление ответа сервера будет возвращено по ссылке в
                             аргумент <strong>$response</strong>, если он указан.

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

<comment>See Also:</comment>
   * <strong>ftp_put()</strong>
   * <strong>ftp_fput()</strong>


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

<comment>Param:</comment>
  <info>FTP\Connection</info>  <strong>$ftp</strong>              An <class>FTP\Connection</class> instance.
  <info>string</info>          <strong>$remote_filename</strong>  
  <info>string</info>          <strong>$local_filename</strong>   
  <info>int</info>             <strong>$mode</strong>             

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


id: ftp_cdup
type: function
doc:
<comment>Description:</comment>
  Переходит в родительскую директорию
  
  Переходит в родительскую директорию.

<comment>Param:</comment>
  <info>FTP\Connection</info>  <strong>$ftp</strong>  An <class>FTP\Connection</class> instance.

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

<comment>See Also:</comment>
   * <strong>ftp_chdir()</strong>
   * <strong>ftp_pwd()</strong>


id: ftp_chdir
type: function
doc:
<comment>Description:</comment>
  Изменяет текущую директорию на FTP-сервере
  
  Меняет текущую директорию на заданную аргументом.

<comment>Param:</comment>
  <info>FTP\Connection</info>  <strong>$ftp</strong>        An <class>FTP\Connection</class> instance.
  <info>string</info>          <strong>$directory</strong>  Целевая директория.

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

<comment>See Also:</comment>
   * <strong>ftp_cdup()</strong>
   * <strong>ftp_pwd()</strong>


id: ftp_chmod
type: function
doc:
<comment>Description:</comment>
  Устанавливает права доступа к файлу
  
  Устанавливает права доступа к указанному удалённому файлу в значение <strong>$permissions</strong>.

<comment>Param:</comment>
  <info>FTP\Connection</info>  <strong>$ftp</strong>          An <class>FTP\Connection</class> instance.
  <info>int</info>             <strong>$permissions</strong>  Новые права доступа, указанные в виде восьмеричного значения.
  <info>string</info>          <strong>$filename</strong>     Удалённый файл.

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

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


id: ftp_close
type: function
doc:
<comment>Description:</comment>
  Закрывает соединение с FTP-сервером
  
  <strong>ftp_close()</strong> закрывает указанный идентификатор соединения с сервером и освобождает <info>resource</info>.
  
  После вызова этой функции, соединение больше не может быть использовано, и при необходимости
  должно быть установлено заново при помощи функции <strong>ftp_connect()</strong>.

<comment>Param:</comment>
  <info>FTP\Connection</info>  <strong>$ftp</strong>  An <class>FTP\Connection</class> instance.

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

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


id: ftp_connect
type: function
doc:
<comment>Description:</comment>
  Устанавливает соединение с FTP-сервером
  
  <strong>ftp_connect()</strong> устанавливает FTP-соединение с указанным сервером <strong>$hostname</strong>.

<comment>Param:</comment>
  <info>string</info>  <strong>$hostname</strong>  Адрес FTP-сервера. Этот аргумент не должен содержать слешей в конце и префикса
                     <return>ftp://</return> в начале.
  <info>int</info>     <strong>$port</strong>      Этот аргумент указывает альтернативный порт для подключения. Если он опущен или
                     установлен в ноль, то будет использован FTP порт по умолчанию - 21.
  <info>int</info>     <strong>$timeout</strong>   Этот аргумент указывает время ожидания в секундах для всех последующих сетевых
                     операций. Если опущен, используется значение по умолчанию - 90 секунд. Время
                     ожидания может быть изменено и получено в любой момент при помощи функций
                     <strong>ftp_set_option()</strong> и <strong>ftp_get_option()</strong> соответственно.

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

<comment>See Also:</comment>
   * <strong>ftp_close()</strong>
   * <strong>ftp_ssl_connect()</strong>


id: ftp_delete
type: function
doc:
<comment>Description:</comment>
  Удаляет файл на FTP-сервере
  
  <strong>ftp_delete()</strong> удаляет файл, заданный аргументом <strong>$filename</strong>, с FTP-сервера.

<comment>Param:</comment>
  <info>FTP\Connection</info>  <strong>$ftp</strong>       An <class>FTP\Connection</class> instance.
  <info>string</info>          <strong>$filename</strong>  Удаляемый файл.

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


id: ftp_exec
type: function
doc:
<comment>Description:</comment>
  Запрашивает выполнение команды на FTP-сервере
  
  Посылает команду SITE EXEC <strong>$command</strong> на FTP-сервер.

<comment>Param:</comment>
  <info>FTP\Connection</info>  <strong>$ftp</strong>      An <class>FTP\Connection</class> instance.
  <info>string</info>          <strong>$command</strong>  Команда для выполнения.

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

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


id: ftp_fget
type: function
doc:
<comment>Description:</comment>
  Скачивает файл с FTP-сервера и сохраняет его в предварительно открытом файле
  
  <strong>ftp_fget()</strong> загружает файл <strong>$remote_filename</strong> с FTP-сервера и записывает его в переданный файловый
  дескриптор.

<comment>Param:</comment>
  <info>FTP\Connection</info>  <strong>$ftp</strong>              An <class>FTP\Connection</class> instance.
  <info>resource</info>        <strong>$stream</strong>           Открытый файловый дескриптор, в который будут сохранены данные.
  <info>string</info>          <strong>$remote_filename</strong>  Путь к удалённому файлу.
  <info>int</info>             <strong>$mode</strong>             Режим передачи. Должен быть либо <info>FTP_ASCII</info>, либо <info>FTP_BINARY</info>.
  <info>int</info>             <strong>$offset</strong>           Позиция начала загрузки в удалённом файле.

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

<comment>See Also:</comment>
   * <strong>ftp_get()</strong>
   * <strong>ftp_nb_get()</strong>
   * <strong>ftp_nb_fget()</strong>


id: ftp_fput
type: function
doc:
<comment>Description:</comment>
  Загружает предварительно открытый файл на FTP-сервер
  
  <strong>ftp_fput()</strong> загружает данные из файлового дескриптора в удалённый файл на FTP-сервере.

<comment>Param:</comment>
  <info>FTP\Connection</info>  <strong>$ftp</strong>              An <class>FTP\Connection</class> instance.
  <info>string</info>          <strong>$remote_filename</strong>  Путь к удалённому файлу.
  <info>resource</info>        <strong>$stream</strong>           Открытый файловый дескриптор локального файла. Чтение
                                    прекращается при достижении конца файла.
  <info>int</info>             <strong>$mode</strong>             Режим передачи. Должен быть либо <info>FTP_ASCII</info>, либо <info>FTP_BINARY</info>.
  <info>int</info>             <strong>$offset</strong>           Позиция начала загрузки в удалённом файле.

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

<comment>See Also:</comment>
   * <strong>ftp_put()</strong>
   * <strong>ftp_nb_fput()</strong>
   * <strong>ftp_nb_put()</strong>


id: ftp_get
type: function
doc:
<comment>Description:</comment>
  Скачивает файл с FTP-сервера
  
  <strong>ftp_get()</strong> загружает удалённый файл с FTP-сервера и сохраняет его локально.

<comment>Param:</comment>
  <info>FTP\Connection</info>  <strong>$ftp</strong>              An <class>FTP\Connection</class> instance.
  <info>string</info>          <strong>$local_filename</strong>   Путь к локальному файлу (файл будет перезаписан, если уже
                                    существует).
  <info>string</info>          <strong>$remote_filename</strong>  Путь к удалённому файлу.
  <info>int</info>             <strong>$mode</strong>             Режим передачи. Должен быть либо <info>FTP_ASCII</info>, либо <info>FTP_BINARY</info>.
  <info>int</info>             <strong>$offset</strong>           Позиция начала загрузки в удалённом файле.

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

<comment>See Also:</comment>
   * <strong>ftp_pasv()</strong>
   * <strong>ftp_fget()</strong>
   * <strong>ftp_nb_get()</strong>
   * <strong>ftp_nb_fget()</strong>


id: ftp_get_option
type: function
doc:
<comment>Description:</comment>
  Получает текущие параметры FTP-соединения
  
  Эта функция возвращает значение запрошенной опции <strong>$option</strong> для указанного FTP-соединения.

<comment>Param:</comment>
  <info>FTP\Connection</info>  <strong>$ftp</strong>     An <class>FTP\Connection</class> instance.
  <info>int</info>             <strong>$option</strong>  На текущий момент, поддерживаются следующие опции: Поддерживаемые текущие
                           опции FTP<info>FTP_TIMEOUT_SEC</info> Возвращает текущее время ожидания, используемое
                           в сетевых операциях. <info>FTP_AUTOSEEK</info> Возвращает <info>true</info>, если эта опция
                           включена, иначе <info>false</info>.

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

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


id: ftp_login
type: function
doc:
<comment>Description:</comment>
  Выполняет вход на FTP-сервер
  
  Выполняет вход на FTP сервер.

<comment>Param:</comment>
  <info>FTP\Connection</info>  <strong>$ftp</strong>       An <class>FTP\Connection</class> instance.
  <info>string</info>          <strong>$username</strong>  Имя пользователя (<return>USER</return>).
  <info>string</info>          <strong>$password</strong>  Пароль (<return>PASS</return>).

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


id: ftp_mdtm
type: function
doc:
<comment>Description:</comment>
  Возвращает время последней модификации файла
  
  <strong>ftp_mdtm()</strong> возвращает время последней модификации удалённого файла.
  
  Не все серверы поддерживают эту функцию!
  
  <strong>ftp_mdtm()</strong> не работает с директориями.

<comment>Param:</comment>
  <info>FTP\Connection</info>  <strong>$ftp</strong>       An <class>FTP\Connection</class> instance.
  <info>string</info>          <strong>$filename</strong>  Файл, время модификации которого надо получить.

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


id: ftp_mkdir
type: function
doc:
<comment>Description:</comment>
  Создаёт директорию
  
  Создаёт директорию <strong>$directory</strong> на FTP-сервере.

<comment>Param:</comment>
  <info>FTP\Connection</info>  <strong>$ftp</strong>        An <class>FTP\Connection</class> instance.
  <info>string</info>          <strong>$directory</strong>  Имя создаваемой директории.

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

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


id: ftp_mlsd
type: function
doc:
<comment>Description:</comment>
  Возвращает список файлов в заданной директории

<comment>Param:</comment>
  <info>FTP\Connection</info>  <strong>$ftp</strong>        An <class>FTP\Connection</class> instance.
  <info>string</info>          <strong>$directory</strong>  Директория, список файлов которой будет возвращён.

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

<comment>See Also:</comment>
   * <strong>ftp_rawlist()</strong>
   * <strong>ftp_nlist()</strong>


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

<comment>Param:</comment>
  <info>FTP\Connection</info>  <strong>$ftp</strong>  An <class>FTP\Connection</class> instance.

<comment>Return:</comment>
  <info>int</info>  Возвращает <info>FTP_FAILED</info>, <info>FTP_FINISHED</info> или <info>FTP_MOREDATA</info>.


id: ftp_nb_fget
type: function
doc:
<comment>Description:</comment>
  Скачивает файл с FTP-сервера в асинхронном режиме и сохраняет его в предварительно открытом файле
  
  <strong>ftp_nb_fget()</strong> скачивает удалённый файл с FTP-сервера.
  
  Разница между этой функцией и <strong>ftp_fget()</strong> заключается в том, что эта функция получает файл
  асинхронно, так что ваша программа может совершать другие операции, пока файл скачивается.

<comment>Param:</comment>
  <info>FTP\Connection</info>  <strong>$ftp</strong>              An <class>FTP\Connection</class> instance.
  <info>resource</info>        <strong>$stream</strong>           Открытый файловый дескриптор для сохранения данных.
  <info>string</info>          <strong>$remote_filename</strong>  Путь к удалённому файлу.
  <info>int</info>             <strong>$mode</strong>             Режим передачи. Должен быть либо <info>FTP_ASCII</info>, либо <info>FTP_BINARY</info>.
  <info>int</info>             <strong>$offset</strong>           Позиция начала загрузки в удалённом файле.

<comment>Return:</comment>
  <info>int</info>  Возвращает <info>FTP_FAILED</info>, <info>FTP_FINISHED</info> или <info>FTP_MOREDATA</info>.

<comment>See Also:</comment>
   * <strong>ftp_nb_get()</strong>
   * <strong>ftp_nb_continue()</strong>
   * <strong>ftp_fget()</strong>
   * <strong>ftp_get()</strong>


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

<comment>Param:</comment>
  <info>FTP\Connection</info>  <strong>$ftp</strong>              An <class>FTP\Connection</class> instance.
  <info>string</info>          <strong>$remote_filename</strong>  Путь к удалённому файлу.
  <info>resource</info>        <strong>$stream</strong>           Открытый файловый дескриптор локального файла. Чтение
                                    прекращается при достижении конца файла.
  <info>int</info>             <strong>$mode</strong>             Режим передачи. Должен быть либо <info>FTP_ASCII</info>, либо <info>FTP_BINARY</info>.
  <info>int</info>             <strong>$offset</strong>           Позиция начала загрузки в удалённом файле.

<comment>Return:</comment>
  <info>int</info>  Возвращает <info>FTP_FAILED</info>, <info>FTP_FINISHED</info> или <info>FTP_MOREDATA</info>.

<comment>See Also:</comment>
   * <strong>ftp_nb_put()</strong>
   * <strong>ftp_nb_continue()</strong>
   * <strong>ftp_put()</strong>
   * <strong>ftp_fput()</strong>


id: ftp_nb_get
type: function
doc:
<comment>Description:</comment>
  Скачивает файл с FTP-сервера в асинхронном режиме и сохраняет его в локальный файл
  
  <strong>ftp_nb_get()</strong> скачивает удалённый файл с FTP-сервера и сохраняет его в локальный файл.
  
  Разница между этой функцией и <strong>ftp_get()</strong> заключается в том, что эта функция получает файл
  асинхронно, так что ваша программа может совершать другие операции, пока файл скачивается.

<comment>Param:</comment>
  <info>FTP\Connection</info>  <strong>$ftp</strong>              An <class>FTP\Connection</class> instance.
  <info>string</info>          <strong>$local_filename</strong>   Путь к локальному файлу (файл будет перезаписан, если уже
                                    существует).
  <info>string</info>          <strong>$remote_filename</strong>  Путь к удалённому файлу.
  <info>int</info>             <strong>$mode</strong>             Режим передачи. Должен быть либо <info>FTP_ASCII</info>, либо <info>FTP_BINARY</info>.
  <info>int</info>             <strong>$offset</strong>           Позиция начала загрузки в удалённом файле.

<comment>Return:</comment>
  <info>int|false</info>  Возвращает <info>FTP_FAILED</info>, <info>FTP_FINISHED</info> или <info>FTP_MOREDATA</info> или <info>false</info> в случае, если
             невозможно открыть локальный файл.

<comment>See Also:</comment>
   * <strong>ftp_nb_fget()</strong>
   * <strong>ftp_nb_continue()</strong>
   * <strong>ftp_fget()</strong>
   * <strong>ftp_get()</strong>


id: ftp_nb_put
type: function
doc:
<comment>Description:</comment>
  Загружает файл на FTP-сервер в асинхронном режиме
  
  <strong>ftp_nb_put()</strong> загружает локальный файл на FTP-сервер.
  
  Отличие этой функции от <strong>ftp_put()</strong> состоит в том, что загрузка файла происходит в асинхронном
  режиме, что позволяет программе выполнять другие операции во время загрузки.

<comment>Param:</comment>
  <info>FTP\Connection</info>  <strong>$ftp</strong>              An <class>FTP\Connection</class> instance.
  <info>string</info>          <strong>$remote_filename</strong>  Путь к файлу на сервере.
  <info></info>                <strong>$local_file</strong>       Путь к локальному файлу.
  <info>int</info>             <strong>$mode</strong>             Режим передачи. Может принимать значения <info>FTP_ASCII</info> или
                                    <info>FTP_BINARY</info>.
  <info>int</info>             <strong>$offset</strong>           Позиция в удалённом файле, в которую начинается загрузка

<comment>Return:</comment>
  <info>int|false</info>  Возвращает <info>FTP_FAILED</info>, <info>FTP_FINISHED</info> или <info>FTP_MOREDATA</info> или <info>false</info> в случае невозможности
             открыть локальный файл.

<comment>See Also:</comment>
   * <strong>ftp_nb_fput()</strong>
   * <strong>ftp_nb_continue()</strong>
   * <strong>ftp_put()</strong>
   * <strong>ftp_fput()</strong>


id: ftp_nlist
type: function
doc:
<comment>Description:</comment>
  Возвращает список файлов в заданной директории

<comment>Param:</comment>
  <info>FTP\Connection</info>  <strong>$ftp</strong>        An <class>FTP\Connection</class> instance.
  <info>string</info>          <strong>$directory</strong>  Имя директории для получения списка файлов. Этот параметр также может
                              включать аргументы, например <return>ftp_nlist($conn_id, "-la /your/dir");</return>.
                              Обратите внимание, что этот параметр не проходит экранирование
                              спецсимволов, так что могут возникнуть проблемы с именами, содержащими
                              пробелы и прочие подобные символы.

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

<comment>See Also:</comment>
   * <strong>ftp_rawlist()</strong>
   * <strong>ftp_mlsd()</strong>


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

<comment>Param:</comment>
  <info>FTP\Connection</info>  <strong>$ftp</strong>     An <class>FTP\Connection</class> instance.
  <info>bool</info>            <strong>$enable</strong>  Если <info>true</info>, пассивный режим будет включён, иначе выключен.

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


id: ftp_put
type: function
doc:
<comment>Description:</comment>
  Загружает файл на FTP-сервер
  
  <strong>ftp_put()</strong> загружает локальный файл на FTP-сервер.

<comment>Param:</comment>
  <info>FTP\Connection</info>  <strong>$ftp</strong>              An <class>FTP\Connection</class> instance.
  <info>string</info>          <strong>$remote_filename</strong>  Путь к файлу на FTP-сервере.
  <info>string</info>          <strong>$local_filename</strong>   Путь к локальному файлу.
  <info>int</info>             <strong>$mode</strong>             Задаёт режим передачи. Может принимать значения <info>FTP_ASCII</info> или
                                    <info>FTP_BINARY</info>.
  <info>int</info>             <strong>$offset</strong>           Задаёт позицию в удалённом файле, в которую начнётся загрузка

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

<comment>See Also:</comment>
   * <strong>ftp_pasv()</strong>
   * <strong>ftp_fput()</strong>
   * <strong>ftp_nb_fput()</strong>
   * <strong>ftp_nb_put()</strong>


id: ftp_pwd
type: function
doc:
<comment>Description:</comment>
  Возвращает имя текущей директории

<comment>Param:</comment>
  <info>FTP\Connection</info>  <strong>$ftp</strong>  An <class>FTP\Connection</class> instance.

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

<comment>See Also:</comment>
   * <strong>ftp_chdir()</strong>
   * <strong>ftp_cdup()</strong>


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


id: ftp_raw
type: function
doc:
<comment>Description:</comment>
  Отправляет произвольную команду FTP-серверу
  
  Отправляет произвольную команду <strong>$command</strong> FTP-серверу.

<comment>Param:</comment>
  <info>FTP\Connection</info>  <strong>$ftp</strong>      An <class>FTP\Connection</class> instance.
  <info>string</info>          <strong>$command</strong>  Команда.

<comment>Return:</comment>
  <info>array|null</info>  Возвращает ответ сервера в виде массива строк или <info>null</info> в случае возникновения ошибки.
              Функция <strong>ftp_raw()</strong> не интерпретирует ответ сервера и не определяет, успешно ли
              выполнена команда.

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


id: ftp_rawlist
type: function
doc:
<comment>Description:</comment>
  Возвращает подробный список файлов в заданной директории
  
  <strong>ftp_rawlist()</strong> отправляет FTP-серверу команду LIST и возвращает результат в виде массива.

<comment>Param:</comment>
  <info>FTP\Connection</info>  <strong>$ftp</strong>        An <class>FTP\Connection</class> instance.
  <info>string</info>          <strong>$directory</strong>  Имя директории на сервере. Может включать аргументы для команды LIST.
  <info>bool</info>            <strong>$recursive</strong>  Если передано значение <info>true</info>, серверу будет отправлена команда LIST -R.

<comment>Return:</comment>
  <info>array|false</info>  Возвращает массив, каждый элемент которого содержит одну строку ответа сервера.
               Возвращает <info>false</info>, если переданная директория <strong>$directory</strong> не валидна.
               
               Ответ сервера никак не обрабатывается. Для определения того, как следует
               интерпретировать результат, можно использовать результат работы функции
               <strong>ftp_systype()</strong>.

<comment>See Also:</comment>
   * <strong>ftp_nlist()</strong>
   * <strong>ftp_mlsd()</strong>


id: ftp_rename
type: function
doc:
<comment>Description:</comment>
  Переименовывает файл или директорию на FTP-сервере
  
  <strong>ftp_rename()</strong> переименовывает файл или директорию на FTP-сервере.

<comment>Param:</comment>
  <info>FTP\Connection</info>  <strong>$ftp</strong>   An <class>FTP\Connection</class> instance.
  <info>string</info>          <strong>$from</strong>  Старое имя файла/директории.
  <info>string</info>          <strong>$to</strong>    Новое имя.

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


id: ftp_rmdir
type: function
doc:
<comment>Description:</comment>
  Удаляет директорию
  
  Удаляет директорию <strong>$directory</strong>.

<comment>Param:</comment>
  <info>FTP\Connection</info>  <strong>$ftp</strong>        An <class>FTP\Connection</class> instance.
  <info>string</info>          <strong>$directory</strong>  Имя директории. Параметр должен содержать относительный или абсолютный
                              путь к пустой директории.

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

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


id: ftp_set_option
type: function
doc:
<comment>Description:</comment>
  Устанавливает параметры соединения с FTP-сервером
  
  Эта функция устанавливает параметры соединения с FTP-сервером.

<comment>Param:</comment>
  <info>FTP\Connection</info>  <strong>$ftp</strong>     An <class>FTP\Connection</class> instance.
  <info>int</info>             <strong>$option</strong>  В настоящее время поддерживаются следующие параметры: Поддерживаемые
                           параметры<info>FTP_TIMEOUT_SEC</info> Устанавливает время ожидания сетевых операций, в
                           секундах. Аргумент <strong>$value</strong> должен быть целым, больше 0. По умолчанию время
                           ожидания равно 90 секундам. <info>FTP_AUTOSEEK</info>При установке этого параметра
                           перед выполнением запросов GET или PUT с параметром <strong>$resumepos</strong> или
                           <strong>$startpos</strong> указатель файла будет установлен на запрошенную позицию. Этот
                           параметр установлен по умолчанию. <info>FTP_USEPASVADDRESS</info> Если отключено, то
                           PHP  будет игнорировать IP-адрес, возвращённый сервером в ответ на
                           команду PASV и вместо него будет использовать IP-адрес, переданный в
                           ftp_connect(). Параметр <strong>$value</strong> должен содержать логическое значение.
  <info>int|bool</info>        <strong>$value</strong>   Назначение этого аргумента зависит от значения параметра <strong>$option</strong>.

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

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


id: ftp_site
type: function
doc:
<comment>Description:</comment>
  Отправляет серверу команду SITE
  
  <strong>ftp_site()</strong> отправляет указанную команду <return>SITE</return> FTP-серверу.
  
  Команды <return>SITE</return> не стандартизированы и зависят от FTP-сервера. Они могут быть полезны для изменения
  прав доступа к файлам или смены владельца или группы.

<comment>Param:</comment>
  <info>FTP\Connection</info>  <strong>$ftp</strong>      An <class>FTP\Connection</class> instance.
  <info>string</info>          <strong>$command</strong>  Команда SITE. Обратите внимание, что этот параметр не проходит
                            экранирование спецсимволов, так что могут возникнуть проблемы с именами,
                            содержащими пробелы и прочие подобные символы.

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

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


id: ftp_size
type: function
doc:
<comment>Description:</comment>
  Возвращает размер указанного файла
  
  <strong>ftp_size()</strong> возвращает размер заданного файла в байтах.
  
  Не все FTP-серверы поддерживают эту возможность.

<comment>Param:</comment>
  <info>FTP\Connection</info>  <strong>$ftp</strong>       An <class>FTP\Connection</class> instance.
  <info>string</info>          <strong>$filename</strong>  Имя файла на сервере.

<comment>Return:</comment>
  <info>int</info>  Возвращает размер файла или -1 при возникновении ошибки.

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


id: ftp_ssl_connect
type: function
doc:
<comment>Description:</comment>
  Устанавливает соединение с FTP-сервером через SSL
  
  <strong>ftp_ssl_connect()</strong> устанавливает явное SSL соединение с FTP-сервером, заданным аргументом
  <strong>$hostname</strong>. Это означает, что <strong>ftp_ssl_connect()</strong> будет успешным даже если сервер не
     настроен для SSL-FTP, или его сертификат недействителен. Только когда будет вызвана функция
  <strong>ftp_login()</strong>, клиент пошлёт необходимую команду AUTH FTP, так что в указанных случаях <strong>ftp_login()</strong>
  завершится ошибкой.
  
  До PHP 7.0.0 <strong>ftp_ssl_connect()</strong> была доступна только если PHP был собран с поддержкой OpenSSL; это
  означает, что в Windows эта функция не была определена в официальных сборках PHP. Чтобы
  использовать эту функцию под Windows, вам придётся собрать PHP самостоятельно для включения
  поддержки OpenSSL.
  
  <strong>ftp_ssl_connect()</strong> не предназначена для использования по протоколу sFTP. Для использования sFTP из
  PHP смотрите функцию <strong>ssh2_sftp()</strong>.

<comment>Param:</comment>
  <info>string</info>  <strong>$hostname</strong>  Адрес FTP-сервера. Этот параметр не должен содержать слеши в конце и префикс
                     <return>ftp://</return> в начале.
  <info>int</info>     <strong>$port</strong>      Задаёт порт, на котором устанавливается соединение. Если равен нулю или опущен,
                     по умолчанию используется стандартный для протокола FTP - порт 21.
  <info>int</info>     <strong>$timeout</strong>   Задаёт время ожидания для всех операций с этим соединением. По умолчанию время
                     ожидания устанавливается в 90 секунд. Получить и установить значение времени
                     ожидания можно также с помощью функций <strong>ftp_set_option()</strong> и <strong>ftp_get_option()</strong>.

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

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


id: ftp_systype
type: function
doc:
<comment>Description:</comment>
  Возвращает тип операционной системы FTP-сервера
  
  Возвращает тип операционной системы FTP-сервера.

<comment>Param:</comment>
  <info>FTP\Connection</info>  <strong>$ftp</strong>  An <class>FTP\Connection</class> instance.

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


id: ftruncate
type: function
doc:
<comment>Description:</comment>
  Урезает файл до указанной длины
  
  Принимает файловый указатель <strong>$stream</strong> и урезает соответствующий файл до размера <strong>$size</strong>.

<comment>Param:</comment>
  <info>resource</info>  <strong>$stream</strong>  Файловый указатель.
                     
                     <strong>$stream</strong> должен быть открыт для записи.
  <info>int</info>       <strong>$size</strong>    Размер файла, до которого он будет обрезан.
                     
                     Если <strong>$size</strong> больше текущего размера файла, то файл будет дополнен нулевыми
                     байтами.
                     
                     Если <strong>$size</strong> меньше текущего размера файла, то файл будет обрезан до этого
                     размера.

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

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


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

<comment>Param:</comment>
  <info>int</info>  <strong>$position</strong>  Номер аргумента. Аргументы функции считаются с нуля.

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

<comment>See Also:</comment>
   * Синтаксис <return>...</return>
   * <strong>func_get_args()</strong>
   * <strong>func_num_args()</strong>


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

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

<comment>See Also:</comment>
   * Синтаксис <return>...</return>
   * <strong>func_get_arg()</strong>
   * <strong>func_num_args()</strong>
   * ReflectionFunctionAbstract::getParameters


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

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

<comment>See Also:</comment>
   * Синтаксис <return>...</return>
   * <strong>func_get_arg()</strong>
   * <strong>func_get_args()</strong>
   * ReflectionFunctionAbstract::getNumberOfParameters


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

<comment>Param:</comment>
  <info>string</info>  <strong>$function</strong>  Имя функции в виде строки.

<comment>Return:</comment>
  <info>bool</info>  Возвращает <info>true</info>, если <strong>$function</strong> существует и является функцией, иначе возвращается <info>false</info>.
        
        Эта функция возвращает <info>false</info> для языковых конструкций, таких как <strong>include_once()</strong> или <strong>echo()</strong>.

<comment>See Also:</comment>
   * <strong>method_exists()</strong>
   * <strong>is_callable()</strong>
   * <strong>get_defined_functions()</strong>
   * <strong>class_exists()</strong>
   * <strong>extension_loaded()</strong>


id: fwrite
type: function
doc:
<comment>Description:</comment>
  Бинарно-безопасная запись в файл
  
  <strong>fwrite()</strong> записывает содержимое <strong>$data</strong> в файловый поток <strong>$stream</strong>.

<comment>Param:</comment>
  <info>resource</info>  <strong>$stream</strong>  Указатель (<info>resource</info>)
                     на файл, обычно создаваемый с помощью функции <strong>fopen()</strong>.
  <info>string</info>    <strong>$data</strong>    Записываемая строка.
  <info>int|null</info>  <strong>$length</strong>  Если параметр <strong>$length</strong> является целым числом (<info>int</info>), запись остановится после
                     того, как <strong>$length</strong> байтов будут записаны или будет достигнут конец строки <strong>$data</strong>,
                     смотря что произойдёт раньше.

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

<comment>See Also:</comment>
   * <strong>fread()</strong>
   * <strong>fopen()</strong>
   * <strong>fsockopen()</strong>
   * <strong>popen()</strong>
   * <strong>file_get_contents()</strong>
   * <strong>pack()</strong>


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

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

<comment>See Also:</comment>
   * Сборка мусора


id: gc_disable
type: function
doc:
<comment>Description:</comment>
  Отключает сборщик циклических ссылок
  
  Отключает сборщик циклических ссылок, путём установки значения zend.enable_gc в <return>0</return>.

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

<comment>See Also:</comment>
   * Сборка мусора


id: gc_enable
type: function
doc:
<comment>Description:</comment>
  Включает сборщик циклических ссылок
    
  
  Включает сборщик циклических ссылок, устанавливая zend.enable_gc в <return>1</return>.

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

<comment>See Also:</comment>
   * Сборка мусора


id: gc_enabled
type: function
doc:
<comment>Description:</comment>
  Возвращает текущее состояние сборщика циклических ссылок
    
  
  Возвращает текущее состояние сборщика циклических ссылок.

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

<comment>See Also:</comment>
   * Сборка мусора


id: gc_mem_caches
type: function
doc:
<comment>Description:</comment>
  Освобождает память, используемую менеджером памяти Zend Engine
    
  
  Освобождает память, используемую менеджером памяти Zend Engine.

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

<comment>See Also:</comment>
   * Сборка мусора


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

<comment>Return:</comment>
  <info>array</info>  Возвращает ассоциативный массив со следующими элементами:
         <return>"runs"</return><return>"collected"</return><return>"threshold"</return><return>"roots"</return>
         
         <return>"runs"</return>
         
         <return>"collected"</return>
         
         <return>"threshold"</return>
         
         <return>"roots"</return>

<comment>See Also:</comment>
   * Сбор мусора


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

<comment>Return:</comment>
  <info>array</info>  Возвращает ассоциативный массив.
         
         Элементы массива, возвращаемого из <strong>gd_info()</strong>АтрибутСмысловое значениеGD VersionСтрока
         (<info>string</info>), содержащая версию <return>libgd</return>. FreeType Support<info>bool</info> значение. <info>true</info>, если компонент
         FreeType Support установлен.FreeType LinkageСтрока (<info>string</info>), содержащая описание, каким
         образом подключён компонент FreeType. Ожидаемые значения: 'with freetype', 'with TTF
         library', и 'with unknown library'. Этот элемент будет определён, только если <return>FreeType
         Support</return> имеет значение <info>true</info>.GIF Read Support<info>bool</info> значение. <info>true</info>, если включена поддержка
         чтения (reading) <return>GIF</return> изображений. GIF Create Support<info>bool</info> значение. <info>true</info>, если включена
         поддержка записи (creating) <return>GIF</return> изображений. JPEG Support<info>bool</info> значение. <info>true</info>, если включена
         поддержка <return>JPEG</return>. PNG Support<info>bool</info> значение. <info>true</info>, если включена поддержка <return>PNG</return>. WBMP
         Support<info>bool</info> значение. <info>true</info>, если включена поддержка <return>WBMP</return>. XBM Support<info>bool</info> значение. <info>true</info>,
         если включена поддержка <return>XBM</return>. WebP Support<info>bool</info> значение. <info>true</info>, если включена поддержка <return>WebP</return>.
         AVIF Support<info>bool</info> значение. <info>true</info>, если включена поддержка <return>AVIF</return>. Доступно, начиная с PHP
         8.1.0.

<comment>See Also:</comment>
   * <strong>imagepng()</strong>
   * <strong>imagejpeg()</strong>
   * <strong>imagegif()</strong>
   * <strong>imagewbmp()</strong>
   * <strong>imagewebp()</strong>
   * <strong>imageavif()</strong>
   * <strong>imagetypes()</strong>


id: geoip_asnum_by_name
type: function
doc:
<comment>Description:</comment>
  Получить номер автономной системы (ASN)
  
  Функция <strong>geoip_asnum_by_name()</strong> возвращает номера автономной системы, связанные с IP-адресом.

<comment>Param:</comment>
  <info>string</info>  <strong>$hostname</strong>  Имя хоста или IP-адрес.

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


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

<comment>Param:</comment>
  <info>string</info>  <strong>$hostname</strong>  Имя хоста или IP-адрес, по которому будет вестись поиск.

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

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


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

<comment>Param:</comment>
  <info>string</info>  <strong>$hostname</strong>  Имя хоста или IP-адрес, по которому будет вестись поиск.

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

<comment>See Also:</comment>
   * <strong>geoip_country_code_by_name()</strong>
   * <strong>geoip_country_name_by_name()</strong>


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

<comment>Param:</comment>
  <info>string</info>  <strong>$hostname</strong>  Имя хоста или IP-адрес, по которому будет вестись поиск.

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

<comment>See Also:</comment>
   * <strong>geoip_country_code3_by_name()</strong>
   * <strong>geoip_country_name_by_name()</strong>


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

<comment>Param:</comment>
  <info>string</info>  <strong>$hostname</strong>  Имя хоста или IP-адрес, по которому будет вестись поиск.

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

<comment>See Also:</comment>
   * <strong>geoip_country_code_by_name()</strong>
   * <strong>geoip_country_code3_by_name()</strong>


id: geoip_database_info
type: function
doc:
<comment>Description:</comment>
  Возвращает информацию о базе GeoIP
  
  Функция <strong>geoip_database_info()</strong> возвращает версию базы GeoIP, соответствующую определению в бинарном
  файле.
  
  Эта функция вызывается без параметров и возвращает версию базы GeoIP Free Country Edition.

<comment>Param:</comment>
  <info>int</info>  <strong>$database</strong>  Тип базы определяется целым числом (integer). Вы можете использовать разнообразные
                  константы, определённые в этом модуле (т.е.: GEOIP_*_EDITION).

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


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

<comment>Param:</comment>
  <info>int</info>  <strong>$database</strong>  Тип базы данных определяется целым числом (integer). Вы можете использовать
                  различные константы, определённые в этом модуле (ie: GEOIP_*_EDITION).

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


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

<comment>Param:</comment>
  <info>int</info>  <strong>$database</strong>  Тип базы определяется целым числом (integer). Вы можете использовать разнообразные
                  константы, определённые в этом модуле (т.е.: GEOIP_*_EDITION).

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


id: geoip_db_get_all_info
type: function
doc:
<comment>Description:</comment>
  Возвращает подробную информацию обо всех типах базы GeoIP
  
  Функция <strong>geoip_db_get_all_info()</strong> возвращает подробную информацию обо всех типах базы GeoIP в виде
  многомерного массива.
  
  Эта функция доступна даже при отсутствии установленных базы данных. При этом типы будут
  перечислены и отмечены как недоступные.
  
  Имена различных ключей возвращаемого ассоциативного массива:
  
   "available" -- Логический тип, указывает доступна ли база (смотрите <strong>geoip_db_avail()</strong>)
  "description" -- Описание базы данных  "filename" -- Имя файла базы данных на диске (смотрите
  <strong>geoip_db_filename()</strong>)
  
  "available" -- Логический тип, указывает доступна ли база (смотрите <strong>geoip_db_avail()</strong>)
  
  "description" -- Описание базы данных
  
  "filename" -- Имя файла базы данных на диске (смотрите <strong>geoip_db_filename()</strong>)

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


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

<comment>Param:</comment>
  <info>string</info>  <strong>$hostname</strong>  Имя хоста или IP-адрес.

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


id: geoip_id_by_name
type: function
doc:
<comment>Description:</comment>
  Возвращает тип интернет-соединения
  
  Функция <strong>geoip_id_by_name()</strong> возвращает тип Интернет соединения соответствующего имени хоста или
  IP-адреса.
  
  Возвращает числовое значение, которое можно сравнить с константами:
  
   GEOIP_UNKNOWN_SPEED  GEOIP_DIALUP_SPEED  GEOIP_CABLEDSL_SPEED  GEOIP_CORPORATE_SPEED 
  
  GEOIP_UNKNOWN_SPEED
  
  GEOIP_DIALUP_SPEED
  
  GEOIP_CABLEDSL_SPEED
  
  GEOIP_CORPORATE_SPEED

<comment>Param:</comment>
  <info>string</info>  <strong>$hostname</strong>  Имя хоста или IP-адрес, соединение с которыми проверяется.

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


id: geoip_isp_by_name
type: function
doc:
<comment>Description:</comment>
  Возвращает имя интернет-провайдера (ISP)
  
  Функция <strong>geoip_isp_by_name()</strong> возвращает имя интернет-провайдера (ISP) указанного IP-адреса.
  
  Эта функция доступна только для тех, кто приобрёл коммерческую версию GeoIP ISP. Если такая база
  отсутствует, выводится предупреждение.

<comment>Param:</comment>
  <info>string</info>  <strong>$hostname</strong>  Имя хоста или IP-адрес.

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


id: geoip_netspeedcell_by_name
type: function
doc:
<comment>Description:</comment>
  Получить скорость соединения с сетью Интернет
  
  Функция <strong>geoip_netspeedcell_by_name()</strong> возвращает тип подключения к сети Интернет и его скорость
  относительно заданного имени хоста или IP-адреса.
  
  Эта функция доступна, только если используется библиотека GeoIP версии 1.4.8 и выше.
  
  Сейчас эта функция доступна только пользователям, купившим коммерческую версию GeoIP Domain
  Edition. В случае если корректная база данных не будет найдена, будет выведено предупреждение.
  
  Возвращается строка. Стандартные значения:
  
   Cable/DSL  Dialup  Cellular  Corporate 
  
  Cable/DSL
  
  Dialup
  
  Cellular
  
  Corporate

<comment>Param:</comment>
  <info>string</info>  <strong>$hostname</strong>  Имя хоста или IP-адрес.

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


id: geoip_org_by_name
type: function
doc:
<comment>Description:</comment>
  Возвращает название организации, владеющей IP-адресом
  
  Функция <strong>geoip_org_by_name()</strong> возвращает название организации, которая владеет указанным IP-адресом.
  
  Эта функция доступна только для тех, кто приобрёл коммерческую версию GeoIP Organization, ISP или
  AS. Если такая база отсутствует, выводится предупреждение.

<comment>Param:</comment>
  <info>string</info>  <strong>$hostname</strong>  Имя хоста или IP-адрес.

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


id: geoip_record_by_name
type: function
doc:
<comment>Description:</comment>
  Возвращает подробную информацию об адресе, найденном в базе GeoIP
  
  Функция <strong>geoip_record_by_name()</strong> возвращает информацию об адресе, соответствующую имени хоста или IP
  адреса.
  
  Функция доступна для бесплатной версии GeoLite City Edition и коммерческой GeoIP City Edition.
  Если необходимые базы отсутствует, выводится предупреждение.
  
  Следующие имена ключей возвращаемого ассоциативного массива:
  
   "continent_code" -- Двухбуквенный код континента (с версии 1.0.4 с libgeoip 1.4.3 или более
  новой)  "country_code" -- Двухбуквенный код страны (смотрите <strong>geoip_country_code_by_name()</strong>)
  "country_code3" -- Трёхбуквенный код страны (смотрите <strong>geoip_country_code3_by_name()</strong>)
  "country_name" -- Название страны (смотрите <strong>geoip_country_name_by_name()</strong>)  "region" -- Код региона
  (например: CA для Калифорнии)  "city" -- Город.  "postal_code" -- Почтовый индекс, FSA или Zip-код
  "latitude" -- Широта, число с плавающей точкой (<info>float</info>) без знака.  "longitude" -- Долгота, число с
  плавающей точкой (<info>float</info>) без знака.  "dma_code" -- Код рыночной зоны (Designated Market Area,
  DMA), только для США и Канады  "area_code" -- Код телефонной сети общего пользования (PSTN),
  например, 212
  
  "continent_code" -- Двухбуквенный код континента (с версии 1.0.4 с libgeoip 1.4.3 или более новой)
  
  "country_code" -- Двухбуквенный код страны (смотрите <strong>geoip_country_code_by_name()</strong>)
  
  "country_code3" -- Трёхбуквенный код страны (смотрите <strong>geoip_country_code3_by_name()</strong>)
  
  "country_name" -- Название страны (смотрите <strong>geoip_country_name_by_name()</strong>)
  
  "region" -- Код региона (например: CA для Калифорнии)
  
  "city" -- Город.
  
  "postal_code" -- Почтовый индекс, FSA или Zip-код
  
  "latitude" -- Широта, число с плавающей точкой (<info>float</info>) без знака.
  
  "longitude" -- Долгота, число с плавающей точкой (<info>float</info>) без знака.
  
  "dma_code" -- Код рыночной зоны (Designated Market Area, DMA), только для США и Канады
  
  "area_code" -- Код телефонной сети общего пользования (PSTN), например, 212

<comment>Param:</comment>
  <info>string</info>  <strong>$hostname</strong>  Имя хоста или IP-адрес, данные по которому должны быть получены.

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


id: geoip_region_by_name
type: function
doc:
<comment>Description:</comment>
  Возвращает коды страны и региона
  
  Функция<strong>geoip_region_by_name()</strong> возвращает коды страны и региона, соответствующих имени хоста или
  IP-адресу.
  
  Эта функция доступна только для тех, кто приобрёл коммерческую версию GeoIP Region. Если такая
  база отсутствует, выводится предупреждение.
  
  Следующие имена ключей возвращаемого ассоциативного массива:
  
   "country_code" -- Двухбуквенный код страны (смотрите <strong>geoip_country_code_by_name()</strong>)  "region" --
  Код региона (например, CA для Калифорнии)
  
  "country_code" -- Двухбуквенный код страны (смотрите <strong>geoip_country_code_by_name()</strong>)
  
  "region" -- Код региона (например, CA для Калифорнии)

<comment>Param:</comment>
  <info>string</info>  <strong>$hostname</strong>  Имя хоста или IP-адрес, данные о стране и регионе, которого необходимо найти.

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


id: geoip_region_name_by_code
type: function
doc:
<comment>Description:</comment>
  Возвращает название региона для выбранной страны и кода региона
  
  Функция <strong>geoip_region_name_by_code()</strong> возвращает название региона, соответствующей страны и кода
  региона.
  
  В США код региона соответствует двухбуквенному сокращению каждому штату. В Канаде код региона
  соответствует двухбуквенному сокращению имени провинции или территории, присвоенный почтовой
  службой Канады.
  
  Для остального мира GeoIP использует коды FIPS 10-4 для представления региона. Смотрите также
  http://www.maxmind.com/app/fips10_4 -- детальный список кодов FIPS 10-4.
  
  Данная функция всегда доступна при использовании библиотеки GeoIP версии 1.4.1 и новее. Данные
  берутся непосредственно из библиотеки GeoIP, а не из какой-либо базы.

<comment>Param:</comment>
  <info>string</info>  <strong>$country_code</strong>  Двухбуквенный код страны <strong>geoip_country_code_by_name()</strong>)
  <info>string</info>  <strong>$region_code</strong>   Двухбуквенный (или цифровой) код региона <strong>geoip_region_by_name()</strong>)

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


id: geoip_setup_custom_directory
type: function
doc:
<comment>Description:</comment>
  Установить пользовательскую директорию для базы данных GeoIP
  
  Функция <strong>geoip_setup_custom_directory()</strong> изменяет директорию по умолчанию для базы данных GeoIP.
  Использование функции эквивалентно изменению geoip.custom_directory.

<comment>Param:</comment>
  <info>string</info>  <strong>$path</strong>  Полный путь до базы данных GeoIP.

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


id: geoip_time_zone_by_country_and_region
type: function
doc:
<comment>Description:</comment>
  Возвращает часовой пояс для кода страны и региона
  
  Функция <strong>geoip_time_zone_by_country_and_region()</strong> вернёт часовой пояс и код региона соответствующей
  страны.
  
  В США код региона соответствует двухбуквенному сокращению каждого штата. В Канаде код региона
  соответствует двухбуквенному сокращению провинции или территориальный код соответствующий
  канадской почте.
  
  Для остальной части мира, для представления регионов GeoIP использует коды FIPS 10-4. Вы можете
  просмотреть http://www.maxmind.com/app/fips10_4 для получения полного списка FIPS 10-4 кодов.
  
  Эта функция всегда доступна при использовании библиотеки GeoIP версии 1.4.1 или новее. Данные
  берутся непосредственно из библиотеки GeoIP, а не из какой-либо базы данных.

<comment>Param:</comment>
  <info>string</info>  <strong>$country_code</strong>  Двухбуквенный код страны (смотрите <strong>geoip_country_code_by_name()</strong>)
  <info>string</info>  <strong>$region_code</strong>   Двухбуквенный (или цифровой) код региона (смотрите <strong>geoip_region_by_name()</strong>)

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


id: getSession
type: function
doc:
<comment>Description:</comment>
  Подключается к серверу MySQL
  
  Подключается к серверу MySQL.

<comment>Param:</comment>
  <info>string</info>  <strong>$uri</strong>  URI к серверу MySQL, такой как <return>mysqlx://user:password@host</return>.
                
                Формат URI:
                
                scheme://[user[:[password]]@]target[:port][?attribute1=value1&attribute2=value2...
                
                <return>scheme</return>: обязательный, протокол соединения
                
                В mysql_xdevapi это всегда 'mysqlx' (для X Protocol)
                
                <return>user</return>: необязательный, учётная запись пользователя MySQL для аутентификации
                
                <return>password</return>: необязательный, пароль пользователя MySQL для аутентификации
                
                <return>target</return>: обязательный, экземпляр сервера, к которому относится соединение:
                
                * TCP-соединение (имя хоста, адрес IPv4 или адрес IPv6)
                
                * Путь к сокету Unix (локальный путь к файлу)
                
                * Именованный канал Windows (локальный путь к файлу)
                
                <return>port</return>: необязательный, сетевой порт сервера MySQL.
                
                по умолчанию порт для X Protocol равен 33060
                
                <return>?attribute=value</return>: этот элемент является необязательным и определяет словарь данных,
                который содержит различные параметры, в том числе:
                
                Атрибут <return>auth</return> (механизм аутентификации), поскольку он относится к зашифрованным
                соединениям. Для получения дополнительной информации смотрите Параметры команды для
                зашифрованных соединений. Поддерживаются следующие значения: <return>plain</return>, <return>mysql41</return>,
                <return>external</return>, и <return>sha256_mem</return>.
                
                Атрибут <return>connect-timeout</return> влияет на соединение, а не на последующие операции. Он
                устанавливается для каждого соединения на одном или нескольких хостах.
                
                Введите положительное целое число, чтобы определить время ожидания соединения в
                секундах, или введите 0 (ноль), чтобы отключить время ожидания (бесконечно). Не
                определяя время ожидания подключения, вы используется значение по умолчанию 10.
                
                Связанные, переменные среды MYSQLX_CONNECTION_TIMEOUT (время ожидания в секундах) и
                MYSQLX_TEST_CONNECTION_TIMEOUT (используемые во время выполнения тестов) могут быть
                установлены и использованы вместо connect-timeout соединения в URI. Параметр URI
                подключения к connect-timeout имеет приоритет над переменными среды.
                
                Необязательный атрибут <return>compression</return> принимает следующие значения: <return>preferred</return> (клиент
                договаривается с сервером, чтобы найти поддерживаемый алгоритм; соединение не сжато,
                если взаимно поддерживаемый алгоритм не найден), <return>required</return> (как "preferred", но
                соединение разрывается, если взаимно поддерживаемый алгоритм не найден),  или
                <return>disabled</return> (соединение не сжато). По умолчанию используется <return>preferred</return>.
                
                Опция была добавлена в версии 8.0.20.
                
                Необязательный атрибут <return>compression-algorithms</return> определяет желаемые алгоритмы сжатия
                (и их предпочтительный порядок использования): <return>zstd_stream</return>(псевдоним: zstd),
                <return>lz4_message</return> (псевдоним: lz4) или <return>deflate_stream</return> (псевдонимы: deflate или zlib). По
                умолчанию используется порядок (в зависимости от доступности системы): lz4_message,
                zstd_stream, затем deflate_stream. Например, при передаче
                compression-algorithms=[lz4, zstd_stream] используется lz4, если он доступен, в
                противном случае используется zstd_stream. Если оба недоступны, поведение зависит от
                значения сжатия, например, если compression=required, то произойдёт сбой с ошибкой.
                
                Опция была добавлена в версии 8.0.22.
                
                Для получения дополнительной информации смотрите MySQL Shell Подключение с
                использованием строки URI.

<comment>Return:</comment>
  <info>mysql_xdevapi\Session</info>  Объект <class>Session</class>.


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

<comment>Param:</comment>
  <info>string|null</info>  <strong>$user_agent</strong>    Анализируемая строка с User Agent. По умолчанию используется значение
                              HTTP User-Agent. Тем не менее, этот параметр можно пропустить для
                              получения дополнительной информации о браузере.
                              
                              Параметр может быть пропущен, если его значение будет равно <info>null</info>.
  <info>bool</info>         <strong>$return_array</strong>  Если равен <info>true</info>, то функция вернёт массив (<info>array</info>) вместо объекта
                              (<info>object</info>).

<comment>Return:</comment>
  <info>object|array|false</info>  Информация возвращается в виде объекта, либо в виде массива, который содержит
                      различные данные, к примеру, мажорную и минорную версию браузера и строку ID;
                      значения с <info>true</info>/<info>false</info> для таких функций браузера, таких как фреймы,
                      JavaScript, cookies и т.д.
                      
                      Наличие <return>cookies</return> означает, что браузер имеет возможность приёма cookies, а не
                      сообщает о том, включил ли пользователь возможность приёма cookies или нет.
                      Единственным способом проверки возможности браузера принимать cookies является
                      установка cookie с помощью <strong>setcookie()</strong>, обновление страницы и проверка
                      значения.
                      
                      Возвращает <info>false</info>, если невозможно получить информацию, например, когда
                      параметр конфигурации browscap в php.ini не был установлен.


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

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

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


id: get_cfg_var
type: function
doc:
<comment>Description:</comment>
  Извлекает значение настройки конфигурации PHP
    
  
  Извлекает значение настройки конфигурации PHP <strong>$option</strong>.
  
  Функция не вернёт никакой информации, заданной при сборке PHP или указанной в конфигурационном
  файле Apache.
  
  Чтобы проверить, что система использует файл конфигурации, попробуйте получить значение настройки
  конфигурации cfg_file_path. Если эта настройка доступна, значит используется файл конфигурации.

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

<comment>Return:</comment>
  <info>string|array|false</info>  Возвращает текущее значение настройки конфигурации PHP <strong>$option</strong> или <info>false</info> в
                      случае возникновения ошибки.

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


id: get_class
type: function
doc:
<comment>Description:</comment>
  Возвращает имя класса, к которому принадлежит объект
  
  Возвращает имя класса, экземпляром которого является объект <strong>$object</strong>.

<comment>Param:</comment>
  <info>object</info>  <strong>$object</strong>  Тестируемый объект. Внутри класса этот параметр может быть опущен.
                   
                   Начиная с PHP 7.2.0, явная передача <info>null</info> в <strong>$object</strong> запрещена и выдаёт ошибку
                   уровня <info>E_WARNING</info>. Начиная с PHP 8.0.0, при передаче <info>null</info>, выбрасывается
                   исключение <class>TypeError</class>.

<comment>Return:</comment>
  <info>string</info>  Возвращает имя класса, к которому принадлежит экземпляр <strong>$object</strong>.
          
          Если параметр <strong>$object</strong> опущен внутри класса, будет возвращено имя этого класса.
          
          Если параметр <strong>$object</strong> является экземпляром класса, существующего в пространстве имён, то
          будет возвращено полное имя с указанием пространства имён.

<comment>See Also:</comment>
   * <strong>get_called_class()</strong>
   * <strong>get_parent_class()</strong>
   * <strong>gettype()</strong>
   * <strong>get_debug_type()</strong>
   * <strong>is_subclass_of()</strong>


id: get_class_methods
type: function
doc:
<comment>Description:</comment>
  Возвращает массив имён методов класса
  
  Возвращает массив имён методов класса.

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

<comment>Return:</comment>
  <info>array</info>  Возвращает массив имён методов, объявленных в классе <strong>$object_or_class</strong>.

<comment>See Also:</comment>
   * <strong>get_class()</strong>
   * <strong>get_class_vars()</strong>
   * <strong>get_object_vars()</strong>


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

<comment>Param:</comment>
  <info>string</info>  <strong>$class</strong>  Имя класса

<comment>Return:</comment>
  <info>array</info>  Возвращает ассоциативный массив объявленных свойств класса, видимых из текущей области
         видимости, с их значением по умолчанию. Получившиеся элементы массива имеют форму <return>varname
         =&gt; value</return>. В случае возникновения ошибки возвращается <info>false</info>.

<comment>See Also:</comment>
   * <strong>get_class_methods()</strong>
   * <strong>get_object_vars()</strong>


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

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

<comment>See Also:</comment>
   * <strong>getmyuid()</strong>
   * <strong>getmygid()</strong>
   * <strong>getmypid()</strong>
   * <strong>getmyinode()</strong>
   * <strong>getlastmod()</strong>


id: get_debug_type
type: function
doc:
<comment>Description:</comment>
  Возвращает имя типа переменной в виде, подходящем для отладки
  
  Возвращает преобразованное имя переменной PHP <strong>$value</strong>. Функция преобразует объекты в имя их класса,
  ресурсы - в имя их типа ресурса, а скалярные значения - в общепринятое имя их типа, которое бы
  использовалось в объявлении типов.
  
  Функция отличается от <strong>gettype()</strong> тем, что возвращает имена типов, которые больше соответствуют
  фактическому использованию, а не те, которые присутствуют по историческим причинам.

<comment>Param:</comment>
  <info>mixed</info>  <strong>$value</strong>  Переменная, у которой проверяется тип.

<comment>Return:</comment>
  <info>string</info>  Возможные значения для возвращаемой строки:
           Тип + СостояниеВозвращаемое значениеЗамечанияnull<return>"null"</return>-Логические значения (true или
          false)<return>"bool"</return>-Целые числа<return>"int"</return>-Числа с плавающей
          точкой<return>"float"</return>-Строки<return>"string"</return>-Массивы<return>"array"</return>-Ресурсы<return>"resource (resourcename)"</return>-Ресурсы
          (закрытые)<return>"resource (closed)"</return>Пример: файловый поток после закрытия с помощью
          fclose.Объекты именованных классов Полное имя класса, включая его пространство имён,
          например, <return>Foo\Bar</return> -Объекты анонимных классов<return>"class@anonymous"</return> Анонимные классы - это
          классы, созданные с использованием синтаксиса $x = new class { ... }.

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


id: get_declared_classes
type: function
doc:
<comment>Description:</comment>
  Возвращает массив с именами объявленных классов
  
  Возвращает объявленные классы.

<comment>Return:</comment>
  <info>array</info>  Возвращает массив имён объявленных классов в текущем скрипте.
         
         Учтите также, что в зависимости от модулей, собранных или загруженных в PHP, может
         варьироваться число дополнительных классов. Это означает, что вы не сможете использовать
         собственные классы с данными именами. Список предопределённых классов находится в разделе
         дополнения "Предопределённые классы".

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


id: get_declared_interfaces
type: function
doc:
<comment>Description:</comment>
  Возвращает массив всех объявленных интерфейсов
  
  Возвращает объявленные интерфейсы.

<comment>Return:</comment>
  <info>array</info>  Возвращает массив имён всех объявленных интерфейсов в текущем скрипте.

<comment>See Also:</comment>
   * <strong>interface_exists()</strong>
   * <strong>get_declared_classes()</strong>
   * <strong>class_implements()</strong>


id: get_declared_traits
type: function
doc:
<comment>Description:</comment>
  Возвращает массив со всеми объявленными трейтами

<comment>Return:</comment>
  <info>array</info>  Возвращает массив с именами трейтов в качестве значений массива.

<comment>See Also:</comment>
   * <strong>class_uses()</strong>
   * <strong>trait_exists()</strong>


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

<comment>Param:</comment>
  <info>bool</info>  <strong>$categorize</strong>  Использование этого аргумента даёт возможность получить многомерный массив, в
                     котором в первом измерении будут содержаться категории констант, а во втором
                     соответствующие имена и значения.
                     ]]>Результатом выполнения данного примера
                     будет что-то подобное: Array ( [E_ERROR] => 1 [E_WARNING] => 2 [E_PARSE] => 4
                     [E_NOTICE] => 8 [E_CORE_ERROR] => 16 [E_CORE_WARNING] => 32 [E_COMPILE_ERROR]
                     => 64 [E_COMPILE_WARNING] => 128 [E_USER_ERROR] => 256 [E_USER_WARNING] => 512
                     [E_USER_NOTICE] => 1024 [E_ALL] => 2047 [TRUE] => 1 )
                      [pcre] => Array ( [PREG_PATTERN_ORDER] => 1 [PREG_SET_ORDER] => 2
                     [PREG_OFFSET_CAPTURE] => 256 [PREG_SPLIT_NO_EMPTY] => 1
                     [PREG_SPLIT_DELIM_CAPTURE] => 2 [PREG_SPLIT_OFFSET_CAPTURE] => 4
                     [PREG_GREP_INVERT] => 1 )
                      [user] => Array ( [MY_CONSTANT] => 1 )
                     
                     )
                     ]]>
                     
                     Результатом выполнения данного примера
                     будет что-то подобное:

<comment>Return:</comment>
  <info>array</info>  Возвращает массив вида "имя константы" =&gt; "значение константы", с возможностью
         сгруппировать его по имени модуля, зарегистрировавшего константу.

<comment>See Also:</comment>
   * <strong>defined()</strong>
   * <strong>constant()</strong>
   * <strong>get_loaded_extensions()</strong>
   * <strong>get_defined_functions()</strong>
   * <strong>get_defined_vars()</strong>


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

<comment>Param:</comment>
  <info>bool</info>  <strong>$exclude_disabled</strong>  Следует ли исключать из результата отключённые функции.

<comment>Return:</comment>
  <info>array</info>  Эта функция возвращает многомерный массив, содержащий список всех определённых функций, как
         встроенных (внутренних), так и пользовательских. Внутренние функции будут перечислены в
         элементе массива $arr["internal"], а определённые пользователем - в элементе $arr["user"]
         (смотрите пример ниже).

<comment>See Also:</comment>
   * <strong>function_exists()</strong>
   * <strong>get_defined_vars()</strong>
   * <strong>get_defined_constants()</strong>
   * <strong>get_declared_classes()</strong>


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

<comment>Return:</comment>
  <info>array</info>  Многомерный массив со всеми переменными.

<comment>See Also:</comment>
   * <strong>isset()</strong>
   * <strong>get_defined_functions()</strong>
   * <strong>get_defined_constants()</strong>


id: get_extension_funcs
type: function
doc:
<comment>Description:</comment>
  Возвращает массив имён функций модуля
    
  
  Функция возвращает имена всех функций, определённых в модуле с именем <strong>$extension</strong>.

<comment>Param:</comment>
  <info>string</info>  <strong>$extension</strong>  Имя модуля.
                      
                      Значение этого аргумента должно задаваться в нижнем регистре.

<comment>Return:</comment>
  <info>array|false</info>  Возвращает массив имён функций или <info>false</info>, если <strong>$extension</strong> не является допустимым
               модулем.

<comment>See Also:</comment>
   * <strong>get_loaded_extensions()</strong>
   * ReflectionExtension::getFunctions


id: get_headers
type: function
doc:
<comment>Description:</comment>
  Возвращает все заголовки из ответа сервера на HTTP-запрос
  
  <strong>get_headers()</strong> возвращает массив с заголовками из ответа сервера на HTTP-запрос.

<comment>Param:</comment>
  <info>string</info>         <strong>$url</strong>          Целевой URL.
  <info>bool</info>           <strong>$associative</strong>  Если необязательный параметр <strong>$associative</strong> установлен в ненулевое
                               значение, <strong>get_headers()</strong> разберёт ответ сервера и установит ключи для
                               возвращаемого массива.
  <info>resource|null</info>  <strong>$context</strong>      Корректный контекст ресурса, созданный с помощью
                               <strong>stream_context_create()</strong> или <info>null</info>, чтобы использовать контекст ресурса
                               по умолчанию.

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

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


id: get_html_translation_table
type: function
doc:
<comment>Description:</comment>
  Возвращает таблицу преобразований, используемую функциями htmlspecialchars и htmlentities
  
  <strong>get_html_translation_table()</strong> возвращает таблицу преобразований, используемую функциями
  <strong>htmlspecialchars()</strong> и <strong>htmlentities()</strong>.
  
  Специальные символы могут быть закодированы разными способами. Например, <return>"</return> может быть закодирован
  как , <return>&#34;</return> или <return>&#x22</return>. <strong>get_html_translation_table()</strong> возвращает только формы, используемые
  функциями <strong>htmlspecialchars()</strong> и <strong>htmlentities()</strong>.

<comment>Param:</comment>
  <info>int</info>     <strong>$table</strong>     Указывает, какую таблицу использовать для преобразований. Либо <info>HTML_ENTITIES</info>,
                     либо <info>HTML_SPECIALCHARS</info>.
  <info>int</info>     <strong>$flags</strong>     Битовая маска, состоящая из одного или нескольких перечисленных ниже флагов,
                     которые указывают, какие кавычки будет содержать таблица, а также для какого
                     документа таблица предназначена. Значение по умолчанию <return>ENT_QUOTES |
                     ENT_SUBSTITUTE | ENT_HTML401</return>. Доступные константы в параметре <strong>$flags</strong>Имя
                     константыОписание<info>ENT_COMPAT</info>Таблица будет содержать сущности для двойных
                     кавычек, но не будет для одинарных.<info>ENT_QUOTES</info>Таблица будет содержать сущности
                     как для двойных кавычек, так и для одинарных.<info>ENT_NOQUOTES</info>Таблица не будет
                     содержать сущности ни для двойных кавычек, ни для одинарных.<info>ENT_SUBSTITUTE</info>
                     Заменяет некорректные кодовые последовательности символом замены Юникода U+FFFD
                     в случае использования UTF-8 и &#FFFD; при использовании другой кодировки,
                     вместо возврата пустой строки. <info>ENT_HTML401</info>Таблица для HTML 4.01.<info>ENT_XML1</info>Таблица
                     для XML 1.<info>ENT_XHTML</info>Таблица для XHTML.<info>ENT_HTML5</info>Таблица для HTML 5.
  <info>string</info>  <strong>$encoding</strong>  Используемая кодировка. Если не указана, то значением по умолчанию для этого
                     аргумента является UTF-8.
                     
                     Поддерживаются следующие кодировки: Поддерживаемые
                     кодировкиКодировкаПсевдонимыОписаниеISO-8859-1ISO8859-1 Западно-европейская
                     Latin-1. ISO-8859-5ISO8859-5 Редко используемая кириллическая кодировка
                     (Latin/Cyrillic). ISO-8859-15ISO8859-15 Западно-европейская Latin-9. Добавляет
                     знак евро, французские и финские буквы к кодировке Latin-1 (ISO-8859-1). UTF-8
                     8-битная Unicode, совместимая с ASCII. cp866ibm866, 866 Кириллическая
                     кодировка, применяемая в DOS. cp1251Windows-1251, win-1251, 1251 Кириллическая
                     кодировка, применяемая в Windows. cp1252Windows-1252, 1252 Западно-европейская
                     кодировка, применяемая в Windows. KOI8-Rkoi8-ru, koi8r Русская кодировка.
                     BIG5950 Традиционный китайский, применяется в основном на Тайване. GB2312936
                     Упрощённый китайский, стандартная национальная кодировка. BIG5-HKSCS
                     Расширенная Big5, применяемая в Гонконге. Shift_JISSJIS, SJIS-win, cp932, 932
                     Японская кодировка. EUC-JPEUCJP, eucJP-win Японская кодировка. MacRoman
                     Кодировка, используемая в Mac OS. <return>''</return> Пустая строка активирует режим определения
                     кодировки из файла скрипта (Zend multibyte), default_charset и текущей локали
                     (смотрите <strong>nl_langinfo()</strong> и <strong>setlocale()</strong>) в указанном порядке. Не рекомендуется к
                     использованию.   Остальные кодировки не поддерживаются, вместо них будет
                     применена кодировка по умолчанию и сгенерировано предупреждение.
                     
                     Остальные кодировки не поддерживаются, вместо них будет применена кодировка по
                     умолчанию и сгенерировано предупреждение.

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

<comment>See Also:</comment>
   * <strong>htmlspecialchars()</strong>
   * <strong>htmlentities()</strong>
   * <strong>html_entity_decode()</strong>


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

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

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


id: get_included_files
type: function
doc:
<comment>Description:</comment>
  Возвращает массив имён включённых в скрипт файлов
  
  Получает имена всех файлов, которые были включены в скрипт с использованием <strong>include()</strong>,
  <strong>include_once()</strong>, <strong>require()</strong> или <strong>require_once()</strong>.

<comment>Return:</comment>
  <info>array</info>  Возвращает массив, содержащий имена всех файлов.
         
         Скрипт, который был загружен изначально, рассматривается как "включённый файл", поэтому он
         также попадёт в список файлов включённых функцией <strong>include()</strong> или другими.
         
         Файлы, добавляемые в скрипт неоднократно, попадут в массив только в одном экземпляре.

<comment>See Also:</comment>
   * <strong>include()</strong>
   * <strong>include_once()</strong>
   * <strong>require()</strong>
   * <strong>require_once()</strong>
   * <strong>get_required_files()</strong>


id: get_loaded_extensions
type: function
doc:
<comment>Description:</comment>
  Возвращает массив имён всех скомпилированных и загруженных модулей
    
  
  Функция возвращает массив имён всех скомпилированных и загруженных в интерпретаторе PHP модулей.

<comment>Param:</comment>
  <info>bool</info>  <strong>$zend_extensions</strong>  Возвращать только модули Zend или обычные модули, такие как mysqli. По
                          умолчанию <info>false</info> (возврат обычных модулей).

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

<comment>See Also:</comment>
   * <strong>get_extension_funcs()</strong>
   * <strong>extension_loaded()</strong>
   * <strong>dl()</strong>
   * <strong>phpinfo()</strong>


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

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

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


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

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

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


id: get_mangled_object_vars
type: function
doc:
<comment>Description:</comment>
  Возвращает массив искажённых свойств объекта
  
  Возвращает массив (<info>array</info>), в элементах которого свойства (переменные-члены) этого объекта. Ключами
  будут имена переменных-членов, с некоторыми примечательными исключениями: к закрытым полям класса
  (private) спереди будет дописано имя класса; к защищённым полям класса (protected) спереди будет
  добавлен символ <return>*</return>. Эти добавленные значения с обеих сторон также имеют <return>NUL</return> байты.
  Неинициализированные типизированные свойства автоматически отбрасываются.

<comment>Param:</comment>
  <info>object</info>  <strong>$object</strong>  Экземпляр объекта.

<comment>Return:</comment>
  <info>array</info>  Возвращает массив (<info>array</info>), содержащий все свойства объекта <strong>$object</strong>, независимо от области
         видимости.

<comment>See Also:</comment>
   * <strong>get_class_vars()</strong>
   * <strong>get_object_vars()</strong>


id: get_meta_tags
type: function
doc:
<comment>Description:</comment>
  Извлекает содержимое всех метатегов из файла и возвращает массив
  
  Открывает <strong>$filename</strong> и разбирает его по строкам в поисках тегов \<meta&gt;. Разбор файла останавливается на теге <return>\</head&gt;</return>.

<comment>Param:</comment>
  <info>string</info>  <strong>$filename</strong>          Путь к HTML-файлу в виде строки. Может быть как локальным файлом, так и
                             URL.
                             
                             Что обрабатывает функция <strong>get_meta_tags()</strong>
                             
                             
                             
                              
                             ]]>
  <info>bool</info>    <strong>$use_include_path</strong>  Если <strong>$use_include_path</strong> равен <info>true</info>, PHP будет искать файл используя
                             стандартные пути поиска из директивы php.ini include_path. Это
                             актуально только для локальных файлов, но не для URL.

<comment>Return:</comment>
  <info>array|false</info>  Возвращает ассоциативный массив со значениями разобранных метатегов.
               
               Значение атрибута name становится ключом массива, а значение атрибута content -
               значением этого элемента. Вы можете использовать стандартные функции работы с
               массивами для обхода или доступа к конкретным значениям. Специальные символы в именах
               (ключах массива) заменяются на '_', и ключи приводятся к нижнему регистру. Если два
               метатега имеют одинаковые имена, будет возвращён только последний.
               
               Возвращает <info>false</info> в случае возникновения ошибки.

<comment>See Also:</comment>
   * <strong>htmlentities()</strong>
   * <strong>urlencode()</strong>


id: get_object_vars
type: function
doc:
<comment>Description:</comment>
  Возвращает свойства указанного объекта
  
  Возвращает видимые нестатические свойства указанного объекта <strong>$object</strong> в соответствии с областью
  видимости.

<comment>Param:</comment>
  <info>object</info>  <strong>$object</strong>  Экземпляр объекта

<comment>Return:</comment>
  <info>array</info>  Возвращает ассоциативный массив нестатических свойств объекта <strong>$object</strong>, доступных в данной
         области видимости.

<comment>See Also:</comment>
   * <strong>get_class_methods()</strong>
   * <strong>get_class_vars()</strong>


id: get_parent_class
type: function
doc:
<comment>Description:</comment>
  Возвращает имя родительского класса для объекта или класса
  
  Возвращает имя родительского класса для объекта или класса.

<comment>Param:</comment>
  <info>object|string</info>  <strong>$object_or_class</strong>  Тестируемый объект или имя класса. Если вызывается из метода
                                   объекта, то этот параметр не обязателен.

<comment>Return:</comment>
  <info>string|false</info>  Возвращает имя родительского класса, если <strong>$object_or_class</strong> является объектом или
                именем класса.
                
                Если объект не имеет родителя или переданного класса с таким именем не существует,
                то возвращается <info>false</info>.
                
                Если функция вызвана без параметров вне объекта, эта функция возвращает <info>false</info>.

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


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


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

<comment>Param:</comment>
  <info>resource</info>  <strong>$resource</strong>  Дескриптор ресурса.

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

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


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

<comment>Param:</comment>
  <info>resource</info>  <strong>$resource</strong>  Определяемый дескриптор ресурса.

<comment>Return:</comment>
  <info>string</info>  Если данный параметр <strong>$resource</strong> является ресурсом, функция возвращает строку, указывающую
          его тип. Если тип не определяется этой функцией, возвращаемым значением будет строка
          <return>Unknown</return>.
          
          Функция возвращает <info>null</info> и вызывает ошибку, если <strong>$resource</strong> не является ресурсом (<info>resource</info>).

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


id: get_resources
type: function
doc:
<comment>Description:</comment>
  Возвращает активные ресурсы
  
  Возвращает массив всех текущих активных ресурсов (<info>resource</info>), опционально отфильтрованный по типу
  ресурса.
  
  Функция предназначена для отладки и тестирования. Функцию не следует использовать в рабочем
  окружении, особенно для доступа или даже управления ресурсами, которые обычно недоступны
  (например, базовый ресурс потока экземпляров <class>SplFileObject</class>).

<comment>Param:</comment>
  <info>string|null</info>  <strong>$type</strong>  Если задано, то  <strong>get_resources()</strong> вернёт только ресурсы указанного типа. Список
                      доступных типов ресурсов.
                      
                      Если в качестве типа задана строка <return>Unknown</return>, то будут возвращены только ресурсы
                      неизвестного типа.
                      
                      Если не задано, то будут возвращены все ресурсы.

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

<comment>See Also:</comment>
   * <strong>get_loaded_extensions()</strong>
   * <strong>get_defined_constants()</strong>
   * <strong>get_defined_functions()</strong>
   * <strong>get_defined_vars()</strong>


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

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

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


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

<comment>Return:</comment>
  <info>string|false</info>  Возвращает текущий рабочий каталог в случае успешного выполнения или <info>false</info> в случае
                ошибки.
                
                На некоторых вариантах Unix <strong>getcwd()</strong> вернёт <info>false</info>, если на каком-либо из
                родительских каталогов не установлен режим чтения или поиска, даже если он
                установлен на текущем каталоге. Больше информации о режимах доступа смотрите в
                документации функции <strong>chmod()</strong>.

<comment>See Also:</comment>
   * <strong>chdir()</strong>
   * <strong>chmod()</strong>


id: getdate
type: function
doc:
<comment>Description:</comment>
  Возвращает информацию о дате/времени
  
  Возвращает ассоциативный массив (<info>array</info>), содержащий информацию о дате, представленной меткой
  времени <strong>$timestamp</strong> или текущим системным временем, если <strong>$timestamp</strong> не был передан или <info>null</info>.

<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>.

<comment>Return:</comment>
  <info>array</info>  Возвращает ассоциативный массив (<info>array</info>) с информацией о параметре <strong>$timestamp</strong>, который
         содержит следующие элементы:
         
         Индексы возвращаемого ассоциативного массиваИндексОписаниеПример значения<return>"seconds"</return>Числовое
         представление секундот <return>0</return> до <return>59</return><return>"minutes"</return>Числовое представление минутот <return>0</return> до
         <return>59</return><return>"hours"</return>Числовое представление часовот <return>0</return> до <return>23</return><return>"mday"</return>Порядковый номер дня месяцаот <return>1</return> до
         <return>31</return><return>"wday"</return>Порядковый номер дня неделиот <return>0</return> (воскресенье) до <return>6</return> (суббота)<return>"mon"</return>Порядковый номер
         месяцаот <return>1</return> до <return>12</return><return>"year"</return>Номер года, 4 цифрыПримеры: <return>1999</return>, <return>2003</return><return>"yday"</return>Порядковый номер дня в
         годуот <return>0</return> до <return>365</return><return>"weekday"</return>Полное наименование дня неделиот <return>Sunday</return> до <return>Saturday</return><return>"month"</return>Полное
         наименование месяца, например, January или Marchот <return>January</return> до <return>December</return><return>0</return> Количество секунд,
         прошедших с начала эпохи Unix (The Unix Epoch), подобно значению, возвращаемому функцией
         <strong>time()</strong> и используемому функцией <strong>date()</strong>. Зависит от платформы, в большинстве случаев от
         <return>-2147483648</return> до <return>2147483647</return>.

<comment>See Also:</comment>
   * <strong>date()</strong>
   * <strong>idate()</strong>
   * <strong>localtime()</strong>
   * <strong>time()</strong>
   * <strong>setlocale()</strong>


