# php_manual

id: SplDoublyLinkedList::unshift
type: function
doc:
<comment>Description:</comment>
  Вставляет элемент в начало двусвязного списка
  
  Вставляет <strong>$value</strong> в начало двусвязного списка.

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

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


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

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


id: SplFileInfo
type: class
doc:
<comment>Description:</comment>
  Класс SplFileInfo предлагает высокоуровневый объектно-ориентированный интерфейс к информации для
  отдельного файла.


id: SplFileInfo::__construct
type: function
doc:
<comment>Description:</comment>
  Создать новый объект SplFileInfo
  
  Создаёт новый объект SplFileInfo для указанного имени файла. Файл не обязательно должен
  существовать или быть доступным для чтения.

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


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

<comment>Return:</comment>
  <info>string</info>  Возвращает путь к файлу.


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

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

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


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

<comment>Param:</comment>
  <info>string</info>  <strong>$suffix</strong>  Необязательный суффикс, который будет исключён из базового имени.
                   
                   <strong>SplFileInfo::getBasename()</strong> учитывает локаль, поэтому, чтобы увидеть корректное
                   базовое имя файла с многобайтовыми символами в пути, соответствующая локаль
                   должна быть установлена с помощью функции <strong>setlocale()</strong>.

<comment>Return:</comment>
  <info>string</info>  Возвращает базовое имя без информации о пути.

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


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

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

<comment>See Also:</comment>
   * <strong>filectime()</strong>
   * SplFileInfo::getATime
   * SplFileInfo::getMTime


id: SplFileInfo::getExtension
type: function
doc:
<comment>Description:</comment>
  Получает расширение файла
  
  Возвращает расширение файла.

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

<comment>See Also:</comment>
   * SplFileInfo::getFilename
   * SplFileInfo::getBasename
   * <strong>pathinfo()</strong>


id: SplFileInfo::getFileInfo
type: function
doc:
<comment>Description:</comment>
  Получает объект SplFileInfo для файла
  
  Этот метод получает объект <class>SplFileInfo</class> для указанного файла.

<comment>Param:</comment>
  <info>string|null</info>  <strong>$class</strong>  Имя производного от <class>SplFileInfo</class> класса для использования.

<comment>Return:</comment>
  <info>SplFileInfo</info>  Объект <class>SplFileInfo</class>, созданный для файла.

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


id: SplFileInfo::getFilename
type: function
doc:
<comment>Description:</comment>
  Получает имя файла
  
  Получает имя файла без информации о пути к нему.

<comment>Return:</comment>
  <info>string</info>  Имя файла.

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


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

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

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


id: SplFileInfo::getInode
type: function
doc:
<comment>Description:</comment>
  Получает индексный дескриптор для файла
    
  
  Получает номер индексного дескриптора для объекта файловой системы.

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

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


id: SplFileInfo::getLinkTarget
type: function
doc:
<comment>Description:</comment>
  Получает путь ссылки
    
  
  Получает целевой путь ссылки файловой системы.
  
  Этот путь может не быть реальным расположением в файловой системе. Чтобы получить реальный путь
  файловой системы, используйте метод SplFileInfo::getRealPath.

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

<comment>See Also:</comment>
   * SplFileInfo::isLink
   * SplFileInfo::getRealPath


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

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

<comment>See Also:</comment>
   * <strong>filemtime()</strong>
   * SplFileInfo::getATime
   * SplFileInfo::getCTime


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

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

<comment>See Also:</comment>
   * <strong>posix_getpwuid()</strong>
   * SplFileInfo::getGroup


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

<comment>Return:</comment>
  <info>string</info>  Возвращает путь к файлу.

<comment>See Also:</comment>
   * SplFileInfo::getRealPath
   * SplFileInfo::getFilename
   * SplFileInfo::getPathInfo


id: SplFileInfo::getPathInfo
type: function
doc:
<comment>Description:</comment>
  Получает объект SplFileInfo для заданного пути
    
  
  Получает объект класса <class>SplFileInfo</class> для пути текущего файла.

<comment>Param:</comment>
  <info>string|null</info>  <strong>$class</strong>  Имя производного от <class>SplFileInfo</class> класса для использования или себя, если <info>null</info>.

<comment>Return:</comment>
  <info>SplFileInfo|null</info>  Возвращает объект класса <class>SplFileInfo</class> для родительского пути файла в случае
                    успешного выполнения или <info>null</info> в случае возникновения ошибки.

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


id: SplFileInfo::getPathname
type: function
doc:
<comment>Description:</comment>
  Получает путь к файлу
    
  
  Возвращает путь к файлу.

<comment>Return:</comment>
  <info>string</info>  Путь к файлу.

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


id: SplFileInfo::getPerms
type: function
doc:
<comment>Description:</comment>
  Получает список разрешений
  
  Получает список разрешений для файла.

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


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

<comment>Return:</comment>
  <info>string|false</info>  Возвращает путь к файлу или <info>false</info>, если файл не существует.

<comment>See Also:</comment>
   * SplFileInfo::isLink
   * realpath


id: SplFileInfo::getSize
type: function
doc:
<comment>Description:</comment>
  Получает размер файла
  
  Возвращает размер файла в байтах.

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

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


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

<comment>Return:</comment>
  <info>string|false</info>  Строка (<info>string</info>), представляющая тип элемента. Возможны следующие значения: <return>file</return>,
                <return>link</return>, <return>dir</return>, <return>block</return>, <return>fifo</return>, <return>char</return>, <return>socket</return> или <return>unknown</return>. В случае возникновения ошибки
                возвращает <info>false</info>.


id: SplFileInfo::isDir
type: function
doc:
<comment>Description:</comment>
  Указывает, является ли файл каталогом
  
  Этот метод можно использовать для определения того, является ли файл каталогом.

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


id: SplFileInfo::isExecutable
type: function
doc:
<comment>Description:</comment>
  Указывает, является ли файл исполняемым
  
  Проверяет, является ли файл исполняемым.

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


id: SplFileInfo::isFile
type: function
doc:
<comment>Description:</comment>
  Указывает, ссылается ли объект на обычный файл
  
  Проверяет, существует ли файл, на который ссылается объект SplFileInfo, и является ли он обычным
  файлом.

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


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

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

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


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

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


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

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


id: SplFileInfo::openFile
type: function
doc:
<comment>Description:</comment>
  Получает объект SplFileObject для файла
  
  Создаёт объект (<info>object</info>) <class>SplFileObject</class> файла. Это полезно, потому что <class>SplFileObject</class> содержит
  дополнительные методы для работы с файлом, в то время как <class>SplFileInfo</class> полезен только для получения
  информации, например, доступен ли файл для записи.

<comment>Param:</comment>
  <info>string</info>         <strong>$mode</strong>            Режим открытия файла. Смотрите документацию по <strong>fopen()</strong> с описанием
                                  возможных режимов. По умолчанию только для чтения.
  <info>bool</info>           <strong>$useIncludePath</strong>  Если установлено в <info>true</info>, имя файла также ищется в
                                  include_path
  <info>resource|null</info>  <strong>$context</strong>         Для описания <return>контекстов</return> обратитесь
                                  к следующему разделу руководства: контекст.

<comment>Return:</comment>
  <info>SplFileObject</info>  Открытый файл как объект (<info>object</info>) <class>SplFileObject</class>.

<comment>See Also:</comment>
   * <class>SplFileObject</class>
   * <strong>stream_context_create()</strong>
   * <strong>fopen()</strong>


id: SplFileInfo::setFileClass
type: function
doc:
<comment>Description:</comment>
  Задаёт имя класса, который будет использоваться методом
     SplFileInfo::openFile
    
  
  Задаёт имя класса, которое будет использовать метод SplFileInfo::openFile. Этим классом должен
  быть <class>SplFileObject</class> или наследник класса <class>SplFileObject</class>.

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

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

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


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

<comment>Param:</comment>
  <info>string</info>  <strong>$class</strong>  Имя класса, который будет использоваться при вызове SplFileInfo::getFileInfo и
                  SplFileInfo::getPathInfo.

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

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


id: SplFileObject
type: class
doc:
<comment>Description:</comment>
  Класс SplFileObject предоставляет объектно-ориентированный интерфейс для файла.


id: SplFileObject::SKIP_EMPTY
type: constant
doc:
<comment>Description:</comment>
  Пропускает пустые строки с файле. Для правильной работы требуется включить флаг <info>READ_AHEAD</info>.


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

<comment>Param:</comment>
  <info>string</info>         <strong>$filename</strong>        Файл, который требуется прочитать.
                                  
                                  Для этой функции вы можете использовать URL в качестве имени
                                  файла, если была включена опция fopen wrappers. Смотрите более
                                  подробную информацию об определении имени файла в описании функции
                                  <strong>fopen()</strong>. Смотрите также список поддерживаемых обёрток URL, их
                                  возможности, замечания по использованию и список предопределённых
                                  констант в разделе .
  <info>string</info>         <strong>$mode</strong>            Режим работы с файлом. Список возможных режимов работы приведён в
                                  описании функции <strong>fopen()</strong>.
  <info>bool</info>           <strong>$useIncludePath</strong>  Требуется ли просматривать include_path во время поиска файла
                                  <strong>$filename</strong>.
  <info>resource|null</info>  <strong>$context</strong>         Допустимый ресурс контекста, созданный функцией
                                  <strong>stream_context_create()</strong>.

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


id: SplFileObject::__toString
type: function
doc:
<comment>Description:</comment>
  Возвращает текущую строку в виде строки
  
  Метод возвращает текущую строку в виде строки.

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


id: SplFileObject::current
type: function
doc:
<comment>Description:</comment>
  Получить текущую строки файла
    
  
  Извлекает текущую строку файла.

<comment>Return:</comment>
  <info>string|array|false</info>  Извлекает текущую строку файла. Если задан флаг <info>SplFileObject::READ_CSV</info>, этот
                      метод будет разбирать строку, как данные CSV, и вернёт массив. Если достигнут
                      конец файла, возвращается <info>false</info>.

<comment>See Also:</comment>
   * SplFileObject::key
   * SplFileObject::seek
   * SplFileObject::next
   * SplFileObject::rewind
   * SplFileObject::valid


id: SplFileObject::eof
type: function
doc:
<comment>Description:</comment>
  Проверяет, достигнут ли конец файла
  
  Определяет, был ли достигнут конец файла

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

<comment>See Also:</comment>
   * SplFileObject::valid
   * <strong>feof()</strong>


id: SplFileObject::fflush
type: function
doc:
<comment>Description:</comment>
  Сбрасывает буфер вывода в файл
  
  Принудительная запись всех буферизованных данных в файл.

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

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


id: SplFileObject::fgetc
type: function
doc:
<comment>Description:</comment>
  Получает символ из файла
  
  Получает символ из файла.

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

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


id: SplFileObject::fgetcsv
type: function
doc:
<comment>Description:</comment>
  Получить строку из файла и её разбор как поля CSV
    
  
  Получает строку из файла и разбирает её в соответствии с форматом CSV. Результаты разбора
  возвращает в виде массива.
  
  Эта функция принимает во внимание настройки локали. К примеру, если <return>LC_CTYPE</return> установлена в
  <return>en_US.UTF-8</return>, то файлы в однобайтовой кодировке будут неправильно прочитаны этой функцией.

<comment>Param:</comment>
  <info>string</info>  <strong>$separator</strong>  Разделитель полей (только один однобайтовый символ). По умолчанию это запятая
                      или символ, который был задан методом SplFileObject::setCsvControl.
  <info>string</info>  <strong>$enclosure</strong>  Символ ограничителя полей (только один однобайтовый символ). По умолчанию это
                      двойная кавычка или символ, который был задан методом
                      SplFileObject::setCsvControl. Пустая строка (<return>""</return>) отключает проприетарный
                      механизм экранирования.
                      
                      Обычно символ <strong>$enclosure</strong> экранируется внутри поля путём его удваивания;
                      однако, символ <strong>$escape</strong> в качестве альтернативы. Поэтому значения по умолчанию
                      этих параметров <return>""</return> и <return>\"</return> имеют одинаковое значение. Помимо разрешения
                      экранировать символ <strong>$enclosure</strong> символ <strong>$escape</strong> не имеет особого смысла; он даже
                      не предназначен для самого экранирования.
  <info>string</info>  <strong>$escape</strong>     Экранирующий символ (не более одного однобайтового символа). По умолчанию это
                      обратный слеш (<return>\</return>) или символ, который был задан методом
                      SplFileObject::setCsvControl.

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

<comment>See Also:</comment>
   * SplFileObject::setCsvControl
   * SplFileObject::setFlags
   * SplFileObject::READ_CSV
   * SplFileObject::current


id: SplFileObject::fgets
type: function
doc:
<comment>Description:</comment>
  Получает строку из файла
  
  Получает строку из файла.

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

<comment>See Also:</comment>
   * <strong>fgets()</strong>
   * SplFileObject::fgetss
   * SplFileObject::fgetc
   * SplFileObject::current


id: SplFileObject::fgetss
type: function
doc:
<comment>Description:</comment>
  Получить строку из файла и удалить теги HTML
    
  
  Работа функции идентична SplFileObject::fgets за исключением того, что SplFileObject::fgetss
  пытается очистить строку от любых тегов HTML и PHP. The function retains the parsing state from
  call to call, and as such is not equivalent to calling <strong>strip_tags()</strong> on the return value of
  SplFileObject::fgets. Функция сохраняет состояние синтаксического анализа от вызова к вызову и
  поэтому не эквивалентна вызову <strong>strip_tags()</strong> для возвращаемого значения SplFileObject::fgets.

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

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

<comment>See Also:</comment>
   * <strong>fgetss()</strong>
   * SplFileObject::fgets
   * SplFileObject::fgetc
   * SplFileObject::current
   * Фильтр string.strip_tags


id: SplFileObject::flock
type: function
doc:
<comment>Description:</comment>
  Портируемая блокировка файла
  
  Блокирует или разблокирует файл тем же портируемым способом, что и <strong>flock()</strong>.

<comment>Param:</comment>
  <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>$wouldBlock</strong>  Будет установлен <info>true</info>, если блокировка будет блокирующей (код ошибки
                    EWOULDBLOCK).

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

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


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

<comment>Return:</comment>
  <info>int</info>  Возвращает количество символов, прочитанных с дескриптора <strong>$handle</strong> и переданных на вывод.

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


id: SplFileObject::fputcsv
type: function
doc:
<comment>Description:</comment>
  Записать массив полей в виде строки CSV
  
  Записывает массив <strong>$fields</strong> в файл как строку CSV.

<comment>Param:</comment>
  <info>array</info>   <strong>$fields</strong>     Массив значений
  <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> в случае возникновения ошибки.
             
             Возвращает <info>false</info> и не производит запись в файл, если параметры <strong>$separator</strong> или
             <strong>$enclosure</strong> содержат больше одного символа.

<comment>See Also:</comment>
   * <strong>fputcsv()</strong>
   * SplFileObject::fgetcsv


id: SplFileObject::fread
type: function
doc:
<comment>Description:</comment>
  Чтение из файла
  
  Считывает заданное количества байт из файла.

<comment>Param:</comment>
  <info>int</info>  <strong>$length</strong>  Количество байт для чтения.

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

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


id: SplFileObject::fscanf
type: function
doc:
<comment>Description:</comment>
  Разбирает строку файла в соответствии с заданным форматом
    
  
  Читает строку из файла и разбирает её в соответствии с заданным форматом <strong>$format</strong>.
  
  Любые пробелы в строке <strong>$format</strong> соответствует любому пробелу в строке из файла. Это означает, что
  символ табуляции (<return>\t</return>) в строке формата может соответствовать одному пробелу в строке файла.

<comment>Param:</comment>
  <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|null</info>  Если передан только один параметр, распознанные в строке значения будут помещены в
                  массив. Если переданы дополнительные строки форматирования, функция вернёт
                  количество шаблонов, с которыми совпала строка. Необязательные параметры должны
                  передаваться по ссылке.

<comment>See Also:</comment>
   * <strong>fscanf()</strong>
   * <strong>sscanf()</strong>
   * <strong>printf()</strong>
   * <strong>sprintf()</strong>


id: SplFileObject::fseek
type: function
doc:
<comment>Description:</comment>
  Перевод файлового указателя на заданную позицию
  
  Перемещает файловый указатель на указанное в параметре <strong>$offset</strong> количество байт. За позицию, от
  которой будет отсчитываться смещение отвечает параметр <strong>$whence</strong>.

<comment>Param:</comment>
  <info>int</info>  <strong>$offset</strong>  Смещение. Отрицательная величина смещения используется, когда нужно перемещаться по
                файлу от конца к началу, т.е. когда в качестве аргумента <strong>$whence</strong> передано значение
                SEEK_END.
  <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>
                байт от конца файла.
                
                Если параметр <strong>$whence</strong> опущен, функция будет работать в режиме <info>SEEK_SET</info>.

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

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


id: SplFileObject::fstat
type: function
doc:
<comment>Description:</comment>
  Получает информацию о файле
  
  Собирает статистическую информацию о файле. Поведение идентично <strong>fstat()</strong>.

<comment>Return:</comment>
  <info>array</info>  Возвращает массив со статистической информацией о файле; формат массива подробно описан на
         странице функции <strong>stat()</strong>.

<comment>See Also:</comment>
   * <strong>fstat()</strong>
   * <strong>stat()</strong>


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

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

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


id: SplFileObject::ftruncate
type: function
doc:
<comment>Description:</comment>
  Обрезает файл до заданной длины
    
  
  Отбрасывает все данные в файле после байта <strong>$size</strong>.

<comment>Param:</comment>
  <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>ftruncate()</strong>


id: SplFileObject::fwrite
type: function
doc:
<comment>Description:</comment>
  Запись в файл
  
  Записывает содержимое строки <strong>$string</strong> в файл.

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

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

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


id: SplFileObject::getChildren
type: function
doc:
<comment>Description:</comment>
  Метод-заглушка
  
  Класс <class>SplFileObject</class> не имеет дочерних элементов, поэтому этот метод возвращает <info>null</info>.

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

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


id: SplFileObject::getCsvControl
type: function
doc:
<comment>Description:</comment>
  Получает символы разделителя, обёртывания и экранирования для CSV
  
  Получает символы разделителя, обёртывания и экранирования для CSV. Символ обёртывания используется
  для помещения в него значений полей. Например строка 'строка' обёрнута в одиночные кавычки (').

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

<comment>See Also:</comment>
   * SplFileObject::setCsvControl
   * SplFileObject::fgetcsv


id: SplFileObject::getCurrentLine
type: function
doc:
<comment>Description:</comment>
  Псевдоним SplFileObject::fgets
  
  Метод является псевдонимом:  SplFileObject::fgets.


id: SplFileObject::getFlags
type: function
doc:
<comment>Description:</comment>
  Получает флаги настройки объекта SplFileObject
    
  
  Получает флаги настройки объекта SplFileObject в виде целого числа типа <info>int</info>.

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

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


id: SplFileObject::getMaxLineLen
type: function
doc:
<comment>Description:</comment>
  Получить максимальную длину строки
  
  Получает максимальную длину строки, установленную с помощью SplFileObject::setMaxLineLen.

<comment>Return:</comment>
  <info>int</info>  Возвращает максимальную длину строки, если она была установлена с помощью
       SplFileObject::setMaxLineLen, по умолчанию <return>0</return>.

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


id: SplFileObject::hasChildren
type: function
doc:
<comment>Description:</comment>
  Класс SplFileObject не имеет наследников
  
  Класс <class>SplFileObject</class> не имеет дочерних элементов, поэтому метод всегда возвращает <info>false</info>.

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

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


id: SplFileObject::key
type: function
doc:
<comment>Description:</comment>
  Получить номер строки
    
  
  Получает номер текущей строки.
  
  Этот номер может отличаться от реального положения файлового указателя, когда читаются строки
  фиксированной длины с заданием этой длины методом SplFileObject::setMaxLineLen.

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

<comment>See Also:</comment>
   * SplFileObject::current
   * SplFileObject::seek
   * SplFileObject::next
   * SplFileObject::rewind
   * SplFileObject::valid


id: SplFileObject::next
type: function
doc:
<comment>Description:</comment>
  Читать следующую строку
  
  Переход к следующей строке в файле.

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

<comment>See Also:</comment>
   * SplFileObject::current
   * SplFileObject::key
   * SplFileObject::seek
   * SplFileObject::rewind
   * SplFileObject::valid


id: SplFileObject::rewind
type: function
doc:
<comment>Description:</comment>
  Перемотка файлового указателя в начало файла
    
  
  Перематывает файловый указатель в начало файла.

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

<comment>See Also:</comment>
   * SplFileObject::current
   * SplFileObject::key
   * SplFileObject::seek
   * SplFileObject::next
   * SplFileObject::valid


id: SplFileObject::seek
type: function
doc:
<comment>Description:</comment>
  Перевод файлового указателя на заданную строку
    
  
  Переводит файловый указатель на заданную строку.

<comment>Param:</comment>
  <info>int</info>  <strong>$line</strong>  Номер строки, начиная с 0, на которую требуется перейти.

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

<comment>See Also:</comment>
   * SplFileObject::current
   * SplFileObject::key
   * SplFileObject::next
   * SplFileObject::rewind
   * SplFileObject::valid


id: SplFileObject::setCsvControl
type: function
doc:
<comment>Description:</comment>
  Устанавливает символы разделителя, обёртывания и экранирования для CSV
  
  Устанавливает символы разделителя, ограничителя и экранирования для CSV. Символ ограничителя
  используется для помещения в него значений полей. Например строка 'строка' обёрнута в одиночные
  кавычки (').

<comment>Param:</comment>
  <info>string</info>  <strong>$separator</strong>  Разделитель поля (только один однобайтовый символ).
  <info>string</info>  <strong>$enclosure</strong>  Символ ограничителя поля (только один однобайтовый символ).
  <info>string</info>  <strong>$escape</strong>     Экранирующий символ (не более одного однобайтового символа). Пустая строка
                      (<return>""</return>) отключает проприетарный механизм экранирования.

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

<comment>See Also:</comment>
   * SplFileObject::getCsvControl
   * SplFileObject::fgetcsv


id: SplFileObject::setFlags
type: function
doc:
<comment>Description:</comment>
  Устанавливает флаги для SplFileObject
  
  Устанавливает флаги, которые будут использоваться <class>SplFileObject</class>.

<comment>Param:</comment>
  <info>int</info>  <strong>$flags</strong>  Битовая маска флагов для установки. Смотрите константы SplFileObject для получения
               списка доступных флагов.

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

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


id: SplFileObject::setMaxLineLen
type: function
doc:
<comment>Description:</comment>
  Установить максимальную длину строки
  
  Устанавливает максимальную длину строки для чтения.

<comment>Param:</comment>
  <info>int</info>  <strong>$maxLength</strong>  Максимальная длина строки.

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

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


id: SplFileObject::valid
type: function
doc:
<comment>Description:</comment>
  Проверяет, достигнут ли конец файла (EOF)
  
  Проверяет, был ли достигнут конец файла (EOF).

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

<comment>See Also:</comment>
   * SplFileObject::current
   * SplFileObject::key
   * SplFileObject::seek
   * SplFileObject::next
   * SplFileObject::rewind


id: SplFixedArray
type: class
doc:
<comment>Description:</comment>
  Класс SplFixedArray обеспечивает базовую функциональность, предоставляемую массивами. Главное
  различие между SplFixedArray и обычным массивом PHP в том, что размер SplFixedArray необходимо
  изменять вручную, а в качестве индексов могут выступать только целочисленные значения.
  Преимущество данных ограничений заключается в меньшем использовании памяти, чем стандартный массив
  (<info>array</info>).


id: SplFixedArray::__construct
type: function
doc:
<comment>Description:</comment>
  Создаёт новый массив фиксированной длины
  
  Создаёт фиксированный массив с числом <info>null</info> значений, равных <strong>$size</strong>.

<comment>Param:</comment>
  <info>int</info>  <strong>$size</strong>  Размер фиксированного массива. Ожидается значение между <return>0</return> и <info>PHP_INT_MAX</info>.


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

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


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

<comment>Param:</comment>
  <info>array</info>  <strong>$data</strong>  Десериализуемое значение.

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


id: SplFixedArray::__wakeup
type: function
doc:
<comment>Description:</comment>
  Переинициализация массива после десериализации
  
  Проинициализирует массив после десериализации.

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


id: SplFixedArray::count
type: function
doc:
<comment>Description:</comment>
  Возвращает размер массива
  
  Возвращает размер массива.

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

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


id: SplFixedArray::current
type: function
doc:
<comment>Description:</comment>
  Возвращает текущий элемент массива
  
  Получает текущий элемент массива.

<comment>Return:</comment>
  <info>mixed</info>  Текущий элемент массива.


id: SplFixedArray::fromArray
type: function
doc:
<comment>Description:</comment>
  Импортирует PHP-массив в объект класса SplFixedArray
  
  Импортирует PHP-массив <strong>$array</strong> в новый объект класса <class>SplFixedArray</class>

<comment>Param:</comment>
  <info>array</info>  <strong>$array</strong>         Массив, который следует импортировать.
  <info>bool</info>   <strong>$preserveKeys</strong>  По возможности сохранить численные индексы, заданные в оригинальном массиве.

<comment>Return:</comment>
  <info>SplFixedArray</info>  Возвращает объект класса <class>SplFixedArray</class>, содержащий данные из импортированного
                 массива.


id: SplFixedArray::getIterator
type: function
doc:
<comment>Description:</comment>
  Получает итератор для перехода по массиву
  
  Возвращает итератор для перехода по массиву

<comment>Return:</comment>
  <info>Iterator</info>  Экземпляр объекта, реализующего <class>Iterator</class> для прохождения по массиву.


id: SplFixedArray::getSize
type: function
doc:
<comment>Description:</comment>
  Получает размер массива
  
  Получает размер массива.

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

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


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

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


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

<comment>Return:</comment>
  <info>int</info>  Индекс текущего элемента массива.


id: SplFixedArray::next
type: function
doc:
<comment>Description:</comment>
  Переходит к следующему элементу массива
  
  Перемещает итератор на следующий элемент массива.

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


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

<comment>Param:</comment>
  <info>int</info>  <strong>$index</strong>  Индекс, который необходимо проверить.

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


id: SplFixedArray::offsetGet
type: function
doc:
<comment>Description:</comment>
  Возвращает значение по указанному индексу
  
  Возвращает значение по индексу <strong>$index</strong>.

<comment>Param:</comment>
  <info>int</info>  <strong>$index</strong>  Индекс.

<comment>Return:</comment>
  <info>mixed</info>  Значение по индексу <strong>$index</strong>.


id: SplFixedArray::offsetSet
type: function
doc:
<comment>Description:</comment>
  Устанавливает новое значение по заданному индексу
  
  По индексу <strong>$index</strong> устанавливает значение <strong>$value</strong>.

<comment>Param:</comment>
  <info>int</info>    <strong>$index</strong>  Индекс, по которому устанавливается значение.
  <info>mixed</info>  <strong>$value</strong>  Новое значение для индекса <strong>$index</strong>.

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


id: SplFixedArray::offsetUnset
type: function
doc:
<comment>Description:</comment>
  Удаляет значение по индексу $index
  
  Удаляет значение по заданному индексу.

<comment>Param:</comment>
  <info>int</info>  <strong>$index</strong>  Индекс, по которому удаляется значение.

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


id: SplFixedArray::rewind
type: function
doc:
<comment>Description:</comment>
  Устанавливает итератор массива в начало
  
  Устанавливает итератор массива в начало.

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


id: SplFixedArray::setSize
type: function
doc:
<comment>Description:</comment>
  Изменяет размер массива
  
  Устанавливает размер массива в значение <strong>$size</strong>. Если <strong>$size</strong> меньше текущего размера массива, то все
  лишние значения отбрасываются. Если же <strong>$size</strong> больше текущего размера массива, то массив будет
  дополнен <info>null</info> значениями.

<comment>Param:</comment>
  <info>int</info>  <strong>$size</strong>  Новое значение размера массива. Ожидается значение между <return>0</return> и <info>PHP_INT_MAX</info>.

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


id: SplFixedArray::toArray
type: function
doc:
<comment>Description:</comment>
  Возвращает обычный PHP-массив со значениями фиксированного массива
  
  Возвращает обычный PHP-массив со значениями фиксированного массива.

<comment>Return:</comment>
  <info>array</info>  Возвращает PHP-массив (<info>array</info>), составленный из значений фиксированного массива.


id: SplFixedArray::valid
type: function
doc:
<comment>Description:</comment>
  Проверяет массив на наличие элементов
  
  Проверяет массив на наличие элементов.

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


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


id: SplHeap::compare
type: function
doc:
<comment>Description:</comment>
  Сравнивает элементы, чтобы во время сортировки корректно разместить их в куче
    
  
  Сравнивает <strong>$value1</strong> с <strong>$value2</strong>.
  
  Выбрасывание исключений в методе SplHeap::compare может нарушить целостность кучи и перевести её в
  заблокированное состояние. Разблокировать кучу можно методом SplHeap::recoverFromCorruption.
  Однако, некоторые элементы могут быть помещены некорректно, что нарушит сортировку внутри кучи.

<comment>Param:</comment>
  <info>mixed</info>  <strong>$value1</strong>  Значение первого сравниваемого узла.
  <info>mixed</info>  <strong>$value2</strong>  Значение второго сравниваемого узла.

<comment>Return:</comment>
  <info>int</info>  Метод должен возвращать положительное значение, когда <strong>$value1</strong> больше <strong>$value2</strong>, 0 если они
       равны, и отрицательное в остальных случаях.
       
       Помещению в кучу одинаковых элементов нежелательно, так как невозможно будет отследить точное
       положение конкретного элемента.


id: SplHeap::count
type: function
doc:
<comment>Description:</comment>
  Определяет количество элементов в куче

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


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

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


id: SplHeap::extract
type: function
doc:
<comment>Description:</comment>
  Извлекает узел из кучи и пересортирует её

<comment>Return:</comment>
  <info>mixed</info>  Значение извлечённого узла.


id: SplHeap::insert
type: function
doc:
<comment>Description:</comment>
  Вставляет элемент в кучу и пересортирует её
    
  
  Вставляет <strong>$value</strong> в кучу.

<comment>Param:</comment>
  <info>mixed</info>  <strong>$value</strong>  Значение, которое требуется вставить.

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


id: SplHeap::isCorrupted
type: function
doc:
<comment>Description:</comment>
  Указывает, находится ли куча в повреждённом состоянии

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


id: SplHeap::isEmpty
type: function
doc:
<comment>Description:</comment>
  Проверка, пуста ли куча

<comment>Return:</comment>
  <info>bool</info>  Определяет, есть ли в куче элементы.


id: SplHeap::key
type: function
doc:
<comment>Description:</comment>
  Возвращает индекс текущего узла
    
  
  Возвращает индекс текущего узла.

<comment>Return:</comment>
  <info>int</info>  Индекс текущего узла.


id: SplHeap::next
type: function
doc:
<comment>Description:</comment>
  Переход к следующему узлу
    
  
  Переход к следующему узлу. Также удалит узел на вершине кучи.

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


id: SplHeap::recoverFromCorruption
type: function
doc:
<comment>Description:</comment>
  Восстанавливает корректное состояние кучи

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


id: SplHeap::rewind
type: function
doc:
<comment>Description:</comment>
  Перевод итератора на начало
    
  
  Метод переводит итератор на начало кучи. На самом деле итератор является виртуальным и никуда не
  двигается с вершины кучи. Так что никаких операций над данными этот метод не совершает.

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


id: SplHeap::top
type: function
doc:
<comment>Description:</comment>
  Возвращает узел, находящийся на вершине кучи

<comment>Return:</comment>
  <info>mixed</info>  Узел, находящийся на вершине кучи.


id: SplHeap::valid
type: function
doc:
<comment>Description:</comment>
  Проверяет, содержит ли куча ещё элементы
    
  
  Проверяет, содержит ли куча ещё элементы.

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


id: SplMaxHeap
type: class
doc:
<comment>Description:</comment>
  Класс SplMaxHeap предоставляет основные функциональные возможности кучи, сохраняя максимальный
  элемент наверху.


id: SplMaxHeap::compare
type: function
doc:
<comment>Description:</comment>
  Сравнивает элементы, чтобы во время сортировки корректно разместить их в куче
  
  Сравнивает <strong>$value1</strong> с <strong>$value2</strong>.

<comment>Param:</comment>
  <info>mixed</info>  <strong>$value1</strong>  Значение первого сравниваемого узла.
  <info>mixed</info>  <strong>$value2</strong>  Значение второго сравниваемого узла.

<comment>Return:</comment>
  <info>int</info>  Метод возвращает положительное значение, когда <strong>$value1</strong> больше <strong>$value2</strong>, 0 если они равны, и
       отрицательное в остальных случаях.
       
       Наличие нескольких элементов с одинаковым значением в куче не рекомендуется, так как
       невозможно будет отследить точное положение конкретного элемента.


id: SplMinHeap
type: class
doc:
<comment>Description:</comment>
  Класс SplMinHeap предоставляет основные функциональные возможности кучи, сохраняя минимальный
  элемент наверху.


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


id: SplObjectStorage::addAll
type: function
doc:
<comment>Description:</comment>
  Добавляет все объекты из другого контейнера
    
  
  Добавляет все пары объект-данные из другого контейнера в текущий.

<comment>Param:</comment>
  <info>SplObjectStorage</info>  <strong>$storage</strong>  Контейнер объектов, из которого требуется импортировать данные.

<comment>Return:</comment>
  <info>int</info>  Количество объектов в хранилище.

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


id: SplObjectStorage::attach
type: function
doc:
<comment>Description:</comment>
  Добавляет объект в контейнер
    
  
  Добавляет объект <info>object</info> в контейнер и дополнительно может ассоциировать этот объект с какими-то
  данными.

<comment>Param:</comment>
  <info>object</info>  <strong>$object</strong>  Добавляемый объект <info>object</info>.
  <info>mixed</info>   <strong>$info</strong>    Данные, с которыми требуется ассоциировать объект <info>object</info>.

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

<comment>See Also:</comment>
   * SplObjectStorage::detach
   * SplObjectStorage::offsetSet


id: SplObjectStorage::contains
type: function
doc:
<comment>Description:</comment>
  Проверяет, содержит ли контейнер заданный объект
    
  
  Проверяет, содержит ли контейнер заданный объект <info>object</info>.

<comment>Param:</comment>
  <info>object</info>  <strong>$object</strong>  Искомый объект <info>object</info>.

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

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


id: SplObjectStorage::count
type: function
doc:
<comment>Description:</comment>
  Возвращает количество объектов в контейнере
    
  
  Производит подсчёт объектов в контейнере.

<comment>Param:</comment>
  <info>int</info>  <strong>$mode</strong>  Если для необязательного параметра <strong>$mode</strong> задано значение <info>COUNT_RECURSIVE</info> (или 1),
              <strong>SplObjectStorage::count()</strong> будет рекурсивно подсчитывать объём хранилища.

<comment>Return:</comment>
  <info>int</info>  Количество объектов в контейнере.

<comment>See Also:</comment>
   * SplObjectStorage::attach
   * SplObjectStorage::detach


id: SplObjectStorage::current
type: function
doc:
<comment>Description:</comment>
  Возвращает текущий объект
    
  
  Возвращает текущий объект.

<comment>Return:</comment>
  <info>object</info>  Объект (<info>object</info>) на который указывает итератор контейнера.

<comment>See Also:</comment>
   * SplObjectStorage::rewind
   * SplObjectStorage::key
   * SplObjectStorage::next
   * SplObjectStorage::valid
   * SplObjectStorage::getInfo


id: SplObjectStorage::detach
type: function
doc:
<comment>Description:</comment>
  Удаляет объект object из контейнера
    
  
  Удаляет объект <info>object</info> из контейнера.

<comment>Param:</comment>
  <info>object</info>  <strong>$object</strong>  Удаляемый объект <info>object</info>.

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

<comment>See Also:</comment>
   * SplObjectStorage::attach
   * SplObjectStorage::removeAll


id: SplObjectStorage::getHash
type: function
doc:
<comment>Description:</comment>
  Вычисляет уникальный идентификатор для объектов контейнера
    
  
  Метод вычисляет уникальный идентификатор для объектов, добавляемых в контейнер <class>SplObjectStorage</class>.
  
  Реализация <class>SplObjectStorage</class> возвращает то же значение, что и функция <strong>spl_object_hash()</strong>.
  
  В одном контейнере никогда не появится двух объектов с одинаковыми идентификаторами. Таким
  образом, с помощью контейнера можно реализовать множество (коллекцию значений, каждое из которых
  представлено в единственном экземпляре), в котором уникальность объектов будет определяться этим
  идентификатором.

<comment>Param:</comment>
  <info>object</info>  <strong>$object</strong>  Объект, чей идентификатор требуется вычислить.

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

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


id: SplObjectStorage::getInfo
type: function
doc:
<comment>Description:</comment>
  Возвращает данные, ассоциированные с текущим объектом
    
  
  Возвращает данные, ассоциированные с объектом на который указывает итератор.

<comment>Return:</comment>
  <info>mixed</info>  Данные, ассоциированные с объектом.

<comment>See Also:</comment>
   * SplObjectStorage::current
   * SplObjectStorage::rewind
   * SplObjectStorage::key
   * SplObjectStorage::next
   * SplObjectStorage::valid
   * SplObjectStorage::setInfo


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

<comment>Return:</comment>
  <info>int</info>  Индекс текущего положения итератора.

<comment>See Also:</comment>
   * SplObjectStorage::rewind
   * SplObjectStorage::current
   * SplObjectStorage::next
   * SplObjectStorage::valid


id: SplObjectStorage::next
type: function
doc:
<comment>Description:</comment>
  Переход к следующему объекту
  
  Перемещает итератор на следующий объект <info>object</info> в контейнере.

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

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


id: SplObjectStorage::offsetExists
type: function
doc:
<comment>Description:</comment>
  Проверяет, существует ли объект в контейнере
    
  
  Проверяет, существует ли объект <info>object</info> в контейнере.
  
  SplObjectStorage::offsetExists является псевдонимом метода SplObjectStorage::contains.

<comment>Param:</comment>
  <info>object</info>  <strong>$object</strong>  Искомый объект <info>object</info>.

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

<comment>See Also:</comment>
   * SplObjectStorage::offsetSet
   * SplObjectStorage::offsetGet
   * SplObjectStorage::offsetUnset


id: SplObjectStorage::offsetGet
type: function
doc:
<comment>Description:</comment>
  Возвращает данные, ассоциированные с объектом object
    
  
  Возвращает данные, ассоциированные с объектом <info>object</info>.

<comment>Param:</comment>
  <info>object</info>  <strong>$object</strong>  Искомый объект <info>object</info>.

<comment>Return:</comment>
  <info>mixed</info>  Данные, ассоциированные с объектом <info>object</info>.

<comment>See Also:</comment>
   * SplObjectStorage::offsetSet
   * SplObjectStorage::offsetExists
   * SplObjectStorage::offsetUnset


id: SplObjectStorage::offsetSet
type: function
doc:
<comment>Description:</comment>
  Ассоциирует данные с объектом в контейнере
    
  
  Ассоциирует данные с объектом <info>object</info> в контейнере.
  
  SplObjectStorage::offsetSet является псевдонимом метода SplObjectStorage::attach.

<comment>Param:</comment>
  <info>object</info>  <strong>$object</strong>  Объект <info>object</info> с которым требуется связать данные.
  <info>mixed</info>   <strong>$info</strong>    Данные, которые требуется связать с объектом <info>object</info>.

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

<comment>See Also:</comment>
   * SplObjectStorage::attach
   * SplObjectStorage::offsetGet
   * SplObjectStorage::offsetExists
   * SplObjectStorage::offsetUnset


id: SplObjectStorage::offsetUnset
type: function
doc:
<comment>Description:</comment>
  Удаляет объект из контейнера
    
  
  Удаляет объект <info>object</info> из контейнера.
  
  SplObjectStorage::offsetUnset является псевдонимом метода SplObjectStorage::detach.

<comment>Param:</comment>
  <info>object</info>  <strong>$object</strong>  Удаляемый объект <info>object</info>.

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

<comment>See Also:</comment>
   * SplObjectStorage::offsetGet
   * SplObjectStorage::offsetSet
   * SplObjectStorage::offsetExists


id: SplObjectStorage::removeAll
type: function
doc:
<comment>Description:</comment>
  Удаляет из текущего контейнера объекты, которые есть в другом контейнере
    
  
  Удаляет из текущего контейнера объекты, которые есть в другом контейнере.

<comment>Param:</comment>
  <info>SplObjectStorage</info>  <strong>$storage</strong>  Контейнер, содержащий элементы, которые требуется удалить.

<comment>Return:</comment>
  <info>int</info>  Возвращает количество оставшихся объектов.

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


id: SplObjectStorage::removeAllExcept
type: function
doc:
<comment>Description:</comment>
  Удаляет из текущего контейнера все объекты, которых нет в другом контейнере
    
  
  Удаляет из текущего контейнера все объекты, которых нет в другом контейнере.

<comment>Param:</comment>
  <info>SplObjectStorage</info>  <strong>$storage</strong>  Контейнер, содержащий элементы, которые должны остаться в текущем
                              контейнере.

<comment>Return:</comment>
  <info>int</info>  Возвращает количество оставшихся объектов.


id: SplObjectStorage::rewind
type: function
doc:
<comment>Description:</comment>
  Переводит итератор на первый элемент контейнера
    
  
  Переводит итератор на первый элемент контейнера.

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

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


id: SplObjectStorage::serialize
type: function
doc:
<comment>Description:</comment>
  Сериализует контейнер
    
  
  Возвращает строковое представление контейнера.

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

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


id: SplObjectStorage::setInfo
type: function
doc:
<comment>Description:</comment>
  Ассоциирует данные с текущим объектом контейнера
    
  
  Ассоциирует данные с текущим объектом контейнера на который указывает итератор.

<comment>Param:</comment>
  <info>mixed</info>  <strong>$info</strong>  Данные, которые требуется связать с текущим объектом.

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

<comment>See Also:</comment>
   * SplObjectStorage::current
   * SplObjectStorage::rewind
   * SplObjectStorage::key
   * SplObjectStorage::next
   * SplObjectStorage::valid
   * SplObjectStorage::getInfo


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

<comment>Param:</comment>
  <info>string</info>  <strong>$data</strong>  Сериализованное представление контейнера.

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

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


id: SplObjectStorage::valid
type: function
doc:
<comment>Description:</comment>
  Определяет, допустимо ли текущее значение итератора
    
  
  Определяет, допустимо ли текущее значение итератора, то есть возможна ли работа с этим объектом.

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

<comment>See Also:</comment>
   * SplObjectStorage::current
   * SplObjectStorage::getInfo


id: SplObserver
type: class
doc:
<comment>Description:</comment>
  Интерфейс <class>SplObserver</class> используется совместно с <class>SplSubject</class> для реализации шаблона проектирования
  Наблюдатель (Observer).


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

<comment>Param:</comment>
  <info>SplSubject</info>  <strong>$subject</strong>  <class>SplSubject</class>, уведомляющий наблюдателя об обновлении.

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


id: SplPriorityQueue
type: class
doc:
<comment>Description:</comment>
  Класс SplPriorityQueue обеспечивает основные функциональные возможности приоритетной очереди,
  реализованный при помощи кучи с максимальным элементом наверху (max-heap).
  
  Порядок элементов с одинаковым приоритетом не определён. Он может отличаться от порядка, в котором
  элементы были вставлены.


id: SplPriorityQueue::compare
type: function
doc:
<comment>Description:</comment>
  Сравнивает приоритеты для корректного помещения элементов в очередь
    
  
  Сравнивает <strong>$priority1</strong> с <strong>$priority2</strong>.

<comment>Param:</comment>
  <info>mixed</info>  <strong>$priority1</strong>  Приоритет первого узла.
  <info>mixed</info>  <strong>$priority2</strong>  Приоритет второго узла.

<comment>Return:</comment>
  <info>int</info>  Результат сравнения, положительное число, когда <strong>$priority1</strong> больше <strong>$priority2</strong>, 0 если они
       равны, и отрицательное число в остальных случаях.
       
       При добавлении нескольких элементов с одинаковым приоритетом точный порядок следования этих
       элементов в очереди не определён.


id: SplPriorityQueue::count
type: function
doc:
<comment>Description:</comment>
  Производит подсчёт элементов в очереди

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


id: SplPriorityQueue::current
type: function
doc:
<comment>Description:</comment>
  Возвращает текущий узел, на который указывает итератор
    
  
  Возвращает структуру данных текущего узла.

<comment>Return:</comment>
  <info>mixed</info>  Значение или приоритет (или и то, и другое) текущего узла в зависимости от заданного флага.


id: SplPriorityQueue::extract
type: function
doc:
<comment>Description:</comment>
  Извлекает узел из начала очереди и пересортирует её

<comment>Return:</comment>
  <info>mixed</info>  Значение или приоритет (или и то, и другое) текущего узла в зависимости от заданного флага.


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

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


id: SplPriorityQueue::insert
type: function
doc:
<comment>Description:</comment>
  Добавляет элемент в очередь и пересортирует её
  
  Добавляет значение <strong>$value</strong> с приоритетом <strong>$priority</strong> в очередь.

<comment>Param:</comment>
  <info>mixed</info>  <strong>$value</strong>     Добавляемое значение.
  <info>mixed</info>  <strong>$priority</strong>  Приоритет значения.

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


id: SplPriorityQueue::isCorrupted
type: function
doc:
<comment>Description:</comment>
  Указывает, находится ли приоритетная очередь в повреждённом состоянии

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


id: SplPriorityQueue::isEmpty
type: function
doc:
<comment>Description:</comment>
  Проверяет, является ли очередь пустой

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


id: SplPriorityQueue::next
type: function
doc:
<comment>Description:</comment>
  Переход к следующему узлу
  
  Переводит итератор на следующий узел.

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


id: SplPriorityQueue::recoverFromCorruption
type: function
doc:
<comment>Description:</comment>
  Восстанавливает корректное состояние очереди

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


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

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


id: SplPriorityQueue::setExtractFlags
type: function
doc:
<comment>Description:</comment>
  Задаёт режим извлечения узлов

<comment>Param:</comment>
  <info>int</info>  <strong>$flags</strong>  Определяет, что будет извлекаться методами SplPriorityQueue::current,
               SplPriorityQueue::top и SplPriorityQueue::extract.
               
               <info>SplPriorityQueue::EXTR_DATA</info> (0x00000001): Извлекать данные
               
               <info>SplPriorityQueue::EXTR_PRIORITY</info> (0x00000002): Извлекать приоритет
               
               <info>SplPriorityQueue::EXTR_BOTH</info> (0x00000003): Извлекать данные и приоритет в виде массива
               
               По умолчанию работает режим <info>SplPriorityQueue::EXTR_DATA</info>.

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


id: SplPriorityQueue::top
type: function
doc:
<comment>Description:</comment>
  Возвращает узел, находящийся в начале очереди

<comment>Return:</comment>
  <info>mixed</info>  Значение или приоритет узла (или и то, и другое) в зависимости от установленного флага.


id: SplPriorityQueue::valid
type: function
doc:
<comment>Description:</comment>
  Проверяет, есть ли в очереди ещё элементы
    
  
  Проверяет, есть ли в очереди ещё элементы.

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


id: SplQueue
type: class
doc:
<comment>Description:</comment>
  Класс SplQueue предоставляет основные функциональные возможности очереди, реализованной с
  использованием двусвязного списка, установив режим итератора <info>SplDoublyLinkedList::IT_MODE_FIFO</info>.


id: SplQueue::dequeue
type: function
doc:
<comment>Description:</comment>
  Удаляет элемент из очереди
  
  Удаляет <strong>$value</strong> из начала очереди.
  
  SplQueue::dequeue - псевдоним SplDoublyLinkedList::shift.

<comment>Return:</comment>
  <info>mixed</info>  Значение удалённого из очереди элемента.


id: SplQueue::enqueue
type: function
doc:
<comment>Description:</comment>
  Добавляет элемент в очередь
  
  Добавляет <strong>$value</strong> в конец очереди.
  
  SplQueue::enqueue - псевдоним SplDoublyLinkedList::push.

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

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


id: SplStack
type: class
doc:
<comment>Description:</comment>
  Класс SplStack предоставляет основные функциональные возможности стека, реализованные с
  использованием двусвязного списка, установив режим итератора <info>SplDoublyLinkedList::IT_MODE_LIFO</info>.


id: SplSubject
type: class
doc:
<comment>Description:</comment>
  Интерфейс <class>SplSubject</class> используется совместно с <class>SplObserver</class> для реализации шаблона проектирования
  Наблюдатель (Observer).


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

<comment>Param:</comment>
  <info>SplObserver</info>  <strong>$observer</strong>  Объект класса <class>SplObserver</class> для присоединения.

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


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

<comment>Param:</comment>
  <info>SplObserver</info>  <strong>$observer</strong>  Объект класса <class>SplObserver</class> для отсоединения.

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


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

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


id: SplTempFileObject
type: class
doc:
<comment>Description:</comment>
  Класс SplTempFileObject предлагает объектно-ориентированный интерфейс для работы с временным
  файлом.


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

<comment>Param:</comment>
  <info>int</info>  <strong>$maxMemory</strong>  Максимальный объем памяти (в байтах, по умолчанию равен 2 МБ) для временного
                   файла. Если временный файл превысит этот размер, он будет перемещён в файл в
                   системной папке временных файлов.
                   
                   Если значение <strong>$maxMemory</strong> отрицательное, будет использоваться только память. Если
                   значение <strong>$maxMemory</strong> равно нулю, то память не будет использоваться.

<comment>See Also:</comment>
   * <class>SplFileObject</class>
   * потоки ввода-вывода PHP
     (для<return>php://temp</return> и <return>php://memory</return>)
    


id: Spoofchecker
type: class
doc:
<comment>Description:</comment>
  Этот класс существует потому, что Unicode содержит большое количество символов и включает в себя
  различные системы письма со всего мира и их некорректное использование может сделать программы и
  системы уязвимыми к хакерским атакам, использующим сходство символов.
  
  Предоставляемые методы позволяют проверить строку на предмет попыток обмануть пользователя (<return>spoof
  detection</return>), например, вставить в слово "pаypаl" кириллический символ 'а'.


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

<comment>Param:</comment>
  <info>string</info>  <strong>$string1</strong>    Первая строка.
  <info>string</info>  <strong>$string2</strong>    Вторая строка.
  <info>int</info>     <strong>$errorCode</strong>  Этот параметр передаётся по ссылке и заполняется целым числом (<info>int</info>),
                      содержащим ошибку, если таковая есть.

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


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

<comment>Param:</comment>
  <info>string</info>  <strong>$string</strong>     Строка для проверки.
  <info>int</info>     <strong>$errorCode</strong>  Этот параметр передаётся по ссылке и заполняется целым числом (<info>int</info>),
                      содержащим ошибку, если таковая есть.

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


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

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

<comment>Return:</comment>
  <info>void</info>  


id: Spoofchecker::setChecks
type: function
doc:
<comment>Description:</comment>
  Установить набор проверок
  
  Устанавливает проверки, которые будут выполняться методом SpoofChecker::isSuspicious.

<comment>Param:</comment>
  <info>int</info>  <strong>$checks</strong>  Проверки, которые будут выполняться методом SpoofChecker::isSuspicious. Битовая
                маска, состоящая из констант <info>Spoofchecker::SINGLE_SCRIPT_CONFUSABLE</info>,
                <info>Spoofchecker::MIXED_SCRIPT_CONFUSABLE</info>, <info>Spoofchecker::WHOLE_SCRIPT_CONFUSABLE</info>,
                <info>Spoofchecker::ANY_CASE</info>, <info>Spoofchecker::SINGLE_SCRIPT</info>, <info>Spoofchecker::INVISIBLE</info> или
                <info>Spoofchecker::CHAR_LIMIT</info>. По умолчанию все проверки, начиная с ICU 58; до этой
                версии константа <info>Spoofchecker::SINGLE_SCRIPT</info> была исключена.

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


id: Spoofchecker::setRestrictionLevel
type: function
doc:
<comment>Description:</comment>
  Set the restriction level
  
  Sets the restriction level of SpoofChecker::isSuspicious.

<comment>Param:</comment>
  <info>int</info>  <strong>$level</strong>  The restriction level of SpoofChecker::isSuspicious. One of <info>Spoofchecker::ASCII</info>,
               <info>Spoofchecker::SINGLE_SCRIPT_RESTRICTIVE</info>, <info>Spoofchecker::HIGHLY_RESTRICTIVE</info>,
               <info>Spoofchecker::MODERATELY_RESTRICTIVE</info>, <info>Spoofchecker::MINIMALLY_RESTRICTIVE</info>, or
               <info>Spoofchecker::UNRESTRICTIVE</info>. Defaults to <info>Spoofchecker::HIGHLY_RESTRICTIVE</info>.

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


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


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

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

<comment>Return:</comment>
  <info>mysql_xdevapi\SqlStatement</info>  


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

<comment>Return:</comment>
  <info>mysql_xdevapi\Result</info>  


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

<comment>Return:</comment>
  <info>mysql_xdevapi\Result</info>  


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

<comment>Return:</comment>
  <info>mysql_xdevapi\Result</info>  


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

<comment>Return:</comment>
  <info>bool</info>  <info>true</info>, если в наборе результатов есть больше объектов для выборки.


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

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


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

<comment>Return:</comment>
  <info>array</info>  Результат, как ассоциативный массив. В случае отсутствия результата возвращается ноль.


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

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


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

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


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

<comment>Return:</comment>
  <info>Array</info>  


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

<comment>Return:</comment>
  <info>int</info>  Количество столбцов; 0 если их нет


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

<comment>Return:</comment>
  <info>array</info>  Массив сгенерированных _id из последней операции или пустой массив, если таковых нет.


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

<comment>Return:</comment>
  <info>String</info>  Идентификатор последней операции вставки.


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

<comment>Return:</comment>
  <info>array</info>  Массив объектов Warning из последней операции. Каждый объект определяет 'message' об
         ошибке, 'level' ошибки и 'code' ошибки. Пустой массив возвращается, если ошибок нет.


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

<comment>Return:</comment>
  <info>int</info>  Количество предупреждений, выданных во время последней операции CRUD.


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

<comment>Return:</comment>
  <info>bool</info>  <info>true</info>, если в наборе результатов есть данные.


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

<comment>Return:</comment>
  <info>mysql_xdevapi\Result</info>  Следующий объект Result из набора результатов.


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

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


id: Stomp
type: class
doc:
<comment>Description:</comment>
  Представляет связь между PHP и Stomp совместимым брокером сообщений (Message Broker).


id: Stomp::__construct
type: function
doc:
<comment>Description:</comment>
  Открывает соединение
  
  Объектно-ориентированный стиль (конструктор):
  
  Процедурный стиль:
  
  Открывает соединение к Stomp-совместимому брокеру сообщений (Message Broker).

<comment>Param:</comment>
  <info>string</info>  <strong>$broker</strong>    URI брокера
  <info>string</info>  <strong>$username</strong>  Имя пользователя
  <info>string</info>  <strong>$password</strong>  Пароль
  <info>array</info>   <strong>$headers</strong>   Ассоциативный массив, содержащий дополнительные заголовки (пример: receipt).

<comment>Return:</comment>
  <info>resource</info>  Также может быть указан заголовок транзакции, означающий что приём сообщения должен
            являться частью именованной транзакции.


id: Stomp::__destruct
type: function
doc:
<comment>Description:</comment>
  Закрывает Stomp-соединение
  
  Объектно-ориентированный стиль (деструктор):
  
  Процедурный стиль:
  
  Закрывает ранее открытые соединения.

<comment>Param:</comment>
  <info>resource</info>  <strong>$link</strong>  Только для процедурного стиля: идентификатор соединения stomp, полученный из
                   <strong>stomp_connect()</strong>.

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


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

<comment>Param:</comment>
  <info>resource</info>  <strong>$link</strong>            Только для процедурного стиля: идентификатор соединения stomp,
                             полученный из <strong>stomp_connect()</strong>.
  <info>string</info>    <strong>$transaction_id</strong>  Транзакция, которую нужно прервать.
  <info>array</info>     <strong>$headers</strong>         Ассоциативный массив, содержащий дополнительные заголовки (пример:
                             receipt).

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


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

<comment>Param:</comment>
  <info>resource</info>  <strong>$link</strong>     Только для процедурного стиля: идентификатор соединения stomp, полученный из
                      <strong>stomp_connect()</strong>.
  <info>mixed</info>     <strong>$msg</strong>      Сообщение/идентификатор сообщения, получение которого должно быть
                      подтверждено.
  <info>array</info>     <strong>$headers</strong>  Ассоциативный массив, содержащий дополнительные заголовки (пример: receipt).

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


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

<comment>Param:</comment>
  <info>resource</info>  <strong>$link</strong>            Только для процедурного стиля: идентификатор соединения stomp,
                             полученный из <strong>stomp_connect()</strong>.
  <info>string</info>    <strong>$transaction_id</strong>  Идентификатор транзакции.
  <info>array</info>     <strong>$headers</strong>         Ассоциативный массив, содержащий дополнительные заголовки (пример:
                             receipt).

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


id: Stomp::commit
type: function
doc:
<comment>Description:</comment>
  Выполняет текущую транзакцию
  
  Объектно-ориентированный стиль (метод):
  
  Процедурный стиль:
  
  Выполняет текущую транзакцию.

<comment>Param:</comment>
  <info>resource</info>  <strong>$link</strong>            Только для процедурного стиля: идентификатор соединения stomp,
                             полученный из <strong>stomp_connect()</strong>.
  <info>string</info>    <strong>$transaction_id</strong>  Идентификатор транзакции.
  <info>array</info>     <strong>$headers</strong>         Ассоциативный массив, содержащий дополнительные заголовки (пример:
                             receipt).

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


id: Stomp::error
type: function
doc:
<comment>Description:</comment>
  Возвращает последнюю ошибку Stomp
  
  Объектно-ориентированный стиль (метод):
  
  Процедурный стиль:
  
  Возвращает последнюю ошибку Stomp.

<comment>Param:</comment>
  <info>resource</info>  <strong>$link</strong>  Только для процедурного стиля: идентификатор соединения stomp, полученный из
                   <strong>stomp_connect()</strong>.

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


id: Stomp::getReadTimeout
type: function
doc:
<comment>Description:</comment>
  Возвращает время максимального ожидания операции чтения
  
  Объектно-ориентированный стиль (метод):
  
  Процедурный стиль:
  
  Возвращает время максимального ожидания операции чтения

<comment>Param:</comment>
  <info>resource</info>  <strong>$link</strong>  Только для процедурного стиля: идентификатор соединения stomp, полученный из
                   <strong>stomp_connect()</strong>.

<comment>Return:</comment>
  <info>array</info>  Возвращает массив с 2 элементами: sec и usec.


id: Stomp::getSessionId
type: function
doc:
<comment>Description:</comment>
  Возвращает идентификатор текущей сессии Stomp
  
  Объектно-ориентированный стиль (метод):
  
  Процедурный стиль:
  
  Возвращает идентификатор текущей сессии Stomp.

<comment>Param:</comment>
  <info>resource</info>  <strong>$link</strong>  Только для процедурного стиля: идентификатор соединения stomp, полученный из
                   <strong>stomp_connect()</strong>.

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


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

<comment>Param:</comment>
  <info>resource</info>  <strong>$link</strong>  Только для процедурного стиля: идентификатор соединения stomp, полученный из
                   <strong>stomp_connect()</strong>.

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


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

<comment>Param:</comment>
  <info>resource</info>  <strong>$link</strong>        Только для процедурного стиля: идентификатор соединения stomp, полученный
                         из <strong>stomp_connect()</strong>.
  <info>string</info>    <strong>$class_name</strong>  Имя класса для создания экземпляра. Если не указан, возвращается объект
                         stompFrame.

<comment>Return:</comment>
  <info>stompframe</info>  Также может быть указан заголовок транзакции, означающий что приём сообщения должен
              являться частью именованной транзакции.


id: Stomp::send
type: function
doc:
<comment>Description:</comment>
  Отправляет сообщение
  
  Объектно-ориентированный стиль (метод):
  
  Процедурный стиль:
  
  Отправляет сообщение брокеру сообщений (Message Broker).

<comment>Param:</comment>
  <info>resource</info>  <strong>$link</strong>         Только для процедурного стиля: идентификатор соединения stomp, полученный
                          из <strong>stomp_connect()</strong>.
  <info>string</info>    <strong>$destination</strong>  Назначение для отправки сообщения.
  <info>mixed</info>     <strong>$msg</strong>          Сообщение для отправки.
  <info>array</info>     <strong>$headers</strong>      Ассоциативный массив, содержащий дополнительные заголовки (пример:
                          receipt).

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


id: Stomp::setReadTimeout
type: function
doc:
<comment>Description:</comment>
  Устанавливает предельное время ожидания операции чтения
  
  Объектно-ориентированный стиль (метод):
  
  Процедурный стиль:
  
  Устанавливает предельное время ожидания операции чтения.

<comment>Param:</comment>
  <info>resource</info>  <strong>$link</strong>          Только для процедурного стиля: идентификатор соединения stomp, полученный
                           из <strong>stomp_connect()</strong>.
  <info>int</info>       <strong>$seconds</strong>       Секундная часть времени ожидания операции.
  <info>int</info>       <strong>$microseconds</strong>  Микросекундная времени ожидания операции.

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


id: Stomp::subscribe
type: function
doc:
<comment>Description:</comment>
  Регистрирует подписку на указанную рассылку
  
  Объектно-ориентированный стиль (метод):
  
  Процедурный стиль:
  
  Регистрирует подписку на указанную рассылку.

<comment>Param:</comment>
  <info>resource</info>  <strong>$link</strong>         Только для процедурного стиля: идентификатор соединения stomp, полученный
                          из <strong>stomp_connect()</strong>.
  <info>string</info>    <strong>$destination</strong>  Рассылка, на которую необходимо зарегистрировать подписку.
  <info>array</info>     <strong>$headers</strong>      Ассоциативный массив, содержащий дополнительные заголовки (пример:
                          receipt).

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


id: Stomp::unsubscribe
type: function
doc:
<comment>Description:</comment>
  Удаляет существующую подписку
  
  Объектно-ориентированный стиль (метод):
  
  Процедурный стиль:
  
  Удаляет существующую подписку.

<comment>Param:</comment>
  <info>resource</info>  <strong>$link</strong>         Только для процедурного стиля: идентификатор соединения stomp, полученный
                          из <strong>stomp_connect()</strong>.
  <info>string</info>    <strong>$destination</strong>  Подписка для удаления.
  <info>array</info>     <strong>$headers</strong>      Ассоциативный массив, содержащий дополнительные заголовки (пример:
                          receipt).

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


id: StompException
type: class
doc:
<comment>Description:</comment>
  Представляет ошибку, вызванную модулем Stomp. Смотрите Исключения для получения подробной
  информации об исключениях в PHP.


id: StompException::getDetails
type: function
doc:
<comment>Description:</comment>
  Возвращает сведения об исключении
  
  Получает сведения об исключении.

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


id: StompFrame
type: class
doc:
<comment>Description:</comment>
  Представляет сообщение, которое было отправлено или получено от Stomp-совместимого брокера
  сообщений (Message Broker).


id: StompFrame::__construct
type: function
doc:
<comment>Description:</comment>
  Конструктор
  
  Конструктор.

<comment>Param:</comment>
  <info>string</info>  <strong>$command</strong>  Команда фрейма.
  <info>array</info>   <strong>$headers</strong>  Заголовки фрейма (<info>array</info>).
  <info>string</info>  <strong>$body</strong>     Тело фрейма.


id: Stringable
type: class
doc:
<comment>Description:</comment>
  Интерфейс Stringable обозначает класс, реализующий метод __toString(). В отличие от большинства
  интерфейсов, Stringable неявно присутствует в любом классе, в котором определён магический метод
  __toString(), хотя он может и должен быть объявлен явно.
  
  Его основное значение - разрешить функциям выполнять проверку типа на соответствие типу union
  <return>string|Stringable</return>, чтобы принимать либо строковый примитив, либо объект, который может быть
  преобразован в строку.


id: Stringable::__toString
type: function
doc:
<comment>Description:</comment>
  Получает строковое представление объекта

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

<comment>See Also:</comment>
   * __toString()


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

<comment>Param:</comment>
  <info>string</info>    <strong>$hostname</strong>  Имя хоста.
  <info>callable</info>  <strong>$callback</strong>  Имя хоста.
                       
                       IP-адрес.
  <info>string</info>    <strong>$hostname</strong>  Имя хоста.
  <info></info>          <strong>$IP</strong>        IP-адрес.

<comment>Return:</comment>
  <info>void</info>  


id: Swoole\Async::read
type: function
doc:
<comment>Description:</comment>
  Асинхронное чтение файлового потока

<comment>Param:</comment>
  <info>string</info>    <strong>$filename</strong>    Название файла.
  <info>callable</info>  <strong>$callback</strong>    Название файла.
                         
                         Содержимое, прочитанное из файлового потока.
  <info>string</info>    <strong>$filename</strong>    Название файла.
  <info>string</info>    <strong>$content</strong>     Содержимое, прочитанное из файлового потока.
  <info>int</info>       <strong>$chunk_size</strong>  Длина части.
  <info>int</info>       <strong>$offset</strong>      Смещение.

<comment>Return:</comment>
  <info>bool</info>  Успешно ли прочитано.


id: Swoole\Async::readFile
type: function
doc:
<comment>Description:</comment>
  Асинхронное чтение файла

<comment>Param:</comment>
  <info>string</info>    <strong>$filename</strong>  Имя читаемого файла.
  <info>callable</info>  <strong>$callback</strong>  Имя читаемого файла.
                       
                       Содержание, прочитанное из файла.
  <info>string</info>    <strong>$filename</strong>  Имя читаемого файла.
  <info>string</info>    <strong>$content</strong>   Содержание, прочитанное из файла.

<comment>Return:</comment>
  <info>void</info>  


id: Swoole\Async::set
type: function
doc:
<comment>Description:</comment>
  Обновляет параметры асинхронного ввода-вывода

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

<comment>Return:</comment>
  <info>void</info>  


id: Swoole\Async::write
type: function
doc:
<comment>Description:</comment>
  Асинхронно записывает данные в файловый поток

<comment>Param:</comment>
  <info>string</info>    <strong>$filename</strong>  Имя файла для записи.
  <info>string</info>    <strong>$content</strong>   Содержание для записи в файл.
  <info>int</info>       <strong>$offset</strong>    Смещение.
  <info>callable</info>  <strong>$callback</strong>  

<comment>Return:</comment>
  <info>void</info>  


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

<comment>Param:</comment>
  <info>string</info>    <strong>$filename</strong>  Имя файла для записи.
  <info>string</info>    <strong>$content</strong>   Содержание для записи в файл.
  <info>callable</info>  <strong>$callback</strong>  
  <info>string</info>    <strong>$flags</strong>     

<comment>Return:</comment>
  <info>void</info>  


id: Swoole\Atomic::__construct
type: function
doc:
<comment>Description:</comment>
  Создаёт атомарный объект swoole
  
  Атомарный объект Swoole - это целочисленная переменная, которая позволяет любому процессору
  атомарно тестировать и модифицировать. Он реализован на основе атомарных инструкций процессора.
  Атомарные переменные Swoole должны быть определены до swoole_server-&gt;start.
  
  Сравнение и замена (CAS) - это атомарная инструкция, используемая в многопоточности для достижения
  синхронизации. Она сравнивает содержимое области памяти с заданным значением и, только если они
  совпадают, изменяет содержимое этой области памяти на новое заданное значение.

<comment>Param:</comment>
  <info>int</info>  <strong>$value</strong>  Значение атомарного объекта.


id: Swoole\Atomic::add
type: function
doc:
<comment>Description:</comment>
  Добавляет число к значению атомарного объекта
  
  Добавляет число к значению атомарного объекта.

<comment>Param:</comment>
  <info>int</info>  <strong>$add_value</strong>  Значение, которое будет добавлено к текущему значению.

<comment>Return:</comment>
  <info>int</info>  Новое значение атомарного объекта.


id: Swoole\Atomic::cmpset
type: function
doc:
<comment>Description:</comment>
  Сравнивает и устанавливает значение атомарного объекта

<comment>Param:</comment>
  <info>int</info>  <strong>$cmp_value</strong>  Значение для сравнения с текущим значением атомарного объекта.
  <info>int</info>  <strong>$new_value</strong>  Значение, устанавливаемое для атомарного объекта, если значение cmp_value
                   совпадает с текущим значением атомарного объекта.

<comment>Return:</comment>
  <info>int</info>  Новое значение атомарного объекта.


id: Swoole\Atomic::get
type: function
doc:
<comment>Description:</comment>
  Получает текущее значение атомарного объекта
  
  Получает текущее значение атомарного объекта.

<comment>Return:</comment>
  <info>int</info>  Текущее значение атомарного объекта.


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

<comment>Param:</comment>
  <info>int</info>  <strong>$value</strong>  Значение, устанавливаемое для атомарного объекта.

<comment>Return:</comment>
  <info>int</info>  Текущее значение атомарного объекта.


id: Swoole\Atomic::sub
type: function
doc:
<comment>Description:</comment>
  Вычитает число из значения атомарного объекта
  
  Вычитает число из значения атомарного объекта.

<comment>Param:</comment>
  <info>int</info>  <strong>$sub_value</strong>  Значение, которое будет вычтено из текущего значения.

<comment>Return:</comment>
  <info>int</info>  Текущее значение атомарного объекта.


id: Swoole\Buffer::__construct
type: function
doc:
<comment>Description:</comment>
  Фиксированный размер блока памяти

<comment>Param:</comment>
  <info>int</info>  <strong>$size</strong>  Размер памяти для выделения.


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

<comment>Return:</comment>
  <info>void</info>  


id: Swoole\Buffer::__toString
type: function
doc:
<comment>Description:</comment>
  Получает строковое значение буфера памяти

<comment>Return:</comment>
  <info>string</info>  Строковое значение буфера памяти.


id: Swoole\Buffer::append
type: function
doc:
<comment>Description:</comment>
  Добавляет строку или двоичные данные в конец буфера памяти и возвращает новый размер выделенной
  памяти

<comment>Param:</comment>
  <info>string</info>  <strong>$data</strong>  Строка или двоичные данные, добавляемые в конец буфера памяти.

<comment>Return:</comment>
  <info>int</info>  Новый размер буфера памяти.


id: Swoole\Buffer::clear
type: function
doc:
<comment>Description:</comment>
  Сбрасывает буфер памяти

<comment>Return:</comment>
  <info>void</info>  


id: Swoole\Buffer::expand
type: function
doc:
<comment>Description:</comment>
  Расширяет размер буфера памяти

<comment>Param:</comment>
  <info>int</info>  <strong>$size</strong>  Новый размер буфера памяти.

<comment>Return:</comment>
  <info>int</info>  Новый размер буфера памяти.


id: Swoole\Buffer::read
type: function
doc:
<comment>Description:</comment>
  Читает данные из буфера памяти на основе смещения и длины

<comment>Param:</comment>
  <info>int</info>  <strong>$offset</strong>  Смещение.
  <info>int</info>  <strong>$length</strong>  Длина.

<comment>Return:</comment>
  <info>string</info>  Данные, считанные из буфера памяти.


id: Swoole\Buffer::recycle
type: function
doc:
<comment>Description:</comment>
  Освобождает память для ОС, которая не используется буфером памяти

<comment>Return:</comment>
  <info>void</info>  


id: Swoole\Buffer::substr
type: function
doc:
<comment>Description:</comment>
  Считывает данные из буфера памяти на основе смещения и длины. Или удаляет данные из буфера памяти
  
  Если для $remove установлено значение true, а для $offset установлено значение 0, данные будут
  удалены из буфера. Память для хранения данных будет освобождена при уничтожении объекта буфера.

<comment>Param:</comment>
  <info>int</info>   <strong>$offset</strong>  Смещение.
  <info>int</info>   <strong>$length</strong>  Длина.
  <info>bool</info>  <strong>$remove</strong>  Определяет, удалить ли данные из буфера памяти.

<comment>Return:</comment>
  <info>string</info>  Данные или строка, прочитанные из буфера памяти.


id: Swoole\Buffer::write
type: function
doc:
<comment>Description:</comment>
  Записывает данные в буфер памяти. Память, выделенная для буфера, не будет изменена

<comment>Param:</comment>
  <info>int</info>     <strong>$offset</strong>  Смещение.
  <info>string</info>  <strong>$data</strong>    Данные для записи в буфер памяти.

<comment>Return:</comment>
  <info>void</info>  


id: Swoole\Channel::__construct
type: function
doc:
<comment>Description:</comment>
  Создаёт канал Swoole
  
  Канал Swoole - это структура данных в памяти, которая работает как Chan в Golang, реализована на
  основе разделяемой памяти и мьютексов. Может использоваться как высокопроизводительная очередь
  сообщений в памяти. Создание канала Swoole с фиксированным размером. Минимальный размер канала
  Swoole составляет 64 КБ. Будут выброшены исключения, если недостаточно памяти.

<comment>Param:</comment>
  <info>string</info>  <strong>$size</strong>  Размер канала Swoole.


id: Swoole\Channel::__destruct
type: function
doc:
<comment>Description:</comment>
  Уничтожает канал Swoole

<comment>Return:</comment>
  <info>void</info>  


id: Swoole\Channel::pop
type: function
doc:
<comment>Description:</comment>
  Читает и извлекает данные из канала Swoole

<comment>Return:</comment>
  <info>mixed</info>  Если канал пуст, функция вернёт false или несериализованные данные.


id: Swoole\Channel::push
type: function
doc:
<comment>Description:</comment>
  Записывает и передаёт данные в канал Swoole
  
  Данные могут быть любой непустой переменной PHP, переменная будет сериализована, если она не
  является строковым типом.
  
  Если размер данных превышает 8 КБ, канал Swoole будет использовать временные хранилища файлов.
  
  Функция вернёт true, если операция записи выполнена успешно или false, если недостаточно места.

<comment>Param:</comment>
  <info>string</info>  <strong>$data</strong>  Данные для вставки в канал Swoole.

<comment>Return:</comment>
  <info>bool</info>  Передались ли данные в канал Swoole.


id: Swoole\Channel::stats
type: function
doc:
<comment>Description:</comment>
  Получает статистику канала Swoole
  
  Получает количество элементов в очереди и общий объем памяти, используемой в очереди.

<comment>Return:</comment>
  <info>array</info>  Статистика канала Swoole.


id: Swoole\Client::__construct
type: function
doc:
<comment>Description:</comment>
  Создаёт синхронный или асинхронный TCP/UDP клиент Swoole с поддержкой SSL или без него

<comment>Param:</comment>
  <info>int</info>  <strong>$sock_type</strong>  Тип сокета: SWOOLE_TCP, SWOOLE_UDP, SWOOLE_ASYNC, SWOOLE_SSL, SWOOLE_KEEP.
  <info>int</info>  <strong>$is_async</strong>   Синхронный или асинхронный клиент.


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

<comment>Return:</comment>
  <info>void</info>  


id: Swoole\Client::close
type: function
doc:
<comment>Description:</comment>
  Закрывает установленное соединение

<comment>Param:</comment>
  <info>bool</info>  <strong>$force</strong>  Определяет, принудительное закрытие соединения.

<comment>Return:</comment>
  <info>bool</info>  Закрыто ли соединение.


id: Swoole\Client::connect
type: function
doc:
<comment>Description:</comment>
  Подключается к удалённому порту TCP или UDP

<comment>Param:</comment>
  <info>string</info>  <strong>$host</strong>     Имя хоста удалённого адреса.
  <info>int</info>     <strong>$port</strong>     Номер порта удалённого адреса.
  <info>int</info>     <strong>$timeout</strong>  Время ожидания (в секундах) соединения/отправки/получения, значение по умолчанию
                    составляет 0,1 с
  <info>int</info>     <strong>$flag</strong>     Если тип клиента - UDP, $flag означает, включена ли конфигурацию udp_connect.
                    Если конфигурация udp_connect включена, клиент будет получать данные только с
                    указанного ip:port. Если тип клиента TCP, а $flag установлен в 1, он должен
                    использовать swoole_client_select для проверки состояния соединения перед
                    отправкой/получением.

<comment>Return:</comment>
  <info>bool</info>  Установлено ли соединение.


id: Swoole\Client::getpeername
type: function
doc:
<comment>Description:</comment>
  Получает имя удалённого сокета соединения

<comment>Return:</comment>
  <info>array</info>  Хост и порт удалённого сокета.


id: Swoole\Client::getsockname
type: function
doc:
<comment>Description:</comment>
  Получает локальное имя сокета соединения

<comment>Return:</comment>
  <info>array</info>  Хост и порт локального сокета.


id: Swoole\Client::isConnected
type: function
doc:
<comment>Description:</comment>
  Проверяет, установлено ли соединение
  
  Метод возвращает состояние соединения прикладного уровня.

<comment>Return:</comment>
  <info>bool</info>  Установлено ли соединение.


id: Swoole\Client::on
type: function
doc:
<comment>Description:</comment>
  Добавляет callback-функции, вызванные событиями

<comment>Param:</comment>
  <info>string</info>    <strong>$event</strong>     
  <info>callable</info>  <strong>$callback</strong>  

<comment>Return:</comment>
  <info>void</info>  


id: Swoole\Client::pause
type: function
doc:
<comment>Description:</comment>
  Приостанавливает получение данных

<comment>Return:</comment>
  <info>void</info>  


id: Swoole\Client::pipe
type: function
doc:
<comment>Description:</comment>
  Перенаправляет данные в другой файловый дескриптор

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

<comment>Return:</comment>
  <info>void</info>  


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

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

<comment>Return:</comment>
  <info>void</info>  


id: Swoole\Client::resume
type: function
doc:
<comment>Description:</comment>
  Возобновляет получение данных

<comment>Return:</comment>
  <info>void</info>  


id: Swoole\Client::send
type: function
doc:
<comment>Description:</comment>
  Отправляет данные в удалённый TCP-сокет

<comment>Param:</comment>
  <info>string</info>  <strong>$data</strong>  Данные для отправки, которые могут быть строковыми или двоичными
  <info>string</info>  <strong>$flag</strong>  

<comment>Return:</comment>
  <info>int</info>  Если клиент успешно отправил данные, он возвращает длину отправленных данных. Или он
       возвращает false и устанавливает $swoole_client-&gt;errCode. Для синхронного клиента нет
       ограничений на отправку данных. Для асинхронного клиента ограничение на отправку данных -
       socket_buffer_size.


id: Swoole\Client::sendfile
type: function
doc:
<comment>Description:</comment>
  Отправляет файл в удалённый TCP-сокет
  
  Является оболочкой системного вызова sendfile в Linux.

<comment>Param:</comment>
  <info>string</info>  <strong>$filename</strong>  Путь к файлу для отправки.
  <info>int</info>     <strong>$offset</strong>    Смещение файла для отправки

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


id: Swoole\Client::sendto
type: function
doc:
<comment>Description:</comment>
  Отправляет данные на удалённый UDP-адрес
  
  Тип клиента swoole должен быть SWOOLE_SOCK_UDP или SWOOLE_SOCK_UDP6.

<comment>Param:</comment>
  <info>string</info>  <strong>$ip</strong>    IP-адрес удалённого хоста, IPv4 или IPv6.
  <info>int</info>     <strong>$port</strong>  Номер порта удалённого хоста.
  <info>string</info>  <strong>$data</strong>  Данные для отправки должны быть меньше 64К.

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


id: Swoole\Client::set
type: function
doc:
<comment>Description:</comment>
  Устанавливает параметры клиента Swoole до установления соединения

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

<comment>Return:</comment>
  <info>void</info>  


id: Swoole\Client::sleep
type: function
doc:
<comment>Description:</comment>
  Удаляет TCP-клиент из цикла системных событий
  
  Удаляет TCP-клиент из цикла системных событий.

<comment>Return:</comment>
  <info>void</info>  


id: Swoole\Client::wakeup
type: function
doc:
<comment>Description:</comment>
  Добавляет TCP-клиент обратно в цикл системных событий

<comment>Return:</comment>
  <info>void</info>  


id: Swoole\Connection\Iterator::count
type: function
doc:
<comment>Description:</comment>
  Считает соединения
  
  Получает количество соединений.

<comment>Return:</comment>
  <info>int</info>  Количество соединений.


id: Swoole\Connection\Iterator::current
type: function
doc:
<comment>Description:</comment>
  Возвращает текущую запись соединения
  
  Получает текущую запись соединения.

<comment>Return:</comment>
  <info>Connection</info>  Текущая запись соединения.


id: Swoole\Connection\Iterator::key
type: function
doc:
<comment>Description:</comment>
  Возвращает ключ текущего соединения
  
  Функция возвращает ключ текущего соединения.

<comment>Return:</comment>
  <info>int</info>  Ключ текущего соединения.


id: Swoole\Connection\Iterator::next
type: function
doc:
<comment>Description:</comment>
  Переходит к следующему соединению
  
  Итератор для следующего соединения.

<comment>Return:</comment>
  <info>Connection</info>  


id: Swoole\Connection\Iterator::offsetExists
type: function
doc:
<comment>Description:</comment>
  Проверяет, существует ли смещение
  
  Проверяет, существует ли смещение.

<comment>Param:</comment>
  <info>int</info>  <strong>$index</strong>  Смещение, которое необходимо проверить.

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


id: Swoole\Connection\Iterator::offsetGet
type: function
doc:
<comment>Description:</comment>
  Смещение для извлечения
  
  Возвращает соединение с указанным смещением.

<comment>Param:</comment>
  <info>string</info>  <strong>$index</strong>  Смещение для извлечения.

<comment>Return:</comment>
  <info>Connection</info>  


id: Swoole\Connection\Iterator::offsetSet
type: function
doc:
<comment>Description:</comment>
  Назначает соединение для указанного смещения
  
  Назначает соединение для указанного смещения.

<comment>Param:</comment>
  <info>int</info>    <strong>$offset</strong>      Смещение для которого назначить соединение.
  <info>mixed</info>  <strong>$connection</strong>  Соединение для установки.

<comment>Return:</comment>
  <info>void</info>  


id: Swoole\Connection\Iterator::offsetUnset
type: function
doc:
<comment>Description:</comment>
  Сбрасывает смещение
  
  Сбрасывает смещение.

<comment>Param:</comment>
  <info>int</info>  <strong>$offset</strong>  Смещение для сбрасывания.

<comment>Return:</comment>
  <info>void</info>  


id: Swoole\Connection\Iterator::rewind
type: function
doc:
<comment>Description:</comment>
  Перематывает итератор

<comment>Return:</comment>
  <info>void</info>  


id: Swoole\Connection\Iterator::valid
type: function
doc:
<comment>Description:</comment>
  Проверяет правильность текущей позиции
  
  Проверяет правильность текущей позиции.

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


id: Swoole\Coroutine::call_user_func
type: function
doc:
<comment>Description:</comment>
  Вызывает callback-функцию, заданную первым параметром
  
  Вызывает <strong>$callback</strong>-функцию, заданную первым параметром и передаёт оставшиеся параметры в качестве
  аргументов.

<comment>Param:</comment>
  <info>callable</info>  <strong>$callback</strong>  Функция <info>callable</info> для вызова.
  <info>mixed</info>     <strong>$args</strong>      Ноль или более параметров для передачи в callback-функцию.

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


id: Swoole\Coroutine::call_user_func_array
type: function
doc:
<comment>Description:</comment>
  Вызывает callback-функцию с массивом параметров
  
  Вызывает callback-функцию, заданную первым параметром с параметрами в param_array.

<comment>Param:</comment>
  <info>callable</info>  <strong>$callback</strong>     Функция <info>callable</info> для вызова.
  <info>array</info>     <strong>$param_array</strong>  Ноль или более параметров для передачи в callback-функцию.

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


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

<comment>Return:</comment>
  <info>ReturnType</info>  


id: Swoole\Event::add
type: function
doc:
<comment>Description:</comment>
  Добавляет новые callback-функции сокета в EventLoop

<comment>Param:</comment>
  <info>int</info>       <strong>$fd</strong>              
  <info>callable</info>  <strong>$read_callback</strong>   
  <info>callable</info>  <strong>$write_callback</strong>  
  <info>string</info>    <strong>$events</strong>          

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


id: Swoole\Event::defer
type: function
doc:
<comment>Description:</comment>
  Добавляет callback-функцию в следующий цикл событий

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

<comment>Return:</comment>
  <info>void</info>  


id: Swoole\Event::del
type: function
doc:
<comment>Description:</comment>
  Удаляет все callback-функции события сокета

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

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


id: Swoole\Event::exit
type: function
doc:
<comment>Description:</comment>
  Выходит из цикла событий, доступно только на стороне клиента

<comment>Return:</comment>
  <info>void</info>  


id: Swoole\Event::set
type: function
doc:
<comment>Description:</comment>
  Обновляет callback-функции события сокета

<comment>Param:</comment>
  <info>int</info>     <strong>$fd</strong>              
  <info>string</info>  <strong>$read_callback</strong>   
  <info>string</info>  <strong>$write_callback</strong>  
  <info>string</info>  <strong>$events</strong>          

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


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

<comment>Return:</comment>
  <info>void</info>  


id: Swoole\Event::write
type: function
doc:
<comment>Description:</comment>
  Записывает данные в сокет

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

<comment>Return:</comment>
  <info>void</info>  


id: Swoole\Http\Client::__construct
type: function
doc:
<comment>Description:</comment>
  Создаёт асинхронный HTTP-клиент

<comment>Param:</comment>
  <info>string</info>  <strong>$host</strong>  Имя удалённого хоста.
  <info>string</info>  <strong>$port</strong>  Номер порта удалённого хоста.
  <info>bool</info>    <strong>$ssl</strong>   Определяет, поддержку SSL.


id: Swoole\Http\Client::__destruct
type: function
doc:
<comment>Description:</comment>
  Уничтожает HTTP-клиент

<comment>Return:</comment>
  <info>void</info>  


id: Swoole\Http\Client::addFile
type: function
doc:
<comment>Description:</comment>
  Добавляет файл в форму сообщения

<comment>Param:</comment>
  <info>string</info>  <strong>$path</strong>      
  <info>string</info>  <strong>$name</strong>      
  <info>string</info>  <strong>$type</strong>      
  <info>string</info>  <strong>$filename</strong>  
  <info>string</info>  <strong>$offset</strong>    

<comment>Return:</comment>
  <info>void</info>  


id: Swoole\Http\Client::close
type: function
doc:
<comment>Description:</comment>
  Закрывает http-соединение

<comment>Return:</comment>
  <info>void</info>  


id: Swoole\Http\Client::download
type: function
doc:
<comment>Description:</comment>
  Загружает файл с удалённого сервера

<comment>Param:</comment>
  <info>string</info>    <strong>$path</strong>      
  <info>string</info>    <strong>$file</strong>      
  <info>callable</info>  <strong>$callback</strong>  
  <info>int</info>       <strong>$offset</strong>    

<comment>Return:</comment>
  <info>void</info>  


id: Swoole\Http\Client::execute
type: function
doc:
<comment>Description:</comment>
  Посылает HTTP-запрос после установки параметров

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

<comment>Return:</comment>
  <info>void</info>  


id: Swoole\Http\Client::get
type: function
doc:
<comment>Description:</comment>
  Отправляет HTTP-запрос GET на удалённый сервер

<comment>Param:</comment>
  <info>string</info>    <strong>$path</strong>      
  <info>callable</info>  <strong>$callback</strong>  

<comment>Return:</comment>
  <info>void</info>  


id: Swoole\Http\Client::isConnected
type: function
doc:
<comment>Description:</comment>
  Проверяет, подключено ли соединение HTTP

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


id: Swoole\Http\Client::on
type: function
doc:
<comment>Description:</comment>
  Регистрирует callback-функцию по имени события

<comment>Param:</comment>
  <info>string</info>    <strong>$event_name</strong>  
  <info>callable</info>  <strong>$callback</strong>    

<comment>Return:</comment>
  <info>void</info>  


id: Swoole\Http\Client::post
type: function
doc:
<comment>Description:</comment>
  Отправляет HTTP-запрос POST на удалённый сервер

<comment>Param:</comment>
  <info>string</info>    <strong>$path</strong>      
  <info>string</info>    <strong>$data</strong>      
  <info>callable</info>  <strong>$callback</strong>  

<comment>Return:</comment>
  <info>void</info>  


id: Swoole\Http\Client::push
type: function
doc:
<comment>Description:</comment>
  Передаёт данные в клиент websocket

<comment>Param:</comment>
  <info>string</info>  <strong>$data</strong>    
  <info>string</info>  <strong>$opcode</strong>  
  <info>string</info>  <strong>$finish</strong>  

<comment>Return:</comment>
  <info>void</info>  


id: Swoole\Http\Client::set
type: function
doc:
<comment>Description:</comment>
  Обновляет параметры HTTP-клиента

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

<comment>Return:</comment>
  <info>void</info>  


id: Swoole\Http\Client::setCookies
type: function
doc:
<comment>Description:</comment>
  Устанавливает cookies для HTTP-запроса

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

<comment>Return:</comment>
  <info>void</info>  


id: Swoole\Http\Client::setData
type: function
doc:
<comment>Description:</comment>
  Устанавливает данные тела HTTP-запроса
  
  Метод HTTP будет изменён на POST.

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

<comment>Return:</comment>
  <info>ReturnType</info>  


id: Swoole\Http\Client::setHeaders
type: function
doc:
<comment>Description:</comment>
  Устанавливает заголовки HTTP-запроса

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

<comment>Return:</comment>
  <info>void</info>  


id: Swoole\Http\Client::setMethod
type: function
doc:
<comment>Description:</comment>
  Устанавливает метод HTTP-запроса

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

<comment>Return:</comment>
  <info>void</info>  


id: Swoole\Http\Client::upgrade
type: function
doc:
<comment>Description:</comment>
  Обновление до протокола websocket

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

<comment>Return:</comment>
  <info>void</info>  


id: Swoole\Http\Request::__destruct
type: function
doc:
<comment>Description:</comment>
  Уничтожает HTTP-запрос

<comment>Return:</comment>
  <info>void</info>  


id: Swoole\Http\Request::rawcontent
type: function
doc:
<comment>Description:</comment>
  Получает необработанное тело HTTP POST
  
  Метод используется для данных POST, которые не имеют форму `application/x-www-form-urlencoded`.
  
  К настоящему времени эта функция ещё не была документирована; для ознакомления доступен только
  список аргументов.

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


id: Swoole\Http\Response::__destruct
type: function
doc:
<comment>Description:</comment>
  Уничтожает HTTP-ответ

<comment>Return:</comment>
  <info>void</info>  


id: Swoole\Http\Response::cookie
type: function
doc:
<comment>Description:</comment>
  Устанавливает cookie HTTP-ответа

<comment>Param:</comment>
  <info>string</info>  <strong>$name</strong>      
  <info>string</info>  <strong>$value</strong>     
  <info>string</info>  <strong>$expires</strong>   
  <info>string</info>  <strong>$path</strong>      
  <info>string</info>  <strong>$domain</strong>    
  <info>string</info>  <strong>$secure</strong>    
  <info>string</info>  <strong>$httponly</strong>  

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


id: Swoole\Http\Response::end
type: function
doc:
<comment>Description:</comment>
  Отправляет данные HTTP-запроса и завершает ответ

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

<comment>Return:</comment>
  <info>void</info>  


id: Swoole\Http\Response::gzip
type: function
doc:
<comment>Description:</comment>
  Включает gzip-сжатие содержимого ответа.
    
  
  Заголовок о Content-Encoding будет добавлен автоматически.

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

<comment>Return:</comment>
  <info>ReturnType</info>  


id: Swoole\Http\Response::header
type: function
doc:
<comment>Description:</comment>
  Устанавливает заголовки HTTP-ответа

<comment>Param:</comment>
  <info>string</info>  <strong>$key</strong>      
  <info>string</info>  <strong>$value</strong>    
  <info>string</info>  <strong>$ucwords</strong>  

<comment>Return:</comment>
  <info>void</info>  


id: Swoole\Http\Response::initHeader
type: function
doc:
<comment>Description:</comment>
  Инициировать заголовок HTTP-ответа
  
  Инициировать заголовок HTTP-ответа.

<comment>Return:</comment>
  <info>ReturnType</info>  


id: Swoole\Http\Response::rawcookie
type: function
doc:
<comment>Description:</comment>
  Устанавливает необработанные cookie в HTTP-ответ

<comment>Param:</comment>
  <info>string</info>  <strong>$name</strong>      
  <info>string</info>  <strong>$value</strong>     
  <info>string</info>  <strong>$expires</strong>   
  <info>string</info>  <strong>$path</strong>      
  <info>string</info>  <strong>$domain</strong>    
  <info>string</info>  <strong>$secure</strong>    
  <info>string</info>  <strong>$httponly</strong>  

<comment>Return:</comment>
  <info>ReturnType</info>  


id: Swoole\Http\Response::sendfile
type: function
doc:
<comment>Description:</comment>
  Отправляет файл через HTTP-ответ
  
  Отправляет файл через HTTP-ответ.

<comment>Param:</comment>
  <info>string</info>  <strong>$filename</strong>  
  <info>int</info>     <strong>$offset</strong>    

<comment>Return:</comment>
  <info>ReturnType</info>  


id: Swoole\Http\Response::status
type: function
doc:
<comment>Description:</comment>
  Устанавливает код состояния HTTP-ответа
  
  Устанавливает код состояния HTTP-ответа.

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

<comment>Return:</comment>
  <info>ReturnType</info>  


id: Swoole\Http\Response::write
type: function
doc:
<comment>Description:</comment>
  Добавляет содержимое тела HTTP в HTTP-ответ
  
  Добавляет содержимое тела HTTP в HTTP-ответ.

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

<comment>Return:</comment>
  <info>void</info>  


id: Swoole\Http\Server::on
type: function
doc:
<comment>Description:</comment>
  Привязывает callback-функцию к HTTP-серверу по имени события
  
  Привязывает callback-функцию к HTTP-серверу по имени события.

<comment>Param:</comment>
  <info>string</info>    <strong>$event_name</strong>  
  <info>callable</info>  <strong>$callback</strong>    

<comment>Return:</comment>
  <info>void</info>  


id: Swoole\Http\Server::start
type: function
doc:
<comment>Description:</comment>
  Запускает http-сервер swoole
  
  Запускает http-сервер swoole.

<comment>Return:</comment>
  <info>void</info>  


id: Swoole\Lock::__construct
type: function
doc:
<comment>Description:</comment>
  Создаёт блокировку памяти
  
  Блокировка Swoole используется для синхронизации данных между несколькими операциями или
  процессами.

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


id: Swoole\Lock::__destruct
type: function
doc:
<comment>Description:</comment>
  Уничтожает блокировку памяти Swoole

<comment>Return:</comment>
  <info>void</info>  


id: Swoole\Lock::lock
type: function
doc:
<comment>Description:</comment>
  Пытается получить блокировку. Заблокируется, если блокировка недоступна

<comment>Return:</comment>
  <info>void</info>  


id: Swoole\Lock::lock_read
type: function
doc:
<comment>Description:</comment>
  Блокирует чтение-запись блокировки для чтения
  
  Блокирует чтение-запись блокировки для чтения.

<comment>Return:</comment>
  <info>void</info>  


id: Swoole\Lock::trylock
type: function
doc:
<comment>Description:</comment>
  Пытается получить блокировку и сразу возвращает, даже если блокировка недоступна

<comment>Return:</comment>
  <info>void</info>  


id: Swoole\Lock::trylock_read
type: function
doc:
<comment>Description:</comment>
  Пытается заблокировать блокировку чтения-записи для чтения и сразу возвращает, даже если
  блокировка
  недоступна

<comment>Return:</comment>
  <info>void</info>  


id: Swoole\Lock::unlock
type: function
doc:
<comment>Description:</comment>
  Снимает блокировку

<comment>Return:</comment>
  <info>void</info>  


id: Swoole\Mmap::open
type: function
doc:
<comment>Description:</comment>
  Отобразить файл в память и вернуть ресурс потока, который может использоваться операциями потока
  PHP

<comment>Param:</comment>
  <info>string</info>  <strong>$filename</strong>  
  <info>string</info>  <strong>$size</strong>      
  <info>string</info>  <strong>$offset</strong>    

<comment>Return:</comment>
  <info>ReturnType</info>  


id: Swoole\MySQL::__construct
type: function
doc:
<comment>Description:</comment>
  Создаёт асинхронный клиент MySQL
  
  Создаёт асинхронный клиент MySQL.


id: Swoole\MySQL::__destruct
type: function
doc:
<comment>Description:</comment>
  Уничтожает асинхронный клиент MySQL

<comment>Return:</comment>
  <info>void</info>  


id: Swoole\MySQL::close
type: function
doc:
<comment>Description:</comment>
  Закрывает асинхронное соединение MySQL

<comment>Return:</comment>
  <info>void</info>  


id: Swoole\MySQL::connect
type: function
doc:
<comment>Description:</comment>
  Подключается к удалённому серверу MySQL
  
  Подключается к удалённому серверу MySQL.

<comment>Param:</comment>
  <info>array</info>     <strong>$server_config</strong>  
  <info>callable</info>  <strong>$callback</strong>       

<comment>Return:</comment>
  <info>void</info>  


id: Swoole\MySQL::on
type: function
doc:
<comment>Description:</comment>
  Регистрирует callback-функцию на основе имени события
  
  Регистрирует callback-функцию на основе имени события, на данный момент поддерживается только
  событие 'close'.

<comment>Param:</comment>
  <info>string</info>    <strong>$event_name</strong>  
  <info>callable</info>  <strong>$callback</strong>    

<comment>Return:</comment>
  <info>void</info>  


id: Swoole\MySQL::query
type: function
doc:
<comment>Description:</comment>
  Выполняет запрос SQL

<comment>Param:</comment>
  <info>string</info>    <strong>$sql</strong>       
  <info>callable</info>  <strong>$callback</strong>  

<comment>Return:</comment>
  <info>ReturnType</info>  


id: Swoole\Process::__construct
type: function
doc:
<comment>Description:</comment>
  Создаёт процесс

<comment>Param:</comment>
  <info>callable</info>  <strong>$callback</strong>                   
  <info>bool</info>      <strong>$redirect_stdin_and_stdout</strong>  
  <info>int</info>       <strong>$pipe_type</strong>                  


id: Swoole\Process::__destruct
type: function
doc:
<comment>Description:</comment>
  Уничтожает процесс

<comment>Return:</comment>
  <info>void</info>  


id: Swoole\Process::alarm
type: function
doc:
<comment>Description:</comment>
  Таймер высокой точности, который запускает сигнал с фиксированным интервалом

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

<comment>Return:</comment>
  <info>void</info>  


id: Swoole\Process::close
type: function
doc:
<comment>Description:</comment>
  Закрывает канал для дочернего процесса
  
  Закрывает канал для дочернего процесса.

<comment>Return:</comment>
  <info>void</info>  


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

<comment>Param:</comment>
  <info>bool</info>  <strong>$nochdir</strong>  
  <info>bool</info>  <strong>$noclose</strong>  

<comment>Return:</comment>
  <info>void</info>  


id: Swoole\Process::exec
type: function
doc:
<comment>Description:</comment>
  Выполняет системные команды
  
  Процесс будет заменён на системный командный процесс, но канал к родительскому процессу будет
  сохранён.

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

<comment>Return:</comment>
  <info>ReturnType</info>  


id: Swoole\Process::exit
type: function
doc:
<comment>Description:</comment>
  Останавливает дочерние процессы

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

<comment>Return:</comment>
  <info>void</info>  


id: Swoole\Process::freeQueue
type: function
doc:
<comment>Description:</comment>
  Уничтожает очередь сообщений, созданную swoole_process::useQueue

<comment>Return:</comment>
  <info>void</info>  


id: Swoole\Process::kill
type: function
doc:
<comment>Description:</comment>
  Посылает сигнал дочернему процессу
  
  Посылает сигнал дочернему процессу.

<comment>Param:</comment>
  <info>int</info>  <strong>$pid</strong>        Идентификатор процесса
  <info>int</info>  <strong>$signal_no</strong>  Сигнал к отправке

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


id: Swoole\Process::name
type: function
doc:
<comment>Description:</comment>
  Устанавливает название процесса

<comment>Param:</comment>
  <info>string</info>  <strong>$process_name</strong>  Устанавливает имя процесса.

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


id: Swoole\Process::pop
type: function
doc:
<comment>Description:</comment>
  Читает и извлекает данные из очереди сообщений

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

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


id: Swoole\Process::push
type: function
doc:
<comment>Description:</comment>
  Записывает и помещает данные в очередь сообщений

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

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


id: Swoole\Process::read
type: function
doc:
<comment>Description:</comment>
  Читает данные отправки в процесс

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

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


id: Swoole\Process::signal
type: function
doc:
<comment>Description:</comment>
  Посылает сигнал дочерним процессам

<comment>Param:</comment>
  <info>string</info>    <strong>$signal_no</strong>  
  <info>callable</info>  <strong>$callback</strong>   

<comment>Return:</comment>
  <info>void</info>  В случае успешной отправки сигнала, возвращает TRUE, в противном случае возвращает FALSE.


id: Swoole\Process::start
type: function
doc:
<comment>Description:</comment>
  Запускает процесс

<comment>Return:</comment>
  <info>void</info>  


id: Swoole\Process::statQueue
type: function
doc:
<comment>Description:</comment>
  Получает статистику очереди сообщений, используемой в качестве метода связи между процессами

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


id: Swoole\Process::useQueue
type: function
doc:
<comment>Description:</comment>
  Создаёт очередь сообщений в качестве метода связи между родительским процессом и дочерними
  процессами

<comment>Param:</comment>
  <info>int</info>  <strong>$key</strong>   
  <info>int</info>  <strong>$mode</strong>  

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


id: Swoole\Process::wait
type: function
doc:
<comment>Description:</comment>
  Ожидает событий дочерних процессов

<comment>Param:</comment>
  <info>bool</info>  <strong>$blocking</strong>  

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


id: Swoole\Process::write
type: function
doc:
<comment>Description:</comment>
  Записывает данные в канал и связывается с родительским процессом или дочерними процессами

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

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


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

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

<comment>Return:</comment>
  <info>ReturnType</info>  


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

<comment>Param:</comment>
  <info>string</info>  <strong>$command</strong>                 
  <info>string</info>  <strong>$callback</strong>                
  <info>string</info>  <strong>$number_of_string_param</strong>  
  <info>string</info>  <strong>$type_of_array_param</strong>     

<comment>Return:</comment>
  <info>ReturnType</info>  


id: Swoole\Serialize::pack
type: function
doc:
<comment>Description:</comment>
  Сериализовать данные
  
  Swoolle обеспечивает быстрый и высокопроизводительный модуль сериализации.

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

<comment>Return:</comment>
  <info>ReturnType</info>  


id: Swoole\Serialize::unpack
type: function
doc:
<comment>Description:</comment>
  Десериализовать данные
  
  Десериализовать данные.

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

<comment>Return:</comment>
  <info>ReturnType</info>  


id: Swoole\Server::__construct
type: function
doc:
<comment>Description:</comment>
  Создаёт сервер Swoole

<comment>Param:</comment>
  <info>string</info>  <strong>$host</strong>       
  <info>int</info>     <strong>$port</strong>       
  <info>int</info>     <strong>$mode</strong>       
  <info>int</info>     <strong>$sock_type</strong>  


id: Swoole\Server::addProcess
type: function
doc:
<comment>Description:</comment>
  Добавляет определённый пользователем swoole_process на сервер

<comment>Param:</comment>
  <info>swoole_process</info>  <strong>$process</strong>  

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


id: Swoole\Server::addlistener
type: function
doc:
<comment>Description:</comment>
  Добавляет нового слушателя на сервер

<comment>Param:</comment>
  <info>string</info>  <strong>$host</strong>         
  <info>int</info>     <strong>$port</strong>         
  <info>string</info>  <strong>$socket_type</strong>  

<comment>Return:</comment>
  <info>void</info>  


id: Swoole\Server::after
type: function
doc:
<comment>Description:</comment>
  Запускает callback-функцию по истечении определённого периода времени

<comment>Param:</comment>
  <info>int</info>       <strong>$after_time_ms</strong>  
  <info>callable</info>  <strong>$callback</strong>       
  <info>string</info>    <strong>$param</strong>          

<comment>Return:</comment>
  <info>ReturnType</info>  


id: Swoole\Server::bind
type: function
doc:
<comment>Description:</comment>
  Привязывает соединение к указанному идентификатору пользователя

<comment>Param:</comment>
  <info>int</info>  <strong>$fd</strong>   
  <info>int</info>  <strong>$uid</strong>  

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


id: Swoole\Server::clearTimer
type: function
doc:
<comment>Description:</comment>
  Останавливает и уничтожает таймер
  
  Объектно-ориентированный стиль (метод):
  
  Процедурный стиль:
  
  Останавливает и уничтожает таймер

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

<comment>Return:</comment>
  <info>void</info>  


id: Swoole\Server::close
type: function
doc:
<comment>Description:</comment>
  Закрывает соединение с клиентом

<comment>Param:</comment>
  <info>int</info>   <strong>$fd</strong>     
  <info>bool</info>  <strong>$reset</strong>  

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


id: Swoole\Server::confirm
type: function
doc:
<comment>Description:</comment>
  Проверяет состояние соединения

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

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


id: Swoole\Server::connection_info
type: function
doc:
<comment>Description:</comment>
  Получает информацию о соединении по описанию файла

<comment>Param:</comment>
  <info>int</info>  <strong>$fd</strong>          
  <info>int</info>  <strong>$reactor_id</strong>  

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


id: Swoole\Server::connection_list
type: function
doc:
<comment>Description:</comment>
  Получает все установленные соединения

<comment>Param:</comment>
  <info>int</info>  <strong>$start_fd</strong>  
  <info>int</info>  <strong>$pagesize</strong>  

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


id: Swoole\Server::defer
type: function
doc:
<comment>Description:</comment>
  Откладывает выполнение callback-функции в конце текущего EventLoop

<comment>Param:</comment>
  <info>callable</info>  <strong>$callback</strong>  

<comment>Return:</comment>
  <info>void</info>  


id: Swoole\Server::exist
type: function
doc:
<comment>Description:</comment>
  Проверяет, существует ли соединение

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

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


id: Swoole\Server::finish
type: function
doc:
<comment>Description:</comment>
  Используется в процессе задачи для отправки результата в рабочий процесс после завершения задачи

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

<comment>Return:</comment>
  <info>void</info>  


id: Swoole\Server::getClientInfo
type: function
doc:
<comment>Description:</comment>
  Получает информацию о соединении по описанию файла

<comment>Param:</comment>
  <info>int</info>   <strong>$fd</strong>            Дескриптор файла
  <info>int</info>   <strong>$reactor_id</strong>    Идентификатор потока Reactor, в котором выполняется соединение.
  <info>bool</info>  <strong>$ignore_error</strong>  Следует ли игнорировать ошибки. Если установлено значение true, информация о
                       соединении будет возвращена, даже если соединение будет закрыто.

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


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

<comment>Param:</comment>
  <info>int</info>  <strong>$start_fd</strong>  
  <info>int</info>  <strong>$pagesize</strong>  

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


id: Swoole\Server::getLastError
type: function
doc:
<comment>Description:</comment>
  Получает код самой последней ошибки

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


id: Swoole\Server::heartbeat
type: function
doc:
<comment>Description:</comment>
  Проверяет все соединения на сервере

<comment>Param:</comment>
  <info>bool</info>  <strong>$if_close_connection</strong>  

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


id: Swoole\Server::listen
type: function
doc:
<comment>Description:</comment>
  Слушает по заданному IP и порту, тип сокета

<comment>Param:</comment>
  <info>string</info>  <strong>$host</strong>         
  <info>int</info>     <strong>$port</strong>         
  <info>string</info>  <strong>$socket_type</strong>  

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


id: Swoole\Server::pause
type: function
doc:
<comment>Description:</comment>
  Прекращает получение данных от соединения

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

<comment>Return:</comment>
  <info>void</info>  


id: Swoole\Server::protect
type: function
doc:
<comment>Description:</comment>
  Устанавливает соединение в защищённый режим

<comment>Param:</comment>
  <info>int</info>   <strong>$fd</strong>            
  <info>bool</info>  <strong>$is_protected</strong>  

<comment>Return:</comment>
  <info>void</info>  


id: Swoole\Server::reload
type: function
doc:
<comment>Description:</comment>
  Перезапускает все рабочие процессы

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


id: Swoole\Server::resume
type: function
doc:
<comment>Description:</comment>
  Начинает получать данные из соединения

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

<comment>Return:</comment>
  <info>void</info>  


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

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

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


id: Swoole\Server::sendMessage
type: function
doc:
<comment>Description:</comment>
  Отправляет сообщение рабочим процессам по идентификатору

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

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


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

<comment>Param:</comment>
  <info>int</info>     <strong>$fd</strong>        
  <info>string</info>  <strong>$filename</strong>  
  <info>int</info>     <strong>$offset</strong>    

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


id: Swoole\Server::sendto
type: function
doc:
<comment>Description:</comment>
  Отправляет данные на удалённый UDP-адрес

<comment>Param:</comment>
  <info>string</info>  <strong>$ip</strong>             
  <info>int</info>     <strong>$port</strong>           
  <info>string</info>  <strong>$data</strong>           
  <info>string</info>  <strong>$server_socket</strong>  

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


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

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

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


id: Swoole\Server::set
type: function
doc:
<comment>Description:</comment>
  Устанавливает настройки времени выполнения сервера swoole
  
  Устанавливает настройки времени выполнения сервера swoole. Доступ к настройкам можно получить с
  помощью $server-&gt;setting после запуска сервера swoole.

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

<comment>Return:</comment>
  <info>ReturnType</info>  


id: Swoole\Server::shutdown
type: function
doc:
<comment>Description:</comment>
  Завершает процесс главного сервера, функцию можно вызывать в рабочих процессах

<comment>Return:</comment>
  <info>void</info>  


id: Swoole\Server::start
type: function
doc:
<comment>Description:</comment>
  Запускает сервер Swoole

<comment>Return:</comment>
  <info>void</info>  


id: Swoole\Server::stats
type: function
doc:
<comment>Description:</comment>
  Получает статистику сервера Swoole

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


id: Swoole\Server::stop
type: function
doc:
<comment>Description:</comment>
  Останавливает сервер Swoole

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

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


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

<comment>Param:</comment>
  <info>string</info>    <strong>$data</strong>           
  <info>int</info>       <strong>$dst_worker_id</strong>  
  <info>callable</info>  <strong>$callback</strong>       

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


id: Swoole\Server::taskWaitMulti
type: function
doc:
<comment>Description:</comment>
  Выполняет несколько задач одновременно

<comment>Param:</comment>
  <info>array</info>  <strong>$tasks</strong>       
  <info>float</info>  <strong>$timeout_ms</strong>  

<comment>Return:</comment>
  <info>void</info>  


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

<comment>Param:</comment>
  <info>string</info>  <strong>$data</strong>       
  <info>float</info>   <strong>$timeout</strong>    
  <info>int</info>     <strong>$worker_id</strong>  

<comment>Return:</comment>
  <info>void</info>  


id: Swoole\Server::tick
type: function
doc:
<comment>Description:</comment>
  Повторяет данную функцию в каждый заданный интервал времени

<comment>Param:</comment>
  <info>int</info>       <strong>$interval_ms</strong>  
  <info>callable</info>  <strong>$callback</strong>     

<comment>Return:</comment>
  <info>void</info>  


id: Swoole\Server\Port::__destruct
type: function
doc:
<comment>Description:</comment>
  Уничтожает порт сервера

<comment>Return:</comment>
  <info>void</info>  


id: Swoole\Server\Port::on
type: function
doc:
<comment>Description:</comment>
  Регистрирует callback-функции по событию

<comment>Param:</comment>
  <info>string</info>    <strong>$event_name</strong>  
  <info>callable</info>  <strong>$callback</strong>    

<comment>Return:</comment>
  <info>ReturnType</info>  


id: Swoole\Server\Port::set
type: function
doc:
<comment>Description:</comment>
  Устанавливает протокол порта сервера

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

<comment>Return:</comment>
  <info>void</info>  


id: Swoole\Table::__construct
type: function
doc:
<comment>Description:</comment>
  Создаёт таблицу памяти Swoole с фиксированным размером

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


id: Swoole\Table::column
type: function
doc:
<comment>Description:</comment>
  Устанавливает тип данных и размер столбцов

<comment>Param:</comment>
  <info>string</info>  <strong>$name</strong>  
  <info>string</info>  <strong>$type</strong>  
  <info>int</info>     <strong>$size</strong>  

<comment>Return:</comment>
  <info>ReturnType</info>  


id: Swoole\Table::count
type: function
doc:
<comment>Description:</comment>
  Подсчитывает строки в таблице или подсчитывает все элементы в таблице, если $mode = 1

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


id: Swoole\Table::create
type: function
doc:
<comment>Description:</comment>
  Создаёт таблицу памяти swoole

<comment>Return:</comment>
  <info>void</info>  


id: Swoole\Table::current
type: function
doc:
<comment>Description:</comment>
  Получает текущую строку

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


id: Swoole\Table::decr
type: function
doc:
<comment>Description:</comment>
  Уменьшает значение в таблице Swoole по $row_key и $column_key

<comment>Param:</comment>
  <info>string</info>  <strong>$key</strong>     
  <info>string</info>  <strong>$column</strong>  
  <info>int</info>     <strong>$decrby</strong>  

<comment>Return:</comment>
  <info>ReturnType</info>  


id: Swoole\Table::del
type: function
doc:
<comment>Description:</comment>
  Удаляет строку в таблице Swoole по $row_key

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

<comment>Return:</comment>
  <info>void</info>  


id: Swoole\Table::destroy
type: function
doc:
<comment>Description:</comment>
  Уничтожает таблицу Swoole

<comment>Return:</comment>
  <info>void</info>  


id: Swoole\Table::exist
type: function
doc:
<comment>Description:</comment>
  Проверяет, существует ли строка по $row_key

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

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


id: Swoole\Table::get
type: function
doc:
<comment>Description:</comment>
  Получает значение в таблице Swoole по $row_key и $column_key

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

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


id: Swoole\Table::incr
type: function
doc:
<comment>Description:</comment>
  Увеличивает значение по $row_key и $column_key

<comment>Param:</comment>
  <info>string</info>  <strong>$key</strong>     
  <info>string</info>  <strong>$column</strong>  
  <info>int</info>     <strong>$incrby</strong>  

<comment>Return:</comment>
  <info>void</info>  


id: Swoole\Table::key
type: function
doc:
<comment>Description:</comment>
  Получает ключ текущей строки

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


id: Swoole\Table::next
type: function
doc:
<comment>Description:</comment>
  Перемещает итератор на следующую строку

<comment>Return:</comment>
  <info>ReturnType</info>  


id: Swoole\Table::set
type: function
doc:
<comment>Description:</comment>
  Обновляет строку таблицы по $row_key

<comment>Param:</comment>
  <info>string</info>  <strong>$key</strong>    
  <info>array</info>   <strong>$value</strong>  

<comment>Return:</comment>
  <info>VOID</info>  


id: Swoole\Table::valid
type: function
doc:
<comment>Description:</comment>
  Проверяет, является ли текущая строка корректной

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


id: Swoole\Timer::after
type: function
doc:
<comment>Description:</comment>
  Запускает callback-функцию через определённый промежуток времени
  
  Запускает callback-функцию через определённый промежуток времени.

<comment>Param:</comment>
  <info>int</info>       <strong>$after_time_ms</strong>  
  <info>callable</info>  <strong>$callback</strong>       

<comment>Return:</comment>
  <info>void</info>  


id: Swoole\Timer::clear
type: function
doc:
<comment>Description:</comment>
  Удаляет таймер по идентификатору
  
  Удаляет таймер по идентификатору.

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

<comment>Return:</comment>
  <info>void</info>  


id: Swoole\Timer::exists
type: function
doc:
<comment>Description:</comment>
  Проверяет, существует ли таймер
  
  Проверяет, существует ли таймер.

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

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


id: Swoole\Timer::tick
type: function
doc:
<comment>Description:</comment>
  Повторяет данную функцию в каждый заданный интервал времени

<comment>Param:</comment>
  <info>int</info>       <strong>$interval_ms</strong>  
  <info>callable</info>  <strong>$callback</strong>     
  <info>string</info>    <strong>$param</strong>        

<comment>Return:</comment>
  <info>void</info>  


id: Swoole\WebSocket\Server::exist
type: function
doc:
<comment>Description:</comment>
  Проверяет, существует ли описание файла

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

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


id: Swoole\WebSocket\Server::on
type: function
doc:
<comment>Description:</comment>
  Зарегистрировать callback-функцию события
  
  Зарегистрировать callback-функцию события

<comment>Param:</comment>
  <info>string</info>    <strong>$event_name</strong>  
  <info>callable</info>  <strong>$callback</strong>    

<comment>Return:</comment>
  <info>ReturnType</info>  


id: Swoole\WebSocket\Server::pack
type: function
doc:
<comment>Description:</comment>
  Получение пакета двоичных данных для отправки в одной группе данных (frame)

<comment>Param:</comment>
  <info>string</info>  <strong>$data</strong>    
  <info>string</info>  <strong>$opcode</strong>  
  <info>string</info>  <strong>$finish</strong>  
  <info>string</info>  <strong>$mask</strong>    

<comment>Return:</comment>
  <info>binary</info>  


id: Swoole\WebSocket\Server::push
type: function
doc:
<comment>Description:</comment>
  Отправить данные удалённому клиенту

<comment>Param:</comment>
  <info>string</info>  <strong>$fd</strong>      
  <info>string</info>  <strong>$data</strong>    
  <info>string</info>  <strong>$opcode</strong>  
  <info>string</info>  <strong>$finish</strong>  

<comment>Return:</comment>
  <info>void</info>  


id: Swoole\WebSocket\Server::unpack
type: function
doc:
<comment>Description:</comment>
  Распаковать двоичные данные, полученные от клиента

<comment>Param:</comment>
  <info>binary</info>  <strong>$data</strong>  

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


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


id: SyncEvent::__construct
type: function
doc:
<comment>Description:</comment>
  Создаёт новый объект SyncEvent
  
  Создаёт именованный или безымянный объект события.

<comment>Param:</comment>
  <info>string</info>  <strong>$name</strong>     Имя события, если это именованный объект события.
                    
                    Если имя уже существует, оно должно быть доступно для открытия текущим
                    пользователем, от имени которого запущен процесс, иначе будет выброшено
                    исключение с бессмысленным сообщением об ошибке.
  <info>bool</info>    <strong>$manual</strong>   Определяет, нужно ли сбрасывать объект события вручную.
                    
                    Объекты событий со сбросом вручную позволяют выполнять все ожидающие процессы,
                    пока объект не будет сброшен.
  <info>bool</info>    <strong>$prefire</strong>  Определяет, следует ли предварительно активировать (сигнализировать) объект
                    события.
                    
                    Имеет значение только в том случае, если вызывающий процесс/поток первым создаёт
                    объект.

<comment>Return:</comment>
  <info>unknown</info>  Новый объект <class>SyncEvent</class>.

<comment>See Also:</comment>
   * SyncEvent::fire
   * SyncEvent::reset
   * SyncEvent::wait


id: SyncEvent::fire
type: function
doc:
<comment>Description:</comment>
  Запускает/устанавливает событие
  
  Запускает/устанавливает объект <class>SyncEvent</class>. Позволяет проходить нескольким потокам, которые ожидают,
  если объект события был создан с параметром manual равным <info>true</info>.

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

<comment>See Also:</comment>
   * SyncEvent::reset
   * SyncEvent::wait


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

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

<comment>See Also:</comment>
   * SyncEvent::fire
   * SyncEvent::reset
   * SyncEvent::wait


id: SyncEvent::wait
type: function
doc:
<comment>Description:</comment>
  Ожидает запуска/установки события
  
  Ожидает запуска объекта <class>SyncEvent</class>.

<comment>Param:</comment>
  <info>int</info>  <strong>$wait</strong>  Количество миллисекунд ожидания запуска события. Значение -1 бесконечно.

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

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


id: SyncMutex
type: class
doc:
<comment>Description:</comment>
  Кроссплатформенная, нативная реализация именованных и безымянных счётных объектов мьютекса.
  
  Мьютекс - это объект взаимного исключения, который ограничивает доступ к общему ресурсу (например,
  файлу) для одного экземпляра. Счётные мьютексы получают мьютекс один раз и внутренне отслеживают,
  сколько раз мьютекс был заблокирован. Мьютекс разблокируется, как только он выходит из области
  действия или разблокируется столько раз, сколько он был заблокирован.


id: SyncMutex::__construct
type: function
doc:
<comment>Description:</comment>
  Создаёт новый объект SyncMutex
  
  Создаёт именованный или безымянный счётный мьютекс.

<comment>Param:</comment>
  <info>string</info>  <strong>$name</strong>  Имя мьютекса, если это именованный объект мьютекса.
                 
                 Если имя уже существует, оно должно быть доступно для открытия текущим
                 пользователем, от имени которого запущен процесс, иначе будет выброшено исключение
                 с бессмысленным сообщением об ошибке.

<comment>Return:</comment>
  <info>unknown</info>  Новый объект <class>SyncMutex</class>.

<comment>See Also:</comment>
   * SyncMutex::lock
   * SyncMutex::unlock


id: SyncMutex::lock
type: function
doc:
<comment>Description:</comment>
  Ждёт эксклюзивной блокировки
  
  Получает эксклюзивную блокировку объекта <class>SyncMutex</class>. Если блокировка уже установлена, внутренний
  счётчик увеличивается.

<comment>Param:</comment>
  <info>int</info>  <strong>$wait</strong>  Количество миллисекунд ожидания эксклюзивной блокировки. Значение -1 означает
              бесконечное время ожидания.

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

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


id: SyncMutex::unlock
type: function
doc:
<comment>Description:</comment>
  Разблокирует мьютекс
  
  Уменьшает внутренний счётчик объекта <class>SyncMutex</class>. Когда внутренний счётчик достигает нуля,
  фактическая блокировка объекта снимается.

<comment>Param:</comment>
  <info>bool</info>  <strong>$all</strong>  Определяет, устанавливать ли внутренний счётчик на ноль и, следовательно, снимать
              блокировку.

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

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


id: SyncReaderWriter
type: class
doc:
<comment>Description:</comment>
  Кроссплатформенная, нативная реализация именованных и безымянных объектов чтения-записи.
  
  Объект читатель-писатель позволяет многим читателям или одному писателю получить доступ к ресурсу.
  Это эффективное решение для управления ресурсами, где доступ будет главным образом только для
  чтения, но иногда необходим эксклюзивный доступ для записи.


id: SyncReaderWriter::__construct
type: function
doc:
<comment>Description:</comment>
  Создаёт новый объект SyncReaderWriter
  
  Создаёт именованный или безымянный объект чтения-записи.

<comment>Param:</comment>
  <info>string</info>  <strong>$name</strong>        Имя средства чтения-записи, если это именованный объект чтения-записи.
                       
                       Если имя уже существует, оно должно быть доступно для открытия текущим
                       пользователем, от имени которого запущен процесс, иначе будет выброшено
                       исключение с бессмысленным сообщением об ошибке.
                       
                       В Windows параметр <strong>$name</strong> не должен содержать обратных слешей.
  <info>int</info>     <strong>$autounlock</strong>  Указывает, следует ли автоматически разблокировать средство чтения-записи при
                       завершении скрипта PHP.
                       
                       Если объект: Именованное средство чтения-записи с автоматической блокировкой
                       FALSE, объект заблокирован для чтения или записи, и скрипт PHP завершается до
                       того, как объект будет разблокирован, тогда базовые объекты окажутся в
                       несогласованном состоянии.

<comment>Return:</comment>
  <info>unknown</info>  Новый объект <class>SyncReaderWriter</class>.

<comment>See Also:</comment>
   * SyncReaderWriter::readlock
   * SyncReaderWriter::readunlock
   * SyncReaderWriter::writelock
   * SyncReaderWriter::writeunlock


id: SyncReaderWriter::readlock
type: function
doc:
<comment>Description:</comment>
  Ожидает блокировки чтения
  
  Получает блокировку чтения объекта <class>SyncReaderWriter</class>.

<comment>Param:</comment>
  <info>int</info>  <strong>$wait</strong>  Количество миллисекунд ожидания блокировки. Значение -1 бесконечно.

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

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


id: SyncReaderWriter::readunlock
type: function
doc:
<comment>Description:</comment>
  Снимает блокировку чтения
  
  Снимает блокировку чтения объекта <class>SyncReaderWriter</class>.

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

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


id: SyncReaderWriter::writelock
type: function
doc:
<comment>Description:</comment>
  Ожидает эксклюзивной блокировки записи
  
  Получает эксклюзивную блокировку записи для объекта <class>SyncReaderWriter</class>.

<comment>Param:</comment>
  <info>int</info>  <strong>$wait</strong>  Количество миллисекунд ожидания блокировки. Значение -1 бесконечно.

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

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


id: SyncReaderWriter::writeunlock
type: function
doc:
<comment>Description:</comment>
  Снимает блокировку записи
  
  Снимает блокировку записи объекта <class>SyncReaderWriter</class>.

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

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


id: SyncSemaphore
type: class
doc:
<comment>Description:</comment>
  Кроссплатформенная, нативная реализация именованных и безымянных объектов семафоров.
  
  Семафор ограничивает доступ к ограниченному ресурсу ограниченным числом экземпляров. Семафоры
  отличаются от мьютексов тем, что они могут разрешить доступ к ресурсу более чем одному экземпляру
  одновременно, в то время как мьютекс допускает только один экземпляр за раз.


id: SyncSemaphore::__construct
type: function
doc:
<comment>Description:</comment>
  Создаёт новый объект SyncSemaphore
  
  Создаёт именованный или безымянный семафор.

<comment>Param:</comment>
  <info>string</info>  <strong>$name</strong>        Имя семафора, если это именованный объект семафора.
                       
                       Если имя уже существует, оно должно быть доступно для открытия текущим
                       пользователем, от имени которого запущен процесс, иначе будет выброшено
                       исключение с бессмысленным сообщением об ошибке.
  <info>int</info>     <strong>$initialval</strong>  Начальное значение семафора. Это количество блокировок, которое можно
                       получить.
  <info>bool</info>    <strong>$autounlock</strong>  Указывает, следует ли автоматически разблокировать семафор при завершении
                       скрипта PHP.
                       
                       Если объект - это: именованный семафор с autounlock со значением <info>false</info>,
                       объект заблокирован и скрипт PHP завершается до того, как объект
                       разблокируется, то базовый семафор окажется в несогласованном состоянии.

<comment>Return:</comment>
  <info>unknown</info>  Новый объект <class>SyncSemaphore</class>.

<comment>See Also:</comment>
   * SyncSemaphore::lock
   * SyncSemaphore::unlock


id: SyncSemaphore::lock
type: function
doc:
<comment>Description:</comment>
  Уменьшает счёт семафора или ждёт
  
  Уменьшает счётчик объекта <class>SyncSemaphore</class> или ждёт, пока семафор не станет отличным от нуля.

<comment>Param:</comment>
  <info>int</info>  <strong>$wait</strong>  Количество миллисекунд ожидания семафора. Значение -1 бесконечно.

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

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


id: SyncSemaphore::unlock
type: function
doc:
<comment>Description:</comment>
  Увеличивает счёт семафора
  
  Увеличивает счёт объекта <class>SyncSemaphore</class>.

<comment>Param:</comment>
  <info>int</info>  <strong>$prevcount</strong>  Возвращает предыдущее значение счётчика семафора.

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

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


id: SyncSharedMemory
type: class
doc:
<comment>Description:</comment>
  Кроссплатформенная, нативная, согласованная реализация именованных объектов общей памяти.
  
  Совместно используемая память позволяет двум отдельным процессам обмениваться данными без
  необходимости в сложных каналах или сокетах. Существует несколько реализаций с общей памятью для
  PHP. Именованная общая память является альтернативой.
  
  Объекты синхронизации (например, SyncMutex) всё ещё необходимы для защиты большинства видов
  использования общей памяти.


id: SyncSharedMemory::__construct
type: function
doc:
<comment>Description:</comment>
  Создаёт новый объект SyncSharedMemory
  
  Создаёт именованный объект разделяемой памяти.

<comment>Param:</comment>
  <info>string</info>  <strong>$name</strong>  Имя объекта разделяемой памяти.
                 
                 Если имя уже существует, оно должно быть доступно для открытия текущим
                 пользователем, от имени которого запущен процесс, иначе будет выброшено исключение
                 с бессмысленным сообщением об ошибке.
  <info>int</info>     <strong>$size</strong>  Размер в байтах разделяемой памяти, которую необходимо зарезервировать.
                 
                 Объем памяти не может быть изменён позже. Запросите заранее достаточно места для
                 хранения.

<comment>Return:</comment>
  <info>unknown</info>  Новый объект <class>SyncSharedMemory</class>.

<comment>See Also:</comment>
   * SyncSharedMemory::first
   * SyncSharedMemory::size
   * SyncSharedMemory::write
   * SyncSharedMemory::read


id: SyncSharedMemory::first
type: function
doc:
<comment>Description:</comment>
  Проверяет, является ли объект первым общесистемным экземпляром именованной разделяемой памяти
  
  Получает общесистемный статус первого экземпляра объекта <class>SyncSharedMemory</class>.

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

<comment>See Also:</comment>
   * SyncSharedMemory::write
   * SyncSharedMemory::read


id: SyncSharedMemory::read
type: function
doc:
<comment>Description:</comment>
  Копирует данные из именованной разделяемой памяти
  
  Копирует данные из именованной разделяемой памяти.

<comment>Param:</comment>
  <info>int</info>  <strong>$start</strong>   Начало/смещение в байтах для начала чтения.
                
                Если значение отрицательное, начальная позиция будет начинаться с указанного
                количества байтов с конца сегмента разделяемой памяти.
  <info>int</info>  <strong>$length</strong>  Количество байтов для чтения.
                
                Если не указано иное, чтение остановится в конце сегмента разделяемой памяти.
                
                Если значение отрицательное, чтение остановится на указанном количестве байтов с
                конца сегмента разделяемой памяти.

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

<comment>See Also:</comment>
   * SyncSharedMemory::__construct
   * SyncSharedMemory::first
   * SyncSharedMemory::write
   * SyncSharedMemory::read


id: SyncSharedMemory::size
type: function
doc:
<comment>Description:</comment>
  Возвращает размер именованной разделяемой памяти
  
  Извлекает размер разделяемой памяти объекта <class>SyncSharedMemory</class>.

<comment>Return:</comment>
  <info>int</info>  Целое число, содержащее размер разделяемой памяти. Это будет тот же размер, который был
       передан конструктору.

<comment>See Also:</comment>
   * SyncSharedMemory::__construct
   * SyncSharedMemory::write
   * SyncSharedMemory::read


id: SyncSharedMemory::write
type: function
doc:
<comment>Description:</comment>
  Копирует данные в именованную разделяемую память
  
  Копирует данные в именованную разделяемую память.

<comment>Param:</comment>
  <info>string</info>  <strong>$string</strong>  Данные для записи в разделяемую память.
                   
                   Если размер данных превышает размер разделяемой памяти, количество записанных
                   возвращаемых байтов будет меньше длины входных данных.
  <info>int</info>     <strong>$start</strong>   Начало/смещение в байтах для начала записи.
                   
                   Если значение отрицательное, начальная позиция будет начинаться с указанного
                   количества байтов с конца сегмента разделяемой памяти.

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

<comment>See Also:</comment>
   * SyncSharedMemory::__construct
   * SyncSharedMemory::first
   * SyncSharedMemory::write
   * SyncSharedMemory::read


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


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


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


id: Table::count
type: function
doc:
<comment>Description:</comment>
  Получить количество строк
  
  Получить количество строк в таблице.

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


id: Table::delete
type: function
doc:
<comment>Description:</comment>
  Удалить строки из таблицы
  
  Удаляет строки из таблицы.

<comment>Return:</comment>
  <info>mysql_xdevapi\TableDelete</info>  Объект TableDelete; используйте метод execute() для выполнения запроса
                             delete


id: Table::existsInDatabase
type: function
doc:
<comment>Description:</comment>
  Проверить, существует ли таблица в базе данных
  
  Проверяет, существует ли данная таблица в базе данных.

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


id: Table::getName
type: function
doc:
<comment>Description:</comment>
  Получить имя таблицы
  
  Возвращает имя объекта базы данных.

<comment>Return:</comment>
  <info>string</info>  Имя объекта базы данных.


id: Table::getSchema
type: function
doc:
<comment>Description:</comment>
  Получить схему таблицы
  
  Извлечь схему, связанную с таблицей.

<comment>Return:</comment>
  <info>mysql_xdevapi\Schema</info>  Объект Schema.


id: Table::getSession
type: function
doc:
<comment>Description:</comment>
  Получить таблицу сессий
  
  Получить сессию, связанную с таблицей.

<comment>Return:</comment>
  <info>mysql_xdevapi\Session</info>  Объект Session.


id: Table::insert
type: function
doc:
<comment>Description:</comment>
  Вставить строки таблицы
  
  Вставляет строки в таблицу.

<comment>Param:</comment>
  <info>mixed</info>  <strong>$columns</strong>       Столбцы для вставки данных. Может быть массивом с одним или несколькими
                        значениями, либо строкой.
  <info>mixed</info>  <strong>$more_columns</strong>  Определения дополнительных столбцов.

<comment>Return:</comment>
  <info>mysql_xdevapi\TableInsert</info>  Объект TableInsert; используйте метод execute() для выполнения
                             выражения insert.


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

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


id: Table::select
type: function
doc:
<comment>Description:</comment>
  Выбрать строки из таблицы
  
  Извлекает данные из таблицы.

<comment>Param:</comment>
  <info>mixed</info>  <strong>$columns</strong>       Столбцы для выбора данных. Может быть массивом с одним или несколькими
                        значениями или строкой.
  <info>mixed</info>  <strong>$more_columns</strong>  Дополнительные определения параметров столбцов.

<comment>Return:</comment>
  <info>mysql_xdevapi\TableSelect</info>  Объект TableSelect; используйте метод execute() для выполнения select и
                             возврата объекта RowResult.


id: Table::update
type: function
doc:
<comment>Description:</comment>
  Обновить строки в таблице
  
  Обновляет столбцы в таблице.

<comment>Return:</comment>
  <info>mysql_xdevapi\TableUpdate</info>  Объект TableUpdate; используйте метод execute() для выполнения
                             выражения update.


id: TableDelete::__construct
type: function
doc:
<comment>Description:</comment>
  Конструктор класса TableDelete
  
  Инициируется с помощью метода delete().


id: TableDelete::bind
type: function
doc:
<comment>Description:</comment>
  Связывает параметры запроса удаления
  
  Привязывает значение к определённому заполнителю.

<comment>Param:</comment>
  <info>array</info>  <strong>$placeholder_values</strong>  Имя заполнителя и значение для привязки.

<comment>Return:</comment>
  <info>mysql_xdevapi\TableDelete</info>  Объект TableDelete.


id: TableDelete::execute
type: function
doc:
<comment>Description:</comment>
  Выполняет запрос на удаление
  
  Выполняет запрос на удаление.

<comment>Return:</comment>
  <info>mysql_xdevapi\Result</info>  Объект Result.


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

<comment>Param:</comment>
  <info>int</info>  <strong>$rows</strong>  Максимальное количество записей или документов для удаления.

<comment>Return:</comment>
  <info>mysql_xdevapi\TableDelete</info>  Объект TableDelete.


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

<comment>Param:</comment>
  <info>string</info>  <strong>$orderby_expr</strong>  Определение сортировки.

<comment>Return:</comment>
  <info>mysql_xdevapi\TableDelete</info>  Объект TableDelete.


id: TableDelete::where
type: function
doc:
<comment>Description:</comment>
  Устанавливает условие поиска для удаления
  
  Устанавливает условие поиска для фильтрации.

<comment>Param:</comment>
  <info>string</info>  <strong>$where_expr</strong>  Определяет условие поиска для фильтрации документов или записей.

<comment>Return:</comment>
  <info>mysql_xdevapi\TableDelete</info>  Объект TableDelete.


id: TableInsert::__construct
type: function
doc:
<comment>Description:</comment>
  Конструктор класса TableInsert
  
  Инициируется с помощью метода insert().


id: TableInsert::execute
type: function
doc:
<comment>Description:</comment>
  Выполняет запрос вставки
  
  Выполняет утверждение.

<comment>Return:</comment>
  <info>mysql_xdevapi\Result</info>  Объект Result.


id: TableInsert::values
type: function
doc:
<comment>Description:</comment>
  Добавляет значения вставки строки
  
  Устанавливает значения для вставки.

<comment>Param:</comment>
  <info>array</info>  <strong>$row_values</strong>  Значения (массив) столбцов для вставки.

<comment>Return:</comment>
  <info>mysql_xdevapi\TableInsert</info>  Объект TableInsert.


id: TableSelect::__construct
type: function
doc:
<comment>Description:</comment>
  Конструктор класса TableSelect
  
  Объект, возвращаемый методом select(); Используйте execute() для выполнения запроса.


id: TableSelect::bind
type: function
doc:
<comment>Description:</comment>
  Привязывает параметры запроса выборки
  
  Привязывает значение к определённому заполнителю.

<comment>Param:</comment>
  <info>array</info>  <strong>$placeholder_values</strong>  Название заполнителя и значение для привязки.

<comment>Return:</comment>
  <info>mysql_xdevapi\TableSelect</info>  Объект TableSelect.


id: TableSelect::execute
type: function
doc:
<comment>Description:</comment>
  Выполняет оператор выборки
  
  Выполняет утверждение выборки, связывая его с методом execute().

<comment>Return:</comment>
  <info>mysql_xdevapi\RowResult</info>  Объект RowResult.


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

<comment>Param:</comment>
  <info>mixed</info>  <strong>$sort_expr</strong>  Критерии группировки.

<comment>Return:</comment>
  <info>mysql_xdevapi\TableSelect</info>  Объект TableSelect.


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

<comment>Param:</comment>
  <info>string</info>  <strong>$sort_expr</strong>  Условие для агрегатных функций, используемых в критериях группировки.

<comment>Return:</comment>
  <info>mysql_xdevapi\TableSelect</info>  Объект TableSelect.


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

<comment>Param:</comment>
  <info>int</info>  <strong>$rows</strong>  Максимальное количество записей или документов.

<comment>Return:</comment>
  <info>mysql_xdevapi\TableSelect</info>  Объект TableSelect.


id: TableSelect::lockExclusive
type: function
doc:
<comment>Description:</comment>
  Выполняет EXCLUSIVE LOCK
  
  Выполняет операцию чтения с EXCLUSIVE LOCK. Только один замок может быть активным одновременно.

<comment>Param:</comment>
  <info>int</info>  <strong>$lock_waiting_option</strong>  Необязательный параметр ожидания, который по умолчанию равен
                             <info>MYSQLX_LOCK_DEFAULT</info>. Допустимые значения:
                             
                             <info>MYSQLX_LOCK_DEFAULT</info>
                             
                             <info>MYSQLX_LOCK_NOWAIT</info>
                             
                             <info>MYSQLX_LOCK_SKIP_LOCKED</info>

<comment>Return:</comment>
  <info>mysql_xdevapi\TableSelect</info>  Объект TableSelect.


id: TableSelect::lockShared
type: function
doc:
<comment>Description:</comment>
  Выполняет SHARED LOCK
  
  Выполняет операцию чтения с SHARED LOCK. Только один замок может быть активным одновременно.

<comment>Param:</comment>
  <info>int</info>  <strong>$lock_waiting_option</strong>  Необязательный параметр ожидания, который по умолчанию равен
                             <info>MYSQLX_LOCK_DEFAULT</info>. Допустимые значения:
                             
                             <info>MYSQLX_LOCK_DEFAULT</info>
                             
                             <info>MYSQLX_LOCK_NOWAIT</info>
                             
                             <info>MYSQLX_LOCK_SKIP_LOCKED</info>

<comment>Return:</comment>
  <info>mysql_xdevapi\TableSelect</info>  Объект TableSelect.


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

<comment>Param:</comment>
  <info>int</info>  <strong>$position</strong>  Предел смещения.

<comment>Return:</comment>
  <info>mysql_xdevapi\TableSelect</info>  Объект TableSelect.


id: TableSelect::orderby
type: function
doc:
<comment>Description:</comment>
  Устанавливает критерии сортировки выборки
  
  Устанавливает порядок по критериям.

<comment>Param:</comment>
  <info>mixed</info>  <strong>$sort_expr</strong>   Выражения, которые определяют порядок по критериям. Может быть массивом с
                      одним или несколькими выражениями или строкой.
  <info>mixed</info>  <strong>$sort_exprs</strong>  Дополнительные параметры sort_expr.

<comment>Return:</comment>
  <info>mysql_xdevapi\TableSelect</info>  Объект TableSelect.


id: TableSelect::where
type: function
doc:
<comment>Description:</comment>
  Устанавливает условие поиска выборки
  
  Устанавливает условие поиска для фильтрации.

<comment>Param:</comment>
  <info>string</info>  <strong>$where_expr</strong>  Определяет условие поиска для фильтрации документов или записей.

<comment>Return:</comment>
  <info>mysql_xdevapi\TableSelect</info>  Объект TableSelect.


id: TableUpdate::__construct
type: function
doc:
<comment>Description:</comment>
  Конструктор класса TableUpdate
  
  Инициируется с помощью метода update().


id: TableUpdate::bind
type: function
doc:
<comment>Description:</comment>
  Привязывает параметры запроса на обновление
  
  Привязывает значение к определённому заполнителю.

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

<comment>Return:</comment>
  <info>mysql_xdevapi\TableUpdate</info>  Объект TableUpdate.


id: TableUpdate::execute
type: function
doc:
<comment>Description:</comment>
  Выполняет запрос на обновление
  
  Выполняет утверждение обновления.

<comment>Return:</comment>
  <info>mysql_xdevapi\TableUpdate</info>  Объект TableUpdate.


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

<comment>Param:</comment>
  <info>int</info>  <strong>$rows</strong>  Максимальное количество записей или документов для обновления.

<comment>Return:</comment>
  <info>mysql_xdevapi\TableUpdate</info>  Объект TableUpdate.


id: TableUpdate::orderby
type: function
doc:
<comment>Description:</comment>
  Устанавливает критерии сортировки
  
  Устанавливает критерии сортировки.

<comment>Param:</comment>
  <info>mixed</info>  <strong>$orderby_expr</strong>   Выражения, которые определяют порядок по критериям. Может быть массивом с
                         одним или несколькими выражениями или строкой.
  <info>mixed</info>  <strong>$orderby_exprs</strong>  Дополнительные параметры sort_expr.

<comment>Return:</comment>
  <info>mysql_xdevapi\TableUpdate</info>  Объект TableUpdate.


id: TableUpdate::set
type: function
doc:
<comment>Description:</comment>
  Добавляет поле для обновления
  
  Обновляет значение столбца для записей в таблице.

<comment>Param:</comment>
  <info>string</info>  <strong>$table_field</strong>            Имя столбца, подлежащего обновлению.
  <info>string</info>  <strong>$expression_or_literal</strong>  Значение, которое будет установлено в указанном столбце.

<comment>Return:</comment>
  <info>mysql_xdevapi\TableUpdate</info>  Объект TableUpdate.


id: TableUpdate::where
type: function
doc:
<comment>Description:</comment>
  Устанавливает фильтр поиска
  
  Устанавливает условие поиска для фильтрации.

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

<comment>Return:</comment>
  <info>mysql_xdevapi\TableUpdate</info>  Объект TableUpdate.


id: Thread
type: class
doc:
<comment>Description:</comment>
  Когда вызван стартовый метод Thread, код метода run будет запущен в отдельном потоке, параллельно.
  
  После отработки метода run, Thread сразу же завершит работу. Он будет присоединён путём создания
  Thread в нужное время.
  
  Если полагаться на движок для определения, когда Thread будет присоединён, можно столкнуться с
  неожиданным поведением. Поэтому необходимо, по возможности, управлять присоединением в явном виде.


id: Thread::getCreatorId
type: function
doc:
<comment>Description:</comment>
  Идентификация
  
  Возвращает идентификатор потока, который создал указанный поток.

<comment>Return:</comment>
  <info>int</info>  Числовой идентификатор.


id: Thread::getCurrentThread
type: function
doc:
<comment>Description:</comment>
  Идентификация
  
  Возвращает ссылку на текущий выполняющийся поток.

<comment>Return:</comment>
  <info>Thread</info>  Объект, представляющий текущий выполняющийся поток.


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

<comment>Return:</comment>
  <info>int</info>  Числовой идентификатор.


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

<comment>Return:</comment>
  <info>int</info>  Числовой идентификатор.


id: Thread::isJoined
type: function
doc:
<comment>Description:</comment>
  Определение состояния
  
  Сообщает, был ли присоединён указанный поток.

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


id: Thread::isStarted
type: function
doc:
<comment>Description:</comment>
  Определение состояния
  
  Сообщает, был ли запущен указанный поток.

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


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

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


id: Thread::start
type: function
doc:
<comment>Description:</comment>
  Выполнение
  
  Запускает новый поток для выполнения реализованного метода запуска.

<comment>Param:</comment>
  <info>int</info>  <strong>$options</strong>  Необязательная маска констант наследования, по умолчанию PTHREADS_INHERIT_ALL.

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


id: Threaded
type: class
doc:
<comment>Description:</comment>
  Объекты Threaded формируют базис способности pthreads запускать пользовательский код в новых
  потоках. Класс содержит методы синхронизации и различные полезные интерфейсы.
  
  Самое важное, что объекты Threaded обеспечивают безопасность для разработчика. Все операции в
  контексте объекта - безопасны.


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

<comment>Param:</comment>
  <info>int</info>   <strong>$size</strong>      Количество элементов для получения.
  <info>bool</info>  <strong>$preserve</strong>  Сохранять ключи элементов, по умолчанию false.

<comment>Return:</comment>
  <info>array</info>  Массив элементов из таблицы свойств объектов.


id: Threaded::count
type: function
doc:
<comment>Description:</comment>
  Обработка
  
  Возвращает количество свойств для этого объекта.

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


id: Threaded::extend
type: function
doc:
<comment>Description:</comment>
  Обработка во время выполнения
  
  Делает потокобезопасный стандартный класс во время выполнения.

<comment>Param:</comment>
  <info>string</info>  <strong>$class</strong>  Класс для расширения.

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


id: Threaded::isRunning
type: function
doc:
<comment>Description:</comment>
  Определение состояния
  
  Сообщает, выполняется ли указанный объект.

<comment>Return:</comment>
  <info>bool</info>  Логическое значение состояния объекта.  Объект считается запущенным при выполнении метода
        run.
        
        Объект считается запущенным при выполнении метода run.


id: Threaded::isTerminated
type: function
doc:
<comment>Description:</comment>
  Определение состояния
  
  Сообщает, был ли объект, на который указывает ссылка, прекращён во время выполнения; произошли ли
  фатальные ошибки или были выброшены неперехваченные исключения.

<comment>Return:</comment>
  <info>bool</info>  Логическое значение состояния объекта.


id: Threaded::merge
type: function
doc:
<comment>Description:</comment>
  Обработка
  
  Объединяет данные в текущий объект.

<comment>Param:</comment>
  <info>mixed</info>  <strong>$from</strong>       Данные для объединения.
  <info>bool</info>   <strong>$overwrite</strong>  Перезаписать существующие ключи, по умолчанию true.

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


id: Threaded::notify
type: function
doc:
<comment>Description:</comment>
  Синхронизация
  
  Отправляет уведомление указанному объекту.

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


id: Threaded::notifyOne
type: function
doc:
<comment>Description:</comment>
  Синхронизация
  
  Отправляет уведомление указанному объекту. Это разблокирует по крайней мере один из
  заблокированных потоков (в отличие от Threaded::notify с разблокировкой всех потоков).

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


id: Threaded::pop
type: function
doc:
<comment>Description:</comment>
  Обработка
  
  Извлекает элемент из таблицы свойств объекта.

<comment>Return:</comment>
  <info>bool</info>  Последний элемент из таблицы свойств объектов.


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

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


id: Threaded::shift
type: function
doc:
<comment>Description:</comment>
  Обработка
  
  Перемещает элемент из таблицы свойств объекта.

<comment>Return:</comment>
  <info>mixed</info>  Первый элемент из таблицы свойств объекта.


id: Threaded::synchronized
type: function
doc:
<comment>Description:</comment>
  Синхронизация
  
  Выполняет блок, сохраняя блокировку синхронизации ссылочных объектов для вызывающего контекста.

<comment>Param:</comment>
  <info>Closure</info>  <strong>$block</strong>  Блок кода для выполнения.
  <info>mixed</info>    <strong>$args</strong>   Список аргументов переменной длины для использования в качестве аргументов
                   функции блока.

<comment>Return:</comment>
  <info>mixed</info>  Возвращаемое значение блока.


id: Threaded::wait
type: function
doc:
<comment>Description:</comment>
  Синхронизация
  
  Заставляет вызывающий контекст ждать уведомления от указанного объекта.

<comment>Param:</comment>
  <info>int</info>  <strong>$timeout</strong>  Необязательный параметр времени ожидания в микросекундах.

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


id: Throwable
type: class
doc:
<comment>Description:</comment>
  <class>Throwable</class> является родительским интерфейсом для всех объектов, выбрасывающихся с помощью выражения
  <return>throw</return>, включая классы <class>Error</class> и <class>Exception</class>.
  
  Классы PHP не могут напрямую реализовать интерфейс <class>Throwable</class>. Вместо этого они могут наследовать
  подкласс <class>Exception</class>.


id: Throwable::__toString
type: function
doc:
<comment>Description:</comment>
  Получает строковое представление выброшенного объекта

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

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


id: Throwable::getCode
type: function
doc:
<comment>Description:</comment>
  Возвращает код исключения
  
  Возвращает код ошибки выброшенного объекта, к которому применена функция.

<comment>Return:</comment>
  <info>int</info>  Возвращает код исключения в виде целого числа (<info>int</info>) в <class>Exception</class>, но возможен и другой
       возвращаемый тип в классах, наследующих <class>Exception</class> (например, в виде строки (<info>string</info>), если тип
       ошибки <class>PDOException</class>).

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


id: Throwable::getFile
type: function
doc:
<comment>Description:</comment>
  Возвращает файл, в котором выброшено исключение
  
  Возвращает имя файла, в котором данный объект был выброшен.

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

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


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

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

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


id: Throwable::getMessage
type: function
doc:
<comment>Description:</comment>
  Получает сообщение ошибки
  
  Возвращает сообщение ошибки данного выброшенного объекта.

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

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


id: Throwable::getPrevious
type: function
doc:
<comment>Description:</comment>
  Возвращает предыдущий Throwable
  
  Возвращает любой предыдущий Throwable (для примера, переданное третьим параметром в
  Exception::__construct).

<comment>Return:</comment>
  <info>Throwable|null</info>  Возвращает предыдущий <class>Throwable</class>, если он доступен, или <info>null</info> в противном случае.

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


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

<comment>Return:</comment>
  <info>array</info>  Возвращает трассировку стека в виде массива в таком же формате, что и <strong>debug_backtrace()</strong>.

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


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

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

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


id: Transliterator
type: class
doc:
<comment>Description:</comment>
  Данный класс предоставляет функциональность транслитерации строк.


id: Transliterator::__construct
type: function
doc:
<comment>Description:</comment>
  Приватный конструктор
  
  Этот метод не может быть вызван. Он существует только для закрытия возможности создания объекта с
  помощью оператора new.
  
  Вместо него используйте фабричные методы Transliterator::create или
  Transliterator::createFromRules.

<comment>See Also:</comment>
   * Transliterator::create
   * Transliterator::createFromRules


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

<comment>Param:</comment>
  <info>string</info>  <strong>$id</strong>         Идентификатор. Список всех зарегистрированных идентификаторов транслитератора
                      можно получить с помощью Transliterator::listIDs.
  <info>int</info>     <strong>$direction</strong>  Направление транслитерации. По умолчанию &gt;Transliterator::FORWARD. Можно
                      использовать Transliterator::REVERSE.

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

<comment>See Also:</comment>
   * Transliterator::getErrorMessage
   * Transliterator::__construct


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

<comment>Param:</comment>
  <info>string</info>  <strong>$rules</strong>      Правила, которые описаны в разделе Transform Rules Syntax отчёта UTS #35:
                      Unicode LDML.
  <info>int</info>     <strong>$direction</strong>  Направление транслитерации. По умолчанию Transliterator::FORWARD. Можно
                      использовать Transliterator::REVERSE.

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

<comment>See Also:</comment>
   * Transliterator::getErrorMessage
   * Transliterator::create


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

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

<comment>See Also:</comment>
   * Transliterator::getErrorMessage
   * Transliterator::create


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

<comment>Param:</comment>
  <info>Transliterator</info>  <strong>$transliterator</strong>  

<comment>Return:</comment>
  <info>int|false</info>  Код ошибки или <info>false</info>, если ошибок не было или если получить его не удалось.

<comment>See Also:</comment>
   * Transliterator::getErrorMessage
   * Transliterator::listIDs


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

<comment>Param:</comment>
  <info>Transliterator</info>  <strong>$transliterator</strong>  

<comment>Return:</comment>
  <info>string|false</info>  Сообщение об ошибке или <info>false</info>, если ошибок не было или если получить его не удалось.

<comment>See Also:</comment>
   * Transliterator::getErrorCode
   * Transliterator::listIDs


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

<comment>Return:</comment>
  <info>array|false</info>  Массив (<info>array</info>) зарегистрированных идентификаторов транслитератора или <info>false</info> в случае
               возникновения ошибки.

<comment>See Also:</comment>
   * Transliterator::getErrorMessage
   * Transliterator::transliterate


id: Transliterator::transliterate
type: function
doc:
<comment>Description:</comment>
  Транслитерировать строку
  
  Объектно-ориентированный стиль
  
  Процедурный стиль
  
  Преобразует строку или её часть, используя транслитератор ICU.

<comment>Param:</comment>
  <info>Transliterator|string</info>  <strong>$transliterator</strong>  В процедурном варианте, <class>Transliterator</class> или строка, из
                                          которой может быть собран объект <class>Transliterator</class>.
  <info>string</info>                 <strong>$string</strong>          Строка для транслитерации.
  <info>int</info>                    <strong>$start</strong>           Начальный индекс, включительно, (в кодовых единицах
                                          UTF-16), с которого начинается часть строки,
                                          предназначенная для транслитерации. Индексация начинается
                                          с 0. Текст до этой позиции останется как есть.
  <info>int</info>                    <strong>$end</strong>             Начальный индекс, не включая, (в кодовых единицах UTF-16),
                                          которым заканчивается часть строки, предназначенная для
                                          транслитерации. Индексация начинается с 0. Текст с этой
                                          позиции останется как есть.

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

<comment>See Also:</comment>
   * Transliterator::getErrorMessage
   * Transliterator::__construct


id: Traversable
type: class
doc:
<comment>Description:</comment>
  Интерфейс, определяющий, является ли класс обходимым (traversable) с использованием foreach.
  
  Абстрактный базовый интерфейс, который не может быть реализован сам по себе. Вместо этого должен
  реализовываться IteratorAggregate или Iterator.


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

<comment>Param:</comment>
  <info>string|null</info>  <strong>$destination_encoding</strong>  
  <info>string|null</info>  <strong>$source_encoding</strong>       


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

<comment>Param:</comment>
  <info>string</info>  <strong>$str</strong>      
  <info>bool</info>    <strong>$reverse</strong>  

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


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

<comment>Param:</comment>
  <info>int</info>    <strong>$reason</strong>     
  <info>array</info>  <strong>$source</strong>     
  <info>int</info>    <strong>$codePoint</strong>  
  <info>int</info>    <strong>$error</strong>      

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


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

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

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


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

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


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

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


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

<comment>Return:</comment>
  <info>int|false|null</info>  


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

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


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

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


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

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


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

<comment>Return:</comment>
  <info>int|false|null</info>  


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

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


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

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


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

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

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


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

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

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


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

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

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


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

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

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


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

<comment>Param:</comment>
  <info>int</info>     <strong>$reason</strong>     
  <info>string</info>  <strong>$source</strong>     
  <info>string</info>  <strong>$codeUnits</strong>  
  <info>int</info>     <strong>$error</strong>      

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


id: UConverter::transcode
type: function
doc:
<comment>Description:</comment>
  Преобразует строку из одной кодировки символов в другую
  
  Преобразует строку <strong>$str</strong> из кодировки <strong>$fromEncoding</strong> в <strong>$toEncoding</strong>.

<comment>Param:</comment>
  <info>string</info>      <strong>$str</strong>           Строка (<info>string</info>) для преобразования.
  <info>string</info>      <strong>$toEncoding</strong>    Требуемая кодировка результата.
  <info>string</info>      <strong>$fromEncoding</strong>  Текущая кодировка строки <strong>$str</strong>.
  <info>array|null</info>  <strong>$options</strong>       Необязательный массив (<info>array</info>), который может содержать следующие ключи:
                             <return>'to_subst'</return> - подстановочный символ, используемый вместо любого символа
                             строки <strong>$str</strong>, который не может быть закодирован в <strong>$toEncoding</strong>. Если ключ
                             указан, он должен представлять один символ в целевой кодировке.

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

<comment>See Also:</comment>
   * <strong>mb_convert_encoding()</strong>
   * <strong>iconv()</strong>


id: UI\Area
type: class
doc:
<comment>Description:</comment>
  Область (Area) представляет собой холст, который можно использовать для рисования и реагирования
  на события мыши и клавиш.


id: UI\Area::Alt
type: constant
doc:
<comment>Description:</comment>
  Должен быть установлен в модификаторах, переданных событиям клавиш и мыши, когда активна клавиша
  ALT


id: UI\Area::Ctrl
type: constant
doc:
<comment>Description:</comment>
  Должен быть установлен в модификаторах, переданных событиям клавиш и мыши, когда активна клавиша
  CTRL


id: UI\Area::Down
type: constant
doc:
<comment>Description:</comment>
  Должен быть установлен в модификаторах, переданных событиям клавиатуры и мыши


id: UI\Area::Shift
type: constant
doc:
<comment>Description:</comment>
  Должен быть установлен в модификаторах, переданных событиям клавиш и мыши, когда активна клавиша
  SHIFT


id: UI\Area::onDraw
type: function
doc:
<comment>Description:</comment>
  Функция обратного вызова при рисовании
  
  Вызывается, когда данная область требует перерисовки

<comment>Param:</comment>
  <info>UI\Draw\Pen</info>  <strong>$pen</strong>        Ручка (Pen), подходящая для рисования в этом районе
  <info>UI\Size</info>      <strong>$areaSize</strong>   Размер области
  <info>UI\Point</info>     <strong>$clipPoint</strong>  Точка обрезки (clip point) области
  <info>UI\Size</info>      <strong>$clipSize</strong>   Размер обрезки (clip size) области


id: UI\Area::onKey
type: function
doc:
<comment>Description:</comment>
  Функция обратного вызова при нажатии
  
  Выполняется при нажатии на клавиши

<comment>Param:</comment>
  <info>string</info>  <strong>$key</strong>    Нажатая клавиша
  <info>int</info>     <strong>$ext</strong>    Нажатая расширенная кнопка
  <info>int</info>     <strong>$flags</strong>  Модификаторы события


id: UI\Area::onMouse
type: function
doc:
<comment>Description:</comment>
  Функция обратного вызова мыши
  
  Вызывается при нажатии мыши

<comment>Param:</comment>
  <info>UI\Point</info>  <strong>$areaPoint</strong>  Координаты события
  <info>UI\Size</info>   <strong>$areaSize</strong>   Размер области события
  <info>int</info>       <strong>$flags</strong>      Модификаторы события


id: UI\Area::redraw
type: function
doc:
<comment>Description:</comment>
  Перерисовать область
  
  Запрашивает, чтобы эта область была перерисована


id: UI\Area::scrollTo
type: function
doc:
<comment>Description:</comment>
  Прокрутить область
  
  Прокрутить данную область

<comment>Param:</comment>
  <info>UI\Point</info>  <strong>$point</strong>  Точка прокрутки
  <info>UI\Size</info>   <strong>$size</strong>   Размер области прокрутки


id: UI\Area::setSize
type: function
doc:
<comment>Description:</comment>
  Установить размер
  
  Устанавливает размер области

<comment>Param:</comment>
  <info>UI\Size</info>  <strong>$size</strong>  Новый размер


id: UI\Control
type: class
doc:
<comment>Description:</comment>
  Это закрытый базовый класс для всех элементов управления пользовательского интерфейса.


id: UI\Control::destroy
type: function
doc:
<comment>Description:</comment>
  Уничтожить управляющий элемент
  
  Уничтожит данный управляющий элемент


id: UI\Control::disable
type: function
doc:
<comment>Description:</comment>
  Отключить управляющий элемент
  
  Отключит данный управляющий элемент


id: UI\Control::enable
type: function
doc:
<comment>Description:</comment>
  Включить управляющий элемент
  
  Включит данный управляющий элемент


id: UI\Control::getParent
type: function
doc:
<comment>Description:</comment>
  Получить родительский управляющий элемент
  
  Возвратит родительский управляющий элемент

<comment>Return:</comment>
  <info>UI\Control</info>  


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

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


id: UI\Control::hide
type: function
doc:
<comment>Description:</comment>
  Скрыть управляющий элемент
  
  Скрыть данный управляющий элемент


id: UI\Control::isEnabled
type: function
doc:
<comment>Description:</comment>
  Определить, включён ли управляющий элемент
  
  Определяет, включён ли управляющий элемент

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


id: UI\Control::isVisible
type: function
doc:
<comment>Description:</comment>
  Определить, видимый ли управляющий элемент
  
  Определяет, видимый ли управляющий элемент

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


id: UI\Control::setParent
type: function
doc:
<comment>Description:</comment>
  Установить родительский управляющий элемент
  
  Установит родительский управляющий элемент этого элемента управления

<comment>Param:</comment>
  <info>UI\Control</info>  <strong>$parent</strong>  Родительский управляющий элемент


id: UI\Controls\Box::__construct
type: function
doc:
<comment>Description:</comment>
  Создать новый объект Box
  
  Создаст новый блок

<comment>Param:</comment>
  <info>int</info>  <strong>$orientation</strong>  Box::Horizontal или Box::Vertical


id: UI\Controls\Box::append
type: function
doc:
<comment>Description:</comment>
  Добавить управляющий элемент
  
  Добавит заданный управляющий элемент к этому блоку

<comment>Param:</comment>
  <info>Control</info>  <strong>$control</strong>   Добавляемый элемент управления
  <info>bool</info>     <strong>$stretchy</strong>  Установить значение true, чтобы растянуть управляющий элемент

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


id: UI\Controls\Box::delete
type: function
doc:
<comment>Description:</comment>
  Удалить управляющий элемент
  
  Удалит элемент управления заданного индекса из данного блока

<comment>Param:</comment>
  <info>int</info>  <strong>$index</strong>  Индекс элемента управления для удаления

<comment>Return:</comment>
  <info>bool</info>  Показатель успешности выполнения


id: UI\Controls\Box::getOrientation
type: function
doc:
<comment>Description:</comment>
  Получить ориентацию
  
  Получает ориентацию данного блока

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


id: UI\Controls\Box::isPadded
type: function
doc:
<comment>Description:</comment>
  Определение заполнения
  
  Определяет, включено ли заполнение в этом блоке

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


id: UI\Controls\Box::setPadded
type: function
doc:
<comment>Description:</comment>
  Установить заполнение
  
  Определяет, включено или выключено заполнение в этом блоке

<comment>Param:</comment>
  <info>bool</info>  <strong>$padded</strong>  


id: UI\Controls\Button::__construct
type: function
doc:
<comment>Description:</comment>
  Создать новый объект Button
  
  Создаст новый объект Button

<comment>Param:</comment>
  <info>string</info>  <strong>$text</strong>  Текст (метка) для данной кнопки


id: UI\Controls\Button::getText
type: function
doc:
<comment>Description:</comment>
  Получить текст
  
  Получить текст (метку) для данного объекта Button

<comment>Return:</comment>
  <info>string</info>  Текущий текст (метка)


id: UI\Controls\Button::onClick
type: function
doc:
<comment>Description:</comment>
  Обработчик клика
  
  Выполняется при нажатии этого объекта Button


id: UI\Controls\Button::setText
type: function
doc:
<comment>Description:</comment>
  Установить текст
  
  Устанавливает текст (метку) для данного объекта Button

<comment>Param:</comment>
  <info>string</info>  <strong>$text</strong>  Новый текст (метка)


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

<comment>Param:</comment>
  <info>string</info>  <strong>$text</strong>  Текст (метка) для чекбокса


id: UI\Controls\Check::getText
type: function
doc:
<comment>Description:</comment>
  Получить текст
  
  Получает текст (метку) для данного чекбокса

<comment>Return:</comment>
  <info>string</info>  Текущий текст (метка)


id: UI\Controls\Check::isChecked
type: function
doc:
<comment>Description:</comment>
  Определение отметки
  
  Определит статус выбора данного чекбокса

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


id: UI\Controls\Check::onToggle
type: function
doc:
<comment>Description:</comment>
  Функция обратного вызова переключения
  
  Выполняется при изменении статуса этого чекбокса.


id: UI\Controls\Check::setChecked
type: function
doc:
<comment>Description:</comment>
  Установить статус выбранности
  
  Изменит статус этого чекбокса

<comment>Param:</comment>
  <info>bool</info>  <strong>$checked</strong>  Новый статус


id: UI\Controls\Check::setText
type: function
doc:
<comment>Description:</comment>
  Установить текст
  
  Установит текст (метку) данного чекбокса

<comment>Param:</comment>
  <info>string</info>  <strong>$text</strong>  Новый текст (метка)


id: UI\Controls\ColorButton
type: class
doc:
<comment>Description:</comment>
  Кнопка с палитрой цветов - это кнопка, которая отображает селектор цвета при нажатии


id: UI\Controls\ColorButton::getColor
type: function
doc:
<comment>Description:</comment>
  Получить объект Color
  
  Получить текущий выбранный объект Color

<comment>Return:</comment>
  <info>UI\Color</info>  


id: UI\Controls\ColorButton::onChange
type: function
doc:
<comment>Description:</comment>
  Обработчик изменения
  
  Выполняется при изменении выбранного объекта Color


id: UI\Controls\ColorButton::setColor
type: function
doc:
<comment>Description:</comment>
  Установить объект Color
  
  Устанавливает текущий выбранный объект Color

<comment>Param:</comment>
  <info>UI\Draw\Color</info>  <strong>$color</strong>  Новый цвет


id: UI\Controls\Combo
type: class
doc:
<comment>Description:</comment>
  Элемент управления "Комбо" представляет список опций, например, похожий на HTML-элемент.


id: UI\Controls\Combo::append
type: function
doc:
<comment>Description:</comment>
  Добавить опцию
  
  Добавить опцию к данному элементу "Комбо"

<comment>Param:</comment>
  <info>string</info>  <strong>$text</strong>  Текст для новой опции


id: UI\Controls\Combo::getSelected
type: function
doc:
<comment>Description:</comment>
  Получить выбранную опцию
  
  Получает индекс опции, выбранной в этом элементе "Комбо"

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


id: UI\Controls\Combo::onSelected
type: function
doc:
<comment>Description:</comment>
  Обработчик выбранной опции
  
  Выполняется, если в этом элементе "Комбо" выбрана опция


id: UI\Controls\Combo::setSelected
type: function
doc:
<comment>Description:</comment>
  Устанавливает выбранную опцию
  
  Установит выбранную в данный момент опцию в данном элементе "Комбо"

<comment>Param:</comment>
  <info>int</info>  <strong>$index</strong>  Индекс опции для выбора


id: UI\Controls\EditableCombo
type: class
doc:
<comment>Description:</comment>
  Редактируемый элемент управления "Комбо" позволяет пользователю вводить произвольные опции


id: UI\Controls\EditableCombo::append
type: function
doc:
<comment>Description:</comment>
  Добавить опцию
  
  Добавить опцию к данному редактируемому элементу "Комбо"

<comment>Param:</comment>
  <info>string</info>  <strong>$text</strong>  Текст для новой опции


id: UI\Controls\EditableCombo::getText
type: function
doc:
<comment>Description:</comment>
  Получить текст
  
  Получает значение выбранной в данный момент опции в данном редактируемом элементе "Комбо"

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


id: UI\Controls\EditableCombo::onChange
type: function
doc:
<comment>Description:</comment>
  Обработчик изменения
  
  Выполняется, когда изменяется значение данного редактируемого элемента "Комбо"


id: UI\Controls\EditableCombo::setText
type: function
doc:
<comment>Description:</comment>
  Установить текст
  
  Установит текст выбранной в данный момент опции в данном редактируемом элементе "Комбо"

<comment>Param:</comment>
  <info>string</info>  <strong>$text</strong>  Новый текст


id: UI\Controls\Entry
type: class
doc:
<comment>Description:</comment>
  Ввод (Entry) - элемент управления текстовой записи, подходящий для ввода простого текста, паролей
  или поисковых запросов.


id: UI\Controls\Entry::__construct
type: function
doc:
<comment>Description:</comment>
  Создать новый объект Entry
  
  Создать новый элемент управления "Ввод" заданного типа

<comment>Param:</comment>
  <info>int</info>  <strong>$type</strong>  Entry::Normal, Entry::Password или Entry::Search


id: UI\Controls\Entry::getText
type: function
doc:
<comment>Description:</comment>
  Получить текст
  
  Возвратит текущий текст из управляющего элемента "Ввод"

<comment>Return:</comment>
  <info>string</info>  Текущий текст


id: UI\Controls\Entry::isReadOnly
type: function
doc:
<comment>Description:</comment>
  Определить, является ли элемент только для чтения
  
  Определяет, является ли управляющий элемент "Ввод" только для чтения

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


id: UI\Controls\Entry::onChange
type: function
doc:
<comment>Description:</comment>
  Обработчик изменения
  
  Выполняется при изменении текста в данном элементе управления "Ввод"


id: UI\Controls\Entry::setReadOnly
type: function
doc:
<comment>Description:</comment>
  Установить "только для чтения"
  
  Включить или отключить только для чтения в данном управляющем элементе "Ввод"

<comment>Param:</comment>
  <info>bool</info>  <strong>$readOnly</strong>  


id: UI\Controls\Entry::setText
type: function
doc:
<comment>Description:</comment>
  Установить текст
  
  Устанавливает текст для данного управляющего элемента "Ввод"

<comment>Param:</comment>
  <info>string</info>  <strong>$text</strong>  Новый текст


id: UI\Controls\Form
type: class
doc:
<comment>Description:</comment>
  Форма - это элемент управления, позволяющий размещать другие элементы управления в макете (форме).


id: UI\Controls\Form::append
type: function
doc:
<comment>Description:</comment>
  Добавить управляющий элемент
  
  Добавляет элемент управления к форме и устанавливает метку

<comment>Param:</comment>
  <info>string</info>      <strong>$label</strong>     Текст для метки
  <info>UI\Control</info>  <strong>$control</strong>   Управляющий элемент
  <info>bool</info>        <strong>$stretchy</strong>  Должно быть значение true, чтобы растянуть элемент управления

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


id: UI\Controls\Form::delete
type: function
doc:
<comment>Description:</comment>
  Удалить элемент управления
  
  Удаляет управляющий элемент заданного индекса в данной форме

<comment>Param:</comment>
  <info>int</info>  <strong>$index</strong>  Индекс элемента управления для удаления

<comment>Return:</comment>
  <info>bool</info>  Индикатор успешности выполнения


id: UI\Controls\Form::isPadded
type: function
doc:
<comment>Description:</comment>
  Определение заполнения
  
  Определяет, включено ли заполнение в данной форме

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


id: UI\Controls\Form::setPadded
type: function
doc:
<comment>Description:</comment>
  Установить заполнение
  
  Определяет, включено или выключено заполнение в данной форме

<comment>Param:</comment>
  <info>bool</info>  <strong>$padded</strong>  


id: UI\Controls\Grid
type: class
doc:
<comment>Description:</comment>
  Сетка - это элемент управления, позволяющий размещать дочерние элементы в сетке


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

<comment>Param:</comment>
  <info>UI\Control</info>  <strong>$control</strong>  Элемент управления для добавления
  <info>int</info>         <strong>$left</strong>     
  <info>int</info>         <strong>$top</strong>      
  <info>int</info>         <strong>$xspan</strong>    
  <info>int</info>         <strong>$yspan</strong>    
  <info>bool</info>        <strong>$hexpand</strong>  
  <info>int</info>         <strong>$halign</strong>   
  <info>bool</info>        <strong>$vexpand</strong>  
  <info>int</info>         <strong>$valign</strong>   


id: UI\Controls\Grid::isPadded
type: function
doc:
<comment>Description:</comment>
  Определение заполнения
  
  Определяет, включено ли заполнение в данной сетке

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


id: UI\Controls\Grid::setPadded
type: function
doc:
<comment>Description:</comment>
  Установить заполнение
  
  Определяет, включено или выключено заполнение в данной сетке

<comment>Param:</comment>
  <info>bool</info>  <strong>$padding</strong>  


id: UI\Controls\Group::__construct
type: function
doc:
<comment>Description:</comment>
  Создать новый объект Group
  
  Создаёт новый объект Group с заданным заголовком

<comment>Param:</comment>
  <info>string</info>  <strong>$title</strong>  Текст заголовка метки


id: UI\Controls\Group::append
type: function
doc:
<comment>Description:</comment>
  Добавить управляющий элемент
  
  Добавляет элемент управления к группе

<comment>Param:</comment>
  <info>UI\Control</info>  <strong>$control</strong>  Управляющий элемент для добавления


id: UI\Controls\Group::getTitle
type: function
doc:
<comment>Description:</comment>
  Получить заголовок
  
  Возвращает текущий заголовок для данной группы

<comment>Return:</comment>
  <info>string</info>  Текущий заголовок


id: UI\Controls\Group::hasMargin
type: function
doc:
<comment>Description:</comment>
  Определение поля
  
  Определяет, имеет ли данная группа поле (margin)

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


id: UI\Controls\Group::setMargin
type: function
doc:
<comment>Description:</comment>
  Установить поле
  
  Включить или отключить поля для данной группы

<comment>Param:</comment>
  <info>bool</info>  <strong>$margin</strong>  


id: UI\Controls\Group::setTitle
type: function
doc:
<comment>Description:</comment>
  Установить заголовок
  
  Установить заголовок для заданной группы

<comment>Param:</comment>
  <info>string</info>  <strong>$title</strong>  Текст для нового заголовка


id: UI\Controls\Label
type: class
doc:
<comment>Description:</comment>
  Метка представляет одну строку текста, предназначенную для идентификации пользователем
  определённого элемента интерфейса.


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

<comment>Param:</comment>
  <info>string</info>  <strong>$text</strong>  Текст для данной метки


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

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


id: UI\Controls\Label::setText
type: function
doc:
<comment>Description:</comment>
  Установить текст
  
  Устанавливает текст для данной метки

<comment>Param:</comment>
  <info>string</info>  <strong>$text</strong>  Новый текст


id: UI\Controls\MultilineEntry
type: class
doc:
<comment>Description:</comment>
  Многострочный ввод - это элемент управления текстовой записи, способный хранить несколько строк
  текста, с переносом строк или без него.


id: UI\Controls\MultilineEntry::__construct
type: function
doc:
<comment>Description:</comment>
  Создать новый объект "Многострочный ввод"
  
  Создаёт новый объект управляющего элемента "Многострочный ввод" заданного типа

<comment>Param:</comment>
  <info>int</info>  <strong>$type</strong>  MultilineEntry::Wrap или MultilineEntry::NoWrap


id: UI\Controls\MultilineEntry::append
type: function
doc:
<comment>Description:</comment>
  Добавить текст
  
  Добавляет заданный текст к тексту в многострочном элементе управления "Ввод"

<comment>Param:</comment>
  <info>string</info>  <strong>$text</strong>  Текст для добавления


id: UI\Controls\MultilineEntry::getText
type: function
doc:
<comment>Description:</comment>
  Получить текст
  
  Возвращает текст в данном управляющем элементе "Многострочный ввод"

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


id: UI\Controls\MultilineEntry::isReadOnly
type: function
doc:
<comment>Description:</comment>
  Определение "только для чтения"
  
  Определяет, является ли элемент управления "Многострочный ввод" только для чтения

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


id: UI\Controls\MultilineEntry::onChange
type: function
doc:
<comment>Description:</comment>
  Обработчик изменения
  
  Выполняется при изменении текста в данном элементе управления "Многострочный ввод"


id: UI\Controls\MultilineEntry::setReadOnly
type: function
doc:
<comment>Description:</comment>
  Установить "только для чтения"
  
  Включить или отключить только для чтения в данном управляющем элементе "Многострочный ввод"

<comment>Param:</comment>
  <info>bool</info>  <strong>$readOnly</strong>  


id: UI\Controls\MultilineEntry::setText
type: function
doc:
<comment>Description:</comment>
  Установить текст
  
  Устанавливает текст для данного управляющего элемента "Многострочный ввод"

<comment>Param:</comment>
  <info>string</info>  <strong>$text</strong>  Новый текст


id: UI\Controls\Picker
type: class
doc:
<comment>Description:</comment>
  Селектор представляет кнопку, которая при нажатии открывает нативный интерфейс селектора
  даты/времени/даты и времени.


id: UI\Controls\Picker::__construct
type: function
doc:
<comment>Description:</comment>
  Создаёт новый объект Picker
  
  Создать новый объект Picker заданного типа

<comment>Param:</comment>
  <info>int</info>  <strong>$type</strong>  Picker::Date, Picker::Time или Picker::DateTime


id: UI\Controls\Progress
type: class
doc:
<comment>Description:</comment>
  Элемент управления "Ход выполнения" похож на знакомый индикатор выполнения: Он представляет собой
  индикатор выполнения в процентах с допустимым диапазоном от 0 до 100 (включительно).


id: UI\Controls\Progress::getValue
type: function
doc:
<comment>Description:</comment>
  Получить значение
  
  Получить текущее значение данного индикатора выполнения

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


id: UI\Controls\Progress::setValue
type: function
doc:
<comment>Description:</comment>
  Установить значение
  
  Установить значение данному индикатору выполнения

<comment>Param:</comment>
  <info>int</info>  <strong>$value</strong>  Целое число между 0 и 100 (включительно)


id: UI\Controls\Radio::append
type: function
doc:
<comment>Description:</comment>
  Добавляет вариант
  
  Добавляет новый вариант для радиокнопки

<comment>Param:</comment>
  <info>string</info>  <strong>$text</strong>  Текст (метка) для данного варианта


id: UI\Controls\Radio::getSelected
type: function
doc:
<comment>Description:</comment>
  Получить выбранный вариант
  
  Получает индекс выбранного в данный момент варианта в данной радиокнопке

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


id: UI\Controls\Radio::onSelected
type: function
doc:
<comment>Description:</comment>
  Обработчик выбора
  
  Выполняется, когда выбирается вариант в данной радиокнопке


id: UI\Controls\Radio::setSelected
type: function
doc:
<comment>Description:</comment>
  Установить выбранный вариант
  
  Включить выбранный в данный момент вариант

<comment>Param:</comment>
  <info>int</info>  <strong>$index</strong>  Индекс варианта для выбора


id: UI\Controls\Separator
type: class
doc:
<comment>Description:</comment>
  Разделитель представляет элемент управления разделителя без каких-либо функций.


id: UI\Controls\Separator::__construct
type: function
doc:
<comment>Description:</comment>
  Создать новый объект Separator
  
  Создаст новый объект Separator заданного типа

<comment>Param:</comment>
  <info>int</info>  <strong>$type</strong>  Separator::Horizonal или Separator::Vertical


id: UI\Controls\Slider
type: class
doc:
<comment>Description:</comment>
  Слайдер - это элемент управления, представляющий диапазон и текущее значение в нем. Скользящий
  элемент управления (иногда называемый «большим пальцем») отражает значение и может быть
  отрегулирован в пределах диапазона.


id: UI\Controls\Slider::__construct
type: function
doc:
<comment>Description:</comment>
  Создаёт новый объект Slider
  
  Создать новый объект Slider с заданным диапазоном

<comment>Param:</comment>
  <info>int</info>  <strong>$min</strong>  Минимальное разрешённое значение
  <info>int</info>  <strong>$max</strong>  Максимальное разрешённое значение


id: UI\Controls\Slider::getValue
type: function
doc:
<comment>Description:</comment>
  Получить значение
  
  Получить значение из данного слайдера

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


id: UI\Controls\Slider::onChange
type: function
doc:
<comment>Description:</comment>
  Обработчик изменения
  
  Выполняется при изменении значения в данном слайдере


id: UI\Controls\Slider::setValue
type: function
doc:
<comment>Description:</comment>
  Установить значение
  
  Установит значение для данного слайдера

<comment>Param:</comment>
  <info>int</info>  <strong>$value</strong>  Новое значение


id: UI\Controls\Spin
type: class
doc:
<comment>Description:</comment>
  Блок "Спин" представляет текстовое поле с элементом управления "вверх", который изменяет
  целочисленное значение в поле, в пределах заданного диапазона


id: UI\Controls\Spin::__construct
type: function
doc:
<comment>Description:</comment>
  Создаёт новый объект Spin
  
  Создаёт новый объект Spin с заданным диапазоном

<comment>Param:</comment>
  <info>int</info>  <strong>$min</strong>  Минимальное разрешённое значение
  <info>int</info>  <strong>$max</strong>  Максимальное разрешённое значение


id: UI\Controls\Spin::getValue
type: function
doc:
<comment>Description:</comment>
  Получить значение
  
  Получить значение в данном элементе управления "Спин"

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


id: UI\Controls\Spin::onChange
type: function
doc:
<comment>Description:</comment>
  Обработчик изменения
  
  Выполняется при изменении значения в данном управляющем элементе "Спин"


id: UI\Controls\Spin::setValue
type: function
doc:
<comment>Description:</comment>
  Установить значение
  
  Установить значение в данном элементе управления "Спин"

<comment>Param:</comment>
  <info>int</info>  <strong>$value</strong>  Новое значение


id: UI\Controls\Tab
type: class
doc:
<comment>Description:</comment>
  Таб может содержать много выбираемых пользователем страниц элементов управления, у каждой из
  которой есть заголовок.


id: UI\Controls\Tab::append
type: function
doc:
<comment>Description:</comment>
  Добавить страницу
  
  Добавить новую страницу к данному управляющему элементу "Таб"

<comment>Param:</comment>
  <info>string</info>      <strong>$name</strong>     Название новой страницы
  <info>UI\Control</info>  <strong>$control</strong>  Управляющий элемент для новой страницы

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


id: UI\Controls\Tab::delete
type: function
doc:
<comment>Description:</comment>
  Удалить страницу
  
  Удалит выбранную страницу из управляющего элемента "Таб"

<comment>Param:</comment>
  <info>int</info>  <strong>$index</strong>  Индекс страницы для удаления

<comment>Return:</comment>
  <info>bool</info>  Индикатор успешности выполнения


id: UI\Controls\Tab::hasMargin
type: function
doc:
<comment>Description:</comment>
  Определения поля
  
  Определяет, есть ли у заданной страницы поле.

<comment>Param:</comment>
  <info>int</info>  <strong>$page</strong>  Индекс страницы

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


id: UI\Controls\Tab::insertAt
type: function
doc:
<comment>Description:</comment>
  Вставить страницу
  
  Вставит новую страницу к управляющему элементу "Таб"

<comment>Param:</comment>
  <info>string</info>      <strong>$name</strong>     Название новой страницы
  <info>int</info>         <strong>$page</strong>     Индекс страницы перед которой вставить данную страницу
  <info>UI\Control</info>  <strong>$control</strong>  Управляющий элемент для новой страницы


id: UI\Controls\Tab::pages
type: function
doc:
<comment>Description:</comment>
  Количество страниц
  
  Возвратит количество страниц в данном управляющем элементе "Таб"

<comment>Return:</comment>
  <info>int</info>  Количество страниц в данном управляющем элементе "Таб"


id: UI\Controls\Tab::setMargin
type: function
doc:
<comment>Description:</comment>
  Установить поле
  
  Включить или отключить поля на выбранной странице

<comment>Param:</comment>
  <info>int</info>   <strong>$page</strong>    Страница для вставки
  <info>bool</info>  <strong>$margin</strong>  Переключатель поля


id: UI\Draw\Brush::__construct
type: function
doc:
<comment>Description:</comment>
  Создать новый объект Brush
  
  Создаст сплошную кисть, используя заданный цвет

<comment>Param:</comment>
  <info>UI\Draw\Color</info>  <strong>$color</strong>  Может быть UI\Draw\Color или RRGGBBAA


id: UI\Draw\Brush::getColor
type: function
doc:
<comment>Description:</comment>
  Получить цвет
  
  Возвратит объект UI\Draw\Color для данной кисти

<comment>Return:</comment>
  <info>UI\Draw\Color</info>  Текущий цвет кисти


id: UI\Draw\Brush::setColor
type: function
doc:
<comment>Description:</comment>
  Установить цвет
  
  Установит переданный цвет для данной кисти

<comment>Param:</comment>
  <info>UI\Draw\Color</info>  <strong>$color</strong>  Может быть UI\Draw\Color или RRGGBBAA

<comment>Return:</comment>
  <info>void</info>  


id: UI\Draw\Brush\Gradient::addStop
type: function
doc:
<comment>Description:</comment>
  Добавляет узел градиента
  
  Добавляет узел градиента заданного цвета в заданной позиции.

<comment>Param:</comment>
  <info>float</info>          <strong>$position</strong>  Позиция для нового узла.
  <info>UI\Draw\Color</info>  <strong>$color</strong>     Цвет для нового узла, может быть UI\Draw\Color или RRGGBBAA.

<comment>Return:</comment>
  <info>int</info>  Общее число узлов.


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

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

<comment>Return:</comment>
  <info>int</info>  Общее число узлов.


id: UI\Draw\Brush\Gradient::setStop
type: function
doc:
<comment>Description:</comment>
  Устанавливает узел градиента

<comment>Param:</comment>
  <info>int</info>            <strong>$index</strong>     Индекс узла для установки.
  <info>float</info>          <strong>$position</strong>  Позиция для узла.
  <info>UI\Draw\Color</info>  <strong>$color</strong>     Цвет для нового узла, может быть UI\Draw\Color или RRGGBBAA.

<comment>Return:</comment>
  <info>bool</info>  Индикация успеха.


id: UI\Draw\Brush\LinearGradient::__construct
type: function
doc:
<comment>Description:</comment>
  Конструктор класса LinearGradient
  
  Создаёт новый линейный градиент

<comment>Param:</comment>
  <info>UI\Point</info>  <strong>$start</strong>  
  <info>UI\Point</info>  <strong>$end</strong>    


id: UI\Draw\Brush\RadialGradient::__construct
type: function
doc:
<comment>Description:</comment>
  Конструктор класса RadialGradient
  
  Создаёт новый радиальный градиент

<comment>Param:</comment>
  <info>UI\Point</info>  <strong>$start</strong>   
  <info>UI\Point</info>  <strong>$outer</strong>   
  <info>float</info>     <strong>$radius</strong>  


id: UI\Draw\Color
type: class
doc:
<comment>Description:</comment>
  Представляет цвета RGBA, отдельные каналы доступны через общедоступные свойства.


id: UI\Draw\Color::__construct
type: function
doc:
<comment>Description:</comment>
  Создать новый объект Color
  
  Создаст новый цвет

<comment>Param:</comment>
  <info>UI\Draw\Color</info>  <strong>$color</strong>  Может быть UI\Draw\Color или RRGGBBAA


id: UI\Draw\Color::getChannel
type: function
doc:
<comment>Description:</comment>
  Управление цветом
  
  Получит значение канала

<comment>Param:</comment>
  <info>int</info>  <strong>$channel</strong>  Идентификация постоянного канала

<comment>Return:</comment>
  <info>float</info>  Текущее значение запрошенного канала


id: UI\Draw\Color::setChannel
type: function
doc:
<comment>Description:</comment>
  Управление цветом
  
  Установит выбранный канал на заданное значение

<comment>Param:</comment>
  <info>int</info>    <strong>$channel</strong>  Идентификация постоянного канала
  <info>float</info>  <strong>$value</strong>    Новое значение выбранного канала

<comment>Return:</comment>
  <info>void</info>  


id: UI\Draw\Matrix::isInvertible
type: function
doc:
<comment>Description:</comment>
  Определение, инвертирована ли матрица
  
  Определить, инвертирована ли матрица

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


id: UI\Draw\Matrix::multiply
type: function
doc:
<comment>Description:</comment>
  Умножить матрицу
  
  Умножит данную матрицу на заданную матрицу

<comment>Return:</comment>
  <info>UI\Draw\Matrix</info>  Новая матрица


id: UI\Draw\Matrix::rotate
type: function
doc:
<comment>Description:</comment>
  Перевернуть матрицу
  
  Перевернёт данную матрицу

<comment>Param:</comment>
  <info>UI\Point</info>  <strong>$point</strong>   
  <info>float</info>     <strong>$amount</strong>  


id: UI\Draw\Matrix::scale
type: function
doc:
<comment>Description:</comment>
  Масштабировать матрицу
  
  Масштабирует данную матрицу

<comment>Param:</comment>
  <info>UI\Point</info>  <strong>$center</strong>  
  <info>UI\Point</info>  <strong>$point</strong>   


id: UI\Draw\Matrix::skew
type: function
doc:
<comment>Description:</comment>
  Наклонить матрицу
  
  Наклонит данную матрицу

<comment>Param:</comment>
  <info>UI\Point</info>  <strong>$point</strong>   
  <info>UI\Point</info>  <strong>$amount</strong>  


id: UI\Draw\Matrix::translate
type: function
doc:
<comment>Description:</comment>
  Перевести матрицу
  
  Переведёт данную матрицу

<comment>Param:</comment>
  <info>UI\Point</info>  <strong>$point</strong>  


id: UI\Draw\Path::__construct
type: function
doc:
<comment>Description:</comment>
  Создать новый объект Path
  
  Создаст новый путь в заданном режиме

<comment>Param:</comment>
  <info>int</info>  <strong>$mode</strong>  Path::Winding или Path::Alternate


id: UI\Draw\Path::addRectangle
type: function
doc:
<comment>Description:</comment>
  Нарисовать прямоугольник
  
  Нарисовать путь прямоугольника заданного размера в определённой точке

<comment>Param:</comment>
  <info>UI\Point</info>  <strong>$point</strong>  Точка начала формы
  <info>UI\Size</info>   <strong>$size</strong>   Размер прямоугольника


id: UI\Draw\Path::arcTo
type: function
doc:
<comment>Description:</comment>
  Нарисовать дугу
  
  Нарисует дугу

<comment>Param:</comment>
  <info>UI\Point</info>  <strong>$point</strong>     Точка начала отображения
  <info>float</info>     <strong>$radius</strong>    Радиус дуги
  <info>float</info>     <strong>$angle</strong>     Угол дуги
  <info>float</info>     <strong>$sweep</strong>     Размах дуги
  <info>float</info>     <strong>$negative</strong>  


id: UI\Draw\Path::bezierTo
type: function
doc:
<comment>Description:</comment>
  Нарисовать кривую Безье
  
  Нарисует кривую Безье

<comment>Param:</comment>
  <info>UI\Point</info>  <strong>$point</strong>     Точка начала отображения
  <info>float</info>     <strong>$radius</strong>    Радиус кривой
  <info>float</info>     <strong>$angle</strong>     Угол кривой
  <info>float</info>     <strong>$sweep</strong>     Размах кривой
  <info>float</info>     <strong>$negative</strong>  


id: UI\Draw\Path::lineTo
type: function
doc:
<comment>Description:</comment>
  Нарисовать линию
  
  Нарисует путь линии

<comment>Param:</comment>
  <info>UI\Point</info>  <strong>$point</strong>     Точка начала отображения
  <info>float</info>     <strong>$radius</strong>    
  <info>float</info>     <strong>$angle</strong>     
  <info>float</info>     <strong>$sweep</strong>     
  <info>float</info>     <strong>$negative</strong>  


id: UI\Draw\Path::newFigure
type: function
doc:
<comment>Description:</comment>
  Нарисовать фигуру
  
  Нарисует новую фигуру в заданной точке

<comment>Param:</comment>
  <info>UI\Point</info>  <strong>$point</strong>  Точка начала отображения


id: UI\Draw\Path::newFigureWithArc
type: function
doc:
<comment>Description:</comment>
  Нарисовать фигуру с дугой

<comment>Param:</comment>
  <info>UI\Point</info>  <strong>$point</strong>     
  <info>float</info>     <strong>$radius</strong>    
  <info>float</info>     <strong>$angle</strong>     
  <info>float</info>     <strong>$sweep</strong>     
  <info>float</info>     <strong>$negative</strong>  


id: UI\Draw\Pen
type: class
doc:
<comment>Description:</comment>
  Перо передаётся обработчику события "рисованию области" (Area Draw), он используется для
  обрезания, заполнения, обводки и записи в "пути рисования" (Draw Paths).


id: UI\Draw\Pen::clip
type: function
doc:
<comment>Description:</comment>
  Обрезать путь
  
  Обрежет заданный путь

<comment>Param:</comment>
  <info>UI\Draw\Path</info>  <strong>$path</strong>  Путь для обрезки


id: UI\Draw\Pen::fill
type: function
doc:
<comment>Description:</comment>
  Залить путь
  
  Заливает заданный путь

<comment>Param:</comment>
  <info>UI\Draw\Path</info>   <strong>$path</strong>  Путь для заливки
  <info>UI\Draw\Brush</info>  <strong>$with</strong>  Цвет или кисть для заливки


id: UI\Draw\Pen::stroke
type: function
doc:
<comment>Description:</comment>
  Обвести путь
  
  Обведёт путь

<comment>Param:</comment>
  <info>UI\Draw\Path</info>    <strong>$path</strong>    Путь для обводки
  <info>UI\Draw\Brush</info>   <strong>$with</strong>    Цвет или кисть, чтобы обвести
  <info>UI\Draw\Stroke</info>  <strong>$stroke</strong>  Конфигурация обводки


id: UI\Draw\Pen::transform
type: function
doc:
<comment>Description:</comment>
  Преобразовать матрицу
  
  Преобразует матрицу

<comment>Param:</comment>
  <info>UI\Draw\Matrix</info>  <strong>$matrix</strong>  Используемая матрица


id: UI\Draw\Pen::write
type: function
doc:
<comment>Description:</comment>
  Нарисовать текст в точке
  
  Нарисует заданный макет текста в заданной точке

<comment>Param:</comment>
  <info>UI\Point</info>             <strong>$point</strong>   Точка для рисования
  <info>UI\Draw\Text\Layout</info>  <strong>$layout</strong>  Макет текста для рисования


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

<comment>Param:</comment>
  <info>int</info>    <strong>$cap</strong>         UI\Draw\Line\Cap::Flat, UI\Draw\Line\Cap::Round или UI\Draw\Line\Cap::Square
  <info>int</info>    <strong>$join</strong>        UI\Draw\Line\Join::Miter, UI\Draw\Line\Join::Round или
                      UI\Draw\Line\Join::Bevel
  <info>float</info>  <strong>$thickness</strong>   Толщина обводки
  <info>float</info>  <strong>$miterLimit</strong>  Предел среза (по умолчанию подходит для всех поддерживаемых платформ)


id: UI\Draw\Stroke::getCap
type: function
doc:
<comment>Description:</comment>
  Получить конец линии
  
  Получит настройку конца линии данной обводки

<comment>Return:</comment>
  <info>int</info>  UI\Draw\Line\Cap::Flat, UI\Draw\Line\Cap::Round или UI\Draw\Line\Cap::Square


id: UI\Draw\Stroke::getJoin
type: function
doc:
<comment>Description:</comment>
  Получить соединение линии
  
  Получит настройку соединения линии данной обводки

<comment>Return:</comment>
  <info>int</info>  UI\Draw\Line\Join::Miter, UI\Draw\Line\Join::Round или UI\Draw\Line\Join::Bevel


id: UI\Draw\Stroke::getMiterLimit
type: function
doc:
<comment>Description:</comment>
  Получить предел среза
  
  Получит предел среза данной обводки

<comment>Return:</comment>
  <info>float</info>  Текущий предел среза


id: UI\Draw\Stroke::getThickness
type: function
doc:
<comment>Description:</comment>
  Получить толщину
  
  Получит толщину данной обводки

<comment>Return:</comment>
  <info>float</info>  Текущая толщина


id: UI\Draw\Stroke::setCap
type: function
doc:
<comment>Description:</comment>
  Установить конец линии
  
  Установит настройку конца линии для данной обводки

<comment>Param:</comment>
  <info>int</info>  <strong>$cap</strong>  UI\Draw\Line\Cap::Flat, UI\Draw\Line\Cap::Round или UI\Draw\Line\Cap::Square


id: UI\Draw\Stroke::setJoin
type: function
doc:
<comment>Description:</comment>
  Получить соединение линии
  
  Установит настройку соединения линии для данной обводки

<comment>Param:</comment>
  <info>int</info>  <strong>$join</strong>  UI\Draw\Line\Join::Miter, UI\Draw\Line\Join::Round или UI\Draw\Line\Join::Bevel


id: UI\Draw\Stroke::setMiterLimit
type: function
doc:
<comment>Description:</comment>
  Установить предел среза
  
  Установить предел среза для данной обводки

<comment>Param:</comment>
  <info>float</info>  <strong>$limit</strong>  Новый предел


id: UI\Draw\Stroke::setThickness
type: function
doc:
<comment>Description:</comment>
  Установить толщину
  
  Установит толщину для данной обводки

<comment>Param:</comment>
  <info>float</info>  <strong>$thickness</strong>  Новая толщина


id: UI\Draw\Text\Font::__construct
type: function
doc:
<comment>Description:</comment>
  Создать новый объект Font
  
  Создаст новый объект Font, используя заданный дескриптор

<comment>Param:</comment>
  <info>UI\Draw\Text\Font\Descriptor</info>  <strong>$descriptor</strong>  Дескриптор шрифта


id: UI\Draw\Text\Font::getAscent
type: function
doc:
<comment>Description:</comment>
  Показатели шрифта

<comment>Return:</comment>
  <info>float</info>  


id: UI\Draw\Text\Font\Descriptor::__construct
type: function
doc:
<comment>Description:</comment>
  Конструктор класса Font Descriptor
  
  Создаёт новый Font Descriptor

<comment>Param:</comment>
  <info>string</info>  <strong>$family</strong>   Название допустимого семейства шрифтов.
  <info>float</info>   <strong>$size</strong>     Предпочтительный размер
  <info>int</info>     <strong>$weight</strong>   Константа UI\Draw\Text\Font\Weight
  <info>int</info>     <strong>$italic</strong>   Константа UI\Draw\Text\Font\Italic
  <info>int</info>     <strong>$stretch</strong>  Константа UI\Draw\Text\Font\Stretch


id: UI\Draw\Text\Font\Descriptor::getFamily
type: function
doc:
<comment>Description:</comment>
  Получает семейство шрифтов
  
  Возвращает семейство шрифтов

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


id: UI\Draw\Text\Font\Descriptor::getItalic
type: function
doc:
<comment>Description:</comment>
  Определение стиля
  
  Возвращает стиль

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


id: UI\Draw\Text\Font\Descriptor::getSize
type: function
doc:
<comment>Description:</comment>
  Определение размера
  
  Возвращает размер

<comment>Return:</comment>
  <info>float</info>  


id: UI\Draw\Text\Font\Descriptor::getStretch
type: function
doc:
<comment>Description:</comment>
  Определение стиля
  
  Возвращает начертание

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


id: UI\Draw\Text\Font\Descriptor::getWeight
type: function
doc:
<comment>Description:</comment>
  Определение насыщенности
  
  Возвращает насыщенность

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


id: UI\Draw\Text\Font\fontFamilies
type: function
doc:
<comment>Description:</comment>
  Извлечь семейство шрифтов
  
  Возвращает массив допустимых семейств шрифтов для текущей системы.

<comment>Return:</comment>
  <info>array</info>  Возвращает массив (<info>array</info>) допустимых семейств шрифтов для текущей системы.


id: UI\Draw\Text\Layout
type: class
doc:
<comment>Description:</comment>
  Текстовый макет представляет собой макет текста, который будет нарисован пером


id: UI\Draw\Text\Layout::__construct
type: function
doc:
<comment>Description:</comment>
  Создать новый объект макета текста
  
  Создаст новый объект макета текста

<comment>Param:</comment>
  <info>string</info>             <strong>$text</strong>   Текст для макета
  <info>UI\Draw\Text\Font</info>  <strong>$font</strong>   Шрифт для записи
  <info>float</info>              <strong>$width</strong>  Ширина для макета


id: UI\Draw\Text\Layout::setColor
type: function
doc:
<comment>Description:</comment>
  Установить цвет
  
  Установит цвет для всего текста или диапазона в макете

<comment>Param:</comment>
  <info>UI\Draw\Color</info>  <strong>$color</strong>  Используемый цвет
  <info>int</info>            <strong>$start</strong>  Начальный символ
  <info>int</info>            <strong>$end</strong>    Конечный символ, по умолчанию конец строки


id: UI\Draw\Text\Layout::setWidth
type: function
doc:
<comment>Description:</comment>
  Установить ширину
  
  Установит ширину для данного макета текста

<comment>Param:</comment>
  <info>float</info>  <strong>$width</strong>  Новая ширина


id: UI\Executor
type: class
doc:
<comment>Description:</comment>
  Эта возможность планирует повторное выполнение callback-функции, полезно для анимации и других
  подобных действий.


id: UI\Executor::__construct
type: function
doc:
<comment>Description:</comment>
  Создать новый объект Executor
  
  Создаёт исполнитель с заданным интервалом, не будет запускаться до тех пор, пока не будет введён
  основной цикл

<comment>Param:</comment>
  <info>int</info>  <strong>$seconds</strong>       Секунды между выполнениями
  <info>int</info>  <strong>$microseconds</strong>  Микросекунды между выполнениями


id: UI\Executor::kill
type: function
doc:
<comment>Description:</comment>
  Остановить исполнитель
  
  Остановит исполнитель, он не будет перезапущен

<comment>Return:</comment>
  <info>void</info>  


id: UI\Executor::onExecute
type: function
doc:
<comment>Description:</comment>
  Callback-функция выполнения
  
  Поставит в очередь для выполнения в основном потоке

<comment>Return:</comment>
  <info>void</info>  


id: UI\Executor::setInterval
type: function
doc:
<comment>Description:</comment>
  Управление интервалом
  
  Установит новый интервал. Интервал 0 приостанавливает выполнение исполнителем до тех пор, пока не
  будет установлен новый интервал

<comment>Param:</comment>
  <info>int</info>  <strong>$seconds</strong>       
  <info>int</info>  <strong>$microseconds</strong>  

<comment>Return:</comment>
  <info>bool</info>  Индикатор успешности выполнения


id: UI\Menu
type: class
doc:
<comment>Description:</comment>
  Меню должно быть создано до первого окна и может отображаться в любом окне


id: UI\Menu::__construct
type: function
doc:
<comment>Description:</comment>
  Создать новый объект Menu
  
  Создаст новый объект Menu

<comment>Param:</comment>
  <info>string</info>  <strong>$name</strong>  Имя (текст) нового меню


id: UI\Menu::append
type: function
doc:
<comment>Description:</comment>
  Добавить пункт меню
  
  Добавит пункт меню

<comment>Param:</comment>
  <info>string</info>  <strong>$name</strong>  Имя (текст) нового пункта
  <info>string</info>  <strong>$type</strong>  Тип нового пункта

<comment>Return:</comment>
  <info>UI\MenuItem</info>  Созданный объект данного типа


id: UI\Menu::appendAbout
type: function
doc:
<comment>Description:</comment>
  Добавить пункт меню About
  
  Добавит пункт меню About

<comment>Param:</comment>
  <info>string</info>  <strong>$type</strong>  Тип нового пункта меню

<comment>Return:</comment>
  <info>UI\MenuItem</info>  Созданный пункт меню с заданным типом


id: UI\Menu::appendCheck
type: function
doc:
<comment>Description:</comment>
  Добавить пункт меню с чекбоксом
  
  Добавит пункт меню с чекбоксом

<comment>Param:</comment>
  <info>string</info>  <strong>$name</strong>  Имя (текст) нового пункта
  <info>string</info>  <strong>$type</strong>  Тип нового пункта

<comment>Return:</comment>
  <info>UI\MenuItem</info>  Созданный пункт меню с чекбоксом заданного типа


id: UI\Menu::appendPreferences
type: function
doc:
<comment>Description:</comment>
  Добавить пункт меню "Настройки" (Preferences)
  
  Добавит пункт меню "Настройки"

<comment>Param:</comment>
  <info>string</info>  <strong>$type</strong>  Тип нового пункта

<comment>Return:</comment>
  <info>UI\MenuItem</info>  Созданный пункт меню "Настройки" заданного типа


id: UI\Menu::appendQuit
type: function
doc:
<comment>Description:</comment>
  Добавить пункт меню "Выход" (Quit)
  
  Добавит пункт меню "Выход"

<comment>Param:</comment>
  <info>string</info>  <strong>$type</strong>  Тип нового пункта

<comment>Return:</comment>
  <info>UI\MenuItem</info>  Созданный пункт меню "Выход" заданного типа


id: UI\Menu::appendSeparator
type: function
doc:
<comment>Description:</comment>
  Добавить пункт меню "Разделитель" (Separator)
  
  Добавит разделитель


id: UI\MenuItem::isChecked
type: function
doc:
<comment>Description:</comment>
  Определение выбранности пункта
  
  Определить, выбран ли данный пункт меню

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


id: UI\MenuItem::onClick
type: function
doc:
<comment>Description:</comment>
  Обработчик нажатия
  
  Выполняется при нажатии данного пункта меню


id: UI\MenuItem::setChecked
type: function
doc:
<comment>Description:</comment>
  Выбрать пункт меню
  
  Установить статус выбранности данного пункта меню

<comment>Param:</comment>
  <info>bool</info>  <strong>$checked</strong>  Новый статус


id: UI\Point
type: class
doc:
<comment>Description:</comment>
  Точки используются во всем пользовательском интерфейсе для представления координат на экране,
  управляющем элементе или области.


id: UI\Point::__construct
type: function
doc:
<comment>Description:</comment>
  Создать новый объект Point
  
  Создать новый объект Point, используя новые координаты

<comment>Param:</comment>
  <info>float</info>  <strong>$x</strong>  Новая X-координата
  <info>float</info>  <strong>$y</strong>  Новая Y-координата


id: UI\Point::at
type: function
doc:
<comment>Description:</comment>
  Приведение Size
  
  Должен вернуть объект UI\Point с координатами x и y, заданными в виде числа с плавающей точкой
  либо в виде объекта UI\Size.

<comment>Param:</comment>
  <info>float</info>    <strong>$point</strong>  Значение для x и y
  <info>UI\Size</info>  <strong>$size</strong>   Объект класса Size для конвертации

<comment>Return:</comment>
  <info>UI\Point</info>  Объект класса Point


id: UI\Point::getX
type: function
doc:
<comment>Description:</comment>
  Получает X
  
  Получает X-координату

<comment>Return:</comment>
  <info>float</info>  Текущая X-координата


id: UI\Point::getY
type: function
doc:
<comment>Description:</comment>
  Получить Y
  
  Получает Y-координату

<comment>Return:</comment>
  <info>float</info>  Текущая Y-координата


id: UI\Point::setX
type: function
doc:
<comment>Description:</comment>
  Установить X
  
  Установить X-координата

<comment>Param:</comment>
  <info>float</info>  <strong>$point</strong>  Новая X-координата


id: UI\Point::setY
type: function
doc:
<comment>Description:</comment>
  Установить Y
  
  Установить Y-координату

<comment>Param:</comment>
  <info>float</info>  <strong>$point</strong>  Новая Y-координата


id: UI\Size
type: class
doc:
<comment>Description:</comment>
  Размеры используются в пользовательском интерфейсе для представления размера экрана, управляющего
  элемента или области.


id: UI\Size::__construct
type: function
doc:
<comment>Description:</comment>
  Создать новый объект Size
  
  Создать новый объект Size, используя новые ширину и высоту

<comment>Param:</comment>
  <info>float</info>  <strong>$width</strong>   Новая ширина
  <info>float</info>  <strong>$height</strong>  Новая высота


id: UI\Size::getHeight
type: function
doc:
<comment>Description:</comment>
  Получает высоту
  
  Получает высоту

<comment>Return:</comment>
  <info>float</info>  Текущая высота


id: UI\Size::getWidth
type: function
doc:
<comment>Description:</comment>
  Получает ширину
  
  Получает ширину

<comment>Return:</comment>
  <info>float</info>  Текущая ширина


id: UI\Size::of
type: function
doc:
<comment>Description:</comment>
  Приведение Point
  
  Должен вернуть объект UI\Size с заданными в виде числа с плавающей запятой или в виде объекта
  UI\Point шириной и высотой

<comment>Param:</comment>
  <info>float</info>     <strong>$size</strong>   Значение для ширины и высоты
  <info>UI\Point</info>  <strong>$point</strong>  Объект Point для конвертации

<comment>Return:</comment>
  <info>UI\Size</info>  Объект класса Size


id: UI\Size::setHeight
type: function
doc:
<comment>Description:</comment>
  Установить высоту
  
  Установить новую высоту

<comment>Param:</comment>
  <info>float</info>  <strong>$size</strong>  Новая высота


id: UI\Size::setWidth
type: function
doc:
<comment>Description:</comment>
  Установить ширину
  
  Установить новую ширину

<comment>Param:</comment>
  <info>float</info>  <strong>$size</strong>  Новая ширина


id: UI\Window::__construct
type: function
doc:
<comment>Description:</comment>
  Создать новый объект Window
  
  Создаст новый объект Window

<comment>Param:</comment>
  <info>string</info>  <strong>$title</strong>  Заголовок окна
  <info>Size</info>    <strong>$size</strong>   Размер окна
  <info>bool</info>    <strong>$menu</strong>   Переключатель меню


id: UI\Window::add
type: function
doc:
<comment>Description:</comment>
  Добавить элемент управления
  
  Добавит элемент управления к окну

<comment>Param:</comment>
  <info>UI\Control</info>  <strong>$control</strong>  Элемент управления для добавления


id: UI\Window::error
type: function
doc:
<comment>Description:</comment>
  Показать блок ошибки
  
  Покажет блок ошибки

<comment>Param:</comment>
  <info>string</info>  <strong>$title</strong>  Заголовок блока ошибки
  <info>string</info>  <strong>$msg</strong>    Сообщение блока ошибки


id: UI\Window::getSize
type: function
doc:
<comment>Description:</comment>
  Получить размер окна
  
  Возвратит размер данного окна

<comment>Return:</comment>
  <info>UI\Size</info>  


id: UI\Window::getTitle
type: function
doc:
<comment>Description:</comment>
  Получить заголовок
  
  Получит заголовок данного окна

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


id: UI\Window::hasBorders
type: function
doc:
<comment>Description:</comment>
  Определение рамки
  
  Определить, используются ли рамки в данном окне

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


id: UI\Window::hasMargin
type: function
doc:
<comment>Description:</comment>
  Определение полей
  
  Определить, используются ли поля в данном окне

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


id: UI\Window::isFullScreen
type: function
doc:
<comment>Description:</comment>
  Определение полного экрана
  
  Определить, используется ли это окно на весь экран

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


id: UI\Window::msg
type: function
doc:
<comment>Description:</comment>
  Показать блок сообщения
  
  Покажет блок сообщения

<comment>Param:</comment>
  <info>string</info>  <strong>$title</strong>  Заголовок блока сообщения
  <info>string</info>  <strong>$msg</strong>    Сообщение


id: UI\Window::onClosing
type: function
doc:
<comment>Description:</comment>
  Callback-функция закрытия
  
  Должен изящно уничтожить данное окно

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


id: UI\Window::open
type: function
doc:
<comment>Description:</comment>
  Открыть диалоговое окно
  
  Откроет диалоговое окно файла

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


id: UI\Window::save
type: function
doc:
<comment>Description:</comment>
  Сохранить диалоговое окно
  
  Откроет диалоговое окно сохранения

<comment>Return:</comment>
  <info>string</info>  Возвращает имя файла для сохранения


id: UI\Window::setBorders
type: function
doc:
<comment>Description:</comment>
  Использование рамок
  
  Включить или отключить использование рамок в данном окне

<comment>Param:</comment>
  <info>bool</info>  <strong>$borders</strong>  


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

<comment>Param:</comment>
  <info>bool</info>  <strong>$full</strong>  


id: UI\Window::setMargin
type: function
doc:
<comment>Description:</comment>
  Использование поля
  
  Включить или отключить использование полей для данного окна.

<comment>Param:</comment>
  <info>bool</info>  <strong>$margin</strong>  


id: UI\Window::setSize
type: function
doc:
<comment>Description:</comment>
  Установить размер
  
  Установит размер данного окна

<comment>Param:</comment>
  <info>UI\Size</info>  <strong>$size</strong>  


id: UI\Window::setTitle
type: function
doc:
<comment>Description:</comment>
  Заголовок окна
  
  Установит заголовок для данного окна

<comment>Param:</comment>
  <info>string</info>  <strong>$title</strong>  Новый заголовок


id: UI\quit
type: function
doc:
<comment>Description:</comment>
  Выйти из цикла UI
  
  Вынуждает главный цикл завершить работу

<comment>Return:</comment>
  <info>void</info>  


id: UI\run
type: function
doc:
<comment>Description:</comment>
  Войти в цикл UI
  
  Приказывает PHP войти в главный цикл, по умолчанию контроль не возвращается к инициатору

<comment>Param:</comment>
  <info>int</info>  <strong>$flags</strong>  Вынуждает UI\Loop вернуть управление, а UI\Wait вернуть управление после ожидания

<comment>Return:</comment>
  <info>void</info>  


id: UnitEnum
type: class
doc:
<comment>Description:</comment>
  Интерфейс <class>UnitEnum</class> автоматически применяется движком ко всем перечислениям. Он не может быть
  реализован пользовательскими классами. Перечисления не могут переопределять его методы, поскольку
  реализации по умолчанию предоставляются движком. Доступен только для проверки типа.


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

<comment>Return:</comment>
  <info>array</info>  Массив всех определённых вариантов перечисления в порядке объявления.


id: V8Js
type: class
doc:
<comment>Description:</comment>
  Это основной класс модуля V8Js. Каждый экземпляр этого класса имеет собственный контекст в котором
  будет скомпилирован и запущен JavaScript.
  
  Также смотрите <strong>V8Js::__construct()</strong>.


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

<comment>Param:</comment>
  <info>string</info>  <strong>$object_name</strong>                 Имя объекта, передаваемого в Javascript.
  <info>array</info>   <strong>$variables</strong>                   Список переменных PHP, которые должны быть доступны в
                                       Javascript. Ассоциативный массив формата <return>array("name-for-js"
                                       =&gt; "name-of-php-variable")</return>. По умолчанию пустой массив.
  <info>array</info>   <strong>$extensions</strong>                  Список зарегистрированных через <strong>V8Js::registerExtension()</strong>
                                       модулей, которые должны быть доступны в контексте созданного
                                       объекта <class>V8Js</class>.  Модули, зарегистрированные как доступные
                                       автоматически, не нужно перечислять в этом массиве. Также,
                                       если модуль имеет какие-либо зависимости, то их тоже не нужно
                                       перечислять. По умолчанию пустой массив.
                                       
                                       Модули, зарегистрированные как доступные автоматически, не
                                       нужно перечислять в этом массиве. Также, если модуль имеет
                                       какие-либо зависимости, то их тоже не нужно перечислять. По
                                       умолчанию пустой массив.
  <info>bool</info>    <strong>$report_uncaught_exceptions</strong>  Определяет, будут ли сообщаться о непойманных исключениях
                                       JavaScript сразу или нет. По умолчанию <info>true</info>. Если установить
                                       в <info>false</info>, то эти исключения будут доступны с помощью
                                       <strong>V8Js::getPendingException()</strong>.


id: V8Js::executeString
type: function
doc:
<comment>Description:</comment>
  Выполнить строку как код Javascript
  
  Компилирует и выполняет строку, переданную в параметр <strong>$script</strong>, как код Javascript.

<comment>Param:</comment>
  <info>string</info>  <strong>$script</strong>      Строка, содержащая код для выполнения.
  <info>string</info>  <strong>$identifier</strong>  Строка идентификатор для запущенного кода. Используется для отладки.
  <info>int</info>     <strong>$flags</strong>       Флаги запуска. Значение должно быть одной из констант <return>V8Js::FLAG_*</return>, по
                       умолчанию <info>V8Js::FLAG_NONE</info>. <info>V8Js::FLAG_NONE</info>: без флагов
                       <info>V8Js::FLAG_FORCE_ARRAY</info>: принуждает объекты JS быть ассоциативными массивами
                       PHP
                       
                       <info>V8Js::FLAG_NONE</info>: без флагов
                       
                       <info>V8Js::FLAG_FORCE_ARRAY</info>: принуждает объекты JS быть ассоциативными массивами
                       PHP

<comment>Return:</comment>
  <info>mixed</info>  Возвращает последнюю переменную, созданную в коде Javascript, предварительно сконвертировав
         её в подходящий тип PHP.


id: V8Js::getExtensions
type: function
doc:
<comment>Description:</comment>
  Возвращает массив зарегистрированных модулей
  
  Возвращает массив зарегистрированных с помощью <strong>V8Js::registerExtension()</strong> модулей Javascript.

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


id: V8Js::getPendingException
type: function
doc:
<comment>Description:</comment>
  Возвращает ожидающее непойманное исключение Javascript
  
  Возвращает ожидающее непойманное исключение Javascript в виде <class>V8JsException</class>, оставшееся от
  предыдущих запусков <strong>V8Js::executeString()</strong>.

<comment>Return:</comment>
  <info>V8JsException</info>  <class>V8JsException</class> или <info>null</info>.


id: V8Js::registerExtension
type: function
doc:
<comment>Description:</comment>
  Регистрация модуля Javascript для V8Js
  
  Регистрация переданного в <strong>$script</strong> Javascript как модуля для использования <class>V8Js</class>.

<comment>Param:</comment>
  <info>string</info>  <strong>$extension_name</strong>  Имя регистрируемого модуля.
  <info>string</info>  <strong>$script</strong>          Код Javascript для регистрации.
  <info>array</info>   <strong>$dependencies</strong>    Массив имён модулей, от которых зависит регистрируемый модуль. Каждый из
                           этих модулей будет включён автоматически при загрузке этого модуля.  Все
                           модули, включая зависимости, должны быть зарегистрированы до создания
                           любых <class>V8Js</class>, которые их используют.
                           
                           Все модули, включая зависимости, должны быть зарегистрированы до создания
                           любых <class>V8Js</class>, которые их используют.
  <info>bool</info>    <strong>$auto_enable</strong>     Если установлено в <info>true</info>, модуль будет включён автоматически для любого
                           контекста <class>V8Js</class>.

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


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

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


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

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


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

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


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

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


id: VARCMP_GT
type: constant
doc:
<comment>Description:</comment>
  Левый <return>bstr</return> больше правого <return>bstr</return>.


id: VARCMP_LT
type: constant
doc:
<comment>Description:</comment>
  Левый <return>bstr</return> меньше правого <return>bstr</return>.


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


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


id: VT_ARRAY
type: constant
doc:
<comment>Description:</comment>
  Если индикатор типа комбинирован с <info>VT_ARRAY</info> с помощью побитового ИЛИ, то значение является
  указателем на <return>SAFEARRAY</return>. <info>VT_ARRAY</info> можно комбинировать побитовым ИЛИ со следующими типами: <info>VT_I1</info>,
  <info>VT_UI1</info>, <info>VT_I2</info>, <info>VT_UI2</info>, <info>VT_I4</info>, <info>VT_UI4</info>, <info>VT_INT</info>, <info>VT_UINT</info>, <info>VT_R4</info>, <info>VT_R8</info>, <info>VT_BOOL</info>, <info>VT_DECIMAL</info>,
  <info>VT_ERROR</info>, <info>VT_CY</info>, <info>VT_DATE</info>, <info>VT_BSTR</info>, <info>VT_DISPATCH</info>, <info>VT_UNKNOWN</info> и <info>VT_VARIANT</info>.


id: VT_BYREF
type: constant
doc:
<comment>Description:</comment>
  Если индикатор типа комбинирован с <info>VT_BYREF</info> с помощью побитового ИЛИ, значит значение является
  ссылкой. Тип "ссылка" интерпретируется как ссылка на данные, аналогично ссылкам C++.


id: VT_DATE
type: constant
doc:
<comment>Description:</comment>
  Значение с плавающей точкой размером 64 бита представляющее количество дней (не секунд) с 31
  Декабря 1899 года. К примеру, <return>1 Января 1900</return> равно 2.0, <return>2 Января 1900</return> равно 3.0, и т.д. Хранится
  таким же образом, что и <info>VT_R8</info>.


id: VT_EMPTY
type: constant
doc:
<comment>Description:</comment>
  Свойство с индикатором типа из <info>VT_EMPTY</info> не имеющий данных ассоциированных с ним. Размер этого
  значения равен нулю.


id: VT_I8
type: constant
doc:
<comment>Description:</comment>
  8-байтовое целочисленное значение со знаком.
  
  Доступно с PHP 7.0.0 (только для x64).


id: VT_INT
type: constant
doc:
<comment>Description:</comment>
  Знаковое целое размером в 4 байт. (аналогично <info>VT_I4</info>).


id: VT_VARIANT
type: constant
doc:
<comment>Description:</comment>
  Индикатор типа с последующим, соответствующим, значением. <info>VT_VARIANT</info> можно использовать только с
  <info>VT_BYREF</info>.


id: VarnishAdmin::__construct
type: function
doc:
<comment>Description:</comment>
  VarnishAdmin constructor

<comment>Param:</comment>
  <info>array</info>  <strong>$args</strong>  Аргументы конфигурации. Возможные ключи:
                


id: VarnishAdmin::auth
type: function
doc:
<comment>Description:</comment>
  Аутентификация на экземпляре varnish

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


id: VarnishAdmin::ban
type: function
doc:
<comment>Description:</comment>
  Запретить URL-адреса, используя выражение VCL

<comment>Param:</comment>
  <info>string</info>  <strong>$vcl_regex</strong>  Выражение Varnish VCL. Оно основывается на команде varnish ban.

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


id: VarnishAdmin::banUrl
type: function
doc:
<comment>Description:</comment>
  Запретить URL, используя выражение VCL

<comment>Param:</comment>
  <info>string</info>  <strong>$vcl_regex</strong>  Регулярное выражение URL в синтаксисе, совместимом с PCRE. Оно основывается на
                      команде varnish ban.

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


id: VarnishAdmin::clearPanic
type: function
doc:
<comment>Description:</comment>
  Очистить критические сообщения экземпляра varnish

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


id: VarnishAdmin::connect
type: function
doc:
<comment>Description:</comment>
  Подключение к интерфейсу администрирования экземпляра varnish

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


id: VarnishAdmin::disconnect
type: function
doc:
<comment>Description:</comment>
  Отключение от интерфейса администрирования экземпляра varnish

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


id: VarnishAdmin::getPanic
type: function
doc:
<comment>Description:</comment>
  Получить последнее критическое сообщение на экземпляре varnish

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


id: VarnishAdmin::getParams
type: function
doc:
<comment>Description:</comment>
  Получить параметры конфигурации текущего экземпляра varnish

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


id: VarnishAdmin::isRunning
type: function
doc:
<comment>Description:</comment>
  Проверить, выполняется в настоящий момент подчинённый процесс varnish

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


id: VarnishAdmin::setCompat
type: function
doc:
<comment>Description:</comment>
  Установить параметр конфигурации compat класса

<comment>Param:</comment>
  <info>int</info>  <strong>$compat</strong>  Опция совместимости Varnish.

<comment>Return:</comment>
  <info>void</info>  


id: VarnishAdmin::setHost
type: function
doc:
<comment>Description:</comment>
  Установить параметр конфигурации host класса

<comment>Param:</comment>
  <info>string</info>  <strong>$host</strong>  Параметр конфигурации хоста подключения.

<comment>Return:</comment>
  <info>void</info>  


id: VarnishAdmin::setIdent
type: function
doc:
<comment>Description:</comment>
  Установить параметр конфигурации ident класса

<comment>Param:</comment>
  <info>string</info>  <strong>$ident</strong>  Параметр конфигурации ident подключения.

<comment>Return:</comment>
  <info>void</info>  


id: VarnishAdmin::setParam
type: function
doc:
<comment>Description:</comment>
  Установить параметр конфигурации на текущем экземпляре varnish

<comment>Param:</comment>
  <info>string</info>      <strong>$name</strong>   Название параметра конфигурации Varnish.
  <info>string|int</info>  <strong>$value</strong>  Значение параметра конфигурации Varnish.

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


id: VarnishAdmin::setPort
type: function
doc:
<comment>Description:</comment>
  Установить параметр конфигурации port класса

<comment>Param:</comment>
  <info>int</info>  <strong>$port</strong>  Параметр конфигурации подключения port.

<comment>Return:</comment>
  <info>void</info>  


id: VarnishAdmin::setSecret
type: function
doc:
<comment>Description:</comment>
  Установить параметр конфигурации secret класса

<comment>Param:</comment>
  <info>string</info>  <strong>$secret</strong>  Параметр конфигурации secret класса.

<comment>Return:</comment>
  <info>void</info>  


id: VarnishAdmin::setTimeout
type: function
doc:
<comment>Description:</comment>
  Установить параметр конфигурации timeout класса

<comment>Param:</comment>
  <info>int</info>  <strong>$timeout</strong>  Параметр конфигурации timeout класса.

<comment>Return:</comment>
  <info>void</info>  


id: VarnishAdmin::start
type: function
doc:
<comment>Description:</comment>
  Запустить рабочий процесс varnish

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


id: VarnishAdmin::stop
type: function
doc:
<comment>Description:</comment>
  Остановить рабочий процесс varnish

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


id: VarnishLog::__construct
type: function
doc:
<comment>Description:</comment>
  Конструктор Varnishlog

<comment>Param:</comment>
  <info>array</info>  <strong>$args</strong>  Аргументы конфигурации. Возможные ключи:
                


id: VarnishLog::getLine
type: function
doc:
<comment>Description:</comment>
  Получить следующую строку журнала

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


id: VarnishLog::getTagName
type: function
doc:
<comment>Description:</comment>
  Получить строковое представление тега журнала по его индексу

<comment>Param:</comment>
  <info>int</info>  <strong>$index</strong>  Индекс тега журнала.

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


id: VarnishStat::__construct
type: function
doc:
<comment>Description:</comment>
  Конструктор VarnishStat

<comment>Param:</comment>
  <info>array</info>  <strong>$args</strong>  Аргументы конфигурации. Возможные ключи:
                


id: VarnishStat::getSnapshot
type: function
doc:
<comment>Description:</comment>
  Получить снимок статистики текущего экземпляра varnish

<comment>Return:</comment>
  <info>array</info>  Массив со снимком статистики varnish. Ключи массива идентичны ключам в команде varnishstat.


id: Volatile
type: class
doc:
<comment>Description:</comment>
  Класс <class>Volatile</class> появился в pthreads v3. Его введение является следствием новой семантики
  неизменности <class>Threaded</class>-свойств классов <class>Threaded</class>. Класс <class>Volatile</class> включает иммутабельность их
  <class>Threaded</class>-свойств и, также, используется для хранения массивов PHP в контексте <class>Threaded</class>.


id: Vtiful\Kernel\Excel::__construct
type: function
doc:
<comment>Description:</comment>
  Конструктор
  
  Конструктор <class>Vtiful\Kernel\Excel</class>, создать экземпляр.

<comment>Param:</comment>
  <info>array</info>  <strong>$config</strong>  Конфигурация экспорта файла XLSX


id: Vtiful\Kernel\Excel::addSheet
type: function
doc:
<comment>Description:</comment>
  Добавить лист
  
  Создайте новый лист в файле xlsx.

<comment>Param:</comment>
  <info>string</info>  <strong>$sheetName</strong>  Имя листа

<comment>Return:</comment>
  <info>unknown</info>  Экземпляр <class>Vtiful\Kernel\Excel</class>


id: Vtiful\Kernel\Excel::autoFilter
type: function
doc:
<comment>Description:</comment>
  Добавить автофильтр
  
  Добавление автофильтра к листу.

<comment>Param:</comment>
  <info>string</info>  <strong>$scope</strong>  Начальная и конечная строка координат ячейки.

<comment>Return:</comment>
  <info>unknown</info>  Экземпляр <class>Vtiful\Kernel\Excel</class>


id: Vtiful\Kernel\Excel::constMemory
type: function
doc:
<comment>Description:</comment>
  Количество памяти
  
  Запись большого файла с постоянным использованием памяти.

<comment>Param:</comment>
  <info>string</info>  <strong>$fileName</strong>   Имя файла XLSX
  <info>string</info>  <strong>$sheetName</strong>  Название листа

<comment>Return:</comment>
  <info>unknown</info>  Экземпляр <class>Vtiful\Kernel\Excel</class>


id: Vtiful\Kernel\Excel::data
type: function
doc:
<comment>Description:</comment>
  Записать данные
  
  Записать данные в таблицу.

<comment>Param:</comment>
  <info>array</info>  <strong>$data</strong>  Данные листа

<comment>Return:</comment>
  <info>unknown</info>  Экземпляр <class>Vtiful\Kernel\Excel</class>


id: Vtiful\Kernel\Excel::fileName
type: function
doc:
<comment>Description:</comment>
  Создать название файла
  
  Создать новый файл XLSX и лист в нем.

<comment>Param:</comment>
  <info>string</info>  <strong>$fileName</strong>   Имя файла XLSX
  <info>string</info>  <strong>$sheetName</strong>  Название листа

<comment>Return:</comment>
  <info>unknown</info>  Экземпляр <class>Vtiful\Kernel\Excel</class>


id: Vtiful\Kernel\Excel::getHandle
type: function
doc:
<comment>Description:</comment>
  Получить дескриптор
  
  Получить дескриптор текстового ресурса xlsx.

<comment>Return:</comment>
  <info>unknown</info>  Ресурс


id: Vtiful\Kernel\Excel::header
type: function
doc:
<comment>Description:</comment>
  Записать заголовок
  
  Написать заголовок на листе.

<comment>Param:</comment>
  <info>array</info>  <strong>$headerData</strong>  Данные заголовка листа

<comment>Return:</comment>
  <info>unknown</info>  Экземпляр <class>Vtiful\Kernel\Excel</class>


id: Vtiful\Kernel\Excel::insertFormula
type: function
doc:
<comment>Description:</comment>
  Вставить формулу расчёта
  
  Вставить формулу расчёта.

<comment>Param:</comment>
  <info>int</info>     <strong>$row</strong>      строка ячейки
  <info>int</info>     <strong>$column</strong>   столбец ячейки
  <info>string</info>  <strong>$formula</strong>  строка формулы

<comment>Return:</comment>
  <info>unknown</info>  Экземпляр <class>Vtiful\Kernel\Excel</class>


id: Vtiful\Kernel\Excel::insertImage
type: function
doc:
<comment>Description:</comment>
  Вставить изображение
  
  Вставьте локальное изображение в ячейку.

<comment>Param:</comment>
  <info>int</info>     <strong>$row</strong>             строка ячейки
  <info>int</info>     <strong>$column</strong>          столбец ячейки
  <info>string</info>  <strong>$localImagePath</strong>  путь к локальному изображению

<comment>Return:</comment>
  <info>unknown</info>  Экземпляр <class>Vtiful\Kernel\Excel</class>


id: Vtiful\Kernel\Excel::insertText
type: function
doc:
<comment>Description:</comment>
  Вставить текст
  
  Вставить текст в ячейку.

<comment>Param:</comment>
  <info>int</info>               <strong>$row</strong>     строка ячейки
  <info>int</info>               <strong>$column</strong>  столбец ячейки
  <info>int|float|string</info>  <strong>$data</strong>    данные для записи
  <info>string</info>            <strong>$format</strong>  формат строки

<comment>Return:</comment>
  <info>unknown</info>  Экземпляр <class>Vtiful\Kernel\Excel</class>


id: Vtiful\Kernel\Excel::mergeCells
type: function
doc:
<comment>Description:</comment>
  Объединить ячейки
  
  Объединить ячейки.

<comment>Param:</comment>
  <info>string</info>  <strong>$scope</strong>  начальные и конечные строки координат ячейки
  <info>string</info>  <strong>$data</strong>   данные строки

<comment>Return:</comment>
  <info>unknown</info>  Экземпляр <class>Vtiful\Kernel\Excel</class>


id: Vtiful\Kernel\Excel::output
type: function
doc:
<comment>Description:</comment>
  Вывод
  
  Вывод xlsx-файла на диск.

<comment>Return:</comment>
  <info>unknown</info>  Путь к файлу XLSX;


id: Vtiful\Kernel\Excel::setColumn
type: function
doc:
<comment>Description:</comment>
  Установить столбец
  
  Установить формат столбца.

<comment>Param:</comment>
  <info>string</info>    <strong>$range</strong>   начальные и конечные строки координат ячейки
  <info>float</info>     <strong>$width</strong>   ширина столбца
  <info>resource</info>  <strong>$format</strong>  ресурс формата ячейки

<comment>Return:</comment>
  <info>unknown</info>  Экземпляр <class>Vtiful\Kernel\Excel</class>


id: Vtiful\Kernel\Excel::setRow
type: function
doc:
<comment>Description:</comment>
  Установить строку
  
  Установить формат строки.

<comment>Param:</comment>
  <info>string</info>    <strong>$range</strong>   начальные и конечные строки координат ячейки
  <info>float</info>     <strong>$height</strong>  высота строки
  <info>resource</info>  <strong>$format</strong>  ресурс формата ячейки

<comment>Return:</comment>
  <info>unknown</info>  Экземпляр <class>Vtiful\Kernel\Excel</class>


id: Vtiful\Kernel\Format::align
type: function
doc:
<comment>Description:</comment>
  Выравнивание
  
  Установить выравнивание ячейки

<comment>Param:</comment>
  <info>resource</info>  <strong>$handle</strong>  Дескриптор файла xlsx
  <info>int</info>       <strong>$style</strong>   Константа <class>Vtiful\Kernel\Format</class>

<comment>Return:</comment>
  <info>unknown</info>  Ресурс


id: Vtiful\Kernel\Format::bold
type: function
doc:
<comment>Description:</comment>
  Полужирный
  
  Полужирный формат <class>Vtiful\Kernel\Format</class>

<comment>Param:</comment>
  <info>resource</info>  <strong>$handle</strong>  Дескриптор файла xlsx

<comment>Return:</comment>
  <info>unknown</info>  Ресурс


id: Vtiful\Kernel\Format::italic
type: function
doc:
<comment>Description:</comment>
  Курсив
  
  Формат курсива <class>Vtiful\Kernel\Format</class>

<comment>Param:</comment>
  <info>resource</info>  <strong>$handle</strong>  Дескриптор файла xlsx

<comment>Return:</comment>
  <info>unknown</info>  Ресурс


id: Vtiful\Kernel\Format::underline
type: function
doc:
<comment>Description:</comment>
  Подчёркнутый
  
  Подчёркнутый формат <class>Vtiful\Kernel\Format</class>

<comment>Param:</comment>
  <info>resource</info>  <strong>$handle</strong>  Дескриптор файла xlsx
  <info>int</info>       <strong>$style</strong>   Константа <class>Vtiful\Kernel\Format</class>

<comment>Return:</comment>
  <info>unknown</info>  Ресурс


id: WIN32_ABOVE_NORMAL_PRIORITY_CLASS
type: constant
doc:
<comment>Description:</comment>
  Процесс имеет приоритет выше WIN32_NORMAL_PRIORITY_CLASS, но ниже WIN32_HIGH_PRIORITY_CLASS.


id: WIN32_BELOW_NORMAL_PRIORITY_CLASS
type: constant
doc:
<comment>Description:</comment>
  Процесс имеет приоритет выше WIN32_IDLE_PRIORITY_CLASS, но ниже WIN32_NORMAL_PRIORITY_CLASS.


id: WIN32_ERROR_DEPENDENT_SERVICES_RUNNING
type: constant
doc:
<comment>Description:</comment>
  0x0000041B
  
  Службу нельзя остановить, поскольку от неё зависит другая запущенная служба.


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


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


id: WIN32_ERROR_INSUFFICIENT_BUFFER
type: constant
doc:
<comment>Description:</comment>
  0x0000007A
  
  Буфер слишком мал для структуры состояния службы. В структуру не будет ничего записано.


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


id: WIN32_ERROR_INVALID_LEVEL
type: constant
doc:
<comment>Description:</comment>
  0x0000007C
  
  Параметр InfoLevel содержит неподдерживаемое значение.


id: WIN32_ERROR_INVALID_SERVICE_ACCOUNT
type: constant
doc:
<comment>Description:</comment>
  Имя аккаунта пользователя, указанное в <strong>$user</strong> отсутствует. Смотрите <strong>win32_create_service()</strong>.


id: WIN32_ERROR_INVALID_SERVICE_CONTROL
type: constant
doc:
<comment>Description:</comment>
  0x0000041C
  
  Запрошенный контрольный код является недействительным, или неприемлемым для службы.


id: WIN32_ERROR_SERVICE_CANNOT_ACCEPT_CTRL
type: constant
doc:
<comment>Description:</comment>
  Запрошенный управляющий код не может быть послан службе, поскольку её статус
  <info>WIN32_SERVICE_STOPPED</info>, <info>WIN32_SERVICE_START_PENDING</info>, или <info>WIN32_SERVICE_STOP_PENDING</info>.


id: WIN32_ERROR_SERVICE_DEPENDENCY_DELETED
type: constant
doc:
<comment>Description:</comment>
  Служба зависит от службы которой нет, либо которая отмечена для удаления.


id: WIN32_ERROR_SERVICE_DEPENDENCY_FAIL
type: constant
doc:
<comment>Description:</comment>
  0x0000042C
  
  Служба зависит от другой службы, которая не может запуститься.


id: WIN32_ERROR_SERVICE_LOGON_FAILED
type: constant
doc:
<comment>Description:</comment>
  0x0000042D
  
  Служба не может запустится из-за проблем авторизации. Такая ошибка случается, если служба
  настроена на запуск под учётной записью, у которой нет прав запускаться как службе (Log on as a
  service).


id: WIN32_ERROR_SERVICE_REQUEST_TIMEOUT
type: constant
doc:
<comment>Description:</comment>
  0x0000041D
  
  Процесс службы стартован, но он не вызывал StartServiceCtrlDispatcher, либо поток, вызывавший
  StartServiceCtrlDispatcher заблокирован функцией управляющей обработкой.


id: WIN32_ERROR_SHUTDOWN_IN_PROGRESS
type: constant
doc:
<comment>Description:</comment>
  0x0000045B
  
  Система останавливается; эта функция не может быть вызвана.


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


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


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


id: WIN32_SERVICE_ACCEPT_HARDWAREPROFILECHANGE
type: constant
doc:
<comment>Description:</comment>
  Сервис уведомлен о том, что аппаратная конфигурация компьютера изменена. Это разрешает системе
  послать службе уведомление <info>WIN32_SERVICE_CONTROL_HARDWAREPROFILECHANGE</info>.


id: WIN32_SERVICE_ACCEPT_NETBINDCHANGE
type: constant
doc:
<comment>Description:</comment>
  Служба - это сетевой компонент, который принимает изменения в своей привязке без необходимости
  остановки и перезапуска. Этот управляющий флаг разрешает службе принимать следующие уведомления:
  <info>WIN32_SERVICE_CONTROL_NETBINDADD</info>, <info>WIN32_SERVICE_CONTROL_NETBINDREMOVE</info>,
  <info>WIN32_SERVICE_CONTROL_NETBINDENABLE</info> и <info>WIN32_SERVICE_CONTROL_NETBINDDISABLE</info>.


id: WIN32_SERVICE_ACCEPT_PARAMCHANGE
type: constant
doc:
<comment>Description:</comment>
  Служба может перечитать стартовые параметры без необходимости остановки и перезапуска. Этот
  управляющий флаг разрешает службе принимать следующие уведомления:
  <info>WIN32_SERVICE_CONTROL_PARAMCHANGE</info>.


id: WIN32_SERVICE_ACCEPT_PAUSE_CONTINUE
type: constant
doc:
<comment>Description:</comment>
  Служба может быть приостановлена и продолжена. Этот код позволяет службе принимать сообщения
  <info>WIN32_SERVICE_CONTROL_PAUSE</info> и <info>WIN32_SERVICE_CONTROL_CONTINUE</info>.


id: WIN32_SERVICE_ACCEPT_POWEREVENT
type: constant
doc:
<comment>Description:</comment>
  Служба оповещается, когда изменился статус электроснабжения. Позволяет системе посылать службе
  уведомление <info>WIN32_SERVICE_CONTROL_POWEREVENT</info>.


id: WIN32_SERVICE_ACCEPT_PRESHUTDOWN
type: constant
doc:
<comment>Description:</comment>
  Служба может выполнять задачи при остановке системы. Этот код позволяет службе принимать сообщения
  <info>WIN32_SERVICE_CONTROL_PRESHUTDOWN</info>. Это значение не поддерживается Windows Server 2003 и Windows
  XP/2000.


id: WIN32_SERVICE_ACCEPT_SESSIONCHANGE
type: constant
doc:
<comment>Description:</comment>
  Сервис оповещается когда изменился статус сессии на компьютере. Позволяет системе посылать службе
  уведомление <info>WIN32_SERVICE_CONTROL_SESSIONCHANGE</info>. Не поддерживается в Windows 2000


id: WIN32_SERVICE_ACCEPT_SHUTDOWN
type: constant
doc:
<comment>Description:</comment>
  Служба должна быть оповещена, что система останавливается. Этот код позволяет службе принимать
  сообщения <info>WIN32_SERVICE_CONTROL_SHUTDOWN</info>.


id: WIN32_SERVICE_ACCEPT_STOP
type: constant
doc:
<comment>Description:</comment>
  Эта служба может быть остановлена. Этот код позволяет службе принимать сообщения
  <info>WIN32_SERVICE_CONTROL_STOP</info>.


id: WIN32_SERVICE_ACCEPT_TIMECHANGE
type: constant
doc:
<comment>Description:</comment>
  Служба оповещается, когда изменилось системное время. Позволяет системе посылать службе оповещение
  <info>WIN32_SERVICE_CONTROL_TIMECHANGE</info>. В Windows Server 2008, Windows Vista, Windows Server 2003, и
  Windows XP/2000 этот управляющий код не используется.


id: WIN32_SERVICE_ACCEPT_TRIGGEREVENT
type: constant
doc:
<comment>Description:</comment>
  Служба уведомляется, когда происходит событие, для которого она зарегистрирована. Позволяет
  системе посылать службе оповещение <info>WIN32_SERVICE_CONTROL_TRIGGEREVENT</info>. В Windows Server 2008,
  Windows Vista, Windows Server 2003, и Windows XP/2000 этот управляющий код не используется.


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


id: WIN32_SERVICE_CONTROL_INTERROGATE
type: constant
doc:
<comment>Description:</comment>
  Оповещает службу, что надо послать информацию по её текущему статусу в менеджер служб.


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


id: WIN32_SERVICE_CONTROL_NETBINDDISABLE
type: constant
doc:
<comment>Description:</comment>
  0x0000000A
  
  Уведомляет сетевую службу о том, что одна из её привязок отключена.


id: WIN32_SERVICE_CONTROL_NETBINDENABLE
type: constant
doc:
<comment>Description:</comment>
  Уведомляет сетевую службу о том, что отключённая привязка включена.


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


id: WIN32_SERVICE_CONTROL_PRESHUTDOWN
type: constant
doc:
<comment>Description:</comment>
  0x0000000F
  
  Оповещает службу, что система останавливается. Служба, обрабатывающая такое сообщение, блокирует
  остановку системы до момента остановки службы, либо до превышения времени ожидания. Это значение
  не поддерживается Windows Server 2003 и Windows XP/2000.


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


id: WIN32_SERVICE_DEMAND_START
type: constant
doc:
<comment>Description:</comment>
  Сервис стартует автоматически, если какой-либо процесс вызвал функцию StartService.


id: WIN32_SERVICE_DISABLED
type: constant
doc:
<comment>Description:</comment>
  Сервис не может быть запущен. Попытка его старта вызовет ошибку <info>WIN32_ERROR_SERVICE_DISABLED</info>.


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


id: WIN32_SERVICE_ERROR_IGNORE
type: constant
doc:
<comment>Description:</comment>
  Запускающаяся программа игнорирует ошибки и продолжает запускаться.


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


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


id: WIN32_SERVICE_INTERACTIVE_PROCESS
type: constant
doc:
<comment>Description:</comment>
  Служба может взаимодействовать с рабочим столом. Эта опция недоступна в Windows Vista и более
  поздних.


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


id: WIN32_SERVICE_SYSTEM_START
type: constant
doc:
<comment>Description:</comment>
  Драйвер устройства запускается функцией IoInitSystem. Это значение корректно только для служб
  драйверов.


id: WIN32_SERVICE_WIN32_OWN_PROCESS_INTERACTIVE
type: constant
doc:
<comment>Description:</comment>
  Служба работает в своём собственном процессе и может взаимодействовать с рабочим столом. Эта опция
  недоступна в Windows Vista и более поздних.


id: WSDL_CACHE_BOTH
type: constant
doc:
<comment>Description:</comment>
  Определяет использование кеша WSDL как на диске, так и в памяти только при использовании с
  параметром soap.wsdl_cache или параметром <return>wsdl_cache</return> методов SoapClient::__construct и
  SoapServer::__construct.


id: WSDL_CACHE_DISK
type: constant
doc:
<comment>Description:</comment>
  Определяет использование кеша WSDL на диске только при использовании с параметром soap.wsdl_cache
  или параметром <return>wsdl_cache</return> методов SoapClient::__construct и SoapServer::__construct.


id: WSDL_CACHE_MEMORY
type: constant
doc:
<comment>Description:</comment>
  Определяет использование кеша WSDL в памяти только при использовании с параметром soap.wsdl_cache
  или параметром <return>wsdl_cache</return> методов SoapClient::__construct и SoapServer::__construct.


id: WSDL_CACHE_NONE
type: constant
doc:
<comment>Description:</comment>
  Отключает кеш WSDL при использовании с параметром soap.wsdl_cache или параметром <return>wsdl_cache</return>
  методов SoapClient::__construct и SoapServer::__construct.


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


id: WeakMap
type: class
doc:
<comment>Description:</comment>
  <class>WeakMap</class> - это коллекция (map) или словарь, который принимает объекты в качестве ключей. Однако, в
  отличие от аналогичного в остальном <class>SplObjectStorage</class>, объект в ключе <class>WeakMap</class> не влияет на счётчик
  ссылок объекта. То есть, если в какой-то момент единственной оставшейся ссылкой на объект является
  ключ <class>WeakMap</class>, объект будет собран сборщиком мусора и удалён из <class>WeakMap</class>. Его основной вариант
  использования - создание кешей данных, полученных из объекта, которым не нужно жить дольше, чем
  объект.
  
  <class>WeakMap</class> реализует ArrayAccess, Iterator и Countable, поэтому в большинстве случаев его можно
  использовать так же, как ассоциативный массив.


id: WeakMap::count
type: function
doc:
<comment>Description:</comment>
  Подсчитывает количество живых записей в коллекции (map)
  
  Подсчитывает количество живых записей в коллекции (map).

<comment>Return:</comment>
  <info>int</info>  Возвращает количество живых записей в коллекции (map).


id: WeakMap::getIterator
type: function
doc:
<comment>Description:</comment>
  Получает внешний итератор
  
  Возвращает внешний итератор.

<comment>Return:</comment>
  <info>Iterator</info>  Экземпляр объекта, реализующего <class>Iterator</class> или <class>Traversable</class>


id: WeakMap::offsetExists
type: function
doc:
<comment>Description:</comment>
  Проверяет, есть ли в коллекции (map) определённый объект
  
  Проверяет, есть ли ссылка на переданный объект в коллекции (map).

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

<comment>Return:</comment>
  <info>bool</info>  Возвращает <info>true</info>, если объект содержится в коллекции (map) или <info>false</info> в противном случае.


id: WeakMap::offsetGet
type: function
doc:
<comment>Description:</comment>
  Возвращает значение, на которое указывает определённый объект
  
  Возвращает значение, на которое указывает определённый объект.

<comment>Param:</comment>
  <info>object</info>  <strong>$object</strong>  Какой-то объект содержится в качестве ключа в коллекции (map).

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


id: WeakMap::offsetSet
type: function
doc:
<comment>Description:</comment>
  Обновляет коллекцию (map) новой парой ключ-значение
  
  Обновляет коллекцию (map) новой парой ключ-значение. Если ключ уже существует в коллекции, старое
  значение заменяется новым.

<comment>Param:</comment>
  <info>object</info>  <strong>$object</strong>  Объект, служащий ключом пары ключ-значение.
  <info>mixed</info>   <strong>$value</strong>   Произвольные данные, служащие значением пары ключ-значение.

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


id: WeakMap::offsetUnset
type: function
doc:
<comment>Description:</comment>
  Удаляет запись из коллекции (map)
  
  Удаляет запись из коллекции (map).

<comment>Param:</comment>
  <info>object</info>  <strong>$object</strong>  Объект, служащий ключом для записи, которую нужно удалить из коллекции.

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


id: WeakReference
type: class
doc:
<comment>Description:</comment>
  Класс WeakReference предоставляет способ доступа к объекту, не влияя при этом на количество ссылок
  на него, таким образом сборщик мусора сможет освободить этот объект.
  
  Объект класса <class>WeakReference</class> не может быть сериализован.


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

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


id: WeakReference::create
type: function
doc:
<comment>Description:</comment>
  Создаёт новую слабую ссылку
  
  Создаёт новый <class>WeakReference</class>.

<comment>Param:</comment>
  <info>object</info>  <strong>$object</strong>  Объект для слабой ссылки.

<comment>Return:</comment>
  <info>WeakReference</info>  Возвращает только что созданный объект.


id: WeakReference::get
type: function
doc:
<comment>Description:</comment>
  Получает объект со слабой ссылкой
  
  Получает объект со слабой ссылкой. Если объект уже был уничтожен, возвращается <info>null</info>.

<comment>Return:</comment>
  <info>object|null</info>  Возвращает ссылку <info>object</info> или <info>null</info>, если объект был уничтожен.


id: Worker
type: class
doc:
<comment>Description:</comment>
  Рабочие потоки имеют постоянный контекст, поэтому в большинстве случаев их следует использовать
  поверх потоков.
  
  Когда Worker запущен, будет выполнен метод run, но Thread не завершится, пока не будет выполнено
  одно из следующих условий:
  
  Worker исчезнет из области видимости (не останется ни одной ссылки на него)
  
  программист вызовет функцию остановки
  
  скрипт завершит работу
  
  Это значит, что программист может переиспользовать контекст во время исполнения. Размещение
  объекта на стек объекта Worker приведёт к запуску метода run этого объекта.


id: Worker::collect
type: function
doc:
<comment>Description:</comment>
  Собрать ссылки на завершённые задачи
  
  Позволяет Worker собрать "мусорные" ссылки на задачи. Опционально можно задать пользовательский
  сборщик.

<comment>Param:</comment>
  <info>Callable</info>  <strong>$collector</strong>  Сборщик типа Callable, который должен возвращать <info>true</info> или <info>false</info> в
                        зависимости от того, можно ли собрать задачу. Случаи, когда вам может
                        понадобиться собственный сборщик, крайне редки.

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


id: Worker::getStacked
type: function
doc:
<comment>Description:</comment>
  Возвращает текущий размер стека
  
  Возвращает количество задач, оставшихся в стеке.

<comment>Return:</comment>
  <info>int</info>  Возвращает количество задач, оставшихся в стеке и ожидающих запуска.


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

<comment>Return:</comment>
  <info>bool</info>  <info>true</info> если остановлен и <info>false</info>, если нет.


id: Worker::shutdown
type: function
doc:
<comment>Description:</comment>
  Остановить Worker
  
  Остановить Worker после запуска всех задач со стека.

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


id: Worker::stack
type: function
doc:
<comment>Description:</comment>
  Положить задачу на стек
  
  Добавляет задачу на стек заданному Worker.

<comment>Param:</comment>
  <info>Threaded</info>  <strong>$work</strong>  Объект типа <class>Threaded</class>, который будет запущен Worker.

<comment>Return:</comment>
  <info>int</info>  Новый размер стека.


id: Worker::unstack
type: function
doc:
<comment>Description:</comment>
  Убрать задачу со стека
  
  Убирает первую задачу (самую старую) из стека.

<comment>Return:</comment>
  <info>int</info>  Новый размер стека.


id: XATTR_CREATE
type: constant
doc:
<comment>Description:</comment>
  Функция завершится ошибкой, если расширенный атрибут уже существует.


id: XATTR_DONTFOLLOW
type: constant
doc:
<comment>Description:</comment>
  Не разыменовывать символические ссылки, работать с самими ссылками.


id: XATTR_REPLACE
type: constant
doc:
<comment>Description:</comment>
  Функция завершится ошибкой, если расширенный атрибут отсутствует.


id: XATTR_ROOT
type: constant
doc:
<comment>Description:</comment>
  Установить атрибут в корневом (доверенном) пространстве имён. Требует привилегий
  суперпользователя.


id: XDIFF_PATCH_NORMAL
type: constant
doc:
<comment>Description:</comment>
  Этот флаг обозначает, что функции <strong>xdiff_string_patch()</strong> и <strong>xdiff_file_patch()</strong> должны создавать
  результат путём применения патча к оригинальному контенту, таким образом, создавая новую версию
  файла. Это является поведением по умолчанию.


id: XDIFF_PATCH_REVERSE
type: constant
doc:
<comment>Description:</comment>
  Этот флаг обозначает, что функции <strong>xdiff_string_patch()</strong> и <strong>xdiff_file_patch()</strong> должны создавать
  результат путём отката патча с полученного нового контента, таким образом, восстанавливая
  оригинальный контент.


id: XHPROF_FLAGS_CPU
type: constant
doc:
<comment>Description:</comment>
  Используется для добавления в отчёт информации по профилированию CPU.


id: XHPROF_FLAGS_MEMORY
type: constant
doc:
<comment>Description:</comment>
  Используется для добавления в отчёт информации по профилированию памяти.


id: XMLDiff\Base
type: class
doc:
<comment>Description:</comment>
  Базовый абстрактный класс для всех классов сравнения данного модуля.


id: XMLDiff\Base::__construct
type: function
doc:
<comment>Description:</comment>
  Конструктор
  
  Базовый конструктор для всех рабочих классов модуля xmldiff.

<comment>Param:</comment>
  <info>string</info>  <strong>$nsname</strong>  Выбранное имя пространства имён для сравнения документов. Пространство имён по
                   умолчанию http://www.locus.cz/diffmark и этого достаточно для избежания конфликта
                   пространств имён. Используйте этот параметр, если, по какой либо причине, вы
                   хотите поменять значение по умолчанию.


id: XMLDiff\Base::diff
type: function
doc:
<comment>Description:</comment>
  Производит сравнение двух документов XML
  
  Абстрактный метод сравнения для реализации в классах наследниках.
  
  Главная задача этого метода - создание списка различий двух документов. Порядок входных параметров
  важен, так как от него зависит результат.

<comment>Param:</comment>
  <info>mixed</info>  <strong>$from</strong>  Исходный документ XML.
  <info>mixed</info>  <strong>$to</strong>    XML документ, с которым производится сравнение.

<comment>Return:</comment>
  <info>mixed</info>  Зависит от реализации.


id: XMLDiff\Base::merge
type: function
doc:
<comment>Description:</comment>
  Создаёт новый документ XML, основываясь на информации о его отличии от другого
  
  Абстрактный метод сравнения для реализации в классах наследниках.
  
  Основная цель метода - создание нового документа основываясь на информации о различиях двух
  документов.

<comment>Param:</comment>
  <info>mixed</info>  <strong>$src</strong>   Исходный документ XML.
  <info>mixed</info>  <strong>$diff</strong>  Документ, созданный методом, реализующего абстрактный метод XMLDiff\Base::diff.

<comment>Return:</comment>
  <info>mixed</info>  Зависит от реализации.


id: XMLDiff\DOM::diff
type: function
doc:
<comment>Description:</comment>
  Поиск различий в двух объектах DOMDocument
  
  Ищет различия в двух объектах DOMDocument и возвращает новый объект, содержащий эти различия.

<comment>Param:</comment>
  <info>DOMDocument</info>  <strong>$from</strong>  Исходный объект DOMDocument.
  <info>DOMDocument</info>  <strong>$to</strong>    Объект DOMDocument, с которым производится сравнение.

<comment>Return:</comment>
  <info>DOMDocument</info>  Новый объект DOMDocument с информацией о найденных отличиях, или NULL.


id: XMLDiff\DOM::merge
type: function
doc:
<comment>Description:</comment>
  Объединяет объект DOMDocument, на основании другого объекта DOMDocument, полученного с помощью
  XMLDiff\DOM::diff
  
  Объединяет объект DOMDocument, на основании другого объекта DOMDocument, полученного с помощью
  XMLDiff\DOM::diff.

<comment>Param:</comment>
  <info>DOMDocument</info>  <strong>$src</strong>   Исходный объект DOMDocument.
  <info>DOMDocument</info>  <strong>$diff</strong>  Объект DOMDocument, содержащий информацию, полученную с помощью
                      XMLDiff\DOM::diff.

<comment>Return:</comment>
  <info>DOMDocument</info>  Объединённый DOMDocument или NULL.


id: XMLDiff\File::diff
type: function
doc:
<comment>Description:</comment>
  Сравнение двух файлов XML
  
  Сравнивает два локальных файла XML и возвращает строку с информацией о различиях.

<comment>Param:</comment>
  <info>string</info>  <strong>$from</strong>  Путь к документу источнику.
  <info>string</info>  <strong>$to</strong>    Путь к целевому документу.

<comment>Return:</comment>
  <info>string</info>  Строка с XML-документом, содержащая информацию о различиях, либо <info>null</info>.


id: XMLDiff\File::merge
type: function
doc:
<comment>Description:</comment>
  Применить изменения к документу XML
  
  Создаёт новый документ XML на базе документа источника и списка изменений.

<comment>Param:</comment>
  <info>string</info>  <strong>$src</strong>   Путь к XML-документу источнику.
  <info>string</info>  <strong>$diff</strong>  Путь к XML-документу, содержащему информацию об изменениях.

<comment>Return:</comment>
  <info>string</info>  Строка с новым XML-документом или <info>null</info>.


id: XMLDiff\Memory::diff
type: function
doc:
<comment>Description:</comment>
  Сравнение двух документов XML
  
  Сравнивает две строки с XML и возвращает строку с информацией о различиях.

<comment>Param:</comment>
  <info>string</info>  <strong>$from</strong>  XML-документ источник.
  <info>string</info>  <strong>$to</strong>    Целевой XML-документ.

<comment>Return:</comment>
  <info>string</info>  Строка с XML-документом, содержащая информацию о различиях, либо <info>null</info>.


id: XMLDiff\Memory::merge
type: function
doc:
<comment>Description:</comment>
  Применить изменения к документу XML
  
  Создаёт новый документ XML на базе документа источника и списка изменений.

<comment>Param:</comment>
  <info>string</info>  <strong>$src</strong>   XML-документ источник.
  <info>string</info>  <strong>$diff</strong>  XML-документ, содержащий информацию об изменениях.

<comment>Return:</comment>
  <info>string</info>  Строка с новым XML-документом или <info>null</info>.


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


id: XMLReader
type: class
doc:
<comment>Description:</comment>
  Модуль XMLReader - синтаксический анализатор XML. Класс-читатель выступает в качестве курсора,
  следует по потоку документа и останавливается на каждом узле на этом пути.


id: XMLReader::XML
type: function
doc:
<comment>Description:</comment>
  Установить данные, содержащие XML для разбора
  
  Устанавливает данные, содержащие XML для разбора.

<comment>Param:</comment>
  <info>string</info>       <strong>$source</strong>    Строка, содержащая XML для разбора.
  <info>string|null</info>  <strong>$encoding</strong>  Кодировка документа или <info>null</info>.
  <info>int</info>          <strong>$flags</strong>     Битовая маска констант LIBXML_*.

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

<comment>See Also:</comment>
   * XMLReader::open
   * XMLReader::close


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

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

<comment>See Also:</comment>
   * XMLReader::open
   * XMLReader::xml


id: XMLReader::expand
type: function
doc:
<comment>Description:</comment>
  Возвратить копию текущего узла в виде объекта DOM
  
  Этот метод копирует текущий узел и возвращает соответствующий объект DOM.

<comment>Param:</comment>
  <info>DOMNode|null</info>  <strong>$baseNode</strong>  <class>DOMNode</class> определяет целевой <class>DOMDocument</class> созданного объекта DOM.

<comment>Return:</comment>
  <info>DOMNode|false</info>  Результирующий <class>DOMNode</class> или <info>false</info> в случае возникновения ошибки.


id: XMLReader::getAttribute
type: function
doc:
<comment>Description:</comment>
  Получить значение атрибута с определённым именем
  
  Возвращает значение именованного атрибута или <info>null</info>, если атрибут не существует или не находится в
  узле элемента.

<comment>Param:</comment>
  <info>string</info>  <strong>$name</strong>  Имя атрибута.

<comment>Return:</comment>
  <info>string|null</info>  Значение атрибута или <info>null</info>, если атрибут с заданным параметром <strong>$name</strong> не найден или
               нет позиции элемента.

<comment>See Also:</comment>
   * XMLReader::getAttributeNo
   * XMLReader::getAttributeNs


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

<comment>Param:</comment>
  <info>int</info>  <strong>$index</strong>  Позиция атрибута.

<comment>Return:</comment>
  <info>string|null</info>  Значение атрибута или <info>null</info>, если атрибут с заданным параметром <strong>$index</strong> не существует
               или нет позиции элемента.

<comment>See Also:</comment>
   * XMLReader::getAttribute
   * XMLReader::getAttributeNs


id: XMLReader::getAttributeNs
type: function
doc:
<comment>Description:</comment>
  Получить значение атрибута по localname и URI
  
  Возвращает значение атрибута по имени и URI пространства имён или пустую строку, если атрибут не
  существует или не расположен на узле элемента.

<comment>Param:</comment>
  <info>string</info>  <strong>$name</strong>       Локальное имя.
  <info>string</info>  <strong>$namespace</strong>  URI пространства имён.

<comment>Return:</comment>
  <info>string|null</info>  Значение атрибута или <info>null</info>, если атрибут с заданным <strong>$name</strong> и <strong>$namespace</strong> не найден или
               нет позиции элемента.

<comment>See Also:</comment>
   * XMLReader::getAttribute
   * XMLReader::getAttributeNo


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

<comment>Param:</comment>
  <info>int</info>  <strong>$property</strong>  Одна из констант анализатора.

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

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


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

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

<comment>See Also:</comment>
   * XMLReader::setParserProperty
   * XMLReader::setRelaxNGSchema
   * XMLReader::setRelaxNGSchemaSource
   * XMLReader::setSchema


id: XMLReader::lookupNamespace
type: function
doc:
<comment>Description:</comment>
  Найти пространство имён для префикса
  
  Поиск в контексте пространства имён для данного префикса.

<comment>Param:</comment>
  <info>string</info>  <strong>$prefix</strong>  Строка, содержащая префикс.

<comment>Return:</comment>
  <info>string|null</info>  Значение пространства имён или <info>null</info>, если пространства имён не существует.


id: XMLReader::moveToAttribute
type: function
doc:
<comment>Description:</comment>
  Переместить курсор к атрибуту с заданным именем
  
  Позиционирует курсор на атрибуте с заданным именем.

<comment>Param:</comment>
  <info>string</info>  <strong>$name</strong>  Имя атрибута.

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

<comment>See Also:</comment>
   * XMLReader::moveToElement
   * XMLReader::moveToAttributeNo
   * XMLReader::moveToAttributeNs
   * XMLReader::moveToFirstAttribute


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

<comment>Param:</comment>
  <info>int</info>  <strong>$index</strong>  Позиция атрибута.

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

<comment>See Also:</comment>
   * XMLReader::moveToElement
   * XMLReader::moveToAttribute
   * XMLReader::moveToAttributeNs
   * XMLReader::moveToFirstAttribute


id: XMLReader::moveToAttributeNs
type: function
doc:
<comment>Description:</comment>
  Переместить курсор к именованному атрибуту
  
  Позиционирует курсор на именованном атрибуте в указанном пространстве имён.

<comment>Param:</comment>
  <info>string</info>  <strong>$name</strong>       Локальное имя.
  <info>string</info>  <strong>$namespace</strong>  URI пространства имён.

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

<comment>See Also:</comment>
   * XMLReader::moveToElement
   * XMLReader::moveToAttribute
   * XMLReader::moveToAttributeNo
   * XMLReader::moveToFirstAttribute


id: XMLReader::moveToElement
type: function
doc:
<comment>Description:</comment>
  Позиционировать курсор на родительском элементе текущего атрибута
  
  Перемещает курсор на родительский элемент текущего атрибута.

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

<comment>See Also:</comment>
   * XMLReader::moveToAttribute
   * XMLReader::moveToAttributeNo
   * XMLReader::moveToAttributeNs
   * XMLReader::moveToFirstAttribute


id: XMLReader::moveToFirstAttribute
type: function
doc:
<comment>Description:</comment>
  Переместить позицию курсора на первый атрибут
  
  Перемещает позицию курсора на первый атрибут.

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

<comment>See Also:</comment>
   * XMLReader::moveToElement
   * XMLReader::moveToAttribute
   * XMLReader::moveToAttributeNo
   * XMLReader::moveToAttributeNs
   * XMLReader::moveToNextAttribute


id: XMLReader::moveToNextAttribute
type: function
doc:
<comment>Description:</comment>
  Переместить позицию курсора на следующий атрибут
  
  Перемещает курсора к следующему атрибуту, если курсор спозиционирован на атрибуте или перемещает
  позицию на первый атрибут, если спозиционирован на элементе.

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

<comment>See Also:</comment>
   * XMLReader::moveToElement
   * XMLReader::moveToAttribute
   * XMLReader::moveToAttributeNo
   * XMLReader::moveToAttributeNs
   * XMLReader::moveToFirstAttribute


id: XMLReader::next
type: function
doc:
<comment>Description:</comment>
  Переместить курсор на следующий узел, пропуская все поддеревья
  
  Позиционирует курсор на следующем узле, пропуская все поддеревья. Если такой узел не существует,
  курсор перемещается в конец документа.

<comment>Param:</comment>
  <info>string|null</info>  <strong>$name</strong>  Имя следующего узла для перехода.

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

<comment>See Also:</comment>
   * XMLReader::moveToNextAttribute
   * XMLReader::moveToElement
   * XMLReader::moveToAttribute


id: XMLReader::open
type: function
doc:
<comment>Description:</comment>
  Установить URI, содержащий XML-документ для разбора
  
  Установить URI, содержащий XML-документ, который будет разобран.

<comment>Param:</comment>
  <info>string</info>       <strong>$uri</strong>       URI, указывающий на документ.
  <info>string|null</info>  <strong>$encoding</strong>  Кодировка документа или <info>null</info>.
  <info>int</info>          <strong>$flags</strong>     Битовая маска, состоящая из LIBXML_* констант.

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

<comment>See Also:</comment>
   * XMLReader::xml
   * XMLReader::close


id: XMLReader::read
type: function
doc:
<comment>Description:</comment>
  Переместиться к следующему узлу в документе
  
  Перемещает курсор к следующему узлу в документе.

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

<comment>See Also:</comment>
   * XMLReader::moveToElement
   * XMLReader::moveToAttribute
   * XMLReader::next


id: XMLReader::readInnerXml
type: function
doc:
<comment>Description:</comment>
  Извлечь XML из текущего узла
  
  Читает содержимое текущего узла, включая дочерние узлы и разметку.

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

<comment>See Also:</comment>
   * <strong>XMLReader::readString()</strong>
   * <strong>XMLReader::readOuterXml()</strong>
   * <strong>XMLReader::expand()</strong>


id: XMLReader::readOuterXml
type: function
doc:
<comment>Description:</comment>
  Получить XML из текущего узла, включая сам узел
  
  Читает содержимое текущего узла, включая сам узел.

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

<comment>See Also:</comment>
   * <strong>XMLReader::readString()</strong>
   * <strong>XMLReader::readInnerXml()</strong>
   * <strong>XMLReader::expand()</strong>


id: XMLReader::readString
type: function
doc:
<comment>Description:</comment>
  Прочитать содержимое текущего узла как строку
  
  Читает содержимое текущего узла как строку.

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

<comment>See Also:</comment>
   * <strong>XMLReader::readOuterXml()</strong>
   * <strong>XMLReader::readInnerXml()</strong>
   * <strong>XMLReader::expand()</strong>


id: XMLReader::setParserProperty
type: function
doc:
<comment>Description:</comment>
  Устанавливает опцию парсера
  
  Устанавливает опции для парсера. Опции должны быть установлены после вызова XMLReader::open или
  XMLReader::xml и до первого вызова XMLReader::read.

<comment>Param:</comment>
  <info>int</info>   <strong>$property</strong>  Одна из констант опций парсера.
  <info>bool</info>  <strong>$value</strong>     Если установлено в <info>true</info>, то опция будет включена, в противном случае опция будет
                   выключена.

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


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

<comment>Param:</comment>
  <info>string|null</info>  <strong>$filename</strong>  Имя файла или URI, указывающий на схему RelaxNG.

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

<comment>See Also:</comment>
   * XMLReader::setRelaxNGSchemaSource
   * XMLReader::setSchema
   * XMLReader::isValid


id: XMLReader::setRelaxNGSchemaSource
type: function
doc:
<comment>Description:</comment>
  Устанавливает данные, содержащие схему RelaxNG
  
  Устанавливает данные, содержащие схему RelaxNG, используемую при проверке.

<comment>Param:</comment>
  <info>string|null</info>  <strong>$source</strong>  Строка, содержащая схему RelaxNG.

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

<comment>See Also:</comment>
   * XMLReader::setRelaxNGSchema
   * XMLReader::setSchema
   * XMLReader::isValid


id: XMLReader::setSchema
type: function
doc:
<comment>Description:</comment>
  Проверить документ, используя XSD
  
  Использует схему W3C XSD для проверки документов в процессе работы. Активация возможна только до
  первого вызова Read().

<comment>Param:</comment>
  <info>string|null</info>  <strong>$filename</strong>  Имя файла XSD схемы.

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

<comment>See Also:</comment>
   * XMLReader::setRelaxNGSchema
   * XMLReader::setRelaxNGSchemaSource
   * XMLReader::isValid


id: XMLWriter::endAttribute
type: function
doc:
<comment>Description:</comment>
  Завершить атрибут
  
  Объектно-ориентированный стиль
  
  Процедурный стиль
  
  Завершает текущий атрибут.

<comment>Param:</comment>
  <info>XMLWriter</info>  <strong>$writer</strong>  Только для процедурных вызовов.
                      Изменяемый экземпляр <class>XMLWriter</class>. Объект возвращается из вызова
                      <strong>xmlwriter_open_uri()</strong> или <strong>xmlwriter_open_memory()</strong>.

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

<comment>See Also:</comment>
   * XMLWriter::startAttribute
   * XMLWriter::startAttributeNs
   * XMLWriter::writeAttribute
   * XMLWriter::writeAttributeNs


id: XMLWriter::endCdata
type: function
doc:
<comment>Description:</comment>
  Завершить текущую секцию CDATA
  
  Объектно-ориентированный стиль
  
  Процедурный стиль
  
  Завершает текущую секцию CDATA.

<comment>Param:</comment>
  <info>XMLWriter</info>  <strong>$writer</strong>  Только для процедурных вызовов.
                      Изменяемый экземпляр <class>XMLWriter</class>. Объект возвращается из вызова
                      <strong>xmlwriter_open_uri()</strong> или <strong>xmlwriter_open_memory()</strong>.

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

<comment>See Also:</comment>
   * XMLWriter::startCdata
   * XMLWriter::writeCdata


id: XMLWriter::endComment
type: function
doc:
<comment>Description:</comment>
  Завершить комментарий
  
  Объектно-ориентированный стиль
  
  Процедурный стиль
  
  Завершает текущий комментарий.

<comment>Param:</comment>
  <info>XMLWriter</info>  <strong>$writer</strong>  Только для процедурных вызовов.
                      Изменяемый экземпляр <class>XMLWriter</class>. Объект возвращается из вызова
                      <strong>xmlwriter_open_uri()</strong> или <strong>xmlwriter_open_memory()</strong>.

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

<comment>See Also:</comment>
   * XMLWriter::startComment
   * XMLWriter::writeComment


id: XMLWriter::endDocument
type: function
doc:
<comment>Description:</comment>
  Завершить текущий документ
  
  Объектно-ориентированный стиль
  
  Процедурный стиль
  
  Завершает текущий документ.

<comment>Param:</comment>
  <info>XMLWriter</info>  <strong>$writer</strong>  Только для процедурных вызовов.
                      Изменяемый экземпляр <class>XMLWriter</class>. Объект возвращается из вызова
                      <strong>xmlwriter_open_uri()</strong> или <strong>xmlwriter_open_memory()</strong>.

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

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


id: XMLWriter::endDtd
type: function
doc:
<comment>Description:</comment>
  Завершить текущий DTD
  
  Объектно-ориентированный стиль
  
  Процедурный стиль
  
  Завершает секцию определения типа документа (DTD).

<comment>Param:</comment>
  <info>XMLWriter</info>  <strong>$writer</strong>  Только для процедурных вызовов.
                      Изменяемый экземпляр <class>XMLWriter</class>. Объект возвращается из вызова
                      <strong>xmlwriter_open_uri()</strong> или <strong>xmlwriter_open_memory()</strong>.

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

<comment>See Also:</comment>
   * XMLWriter::startDtd
   * XMLWriter::writeDtd


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

<comment>Param:</comment>
  <info>XMLWriter</info>  <strong>$writer</strong>  Только для процедурных вызовов.
                      Изменяемый экземпляр <class>XMLWriter</class>. Объект возвращается из вызова
                      <strong>xmlwriter_open_uri()</strong> или <strong>xmlwriter_open_memory()</strong>.

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

<comment>See Also:</comment>
   * XMLWriter::startDtdAttlist
   * XMLWriter::writeDtdAttlist


id: XMLWriter::endDtdElement
type: function
doc:
<comment>Description:</comment>
  Завершить текущий элемент DTD
  
  Объектно-ориентированный стиль
  
  Процедурный стиль
  
  Завершает текущий элемент DTD.

<comment>Param:</comment>
  <info>XMLWriter</info>  <strong>$writer</strong>  Только для процедурных вызовов.
                      Изменяемый экземпляр <class>XMLWriter</class>. Объект возвращается из вызова
                      <strong>xmlwriter_open_uri()</strong> или <strong>xmlwriter_open_memory()</strong>.

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

<comment>See Also:</comment>
   * XMLWriter::startDtdElement
   * XMLWriter::writeDtdElement


id: XMLWriter::endDtdEntity
type: function
doc:
<comment>Description:</comment>
  Завершить текущую запись DTD
  
  Объектно-ориентированный стиль
  
  Процедурный стиль
  
  Завершает текущую запись DTD.

<comment>Param:</comment>
  <info>XMLWriter</info>  <strong>$writer</strong>  Только для процедурных вызовов.
                      Изменяемый экземпляр <class>XMLWriter</class>. Объект возвращается из вызова
                      <strong>xmlwriter_open_uri()</strong> или <strong>xmlwriter_open_memory()</strong>.

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

<comment>See Also:</comment>
   * XMLWriter::startDtdEntity
   * XMLWriter::writeDtdEntity


id: XMLWriter::endElement
type: function
doc:
<comment>Description:</comment>
  Завершить текущий элемент
  
  Объектно-ориентированный стиль
  
  Процедурный стиль
  
  Завершает текущий элемент.

<comment>Param:</comment>
  <info>XMLWriter</info>  <strong>$writer</strong>  Только для процедурных вызовов.
                      Изменяемый экземпляр <class>XMLWriter</class>. Объект возвращается из вызова
                      <strong>xmlwriter_open_uri()</strong> или <strong>xmlwriter_open_memory()</strong>.

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

<comment>See Also:</comment>
   * XMLWriter::startElement
   * XMLWriter::writeElement


id: XMLWriter::endPi
type: function
doc:
<comment>Description:</comment>
  Завершить текущую инструкцию обработки (PI)
  
  Объектно-ориентированный стиль
  
  Процедурный стиль
  
  Завершает текущую инструкцию обработки.

<comment>Param:</comment>
  <info>XMLWriter</info>  <strong>$writer</strong>  Только для процедурных вызовов.
                      Изменяемый экземпляр <class>XMLWriter</class>. Объект возвращается из вызова
                      <strong>xmlwriter_open_uri()</strong> или <strong>xmlwriter_open_memory()</strong>.

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

<comment>See Also:</comment>
   * XMLWriter::startPi
   * XMLWriter::writePi


id: XMLWriter::flush
type: function
doc:
<comment>Description:</comment>
  Сбросить текущий буфер
  
  Объектно-ориентированный стиль
  
  Процедурный стиль
  
  Сбрасывает текущий буфер.

<comment>Param:</comment>
  <info>XMLWriter</info>  <strong>$writer</strong>  Только для процедурных вызовов.
                      Изменяемый экземпляр <class>XMLWriter</class>. Объект возвращается из вызова
                      <strong>xmlwriter_open_uri()</strong> или <strong>xmlwriter_open_memory()</strong>.
  <info>bool</info>       <strong>$empty</strong>   Определяет, освободить буфер или нет. По умолчанию <info>true</info>.

<comment>Return:</comment>
  <info>string|int</info>  Если XML создаётся в  памяти, то функция вернёт сгенерированный буфер XML, иначе, при
              использовании URI, эта функция запишет буфер и вернёт количество записанных байт.


id: XMLWriter::fullEndElement
type: function
doc:
<comment>Description:</comment>
  Завершить текущий элемент
  
  Объектно-ориентированный стиль
  
  Процедурный стиль
  
  Завершает текущий XML элемент. Записывает закрывающий тег, даже если элемент пустой.

<comment>Param:</comment>
  <info>XMLWriter</info>  <strong>$writer</strong>  Только для процедурных вызовов.
                      Изменяемый экземпляр <class>XMLWriter</class>. Объект возвращается из вызова
                      <strong>xmlwriter_open_uri()</strong> или <strong>xmlwriter_open_memory()</strong>.

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

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


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

<comment>Return:</comment>
  <info>bool</info>  Объектно-ориентированный стиль: Возвращает <info>true</info> в случае успешного выполнения или <info>false</info> в
        случае возникновения ошибки.
        
        Процедурный стиль: Возвращает новый <class>XMLWriter</class> для дальнейшего использования функциями
        xmlwriter в случае успешного выполнения или <info>false</info> в случае возникновения ошибки.

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


id: XMLWriter::openUri
type: function
doc:
<comment>Description:</comment>
  Создать новый объект XMLWriter, используя исходный URI для вывода
  
  Объектно-ориентированный стиль
  
  Процедурный стиль
  
  Создаёт новый объект <class>XMLWriter</class>, используя <strong>$uri</strong> для вывода.

<comment>Param:</comment>
  <info>string</info>  <strong>$uri</strong>  URI ресурса для вывода.

<comment>Return:</comment>
  <info>bool</info>  Объектно-ориентированный стиль: Возвращает <info>true</info> в случае успешного выполнения или <info>false</info> в
        случае возникновения ошибки.
        
        Процедурный стиль: Возвращает новый <class>XMLWriter</class> для дальнейшего использования функциями
        xmlwriter в случае успешного выполнения или <info>false</info> в случае возникновения ошибки.

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


id: XMLWriter::outputMemory
type: function
doc:
<comment>Description:</comment>
  Возвращает текущий буфер
  
  Объектно-ориентированный стиль
  
  Процедурный стиль
  
  Возвращает текущий буфер.

<comment>Param:</comment>
  <info>XMLWriter</info>  <strong>$writer</strong>  Только для процедурных вызовов.
                      Изменяемый экземпляр <class>XMLWriter</class>. Объект возвращается из вызова
                      <strong>xmlwriter_open_uri()</strong> или <strong>xmlwriter_open_memory()</strong>.
  <info>bool</info>       <strong>$flush</strong>   Определяет, освободить буфер или нет. По умолчанию <info>true</info>.

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

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


id: XMLWriter::setIndent
type: function
doc:
<comment>Description:</comment>
  Включить или отключить отступы
  
  Объектно-ориентированный стиль
  
  Процедурный стиль
  
  Включает или отключает отступы.

<comment>Param:</comment>
  <info>XMLWriter</info>  <strong>$writer</strong>  Только для процедурных вызовов.
                      Изменяемый экземпляр <class>XMLWriter</class>. Объект возвращается из вызова
                      <strong>xmlwriter_open_uri()</strong> или <strong>xmlwriter_open_memory()</strong>.
  <info>bool</info>       <strong>$enable</strong>  Определяет, включено ли добавление отступа.

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

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


id: XMLWriter::setIndentString
type: function
doc:
<comment>Description:</comment>
  Установить строку, используемую для отступов
  
  Объектно-ориентированный стиль
  
  Процедурный стиль
  
  Устанавливает строку, которая будет использоваться для отступа каждого элемента/атрибута в
  результирующем XML.

<comment>Param:</comment>
  <info>XMLWriter</info>  <strong>$writer</strong>        Только для процедурных вызовов.
                            Изменяемый экземпляр <class>XMLWriter</class>. Объект возвращается из вызова
                            <strong>xmlwriter_open_uri()</strong> или <strong>xmlwriter_open_memory()</strong>.
  <info></info>           <strong>$indentString</strong>  Отступ строки.

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

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


id: XMLWriter::startAttribute
type: function
doc:
<comment>Description:</comment>
  Создать начальный атрибут
  
  Объектно-ориентированный стиль
  
  Процедурный стиль
  
  Начинает атрибут.

<comment>Param:</comment>
  <info>XMLWriter</info>  <strong>$writer</strong>  Только для процедурных вызовов.
                      Изменяемый экземпляр <class>XMLWriter</class>. Объект возвращается из вызова
                      <strong>xmlwriter_open_uri()</strong> или <strong>xmlwriter_open_memory()</strong>.
  <info>string</info>     <strong>$name</strong>    Имя атрибута.

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

<comment>See Also:</comment>
   * XMLWriter::startAttributeNs
   * XMLWriter::endAttribute
   * XMLWriter::writeAttribute
   * XMLWriter::writeAttributeNs


id: XMLWriter::startAttributeNs
type: function
doc:
<comment>Description:</comment>
  Создать стартовый атрибут пространства имён
  
  Объектно-ориентированный стиль
  
  Процедурный стиль
  
  Начинает атрибут пространства имён.

<comment>Param:</comment>
  <info>XMLWriter</info>    <strong>$writer</strong>     Только для процедурных вызовов.
                           Изменяемый экземпляр <class>XMLWriter</class>. Объект возвращается из вызова
                           <strong>xmlwriter_open_uri()</strong> или <strong>xmlwriter_open_memory()</strong>.
  <info>string|null</info>  <strong>$prefix</strong>     Префикс пространства имён.
  <info>string</info>       <strong>$name</strong>       Имя атрибута.
  <info>string|null</info>  <strong>$namespace</strong>  URI пространства имён. Если <strong>$namespace</strong> равен <info>null</info>, объявление
                           пространства имён будет опущено.

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

<comment>See Also:</comment>
   * XMLWriter::startAttribute
   * XMLWriter::endAttribute
   * XMLWriter::writeAttribute
   * XMLWriter::writeAttributeNs


id: XMLWriter::startCdata
type: function
doc:
<comment>Description:</comment>
  Создать начальный тег CDATA
  
  Объектно-ориентированный стиль
  
  Процедурный стиль
  
  Начинает CDATA.

<comment>Param:</comment>
  <info>XMLWriter</info>  <strong>$writer</strong>  Только для процедурных вызовов.
                      Изменяемый экземпляр <class>XMLWriter</class>. Объект возвращается из вызова
                      <strong>xmlwriter_open_uri()</strong> или <strong>xmlwriter_open_memory()</strong>.

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

<comment>See Also:</comment>
   * XMLWriter::endCdata
   * XMLWriter::writeCdata


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

<comment>Param:</comment>
  <info>XMLWriter</info>  <strong>$writer</strong>  Только для процедурных вызовов.
                      Изменяемый экземпляр <class>XMLWriter</class>. Объект возвращается из вызова
                      <strong>xmlwriter_open_uri()</strong> или <strong>xmlwriter_open_memory()</strong>.

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

<comment>See Also:</comment>
   * XMLWriter::endComment
   * XMLWriter::writeComment


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

<comment>Param:</comment>
  <info>XMLWriter</info>    <strong>$writer</strong>      Только для процедурных вызовов.
                            Изменяемый экземпляр <class>XMLWriter</class>. Объект возвращается из вызова
                            <strong>xmlwriter_open_uri()</strong> или <strong>xmlwriter_open_memory()</strong>.
  <info>string|null</info>  <strong>$version</strong>     Номер версии документа как часть объявления XML.
  <info>string|null</info>  <strong>$encoding</strong>    Кодировка документа как часть объявления XML.
  <info>string|null</info>  <strong>$standalone</strong>  <return>yes</return> или <return>no</return>.

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

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


id: XMLWriter::startDtd
type: function
doc:
<comment>Description:</comment>
  Создать стартовый DTD тег
  
  Объектно-ориентированный стиль
  
  Процедурный стиль
  
  Начинает DTD.

<comment>Param:</comment>
  <info>XMLWriter</info>    <strong>$writer</strong>         Только для процедурных вызовов.
                               Изменяемый экземпляр <class>XMLWriter</class>. Объект возвращается из вызова
                               <strong>xmlwriter_open_uri()</strong> или <strong>xmlwriter_open_memory()</strong>.
  <info>string</info>       <strong>$qualifiedName</strong>  Полностью определённое имя типа документа для создания.
  <info>string|null</info>  <strong>$publicId</strong>       Идентификатор внешнего публичного подмножества.
  <info>string|null</info>  <strong>$systemId</strong>       Идентификатор внешнего системного подмножества.

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

<comment>See Also:</comment>
   * XMLWriter::endDtd
   * XMLWriter::writeDtd


id: XMLWriter::startDtdAttlist
type: function
doc:
<comment>Description:</comment>
  Создаёт стартовый список атрибутов DTD
  
  Объектно-ориентированный стиль
  
  Процедурный стиль
  
  Начинает список атрибутов DTD.

<comment>Param:</comment>
  <info>XMLWriter</info>  <strong>$writer</strong>  Только для процедурных вызовов.
                      Изменяемый экземпляр <class>XMLWriter</class>. Объект возвращается из вызова
                      <strong>xmlwriter_open_uri()</strong> или <strong>xmlwriter_open_memory()</strong>.
  <info>string</info>     <strong>$name</strong>    Название списка атрибутов.

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

<comment>See Also:</comment>
   * XMLWriter::endDtdAttlist
   * XMLWriter::writeDtdAttlist


id: XMLWriter::startDtdElement
type: function
doc:
<comment>Description:</comment>
  Создать стартовый элемент DTD
  
  Объектно-ориентированный стиль
  
  Процедурный стиль
  
  Начинает элемент DTD.

<comment>Param:</comment>
  <info>XMLWriter</info>  <strong>$writer</strong>         Только для процедурных вызовов.
                             Изменяемый экземпляр <class>XMLWriter</class>. Объект возвращается из вызова
                             <strong>xmlwriter_open_uri()</strong> или <strong>xmlwriter_open_memory()</strong>.
  <info>string</info>     <strong>$qualifiedName</strong>  Полностью определённое имя типа документа для создания.

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

<comment>See Also:</comment>
   * XMLWriter::endDtdElement
   * XMLWriter::writeDtdElement


id: XMLWriter::startDtdEntity
type: function
doc:
<comment>Description:</comment>
  Создать стартовую запись DTD
  
  Объектно-ориентированный стиль
  
  Процедурный стиль
  
  Начинает запись DTD.

<comment>Param:</comment>
  <info>XMLWriter</info>  <strong>$writer</strong>   Только для процедурных вызовов.
                       Изменяемый экземпляр <class>XMLWriter</class>. Объект возвращается из вызова
                       <strong>xmlwriter_open_uri()</strong> или <strong>xmlwriter_open_memory()</strong>.
  <info>string</info>     <strong>$name</strong>     Имя записи.
  <info>bool</info>       <strong>$isParam</strong>  

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

<comment>See Also:</comment>
   * XMLWriter::endDtdEntity
   * XMLWriter::writeDtdEntity


id: XMLWriter::startElement
type: function
doc:
<comment>Description:</comment>
  Создать стартовый тег элемента
  
  Объектно-ориентированный стиль
  
  Процедурный стиль
  
  Начинает элемент.

<comment>Param:</comment>
  <info>XMLWriter</info>  <strong>$writer</strong>  Только для процедурных вызовов.
                      Изменяемый экземпляр <class>XMLWriter</class>. Объект возвращается из вызова
                      <strong>xmlwriter_open_uri()</strong> или <strong>xmlwriter_open_memory()</strong>.
  <info>string</info>     <strong>$name</strong>    Имя элемента.

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

<comment>See Also:</comment>
   * XMLWriter::endElement
   * XMLWriter::writeElement


id: XMLWriter::startElementNs
type: function
doc:
<comment>Description:</comment>
  Создать стартовый тег элемента пространства имён
  
  Объектно-ориентированный стиль
  
  Процедурный стиль
  
  Начинает элемент пространства имён.

<comment>Param:</comment>
  <info>XMLWriter</info>    <strong>$writer</strong>     Только для процедурных вызовов.
                           Изменяемый экземпляр <class>XMLWriter</class>. Объект возвращается из вызова
                           <strong>xmlwriter_open_uri()</strong> или <strong>xmlwriter_open_memory()</strong>.
  <info>string|null</info>  <strong>$prefix</strong>     Префикс пространства имён. Если <strong>$prefix</strong> равен <info>null</info>, пространство имён
                           будет опущено.
  <info>string</info>       <strong>$name</strong>       Имя элемента.
  <info>string|null</info>  <strong>$namespace</strong>  URI пространства имён. Если <strong>$namespace</strong> равен <info>null</info>, объявление
                           пространства имён будет опущено.

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

<comment>See Also:</comment>
   * XMLWriter::endElement
   * XMLWriter::writeElementNs


id: XMLWriter::startPi
type: function
doc:
<comment>Description:</comment>
  Создать стартовый тег PI
  
  Объектно-ориентированный стиль
  
  Процедурный стиль
  
  Начинает тег инструкции обработки (PI).

<comment>Param:</comment>
  <info>XMLWriter</info>  <strong>$writer</strong>  Только для процедурных вызовов.
                      Изменяемый экземпляр <class>XMLWriter</class>. Объект возвращается из вызова
                      <strong>xmlwriter_open_uri()</strong> или <strong>xmlwriter_open_memory()</strong>.
  <info>string</info>     <strong>$target</strong>  Цель инструкции обработки.

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

<comment>See Also:</comment>
   * XMLWriter::endPi
   * XMLWriter::writePi


id: XMLWriter::text
type: function
doc:
<comment>Description:</comment>
  Записать текст
  
  Объектно-ориентированный стиль
  
  Процедурный стиль
  
  Записывает текст.

<comment>Param:</comment>
  <info>XMLWriter</info>  <strong>$writer</strong>   Только для процедурных вызовов.
                       Изменяемый экземпляр <class>XMLWriter</class>. Объект возвращается из вызова
                       <strong>xmlwriter_open_uri()</strong> или <strong>xmlwriter_open_memory()</strong>.
  <info>string</info>     <strong>$content</strong>  Содержимое текста. Символы <return>\<</return>, <return>&gt;</return>, <return>&</return> и <return>"</return> записываются как ссылки на сущности (т.е. , , и , соответственно). Все остальные символы в том числе <return>'</return> записываются буквально. Чтобы записывать специальные символы XML буквально или записывать буквальные ссылки на сущности, необходимо использовать <strong>xmlwriter_write_raw()</strong>.

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


id: XMLWriter::writeAttribute
type: function
doc:
<comment>Description:</comment>
  Записать полный атрибут
  
  Объектно-ориентированный стиль
  
  Процедурный стиль
  
  Записывает полный атрибут.

<comment>Param:</comment>
  <info>XMLWriter</info>  <strong>$writer</strong>  Только для процедурных вызовов.
                      Изменяемый экземпляр <class>XMLWriter</class>. Объект возвращается из вызова
                      <strong>xmlwriter_open_uri()</strong> или <strong>xmlwriter_open_memory()</strong>.
  <info>string</info>     <strong>$name</strong>    Имя атрибута.
  <info>string</info>     <strong>$value</strong>   Значение атрибута.

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

<comment>See Also:</comment>
   * XMLWriter::writeAttributeNs
   * XMLWriter::startAttribute
   * XMLWriter::startAttributeNs
   * XMLWriter::endAttribute


id: XMLWriter::writeAttributeNs
type: function
doc:
<comment>Description:</comment>
  Записать полный атрибут пространства имён
  
  Объектно-ориентированный стиль
  
  Процедурный стиль
  
  Записывает полный атрибут пространства имён.

<comment>Param:</comment>
  <info>XMLWriter</info>    <strong>$writer</strong>     Только для процедурных вызовов.
                           Изменяемый экземпляр <class>XMLWriter</class>. Объект возвращается из вызова
                           <strong>xmlwriter_open_uri()</strong> или <strong>xmlwriter_open_memory()</strong>.
  <info>string|null</info>  <strong>$prefix</strong>     Префикс пространства имён. Если <strong>$prefix</strong> равен <info>null</info>, пространство имён
                           будет опущено.
  <info>string</info>       <strong>$name</strong>       Имя атрибута.
  <info>string|null</info>  <strong>$namespace</strong>  URI пространства имён. Если <strong>$namespace</strong> равен <info>null</info>, объявление
                           пространства имён будет опущено.
  <info></info>             <strong>$content</strong>    Значение атрибута.

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

<comment>See Also:</comment>
   * XMLWriter::writeAttribute
   * XMLWriter::startAttribute
   * XMLWriter::startAttributeNs
   * XMLWriter::endAttribute


id: XMLWriter::writeCdata
type: function
doc:
<comment>Description:</comment>
  Записать полный тег CDATA
  
  Объектно-ориентированный стиль
  
  Процедурный стиль
  
  Записывает полный тег CDATA.

<comment>Param:</comment>
  <info>XMLWriter</info>  <strong>$writer</strong>   Только для процедурных вызовов.
                       Изменяемый экземпляр <class>XMLWriter</class>. Объект возвращается из вызова
                       <strong>xmlwriter_open_uri()</strong> или <strong>xmlwriter_open_memory()</strong>.
  <info>string</info>     <strong>$content</strong>  Содержимое CDATA.

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

<comment>See Also:</comment>
   * XMLWriter::startCdata
   * XMLWriter::endCdata


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

<comment>Param:</comment>
  <info>XMLWriter</info>  <strong>$writer</strong>   Только для процедурных вызовов.
                       Изменяемый экземпляр <class>XMLWriter</class>. Объект возвращается из вызова
                       <strong>xmlwriter_open_uri()</strong> или <strong>xmlwriter_open_memory()</strong>.
  <info>string</info>     <strong>$content</strong>  Содержимое комментария.

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

<comment>See Also:</comment>
   * XMLWriter::startComment
   * XMLWriter::endComment


id: XMLWriter::writeDtd
type: function
doc:
<comment>Description:</comment>
  Записать полный тег DTD
  
  Объектно-ориентированный стиль
  
  Процедурный стиль
  
  Записывает полный тег DTD.

<comment>Param:</comment>
  <info>XMLWriter</info>    <strong>$writer</strong>    Только для процедурных вызовов.
                          Изменяемый экземпляр <class>XMLWriter</class>. Объект возвращается из вызова
                          <strong>xmlwriter_open_uri()</strong> или <strong>xmlwriter_open_memory()</strong>.
  <info>string</info>       <strong>$name</strong>      Имя DTD.
  <info>string|null</info>  <strong>$publicId</strong>  Идентификатор внешнего публичного подмножества.
  <info>string|null</info>  <strong>$systemId</strong>  Идентификатор внешнего системного подмножества.
  <info>string|null</info>  <strong>$content</strong>   Содержимое DTD.

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

<comment>See Also:</comment>
   * XMLWriter::startDtd
   * XMLWriter::endDtd


id: XMLWriter::writeDtdAttlist
type: function
doc:
<comment>Description:</comment>
  Записать полный тег DTD AttList
  
  Объектно-ориентированный стиль
  
  Процедурный стиль
  
  Записывает список атрибутов DTD.

<comment>Param:</comment>
  <info>XMLWriter</info>  <strong>$writer</strong>   Только для процедурных вызовов.
                       Изменяемый экземпляр <class>XMLWriter</class>. Объект возвращается из вызова
                       <strong>xmlwriter_open_uri()</strong> или <strong>xmlwriter_open_memory()</strong>.
  <info>string</info>     <strong>$name</strong>     Имя списка атрибутов DTD.
  <info>string</info>     <strong>$content</strong>  Содержимое списка атрибутов DTD.

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

<comment>See Also:</comment>
   * XMLWriter::startDtdAttlist
   * XMLWriter::endDtdAttlist


id: XMLWriter::writeDtdElement
type: function
doc:
<comment>Description:</comment>
  Записать полный тег элемента DTD
  
  Объектно-ориентированный стиль
  
  Процедурный стиль
  
  Записывает полный тег элемента DTD.

<comment>Param:</comment>
  <info>XMLWriter</info>  <strong>$writer</strong>   Только для процедурных вызовов.
                       Изменяемый экземпляр <class>XMLWriter</class>. Объект возвращается из вызова
                       <strong>xmlwriter_open_uri()</strong> или <strong>xmlwriter_open_memory()</strong>.
  <info>string</info>     <strong>$name</strong>     Имя элемента DTD.
  <info>string</info>     <strong>$content</strong>  Содержимое элемента.

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

<comment>See Also:</comment>
   * XMLWriter::startDtdElement
   * XMLWriter::endDtdElement


id: XMLWriter::writeDtdEntity
type: function
doc:
<comment>Description:</comment>
  Записать полный тег DTD записи
  
  Объектно-ориентированный стиль
  
  Процедурный стиль
  
  Записывает полную DTD запись.

<comment>Param:</comment>
  <info>XMLWriter</info>  <strong>$writer</strong>   Только для процедурных вызовов.
                       Изменяемый экземпляр <class>XMLWriter</class>. Объект возвращается из вызова
                       <strong>xmlwriter_open_uri()</strong> или <strong>xmlwriter_open_memory()</strong>.
  <info>string</info>     <strong>$name</strong>     Имя записи.
  <info>string</info>     <strong>$content</strong>  Содержимое записи.

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

<comment>See Also:</comment>
   * XMLWriter::startDtdEntity
   * XMLWriter::endDtdEntity


id: XMLWriter::writeElement
type: function
doc:
<comment>Description:</comment>
  Записать полный тег элемента
  
  Объектно-ориентированный стиль
  
  Процедурный стиль
  
  Записывает полный тег элемента.

<comment>Param:</comment>
  <info>XMLWriter</info>    <strong>$writer</strong>   Только для процедурных вызовов.
                         Изменяемый экземпляр <class>XMLWriter</class>. Объект возвращается из вызова
                         <strong>xmlwriter_open_uri()</strong> или <strong>xmlwriter_open_memory()</strong>.
  <info>string</info>       <strong>$name</strong>     Имя элемента.
  <info>string|null</info>  <strong>$content</strong>  Содержимое элемента.

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

<comment>See Also:</comment>
   * XMLWriter::startElement
   * XMLWriter::endElement
   * XMLWriter::writeElementNs


id: XMLWriter::writeElementNs
type: function
doc:
<comment>Description:</comment>
  Записать полное пространство имён тега элемента
  
  Объектно-ориентированный стиль
  
  Процедурный стиль
  
  Записывает полное пространство имён тега элемента.

<comment>Param:</comment>
  <info>XMLWriter</info>    <strong>$writer</strong>     Только для процедурных вызовов.
                           Изменяемый экземпляр <class>XMLWriter</class>. Объект возвращается из вызова
                           <strong>xmlwriter_open_uri()</strong> или <strong>xmlwriter_open_memory()</strong>.
  <info>string|null</info>  <strong>$prefix</strong>     Префикс пространства имён. Если <strong>$prefix</strong> равен <info>null</info>, пространство имён
                           будет опущено.
  <info>string</info>       <strong>$name</strong>       Имя элемента.
  <info>string|null</info>  <strong>$namespace</strong>  URI пространства имён. Если <strong>$namespace</strong> равен <info>null</info>, объявление
                           пространства имён будет опущено.
  <info>string|null</info>  <strong>$content</strong>    Содержимое элемента.

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

<comment>See Also:</comment>
   * XMLWriter::startElementNs
   * XMLWriter::endElement
   * XMLWriter::writeElement


id: XMLWriter::writePi
type: function
doc:
<comment>Description:</comment>
  Записать инструкцию обработки (PI)
  
  Объектно-ориентированный стиль
  
  Процедурный стиль
  
  Записывает инструкцию обработки.

<comment>Param:</comment>
  <info>XMLWriter</info>  <strong>$writer</strong>   Только для процедурных вызовов.
                       Изменяемый экземпляр <class>XMLWriter</class>. Объект возвращается из вызова
                       <strong>xmlwriter_open_uri()</strong> или <strong>xmlwriter_open_memory()</strong>.
  <info>string</info>     <strong>$target</strong>   Цель инструкции обработки.
  <info>string</info>     <strong>$content</strong>  Содержимое инструкции обработки.

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

<comment>See Also:</comment>
   * XMLWriter::startPi
   * XMLWriter::endPi


id: XMLWriter::writeRaw
type: function
doc:
<comment>Description:</comment>
  Записать необработанный XML-текст
  
  Объектно-ориентированный стиль
  
  Процедурный стиль
  
  Записывает необработанный XML-текст.

<comment>Param:</comment>
  <info>XMLWriter</info>  <strong>$writer</strong>   Только для процедурных вызовов.
                       Изменяемый экземпляр <class>XMLWriter</class>. Объект возвращается из вызова
                       <strong>xmlwriter_open_uri()</strong> или <strong>xmlwriter_open_memory()</strong>.
  <info>string</info>     <strong>$content</strong>  Текстовая строка для записи.

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

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


id: XML_SAX_IMPL
type: constant
doc:
<comment>Description:</comment>
  Устанавливает стандарт обработки SAX. Может быть <return>libxml</return> или <return>expat</return>.


id: XSLTProcessor::__construct
type: function
doc:
<comment>Description:</comment>
  Создаёт новый экземпляр класса XSLTProcessor
  
  Создаёт новый экземпляр класса <class>XSLTProcessor</class>.


id: XSLTProcessor::getParameter
type: function
doc:
<comment>Description:</comment>
  Возвращает значение параметра
  
  Возвращает параметр, если он раньше установлен с помощью <strong>XSLTProcessor::setParameter()</strong>.

<comment>Param:</comment>
  <info>string</info>  <strong>$namespace</strong>  Пространство имён URI параметра XSLT.
  <info>string</info>  <strong>$name</strong>       Локальное имя параметра XSLT.

<comment>Return:</comment>
  <info>string|false</info>  Значение параметра (в виде строки), или <info>false</info>, если оно не установлено.

<comment>See Also:</comment>
   * <strong>XSLTProcessor::setParameter()</strong>
   * <strong>XSLTProcessor::removeParameter()</strong>


id: XSLTProcessor::getSecurityPrefs
type: function
doc:
<comment>Description:</comment>
  Получить настройки безопасности
  
  Получает настройки безопасности.

<comment>Return:</comment>
  <info>int</info>  Битовая маска, состоящая из <info>XSL_SECPREF_READ_FILE</info>, <info>XSL_SECPREF_WRITE_FILE</info>,
       <info>XSL_SECPREF_CREATE_DIRECTORY</info>, <info>XSL_SECPREF_READ_NETWORK</info>, <info>XSL_SECPREF_WRITE_NETWORK</info>.


id: XSLTProcessor::hasExsltSupport
type: function
doc:
<comment>Description:</comment>
  Определяет имеет ли PHP поддержку EXSLT
  
  Этот метод определяет был ли PHP сконфигурирован с библиотекой EXSLT.

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


id: XSLTProcessor::importStylesheet
type: function
doc:
<comment>Description:</comment>
  Импортирует таблицу стилей
  
  Этот метод импортирует таблицу стилей в <class>XSLTProcessor</class> для трансформации.

<comment>Param:</comment>
  <info>object</info>  <strong>$stylesheet</strong>  Импортируемая таблица стилей в виде объекта <class>DOMDocument</class> или <class>SimpleXMLElement</class>.

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


id: XSLTProcessor::registerPHPFunctions
type: function
doc:
<comment>Description:</comment>
  Включает способность функций PHP работать в качестве функций XSLT
  
  Этот метод делает PHP-функции доступными в качестве XSLT-функции в таблицах стилей XSL.

<comment>Param:</comment>
  <info>array|string|null</info>  <strong>$functions</strong>  Используйте этот параметр, чтобы разрешить вызов из XSLT только
                                 отдельных функций.
                                 
                                 Этот параметр может принимать либо строковое значение — название
                                 функции, либо массив — список названий.

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


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

<comment>Param:</comment>
  <info>string</info>  <strong>$namespace</strong>  Пространство имён URI параметра XSLT.
  <info>string</info>  <strong>$name</strong>       Локальное название XSLT параметра.

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

<comment>See Also:</comment>
   * <strong>XSLTProcessor::setParameter()</strong>
   * <strong>XSLTProcessor::getParameter()</strong>


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

<comment>Param:</comment>
  <info>string</info>  <strong>$namespace</strong>  Пространство имён URI параметра XSLT.
  <info>string</info>  <strong>$name</strong>       Локальное название параметра XSLT.
  <info>string</info>  <strong>$value</strong>      Новое значение параметра XSLT.
  <info>array</info>   <strong>$options</strong>    Массив пар <return>name =&gt; value</return>.

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

<comment>See Also:</comment>
   * <strong>XSLTProcessor::getParameter()</strong>
   * <strong>XSLTProcessor::removeParameter()</strong>


id: XSLTProcessor::setProfiling
type: function
doc:
<comment>Description:</comment>
  Устанавливает файл для профилирования
  
  Устанавливает файл для записи профилирующей информации во время обработки таблиц стилей.

<comment>Param:</comment>
  <info>string|null</info>  <strong>$filename</strong>  Путь к файлу, в который записывается профилирующая информация.

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


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

<comment>Param:</comment>
  <info>int</info>  <strong>$preferences</strong>  Новые настройки безопасности. Битовая маска из: <info>XSL_SECPREF_READ_FILE</info>,
                     <info>XSL_SECPREF_WRITE_FILE</info>, <info>XSL_SECPREF_CREATE_DIRECTORY</info>, <info>XSL_SECPREF_READ_NETWORK</info>,
                     <info>XSL_SECPREF_WRITE_NETWORK</info>. Или, альтернативно, можно передать <info>XSL_SECPREF_NONE</info>
                     или <info>XSL_SECPREF_DEFAULT</info>.

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


id: XSLTProcessor::transformToDoc
type: function
doc:
<comment>Description:</comment>
  Преобразует в документ
  
  Преобразует исходный узел в документ (например, <class>DOMDocument</class>), применяя таблицу стилей, заданную
  методом <strong>XSLTProcessor::importStylesheet()</strong>.

<comment>Param:</comment>
  <info>object</info>       <strong>$document</strong>     Объект класса <class>DOMDocument</class>, объект класса <class>SimpleXMLElement</class> или
                             libxml-совместимый объект, который будет преобразован.
  <info>string|null</info>  <strong>$returnClass</strong>  Через этот необязательный параметр можно установить класс объекта,
                             который вернёт XSLTProcessor::transformToDoc. Этот класс должен либо
                             расширять, либо быть объектом того же класса, который передан в
                             параметр <strong>$document</strong>.

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

<comment>See Also:</comment>
   * <strong>XSLTProcessor::transformToUri()</strong>
   * <strong>XSLTProcessor::transformToXml()</strong>


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

<comment>Param:</comment>
  <info>object</info>  <strong>$document</strong>  Преобразуемый объект <class>DOMDocument</class> или <class>SimpleXMLElement</class>.
  <info>string</info>  <strong>$uri</strong>       Целевой URI для преобразования.

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

<comment>See Also:</comment>
   * <strong>XSLTProcessor::transformToDoc()</strong>
   * <strong>XSLTProcessor::transformToXml()</strong>


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

<comment>Param:</comment>
  <info>object</info>  <strong>$document</strong>  Объект класса <class>DOMDocument</class> или <class>SimpleXMLElement</class> для преобразования.

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

<comment>See Also:</comment>
   * <strong>XSLTProcessor::transformToDoc()</strong>
   * <strong>XSLTProcessor::transformToUri()</strong>


id: XSL_SECPREF_DEFAULT
type: constant
doc:
<comment>Description:</comment>
  Запрещает все виды доступа на запись, т.е. битовая маска <info>XSL_SECPREF_WRITE_NETWORK</info> |
  <info>XSL_SECPREF_CREATE_DIRECTORY</info> | <info>XSL_SECPREF_WRITE_FILE</info>.


id: YAC_SERIALIZER_IGBINARY
type: constant
doc:
<comment>Description:</comment>
  Использовать igbinary в качестве сериализатора (требуется --enable-igbinary)


id: YAC_SERIALIZER_JSON
type: constant
doc:
<comment>Description:</comment>
  Использовать json в качестве сериализатора (требуется --enable-json)


id: YAC_SERIALIZER_MSGPACK
type: constant
doc:
<comment>Description:</comment>
  Использовать msgpack в качестве сериализатора (требуется --enable-msgpack)


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

<comment>Param:</comment>
  <info>string</info>  <strong>$prefix</strong>  Префикс (<info>string</info>)


id: Yac::__get
type: function
doc:
<comment>Description:</comment>
  Геттер
  
  Извлекает значения из кеша

<comment>Param:</comment>
  <info>string</info>  <strong>$key</strong>  Ключ (<info>string</info>)

<comment>Return:</comment>
  <info>mixed</info>  Смешанное значение в случае успешного выполнения, <info>null</info> в случае возникновения ошибки


id: Yac::__set
type: function
doc:
<comment>Description:</comment>
  Сеттер
  
  Сохраняет элемент в кеш

<comment>Param:</comment>
  <info>string</info>  <strong>$keys</strong>   Ключ (<info>string</info>)
  <info>mixed</info>   <strong>$value</strong>  Смешанное значение. Могут быть сохранены все типы значений php, кроме resource

<comment>Return:</comment>
  <info>mixed</info>  Всегда возвращает собственное значение


id: Yac::add
type: function
doc:
<comment>Description:</comment>
  Сохраняет в кеш
  
  Добавляет элемент в кеш.

<comment>Param:</comment>
  <info>string</info>  <strong>$keys</strong>   Ключ (<info>string</info>)
  <info>mixed</info>   <strong>$value</strong>  Смешанное значение. Могут быть сохранены все типы значений php, кроме resource
  <info>int</info>     <strong>$ttl</strong>    Время жизни

<comment>Return:</comment>
  <info>bool</info>  <info>bool</info>, <info>true</info> в случае успешного выполнения, <info>false</info> в случае возникновения ошибки Yac::add может
        завершиться с ошибкой, если не удалось получить блокировку cas, поэтому, если вам нужно,
        чтобы значение сохранялось должным образом, вы можете написать следующее: Убедитесь, что
        элемент хранитсяset("key", "vale));
        ]]> 
        
        Yac::add может завершиться с ошибкой, если не удалось получить блокировку cas, поэтому, если
        вам нужно, чтобы значение сохранялось должным образом, вы можете написать следующее:
        Убедитесь, что элемент хранитсяset("key", "vale));
        ]]>


