# php_manual

id: AF_INET6
type: constant
doc:
<comment>Description:</comment>
  Константа доступна, только если PHP скомпилирован с поддержкой IPv6.


id: APCUIterator
type: class
doc:
<comment>Description:</comment>
  Класс <class>APCUIterator</class> позволяет с лёгкостью итерировать большой APCu кеш. Это полезно, так как
  позволяет перебирать большой кеш по шагам, забирая заданное количество записей используя одну
  блокировку, позволяя другим активностям использовать блокировку, а не задерживать весь кеш для
  чтения ста (по умолчанию) записей. Также, использование регулярных выражений более эффективно, так
  как выполняется на уровне скомпилированного кода C.


id: APCUIterator::__construct
type: function
doc:
<comment>Description:</comment>
  Создаёт объект итератор класса APCUIterator
  
  Создаёт объект <class>APCUIterator</class>.

<comment>Param:</comment>
  <info>array|string|null</info>  <strong>$search</strong>      Либо регулярное выражение PCRE, которое соответствует именам
                                  ключей APCu, заданным как строки (<info>string</info>). Или массив (<info>array</info>)
                                  строк (<info>string</info>) с именами ключей APCu. Или, необязательно, <info>null</info>
                                  чтобы пропустить поиск.
  <info>int</info>                <strong>$format</strong>      Формат, заданный одной из констант APC_ITER_*.
  <info>int</info>                <strong>$chunk_size</strong>  Размер блока данных. Должно быть больше 0. По умолчанию 100.
  <info>int</info>                <strong>$list</strong>        Тип списка. Задаётся константами <info>APC_LIST_ACTIVE</info> или
                                  <info>APC_LIST_DELETED</info>.

<comment>See Also:</comment>
   * <strong>apcu_exists()</strong>
   * <strong>apcu_cache_info()</strong>


id: APCUIterator::current
type: function
doc:
<comment>Description:</comment>
  Получить текущий элемент
  
  Получает текущий элемент стека <class>APCUIterator</class>.

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

<comment>See Also:</comment>
   * APCUIterator::next
   * Iterator::current


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

<comment>Return:</comment>
  <info>int</info>  Общее количество записей.

<comment>See Also:</comment>
   * APCUIterator::getTotalHits
   * APCUIterator::getTotalSize
   * <strong>apcu_cache_info()</strong>


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

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

<comment>See Also:</comment>
   * APCUIterator::getTotalCount
   * APCUIterator::getTotalSize
   * <strong>apcu_cache_info()</strong>


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

<comment>Return:</comment>
  <info>int</info>  Общий размер кеша.

<comment>See Also:</comment>
   * APCUIterator::getTotalCount
   * APCUIterator::getTotalHits
   * <strong>apc_cache_info()</strong>


id: APCUIterator::key
type: function
doc:
<comment>Description:</comment>
  Получить ключ итератора
  
  Возвращает текущий ключ итератора.

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

<comment>See Also:</comment>
   * APCUIterator::current
   * Iterator::key


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

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

<comment>See Also:</comment>
   * APCUIterator::current
   * APCUIterator::rewind
   * Iterator::next


id: APCUIterator::rewind
type: function
doc:
<comment>Description:</comment>
  Перемотка итератора
  
  Устанавливает указатель итератора на первый элемент.

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

<comment>See Also:</comment>
   * APCUIterator::next
   * Iterator::next


id: APCUIterator::valid
type: function
doc:
<comment>Description:</comment>
  Проверяет, корректна ли текущая позиция итератора
  
  Проверяет, корректна ли текущая позиция итератора.

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

<comment>See Also:</comment>
   * APCUIterator::current
   * Iterator::valid


id: ARRAY_FILTER_USE_BOTH
type: constant
doc:
<comment>Description:</comment>
  <info>ARRAY_FILTER_USE_BOTH</info> используется в <strong>array_filter()</strong> для передачи и значения и ключа в заданную
  функцию.


id: ARRAY_FILTER_USE_KEY
type: constant
doc:
<comment>Description:</comment>
  <info>ARRAY_FILTER_USE_KEY</info> используется в <strong>array_filter()</strong> для передачи каждого ключа в виде первого
  аргумента в заданную функцию.


id: ASSERT_ACTIVE
type: constant
doc:
<comment>Description:</comment>
  assert.active
  
  Включение <strong>assert()</strong> проверок. Данная функциональность объявлена
  УСТАРЕВШЕЙ, начиная с PHP 8.3.0 и её крайне не рекомендуется использовать.


id: ASSERT_BAIL
type: constant
doc:
<comment>Description:</comment>
  assert.bail
  
  Прервать выполнение при провале проверки утверждения. Данная функциональность объявлена
  УСТАРЕВШЕЙ, начиная с PHP 8.3.0 и её крайне не рекомендуется использовать.


id: ASSERT_CALLBACK
type: constant
doc:
<comment>Description:</comment>
  assert.callback
  
  Обратный вызов при провале проверки утверждения. Данная функциональность объявлена
  УСТАРЕВШЕЙ, начиная с PHP 8.3.0 и её крайне не рекомендуется использовать.


id: ASSERT_EXCEPTION
type: constant
doc:
<comment>Description:</comment>
  assert.exception
  
  Выдаёт предупреждение PHP для каждого неудачного утверждения. Данная функциональность объявлена
  УСТАРЕВШЕЙ, начиная с PHP 8.3.0 и её крайне не рекомендуется использовать.


id: ASSERT_QUIET_EVAL
type: constant
doc:
<comment>Description:</comment>
  assert.quiet_eval
  
  Отключить <return>error_reporting</return> во время выполнения проверки утверждения. Данная функциональность была
  УДАЛЕНА, начиная с PHP 8.0.0.


id: ASSERT_WARNING
type: constant
doc:
<comment>Description:</comment>
  assert.warning
  
  Выдавать предупреждение PHP в случае провала проверки каждого утверждения Данная функциональность
  объявлена
  УСТАРЕВШЕЙ, начиная с PHP 8.3.0 и её крайне не рекомендуется использовать.


id: AddressInfo
type: class
doc:
<comment>Description:</comment>
  Полностью непрозрачный класс, заменяющий ресурсы <return>AddressInfo</return> в PHP 8.0.0.


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


id: AllowDynamicProperties::__construct
type: function
doc:
<comment>Description:</comment>
  Создаёт новый экземпляр атрибута AllowDynamicProperties
  
  Создаёт новый экземпляр <class>AllowDynamicProperties</class>.


id: AppendIterator
type: class
doc:
<comment>Description:</comment>
  Итератор, который выполняет несколько других итераторов один за другим


id: AppendIterator::__construct
type: function
doc:
<comment>Description:</comment>
  Создаёт AppendIterator
  
  Создаёт AppendIterator.

<comment>See Also:</comment>
   * AppendIterator::append


id: AppendIterator::append
type: function
doc:
<comment>Description:</comment>
  Добавляет итератор
  
  Добавляет итератор.

<comment>Param:</comment>
  <info>Iterator</info>  <strong>$iterator</strong>  Итератор для добавления.

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

<comment>See Also:</comment>
   * AppendIterator::__construct


id: AppendIterator::current
type: function
doc:
<comment>Description:</comment>
  Возвращает текущее значение
  
  Возвращает текущее значение.

<comment>Return:</comment>
  <info>mixed</info>  Текущее значение, если оно действительное, или <info>null</info> в противном случае.

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


id: AppendIterator::getArrayIterator
type: function
doc:
<comment>Description:</comment>
  Возвращает класс итератора массива ArrayIterator
  
  Этот метод получает класс <class>ArrayIterator</class>, который используется для хранения итераторов, добавленных
  с помощью метода AppendIterator::append.

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

<comment>See Also:</comment>
   * AppendIterator::getInnerIterator


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

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

<comment>See Also:</comment>
   * AppendIterator::getInnerIterator
   * AppendIterator::getArrayIterator


id: AppendIterator::key
type: function
doc:
<comment>Description:</comment>
  Возвращает текущий ключ
  
  Возвращает текущий ключ.

<comment>Return:</comment>
  <info>scalar</info>  Текущий ключ, если он является действительным, или <info>null</info> в противном случае.

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


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

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

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


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

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

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


id: AppendIterator::valid
type: function
doc:
<comment>Description:</comment>
  Проверяет срок действия текущего элемента
  
  Проверяет срок действия текущего элемента.

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

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


id: ArrayAccess::offsetExists
type: function
doc:
<comment>Description:</comment>
  Определяет, существует ли заданное смещение (ключ)
  
  Определяет, существует или нет данное смещение (ключ).
  
  Данный метод выполняется при использовании <strong>isset()</strong> или <strong>empty()</strong> на объектах, реализующих интерфейс
  <class>ArrayAccess</class>.
  
  При использовании функции <strong>empty()</strong>, вызывается метод <strong>ArrayAccess::offsetGet()</strong> и проверка на пустоту
  произойдёт, только если метод <strong>ArrayAccess::offsetExists()</strong> вернёт <info>true</info>.

<comment>Param:</comment>
  <info>mixed</info>  <strong>$offset</strong>  Смещение (ключ) для проверки.

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


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

<comment>Param:</comment>
  <info>mixed</info>  <strong>$offset</strong>  Смещение (ключ) для возврата.

<comment>Return:</comment>
  <info>mixed</info>  Может возвращать значение любого типа.

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


id: ArrayAccess::offsetSet
type: function
doc:
<comment>Description:</comment>
  Присваивает значение заданному смещению
  
  Присваивает значение указанному смещению (ключу).

<comment>Param:</comment>
  <info>mixed</info>  <strong>$offset</strong>  Смещение (ключ), которому будет присваиваться значение.
  <info>mixed</info>  <strong>$value</strong>   Значение для присвоения.

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


id: ArrayAccess::offsetUnset
type: function
doc:
<comment>Description:</comment>
  Удаляет смещение
  
  Удаляет смещение (ключ).
  
  Этот метод не будет вызван при приведении типа к (unset)

<comment>Param:</comment>
  <info>mixed</info>  <strong>$offset</strong>  Смещение (ключ) для удаления.

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


id: ArrayIterator
type: class
doc:
<comment>Description:</comment>
  Позволяет удалять элементы, изменять ключи или значения при итерации по массивам или объектам.
  
  Когда вы хотите перебрать один и тот же массив несколько раз, вам нужно создать экземпляр
  ArrayObject и создать для него объекты ArrayIterator, ссылающиеся на него либо при помощи foreach
  или при вызове метода getIterator() вручную.


id: ArrayIterator::STD_PROP_LIST
type: constant
doc:
<comment>Description:</comment>
  Свойства имеют обычную функциональность при доступе в виде списке (var_dump, foreach и т.д.).


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

<comment>Param:</comment>
  <info>array|object</info>  <strong>$array</strong>  Массив или объект, который может быть итерирован.
  <info>int</info>           <strong>$flags</strong>  Флаги для управления поведением объекта <class>ArrayIterator</class>. Смотрите
                        ArrayIterator::setFlags.

<comment>See Also:</comment>
   * ArrayIterator::getArrayCopy


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

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

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

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


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

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

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

<comment>See Also:</comment>
   * ArrayIterator::ksort
   * ArrayIterator::natcasesort
   * ArrayIterator::natsort
   * ArrayIterator::uasort
   * ArrayIterator::uksort
   * <strong>asort()</strong>


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

<comment>Return:</comment>
  <info>int</info>  Количество элементов или публичных свойств в ассоциативном массиве (<info>array</info>) или объекте
       (<info>object</info>) соответственно.

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


id: ArrayIterator::current
type: function
doc:
<comment>Description:</comment>
  Возвращает текущий элемент в массиве
  
  Возвращает текущий элемент в массиве (<info>array</info>).

<comment>Return:</comment>
  <info>mixed</info>  Возвращает текущий элемент в массиве (<info>array</info>).


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

<comment>Return:</comment>
  <info>array</info>  Копия массива (<info>array</info>) или массив публичных свойств, если ArrayIterator указывает на объект
         (<info>object</info>).

<comment>See Also:</comment>
   * ArrayIterator::valid


id: ArrayIterator::getFlags
type: function
doc:
<comment>Description:</comment>
  Получает флаги поведения
  
  Получает флаги поведения <class>ArrayIterator</class>. Смотрите метод ArrayIterator::setFlags для просмотра
  списка доступных флагов.

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

<comment>See Also:</comment>
   * ArrayIterator::setFlags
   * ArrayIterator::valid


id: ArrayIterator::key
type: function
doc:
<comment>Description:</comment>
  Возвращает ключ текущего элемента массива
  
  Эта функция возвращает ключ текущего элемента массива

<comment>Return:</comment>
  <info>string|int|null</info>  Ключ текущего элемента в массиве (<info>array</info>).


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

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

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

<comment>See Also:</comment>
   * ArrayIterator::asort
   * ArrayIterator::natcasesort
   * ArrayIterator::natsort
   * ArrayIterator::uasort
   * ArrayIterator::uksort
   * <strong>ksort()</strong>


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

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

<comment>See Also:</comment>
   * ArrayIterator::asort
   * ArrayIterator::ksort
   * ArrayIterator::natsort
   * ArrayIterator::uasort
   * ArrayIterator::uksort
   * <strong>natcasesort()</strong>


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

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

<comment>See Also:</comment>
   * ArrayIterator::asort
   * ArrayIterator::ksort
   * ArrayIterator::natsort
   * ArrayIterator::uasort
   * ArrayIterator::uksort
   * <strong>natsort()</strong>


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

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


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

<comment>Param:</comment>
  <info>mixed</info>  <strong>$key</strong>  Проверяемое смещение.

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

<comment>See Also:</comment>
   * ArrayIterator::valid


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

<comment>Param:</comment>
  <info>mixed</info>  <strong>$key</strong>  Смещение, из которого необходимо получить значения.

<comment>Return:</comment>
  <info>mixed</info>  Значение по смещению <strong>$key</strong>.

<comment>See Also:</comment>
   * ArrayIterator::offsetSet
   * ArrayIterator::offsetUnset


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

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

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

<comment>See Also:</comment>
   * ArrayIterator::offsetGet
   * ArrayIterator::offsetUnset


id: ArrayIterator::offsetUnset
type: function
doc:
<comment>Description:</comment>
  Сбрасывает значение по смещению
  
  Сбрасывает значение по смещению.
  
  Если итерация выполняется и ArrayIterator::offsetUnset используется для сброса текущего индекса
  итерации, позиция итерации будет смещена к следующему индексу. Поскольку позиция итерации также
  смещается в конце foreach в теле цикла, использование ArrayIterator::offsetUnset внутри цикла
  <return>foreach</return> может привести к пропуску индексов.

<comment>Param:</comment>
  <info>mixed</info>  <strong>$key</strong>  Смещение для сброса.

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

<comment>See Also:</comment>
   * ArrayIterator::offsetGet
   * ArrayIterator::offsetSet


id: ArrayIterator::rewind
type: function
doc:
<comment>Description:</comment>
  Перемещает указатель в начало массива
  
  Перемещает указатель на первый элемент в массиве

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


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

<comment>Param:</comment>
  <info>int</info>  <strong>$offset</strong>  Позиция, на которую нужно переместить указатель.

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


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

<comment>Return:</comment>
  <info>string</info>  Сериализованный <class>ArrayIterator</class>.

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


id: ArrayIterator::setFlags
type: function
doc:
<comment>Description:</comment>
  Устанавливает флаги, изменяющие поведение ArrayIterator
  
  Устанавливает флаги, управляющие поведением.

<comment>Param:</comment>
  <info>int</info>  <strong>$flags</strong>  Поведение нового ArrayIterator. Принимает либо битовую маску, либо именованные
               константы. Использование именованных констант настоятельно рекомендуется для
               обеспечения совместимости с будущими версиями.
               
               Доступные флаги поведения перечислены ниже. Фактический смысл этих флагов описан в
               предопределённых константах. Флаги поведения
               ArrayIteratorзначениеконстанта1ArrayIterator::STD_PROP_LIST2ArrayIterator::ARRAY_AS_PROPS

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

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


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

<comment>Param:</comment>
  <info>callable</info>  <strong>$callback</strong>  Функция сравнения должна возвращать целое, которое меньше, равно или больше
                       нуля, если первый аргумент является соответственно меньшим, равным или
                       большим, чем второй.
                       
                       Возвращение нецелых значений из функции сравнения, таких как число с
                       плавающей точкой (<info>float</info>), приведёт к внутреннему приведению возвращаемого
                       значения callback-функции к целому числу (<info>int</info>). Таким образом, значения <return>0.99</return>
                       и <return>0.1</return> будут приведены к целочисленному значению <return>0</return>, что позволит сравнить эти
                       значения как равные.

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

<comment>See Also:</comment>
   * ArrayIterator::asort
   * ArrayIterator::ksort
   * ArrayIterator::natcasesort
   * ArrayIterator::natsort
   * ArrayIterator::uksort
   * <strong>uasort()</strong>


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

<comment>Param:</comment>
  <info>callable</info>  <strong>$callback</strong>  Функция сравнения должна возвращать целое, которое меньше, равно или больше
                       нуля, если первый аргумент является соответственно меньшим, равным или
                       большим, чем второй.
                       
                       Возвращение нецелых значений из функции сравнения, таких как число с
                       плавающей точкой (<info>float</info>), приведёт к внутреннему приведению возвращаемого
                       значения callback-функции к целому числу (<info>int</info>). Таким образом, значения <return>0.99</return>
                       и <return>0.1</return> будут приведены к целочисленному значению <return>0</return>, что позволит сравнить эти
                       значения как равные.

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

<comment>See Also:</comment>
   * ArrayIterator::asort
   * ArrayIterator::ksort
   * ArrayIterator::natcasesort
   * ArrayIterator::natsort
   * ArrayIterator::uksort
   * <strong>uksort()</strong>


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

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

<comment>Return:</comment>
  <info>void</info>  <class>ArrayIterator</class>.

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


id: ArrayIterator::valid
type: function
doc:
<comment>Description:</comment>
  Проверяет, содержит ли массив ещё записи
  
  Проверяет, содержит ли массив <info>array</info> ещё записи.

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


id: ArrayObject::STD_PROP_LIST
type: constant
doc:
<comment>Description:</comment>
  Свойства объекта получают стандартное поведение при доступе в виде списка (var_dump, foreach и
  т.д.).


id: ArrayObject::__construct
type: function
doc:
<comment>Description:</comment>
  Создаёт новый объект массива
  
  Создаёт новый объект (<info>object</info>) массива.

<comment>Param:</comment>
  <info>array|object</info>  <strong>$array</strong>          Параметр <strong>$array</strong> принимает значение типа <info>array</info> или <info>Object</info>.
  <info>int</info>           <strong>$flags</strong>          Флаги для управления поведением объекта <class>ArrayObject</class>. Смотрите
                                ArrayObject::setFlags.
  <info>string</info>        <strong>$iteratorClass</strong>  Указывает класс, который будет использоваться в качестве итератора
                                объекта <class>ArrayObject</class>. Класс должен реализовать интерфейс
                                ArrayIterator.

<comment>See Also:</comment>
   * ArrayObject::setflags


id: ArrayObject::append
type: function
doc:
<comment>Description:</comment>
  Добавляет значение в конец массива
  
  Добавляет новое значение в конец массива.
  
  Этот метод не может быть вызван, если <class>ArrayObject</class> был создан из объекта. В этом случае используйте
  вместо него ArrayObject::offsetSet.

<comment>Param:</comment>
  <info>mixed</info>  <strong>$value</strong>  Значение, которое должно быть добавлено.

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

<comment>See Also:</comment>
   * ArrayObject::offsetSet


id: ArrayObject::asort
type: function
doc:
<comment>Description:</comment>
  Сортировать записи по значению
  
  Сортирует элементы массива в порядке возрастания, так что его ключи сохраняют свою корреляцию со
  значениями, с которыми они связаны.
  
  Используется в основном при сортировке ассоциативных массивов, где важен фактический порядок
  элементов.
  
  Если оба сравниваемых значения эквивалентны, они сохраняют свой первоначальный порядок.
  До PHP 8.0.0 их относительный порядок в отсортированном массиве не был определён.

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

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

<comment>See Also:</comment>
   * ArrayObject::ksort
   * ArrayObject::natsort
   * ArrayObject::natcasesort
   * ArrayObject::uasort
   * ArrayObject::uksort
   * <strong>asort()</strong>


id: ArrayObject::count
type: function
doc:
<comment>Description:</comment>
  Получить количество общедоступных свойств ArrayObject
  
  Получить количество общедоступных свойств <class>ArrayObject</class>.

<comment>Return:</comment>
  <info>int</info>  Количество общедоступных свойств <class>ArrayObject</class>.
       
       Если <class>ArrayObject</class> создаётся из массива, то все свойства являются общедоступными.


id: ArrayObject::exchangeArray
type: function
doc:
<comment>Description:</comment>
  Заменить массив на другой
  
  Заменяет текущий массив (<info>array</info>) на другой массив (<info>array</info>) или объект (<info>object</info>).

<comment>Param:</comment>
  <info>array|object</info>  <strong>$array</strong>  Новый массив (<info>array</info>) или объект (<info>object</info>) для замены текущего массива.

<comment>Return:</comment>
  <info>array</info>  Возвращает старый массив (<info>array</info>).


id: ArrayObject::getArrayCopy
type: function
doc:
<comment>Description:</comment>
  Создаёт копию ArrayObject
  
  Экспортирует <class>ArrayObject</class> в массив.

<comment>Return:</comment>
  <info>array</info>  Возвращает копию массива. Если <class>ArrayObject</class> ссылается на объект, то будет возвращён массив
         свойств данного объекта.


id: ArrayObject::getFlags
type: function
doc:
<comment>Description:</comment>
  Получает флаги поведения
  
  Получает флаги поведения <class>ArrayObject</class>. Смотрите метод ArrayObject::setFlags для просмотра списка
  возможных флагов.

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

<comment>See Also:</comment>
   * Метод ArrayObject::setFlags


id: ArrayObject::getIterator
type: function
doc:
<comment>Description:</comment>
  Создать новый итератор из экземпляра ArrayObject
  
  Создать новый итератор из экземпляра <class>ArrayObject</class>.

<comment>Return:</comment>
  <info>Iterator</info>  Итератор из <class>ArrayObject</class>.


id: ArrayObject::getIteratorClass
type: function
doc:
<comment>Description:</comment>
  Получает имя класса итератора для ArrayObject
  
  Получает имя класса итератора массива, который используется ArrayObject::getIterator().

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

<comment>See Also:</comment>
   * ArrayObject::setIteratorClass


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

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

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

<comment>See Also:</comment>
   * ArrayObject::asort
   * ArrayObject::natsort
   * ArrayObject::natcasesort
   * ArrayObject::uasort
   * ArrayObject::uksort
   * <strong>ksort()</strong>


id: ArrayObject::natcasesort
type: function
doc:
<comment>Description:</comment>
  Сортировать массив, используя регистронезависимый алгоритм "natural order"
  
  Этот метод является регистронезависимой версией ArrayObject::natsort.
  
  Этот метод реализует алгоритм сортировки, при котором порядок буквенно-цифровых строк будет
  привычным для человека, сохраняя при этом связь ключ/значение. Такой алгоритм называется
  "естественный порядок" (natural ordering).
  
  Если оба сравниваемых значения эквивалентны, они сохраняют свой первоначальный порядок.
  До PHP 8.0.0 их относительный порядок в отсортированном массиве не был определён.

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

<comment>See Also:</comment>
   * ArrayObject::asort
   * ArrayObject::ksort
   * ArrayObject::natsort
   * ArrayObject::uasort
   * ArrayObject::uksort
   * <strong>natcasesort()</strong>


id: ArrayObject::natsort
type: function
doc:
<comment>Description:</comment>
  Сортировать массив, используя алгоритм "natural order"
  
  Этот метод реализует алгоритм сортировки, при котором порядок буквенно-цифровых строк будет
  привычным для человека, сохраняя при этом связь ключ/значение. Такой алгоритм называется
  "естественный порядок" (natural ordering). Пример разницы между этим алгоритмом и обычными
  алгоритмами сортировки, (используются в ArrayObject::asort) можно увидеть в примере ниже.
  
  Если оба сравниваемых значения эквивалентны, они сохраняют свой первоначальный порядок.
  До PHP 8.0.0 их относительный порядок в отсортированном массиве не был определён.

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

<comment>See Also:</comment>
   * ArrayObject::asort
   * ArrayObject::ksort
   * ArrayObject::natcasesort
   * ArrayObject::uasort
   * ArrayObject::uksort
   * <strong>natsort()</strong>


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

<comment>Param:</comment>
  <info>mixed</info>  <strong>$key</strong>  Индекс, который должен быть проверен.

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


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

<comment>Param:</comment>
  <info>mixed</info>  <strong>$key</strong>  Индекс, ссылающийся на значение.

<comment>Return:</comment>
  <info>mixed</info>  Значение по указанному индексу или <info>null</info>.


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

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

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

<comment>See Also:</comment>
   * ArrayObject::append


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

<comment>Param:</comment>
  <info>mixed</info>  <strong>$key</strong>  Индекс, значение которого необходимо удалить.

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


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

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

<comment>See Also:</comment>
   * ArrayObject::unserialize
   * <strong>serialize()</strong>
   * Сериализация объектов


id: ArrayObject::setFlags
type: function
doc:
<comment>Description:</comment>
  Устанавливает флаги поведения
  
  Устанавливает флаги, которые влияют на поведение ArrayObject.

<comment>Param:</comment>
  <info>int</info>  <strong>$flags</strong>  Новое поведение ArrayObject. Допускается либо битовая маска, либо именованные
               константы. Использование именованных констант настоятельно рекомендуется для
               обеспечения совместимости с будущими версиями.
               
               Доступные флаги поведения перечислены ниже. Фактические значения этих флагов описаны
               в разделе предопределённые константы. Флаги поведения
               ArrayObjectЗначениеКонстанта1ArrayObject::STD_PROP_LIST2ArrayObject::ARRAY_AS_PROPS

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


id: ArrayObject::setIteratorClass
type: function
doc:
<comment>Description:</comment>
  Устанавливает имя класса итератора для ArrayObject
  
  Устанавливает имя класса итератора массива, которое используется ArrayObject::getIterator().

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

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


id: ArrayObject::uasort
type: function
doc:
<comment>Description:</comment>
  Сортировать записи, используя пользовательскую функцию для сравнения элементов и сохраняя при этом
  связь ключ/значение
  
  Эта функция сортирует значения с сохранением ключей, используя пользовательскую функцию сравнения.
  
  Функция используется в основном при сортировке ассоциативных массивов, в которых важен актуальный
  порядок элементов.
  
  Если оба сравниваемых значения эквивалентны, они сохраняют свой первоначальный порядок.
  До PHP 8.0.0 их относительный порядок в отсортированном массиве не был определён.

<comment>Param:</comment>
  <info>callable</info>  <strong>$callback</strong>  Функция сравнения должна возвращать целое, которое меньше, равно или больше
                       нуля, если первый аргумент является соответственно меньшим, равным или
                       большим, чем второй.
                       
                       Возвращение нецелых значений из функции сравнения, таких как число с
                       плавающей точкой (<info>float</info>), приведёт к внутреннему приведению возвращаемого
                       значения callback-функции к целому числу (<info>int</info>). Таким образом, значения <return>0.99</return>
                       и <return>0.1</return> будут приведены к целочисленному значению <return>0</return>, что позволит сравнить эти
                       значения как равные.

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

<comment>See Also:</comment>
   * ArrayObject::asort
   * ArrayObject::ksort
   * ArrayObject::natsort
   * ArrayObject::natcasesort
   * ArrayObject::uksort
   * <strong>uasort()</strong>


id: ArrayObject::uksort
type: function
doc:
<comment>Description:</comment>
  Сортировать массив по ключам, используя пользовательскую функцию для сравнения
  
  Эта функция сортирует ключи записей, используя предоставленную пользователем функцию. Отношения
  между ключами и элементами сохраняются.
  
  Если оба сравниваемых значения эквивалентны, они сохраняют свой первоначальный порядок.
  До PHP 8.0.0 их относительный порядок в отсортированном массиве не был определён.

<comment>Param:</comment>
  <info>callable</info>  <strong>$callback</strong>  Функция сравнения должна возвращать целое, которое меньше, равно или больше
                       нуля, если первый аргумент является соответственно меньшим, равным или
                       большим, чем второй.
                       
                       Возвращение нецелых значений из функции сравнения, таких как число с
                       плавающей точкой (<info>float</info>), приведёт к внутреннему приведению возвращаемого
                       значения callback-функции к целому числу (<info>int</info>). Таким образом, значения <return>0.99</return>
                       и <return>0.1</return> будут приведены к целочисленному значению <return>0</return>, что позволит сравнить эти
                       значения как равные.

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

<comment>See Also:</comment>
   * ArrayObject::asort
   * ArrayObject::ksort
   * ArrayObject::natsort
   * ArrayObject::natcasesort
   * ArrayObject::uasort
   * <strong>uksort()</strong>


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

<comment>Param:</comment>
  <info>string</info>  <strong>$data</strong>  Сериализованный объект <class>ArrayObject</class>.

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

<comment>See Also:</comment>
   * ArrayIterator::serialize
   * <strong>unserialize()</strong>
   * Сериализация объектов


id: Attribute
type: class
doc:
<comment>Description:</comment>
  Атрибуты дают возможность добавлять структурированную, машиночитаемую информацию метаданных о
  декларациях в коде: целью атрибута могут быть классы, методы, функции, параметры, свойства и
  константы класса. Метаданные, определённые атрибутами, могут быть проверены во время выполнения с
  помощью Reflection API. Поэтому атрибуты можно рассматривать как язык конфигурации, встроенный
  непосредственно в код.


id: Attribute::__construct
type: function
doc:
<comment>Description:</comment>
  Создаёт новый экземпляр Attribute
  
  Создаёт новый экземпляр <class>Attribute</class>.

<comment>Param:</comment>
  <info>int</info>  <strong>$flags</strong>  


id: BackedEnum
type: class
doc:
<comment>Description:</comment>
  Интерфейс <class>BackedEnum</class> автоматически применяется движком к типизированным перечислениям. Он не может
  быть реализован пользовательскими классами. Перечисления не могут переопределять его методы,
  поскольку реализации по умолчанию предоставляются движком. Доступен только для проверки типа.


id: BackedEnum::from
type: function
doc:
<comment>Description:</comment>
  Сопоставляет скаляр с экземпляром перечисления
  
  Метод from переводит строку (<info>string</info>) или число (<info>int</info>) в соответствующее значение перечисления, если
  такое имеется. Если соответствующее значение не определено, выбрасывается <class>ValueError</class>.

<comment>Param:</comment>
  <info>int|string</info>  <strong>$value</strong>  Скалярное значение для сопоставления с перечислением.

<comment>Return:</comment>
  <info>static</info>  Случайный экземпляр этого перечисления.

<comment>See Also:</comment>
   * UnitEnum::cases
   * BackedEnum::tryFrom


id: BackedEnum::tryFrom
type: function
doc:
<comment>Description:</comment>
  Сопоставляет скаляр с экземпляром перечисления или null
  
  Метод tryFrom переводит строку (<info>string</info>) или число (<info>int</info>) в соответствующее значение перечисления,
  если такое имеется. Если соответствующее значение не определено, возвращается null.

<comment>Param:</comment>
  <info>int|string</info>  <strong>$value</strong>  Скалярное значение для сопоставления с перечислением.

<comment>Return:</comment>
  <info>static|null</info>  Экземпляр перечисления или <info>null</info>, если экземпляр не найден.

<comment>See Also:</comment>
   * UnitEnum::cases
   * BackedEnum::from


id: BaseResult::getWarnings
type: function
doc:
<comment>Description:</comment>
  Получает предупреждения последней операции
  
  Получает предупреждения, сгенерированные последней операцией сервера MySQL.

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


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

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


id: CAL_DOW_DAYNO
type: constant
doc:
<comment>Description:</comment>
  Для <strong>jddayofweek()</strong>: день недели в виде целого числа (<info>int</info>), где <return>0</return> означает воскресенье, а <return>6</return> означает
  субботу.


id: CAL_DOW_LONG
type: constant
doc:
<comment>Description:</comment>
  Для <strong>jddayofweek()</strong>: английское название дня недели.


id: CAL_DOW_SHORT
type: constant
doc:
<comment>Description:</comment>
  Для <strong>jddayofweek()</strong>: сокращённое английское название дня недели.


id: CAL_EASTER_ALWAYS_GREGORIAN
type: constant
doc:
<comment>Description:</comment>
  Для <strong>easter_days()</strong>: вычислять Пасху в соответствии с пролептическим григорианским календарём.


id: CAL_EASTER_ALWAYS_JULIAN
type: constant
doc:
<comment>Description:</comment>
  Для <strong>easter_days()</strong>: вычислять Пасху в соответствии с юлианским календарём.


id: CAL_EASTER_DEFAULT
type: constant
doc:
<comment>Description:</comment>
  Для <strong>easter_days()</strong>: вычислять Пасху для лет до 1753 года по юлианскому календарю, а в последующие
  годы по григорианскому календарю.


id: CAL_EASTER_ROMAN
type: constant
doc:
<comment>Description:</comment>
  Для <strong>easter_days()</strong>: вычислять Пасху для лет до 1583 года по юлианскому календарю, а в последующие
  годы по григорианскому календарю.


id: CAL_FRENCH
type: constant
doc:
<comment>Description:</comment>
  Для <strong>cal_days_in_month()</strong>, <strong>cal_from_jd()</strong>, <strong>cal_info()</strong> и <strong>cal_to_jd()</strong>: использовать французский
  республиканский календарь.


id: CAL_GREGORIAN
type: constant
doc:
<comment>Description:</comment>
  Для <strong>cal_days_in_month()</strong>, <strong>cal_from_jd()</strong>, <strong>cal_info()</strong> и <strong>cal_to_jd()</strong>: использовать пролептический
  григорианский календарь.


id: CAL_JEWISH
type: constant
doc:
<comment>Description:</comment>
  Для <strong>cal_days_in_month()</strong>, <strong>cal_from_jd()</strong>, <strong>cal_info()</strong> и <strong>cal_to_jd()</strong>: использовать еврейский
  календарь.


id: CAL_JEWISH_ADD_ALAFIM
type: constant
doc:
<comment>Description:</comment>
  Для <strong>jdtojewish()</strong>: добавляет слово alafim в качестве разделителя тысяч для количества лет.


id: CAL_JEWISH_ADD_ALAFIM_GERESH
type: constant
doc:
<comment>Description:</comment>
  Для <strong>jdtojewish()</strong>: добавляет знак гореш (geresh), напоминающий одинарную кавычку в качестве
  разделителя тысяч для количества лет.


id: CAL_JEWISH_ADD_GERESHAYIM
type: constant
doc:
<comment>Description:</comment>
  For <strong>jdtojewish()</strong>: добавить символ гершаим (gershayim), напоминающий двойную кавычку перед
  последней буквой дня и числом лет


id: CAL_JULIAN
type: constant
doc:
<comment>Description:</comment>
  Для <strong>cal_days_in_month()</strong>, <strong>cal_from_jd()</strong>, <strong>cal_info()</strong> и <strong>cal_to_jd()</strong>: использовать юлианский
  календарь.


id: CAL_MONTH_FRENCH
type: constant
doc:
<comment>Description:</comment>
  Для <strong>jdmonthname()</strong>: французское республиканское название месяца.


id: CAL_MONTH_GREGORIAN_LONG
type: constant
doc:
<comment>Description:</comment>
  Для <strong>jdmonthname()</strong>: григорианское название месяца.


id: CAL_MONTH_GREGORIAN_SHORT
type: constant
doc:
<comment>Description:</comment>
  Для <strong>jdmonthname()</strong>: сокращённое григорианское название месяца.


id: CAL_MONTH_JULIAN_SHORT
type: constant
doc:
<comment>Description:</comment>
  Для <strong>jdmonthname()</strong>: сокращённое юлианское название месяца.


id: CASE_LOWER
type: constant
doc:
<comment>Description:</comment>
  <info>CASE_LOWER</info> используется с <strong>array_change_key_case()</strong> для конвертации ключей массива в нижний регистр.
  Это действие по умолчанию для <strong>array_change_key_case()</strong>. Начиная с PHP 8.2.0, конвертируются только
  символы ASCII.


id: CASE_UPPER
type: constant
doc:
<comment>Description:</comment>
  <info>CASE_UPPER</info> используется c <strong>array_change_key_case()</strong> для конвертации ключей массива в верхний
  регистр. Начиная с PHP 8.2.0, конвертируются только символы ASCII.


id: CLSCTX_ALL
type: constant
doc:
<comment>Description:</comment>
  Обозначает весь контекст класса. Задаётся побитовым ИЛИ констант <info>CLSCTX_INPROC_HANDLER</info> и
  <info>CLSCTX_SERVER</info>.


id: CLSCTX_INPROC_HANDLER
type: constant
doc:
<comment>Description:</comment>
  Код, создающий и управляющий объектами этого класса является обработчиком внутри процесса. Это DLL
  , запускаемый в процессе клиента и реализующий структуру этого класса на стороне клиента, когда
  экземпляр класса используется удалённо.


id: CLSCTX_INPROC_SERVER
type: constant
doc:
<comment>Description:</comment>
  Код, создающий и управляющий объектами этого класса является DLL запущенным в том же процессе,
  который вызывает функцию указанную в контексте класса.


id: CLSCTX_LOCAL_SERVER
type: constant
doc:
<comment>Description:</comment>
  Код EXE, который создаёт и управляет объектами этого класса, работает на той же машине, но в
  рамках отдельного процесса.


id: CLSCTX_REMOTE_SERVER
type: constant
doc:
<comment>Description:</comment>
  Внешний контекст. Код, создающий и управляющий объектами этого класса работает на другом
  компьютере.


id: CLSCTX_SERVER
type: constant
doc:
<comment>Description:</comment>
  Означает серверный код, локальный, удалённый или же внутри процесса. Задаётся побитовым ИЛИ
  констант <info>CLSCTX_INPROC_SERVER</info>, <info>CLSCTX_LOCAL_SERVER</info> и <info>CLSCTX_REMOTE_SERVER</info>.


id: CL_EXPUNGE
type: constant
doc:
<comment>Description:</comment>
  Не выдавая никаких предупреждений стирать сообщения прежде чем закрыть при вызове <strong>imap_close()</strong>


id: COMPersistHelper
type: class
doc:
<comment>Description:</comment>
  <class>COMPersistHelper</class> улучшает совместимость COM и PHP в отношении php.ini директивы open_basedir и
  потоковых ресурсов.


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

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


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

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


id: COMPersistHelper::InitNew
type: function
doc:
<comment>Description:</comment>
  Инициализирует объект в состояние по умолчанию
  
  Инициализирует объект в состояние по умолчанию.

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


id: COMPersistHelper::LoadFromFile
type: function
doc:
<comment>Description:</comment>
  Загрузить объект из файла
  
  Открывает указанный файл и инициализирует объект из его содержимого.

<comment>Param:</comment>
  <info>string</info>  <strong>$filename</strong>  Имя файла.
  <info>int</info>     <strong>$flags</strong>     Режим доступа для доступа к файлу. Допустимые значения указаны в перечислении
                     STGM. Этот режим считается желаемым, но может быть, по необходимости, изменён
                     на более строгий Если параметр <strong>$flags</strong> задан как <return>0</return>, то файл будет открыт с
                     разрешениями по умолчанию, какие использовались бы, если бы пользователь
                     открывал этот файл.

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


id: COMPersistHelper::LoadFromStream
type: function
doc:
<comment>Description:</comment>
  Загружает объект из потока
  
  Загружает объект из потока, где он изначально был сохранён.

<comment>Param:</comment>
  <info>resource</info>  <strong>$stream</strong>  Потоковый ресурс для загрузки объекта.

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


id: COMPersistHelper::SaveToFile
type: function
doc:
<comment>Description:</comment>
  Сохранить объект в файл
  
  Сохраняет копию объекта в указанный файл.

<comment>Param:</comment>
  <info>string|null</info>  <strong>$filename</strong>  Имя файла.
  <info>bool</info>         <strong>$remember</strong>  Определяет, будет ли <strong>$filename</strong> использоваться для текущего рабочего файла.
                          Если <info>true</info>, то <strong>$filename</strong> становится текущим файлом, и объект должен
                          очистить свой флаг dirty после сохранения. Если <info>false</info>, то эта операция
                          записи будет считаться как "Save A Copy As ...". В этом случае текущий
                          файл останется без изменений и объект не будет снимать флаг dirty.

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


id: COMPersistHelper::SaveToStream
type: function
doc:
<comment>Description:</comment>
  Сохраняет объект в потоке
  
  Сохраняет объект в заданном потоке.

<comment>Param:</comment>
  <info>resource</info>  <strong>$stream</strong>  Потоковый ресурс.

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


id: COMPersistHelper::__construct
type: function
doc:
<comment>Description:</comment>
  Конструктор класса COMPersistHelper
  
  Создаёт объект класса COMPersistHelper, обычно связанный с <strong>$variant</strong>.

<comment>Param:</comment>
  <info>variant|null</info>  <strong>$variant</strong>  Объект COM, реализующий интерфейс IDispatch. Для успешного вызова методов
                          <class>COMPersistHelper</class>, объект должен реализовывать интерфейсы IPersistFile,
                          IPersistStream и/или IPersistStreamInit.
                          
                          Передача <info>null</info> в качестве <strong>$variant</strong> оправдана только в том случае, если
                          объект будет загружен из потока с помощью
                          COMPersistHelper::LoadFromStream.


id: CP_MOVE
type: constant
doc:
<comment>Description:</comment>
  Удалить сообщения из текущего почтового ящика после копирования с помощью <strong>imap_mail_copy()</strong>


id: CREDITS_ALL
type: constant
doc:
<comment>Description:</comment>
  -1
  
  Все разработчики, аналогично использованию: <return>CREDITS_DOCS + CREDITS_GENERAL + CREDITS_GROUP +
  CREDITS_MODULES + CREDITS_QA CREDITS_FULLPAGE</return>. Будет сгенерирована HTML-страница с
  соответствующими тегами. Это значение по умолчанию.


id: CREDITS_FULLPAGE
type: constant
doc:
<comment>Description:</comment>
  Обычно используется в сочетании с другими флагами. Означает, что HTML- страница должна печататься
  вместе с дополнительной информацией (за которую отвечают другие флаги).


id: CREDITS_GENERAL
type: constant
doc:
<comment>Description:</comment>
  Главные разработчики: Дизайн и концепции языка, авторы PHP и модуля SAPI.


id: CRYPT_BLOWFISH
type: constant
doc:
<comment>Description:</comment>
  Указывает, поддерживаются ли хеши Blowfish в функции <strong>crypt()</strong>. Всегда <return>1</return>.


id: CRYPT_EXT_DES
type: constant
doc:
<comment>Description:</comment>
  Указывает, поддерживаются ли расширенные хеши на основе DES в функции <strong>crypt()</strong>. Всегда <return>1</return>.


id: CRYPT_MD5
type: constant
doc:
<comment>Description:</comment>
  Указывает, поддерживаются ли хеши MD5 в функции <strong>crypt()</strong>. Всегда <return>1</return>.


id: CRYPT_SHA256
type: constant
doc:
<comment>Description:</comment>
  Указывает, поддерживаются ли хеши SHA-256 в функции <strong>crypt()</strong>. Всегда <return>1</return>.


id: CRYPT_SHA512
type: constant
doc:
<comment>Description:</comment>
  Указывает, поддерживаются ли хеши SHA-512 в функции <strong>crypt()</strong>. Всегда <return>1</return>.


id: CRYPT_STD_DES
type: constant
doc:
<comment>Description:</comment>
  Указывает, поддерживаются ли стандартные хеши на основе DES в функции <strong>crypt()</strong>. Всегда <return>1</return>.


id: CURLFile
type: class
doc:
<comment>Description:</comment>
  Этот класс или <class>CURLStringFile</class> могут быть использованы для загрузки файла с помощью опции
  <info>CURLOPT_POSTFIELDS</info>.
  
  Десериализация экземпляров <class>CURLFile</class> не допускается. Начиная с PHP 7.4.0, сериализация запрещена в
  первую очередь.


id: CURLFile::__construct
type: function
doc:
<comment>Description:</comment>
  Создаёт объект CURLFile
  
  Объектно-ориентированный стиль
  
  Процедурный стиль
  
  Создаёт объект <class>CURLFile</class>, используемый для загрузки файла с использованием опции
  <info>CURLOPT_POSTFIELDS</info>.

<comment>Param:</comment>
  <info>string</info>       <strong>$filename</strong>         Путь к файлу, который будет загружен
  <info>string|null</info>  <strong>$mime_type</strong>        Mime-тип файла.
  <info>string|null</info>  <strong>$posted_filename</strong>  Имя файла при отправке методом POST.

<comment>Return:</comment>
  <info>CURLFile</info>  Возвращает объект типа <class>CURLFile</class>.

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


id: CURLFile::getFilename
type: function
doc:
<comment>Description:</comment>
  Возвращает имя файла на сервере

<comment>Return:</comment>
  <info>string</info>  Возвращает имя файла.


id: CURLFile::getMimeType
type: function
doc:
<comment>Description:</comment>
  Возвращает MIME-тип файла

<comment>Return:</comment>
  <info>string</info>  Возвращает MIME-тип файла.


id: CURLFile::getPostFilename
type: function
doc:
<comment>Description:</comment>
  Возвращает имя файла, отправляемого POST-запросом

<comment>Return:</comment>
  <info>string</info>  Возвращает имя файла, отправляемого POST-запросом.


id: CURLFile::setMimeType
type: function
doc:
<comment>Description:</comment>
  Устанавливает MIME-тип

<comment>Param:</comment>
  <info>string</info>  <strong>$mime_type</strong>  MIME-тип для отправки.

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


id: CURLFile::setPostFilename
type: function
doc:
<comment>Description:</comment>
  Устанавливает имя файла для отправки методом POST

<comment>Param:</comment>
  <info>string</info>  <strong>$posted_filename</strong>  Имя файла для отправки методом POST

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


id: CURLINFO_HTTP_CODE
type: constant
doc:
<comment>Description:</comment>
  С cURL 7.10.8 это устаревший псевдоним опции <info>CURLINFO_RESPONSE_CODE</info>


id: CURLOPT_DOH_SSL_VERIFYHOST
type: constant
doc:
<comment>Description:</comment>
  Сопоставляет имена полей SSL-сертификата сервера DNS поверх HTTPS с именем хоста. Доступно начиная
  с PHP 8.2.0 и cURL 7.76.0.


id: CURLOPT_DOH_SSL_VERIFYPEER
type: constant
doc:
<comment>Description:</comment>
  Проверяет подлинность SSL-сертификата сервера DNS поверх HTTPS. Доступно начиная с PHP 8.2.0 и
  cURL 7.76.0.


id: CURLOPT_DOH_SSL_VERIFYSTATUS
type: constant
doc:
<comment>Description:</comment>
  Сообщает cURL, чтобы он проверил статус сертификата сервера DNS поверх HTTPS используя модуль TLS
  "Certificate Status Request" (OCSP-сшивание). Доступно начиная с PHP 8.2.0 и cURL 7.76.0.


id: CURLOPT_DOH_URL
type: constant
doc:
<comment>Description:</comment>
  Указывает URL-адрес сервера DNS поверх HTTPS. Доступно начиная с PHP 8.1.0 и cURL 7.62.0.


id: CURLOPT_HTTP09_ALLOWED
type: constant
doc:
<comment>Description:</comment>
  Доступно с версии PHP 7.3.15 и 7.4.3, соответственно, и cURL 7.64.0.


id: CURLOPT_ISSUERCERT_BLOB
type: constant
doc:
<comment>Description:</comment>
  Сертификат SSL эмитента из большого двоичного объекта памяти. Доступно начиная с PHP 8.1.0 и cURL
  7.71.0.


id: CURLOPT_MUTE
type: constant
doc:
<comment>Description:</comment>
  Удалено в cURL 7.15.5; вместо неё используйте константу <info>CURLOPT_RETURNTRANSFER</info>.


id: CURLOPT_PROXY_ISSUERCERT
type: constant
doc:
<comment>Description:</comment>
  Имя файла сертификата SSL эмитента прокси. Доступно начиная с PHP 8.1.0 и cURL 7.71.0.


id: CURLOPT_PROXY_ISSUERCERT_BLOB
type: constant
doc:
<comment>Description:</comment>
  SSL-сертификат эмитента прокси из большого двоичного объекта памяти. Доступно начиная с PHP 8.1.0
  и cURL 7.71.0.


id: CURLOPT_PROXY_SSLCERT_BLOB
type: constant
doc:
<comment>Description:</comment>
  Сертификат клиента прокси SSL из большого двоичного объекта памяти. Доступно начиная с PHP 8.1.0 и
  cURL 7.71.0.


id: CURLOPT_PROXY_SSLKEY_BLOB
type: constant
doc:
<comment>Description:</comment>
  Закрытый ключ для сертификата прокси из большого двоичного объекта памяти. Доступно начиная с PHP
  8.1.0 и cURL 7.71.0.


id: CURLOPT_SSLCERT_BLOB
type: constant
doc:
<comment>Description:</comment>
  Сертификат клиента SSL из большого двоичного объекта памяти. Доступно начиная с PHP 8.1.0 и cURL
  7.71.0.


id: CURLOPT_SSLKEY_BLOB
type: constant
doc:
<comment>Description:</comment>
  Закрытый ключ для сертификата клиента из большого двоичного объекта памяти. Доступно начиная с PHP
  8.1.0 и cURL 7.71.0.


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


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

<comment>Param:</comment>
  <info>string</info>  <strong>$data</strong>      Содержимое для загрузки.
  <info>string</info>  <strong>$postname</strong>  Имя файла, который будет использоваться в загружаемых данных.
  <info>string</info>  <strong>$mime</strong>      MIME-тип файла (по умолчанию <return>application/octet-stream</return>).

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


id: CURL_VERSION_CONV
type: constant
doc:
<comment>Description:</comment>
  Поддерживаются преобразования символов. Доступно с PHP 7.3.0 и cURL 7.15.4.


id: CURL_VERSION_CURLDEBUG
type: constant
doc:
<comment>Description:</comment>
  Поддерживается отслеживание отладки памяти. Доступно с PHP 7.3.6 и cURL 7.19.6.


id: CURL_VERSION_DEBUG
type: constant
doc:
<comment>Description:</comment>
  Собран с возможностью отладки. Доступно с PHP 7.3.0 и cURL 7.10.6.


id: CURL_VERSION_GSSAPI
type: constant
doc:
<comment>Description:</comment>
  Собран на основе библиотеки GSS-API. Доступно с PHP 7.3.0 и cURL 7.38.0.


id: CURL_VERSION_GSSNEGOTIATE
type: constant
doc:
<comment>Description:</comment>
  Поддерживается согласование аутентификации. Доступно с PHP 7.3.0 и cURL 7.10.6 (объявлено
  устаревшим с 7.38.0).


id: CURL_VERSION_IDN
type: constant
doc:
<comment>Description:</comment>
  Поддерживаются международные доменные имена. Доступно с PHP 7.3.0 и cURL 7.12.0.


id: CURL_VERSION_KERBEROS5
type: constant
doc:
<comment>Description:</comment>
  Поддерживается проверка подлинности Kerberos V5. Доступно с PHP 7.0.7 и cURL 7.40.0.


id: CURL_VERSION_NTLM
type: constant
doc:
<comment>Description:</comment>
  Поддерживается аутентификация NTLM. Доступно с PHP 7.3.0 и cURL 7.10.6.


id: CURL_VERSION_NTLM_WB
type: constant
doc:
<comment>Description:</comment>
  Поддерживается делегирование NTLM помощнику winbind. Доступно с PHP 7.3.0 и cURL 7.22.0.


id: CURL_VERSION_PSL
type: constant
doc:
<comment>Description:</comment>
  Список общедоступных суффиксов Mozilla, используемый для проверки домена cookie. Доступно с PHP
  7.3.6 и cURL 7.47.0.


id: CURL_VERSION_SPNEGO
type: constant
doc:
<comment>Description:</comment>
  Поддерживается аутентификация SPNEGO. Доступно с PHP 7.3.0 и cURL 7.10.8.


id: CURL_VERSION_SSPI
type: constant
doc:
<comment>Description:</comment>
  Встроенная поддержка Windows SSPI. Доступно с PHP 7.3.0 и cURL 7.13.2.


id: CURL_VERSION_TLSAUTH_SRP
type: constant
doc:
<comment>Description:</comment>
  Поддерживается аутентификация TLS-SRP. Доступно с PHP 7.3.0 и cURL 7.21.4.


id: CURL_VERSION_UNIX_SOCKETS
type: constant
doc:
<comment>Description:</comment>
  Поддержка сокетов домена Unix. Доступно с PHP 7.0.7 и cURL 7.40.0.


id: CachingIterator
type: class
doc:
<comment>Description:</comment>
  Этот объект поддерживает кеширование итерации над другим итератором.


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

<comment>Param:</comment>
  <info>Iterator</info>  <strong>$iterator</strong>  Iterator для кеширования
  <info>int</info>       <strong>$flags</strong>     Битовые маски флагов.


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

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


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

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


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

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

<comment>See Also:</comment>
   * Iterator::current


id: CachingIterator::getCache
type: function
doc:
<comment>Description:</comment>
  Получение содержимого кеша
  
  Получение содержимого кеша.
  
  Должен использоваться флаг <info>CachingIterator::FULL_CACHE</info>.

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


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

<comment>Return:</comment>
  <info>void</info>  Описание...


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

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


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

<comment>Return:</comment>
  <info>scalar</info>  


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

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


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

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

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


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

<comment>Param:</comment>
  <info>string</info>  <strong>$key</strong>  Описание...

<comment>Return:</comment>
  <info>mixed</info>  Описание...


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

<comment>Param:</comment>
  <info>string</info>  <strong>$key</strong>    Индекс элемента.
  <info>mixed</info>   <strong>$value</strong>  Новое значение для элемента с индексом<strong>$key</strong>.

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


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

<comment>Param:</comment>
  <info>string</info>  <strong>$key</strong>  Индекс элемента, который будет удалён.

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


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

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


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

<comment>Param:</comment>
  <info>int</info>  <strong>$flags</strong>  Битовая маска флагов для установки.

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


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

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


id: CallbackFilterIterator::__construct
type: function
doc:
<comment>Description:</comment>
  Создаёт фильтрующий итератор на основе другого итератора
    
  
  Создаёт фильтрующий итератор, используя функцию <strong>$callback</strong> для отбора или отклонения элементов.

<comment>Param:</comment>
  <info>Iterator</info>  <strong>$iterator</strong>  Итератор, к которому применяется фильтр.
  <info>callable</info>  <strong>$callback</strong>  Callback-функция, которая должна возвращать <info>true</info>, если текущий элемент прошёл
                       фильтр, и <info>false</info>, если элемент отклонён. Смотрите примеры.
                       
                       Может быть любым <info>callable</info> значением.

<comment>See Also:</comment>
   * Примеры использования CallbackFilterIterator
   * CallbackFilterIterator::accept


id: CallbackFilterIterator::accept
type: function
doc:
<comment>Description:</comment>
  Вызывает callback-функцию и передаёт ей в качестве аргументов текущее значение,
     текущий ключ и внутренний указатель
    
  
  Вызывает callback-функцию и передаёт ей в качестве аргументов текущее значение, текущий ключ и
  внутренний указатель.
  
  Callback-функция должна возвращать <info>true</info>, если текущий элемент прошёл фильтр, <info>false</info> в противном
  случае.

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

<comment>See Also:</comment>
   * Примеры использования CallbackFilterIterator
   * CallbackFilterIterator::__construct


id: Client::getClient
type: function
doc:
<comment>Description:</comment>
  Получает сеанс клиента
  
  Получает сеанс, связанный с клиентом.

<comment>Return:</comment>
  <info>mysql_xdevapi\Session</info>  Объект Session.


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


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

<comment>See Also:</comment>
   * Анонимные функции


id: Closure::bind
type: function
doc:
<comment>Description:</comment>
  Дублирует замыкание с указанием конкретного связанного объекта и области видимости класса
    
  
  Этот метод является статическим вариантом Closure::bindTo. Смотрите документацию к указанному
  методу для подробной информации.

<comment>Param:</comment>
  <info>Closure</info>             <strong>$closure</strong>   Анонимная функция для привязывания к объекту.
  <info>object|null</info>         <strong>$newThis</strong>   Объект, к которому будет привязана переданная анонимная функция,
                                 или <info>null</info> для отсоединения функции от её текущего объекта.
  <info>object|string|null</info>  <strong>$newScope</strong>  Область видимости класса, с которой должно быть связано замыкание,
                                 или 'static' для сохранения текущей области видимости. Если передан
                                 объект, то будет использован его класс. Этот параметр определяет
                                 видимость protected (защищённых) и private (закрытых) методов
                                 привязанного объекта. Запрещено в качестве этого параметра
                                 передавать (объектом) внутренний класс.

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

<comment>See Also:</comment>
   * Анонимные функции
   * Closure::bindTo


id: Closure::bindTo
type: function
doc:
<comment>Description:</comment>
  Дублирует замыкание с указанием связанного объекта и области видимости класса
    
  
  Создаёт и возвращает новую анонимную функцию с тем же телом функции и связанными переменными, но с
  другим связанным объектом или новой областью видимости класса.
  
  "Связанный объект" определяет значение <return>$this</return>, которое будет доступно в теле функции, а "область
  видимости класса" представляет собой класс, который определяет к каким protected (защищённым) и
  private (закрытым) элементам этого объекта будет иметь доступ анонимная функция. Если точнее, то
  это те элементы, как если бы анонимная функция была бы методом класса, переданного в параметре
  <strong>$newScope</strong>.
  
  Статические замыкания не могут иметь привязанный объект (значение параметра <strong>$newThis</strong> должно быть
  равно <info>null</info>), но эта функция может всё равно использоваться для изменения его области видимости
  класса.
  
  Данный метод гарантирует, что у нестатического замыкания с привязанным объектом будет задана
  область видимости и наоборот. Для выполнения этого условия применяются следующие правила: Для
  нестатического замыкания с указанной областью видимости и с <info>null</info> вместо объекта, будет создано
  статическое замыкание. Для нестатического замыкания с незаданной областью видимости, но с
  указанием объекта, создаётся замыкание с неуказанной областью видимости.
  
  Если вам необходимо только дублировать анонимную функцию, то вы можете вместо данного метода
  использовать клонирование.

<comment>Param:</comment>
  <info>object|null</info>         <strong>$newThis</strong>   Объект, к которому будет привязана переданная анонимная функция,
                                 или <info>null</info> для отсоединения замыкания от её текущего объекта.
  <info>object|string|null</info>  <strong>$newScope</strong>  Область видимости класса, с которой должно быть связано замыкание
                                 или 'static' для сохранения текущей области видимости. Если передан
                                 объект, то будет использован его класс. Этот параметр определяет
                                 видимость protected (защищённых) и private (закрытых) методов
                                 привязанного объекта. Запрещается передавать в этот параметр
                                 внутренний класс (объект класса).

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

<comment>See Also:</comment>
   * Анонимные функции
   * Closure::bind


id: Closure::call
type: function
doc:
<comment>Description:</comment>
  Связывает и запускает замыкание
  
  Временно связывает замыкание с <strong>$newThis</strong> и вызывает его с заданными параметрами.

<comment>Param:</comment>
  <info>object</info>  <strong>$newThis</strong>  Объект (<info>object</info>) для привязки к замыканию на время его вызова.
  <info>mixed</info>   <strong>$args</strong>     Ноль или больше параметров, которые передаются замыканию.

<comment>Return:</comment>
  <info>mixed</info>  Возвращает возвращаемое значение замыкания


id: Closure::fromCallable
type: function
doc:
<comment>Description:</comment>
  Конвертирует callable в замыкание
  
  Создаёт и возвращает новую анонимную функцию из заданного <strong>$callback</strong>, используя текущую область
  видимости. Этот метод проверяет, что <strong>$callback</strong> является типом callable в текущей области видимости
  и выбрасывает исключение <class>TypeError</class>, если это не так.
  
  Начиная с PHP 8.1.0, у Callback-функций как объектов первого класса та же семантика, что и у этого
  метода.

<comment>Param:</comment>
  <info>callable</info>  <strong>$callback</strong>  Объект типа callable.

<comment>Return:</comment>
  <info>Closure</info>  Возвращает новый объект класса <class>Closure</class> или выбрасывает исключение <class>TypeError</class>, если
           <strong>$callback</strong> не является объектом типа callable в текущей области видимости.

<comment>See Also:</comment>
   * Анонимные функции
   * Callback-функции как объекты первого класса


id: Collator
type: class
doc:
<comment>Description:</comment>
  Производит сравнение строк с поддержкой порядка сортировки специфичного для локали.


id: Collator::ALTERNATE_HANDLING
type: constant
doc:
<comment>Description:</comment>
  Аттрибут "Alternate" используется для контроля обработки так называемых "переменных символов" в
  UCA: пробельные символы, знаки пунктуации и символы. Если "Alternate" установлен как NonIgnorable
  (N), то различия в этих символах будут считаться такими же значимыми, как и различия между
  буквами. Если "Alternate" установлен как Shifted (S), то эти символы будут иметь низкую
  значимость. Значение Shifted зачастую используется в комбинации с Strength установленным в
  "Quaternary". В таких случаях подобные символы будут учитываться при сортировке, но только если
  все остальные аспекты строк (буквы, акценты, регист) идентичны. Если "Alternate" не установлен как
  "Shifted", то разницы между "Strength" равным 3 и 4 не будет. Более подробно и с примерами читайте
  в разделе "Variable_Weighting" на сайте UCA. Причина, по которой значения для "Alternate" не
  используются просто On в Off в том, что в будущем могут быть добавлены дополнительные варианты.
  Опция UCA "Blanked"  выражается с помощью "Strength" установленного в и "Alternate" установленного
  в "Shifted". Для большинства локалей этот параметр по умолчанию равен "NonIgnorable". Если задано
  "Shifted", то обработка может быть медленнее в случае если у вас много строк, отличающихся только
  пунктуацией. Длина ключа сортировки не затрагивается только если также не увеличивался уровень
  "Strength".
  
  Возможные значения: <info>Collator::NON_IGNORABLE</info>(по умолчанию)<info>Collator::SHIFTED</info><info>Collator::DEFAULT_VALUE</info>
  
  ALTERNATE_HANDLING rules S=3, A=N di Silva
  \< Di Silva \< diSilva \< U.S.A. \< USA  S=3, A=S di Silva = diSilva \< Di Silva \< U.S.A. = USA  S=4, A=S di Silva \< diSilva \< Di Silva \< U.S.A. \< USA
  
   S=3, A=N di Silva
  \< Di Silva \< diSilva \< U.S.A. \< USA  S=3, A=S di Silva = diSilva \< Di Silva \< U.S.A. = USA  S=4, A=S di Silva \< diSilva \< Di Silva \< U.S.A. \< USA


id: Collator::CASE_FIRST
type: constant
doc:
<comment>Description:</comment>
  Аттрибут "Case_First" используется для определения порядка сортировки в зависимости от регистра
  символов при отсутствии других различий в строках. Возможные значения: Uppercase_First(U),
  Lowercase_First (L), Default и Off. Между "Off" и "Lowercase_First" практически нет разницы, так
  что пользователи обычно не используют "Lowercase_First", а только Off или Uppercase_First. (Те,
  кому действительно интересна разница между X и L могут обратиться к <return>Настройке Collation</return>). Задание
  L или U не сказывается на скорости сравнения, но влияет на длину ключа сортировки.
  
  Возможные значения: <info>Collator::OFF</info>(по
  умолчанию)<info>Collator::LOWER_FIRST</info><info>Collator::UPPER_FIRST</info><info>Collator:DEFAULT</info>
  
  Правила CASE_FIRSTC=X or C=L "china"
  \< "China" \< "denmark" \< "Denmark"C=U "China" \< "china" \< "Denmark" \< "denmark"
  
  C=X or C=L "china"
  \< "China" \< "denmark" \< "Denmark"C=U "China" \< "china" \< "Denmark" \< "denmark"


id: Collator::CASE_LEVEL
type: constant
doc:
<comment>Description:</comment>
  Аттрибут "Case_Level" используется, когда акценты не важны, а регист важен. В таких случаях
  установите "Strength" в значение Primary, и "Case_Level" в On. В большинстве локалей по умолчанию
  задано значение "Off". Оказывает незначительное влияние на скорость сравнения и длину ключа
  сортировки если установлено как On.
  
  Возможные значения: <info>Collator::OFF</info>(по умолчанию)<info>Collator::ON</info><info>Collator::DEFAULT_VALUE</info>
  
  CASE_LEVEL rulesS=1, E=X role = Role = rôleS=1, E=O role = rôle \< Role
  
  S=1, E=X role = Role = rôleS=1, E=O role = rôle \< Role


id: Collator::FRENCH_COLLATION
type: constant
doc:
<comment>Description:</comment>
  Сортировка строк с акцентами с конца строки. Этот атрибут автоматически проставляется в On для
  французской и некоторых других локалей. Обычно пользователям нет необходимости специально задавать
  этот параметр. Есть некоторая просадка производительности если этот параметр установлен как On, но
  никак не влияет на длину ключа сортировки. Возможные значения: <info>Collator::ON</info><info>Collator::OFF</info>(по
  умолчанию)<info>Collator::DEFAULT_VALUE</info>
  
  Правила FRENCH_COLLATIONF=OFF cote \< coté \< côte \< côté F=ON cote \< côte \< coté \< côté
  
  F=OFF cote \< coté \< côte \< côté F=ON cote \< côte \< coté \< côté


id: Collator::HIRAGANA_QUATERNARY_MODE
type: constant
doc:
<comment>Description:</comment>
  Совместимость с JIS x 4061 требует введения дополнительного уровня для выделения символов Hiragana
  и Katakana. Если требуется совместимость со стандартом, то данный аттрибут необходимо задать как
  On, а "Strength" как "Quaternary". Это скажется на длине ключа сортировки и скорости сравнения.
  
  Возможные значения: <info>Collator::OFF</info>(по умолчанию)<info>Collator::ON</info><info>Collator::DEFAULT_VALUE</info>


id: Collator::NORMALIZATION_MODE
type: constant
doc:
<comment>Description:</comment>
  Настройка "Normalization" определяет, будет ли текст тщательно нормализован в сравнении или нет.
  Даже если данная настройка отключена (по умолчанию для многих локалей), текст в общем случае будет
  сравниваться корректно (подробности в UTN #5). Проблемы могут быть только с отметками акцентов
  расположенными в неканоничном порядке. Если установлено как On, то будет гарантирован наилучший
  результат для всех возможных вариантов текста. Однако, если установлено как On - это скажется на
  скорости сравнения, в зависимости от количества последовательностей, который необходимо
  нормализовать. Какого-либо заметного влияния на длину ключа сортировки оказано не будет. Если
  заранее известно, что текст уже нормализован как NFD или NFKD, необходимости в использовании этой
  настройки нет.
  
  Возможные значения: <info>Collator::OFF</info>(по умолчанию)<info>Collator::ON</info><info>Collator::DEFAULT_VALUE</info>


id: Collator::NUMERIC_COLLATION
type: constant
doc:
<comment>Description:</comment>
  Если включён, этот аттрибут генерирует ключ сравнения для числового значения подстроки состоящей
  из цифр. Это позволяет при сортировке помещать '100' после '2'.
  
  Возможные значения: <info>Collator::OFF</info>(по умолчанию)<info>Collator::ON</info><info>Collator::DEFAULT_VALUE</info>


id: Collator::STRENGTH
type: constant
doc:
<comment>Description:</comment>
  ICU Collation Service поддерживает множество уровней сравнения (они называются "Levels", но также
  известны как "Strengths"). Использование этих настроек позволяет ICU сортировать строки точно в
  соответствии с правилами локали. Однако, разрешая выборочное использование этих уровней, поиск
  строки в тексте можно производить с использованием различных условий. Больше информации описано в
  главе посвящённой <strong>collator_set_strength()</strong>.
  
  Возможные значения: <info>Collator::PRIMARY</info><info>Collator::SECONDARY</info><info>Collator::TERTIARY</info>(по
  умолчанию)<info>Collator::QUATERNARY</info><info>Collator::IDENTICAL</info><info>Collator::DEFAULT_VALUE</info>


id: Collator::__construct
type: function
doc:
<comment>Description:</comment>
  Создаёт новый экземпляр Collator
  
  Создаёт новый экземпляр <class>Collator</class>.

<comment>Param:</comment>
  <info>string</info>  <strong>$locale</strong>  Локаль, правила сопоставления которой следует использовать. Могут быть переданы
                   специальные значения для языковых стандартов - если для языкового стандарта
                   передана пустая строка (<info>string</info>), будут использоваться правила сопоставления
                   языкового стандарта по умолчанию. Если передано значение <return>"root"</return>, будут
                   использоваться правила UCA.
                   
                   Атрибут <strong>$locale</strong> обычно является наиболее важным атрибутом для правильной
                   сортировки и сопоставления в соответствии с ожиданиями пользователей в разных
                   странах и регионах. По умолчанию порядок сортировки UCA будет правильно
                   отсортировать только несколько языков, таких как голландский и португальский
                   ("правильно" означает в соответствии с обычными ожиданиями пользователей этих
                   языков). В противном случае вам необходимо указать локаль в UCA, чтобы правильно
                   сопоставить текст для данного языка. Таким образом, необходимо указать языковой
                   стандарт, чтобы выбрать Collator, который правильно адаптирован для этого
                   языкового стандарта. Выбор языкового стандарта автоматически устанавливает
                   значения для всех атрибутов на то, что подходит для этого языкового стандарта.
                   Таким образом, в большинстве случаев другие атрибуты не нужно явно указывать. В
                   некоторых случаях выбор локали будет иметь значение для производительности
                   сравнения строк и/или длины ключа сортировки.

<comment>See Also:</comment>
   * <strong>Collator::create()</strong>
   * <strong>collator_create()</strong>


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

<comment>Param:</comment>
  <info>Collator</info>  <strong>$object</strong>  Объект <class>Collator</class>.
  <info>array</info>     <strong>$array</strong>   Массив строк для сортировки.
  <info>int</info>       <strong>$flags</strong>   Необязательный тип сортировки, один из следующих: <info>Collator::SORT_REGULAR</info> -
                     сравнивает элементы как обычно (не изменяя тип) <info>Collator::SORT_NUMERIC</info> -
                     сравнивает элементы, как числа <info>Collator::SORT_STRING</info> - сравнивает элементы, как
                     строки
                     
                     <info>Collator::SORT_REGULAR</info> - сравнивает элементы как обычно (не изменяя тип)
                     
                     <info>Collator::SORT_NUMERIC</info> - сравнивает элементы, как числа
                     
                     <info>Collator::SORT_STRING</info> - сравнивает элементы, как строки
                     
                     Значение <strong>$flags</strong> по умолчанию - <info>Collator::SORT_REGULAR</info>. Также используется, если
                     указано недопустимое значение <strong>$flags</strong>.

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

<comment>See Also:</comment>
   * Константы <class>Collator</class>
   * <strong>collator_sort()</strong>
   * <strong>collator_sort_with_sort_keys()</strong>


id: Collator::compare
type: function
doc:
<comment>Description:</comment>
  Сравнивает две строки Unicode
  
  Объектно-ориентированный стиль
  
  Процедурный стиль
  
  Сравнивает две строки Unicode в соответствии с правилами сопоставления.

<comment>Param:</comment>
  <info>Collator</info>  <strong>$object</strong>   Объект <class>Collator</class>.
  <info>string</info>    <strong>$string1</strong>  Первая строка для сравнения.
  <info>string</info>    <strong>$string2</strong>  Вторая строка для сравнения.

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

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


id: Collator::create
type: function
doc:
<comment>Description:</comment>
  Создаёт новый экземпляр Collator
  
  Объектно-ориентированный стиль
  
  Процедурный стиль
  
  Строки будут сравниваться с использованием уже указанных параметров.

<comment>Param:</comment>
  <info>string</info>  <strong>$locale</strong>  Локаль, содержащая необходимые правила сопоставления. Могут быть переданы
                   специальные значения для языковых стандартов, если для языкового стандарта
                   передана пустая строка (<info>string</info>), будут использоваться правила сопоставления
                   языковых стандартов по умолчанию. Если передаётся значение <return>"root"</return>, будут
                   использоваться правила UCA.

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

<comment>See Also:</comment>
   * <strong>Collator::__construct()</strong>


id: Collator::getAttribute
type: function
doc:
<comment>Description:</comment>
  Получает значение атрибута сопоставления
  
  Объектно-ориентированный стиль
  
  Процедурный стиль
  
  Получает значение целочисленного атрибута сопоставителя.

<comment>Param:</comment>
  <info>Collator</info>  <strong>$object</strong>     Объект <class>Collator</class>.
  <info>int</info>       <strong>$attribute</strong>  Атрибут, для которого требуется получить значение.

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

<comment>See Also:</comment>
   * Константы <class>Collator</class>
   * <strong>collator_set_attribute()</strong>
   * <strong>collator_get_strength()</strong>


id: Collator::getErrorCode
type: function
doc:
<comment>Description:</comment>
  Получает последний код ошибки Collator
  
  Объектно-ориентированный стиль
  
  Процедурный стиль
  
  

<comment>Param:</comment>
  <info>Collator</info>  <strong>$object</strong>  Объект <class>Collator</class>.

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

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


id: Collator::getErrorMessage
type: function
doc:
<comment>Description:</comment>
  Получает текст для кода последней ошибки Collator
  
  Объектно-ориентированный стиль
  
  Процедурный стиль
  
  Получает сообщение о последней ошибке.

<comment>Param:</comment>
  <info>Collator</info>  <strong>$object</strong>  Объект <class>Collator</class>.

<comment>Return:</comment>
  <info>string|false</info>  Описание ошибки, возвращённой последним вызовом функции API Collator или <info>false</info> в
                случае возникновения ошибки.

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


id: Collator::getLocale
type: function
doc:
<comment>Description:</comment>
  Получает название локали для Collator
  
  Объектно-ориентированный стиль
  
  Процедурный стиль
  
  Получает название локали для Collator.

<comment>Param:</comment>
  <info>Collator</info>  <strong>$object</strong>  Объект <class>Collator</class>.
  <info>int</info>       <strong>$type</strong>    Вы можете выбирать между корректным и фактическим языковым стандартом (
                     <info>Locale::VALID_LOCALE</info> и <info>Locale::ACTUAL_LOCALE</info>, соответственно).

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

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


id: Collator::getSortKey
type: function
doc:
<comment>Description:</comment>
  Получает ключ сортировки строки
  
  Объектно-ориентированный стиль
  
  Процедурный стиль
  
  Возвращает ключ сопоставления для строки. Ключи сопоставления можно сравнивать напрямую, а не
  строки, хотя они зависят от реализации и могут меняться в зависимости от версии библиотеки ICU.
  Ключи сортировки обычно полезны только в базах данных или в других случаях, когда вызовы функций
  чрезвычайно дороги.

<comment>Param:</comment>
  <info>Collator</info>  <strong>$object</strong>  Объект <class>Collator</class>.
  <info>string</info>    <strong>$string</strong>  Строка, из которой создаётся ключ.

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

<comment>See Also:</comment>
   * <strong>collator_sort()</strong>
   * <strong>collator_sort_with_sort_keys()</strong>


id: Collator::getStrength
type: function
doc:
<comment>Description:</comment>
  Получает текущую силу сопоставления
  
  Объектно-ориентированный стиль
  
  Процедурный стиль
  
  

<comment>Param:</comment>
  <info>Collator</info>  <strong>$object</strong>  Объект <class>Collator</class>.

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

<comment>See Also:</comment>
   * Константы <class>Collator</class>
   * <strong>collator_set_strength()</strong>
   * <strong>collator_get_attribute()</strong>


id: Collator::setAttribute
type: function
doc:
<comment>Description:</comment>
  Устанавливает атрибут сопоставления
  
  Объектно-ориентированный стиль
  
  Процедурный стиль
  
  

<comment>Param:</comment>
  <info>Collator</info>  <strong>$object</strong>     Объект <class>Collator</class>.
  <info>int</info>       <strong>$attribute</strong>  Атрибут.
  <info>int</info>       <strong>$value</strong>      Значение атрибута.

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

<comment>See Also:</comment>
   * Константы <class>Collator</class>
   * <strong>collator_get_attribute()</strong>
   * <strong>collator_set_strength()</strong>


id: Collator::setStrength
type: function
doc:
<comment>Description:</comment>
  Устанавливает силу сопоставления
  
  Объектно-ориентированный стиль
  
  Процедурный стиль
  
  Служба сопоставления ICU поддерживает множество уровней сравнения (называемых "Уровни", но также
  известных как "Сила сравнения"). Наличие этих категорий позволяет ICU сортировать строки точно в
  соответствии с местными соглашениями. Однако, позволяя выборочно использовать уровни, поиск строки
  в тексте может выполняться с различными условиями сопоставления.
  
  Первичный уровень: Обычно используется для обозначения различий между основными символами
  (например, "a"
  \< "b"). Это самая большая разница. Например, словари разбиты на разные разделы по основному символу. Также называется силой <return>level
  1</return>. Вторичный уровень: Акценты в символах считаются вторичными отличиями (например, "as"
  \< "às" \< "at"). Другие различия между буквами также можно считать вторичными, в зависимости от языка. Вторичное отличие игнорируется, если есть первичное различие где-либо в строках. Также называется силой <return>level
  2</return>.  Примечание: В некоторых языках (например, датском) определённые буквы с диакритическими
  знаками считаются отдельными базовыми символами. Однако, в большинстве языков, буква с ударением
  имеет лишь второстепенное отличие от версии этой буквы без ударения.  Третичный уровень: Различия
  в верхнем и нижнем регистре символов различаются на третичном уровне (например, "ao"
  \< "Ao" \< "aò"). Кроме того, вариант буквы отличается от базовой формы на третичном уровне (например, "A" и " "). Другой пример - разница между большой и маленькой Кана. Третичное различие игнорируется, если где-либо в строках есть первичное или вторичное различие. Также называется силой <return>level
  3</return>. Четвертичный уровень: Когда пунктуация игнорируется (смотрите Игнорирование знаков препинания)
  на уровнях 1-3, можно использовать дополнительный уровень для различения слов с пунктуацией и без
  неё (например, "ab"
  \< "a-b" \< "aB"). Эта разница игнорируется, если есть первичная, вторичная или третичная разница. Также называется силой <return>level
  4</return>. Четвертичный уровень следует использовать только в том случае, если требуется игнорирование
  знаков препинания или при обработке японского текста (смотрите Обработка хираганы). Идентичный
  уровень: Когда все остальные уровни равны, идентичный уровень используется в качестве тай-брейка.
  Значения кодовых точек Unicode формы NFD каждой строки сравниваются на этом уровне, на всякий
  случай, если нет разницы на уровнях 1-4. Например, кантиляционные знаки иврита различаются только
  на этом уровне. Этот уровень следует использовать с осторожностью, поскольку разница только в
  значениях кодовых точек между двумя строками является крайне редким явлением. Использование этого
  уровня существенно снижает производительность как для инкрементного сравнения, так и для генерации
  ключа сортировки (а также увеличивает длину ключа сортировки). Также называется силой <return>level 5</return>.
  
  Первичный уровень: Обычно используется для обозначения различий между основными символами
  (например, "a"
  \< "b"). Это самая большая разница. Например, словари разбиты на разные разделы по основному символу. Также называется силой <return>level
  1</return>.
  
  Вторичный уровень: Акценты в символах считаются вторичными отличиями (например, "as"
  \< "às" \< "at"). Другие различия между буквами также можно считать вторичными, в зависимости от языка. Вторичное отличие игнорируется, если есть первичное различие где-либо в строках. Также называется силой <return>level
  2</return>.  Примечание: В некоторых языках (например, датском) определённые буквы с диакритическими
  знаками считаются отдельными базовыми символами. Однако, в большинстве языков, буква с ударением
  имеет лишь второстепенное отличие от версии этой буквы без ударения.
  
  Примечание: В некоторых языках (например, датском) определённые буквы с диакритическими знаками
  считаются отдельными базовыми символами. Однако, в большинстве языков, буква с ударением имеет
  лишь второстепенное отличие от версии этой буквы без ударения.
  
  Третичный уровень: Различия в верхнем и нижнем регистре символов различаются на третичном уровне
  (например, "ao"
  \< "Ao" \< "aò"). Кроме того, вариант буквы отличается от базовой формы на третичном уровне (например, "A" и " "). Другой пример - разница между большой и маленькой Кана. Третичное различие игнорируется, если где-либо в строках есть первичное или вторичное различие. Также называется силой <return>level
  3</return>.
  
  Четвертичный уровень: Когда пунктуация игнорируется (смотрите Игнорирование знаков препинания) на
  уровнях 1-3, можно использовать дополнительный уровень для различения слов с пунктуацией и без неё
  (например, "ab"
  \< "a-b" \< "aB"). Эта разница игнорируется, если есть первичная, вторичная или третичная разница. Также называется силой <return>level
  4</return>. Четвертичный уровень следует использовать только в том случае, если требуется игнорирование
  знаков препинания или при обработке японского текста (смотрите Обработка хираганы).
  
  Идентичный уровень: Когда все остальные уровни равны, идентичный уровень используется в качестве
  тай-брейка. Значения кодовых точек Unicode формы NFD каждой строки сравниваются на этом уровне, на
  всякий случай, если нет разницы на уровнях 1-4. Например, кантиляционные знаки иврита различаются
  только на этом уровне. Этот уровень следует использовать с осторожностью, поскольку разница только
  в значениях кодовых точек между двумя строками является крайне редким явлением. Использование
  этого уровня существенно снижает производительность как для инкрементного сравнения, так и для
  генерации ключа сортировки (а также увеличивает длину ключа сортировки). Также называется силой
  <return>level 5</return>.
  
  Например, люди могут игнорировать акценты или игнорировать акценты и регистр при поиске текста.
  Почти все символы различаются по первым трём уровням, поэтому в большинстве языков значение по
  умолчанию - третичный. Однако, если для параметра "Альтернативный" задано значение "Shifted", то
  четвертичную силу можно использовать для разрыва связей между пробелами, пунктуацией и символами,
  которые в противном случае были бы проигнорированы. Если требуются очень тонкие различия между
  символами, тогда можно использовать Идентичный уровень (например, Идентичный уровень различает
  Mathematical Bold Small A и the Mathematical Italic Small A.). Однако использование уровней выше,
  чем третичный, идентичная сила приводит к значительно более длинным ключам сортировки и снижению
  производительности сравнения строк для равных строк.

<comment>Param:</comment>
  <info>Collator</info>  <strong>$object</strong>    Объект <class>Collator</class>.
  <info>int</info>       <strong>$strength</strong>  Strength to set.
                       
                       Допустимые значения:
                       <info>Collator::PRIMARY</info><info>Collator::SECONDARY</info><info>Collator::TERTIARY</info><info>Collator::QUATERNARY</info><info>Collator::IDENTICAL</info><info>Collator::DEFAULT_STRENGTH</info>
                       
                       <info>Collator::PRIMARY</info>
                       
                       <info>Collator::SECONDARY</info>
                       
                       <info>Collator::TERTIARY</info>
                       
                       <info>Collator::QUATERNARY</info>
                       
                       <info>Collator::IDENTICAL</info>
                       
                       <info>Collator::DEFAULT_STRENGTH</info>

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

<comment>See Also:</comment>
   * Константы <class>Collator</class>
   * <strong>collator_get_strength()</strong>


id: Collator::sort
type: function
doc:
<comment>Description:</comment>
  Сортирует массив с использованием указанного средства сортировки
  
  Объектно-ориентированный стиль
  
  Процедурный стиль
  
  Функция сортирует массив в соответствии с текущими правилами локали.
  
  Эквивалентна стандартной функции PHP <strong>sort()</strong> .

<comment>Param:</comment>
  <info>Collator</info>  <strong>$object</strong>  Объект <class>Collator</class>.
  <info>array</info>     <strong>$array</strong>   Array of strings to sort.
  <info>int</info>       <strong>$flags</strong>   Необязательный тип сортировки, один из следующих:
                     
                     <info>Collator::SORT_REGULAR</info> - сравнивает элементы как обычно (не изменяя тип)
                     <info>Collator::SORT_NUMERIC</info> - сравнивает элементы, как числа <info>Collator::SORT_STRING</info> -
                     сравнивает элементы, как строки  Тип сортировки по умолчанию -
                     <info>Collator::SORT_REGULAR</info>. Он также используется, если указано недопустимое
                     значение <strong>$flags</strong>.
                     
                     <info>Collator::SORT_REGULAR</info> - сравнивает элементы как обычно (не изменяя тип)
                     
                     <info>Collator::SORT_NUMERIC</info> - сравнивает элементы, как числа
                     
                     <info>Collator::SORT_STRING</info> - сравнивает элементы, как строки

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

<comment>See Also:</comment>
   * Константы <class>Collator</class>
   * <strong>collator_asort()</strong>
   * <strong>collator_sort_with_sort_keys()</strong>


id: Collator::sortWithSortKeys
type: function
doc:
<comment>Description:</comment>
  Сортирует массив с использованием указанного Collator и ключей сортировки
  
  Объектно-ориентированный стиль
  
  Процедурный стиль
  
  То же, что и <strong>collator_sort()</strong>, но использует ключи сортировки ICU, созданные ucol_getSortKey() для
  увеличения скорости работы с большими массивами.

<comment>Param:</comment>
  <info>Collator</info>  <strong>$object</strong>  Объект <class>Collator</class>.
  <info>array</info>     <strong>$array</strong>   Массив строк для сортировки

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

<comment>See Also:</comment>
   * Константы <class>Collator</class>
   * <strong>collator_sort()</strong>
   * <strong>collator_asort()</strong>


id: Collectable::isGarbage
type: function
doc:
<comment>Description:</comment>
  Определяет, помечен ли объект как мусор
  
  Можно вызывать в Pool::collect для определения, является ли объект мусором.

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

<comment>See Also:</comment>
   * Pool::collect


id: Collection::add
type: function
doc:
<comment>Description:</comment>
  Добавляет документ в коллекцию
  
  Запускает добавление данного документа (документов) в коллекцию, поддерживаются несколько
  вариантов метода. Возможные варианты:
  
  Добавление одного документа в виде строки JSON.
  
  Добавление одного документа в виде массива, например: <return>[ 'field' =&gt; 'value', 'field2' =&gt;
  'value2' ... ]</return>
  
  В одну и ту же операцию можно добавить, как документ, так и несколько документов.

<comment>Param:</comment>
  <info>mixed</info>  <strong>$document</strong>  Один или несколько документов, это может быть либо JSON, либо массив полей с
                    соответствующими значениями. Массив не может быть пустым.
                    
                    Сервер MySQL автоматически генерирует уникальные значения <return>_id</return> для каждого
                    документа (рекомендуется), хотя оно также может быть добавлено вручную. Это
                    значение должно быть уникальным, иначе операция добавления не будет выполнена.

<comment>Return:</comment>
  <info>mysql_xdevapi\CollectionAdd</info>  Объект CollectionAdd. Используйте execute() для возврата Result,
                               который можно использовать для запроса количества затронутых
                               элементов, количества предупреждений, сгенерированных операцией, или
                               для получения списка сгенерированных идентификаторов для добавленных
                               документов.


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

<comment>Param:</comment>
  <info>string</info>  <strong>$id</strong>   Идентификатор фильтра. Если идентификатор или любое другое поле с уникальным
                индексом уже существует в коллекции, он обновит соответствующий документ.
                
                По умолчанию этот идентификатор автоматически генерируется MySQL Server при
                добавлении записи и упоминается, как поле с именем '_id'.
  <info>string</info>  <strong>$doc</strong>  Это документ для добавления или замены, представляющий собой строку JSON.

<comment>Return:</comment>
  <info>mysql_xdevapi\Result</info>  Объект Result.


id: Collection::count
type: function
doc:
<comment>Description:</comment>
  Получает количество документов
  
  Функционал аналогичен операции SQL <return>SELECT COUNT(*)</return> на сервере MySQL для текущей схемы и коллекции.
  Другими словами, метод подсчитывает количество документов в коллекции.

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


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

<comment>Param:</comment>
  <info>string</info>  <strong>$index_name</strong>       Имя индекса, который нужно создать. Должно быть корректным именем
                            индекса, допустимым для SQL-запроса <return>CREATE INDEX</return>.
  <info>string</info>  <strong>$index_desc_json</strong>  Определение индекса для создания. Содержит массив объектов IndexField, и
                            каждый объект описывает один элемент документа для добавления в индекс,
                            а также необязательную строку для типа индекса, который может быть INDEX
                            (по умолчанию) или SPATIAL.
                            
                            Одно описание IndexField состоит из следующих полей:
                            
                            field: строка, полный путь документа к элементу документа или полю для
                            индексации.
                            
                            type: строка, один из поддерживаемых типов столбцов SQL для
                            сопоставления поля. Для числовых типов может быть добавлено
                            необязательное ключевое слово UNSIGNED. Для типа TEXT может быть
                            добавлена длина, учитываемая для индексации.
                            
                            required: булево, (необязательное) true, если поле должно быть
                            обязательным в документе. По умолчанию используется значение <info>false</info>, за
                            исключением типа <return>GEOJSON</return>, где по умолчанию используется значение <info>true</info>.
                            
                            options: целое число, (необязательное) флаги специальных опций для
                            использования при декодировании данных <return>GEOJSON</return>.
                            
                            srid: целое число, (необязательное) значение srid для использования при
                            декодировании данных <return>GEOJSON</return>.
                            
                            Ошибочно включать другие поля, не описанные выше, в документы
                            IndexDefinition или IndexField.

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


id: Collection::dropIndex
type: function
doc:
<comment>Description:</comment>
  Удаляет индекс коллекции
  
  Удаляет индекс коллекции.
  
  Данная операция не приведёт к возникновению ошибки, если индекс не существует, но в этом случае
  вернётся <info>false</info>.

<comment>Param:</comment>
  <info>string</info>  <strong>$index_name</strong>  Имя индекса коллекции для удаления.

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


id: Collection::existsInDatabase
type: function
doc:
<comment>Description:</comment>
  Проверяет, существует ли коллекция в базе данных
  
  Проверяет, ссылается ли объект Collection на коллекцию в базе данных (схему).

<comment>Return:</comment>
  <info>bool</info>  Возвращает <info>true</info> если коллекция существует в базе данных, иначе <info>false</info> если это не так.
        
        Таблица, определённая двумя столбцами (doc и _id), считается коллекцией, и третьим столбцом
        _json_schema с MySQL 8.0.21. Добавление дополнительного столбца означает, что
        existsInDatabase() больше не будет видеть его как коллекцию.


id: Collection::find
type: function
doc:
<comment>Description:</comment>
  Ищет документ
  
  Ищет документ или набор документов в коллекции базы данных. Найденные документы возвращаются в
  виде объекта CollectionFind, из которого в дальнейшем можно извлекать результаты или изменять их.

<comment>Param:</comment>
  <info>string</info>  <strong>$search_condition</strong>  Хотя это необязательно, обычно определяется условие, сужающее
                             результаты до подмножества документов.
                             
                             Условие могут составлять несколько элементов, синтаксис поддерживает
                             привязку параметров. Выражение, используемое в качестве условия поиска,
                             должно быть допустимым выражением SQL. Если условие поиска не указано
                             (поле пустое), подразумевается find('true').

<comment>Return:</comment>
  <info>mysql_xdevapi\CollectionFind</info>  Объект CollectionFind для проверки операции или получения найденных
                                документов.


id: Collection::getName
type: function
doc:
<comment>Description:</comment>
  Получает название коллекции
  
  Получает название коллекции.

<comment>Return:</comment>
  <info>string</info>  Название коллекции в виде строки.


id: Collection::getOne
type: function
doc:
<comment>Description:</comment>
  Получает один документ
  
  Выбирает один документ из коллекции.
  
  Это краткая запись для: Collection.find("_id = :id").bind("id", id).execute().fetchOne();

<comment>Param:</comment>
  <info>string</info>  <strong>$id</strong>  _id документа в коллекции.

<comment>Return:</comment>
  <info>Document</info>  Объект коллекции или <info>null</info>, если _id не соответствует документу.


id: Collection::getSchema
type: function
doc:
<comment>Description:</comment>
  Возвращает объект Schema
  
  Возвращает объект Schema, содержащий коллекцию.

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


id: Collection::getSession
type: function
doc:
<comment>Description:</comment>
  Возвращает объект Session
  
  Возвращает новый объект Session из объекта Collection.

<comment>Return:</comment>
  <info>Session</info>  Объект Session.


id: Collection::modify
type: function
doc:
<comment>Description:</comment>
  Изменяет документы коллекции
  
  Изменяет коллекции, соответствующие определённым условиям поиска. Разрешены несколько операций,
  поддерживается привязка параметров.

<comment>Param:</comment>
  <info>string</info>  <strong>$search_condition</strong>  Параметр должен быть допустимым выражением SQL, используемым для
                             соответствия документам, которые нужно изменить. Это выражение может
                             быть простым значением <info>true</info>, что соответствует всем документам, или
                             может использовать функции и операторы, такие как 'CAST(_id AS SIGNED)
                             &gt;= 10', 'age MOD 2 = 0 OR age MOD 3 = 0' или '_id IN
                             ["2","5","7","10"]'.

<comment>Return:</comment>
  <info>mysql_xdevapi\CollectionModify</info>  Если операция не выполнена, функция вернёт объект Modify, который
                                  можно использовать для добавления дополнительных операций MODIFY.
                                  
                                  Если операция MODIFY выполнена, то возвращаемый объект будет
                                  содержать результат операции.


id: Collection::remove
type: function
doc:
<comment>Description:</comment>
  Удаляет документы коллекции
  
  Удаляет коллекции, которые соответствуют определённым условиям поиска. Допускается несколько
  операций и поддерживается привязка параметров.

<comment>Param:</comment>
  <info>string</info>  <strong>$search_condition</strong>  Должно быть корректным выражением SQL, используемым для сопоставления
                             документов, которые нужно изменить. Выражение может быть таким же
                             простым, как <info>true</info>, которое соответствует всем документам, или оно может
                             использовать функции и операторы, такие как 'CAST(_id AS SIGNED) &gt;=
                             10', 'age MOD 2 = 0 OR age MOD 3 = 0', или '_id IN ["2","5","7","10"]'.

<comment>Return:</comment>
  <info>mysql_xdevapi\CollectionRemove</info>  Если операция не выполнена, функция вернёт объект Remove, который
                                  можно использовать для добавления дополнительных операций
                                  удаления.
                                  
                                  Если операция удаления выполнена, то возвращённый объект будет
                                  содержать результат операции.


id: Collection::removeOne
type: function
doc:
<comment>Description:</comment>
  Удаляет один документ из коллекции
  
  Удаляет один документ из коллекции с соответствующим идентификатором. Сокращённая запись для
  Collection.remove("_id = :id").bind("id", id).execute().

<comment>Param:</comment>
  <info>string</info>  <strong>$id</strong>  Идентификатор документа коллекции, который нужно удалить. Обычно это _id, который был
               сгенерирован MySQL Server при добавлении записи.

<comment>Return:</comment>
  <info>mysql_xdevapi\Result</info>  Объект Result, который можно использовать для запроса количества затронутых
                        элементов или количества предупреждений, сгенерированных операцией.


id: Collection::replaceOne
type: function
doc:
<comment>Description:</comment>
  Заменяет один документ коллекции
  
  Обновляет (или заменяет) документ, по идентификатору, если он существует.

<comment>Param:</comment>
  <info>string</info>  <strong>$id</strong>   Идентификатор документа для замены или обновления. Обычно это _id, который был
                сгенерирован MySQL Server при добавлении записи.
  <info>string</info>  <strong>$doc</strong>  Документ коллекции для обновления или замены документа, соответствующего параметру
                id.
                
                Документ может быть либо объектом документа, либо корректной строкой JSON,
                описывающей новый документ.

<comment>Return:</comment>
  <info>mysql_xdevapi\Result</info>  Объект Result, который можно использовать для запроса количества затронутых
                        элементов и количества предупреждений, сгенерированных операцией.


id: CollectionAdd::__construct
type: function
doc:
<comment>Description:</comment>
  Конструктор класса CollectionAdd
  
  Используется для добавления документа в коллекцию; вызывается из объекта Collection.


id: CollectionAdd::execute
type: function
doc:
<comment>Description:</comment>
  Выполняет утверждение
  
  Метод execute необходим для отправки запроса операции CRUD на сервер MySQL.

<comment>Return:</comment>
  <info>mysql_xdevapi\Result</info>  Объект Result, который можно использовать для проверки состояния операции,
                        например, количества затронутых строк.


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


id: CollectionFind::bind
type: function
doc:
<comment>Description:</comment>
  Привязывает значение к заполнителю запроса
  
  Позволяет пользователю привязать параметр к заполнителю в условии поиска операции поиска.
  Заполнитель имеет вид :NAME, где ':' - это общий префикс, который должен всегда существовать перед
  любым NAME, NAME - фактическое имя заполнителя. Функция bind принимает список заполнителей, если в
  условии поиска необходимо заменить несколько объектов.

<comment>Param:</comment>
  <info>array</info>  <strong>$placeholder_values</strong>  Значения для подстановки в условиях поиска; допускается несколько
                              значений, которые передаются в виде массива, где "PLACEHOLDER_NAME
                              =&gt; PLACEHOLDER_VALUE".

<comment>Return:</comment>
  <info>mysql_xdevapi\CollectionFind</info>  Объект CollectionFind, или цепочка с execute() для возврата объекта
                                Result.


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

<comment>Return:</comment>
  <info>mysql_xdevapi\DocResult</info>  Возвращает объект класса <class>mysql_xdevapi\DocResult</class>, из которого можно либо
                           получить результаты, либо запросить состояние операции.


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

<comment>Param:</comment>
  <info>string</info>  <strong>$projection</strong>  Может быть либо одной строкой, либо массивом строк, определяющих столбцы,
                       которые нужно вернуть для каждого документа, который соответствует условию
                       поиска.

<comment>Return:</comment>
  <info>mysql_xdevapi\CollectionFind</info>  Возвращает объект класса CollectionFind, который можно использовать
                                для дальнейшей обработки.


id: CollectionFind::groupBy
type: function
doc:
<comment>Description:</comment>
  Устанавливает критерии группировки
  
  Эту функцию вызывают для группировки набора результатов по одному или нескольким столбцам. Её
  часто вызывают с агрегатными функциями, например: <return>COUNT</return>, <return>MAX</return>, <return>MIN</return>, <return>SUM</return> и т. д.

<comment>Param:</comment>
  <info>string</info>  <strong>$sort_expr</strong>  Столбец или столбцы, по которым будет проведена операция группировки, это
                      может быть либо одна строка, либо массив строковых аргументов, по одному для
                      каждого столбца.

<comment>Return:</comment>
  <info>mysql_xdevapi\CollectionFind</info>  Возвращает объект класса CollectionFind, с которым можно будет
                                работать далее.


id: CollectionFind::having
type: function
doc:
<comment>Description:</comment>
  Устанавливает условие для агрегатных функций
  
  Функция может использоваться после операции 'field', чтобы сделать выборку документов для
  извлечения.

<comment>Param:</comment>
  <info>string</info>  <strong>$sort_expr</strong>  Должно быть корректное выражение SQL, разрешено использование агрегатных
                      функций.

<comment>Return:</comment>
  <info>mysql_xdevapi\CollectionFind</info>  Объект CollectionFind, который можно использовать для дальнейшей
                                обработки.


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

<comment>Param:</comment>
  <info>int</info>  <strong>$rows</strong>  Максимальное количество документов.

<comment>Return:</comment>
  <info>mysql_xdevapi\CollectionFind</info>  Объект CollectionFind, который можно использовать для дополнительной
                                обработки; цепочка с методом execute() для возврата объекта
                                DocResult.


id: CollectionFind::lockExclusive
type: function
doc:
<comment>Description:</comment>
  Выполняет операцию с EXCLUSIVE LOCK
  
  Накладывает на документ исключительную блокировку. До тех пор, пока документ заблокирован, другие
  транзакции не могут обновлять документ, выполнять выражения SELECT ... LOCK IN SHARE MODE или
  читать данные на отдельных уровнях изоляции транзакций. Согласованные чтения игнорируют любые
  блокировки, установленные для записей, которые существуют в представлении чтения.
  
  Чтобы не было проблем с конкурентным доступом, имеет ссмысл вызывать этот метод совместно с
  методом mysql_xdevapi\Collection::modify. По существу, эта функция использует блокировки строк для
  сериализации доступа к строкам.

<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\CollectionFind</info>  Возвращает объект класса CollectionFind, с которым можно будет
                                работать далее.


id: CollectionFind::lockShared
type: function
doc:
<comment>Description:</comment>
  Выполняет операцию с 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\CollectionFind</info>  Возвращает объект класса CollectionFind, с которым можно будет
                                работать далее.


id: CollectionFind::offset
type: function
doc:
<comment>Description:</comment>
  Пропускает указанное количество возвращаемых элементов
  
  Пропускает (смещает) это количество элементов, которые в противном случае были бы возвращены
  операцией поиска. Используйте совместно с методом limit().
  
  При значении, превышающем размер набора результатов, приводит к пустому набору.

<comment>Param:</comment>
  <info>int</info>  <strong>$position</strong>  Количество элементов, которые нужно пропустить для операции limit().

<comment>Return:</comment>
  <info>mysql_xdevapi\CollectionFind</info>  Объект CollectionFind, который можно использовать для дополнительной
                                обработки.


id: CollectionFind::sort
type: function
doc:
<comment>Description:</comment>
  Устанавливает критерии сортировки
  
  Сортирует набор результатов по полю, выбранному в аргументе sort_expr. Разрешённые направления:
  ASC (по возрастанию) или DESC (по убыванию). Операция эквивалентна операции SQL 'ORDER BY' и
  соответствует тому же набору правил.

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

<comment>Return:</comment>
  <info>mysql_xdevapi\CollectionFind</info>  Объект CollectionFind, который можно использовать для выполнения
                                команды или для добавления дополнительных операций.


id: CollectionModify::__construct
type: function
doc:
<comment>Description:</comment>
  Конструктор класса CollectionModify
  
  Изменяет (обновляет) коллекцию и создаётся методом mysql_xdevapi\Collection::modify.


id: CollectionModify::arrayAppend
type: function
doc:
<comment>Description:</comment>
  Добавляет элемент в поле массива
  
  Добавляет элемент в поле документа, когда несколько элементов поля представляются в виде массива.
  В отличие от arrayInsert(), arrayAppend() всегда добавляет новый элемент в конец массива, тогда
  как arrayInsert() может определять местоположение.

<comment>Param:</comment>
  <info>string</info>  <strong>$collection_field</strong>       Идентификатор поля, в которое вставляется новый элемент.
  <info>string</info>  <strong>$expression_or_literal</strong>  Новый элемент для добавления в конец массива полей документа.

<comment>Return:</comment>
  <info>mysql_xdevapi\CollectionModify</info>  Объект CollectionModify, который можно использовать для выполнения
                                  команды или для добавления дополнительных операций.


id: CollectionModify::arrayInsert
type: function
doc:
<comment>Description:</comment>
  Добавляет элемент в поле массива
  
  Добавляет элемент в поле документа, когда поле — это массив из нескольких элементов. Через этот
  метод, в отличие от метода mysql_xdevapi\CollectionModify::arrayAppend, можно указать, куда
  добавится новый элемент, определяя, после какого элемента он будет идти, тогда как метод
  mysql_xdevapi\CollectionModify::arrayAppend добавляет новый элемент в конец массива.

<comment>Param:</comment>
  <info>string</info>  <strong>$collection_field</strong>       Определите элемент в массиве, после которого добавится новый
                                  элемент. Формат этого параметра: <return>FIELD_NAME[ INDEX ]</return>, где
                                  FIELD_NAME — это имя поля документа, в которое нужно добавить
                                  элемент, а INDEX — это INDEX элемента в поле.
                                  
                                  Поле INDEX основано на нуле, поэтому у первого элемента массива
                                  индекс — 0.
  <info>string</info>  <strong>$expression_or_literal</strong>  Новый элемент для добавления после FIELD_NAME[ INDEX ]

<comment>Return:</comment>
  <info>mysql_xdevapi\CollectionModify</info>  Объект CollectionModify, который можно использовать для выполнения
                                  команды или для добавления дополнительных операций.


id: CollectionModify::bind
type: function
doc:
<comment>Description:</comment>
  Привязывает значение к заполнителю запроса
  
  Привязывает параметр к заполнителю в условии поиска операции изменения.
  
  Заполнитель имеет вид :NAME, где ':' - это общий префикс, который должен всегда существовать до
  любого NAME, где NAME - это имя заполнителя. Метод bind принимает список заполнителей, если в
  условии поиска операции изменения необходимо заменить несколько объектов.

<comment>Param:</comment>
  <info>array</info>  <strong>$placeholder_values</strong>  Подстановочные значения для замены в условии поиска. Допускается
                              использование нескольких значений, которые необходимо передать в виде
                              массива сопоставлений PLACEHOLDER_NAME-&gt;PLACEHOLDER_VALUE.

<comment>Return:</comment>
  <info>mysql_xdevapi\CollectionModify</info>  Объект CollectionModify, который можно использовать для выполнения
                                  команды или для добавления дополнительных операций.


id: CollectionModify::execute
type: function
doc:
<comment>Description:</comment>
  Выполняет операцию изменения
  
  Метод execute необходим для отправки запроса операции CRUD на сервер MySQL.

<comment>Return:</comment>
  <info>mysql_xdevapi\Result</info>  Объект Result, который можно использовать для проверки состояния операции,
                        например, количества затронутых строк.


id: CollectionModify::limit
type: function
doc:
<comment>Description:</comment>
  Ограничивает количество изменяемых документов
  
  Ограничивает количество документов, изменяемых этой операцией. При желании можно использовать
  skip() для определения значения смещения.

<comment>Param:</comment>
  <info>int</info>  <strong>$rows</strong>  Максимальное количество документов для изменения.

<comment>Return:</comment>
  <info>mysql_xdevapi\CollectionModify</info>  Объект CollectionModify.


id: CollectionModify::patch
type: function
doc:
<comment>Description:</comment>
  Исправляет документ
  
  Принимает объект исправления и применяет его к одному или нескольким документам, и может обновлять
  несколько свойств документа.

<comment>Param:</comment>
  <info>string</info>  <strong>$document</strong>  Документ со свойствами, применяемыми к соответствующим документам.

<comment>Return:</comment>
  <info>mysql_xdevapi\CollectionModify</info>  Объект CollectionModify.


id: CollectionModify::replace
type: function
doc:
<comment>Description:</comment>
  Заменяет поле документа
  
  Заменяет (обновляет) данное значение поля новым.

<comment>Param:</comment>
  <info>string</info>  <strong>$collection_field</strong>       Путь документа к элементу для обновления.
  <info>string</info>  <strong>$expression_or_literal</strong>  Значение, устанавливаемое для указанного атрибута.

<comment>Return:</comment>
  <info>mysql_xdevapi\CollectionModify</info>  Объект CollectionModify.


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

<comment>Param:</comment>
  <info>string</info>  <strong>$collection_field</strong>       Путь к документу (имя) элемента для установки.
  <info>string</info>  <strong>$expression_or_literal</strong>  Значение для установки.

<comment>Return:</comment>
  <info>mysql_xdevapi\CollectionModify</info>  Объект CollectionModify.


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

<comment>Param:</comment>
  <info>int</info>  <strong>$position</strong>  Количество пропускаемых элементов.

<comment>Return:</comment>
  <info>mysql_xdevapi\CollectionModify</info>  Возвращает объект класса CollectionModify, с которым можно
                                  работать далее.


id: CollectionModify::sort
type: function
doc:
<comment>Description:</comment>
  Устанавливает критерии сортировки
  
  Сортирует набор результатов по полю, переданному в аргументе sort_expr. Разрешённые направления
  сортировки: ASC (по возрастанию) или DESC (по убыванию). Эта операция эквивалентна операции SQL
  'ORDER BY' и соответствует тому же набору правил.
  
  К настоящему времени эта функция ещё не была документирована; для ознакомления доступен только
  список аргументов.

<comment>Param:</comment>
  <info>string</info>  <strong>$sort_expr</strong>  Можно указать одно или несколько выражений сортировки. Оценка выполняется
                      слева направо, а выражения должны быть разделены запятой.

<comment>Return:</comment>
  <info>mysql_xdevapi\CollectionModify</info>  Возвращает объект класса CollectionModify, с которым можно
                                  работать далее.


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

<comment>Param:</comment>
  <info>array</info>  <strong>$fields</strong>  Атрибуты для удаления из документов в коллекции.

<comment>Return:</comment>
  <info>mysql_xdevapi\CollectionModify</info>  Возвращает объект класса CollectionModify, с которым можно
                                  работать далее.


id: CollectionRemove::__construct
type: function
doc:
<comment>Description:</comment>
  Конструктор класса CollectionRemove
  
  Удаляет документы коллекции и создаётся экземпляром метода Collection::remove().


id: CollectionRemove::bind
type: function
doc:
<comment>Description:</comment>
  Привязывает значение к заполнителю
  
  Привязывает параметр к заполнителю в условии поиска операции удаления.
  
  Заполнитель имеет вид :NAME, где ':' - это общий префикс, который должен всегда указан перед любым
  NAME, где NAME - это имя заполнителя. Метод bind принимает список заполнителей, если в условии
  поиска операции удаления необходимо заменить несколько объектов.
  
  К настоящему времени эта функция ещё не была документирована; для ознакомления доступен только
  список аргументов.

<comment>Param:</comment>
  <info>array</info>  <strong>$placeholder_values</strong>  Значения заполнителя для замены в условии поиска. Допускается
                              использование нескольких значений, которые необходимо передать в виде
                              массива сопоставлений PLACEHOLDER_NAME-&gt;PLACEHOLDER_VALUE.

<comment>Return:</comment>
  <info>mysql_xdevapi\CollectionRemove</info>  Объект CollectionRemove, который можно использовать для выполнения
                                  команды или для добавления дополнительных операций.


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

<comment>Return:</comment>
  <info>mysql_xdevapi\Result</info>  Объект Result.


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

<comment>Param:</comment>
  <info>int</info>  <strong>$rows</strong>  Максимальное количество документов для удаления.

<comment>Return:</comment>
  <info>mysql_xdevapi\CollectionRemove</info>  Возвращает объект CollectionRemove, который можно использовать для
                                  выполнения команды или для добавления дополнительных операций.


id: CollectionRemove::sort
type: function
doc:
<comment>Description:</comment>
  Устанавливает критерии сортировки
  
  Сортирует набор результатов по полю, выбранному в аргументе sort_expr. Разрешённые направления:
  ASC (по возрастанию) или DESC (по убыванию). Эта операция эквивалентна операции SQL 'ORDER BY' и
  соответствует тому же набору правил.
  
  К настоящему времени эта функция ещё не была документирована; для ознакомления доступен только
  список аргументов.

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

<comment>Return:</comment>
  <info>mysql_xdevapi\CollectionRemove</info>  Объект CollectionRemove, который можно использовать для выполнения
                                  команды или для добавления дополнительных операций.


id: ColumnResult::__construct
type: function
doc:
<comment>Description:</comment>
  Конструктор класса ColumnResult
  
  Получает метаданные столбца, такие как набор символов; создаётся методом RowResult::getColumns().


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

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


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

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


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

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


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

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


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

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


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

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


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

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


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

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


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

<comment>Return:</comment>
  <info>string</info>  Имя таблицы для столбца.


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

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


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

<comment>Return:</comment>
  <info>int</info>  <info>true</info>, если данный тип столбца является подписанным.


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

<comment>Return:</comment>
  <info>int</info>  <info>true</info>, если заданный столбец дополняется.


id: CommonMark\CQL
type: class
doc:
<comment>Description:</comment>
  CommonMark Query Language - это DSL для описания того, как проходить через дерево узлов
  CommonMark, реализованное в виде синтаксического анализатора и компилятора для небольшого набора
  инструкций, и виртуальной машины для выполнения этих инструкций.
  
  В наиболее упрощённой форме запрос CQL объединяет следующие пути и <return>/</return>, чтобы описать, как
  перемещаться по дереву: firstChildlastChildpreviousnextparent Например, <return>/firstChild/lastChild</return>
  будет перемещаться к последнему дочернему узлу первого дочернего узла.
  
  В CQL может быть задан цикл, например, через дочерние элементы или дочерние элементы к
  определённому узлу с использованием пути <return>children</return> или <return>siblings</return>. Например, <return>/firstChild/children</return>
  будет перемещаться по всем дочерним элементам первого дочернего узла.
  
  CQL можно проинструктировать, как перемещаться, используя подзапрос, такой как <return>[/firstChild]</return>.
  Например, <return>/firstChild/children[/firstChild]</return> перейдёт к первому дочернему узлу всех дочерних узлов
  первого дочернего узла.
  
  Во время цикла CQL может быть проинструктирован ограничивать пройденный путь до узлов
  определённого типа. Например, <return>/children(BlockQuote)</return> будет перемещаться к дочерним элементам узла,
  где типом является <return>BlockQuote</return>. Следующие типы распознаются (без учёта регистра):
  BlockQuoteListItemCodeBlockHtmlBlockCustomBlockParagraphHeadingThematicBreakTextSoftBreakLineBreakCodeHtmlInlineCustomInlineEmphasisStrongLinkImage
  Типы могут использоваться как объединение, например, <return>/children(BlockQuote|List)</return> будет перемещаться
  к дочерним элементам узла, где типом является <return>BlockQuote</return> или <return>List</return>. Типы или объединения типов,
  также могут быть отменены. Например, <return>/children(~BlockQuote)</return> будет перемещаться к дочерним
  элементам узла, где тип не является <return>BlockQuote</return>, а <return>/children(~BlockQuote|Paragraph)</return> будет
  перемещаться к дочерним узлам, где тип не является <return>BlockQuote</return> или <return>Paragraph</return>.
  
  CQL можно поручить создать цикл для перемещения к узлу определённого типа по определённому пути.
  Например, <return>/firstChild(BlockQuote)</return> перейдёт к первому дочернему узлу с типом <return>BlockQuote</return>. Обратите
  внимание, что как и другие циклы, для <return>children</return> и <return>siblings</return>, этот тип пути может сопровождаться
  только подзапросом.
  
  Хотя CQL реализован как часть модуля PHP CommonMark, он стоит отдельно от PHP и не использует
  виртуальную машину PHP или внутреннее представление значений.


id: CommonMark\CQL::__construct
type: function
doc:
<comment>Description:</comment>
  Конструктор класса CQL

<comment>Param:</comment>
  <info>string</info>  <strong>$query</strong>  Строка CQL


id: CommonMark\CQL::__invoke
type: function
doc:
<comment>Description:</comment>
  Выполнение CQL
  
  Должен вызывать текущую функцию CQL в указанном <strong>$root</strong>, выполняя указанный <strong>$handler</strong> при входе в
  <info>CommonMark\Node</info>.

<comment>Param:</comment>
  <info>CommonMark\Node</info>  <strong>$root</strong>     корневой узел дерева
  <info>callable</info>         <strong>$handler</strong>  должен иметь прототип:
                             <info>bool</info><info>null</info></info>handler<info>CommonMark\Node</info><strong>$root</strong><info>CommonMark\Node</info><strong>$entering</strong> Если
                             <strong>$handler</strong> ничего не возвращает (void) или возвращает <info>null</info>, CQL продолжит
                             выполнениеЕсли обработчик вернёт истинное значение, CQL продолжит
                             выполнениеЕсли обработчик возвращает ложное значение, CQL прекратит
                             выполнение


id: CommonMark\Interfaces\IVisitable::accept
type: function
doc:
<comment>Description:</comment>
  Visitation

<comment>Param:</comment>
  <info>CommonMark\Interfaces\IVisitor</info>  <strong>$visitor</strong>  Объект, реализующий <class>CommonMark\Interfaces\IVisitor</class>

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

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


id: CommonMark\Interfaces\IVisitor::enter
type: function
doc:
<comment>Description:</comment>
  Посещение

<comment>Param:</comment>
  <info>IVisitable</info>  <strong>$visitable</strong>  Текущий входимый <class>CommonMark\Interfaces\IVisitable</class>.

<comment>Return:</comment>
  <info>int|IVisitable|null</info>  Возврат CommonMark\Interfaces\IVisitor::Done приведёт к выходу
                       вспомогательного итератора.
                       
                       Возврат CommonMark\Interfaces\IVisitor::Enter сбросит вспомогательный
                       итератор при входе в текущий <class>IVisitable</class>.
                       
                       Возврат CommonMark\Interfaces\IVisitor::Leave сбросит вспомогательный
                       итератор при выходе из текущего <class>IVisitable</class>.
                       
                       Возврат <class>IVisitable</class> сбросит вспомогательный итератор при входе в данный
                       <class>IVisitable</class>.
                       
                       Если ничего не возвращается, вспомогательный итератор продолжит работу.

<comment>See Also:</comment>
   * 


id: CommonMark\Interfaces\IVisitor::leave
type: function
doc:
<comment>Description:</comment>
  Посещение

<comment>Param:</comment>
  <info>IVisitable</info>  <strong>$visitable</strong>  Текущий покидаемый <class>CommonMark\Interfaces\IVisitable</class>.

<comment>Return:</comment>
  <info>int|IVisitable|null</info>  Возврат CommonMark\Interfaces\IVisitor::Done приведёт к выходу
                       вспомогательного итератора.
                       
                       Возврат CommonMark\Interfaces\IVisitor::Enter сбросит вспомогательный
                       итератор при входе в текущий <class>IVisitable</class>.
                       
                       Возврат CommonMark\Interfaces\IVisitor::Leave сбросит вспомогательный
                       итератор при выходе из текущего <class>IVisitable</class>.
                       
                       Возврат <class>IVisitable</class> сбросит вспомогательный итератор при выходе из данного
                       <class>IVisitable</class>.
                       
                       Если ничего не возвращается, вспомогательный итератор продолжит работу.

<comment>See Also:</comment>
   * 


id: CommonMark\Node
type: class
doc:
<comment>Description:</comment>
  Представляет абстрактный узел, не предназначенный для непосредственного использования
  программистом.


id: CommonMark\Node::appendChild
type: function
doc:
<comment>Description:</comment>
  Манипуляции с AST (Абстрактное синтаксическое дерево)
  
  К настоящему времени эта функция ещё не была документирована; для ознакомления доступен только
  список аргументов.

<comment>Param:</comment>
  <info>CommonMark\Node</info>  <strong>$child</strong>  

<comment>Return:</comment>
  <info>CommonMark\Node</info>  


id: CommonMark\Node::insertAfter
type: function
doc:
<comment>Description:</comment>
  Манипуляции с AST (Абстрактное синтаксическое дерево)
  
  К настоящему времени эта функция ещё не была документирована; для ознакомления доступен только
  список аргументов.

<comment>Param:</comment>
  <info>CommonMark\Node</info>  <strong>$sibling</strong>  

<comment>Return:</comment>
  <info>CommonMark\Node</info>  


id: CommonMark\Node::replace
type: function
doc:
<comment>Description:</comment>
  Манипуляции с AST (Абстрактное синтаксическое дерево)
  
  К настоящему времени эта функция ещё не была документирована; для ознакомления доступен только
  список аргументов.

<comment>Param:</comment>
  <info>CommonMark\Node</info>  <strong>$target</strong>  

<comment>Return:</comment>
  <info>CommonMark\Node</info>  


id: CommonMark\Node::unlink
type: function
doc:
<comment>Description:</comment>
  Манипуляции с AST (Абстрактное синтаксическое дерево)
  
  К настоящему времени эта функция ещё не была документирована; для ознакомления доступен только
  список аргументов.

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


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


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

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


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


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

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


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

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


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

<comment>Param:</comment>
  <info>int</info>  <strong>$tight</strong>      
  <info>int</info>  <strong>$delimiter</strong>  
  <info>int</info>  <strong>$start</strong>      


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

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


id: CommonMark\Parse
type: function
doc:
<comment>Description:</comment>
  Разбор
  
  Разбирает <strong>$content</strong>

<comment>Param:</comment>
  <info>string</info>  <strong>$content</strong>  Строка markdown
  <info>int</info>     <strong>$options</strong>  Маска из:

<comment>Return:</comment>
  <info>CommonMark\Node</info>  Вернёт корневой (root) узел CommonMark\Node


id: CommonMark\Parser
type: class
doc:
<comment>Description:</comment>
  Предоставляет инкрементный синтаксический анализатор в качестве альтернативы простой функции API
  синтаксического анализа


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

<comment>Param:</comment>
  <info>int</info>  <strong>$options</strong>  Маска из:


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

<comment>Return:</comment>
  <info>CommonMark\Node</info>  


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

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

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


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

<comment>Param:</comment>
  <info>CommonMark\Node</info>  <strong>$node</strong>     
  <info>int</info>              <strong>$options</strong>  Маска из:
  <info>int</info>              <strong>$width</strong>    

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


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

<comment>Param:</comment>
  <info>CommonMark\Node</info>  <strong>$node</strong>     
  <info>int</info>              <strong>$options</strong>  Маска из:

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


id: Componere\Abstract\Definition
type: class
doc:
<comment>Description:</comment>
  Окончательный абстрактный класс представляет собой структуру класса и не должен использоваться
  программистом.


id: Componere\Abstract\Definition::addInterface
type: function
doc:
<comment>Description:</comment>
  Добавляет интерфейс
  
  Реализует данный интерфейс по текущему определению

<comment>Param:</comment>
  <info>string</info>  <strong>$interface</strong>  Имя интерфейса без учёта регистра

<comment>Return:</comment>
  <info>Definition</info>  The current Definition


id: Componere\Abstract\Definition::addMethod
type: function
doc:
<comment>Description:</comment>
  Добавляет метод
  
  Должен создать или переопределить метод в текущем определении.

<comment>Param:</comment>
  <info>string</info>            <strong>$name</strong>    Нечувствительное к регистру имя метода
  <info>Componere\Method</info>  <strong>$method</strong>  <info>Componere\Method</info> ранее не добавленный к другому <info>Definition</info>

<comment>Return:</comment>
  <info>Definition</info>  The current Definition


id: Componere\Abstract\Definition::addTrait
type: function
doc:
<comment>Description:</comment>
  Добавляет трейт
  
  Использовать данный трейт для текущего определения

<comment>Param:</comment>
  <info>string</info>  <strong>$trait</strong>  Нечувствительное к регистру имя трейта

<comment>Return:</comment>
  <info>Definition</info>  The current Definition


id: Componere\Abstract\Definition::getReflector
type: function
doc:
<comment>Description:</comment>
  Reflection
  
  Должен создать или вернуть ReflectionClass

<comment>Return:</comment>
  <info>ReflectionClass</info>  ReflectionClass для текущего определения (кешируется)


id: Componere\Definition
type: class
doc:
<comment>Description:</comment>
  Класс Definition позволяет программисту создавать и регистрировать тип во время выполнения.
  
  Если Definition заменит существующий класс, существующий класс будет восстановлен после
  уничтожения Definition.


id: Componere\Definition::__construct
type: function
doc:
<comment>Description:</comment>
  Определение конструктора

<comment>Param:</comment>
  <info>string</info>  <strong>$name</strong>        Регистронезависимое имя класса
  <info>string</info>  <strong>$parent</strong>      Регистронезависимое имя класса
  <info>array</info>   <strong>$interfaces</strong>  Массив регистронезависимых имён классов


id: Componere\Definition::addConstant
type: function
doc:
<comment>Description:</comment>
  Добавляет константу
  
  Должен объявить константу класса в текущем определении

<comment>Param:</comment>
  <info>string</info>           <strong>$name</strong>   Регистронезависимое имя константы
  <info>Componere\Value</info>  <strong>$value</strong>  Значение для константы не должно быть неопределённым (undefined) или
                           статичным

<comment>Return:</comment>
  <info>Definition</info>  Текущее определение


id: Componere\Definition::addProperty
type: function
doc:
<comment>Description:</comment>
  Добавляет свойство
  
  Должен объявить свойство класса в текущем определении

<comment>Param:</comment>
  <info>string</info>           <strong>$name</strong>   Регистронезависимое имя свойства
  <info>Componere\Value</info>  <strong>$value</strong>  Значение свойства по умолчанию

<comment>Return:</comment>
  <info>Definition</info>  Текущее определение


id: Componere\Definition::getClosure
type: function
doc:
<comment>Description:</comment>
  Получает замыкание
  
  Должен вернуть замыкание для указанного метода

<comment>Param:</comment>
  <info>string</info>  <strong>$name</strong>  Регистронезависимое имя метода

<comment>Return:</comment>
  <info>Closure</info>  Замыкание, привязанное к корректной области


id: Componere\Definition::getClosures
type: function
doc:
<comment>Description:</comment>
  Получает замыкание
  
  Возвращает массив замыканий

<comment>Return:</comment>
  <info>array</info>  Возвращает все методы в виде массива объектов Closure, привязанных к корректной области


id: Componere\Definition::isRegistered
type: function
doc:
<comment>Description:</comment>
  Определение состояния
  
  Определяет состояние регистрации этого определения

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


id: Componere\Definition::register
type: function
doc:
<comment>Description:</comment>
  Регистрация
  
  Регистрирует текущее определение

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


id: Componere\Method::__construct
type: function
doc:
<comment>Description:</comment>
  Конструктор класса Method

<comment>Param:</comment>
  <info>Closure</info>  <strong>$closure</strong>  


id: Componere\Method::getReflector
type: function
doc:
<comment>Description:</comment>
  Reflection
  
  Должен создать и вернуть ReflectionMethod

<comment>Return:</comment>
  <info>ReflectionMethod</info>  ReflectionMethod для текущего метода (кешируется)


id: Componere\Method::setPrivate
type: function
doc:
<comment>Description:</comment>
  Изменение доступности

<comment>Return:</comment>
  <info>Method</info>  Текущий метод


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


id: Componere\Patch::__construct
type: function
doc:
<comment>Description:</comment>
  Конструктор класса Patch

<comment>Param:</comment>
  <info>object</info>  <strong>$instance</strong>    Назначение для этого патча
  <info>array</info>   <strong>$interfaces</strong>  Регистронезависимый массив имён классов


id: Componere\Patch::apply
type: function
doc:
<comment>Description:</comment>
  Приложение
  
  Применяет текущий патч

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


id: Componere\Patch::derive
type: function
doc:
<comment>Description:</comment>
  Получение патча
  
  Должен получить <info>Patch</info> для заданного экземпляра <strong>$instance</strong>

<comment>Param:</comment>
  <info>object</info>  <strong>$instance</strong>  Назначение для полученного патча

<comment>Return:</comment>
  <info>Patch</info>  <info>Patch</info> для <strong>$instance</strong> получается из текущего <info>Patch</info>


id: Componere\Patch::getClosure
type: function
doc:
<comment>Description:</comment>
  Получает замыкание
  
  Должен вернуть замыкание для указанного метода

<comment>Param:</comment>
  <info>string</info>  <strong>$name</strong>  Регистронезависимое имя метода

<comment>Return:</comment>
  <info>Closure</info>  Замыкание, привязанное к правильной области и объекту


id: Componere\Patch::getClosures
type: function
doc:
<comment>Description:</comment>
  Получает замыкания
  
  Должен вернуть массив замыканий

<comment>Return:</comment>
  <info>array</info>  Должен вернуть все методы в виде массива объектов Closure, привязанных к правильной области
         и объекту


id: Componere\Patch::isApplied
type: function
doc:
<comment>Description:</comment>
  Определение состояния

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


id: Componere\Patch::revert
type: function
doc:
<comment>Description:</comment>
  Отмена
  
  Отменяет текущий патч

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


id: Componere\Value
type: class
doc:
<comment>Description:</comment>
  Value представляет переменную PHP всех типов, включая неопределённую (undefined)


id: Componere\Value::__construct
type: function
doc:
<comment>Description:</comment>
  Конструктор класса Value

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


id: Componere\Value::hasDefault
type: function
doc:
<comment>Description:</comment>
  Взаимодействие с классом Value

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


id: Componere\Value::isPrivate
type: function
doc:
<comment>Description:</comment>
  Определение доступности

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


id: Componere\Value::setPrivate
type: function
doc:
<comment>Description:</comment>
  Изменение доступности

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


id: Componere\cast
type: function
doc:
<comment>Description:</comment>
  Приведение к типу

<comment>Param:</comment>
  <info>Type</info>  <strong>$type</strong>    Пользовательский тип
  <info></info>      <strong>$object</strong>  Объект с пользовательским типом, совместимый с Type

<comment>Return:</comment>
  <info>Type</info>  <info>object</info> типа Type, приведённый из <strong>$object</strong>

<comment>See Also:</comment>
   * 


id: Componere\cast_by_ref
type: function
doc:
<comment>Description:</comment>
  Приведение к типу

<comment>Param:</comment>
  <info></info>  <strong>$object</strong>  Объект с пользовательским типом, совместимым с Type

<comment>Return:</comment>
  <info>Type</info>  <info>object</info> типа Type, приведённый из <strong>$object</strong>, где элементы являются ссылками на элементы <strong>$object</strong>

<comment>See Also:</comment>
   * 


id: Countable
type: class
doc:
<comment>Description:</comment>
  Классы, реализующие интерфейс <class>Countable</class>, могут быть использованы с функцией <strong>count()</strong>.


id: Countable::count
type: function
doc:
<comment>Description:</comment>
  Количество элементов объекта
  
  Этот метод выполняется при использовании <strong>count()</strong> на объекте, реализующем интерфейс <class>Countable</class>.

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


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

<comment>Param:</comment>
  <info>array</info>  <strong>$placeholder_values</strong>  Имя заполнителей и значения для привязки.

<comment>Return:</comment>
  <info>mysql_xdevapi\CrudOperationBindable</info>  Объект CrudOperationBindable.


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

<comment>Param:</comment>
  <info>int</info>  <strong>$rows</strong>  Максимальное количество записей или документов.

<comment>Return:</comment>
  <info>mysql_xdevapi\CrudOperationLimitable</info>  Объект CrudOperationLimitable.


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

<comment>Param:</comment>
  <info>int</info>  <strong>$skip</strong>  Количество пропускаемых элементов.

<comment>Return:</comment>
  <info>mysql_xdevapi\CrudOperationSkippable</info>  Объект CrudOperationSkippable.


id: CrudOperationSortable::sort
type: function
doc:
<comment>Description:</comment>
  Сортирует результаты
  
  Сортирует результирующий набор по полю, выбранному в аргументе sort_expr. Допустимый порядок
  сортировки: ASC (по возрастанию) или DESC (по убыванию). Эта операция эквивалентна операции SQL
  'ORDER BY' и следует тому же набору правил.
  
  К настоящему времени эта функция ещё не была документирована; для ознакомления доступен только
  список аргументов.

<comment>Param:</comment>
  <info>string</info>  <strong>$sort_expr</strong>  Может быть предоставлено одно или несколько выражений сортировки. Вычисление
                      выполняется слева направо, и каждое выражение разделяется запятой.

<comment>Return:</comment>
  <info>mysql_xdevapi\CrudOperationSortable</info>  Объект CrudOperationSortable.


id: CurlHandle
type: class
doc:
<comment>Description:</comment>
  Полностью непрозрачный класс, заменяющий ресурсы <return>curl</return> в PHP 8.0.0.


id: CurlMultiHandle
type: class
doc:
<comment>Description:</comment>
  Полностью непрозрачный класс, заменяющий ресурсы <return>curl_multi</return> в PHP 8.0.0.


id: CurlShareHandle
type: class
doc:
<comment>Description:</comment>
  Полностью непрозрачный класс, заменяющий ресурсы <return>curl_share</return> в PHP 8.0.0.


id: DATE_ISO8601
type: constant
doc:
<comment>Description:</comment>
  ISO-8601 (пример: 2005-08-15T15:52:01+0000)
  
  Этот формат не совместим с ISO-8601, но остаётся для обратной совместимости. Вместо него
  используйте <info>DateTimeInterface::ISO8601_EXPANDED</info> или <info>DateTimeInterface::ATOM</info> для совместимости с
  ISO-8601. (ссылка на ISO8601:2004 раздел 4.3.3 пункт d)


id: DATE_ISO8601_EXPANDED
type: constant
doc:
<comment>Description:</comment>
  ISO-8601 Expanded (пример: +10191-07-26T08:59:52+01:00)
  
  Формат позволяет использовать диапазоны годов, выходящие за пределы обычного диапазона ISO-8601
  (<return>0000</return>-<return>9999</return>), всегда включая символ знака. Он также учитывает, что часть часового пояса (<return>+01:00</return>)
  совместима с ISO-8601.


id: DATE_RFC7231
type: constant
doc:
<comment>Description:</comment>
  RFC 7231 (с версии PHP 7.0.19 и 7.1.5) (пример: Sat, 30 Apr 2016 17:52:13 GMT)


id: DB2_AUTOCOMMIT_OFF
type: constant
doc:
<comment>Description:</comment>
  Указывает, что необходимо отключить режим автоподтверждения транзакции.


id: DB2_AUTOCOMMIT_ON
type: constant
doc:
<comment>Description:</comment>
  Указывает, что необходимо включить режим автоподтверждения транзакции.


id: DB2_BINARY
type: constant
doc:
<comment>Description:</comment>
  Указывает, что бинарные данные должны быть возвращены как есть. Этот режим используется по
  умолчанию.


id: DB2_CASE_LOWER
type: constant
doc:
<comment>Description:</comment>
  Указывает, что имена столбцов должны возвращаться в нижнем регистре.


id: DB2_CASE_NATURAL
type: constant
doc:
<comment>Description:</comment>
  Указывает, что имена столбцов должны возвращаться как есть, без изменения регистра символов.


id: DB2_CASE_UPPER
type: constant
doc:
<comment>Description:</comment>
  Указывает, что имена столбцов должны возвращаться в верхнем регистре.


id: DB2_CHAR
type: constant
doc:
<comment>Description:</comment>
  Указывает, что переменная должна быть связана как тип данных CHAR или VARCHAR.


id: DB2_CONVERT
type: constant
doc:
<comment>Description:</comment>
  Указывает, что бинарные данные должны конвертироваться в шестнадцатеричный формат и возвращаться
  как строка ASCII.


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


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


id: DB2_DOUBLE
type: constant
doc:
<comment>Description:</comment>
  Указывает, что переменная должна быть связана как тип данных DOUBLE, FLOAT или REAL.


id: DB2_FORWARD_ONLY
type: constant
doc:
<comment>Description:</comment>
  Курсор "forward-only" - только вперёд. Используется по умолчанию и поддерживается всеми серверами
  баз данных.


id: DB2_LONG
type: constant
doc:
<comment>Description:</comment>
  Указывает, что переменная должна быть связана как тип данных SMALLINT, INTEGER или BIGINT.


id: DB2_PARAM_FILE
type: constant
doc:
<comment>Description:</comment>
  Указывает, что столбец должен быть привязан непосредственно к файлу для ввода.


id: DB2_PARAM_IN
type: constant
doc:
<comment>Description:</comment>
  Указанная переменная PHP должна быть привязана как параметр IN для хранимой процедуры.


id: DB2_PARAM_INOUT
type: constant
doc:
<comment>Description:</comment>
  Указанная переменная PHP должна быть привязана как параметр INOUT для хранимой процедуры.


id: DB2_PARAM_OUT
type: constant
doc:
<comment>Description:</comment>
  Указанная переменная PHP должна быть привязана как параметр OUT для хранимой процедуры.


id: DB2_PASSTHRU
type: constant
doc:
<comment>Description:</comment>
  Указывает, что бинарные данные должны быть конвертированы в <info>null</info>.


id: DB2_SCROLLABLE
type: constant
doc:
<comment>Description:</comment>
  Курсор "scrollable" - перематываемый. Этот режим разрешает случайный доступ к строкам в
  результирующем наборе, но в данный момент поддерживается только для IBM DB2 Universal Database.


id: DBASE_RDONLY
type: constant
doc:
<comment>Description:</comment>
  Открыть базу данных только для чтения. Используется с <strong>dbase_open()</strong>. (Доступно с dbase 7.0.0)


id: DBASE_RDWR
type: constant
doc:
<comment>Description:</comment>
  Открыть базу данных для чтения и записи. Используется с <strong>dbase_open()</strong>. (Доступно с 7.0.0)


id: DBASE_TYPE_DBASE
type: constant
doc:
<comment>Description:</comment>
  Создать базу данных типа dBASE. Используется с  <strong>dbase_create()</strong>. (Доступно с 7.0.0)


id: DBASE_TYPE_FOXPRO
type: constant
doc:
<comment>Description:</comment>
  Создать базу данных типа FoxPro. Используется с  <strong>dbase_create()</strong>. (Доступно с 7.0.0)


id: DBA_LMDB_NO_SUB_DIR
type: constant
doc:
<comment>Description:</comment>
  Флаг LMDB Driver, запрещающий создание подкаталога для файлов базы данных. Доступно, начиная с PHP
  8.2.0.


id: DBA_LMDB_USE_SUB_DIR
type: constant
doc:
<comment>Description:</comment>
  Флаг LMDB Driver, разрешающий создание подкаталога для файлов базы данных. Доступно, начиная с PHP
  8.2.0.


id: DISP_E_BADINDEX
type: constant
doc:
<comment>Description:</comment>
  -2147352565
  
  Ошибка, означающая, что индекс массива не существует.
  
  Начиная с PHP 7.0.0, значение равно <return>2147614731</return> в x64.


id: DISP_E_DIVBYZERO
type: constant
doc:
<comment>Description:</comment>
  -2147352558
  
  Ответ означающий попытку деления на ноль.
  
  Начиная с PHP 7.0.0, значение равно <return>2147614738</return> в x64.


id: DISP_E_OVERFLOW
type: constant
doc:
<comment>Description:</comment>
  -2147352566
  
  Ошибка означающая, что значение не может быть приведено к ожидаемому типу.
  
  Начиная с PHP 7.0.0, значение равно <return>2147614730</return> в x64.


id: DNS_ALL
type: constant
doc:
<comment>Description:</comment>
  Итеративно опрашивает DNS сервер по каждому доступному типу записи.


id: DNS_ANY
type: constant
doc:
<comment>Description:</comment>
  Любая ресурсная запись.  На большинстве систем возвращает все ресурсные записи, однако для
  использования в критических условиях не подходит. Вместо этого необходимо использовать <info>DNS_ALL</info>


id: DNS_CAA
type: constant
doc:
<comment>Description:</comment>
  Ресурсная запись Authority Authorization Resource (доступно с PHP 7.0.16 и с 7.1.2)


id: DNS_HINFO
type: constant
doc:
<comment>Description:</comment>
  Ресурс Host Info (Смотрите <return>IANA Названия операционных систем</return> для получения расшифровки значений)


id: DOMAttr
type: class
doc:
<comment>Description:</comment>
  <class>DOMAttr</class> предоставляет атрибут в объекте <class>DOMElement</class>.


id: DOMAttr::__construct
type: function
doc:
<comment>Description:</comment>
  Создаёт экземпляр класса DOMAttr
    
  
  Создаёт новый объект класса DOMAttr. Этот объект будет доступен только для чтения. Он может быть
  добавлен к документу, но дополнительные узлы нельзя добавить к этому узлу, пока он присоединён к
  документу. Для создания узла с возможностью модификации используйте .

<comment>Param:</comment>
  <info>string</info>  <strong>$name</strong>   Имя тега атрибута.
  <info>string</info>  <strong>$value</strong>  Значение атрибута.

<comment>See Also:</comment>
   * DOMDocument::createAttribute


id: DOMAttr::isId
type: function
doc:
<comment>Description:</comment>
  Проверяет, является ли атрибут определённым идентификатором
    
  
  Эта функция проверяет, является ли определённым идентификатором.
  
  В соответствии со стандартом DOM для этого требуется DTD, который определяет идентификатор
  атрибута быть идентификатором типа. Перед использованием этой функции необходимо проверять
  документ на действительность с помощью  или <return>DOMDocument::validateOnParse</return>.

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


id: DOMCdataSection
type: class
doc:
<comment>Description:</comment>
  Класс <class>DOMCdataSection</class> наследуется от <class>DOMText</class> для текстового представления конструкций CData.


id: DOMCdataSection::__construct
type: function
doc:
<comment>Description:</comment>
  Создаёт новый экземпляр класса DOMCdataSection
    
  
  Создаёт новый узел CDATA. Работает как класс <class>DOMText</class>.

<comment>Param:</comment>
  <info>string</info>  <strong>$data</strong>  Значение узла CDATA. Если не указано, создаётся пустой узел CDATA.

<comment>See Also:</comment>
   * DOMText::__construct
   * DOMDocument::createTextNode


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


id: DOMCharacterData::after
type: function
doc:
<comment>Description:</comment>
  Adds nodes after the character data
  
  Adds the passed <strong>$nodes</strong> after the element.

<comment>Param:</comment>
  <info>DOMNode|string</info>  <strong>$nodes</strong>  Узлы, которые необходимо добавить после узла. Строки автоматически
                          преобразуются в текстовые узлы.

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

<comment>See Also:</comment>
   * DOMChildNode::after
   * DOMCharacterData::before


id: DOMCharacterData::appendData
type: function
doc:
<comment>Description:</comment>
  Добавить строку в конец символьных данных узла
    
  
  Добавить строку <strong>$data</strong> в конец символьных данных узла.

<comment>Param:</comment>
  <info>string</info>  <strong>$data</strong>  Добавляемая строка.

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

<comment>See Also:</comment>
   * DOMCharacterData::deleteData
   * DOMCharacterData::insertData
   * DOMCharacterData::replaceData
   * DOMCharacterData::substringData


id: DOMCharacterData::before
type: function
doc:
<comment>Description:</comment>
  Adds nodes before the node
  
  Adds the passed <strong>$nodes</strong> before the node.

<comment>Param:</comment>
  <info>DOMNode|string</info>  <strong>$nodes</strong>  Узлы, которые необходимо добавить перед узлом. Строки автоматически
                          преобразуются в текстовые узлы.

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

<comment>See Also:</comment>
   * DOMChildNode::before
   * DOMCharacterData::after


id: DOMCharacterData::deleteData
type: function
doc:
<comment>Description:</comment>
  Удалить диапазон символов из узла
    
  
  Удаляет <strong>$count</strong> символов, начиная с позиции <strong>$offset</strong>.

<comment>Param:</comment>
  <info>int</info>  <strong>$offset</strong>  Позиция, с которой будут удаляться символы.
  <info>int</info>  <strong>$count</strong>   Количество удаляемых символов. Если <strong>$offset</strong> и <strong>$count</strong> в сумме окажется больше
                значения длины, будут удалены все символы до конца данных.

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

<comment>See Also:</comment>
   * DOMCharacterData::appendData
   * DOMCharacterData::insertData
   * DOMCharacterData::replaceData
   * DOMCharacterData::substringData


id: DOMCharacterData::insertData
type: function
doc:
<comment>Description:</comment>
  Вставить строку в указанную 16-битную позицию
    
  
  Вставляет строку <strong>$data</strong> в позицию <strong>$offset</strong>.

<comment>Param:</comment>
  <info>int</info>     <strong>$offset</strong>  Позиция символа, начиная с которого будет вставлена строка.
  <info>string</info>  <strong>$data</strong>    Вставляемая строка.

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

<comment>See Also:</comment>
   * DOMCharacterData::appendData
   * DOMCharacterData::deleteData
   * DOMCharacterData::replaceData
   * DOMCharacterData::substringData


id: DOMCharacterData::remove
type: function
doc:
<comment>Description:</comment>
  Removes the character data
  
  Removes the character data.

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

<comment>See Also:</comment>
   * DOMChildNode::remove
   * DOMCharacterData::after
   * DOMCharacterData::before
   * DOMCharacterData::replaceWith
   * DOMNode::removeChild


id: DOMCharacterData::replaceData
type: function
doc:
<comment>Description:</comment>
  Заменить подстроку в узле типа DOMCharacterData
    
  
  Заменяет <strong>$count</strong> символов, начиная с позиции <strong>$offset</strong>, на строку <strong>$data</strong>.

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

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

<comment>See Also:</comment>
   * DOMCharacterData::appendData
   * DOMCharacterData::deleteData
   * DOMCharacterData::insertData
   * DOMCharacterData::substringData


id: DOMCharacterData::replaceWith
type: function
doc:
<comment>Description:</comment>
  Replaces the character data with new nodes
  
  Replaces the character data with new <strong>$nodes</strong>.

<comment>Param:</comment>
  <info>DOMNode|string</info>  <strong>$nodes</strong>  Узлы, которыми необходимо заменить узел.

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

<comment>See Also:</comment>
   * DOMChildNode::replaceWith
   * DOMCharacterData::after
   * DOMCharacterData::before
   * DOMCharacterData::remove


id: DOMCharacterData::substringData
type: function
doc:
<comment>Description:</comment>
  Извлекает определённый диапазон данных из узла
    
  
  Возвращает указанную подстроку.

<comment>Param:</comment>
  <info>int</info>  <strong>$offset</strong>  Начало позиции извлекаемой подстроки.
  <info>int</info>  <strong>$count</strong>   Количество извлекаемых символов.

<comment>Return:</comment>
  <info>string|false</info>  Указанная подстрока. Если <strong>$offset</strong> и <strong>$count</strong> в сумме превышают длину строки данных
                узла, будут извлечены все символы до конца строки.

<comment>See Also:</comment>
   * DOMCharacterData::appendData
   * DOMCharacterData::deleteData
   * DOMCharacterData::insertData
   * DOMCharacterData::replaceData


id: DOMChildNode::after
type: function
doc:
<comment>Description:</comment>
  Добавляет узлы после узла
  
  Добавляет переданные <strong>$nodes</strong> после узла.

<comment>Param:</comment>
  <info>DOMNode|string</info>  <strong>$nodes</strong>  Узлы, которые необходимо добавить после узла. Строки автоматически
                          преобразуются в текстовые узлы.

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

<comment>See Also:</comment>
   * DOMChildNode::before
   * DOMChildNode::remove
   * DOMChildNode::replaceWith
   * DOMNode::appendChild


id: DOMChildNode::before
type: function
doc:
<comment>Description:</comment>
  Добавляет узлы перед узлом
  
  Добавляет переданные <strong>$nodes</strong> перед узлом.

<comment>Param:</comment>
  <info>DOMNode|string</info>  <strong>$nodes</strong>  Узлы, которые необходимо добавить перед узлом. Строки автоматически
                          преобразуются в текстовые узлы.

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

<comment>See Also:</comment>
   * DOMChildNode::after
   * DOMChildNode::remove
   * DOMChildNode::replaceWith


id: DOMChildNode::remove
type: function
doc:
<comment>Description:</comment>
  Удаляет узел
  
  Удаляет узел.

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

<comment>See Also:</comment>
   * DOMChildNode::after
   * DOMChildNode::before
   * DOMChildNode::replaceWith
   * DOMNode::removeChild


id: DOMChildNode::replaceWith
type: function
doc:
<comment>Description:</comment>
  Заменяет узел новыми узлами
  
  Заменяет узел новыми переданными <strong>$nodes</strong>. Сочетание метода DOMChildNode::remove и
  DOMChildNode::append.

<comment>Param:</comment>
  <info>DOMNode|string</info>  <strong>$nodes</strong>  Узлы, которыми необходимо заменить узел.

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

<comment>See Also:</comment>
   * DOMChildNode::after
   * DOMChildNode::before
   * DOMChildNode::remove
   * DOMNode::replaceChild


id: DOMComment
type: class
doc:
<comment>Description:</comment>
  Представляет узлы комментариев, символы, помеченные \<!-- и --&gt;.


id: DOMComment::__construct
type: function
doc:
<comment>Description:</comment>
  Создаёт новый экземпляр класса DOMComment
    
  
  Создаёт новый объект класса <class>DOMComment</class>. Объект будет доступен только для чтения. Его можно
  добавить к документу, но дополнительные узлы нельзя добавлять к объекту, пока он не будет
  присоединён к документу. Чтобы создать записываемый узел, используйте .

<comment>Param:</comment>
  <info>string</info>  <strong>$data</strong>  Значение комментария.

<comment>See Also:</comment>
   * DOMDocument::createComment


id: DOMDocument
type: class
doc:
<comment>Description:</comment>
  Представляет все содержимое HTML- или XML-документа; служит корнем дерева документа.


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

<comment>Param:</comment>
  <info>string</info>  <strong>$version</strong>   Номер версии документа как часть объявления XML.
  <info>string</info>  <strong>$encoding</strong>  Кодировка документа как часть объявления XML.

<comment>See Also:</comment>
   * DOMImplementation::createDocument


id: DOMDocument::adoptNode
type: function
doc:
<comment>Description:</comment>
  Transfer a node from another document
  
  Transfer a node from another document into the current document.

<comment>Param:</comment>
  <info>DOMNode</info>  <strong>$node</strong>  The node to transfer.

<comment>Return:</comment>
  <info>DOMNode|false</info>  The node that was transfered, or <info>false</info> on error.

<comment>See Also:</comment>
   * DOMDocument::importNode


id: DOMDocument::append
type: function
doc:
<comment>Description:</comment>
  Appends nodes after the last child node
  
  Appends one or many <strong>$nodes</strong> to the list of children after the last child node.

<comment>Param:</comment>
  <info>DOMNode|string</info>  <strong>$nodes</strong>  Узлы, которые необходимо добавить. Строки автоматически преобразуются в
                          текстовые узлы.

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

<comment>See Also:</comment>
   * DOMParentNode::append
   * DOMDocument::prepend


id: DOMDocument::createAttribute
type: function
doc:
<comment>Description:</comment>
  Создать новый атрибут
  
  Эта функция создаёт новый объект класса <class>DOMAttr</class>. Этот узел не будет отображаться в документе до
  тех пор,
  пока он не будет вставлен, например, функцией <strong>DOMNode::appendChild()</strong>.

<comment>Param:</comment>
  <info>string</info>  <strong>$localName</strong>  Имя атрибута.

<comment>Return:</comment>
  <info>DOMAttr|false</info>  Новый объект <class>DOMAttr</class> либо <info>false</info> в случае возникновения ошибки.

<comment>See Also:</comment>
   * DOMNode::appendChild
   * DOMDocument::createAttributeNS
   * DOMDocument::createCDATASection
   * DOMDocument::createComment
   * DOMDocument::createDocumentFragment
   * DOMDocument::createElement
   * DOMDocument::createElementNS
   * DOMDocument::createEntityReference
   * DOMDocument::createProcessingInstruction
   * DOMDocument::createTextNode


id: DOMDocument::createAttributeNS
type: function
doc:
<comment>Description:</comment>
  Создаёт новый атрибут узла с соответствующим пространством имён
    
  
  Эта функция создаёт новый объект класса <class>DOMAttr</class>. Этот узел не будет отображаться в документе до
  тех пор,
  пока он не будет вставлен, например, функцией <strong>DOMNode::appendChild()</strong>.

<comment>Param:</comment>
  <info>string|null</info>  <strong>$namespace</strong>      URI пространства имён.
  <info>string</info>       <strong>$qualifiedName</strong>  Имя и префикс атрибута в виде <return>prefix:tagname</return>.

<comment>Return:</comment>
  <info>DOMAttr|false</info>  Новый экземпляр класса <class>DOMAttr</class> или <info>false</info> в случае ошибки.

<comment>See Also:</comment>
   * DOMNode::appendChild
   * DOMDocument::createAttribute
   * DOMDocument::createCDATASection
   * DOMDocument::createComment
   * DOMDocument::createDocumentFragment
   * DOMDocument::createElement
   * DOMDocument::createElementNS
   * DOMDocument::createEntityReference
   * DOMDocument::createProcessingInstruction
   * DOMDocument::createTextNode


id: DOMDocument::createCDATASection
type: function
doc:
<comment>Description:</comment>
  Создаёт новый узел cdata
    
  
  Эта функция создаёт новый объект класса <class>DOMCDATASection</class>. Этот узел не будет отображаться в
  документе до тех пор,
  пока он не будет вставлен, например, функцией <strong>DOMNode::appendChild()</strong>.

<comment>Param:</comment>
  <info>string</info>  <strong>$data</strong>  Содержимое cdata.

<comment>Return:</comment>
  <info>DOMCdataSection|false</info>  Новый объект класса <class>DOMCDATASection</class> или <info>false</info> в случае возникновения
                         ошибки.

<comment>See Also:</comment>
   * DOMNode::appendChild
   * DOMDocument::createAttribute
   * DOMDocument::createAttributeNS
   * DOMDocument::createComment
   * DOMDocument::createDocumentFragment
   * DOMDocument::createElement
   * DOMDocument::createElementNS
   * DOMDocument::createEntityReference
   * DOMDocument::createProcessingInstruction
   * DOMDocument::createTextNode


id: DOMDocument::createComment
type: function
doc:
<comment>Description:</comment>
  Создать новый узел комментария
    
  
  Эта функция создаёт новый экземпляр класса <class>DOMComment</class>. Этот узел не будет отображаться в документе
  до тех пор,
  пока он не будет вставлен, например, функцией <strong>DOMNode::appendChild()</strong>.

<comment>Param:</comment>
  <info>string</info>  <strong>$data</strong>  Содержимое комментария.

<comment>Return:</comment>
  <info>DOMComment</info>  Новый объект класса <class>DOMComment</class>.

<comment>See Also:</comment>
   * DOMNode::appendChild
   * DOMDocument::createAttribute
   * DOMDocument::createAttributeNS
   * DOMDocument::createCDATASection
   * DOMDocument::createDocumentFragment
   * DOMDocument::createElement
   * DOMDocument::createElementNS
   * DOMDocument::createEntityReference
   * DOMDocument::createProcessingInstruction
   * DOMDocument::createTextNode


id: DOMDocument::createDocumentFragment
type: function
doc:
<comment>Description:</comment>
  Создать новый фрагмент документа
    
  
  Эта функция создаёт новый экземпляр класса <class>DOMDocumentFragment</class>. Этот узел не будет отображаться в
  документе до тех пор,
  пока он не будет вставлен, например, функцией <strong>DOMNode::appendChild()</strong>.

<comment>Return:</comment>
  <info>DOMDocumentFragment</info>  Новый объект класса <class>DOMDocumentFragment</class>.

<comment>See Also:</comment>
   * DOMNode::appendChild
   * DOMDocument::createAttribute
   * DOMDocument::createAttributeNS
   * DOMDocument::createCDATASection
   * DOMDocument::createComment
   * DOMDocument::createElement
   * DOMDocument::createElementNS
   * DOMDocument::createEntityReference
   * DOMDocument::createProcessingInstruction
   * DOMDocument::createTextNode


id: DOMDocument::createElement
type: function
doc:
<comment>Description:</comment>
  Создать новый узел элемента
  
  Эта функция создаёт экземпляр класса <class>DOMElement</class>. Этот узел не будет отображаться в документе до
  тех пор,
  пока он не будет вставлен, например, функцией <strong>DOMNode::appendChild()</strong>.

<comment>Param:</comment>
  <info>string</info>  <strong>$localName</strong>  Имя тега элемента.
  <info>string</info>  <strong>$value</strong>      Значение элемента. По умолчанию будет создан пустой элемент. Значение может
                      быть установлено позднее с помощью DOMElement::$nodeValue.
                      
                      Значение используется дословно, за исключением
                      \< и &gt;, которые будут экранированы. Обратите внимание, что & должен быть экранирован самостоятельно, в противном случае он будет рассматриваться как начало ссылки на сущность. Также " не будет экранирован.

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

<comment>See Also:</comment>
   * DOMNode::appendChild
   * DOMDocument::createAttribute
   * DOMDocument::createAttributeNS
   * DOMDocument::createCDATASection
   * DOMDocument::createComment
   * DOMDocument::createDocumentFragment
   * DOMDocument::createElementNS
   * DOMDocument::createEntityReference
   * DOMDocument::createProcessingInstruction
   * DOMDocument::createTextNode


id: DOMDocument::createElementNS
type: function
doc:
<comment>Description:</comment>
  Создать новый узел элемента с соответствующим пространством имён
    
  
  Эта функция создаёт новый узел-элемент с соответствующим пространством имён. Этот узел не будет
  отображаться в документе до тех пор,
  пока он не будет вставлен, например, функцией <strong>DOMNode::appendChild()</strong>.

<comment>Param:</comment>
  <info>string|null</info>  <strong>$namespace</strong>      URI пространства имён.
  <info>string</info>       <strong>$qualifiedName</strong>  Квалифицированное имя элемента в виде <return>prefix:tagname</return>.
  <info>string</info>       <strong>$value</strong>          Значение элемента. По умолчанию будет создан пустой элемент. Задать
                               значение также можно позднее с помощью DOMElement::$nodeValue.

<comment>Return:</comment>
  <info>DOMElement|false</info>  Новый объект класса <class>DOMElement</class> или <info>false</info> в случае возникновения ошибки.

<comment>See Also:</comment>
   * DOMNode::appendChild
   * DOMDocument::createAttribute
   * DOMDocument::createAttributeNS
   * DOMDocument::createCDATASection
   * DOMDocument::createComment
   * DOMDocument::createDocumentFragment
   * DOMDocument::createElement
   * DOMDocument::createEntityReference
   * DOMDocument::createProcessingInstruction
   * DOMDocument::createTextNode


id: DOMDocument::createEntityReference
type: function
doc:
<comment>Description:</comment>
  Создать новый узел ссылки на сущность
    
  
  Эта функция создаёт экземпляр класса <class>DOMEntityReference</class>. Этот узел не будет отображаться в
  документе до тех пор,
  пока он не будет вставлен, например, функцией <strong>DOMNode::appendChild()</strong>.

<comment>Param:</comment>
  <info>string</info>  <strong>$name</strong>  Содержимое ссылки на сущность, например, ссылка на сущность без <return>&</return> в начале и <return>;</return> в
                 конце.

<comment>Return:</comment>
  <info>DOMEntityReference|false</info>  Новый объект класса <class>DOMEntityReference</class> или <info>false</info> в случае возникновения
                            ошибки.

<comment>See Also:</comment>
   * DOMNode::appendChild
   * DOMDocument::createAttribute
   * DOMDocument::createAttributeNS
   * DOMDocument::createCDATASection
   * DOMDocument::createComment
   * DOMDocument::createDocumentFragment
   * DOMDocument::createElement
   * DOMDocument::createElementNS
   * DOMDocument::createProcessingInstruction
   * DOMDocument::createTextNode


id: DOMDocument::createProcessingInstruction
type: function
doc:
<comment>Description:</comment>
  Создать новый PI-узел
    
  
  Эта функция создаёт экземпляр класса <class>DOMProcessingInstruction</class>. Этот узел не будет отображаться в
  документе до тех пор,
  пока он не будет вставлен, например, функцией <strong>DOMNode::appendChild()</strong>.

<comment>Param:</comment>
  <info>string</info>  <strong>$target</strong>  Цель инструкции для обработчика документа.
  <info>string</info>  <strong>$data</strong>    Содержимое инструкции обработчика.

<comment>Return:</comment>
  <info>DOMProcessingInstruction|false</info>  Новый объект класса <class>DOMProcessingInstruction</class> либо <info>false</info> в случае
                                  возникновения ошибки.

<comment>See Also:</comment>
   * DOMNode::appendChild
   * DOMDocument::createAttribute
   * DOMDocument::createAttributeNS
   * DOMDocument::createCDATASection
   * DOMDocument::createComment
   * DOMDocument::createDocumentFragment
   * DOMDocument::createElement
   * DOMDocument::createElementNS
   * DOMDocument::createEntityReference
   * DOMDocument::createTextNode


id: DOMDocument::createTextNode
type: function
doc:
<comment>Description:</comment>
  Создать новый текстовый узел
  
  Эта функция создаёт экземпляр класса <class>DOMText</class>. Этот узел не будет отображаться в документе до тех
  пор,
  пока он не будет вставлен, например, функцией <strong>DOMNode::appendChild()</strong>.

<comment>Param:</comment>
  <info>string</info>  <strong>$data</strong>  Содержимое узла.

<comment>Return:</comment>
  <info>DOMText</info>  Возвращает новый объект класса <class>DOMText</class>.

<comment>See Also:</comment>
   * DOMNode::appendChild
   * DOMDocument::createAttribute
   * DOMDocument::createAttributeNS
   * DOMDocument::createCDATASection
   * DOMDocument::createComment
   * DOMDocument::createDocumentFragment
   * DOMDocument::createElement
   * DOMDocument::createElementNS
   * DOMDocument::createEntityReference
   * DOMDocument::createProcessingInstruction


id: DOMDocument::getElementById
type: function
doc:
<comment>Description:</comment>
  Ищет элемент с определённым идентификатором
    
  
  Эта функция похожа на , но ищет элемент с заданным идентификатором.
  
  Для работы этой функции необходимо установить атрибуты идентификаторов с помощью , либо DTD,
  который определяет атрибут идентификатора типа. В последнем случае перед использованием этой
  функции вам необходимо будет проверить документ с помощью  или DOMDocument::$validateOnParse.

<comment>Param:</comment>
  <info>string</info>  <strong>$elementId</strong>  Уникальный значение идентификатора элемента.

<comment>Return:</comment>
  <info>DOMElement|null</info>  Возвращает объект <class>DOMElement</class> или <info>null</info>, если элемент не найден.

<comment>See Also:</comment>
   * DOMDocument::getElementsByTagName


id: DOMDocument::getElementsByTagName
type: function
doc:
<comment>Description:</comment>
  Ищет все элементы с заданным локальным именем
    
  
  Эта функция возвращает новый объект класса <class>DOMNodeList</class>, содержащий элементы с заданным локальным
  именем.

<comment>Param:</comment>
  <info>string</info>  <strong>$qualifiedName</strong>  Локальное имя (без пространства имён) тега, по которому будет проводиться
                          поиск. Специальное значение <return>*</return> соответствует всем тегам.

<comment>Return:</comment>
  <info>DOMNodeList</info>  Новый объект класса <class>DOMNodeList</class>, содержащий все найденные элементы.

<comment>See Also:</comment>
   * DOMDocument::getElementsByTagNameNS


id: DOMDocument::getElementsByTagNameNS
type: function
doc:
<comment>Description:</comment>
  Ищет все элементы с заданным именем в указанном пространстве имён
    
  
  Возвращает объект <class>DOMNodeList</class> со всеми элементами с заданным локальным именем и URI пространства
  имён.

<comment>Param:</comment>
  <info>string|null</info>  <strong>$namespace</strong>  URI пространства имён. Специальное значение <return>"*"</return> соответствует всем
                           пространствам имён. Передача <info>null</info> соответствует пустому пространству
                           имён.
  <info>string</info>       <strong>$localName</strong>  Локальное имя искомых элементов. Специальное значение <return>"*"</return> соответствует
                           всем локальным именам.

<comment>Return:</comment>
  <info>DOMNodeList</info>  Новый объект класса <class>DOMNodeList</class>, содержащий все найденные элементы.

<comment>See Also:</comment>
   * DOMDocument::getElementsByTagName


id: DOMDocument::importNode
type: function
doc:
<comment>Description:</comment>
  Импортировать узел в текущий документ
    
  
  Эта функция возвращает копию импортируемого узла и связывает её с текущим документом.

<comment>Param:</comment>
  <info>DOMNode</info>  <strong>$node</strong>  Узел для импорта.
  <info>bool</info>     <strong>$deep</strong>  Если установлено значение <info>true</info>, этот метод будет рекурсивно импортировать
                  поддерево узла <strong>$node</strong>.
                  
                  Чтобы скопировались атрибуты узла, <strong>$deep</strong> должен быть установлен в <info>true</info>.

<comment>Return:</comment>
  <info>DOMNode|false</info>  Скопированный узел или <info>false</info>, если он не может быть скопирован.


id: DOMDocument::load
type: function
doc:
<comment>Description:</comment>
  Загрузка XML из файла
    
  
  Загружает XML-документ из файла.
  
  Пути к файлам в стиле Unix с прямыми слешами могут отрицательно сказаться на работоспособности
  скриптов в среде Windows; используйте функцию <strong>realpath()</strong> для исключения подобных ситуаций.

<comment>Param:</comment>
  <info>string</info>  <strong>$filename</strong>  Путь к XML-документу.
  <info>int</info>     <strong>$options</strong>   Побитовое <return>ИЛИ</return>констант опций libxml.

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

<comment>See Also:</comment>
   * DOMDocument::loadXML
   * DOMDocument::save
   * DOMDocument::saveXML


id: DOMDocument::loadHTML
type: function
doc:
<comment>Description:</comment>
  Загрузка HTML из строки
    
  
  Функция разбирает HTML, содержащийся в строке <strong>$source</strong>. В отличие от загрузки XML, HTML не обязан
  быть правильно построен для загрузки.
  
  Эта функция анализирует входные данные, используя синтаксический анализатор HTML 4. В браузеры
  встроен синтаксический анализатор HTML 5, у которого другие правила анализа. Какая структура DOM
  будет сформирована — зависит от входных данных. Поэтому эту функцию нельзя использовать для
  безопасной очистки HTML.
  
  Например, некоторые HTML-элементы будут неявно закрывать родительский элемент. Правила для
  автоматического закрытия родительских элементов у HTML 4 и HTML 5 разные, поэтому результирующая
  структура DOM, которую видит объект класса <class>DOMDocument</class> может отличаться от структуры DOM, которую
  видит веб-браузер, что дает возможность злоумышленнику сломать результирующий HTML.

<comment>Param:</comment>
  <info>string</info>  <strong>$source</strong>   HTML-строка.
  <info>int</info>     <strong>$options</strong>  Побитовое ИЛИ (<return>OR</return>)констант опций libxml.

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

<comment>See Also:</comment>
   * DOMDocument::loadHTMLFile
   * DOMDocument::saveHTML
   * DOMDocument::saveHTMLFile


id: DOMDocument::loadHTMLFile
type: function
doc:
<comment>Description:</comment>
  Загрузка HTML из файла
    
  
  Функция разбирает HTML-документ из файла <strong>$filename</strong>. В отличие от загрузки XML, HTML не обязан быть
  правильно построен для загрузки.
  
  Эта функция анализирует входные данные, используя синтаксический анализатор HTML 4. В браузеры
  встроен синтаксический анализатор HTML 5, у которого другие правила анализа. Какая структура DOM
  будет сформирована — зависит от входных данных. Поэтому эту функцию нельзя использовать для
  безопасной очистки HTML.
  
  Например, некоторые HTML-элементы будут неявно закрывать родительский элемент. Правила для
  автоматического закрытия родительских элементов у HTML 4 и HTML 5 разные, поэтому результирующая
  структура DOM, которую видит объект класса <class>DOMDocument</class> может отличаться от структуры DOM, которую
  видит веб-браузер, что дает возможность злоумышленнику сломать результирующий HTML.

<comment>Param:</comment>
  <info>string</info>  <strong>$filename</strong>  Путь к HTML-файлу.
  <info>int</info>     <strong>$options</strong>   Побитовое ИЛИ (<return>OR</return>)констант опций libxml.

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

<comment>See Also:</comment>
   * DOMDocument::loadHTML
   * DOMDocument::saveHTML
   * DOMDocument::saveHTMLFile


id: DOMDocument::loadXML
type: function
doc:
<comment>Description:</comment>
  Загрузка XML из строки
    
  
  Загружает XML-документ из строки.

<comment>Param:</comment>
  <info>string</info>  <strong>$source</strong>   Содержащая XML-строка.
  <info>int</info>     <strong>$options</strong>  Побитовое <return>ИЛИ</return>констант опций libxml.

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

<comment>See Also:</comment>
   * DOMDocument::load
   * DOMDocument::save
   * DOMDocument::saveXML


id: DOMDocument::normalizeDocument
type: function
doc:
<comment>Description:</comment>
  Нормализует документ
  
  Этот метод выполняет те же действия, как если бы вы сохранили и затем загрузили документ, приводит
  документ к "нормальной" форме.

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

<comment>See Also:</comment>
   * Спецификация DOM
   * DOMNode::normalize


id: DOMDocument::prepend
type: function
doc:
<comment>Description:</comment>
  Prepends nodes before the first child node
  
  Prepends one or many <strong>$nodes</strong> to the list of children before the first child node.

<comment>Param:</comment>
  <info>DOMNode|string</info>  <strong>$nodes</strong>  Узлы, которые необходимо добавить. Строки автоматически преобразуются в
                          текстовые узлы.

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

<comment>See Also:</comment>
   * DOMParentNode::prepend
   * DOMDocument::append


id: DOMDocument::registerNodeClass
type: function
doc:
<comment>Description:</comment>
  Регистрация расширенного класса, используемого для создания типа базового узла
    
  
  Этот метод позволяет зарегистрировать свой собственный расширенный класс DOM, который будет
  использоваться впоследствии модулем PHP DOM.
  
  Этот метод не является частью стандарта DOM.
  
  Конструктор объектов зарегистрированных классов узлов не вызывается.

<comment>Param:</comment>
  <info>string</info>       <strong>$baseClass</strong>      Класс DOM, который вы хотите расширить. Список таких классов можно
                               увидеть во введении.
  <info>string|null</info>  <strong>$extendedClass</strong>  Имя расширенного класса. Если передать <info>null</info>, будут удалены все ранее
                               зарегистрированные классы, расширяющие базовый класс <strong>$baseClass</strong>.

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


id: DOMDocument::relaxNGValidate
type: function
doc:
<comment>Description:</comment>
  Производит проверку документа на правильность построения посредством relaxNG
    
  
  Производит relaxNG проверку документа, основываясь на заданной схеме RNG.

<comment>Param:</comment>
  <info>string</info>  <strong>$filename</strong>  Файл RNG.

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

<comment>See Also:</comment>
   * DOMDocument::relaxNGValidateSource
   * DOMDocument::schemaValidate
   * DOMDocument::schemaValidateSource
   * DOMDocument::validate


id: DOMDocument::relaxNGValidateSource
type: function
doc:
<comment>Description:</comment>
  Проверяет документ посредством relaxNG
    
  
  Применяет проверку relaxNG документа на соответствие заданному источнику RNG.

<comment>Param:</comment>
  <info>string</info>  <strong>$source</strong>  Строка содержащая RNG-схему.

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

<comment>See Also:</comment>
   * DOMDocument::relaxNGValidate
   * DOMDocument::schemaValidate
   * DOMDocument::schemaValidateSource
   * DOMDocument::validate


id: DOMDocument::replaceChildren
type: function
doc:
<comment>Description:</comment>
  Replace children in document
  
  Replaces the children in the document with new <strong>$nodes</strong>.

<comment>Param:</comment>
  <info>DOMNode|string</info>  <strong>$nodes</strong>  The nodes replacing the children. Strings are automatically converted to
                          text nodes.

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

<comment>See Also:</comment>
   * DOMParentNode::replaceChildren
   * DOMDocument::append
   * DOMDocument::prepend


id: DOMDocument::save
type: function
doc:
<comment>Description:</comment>
  Сохраняет XML-дерево из внутреннего представления в файл
    
  
  Создаёт XML-документ из представления DOM. Эту функцию обычно вызывают после построения нового
  DOM-документа, как показано в примере ниже.

<comment>Param:</comment>
  <info>string</info>  <strong>$filename</strong>  Путь к файлу, в который будет сохранён XML-документ.
  <info>int</info>     <strong>$options</strong>   Дополнительные настройки. На данный момент поддерживается только
                     LIBXML_NOEMPTYTAG.

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

<comment>See Also:</comment>
   * DOMDocument::saveXML
   * DOMDocument::load
   * DOMDocument::loadXML


id: DOMDocument::saveHTML
type: function
doc:
<comment>Description:</comment>
  Сохраняет документ из внутреннего представления в строку, используя
     форматирование HTML
    
  
  Создаёт HTML-документ из представления DOM. Эту функцию обычно вызывают после построения нового
  DOM-документа, как показано в примере ниже.

<comment>Param:</comment>
  <info>DOMNode|null</info>  <strong>$node</strong>  Необязательный аргумент для вывода подмножества документа.

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

<comment>See Also:</comment>
   * DOMDocument::saveHTMLFile
   * DOMDocument::loadHTML
   * DOMDocument::loadHTMLFile


id: DOMDocument::saveHTMLFile
type: function
doc:
<comment>Description:</comment>
  Сохраняет документ из внутреннего представления в файл, используя
     форматирование HTML
    
  
  Создаёт HTML-документ из DOM-представления. Эту функцию обычно вызывают после построения нового
  DOM-документа, как показано в примере ниже.

<comment>Param:</comment>
  <info>string</info>  <strong>$filename</strong>  Путь к файлу, в который сохранится HTML-документ.

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

<comment>See Also:</comment>
   * DOMDocument::saveHTML
   * DOMDocument::loadHTML
   * DOMDocument::loadHTMLFile


id: DOMDocument::saveXML
type: function
doc:
<comment>Description:</comment>
  Сохраняет XML-дерево из внутреннего представления в виде строки
    
  
  Создаёт XML-документ из представления DOM. Эту функцию обычно вызывают после построения нового
  DOM-документа, как показано в примере ниже.

<comment>Param:</comment>
  <info>DOMNode|null</info>  <strong>$node</strong>     Этот аргумент используют для вывода только определённого узла без
                          объявления XML, а не всего документа целиком.
  <info>int</info>           <strong>$options</strong>  Дополнительные настройки. Поддерживаются константы LIBXML_NOEMPTYTAG и
                          LIBXML_NOXMLDECL. До версии PHP 8.3.0 поддерживалась только константа
                          LIBXML_NOEMPTYTAG.

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

<comment>See Also:</comment>
   * DOMDocument::save
   * DOMDocument::load
   * DOMDocument::loadXML


id: DOMDocument::schemaValidate
type: function
doc:
<comment>Description:</comment>
  Проверяет действительность документа, основываясь на заданной схеме. Поддерживается только
  XML-схема 1.0.
    
  
  Проверяет документ на действительность, основываясь на файле схемы.

<comment>Param:</comment>
  <info>string</info>  <strong>$filename</strong>  Путь к файлу со схемой.
  <info>int</info>     <strong>$flags</strong>     Битовая маска флагов проверки схемы Libxml. На данный момент поддерживается
                     только одно значение LIBXML_SCHEMA_CREATE. Параметр доступен, начиная с Libxml
                     2.6.14.

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

<comment>See Also:</comment>
   * DOMDocument::schemaValidateSource
   * DOMDocument::relaxNGValidate
   * DOMDocument::relaxNGValidateSource
   * DOMDocument::validate


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

<comment>Param:</comment>
  <info>string</info>  <strong>$source</strong>  Строка, содержащая схему.
  <info>int</info>     <strong>$flags</strong>   Битовая маска флагов проверки схемы Libxml. На данный момент поддерживается
                   только одно значение LIBXML_SCHEMA_CREATE. Параметр доступен, начиная с Libxml
                   2.6.14.

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

<comment>See Also:</comment>
   * DOMDocument::schemaValidate
   * DOMDocument::relaxNGValidate
   * DOMDocument::relaxNGValidateSource
   * DOMDocument::validate


id: DOMDocument::validate
type: function
doc:
<comment>Description:</comment>
  Проверяет документ на соответствие его DTD
    
  
  Проверяет документ на действительность, основываясь на его DTD.
  
  Также можно использовать свойство <return>validateOnParse</return> класса <class>DOMDocument</class> для выполнения проверки DTD.

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

<comment>See Also:</comment>
   * DOMDocument::schemaValidate
   * DOMDocument::schemaValidateSource
   * DOMDocument::relaxNGValidate
   * DOMDocument::relaxNGValidateSource


id: DOMDocument::xinclude
type: function
doc:
<comment>Description:</comment>
  Проводит вставку XInclude в объекте DOMDocument
    
  
  Этот метод вставляет блоки XInclude в объекте класса DOMDocument.
  
  Из-за того, что libxml2 автоматически разрешает сущности, вызов этого метода приведёт к
  неожидаемым результатам в случае, когда XML-файл содержит прикреплённую схему DTD.

<comment>Param:</comment>
  <info>int</info>  <strong>$options</strong>  Побитовое ИЛИ (<return>OR</return>)констант опций libxml.

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


id: DOMDocumentFragment::append
type: function
doc:
<comment>Description:</comment>
  Appends nodes after the last child node
  
  Appends one or many <strong>$nodes</strong> to the list of children after the last child node.

<comment>Param:</comment>
  <info>DOMNode|string</info>  <strong>$nodes</strong>  Узлы, которые необходимо добавить. Строки автоматически преобразуются в
                          текстовые узлы.

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

<comment>See Also:</comment>
   * DOMParentNode::append
   * DOMDocumentFragment::prepend


id: DOMDocumentFragment::appendXML
type: function
doc:
<comment>Description:</comment>
  Добавление необработанных данных XML
    
  
  Добавляет необработанные XML-данные в объект класса DOMDocumentFragment.
  
  Это метод не является частью стандарта DOM. Он был разработан для упрощения процедуры добавления
  XML DocumentFragment в DOMDocument.
  
  Если вы хотите следовать стандарту, вам нужно будет создать временный DOMDocument с фиктивным
  корнем, а затем пройти по всем узлам потомкам корневого узла XML-документа, чтобы добавить их.

<comment>Param:</comment>
  <info>string</info>  <strong>$data</strong>  XML для добавления.

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


id: DOMDocumentFragment::prepend
type: function
doc:
<comment>Description:</comment>
  Prepends nodes before the first child node
  
  Prepends one or many <strong>$nodes</strong> to the list of children before the first child node.

<comment>Param:</comment>
  <info>DOMNode|string</info>  <strong>$nodes</strong>  Узлы, которые необходимо добавить. Строки автоматически преобразуются в
                          текстовые узлы.

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

<comment>See Also:</comment>
   * DOMParentNode::prepend
   * DOMDocumentFragment::append


id: DOMDocumentFragment::replaceChildren
type: function
doc:
<comment>Description:</comment>
  Replace children in fragment
  
  Replaces the children in the document fragment with new <strong>$nodes</strong>.

<comment>Param:</comment>
  <info>DOMNode|string</info>  <strong>$nodes</strong>  The nodes replacing the children. Strings are automatically converted to
                          text nodes.

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

<comment>See Also:</comment>
   * DOMParentNode::replaceChildren
   * DOMDocumentFragment::append
   * DOMDocumentFragment::prepend


id: DOMDocumentType
type: class
doc:
<comment>Description:</comment>
  Каждый объект <class>DOMDocument</class> имеет атрибут <return>doctype</return>, значение которого либо <info>null</info>, либо объект класса
  <class>DOMDocumentType</class>.


id: DOMElement::__construct
type: function
doc:
<comment>Description:</comment>
  Создаёт новый экземпляр класса DOMElement
    
  
  Создаёт новый объект класса <class>DOMElement</class>. Этот объект доступен только для чтения. Он может быть
  добавлен к документу, но дополнительные узлы в него нельзя добавить, пока узел не будет связан с
  документом. Чтобы создать записываемый узел, используйте  или .

<comment>Param:</comment>
  <info>string</info>       <strong>$qualifiedName</strong>  Имя тега создаваемого элемента. Если также передаётся параметр
                               namespaceURI, имя элемента может принимать префикс, который должен
                               быть связан с URI.
  <info>string|null</info>  <strong>$value</strong>          Значение элемента.
  <info>string</info>       <strong>$namespace</strong>      URI пространства имён для создания элемента с определённым
                               пространством имён.

<comment>See Also:</comment>
   * DOMDocument::createElement
   * DOMDocument::createElementNS


id: DOMElement::after
type: function
doc:
<comment>Description:</comment>
  Adds nodes after the element
  
  Adds the passed <strong>$nodes</strong> after the element.

<comment>Param:</comment>
  <info>DOMNode|string</info>  <strong>$nodes</strong>  Узлы, которые необходимо добавить после узла. Строки автоматически
                          преобразуются в текстовые узлы.

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

<comment>See Also:</comment>
   * DOMChildNode::after
   * DOMElement::before


id: DOMElement::append
type: function
doc:
<comment>Description:</comment>
  Appends nodes after the last child node
  
  Appends one or many <strong>$nodes</strong> to the list of children after the last child node.

<comment>Param:</comment>
  <info>DOMNode|string</info>  <strong>$nodes</strong>  Узлы, которые необходимо добавить. Строки автоматически преобразуются в
                          текстовые узлы.

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

<comment>See Also:</comment>
   * DOMParentNode::append
   * DOMElement::prepend


id: DOMElement::before
type: function
doc:
<comment>Description:</comment>
  Adds nodes before the element
  
  Adds the passed <strong>$nodes</strong> before the element.

<comment>Param:</comment>
  <info>DOMNode|string</info>  <strong>$nodes</strong>  Узлы, которые необходимо добавить перед узлом. Строки автоматически
                          преобразуются в текстовые узлы.

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

<comment>See Also:</comment>
   * DOMChildNode::before
   * DOMElement::after


id: DOMElement::getAttribute
type: function
doc:
<comment>Description:</comment>
  Возвращает значение атрибута
  
  Возвращает значение атрибута с именем <strong>$qualifiedName</strong> для текущего узла.

<comment>Param:</comment>
  <info>string</info>  <strong>$qualifiedName</strong>  Имя атрибута.

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

<comment>See Also:</comment>
   * DOMElement::hasAttribute
   * DOMElement::setAttribute
   * DOMElement::removeAttribute


id: DOMElement::getAttributeNS
type: function
doc:
<comment>Description:</comment>
  Возвращает значение атрибута
    
  
  Получает значение атрибута в пространстве имён <strong>$namespace</strong> с локальным именем <strong>$localName</strong> для
  текущего узла.

<comment>Param:</comment>
  <info>string|null</info>  <strong>$namespace</strong>  URI пространства имён.
  <info>string</info>       <strong>$localName</strong>  Локальное имя.

<comment>Return:</comment>
  <info>string</info>  Значение атрибута либо пустая строка, если атрибута с заданным локальным именем <strong>$localName</strong>
          в пространстве имён <strong>$namespace</strong> не найден.

<comment>See Also:</comment>
   * DOMElement::hasAttributeNS
   * DOMElement::setAttributeNS
   * DOMElement::removeAttributeNS


id: DOMElement::getAttributeNames
type: function
doc:
<comment>Description:</comment>
  Get attribute names
  
  Get attribute names.

<comment>Return:</comment>
  <info>array</info>  Return attribute names.


id: DOMElement::getAttributeNode
type: function
doc:
<comment>Description:</comment>
  Возвращает узел атрибута
    
  
  Возвращает узел атрибута с именем <strong>$qualifiedName</strong> для текущего элемента.

<comment>Param:</comment>
  <info>string</info>  <strong>$qualifiedName</strong>  Имя атрибута.

<comment>Return:</comment>
  <info>DOMAttr|DOMNameSpaceNode|false</info>  Узел атрибута. Обратите внимание, что для объявлений пространств
                                  имён XML (атрибуты <return>xmlns</return> и <return>xmlns:*</return>) возвращается экземпляр
                                  <class>DOMNameSpaceNode</class>, а не <class>DOMAttr</class>.

<comment>See Also:</comment>
   * DOMElement::hasAttribute
   * DOMElement::setAttributeNode
   * DOMElement::removeAttributeNode


id: DOMElement::getAttributeNodeNS
type: function
doc:
<comment>Description:</comment>
  Возвращает узел атрибута
    
  
  Возвращает узел атрибута в пространстве имён <strong>$namespace</strong> с локальным именем <strong>$localName</strong> для текущего
  узла.

<comment>Param:</comment>
  <info>string|null</info>  <strong>$namespace</strong>  URI пространства имён.
  <info>string</info>       <strong>$localName</strong>  Локальное имя.

<comment>Return:</comment>
  <info>DOMAttr|DOMNameSpaceNode|null</info>  Узел атрибута. Обратите внимание, что для объявлений пространств
                                 имён XML (атрибуты <return>xmlns</return> и <return>xmlns:*</return>) возвращается экземпляр
                                 <class>DOMNameSpaceNode</class>, а не объект <class>DOMAttr</class>.

<comment>See Also:</comment>
   * DOMElement::hasAttributeNS
   * DOMElement::setAttributeNodeNS
   * DOMElement::removeAttributeNode


id: DOMElement::getElementsByTagName
type: function
doc:
<comment>Description:</comment>
  Возвращает элементы по имени тега
  
  Эта функция возвращает новый экземпляр класса <class>DOMNodeList</class> - список всех элементов-потомков
  текущего узла с указанным именем тега <strong>$qualifiedName</strong>, в том порядке, в котором они встречаются при
  обходе дерева.

<comment>Param:</comment>
  <info>string</info>  <strong>$qualifiedName</strong>  Имя тега. Используйте символ <return>*</return> для возврата всех элементов дерева.

<comment>Return:</comment>
  <info>DOMNodeList</info>  Эта функция возвращает новый объект класса <class>DOMNodeList</class> - список всех подходящих
               элементов.

<comment>See Also:</comment>
   * DOMElement::getElementsByTagNameNS


id: DOMElement::getElementsByTagNameNS
type: function
doc:
<comment>Description:</comment>
  Получение элементов по локальному имени в заданном пространстве имён
    
  
  Эта функция выбирает все элементы-потомки с заданным именем <strong>$localName</strong> и пространством имён
  <strong>$namespace</strong>.

<comment>Param:</comment>
  <info>string|null</info>  <strong>$namespace</strong>  URI пространства имён элементов для поиска. Специальное значение <return>"*"</return>
                           соответствует всем пространствам имён. Передача <info>null</info> соответствует
                           пустому пространству имён.
  <info>string</info>       <strong>$localName</strong>  Локальное имя элементов для поиска. Специальное значение <return>"*"</return>
                           соответствует всем локальным именам.

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

<comment>See Also:</comment>
   * DOMElement::getElementsByTagName


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

<comment>Param:</comment>
  <info>string</info>  <strong>$qualifiedName</strong>  Имя атрибута.

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

<comment>See Also:</comment>
   * DOMElement::hasAttributeNS
   * DOMElement::getAttribute
   * DOMElement::setAttribute
   * DOMElement::removeAttribute


id: DOMElement::hasAttributeNS
type: function
doc:
<comment>Description:</comment>
  Проверяет, существует ли заданный атрибут
    
  
  Показывает, существует ли атрибут в пространстве имён <strong>$namespace</strong> с именем <strong>$localName</strong> в составе
  элемента.

<comment>Param:</comment>
  <info>string|null</info>  <strong>$namespace</strong>  URI пространства имён.
  <info>string</info>       <strong>$localName</strong>  Локальное имя.

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

<comment>See Also:</comment>
   * DOMElement::hasAttribute
   * DOMElement::getAttributeNS
   * DOMElement::setAttributeNS
   * DOMElement::removeAttributeNS


id: DOMElement::insertAdjacentElement
type: function
doc:
<comment>Description:</comment>
  Insert adjacent element
  
  Inserts an element at a relative position given by <strong>$where</strong>.

<comment>Param:</comment>
  <info>string</info>      <strong>$where</strong>    <return>beforebegin</return> - Insert before the target element.<return>afterbegin</return> - Insert as the
                        first child of the target element.<return>beforeend</return> - Insert as the last child of
                        the target element.<return>afterend</return> - Insert after the target element.
  <info>DOMElement</info>  <strong>$element</strong>  The element to insert.

<comment>Return:</comment>
  <info>DOMElement|null</info>  Return <class>DOMElement</class> or <info>null</info> on failure.

<comment>See Also:</comment>
   * DOMElement::insertAdjacentText


id: DOMElement::insertAdjacentText
type: function
doc:
<comment>Description:</comment>
  Insert adjacent text
  
  Inserts text at a relative position given by <strong>$where</strong>.

<comment>Param:</comment>
  <info>string</info>  <strong>$where</strong>  <return>beforebegin</return> - Insert before the target element.<return>afterbegin</return> - Insert as the first
                  child of the target element.<return>beforeend</return> - Insert as the last child of the target
                  element.<return>afterend</return> - Insert after the target element.
  <info>string</info>  <strong>$data</strong>   The string to insert.

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

<comment>See Also:</comment>
   * DOMElement::insertAdjacentElement


id: DOMElement::prepend
type: function
doc:
<comment>Description:</comment>
  Prepends nodes before the first child node
  
  Prepends one or many <strong>$nodes</strong> to the list of children before the first child node.

<comment>Param:</comment>
  <info>DOMNode|string</info>  <strong>$nodes</strong>  Узлы, которые необходимо добавить. Строки автоматически преобразуются в
                          текстовые узлы.

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

<comment>See Also:</comment>
   * DOMParentNode::prepend
   * DOMElement::append


id: DOMElement::remove
type: function
doc:
<comment>Description:</comment>
  Removes the element
  
  Removes the element.

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

<comment>See Also:</comment>
   * DOMElement::after
   * DOMElement::before
   * DOMElement::replaceWith
   * DOMNode::removeChild


id: DOMElement::removeAttribute
type: function
doc:
<comment>Description:</comment>
  Удаляет атрибут
  
  Удаляет атрибут с именем <strong>$qualifiedName</strong> из элемента.

<comment>Param:</comment>
  <info>string</info>  <strong>$qualifiedName</strong>  Имя атрибута.

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

<comment>See Also:</comment>
   * DOMElement::hasAttribute
   * DOMElement::getAttribute
   * DOMElement::setAttribute


id: DOMElement::removeAttributeNS
type: function
doc:
<comment>Description:</comment>
  Удаляет атрибут
  
  Удаляет атрибут <strong>$localName</strong> в пространстве имён <strong>$namespace</strong> из элемента.

<comment>Param:</comment>
  <info>string|null</info>  <strong>$namespace</strong>  URI пространства имён.
  <info>string</info>       <strong>$localName</strong>  Локальное имя.

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

<comment>See Also:</comment>
   * DOMElement::hasAttributeNS
   * DOMElement::getAttributeNS
   * DOMElement::setAttributeNS


id: DOMElement::removeAttributeNode
type: function
doc:
<comment>Description:</comment>
  Удаляет атрибут
  
  Удаляет узел атрибута <strong>$attr</strong> из элемента.

<comment>Param:</comment>
  <info>DOMAttr</info>  <strong>$attr</strong>  Узел атрибута.

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

<comment>See Also:</comment>
   * DOMElement::hasAttribute
   * DOMElement::getAttributeNode
   * DOMElement::setAttributeNode


id: DOMElement::replaceChildren
type: function
doc:
<comment>Description:</comment>
  Replace children in element
  
  Replaces the children in the element with new <strong>$nodes</strong>.

<comment>Param:</comment>
  <info>DOMNode|string</info>  <strong>$nodes</strong>  The nodes replacing the children. Strings are automatically converted to
                          text nodes.

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

<comment>See Also:</comment>
   * DOMParentNode::replaceChildren
   * DOMElement::replaceWith
   * DOMElement::after
   * DOMElement::before
   * DOMElement::remove


id: DOMElement::replaceWith
type: function
doc:
<comment>Description:</comment>
  Replaces the element with new nodes
  
  Replaces the element with new <strong>$nodes</strong>.

<comment>Param:</comment>
  <info>DOMNode|string</info>  <strong>$nodes</strong>  Узлы, которыми необходимо заменить узел.

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

<comment>See Also:</comment>
   * DOMChildNode::replaceWith
   * DOMElement::replaceChildren
   * DOMElement::after
   * DOMElement::before
   * DOMElement::remove


id: DOMElement::setAttribute
type: function
doc:
<comment>Description:</comment>
  Добавляет новый или изменяет существующий атрибут
  
  Устанавливает атрибут с именем <strong>$qualifiedName</strong>. Если атрибут не существует, то он будет создан.

<comment>Param:</comment>
  <info>string</info>  <strong>$qualifiedName</strong>  Имя атрибута.
  <info>string</info>  <strong>$value</strong>          Значение атрибута.

<comment>Return:</comment>
  <info>DOMAttr|bool</info>  Созданный или изменённый объект класса <class>DOMAttr</class> или <info>false</info> в случае возникновения
                ошибки.

<comment>See Also:</comment>
   * DOMElement::hasAttribute
   * DOMElement::getAttribute
   * DOMElement::removeAttribute


id: DOMElement::setAttributeNS
type: function
doc:
<comment>Description:</comment>
  Добавляет новый атрибут
  
  Устанавливает атрибут с пространстве имён <strong>$namespace</strong> и локальным именем <strong>$name</strong>. Если атрибут не
  существует, он будет создан.

<comment>Param:</comment>
  <info>string|null</info>  <strong>$namespace</strong>      URI пространства имён.
  <info>string</info>       <strong>$qualifiedName</strong>  Квалифицированное имя атрибута в виде <return>prefix:tagname</return>.
  <info>string</info>       <strong>$value</strong>          Значение атрибута.

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

<comment>See Also:</comment>
   * DOMElement::hasAttributeNS
   * DOMElement::getAttributeNS
   * DOMElement::removeAttributeNS


id: DOMElement::setAttributeNode
type: function
doc:
<comment>Description:</comment>
  Добавляет новый узел атрибута в элемент
    
  
  Добавляет новый узел атрибута <strong>$attr</strong> в элемент. Если в элементе уже существует узел с таким же
  именем, то он заменяется на <strong>$attr</strong>.

<comment>Param:</comment>
  <info>DOMAttr</info>  <strong>$attr</strong>  Узел атрибута.

<comment>Return:</comment>
  <info>DOMAttr|null|false</info>  Возвращает старый узел, если он был заменён или <info>null</info>, если старого узла не
                      было. Если выдаётся ошибка <info>DOM_WRONG_DOCUMENT_ERR</info>, а strictErrorChecking равно
                      <info>false</info>, то возвращается <info>false</info>.

<comment>See Also:</comment>
   * DOMElement::hasAttribute
   * DOMElement::getAttributeNode
   * DOMElement::removeAttributeNode


id: DOMElement::setAttributeNodeNS
type: function
doc:
<comment>Description:</comment>
  Добавляет новый атрибут в элемент
  
  Добавляет новый узел атрибута <strong>$attr</strong> в элемент с учётом пространства имён. Если в элементе уже
  существует атрибут с таким же именем, то он заменяется на <strong>$attr</strong>.

<comment>Param:</comment>
  <info>DOMAttr</info>  <strong>$attr</strong>  Узел атрибута.

<comment>Return:</comment>
  <info>DOMAttr|null|false</info>  Возвращает старый атрибут, если он был заменён или <info>null</info>, если старого атрибута
                      не было. Если возникает ошибка <info>DOM_WRONG_DOCUMENT_ERR</info>, а strictErrorChecking
                      равно <info>false</info>, то возвращается значение <info>false</info>.

<comment>See Also:</comment>
   * DOMElement::hasAttributeNS
   * DOMElement::getAttributeNodeNS
   * DOMElement::removeAttributeNode


id: DOMElement::setIdAttribute
type: function
doc:
<comment>Description:</comment>
  Объявляет атрибут, указанный именем, с идентификатором типа
    
  
  Объявляет атрибут <strong>$qualifiedName</strong> с идентификатором типа.

<comment>Param:</comment>
  <info>string</info>  <strong>$qualifiedName</strong>  Имя атрибута.
  <info>bool</info>    <strong>$isId</strong>           Установите значение в <info>true</info> если вы хотите, чтобы <strong>$qualifiedName</strong> имел
                          идентификатор типа, <info>false</info> в противном случае.

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

<comment>See Also:</comment>
   * DOMDocument::getElementById
   * DOMElement::setIdAttributeNode
   * DOMElement::setIdAttributeNS


id: DOMElement::setIdAttributeNS
type: function
doc:
<comment>Description:</comment>
  Объявляет атрибут, указанный локальным именем и URI пространства имён, с идентификатором типа
    
  
  Объявляет атрибут, указанный локальным именем <strong>$qualifiedName</strong> и пространством имён <strong>$namespace</strong>,
  идентификатором типа.

<comment>Param:</comment>
  <info>string</info>  <strong>$namespace</strong>      URI пространства имён атрибута.
  <info>string</info>  <strong>$qualifiedName</strong>  Локальное имя атрибута в виде <return>prefix:tagname</return>.
  <info>bool</info>    <strong>$isId</strong>           Установите значение в <info>true</info> если вы хотите, чтобы <strong>$name</strong> имел идентификатор
                          типа, <info>false</info> в противном случае.

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

<comment>See Also:</comment>
   * DOMDocument::getElementById
   * DOMElement::setIdAttribute
   * DOMElement::setIdAttributeNode


id: DOMElement::setIdAttributeNode
type: function
doc:
<comment>Description:</comment>
  Объявляет атрибут, указанный узлом, с идентификатором типа
    
  
  Объявляет атрибут, определяемый узлом <strong>$attr</strong>, идентификатором типа.

<comment>Param:</comment>
  <info>DOMAttr</info>  <strong>$attr</strong>  Узел атрибута.
  <info>bool</info>     <strong>$isId</strong>  Установите значение в <info>true</info> если вы хотите, чтобы <strong>$name</strong> имел идентификатор типа,
                  <info>false</info> в противном случае.

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

<comment>See Also:</comment>
   * DOMDocument::getElementById
   * DOMElement::setIdAttribute
   * DOMElement::setIdAttributeNS


id: DOMElement::toggleAttribute
type: function
doc:
<comment>Description:</comment>
  Toggle attribute
  
  Toggle the attribute.

<comment>Param:</comment>
  <info>string</info>     <strong>$qualifiedName</strong>  The qualified name of the attribute.
  <info>bool|null</info>  <strong>$force</strong>          if <info>null</info>, the function will toggle the attribute.if <info>true</info>, the function
                             adds the attribute.if <info>false</info>, the function removes the attribute.

<comment>Return:</comment>
  <info>bool</info>  Returns <info>true</info> if the attribute is present after finishing the call, <info>false</info> otherwise.


id: DOMEntity
type: class
doc:
<comment>Description:</comment>
  Этот интерфейс представляет известную сущность, уже разобранную или нет, в документе XML.


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

<comment>Param:</comment>
  <info>string</info>  <strong>$name</strong>  Имя ссылки на сущность.

<comment>See Also:</comment>
   * DOMDocument::createEntityReference


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


id: DOMImplementation::__construct
type: function
doc:
<comment>Description:</comment>
  Создаёт новый объект класса DOMImplementation
    
  
  Создаёт экземпляр класса <class>DOMImplementation</class>.


id: DOMImplementation::createDocument
type: function
doc:
<comment>Description:</comment>
  Создаёт объект класса DOMDocument заданного типа с его элементом document
    
  
  Создаёт объект класса <class>DOMDocument</class> заданного типа с его элементом document.

<comment>Param:</comment>
  <info>string|null</info>           <strong>$namespace</strong>      URI пространства имён создаваемого элемента document.
  <info>string</info>                <strong>$qualifiedName</strong>  Квалифицированное имя создаваемого элемента document.
  <info>DOMDocumentType|null</info>  <strong>$doctype</strong>        Тип создаваемого элемента document или <info>null</info>.

<comment>Return:</comment>
  <info>DOMDocument|false</info>  Новый объект класса <class>DOMDocument</class> или <info>false</info> в случае возникновения ошибки. Если
                     аргументы <strong>$namespace</strong>, <strong>$qualifiedName</strong>, и <strong>$doctype</strong> имеют значение null,
                     возвращаемый объект <class>DOMDocument</class> будет пустым и без элемента document.

<comment>See Also:</comment>
   * DOMDocument::__construct
   * DOMImplementation::createDocumentType


id: DOMImplementation::createDocumentType
type: function
doc:
<comment>Description:</comment>
  Создаёт пустой объект класса DOMDocumentType
    
  
  Создаёт пустой объект класса <class>DOMDocumentType</class>. Объявления сущностей и обозначения будут недоступны.
  Ссылки на сущности не будут заменяться и добавления атрибутов по умолчанию не будут происходить.

<comment>Param:</comment>
  <info>string</info>  <strong>$qualifiedName</strong>  Квалифицированное имя типа документа для создания.
  <info>string</info>  <strong>$publicId</strong>       Общедоступный идентификатор внешнего подмножества.
  <info>string</info>  <strong>$systemId</strong>       Системный идентификатор внешнего подмножества.

<comment>Return:</comment>
  <info>DOMDocumentType|false</info>  Новый объект класса <class>DOMDocumentType</class> с атрибутом <return>ownerDocument</return>,
                         установленным в <info>null</info> или <info>false</info> в случае возникновения ошибки.

<comment>See Also:</comment>
   * DOMImplementation::createDocument


id: DOMImplementation::hasFeature
type: function
doc:
<comment>Description:</comment>
  Проверка, реализована ли определённая возможность в реализации DOM
    
  
  Проверяет, реализует ли специфичную возможность <strong>$feature</strong> реализация DOM.
  
  Вы можете найти список всех возможностей в разделе Согласование стандарта DOM.

<comment>Param:</comment>
  <info>string</info>  <strong>$feature</strong>  Тестируемая возможность.
  <info>string</info>  <strong>$version</strong>  Номер версии тестируемой возможности <strong>$feature</strong>. В DOM level 2 это может быть либо
                    <return>2.0</return>, либо <return>1.0</return>.

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

<comment>See Also:</comment>
   * DOMNode::isSupported


id: DOMNamedNodeMap::count
type: function
doc:
<comment>Description:</comment>
  Количество узлов в отображении
  
  Получает количество узлов в отображении.

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


id: DOMNamedNodeMap::getIterator
type: function
doc:
<comment>Description:</comment>
  Retrieve an external iterator
  
  Returns an external iterator for the named node map.

<comment>Return:</comment>
  <info>Iterator</info>  Возвращает экземпляр объекта, реализующий <class>Iterator</class> или <class>Traversable</class>

<comment>See Also:</comment>
   * IteratorAggregate::getIterator


id: DOMNamedNodeMap::getNamedItem
type: function
doc:
<comment>Description:</comment>
  Получает узел, указанный по имени
    
  
  Извлекает узел по заданному <return>nodeName</return>.

<comment>Param:</comment>
  <info>string</info>  <strong>$qualifiedName</strong>  Имя <return>nodeName</return> искомого узла.

<comment>Return:</comment>
  <info>DOMNode|null</info>  Узел (любого типа) с заданным значением тега <return>nodeName</return> или <info>null</info>, если таковых не
                найдено.

<comment>See Also:</comment>
   * DOMNamedNodeMap::getNamedItemNS


id: DOMNamedNodeMap::getNamedItemNS
type: function
doc:
<comment>Description:</comment>
  Получает узел с заданным локальным именем и URI пространства имён
    
  
  Извлекает узел с заданным локальным именем <strong>$localName</strong> и URI пространства имён <strong>$namespace</strong>.

<comment>Param:</comment>
  <info>string|null</info>  <strong>$namespace</strong>  URI пространства имён искомого узла.
  <info>string</info>       <strong>$localName</strong>  Локальное имя искомого узла.

<comment>Return:</comment>
  <info>DOMNode|null</info>  Узел (любого типа) с заданным локальным именем и URI пространства имён или <info>null</info>,
                если он не найден.

<comment>See Also:</comment>
   * DOMNamedNodeMap::getNamedItem


id: DOMNamedNodeMap::item
type: function
doc:
<comment>Description:</comment>
  Получает узел с заданным индексом
    
  
  Извлекает узел с заданным индексом <strong>$index</strong> из объекта класса <class>DOMNamedNodeMap</class>.

<comment>Param:</comment>
  <info>int</info>  <strong>$index</strong>  Индекс узла в отображении.

<comment>Return:</comment>
  <info>DOMNode|null</info>  Узел с индексом <strong>$index</strong> в отображении или <info>null</info>, если индекс имеет недопустимое
                значение (больше или равен количеству узлов в отображении).


id: DOMNode::C14N
type: function
doc:
<comment>Description:</comment>
  Канонизировать узлы в строку
  
  Канонизировать узлы в строку

<comment>Param:</comment>
  <info>bool</info>        <strong>$exclusive</strong>     Включить эксклюзивный разбор только тех узлов, которые совпадают с
                             предоставленными xpath или ns_prefixes.
  <info>bool</info>        <strong>$withComments</strong>  Сохранять комментарии в выводе.
  <info>array|null</info>  <strong>$xpath</strong>         Массив <return>xpath</return> для фильтрации узлов.
  <info>array|null</info>  <strong>$nsPrefixes</strong>    Массив префиксов пространств имён для фильтрации узлов.

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

<comment>See Also:</comment>
   * DOMNode::C14NFile


id: DOMNode::C14NFile
type: function
doc:
<comment>Description:</comment>
  Канонизировать узлы в файл
  
  Канонизировать узлы в файл.

<comment>Param:</comment>
  <info>string</info>      <strong>$uri</strong>           Путь для записи вывода.
  <info>bool</info>        <strong>$exclusive</strong>     Включить эксклюзивный разбор только тех узлов, которые совпадают с
                             предоставленными xpath или ns_prefixes.
  <info>bool</info>        <strong>$withComments</strong>  Сохранять комментарии в выводе.
  <info>array|null</info>  <strong>$xpath</strong>         Массив <return>xpath</return> для фильтрации узлов.
  <info>array|null</info>  <strong>$nsPrefixes</strong>    Массив префиксов пространств имён для фильтрации узлов.

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

<comment>See Also:</comment>
   * DOMNode::C14N


id: DOMNode::appendChild
type: function
doc:
<comment>Description:</comment>
  Добавляет новый дочерний узел в конец списка потомков
    
  
  Функция добавляет дочерний узел в существующий список потомков или создаёт новый список дочерних
  элементов. Дочерний узел может быть создан с помощью DOMDocument::createElement,
  DOMDocument::createTextNode и т.д., или может быть использован любой другой узел.
  
  При использовании существующего узла он будет перемещён.

<comment>Param:</comment>
  <info>DOMNode</info>  <strong>$node</strong>  Добавляемый дочерний узел.

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

<comment>See Also:</comment>
   * DOMChildNode::after
   * DOMNode::insertBefore
   * DOMNode::removeChild
   * DOMNode::replaceChild


id: DOMNode::cloneNode
type: function
doc:
<comment>Description:</comment>
  Клонирует узел
    
  
  Создаёт копию узла.

<comment>Param:</comment>
  <info>bool</info>  <strong>$deep</strong>  Указывает, нужно ли копировать всех потомков. Этот параметр по умолчанию имеет
               значение <info>false</info>.

<comment>Return:</comment>
  <info>DOMNode|false</info>  Копия узла.


id: DOMNode::contains
type: function
doc:
<comment>Description:</comment>
  Checks if node contains other node
  
  Checks if node contains <strong>$other</strong> node.

<comment>Param:</comment>
  <info>DOMNode|DOMNameSpaceNode|null</info>  <strong>$other</strong>  Node to be checked.

<comment>Return:</comment>
  <info>bool</info>  Returns <info>true</info> if node contains <strong>$other</strong> node, <info>false</info> otherwise.


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

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


id: DOMNode::getNodePath
type: function
doc:
<comment>Description:</comment>
  Получение XPath узла
    
  
  Получает путь XPath, по которому расположен узел.

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

<comment>See Also:</comment>
   * <class>DOMXPath</class>


id: DOMNode::getRootNode
type: function
doc:
<comment>Description:</comment>
  Get root node
  
  Get root node.

<comment>Param:</comment>
  <info>array</info>  <strong>$options</strong>  This parameter has no effect yet.

<comment>Return:</comment>
  <info>DOMNode</info>  Returns the root node.


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

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

<comment>See Also:</comment>
   * DOMNode::hasChildNodes


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

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

<comment>See Also:</comment>
   * DOMNode::hasAttributes


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

<comment>Param:</comment>
  <info>DOMNode</info>       <strong>$node</strong>   Новый узел.
  <info>DOMNode|null</info>  <strong>$child</strong>  Контрольный узел. Если отсутствует, то <strong>$node</strong> добавляется в конец списка
                        потомков.

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

<comment>See Also:</comment>
   * DOMNode::appendChild


id: DOMNode::isDefaultNamespace
type: function
doc:
<comment>Description:</comment>
  Проверяет, является ли указанный URI пространства имён узла пространством имён по умолчанию или
  нет
  
  Указывает, является ли <strong>$namespace</strong> пространством имён по умолчанию.

<comment>Param:</comment>
  <info>string</info>  <strong>$namespace</strong>  URI пространства имён.

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


id: DOMNode::isEqualNode
type: function
doc:
<comment>Description:</comment>
  Checks that both nodes are equal
  
  Checks that both nodes are equal.

<comment>Param:</comment>
  <info>DOMNode|null</info>  <strong>$otherNode</strong>  The node.

<comment>Return:</comment>
  <info>bool</info>  Returns <info>true</info> if both nodes are equal, <info>false</info> otherwise.


id: DOMNode::isSameNode
type: function
doc:
<comment>Description:</comment>
  Указывает, являются ли два узла одним и тем же узлом
    
  
  Эта функция указывает, являются ли два узла одним и тем же узлом. Данное сравнение происходит не
  на основе содержимого узлов.

<comment>Param:</comment>
  <info>DOMNode</info>  <strong>$otherNode</strong>  Сравниваемый узел.

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


id: DOMNode::isSupported
type: function
doc:
<comment>Description:</comment>
  Проверяет, поддерживается ли возможность в определённой версии
    
  
  Проверяет, поддерживается ли указанная возможность <strong>$feature</strong> в определённой версии <strong>$version</strong>.

<comment>Param:</comment>
  <info>string</info>  <strong>$feature</strong>  Проверяемая возможность. Список возможностей приведён в примере к
                    DOMImplementation::hasFeature.
  <info>string</info>  <strong>$version</strong>  Номер версии (<strong>$feature</strong>) для проверки.

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

<comment>See Also:</comment>
   * DOMImplementation::hasFeature


id: DOMNode::lookupNamespaceURI
type: function
doc:
<comment>Description:</comment>
  Получает URI пространства имён узла по префиксу
    
  
  Получает URI пространства имён узла на основе префикса <strong>$prefix</strong>.

<comment>Param:</comment>
  <info>string|null</info>  <strong>$prefix</strong>  Префикс, который необходимо искать. Если этот параметр равен <info>null</info>, то метод
                        возвращает URI пространства имён по умолчанию, если таковое имеется.

<comment>Return:</comment>
  <info>string|null</info>  Возвращает URI связанного пространства имён или <info>null</info>, если оно не найдено.

<comment>See Also:</comment>
   * DOMNode::lookupPrefix


id: DOMNode::lookupPrefix
type: function
doc:
<comment>Description:</comment>
  Возвращает префикс пространства имён узла из URI пространства имён
    
  
  Возвращает префикс пространства имён узла на основе URI пространства имён.

<comment>Param:</comment>
  <info>string</info>  <strong>$namespace</strong>  URI пространства имён.

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

<comment>See Also:</comment>
   * DOMNode::lookupNamespaceUri


id: DOMNode::normalize
type: function
doc:
<comment>Description:</comment>
  Нормализует узел
    
  
  Удаляет пустые текстовые узлы и объединяет соседние текстовые узлы в этом узле и всех его дочерних
  узлов.

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

<comment>See Also:</comment>
   * Спецификация DOM
   * DOMDocument::normalizeDocument


id: DOMNode::removeChild
type: function
doc:
<comment>Description:</comment>
  Удаляет дочерний узел из списка потомков
    
  
  Эта функция удаляет дочерний узел из списка потомков.

<comment>Param:</comment>
  <info>DOMNode</info>  <strong>$child</strong>  Удаляемый дочерний узел.

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

<comment>See Also:</comment>
   * DOMChildNode::remove
   * DOMNode::appendChild
   * DOMNode::replaceChild


id: DOMNode::replaceChild
type: function
doc:
<comment>Description:</comment>
  Заменяет дочерний узел
    
  
  Функция заменяет дочерний узел <strong>$child</strong> новым узлом. Если узел <strong>$node</strong> уже является дочерним, то он не
  будет добавлен во второй раз. Если замена прошла успешно, то будет возвращён старый (заменяемый)
  узел.

<comment>Param:</comment>
  <info>DOMNode</info>  <strong>$node</strong>   Новый узел. Должен быть частью целевого документа, то есть создан посредством
                   одного из методов DOMDocument-&gt;createXXX() или импортирован в документ через .
  <info>DOMNode</info>  <strong>$child</strong>  Старый узел.

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

<comment>See Also:</comment>
   * DOMChildNode::replaceWith
   * DOMNode::appendChild
   * DOMNode::removeChild


id: DOMNodeList::count
type: function
doc:
<comment>Description:</comment>
  Получить количество узлов в списке
  
  Получает количество узлов в списке.

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


id: DOMNodeList::getIterator
type: function
doc:
<comment>Description:</comment>
  Retrieve an external iterator
  
  Returns an external iterator for the node list.

<comment>Return:</comment>
  <info>Iterator</info>  Возвращает экземпляр объекта, реализующий <class>Iterator</class> или <class>Traversable</class>

<comment>See Also:</comment>
   * IteratorAggregate::getIterator


id: DOMNodeList::item
type: function
doc:
<comment>Description:</comment>
  Получает узел с заданным индексом
    
  
  Извлекает узел с заданным индексом <strong>$index</strong> из объекта класса <class>DOMNodeList</class>.
  
  Если требуется узнать количество узлов в коллекции, используйте свойство <return>length</return> объекта класса
  <class>DOMNodeList</class>.

<comment>Param:</comment>
  <info>int</info>  <strong>$index</strong>  Индекс узла в коллекции.

<comment>Return:</comment>
  <info>DOMElement|DOMNode|DOMNameSpaceNode|null</info>  Узел, находящийся в позиции <strong>$index</strong> объекта <class>DOMNodeList</class>,
                                            или <info>null</info>, если этот индекс недопустим.


id: DOMParentNode::append
type: function
doc:
<comment>Description:</comment>
  Добавляет узлы после последнего дочернего узла
  
  Добавляет один или несколько <strong>$nodes</strong> в список дочерних узлов после последнего дочернего узла.

<comment>Param:</comment>
  <info>DOMNode|string</info>  <strong>$nodes</strong>  Узлы, которые необходимо добавить. Строки автоматически преобразуются в
                          текстовые узлы.

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

<comment>See Also:</comment>
   * DOMParentNode::prepend


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

<comment>Param:</comment>
  <info>DOMNode|string</info>  <strong>$nodes</strong>  Узлы, которые необходимо добавить. Строки автоматически преобразуются в
                          текстовые узлы.

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

<comment>See Also:</comment>
   * DOMParentNode::append


id: DOMParentNode::replaceChildren
type: function
doc:
<comment>Description:</comment>
  Replace children in node
  
  Replace children in node.

<comment>Param:</comment>
  <info>DOMNode|string</info>  <strong>$nodes</strong>  The nodes replacing the children. Strings are automatically converted to
                          text nodes.

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


id: DOMProcessingInstruction::__construct
type: function
doc:
<comment>Description:</comment>
  Создаёт новый объект класса DOMProcessingInstruction
    
  
  Создаёт новый объект класса <class>DOMProcessingInstruction</class>. Этот объект будет доступен только для
  чтения. Он может быть добавлен в документ. Дополнительные узлы нельзя прикрепить к этому объекту,
  пока он присоединён к какому-либо документу. Для создания модифицируемого узла используйте .

<comment>Param:</comment>
  <info>string</info>  <strong>$name</strong>   Имя инструкции для обработчика.
  <info>string</info>  <strong>$value</strong>  Значение инструкции для обработчика.

<comment>See Also:</comment>
   * DOMDocument::createProcessingInstruction


id: DOMSTRING_SIZE_ERR
type: constant
doc:
<comment>Description:</comment>
  Если указанный фрагмент текста не помещается в <class>DOMString</class>.


id: DOMText
type: class
doc:
<comment>Description:</comment>
  Класс <class>DOMText</class> наследуется от <class>DOMCharacterData</class> и представляет текстовое содержимое <class>DOMElement</class> или
  <class>DOMAttr</class>.


id: DOMText::__construct
type: function
doc:
<comment>Description:</comment>
  Создаёт объект класса DOMText
    
  
  Создаёт новый экземпляр класса <class>DOMText</class>.

<comment>Param:</comment>
  <info>string</info>  <strong>$data</strong>  Значение текстового узла. Если значение не передано, будет создан пустой текстовый
                 узел.

<comment>See Also:</comment>
   * DOMDocument::createTextNode


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

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


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

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


id: DOMText::splitText
type: function
doc:
<comment>Description:</comment>
  Разделяет узел на два, начиная с заданной позиции
    
  
  Разделяет узел на два, вторая часть начинается с позиции <strong>$offset</strong>, полученные узлы становятся
  братьями.
  
  После разделения исходный узел будет содержать данные до позиции <strong>$offset</strong>. Если исходный узел имеет
  родителя, то второй, созданный, узел станет следующим братом исходного узла. Если <strong>$offset</strong> равно
  длине содержимого узла, новый узел всё равно будет создан, но не будет содержать данных.

<comment>Param:</comment>
  <info>int</info>  <strong>$offset</strong>  Позиция, с которой узел будет разделён, начиная с 0.

<comment>Return:</comment>
  <info>DOMText|false</info>  Новый узел того же типа, содержащий данные до и после <strong>$offset</strong>.


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

<comment>Param:</comment>
  <info>DOMDocument</info>  <strong>$document</strong>  Объект класса <class>DOMDocument</class>, связанный с <class>DOMXPath</class>.


id: DOMXPath::evaluate
type: function
doc:
<comment>Description:</comment>
  Вычисляет переданное выражение XPath и возвращает типизированный результат,
     если возможно
    
  
  Выполняет переданное выражение XPath <strong>$expression</strong> и возвращает типизированный результат, если это
  возможно.

<comment>Param:</comment>
  <info>string</info>        <strong>$expression</strong>      Выражение XPath для выполнения.
  <info>DOMNode|null</info>  <strong>$contextNode</strong>     Дополнительный параметр <strong>$contextNode</strong> может быть указан для
                                 выполнения относительных запросов XPath. По умолчанию запросы
                                 выполняются относительно корневого элемента.
  <info>bool</info>          <strong>$registerNodeNS</strong>  Дополнительный параметр <strong>$registerNodeNS</strong> можно указать, чтобы
                                 отключить автоматическую регистрацию контекста узла.

<comment>Return:</comment>
  <info>mixed</info>  Возвращает типизированный результат, если это возможно, либо объект <class>DOMNodeList</class>, содержащий
         все узлы, соответствующие заданному XPath-выражению <strong>$expression</strong>.
         
         Если <strong>$expression</strong> построено неправильно или <strong>$contextNode</strong> имеет неверное значение,
         DOMXPath::evaluate вернёт <info>false</info>.

<comment>See Also:</comment>
   * DOMXPath::query


id: DOMXPath::query
type: function
doc:
<comment>Description:</comment>
  Выполняет заданное выражение XPath
    
  
  Выполняет заданное XPath-выражение <strong>$expression</strong>.

<comment>Param:</comment>
  <info>string</info>        <strong>$expression</strong>      Выражение XPath для выполнения.
  <info>DOMNode|null</info>  <strong>$contextNode</strong>     Дополнительный параметр <strong>$contextNode</strong> может быть указан для
                                 выполнения относительных запросов XPath. По умолчанию запросы
                                 выполняются относительно корневого элемента.
  <info>bool</info>          <strong>$registerNodeNS</strong>  Дополнительный параметр <strong>$registerNodeNS</strong> можно указать, чтобы
                                 отключить автоматическую регистрацию контекста узла.

<comment>Return:</comment>
  <info>mixed</info>  Возвращает объект <class>DOMNodeList</class>, содержащий узлы, соответствующие выражению XPath
         <strong>$expression</strong>. Любое выражение, не возвращающее узлы, вернёт пустой объект <class>DOMNodeList</class>.
         
         Если <strong>$expression</strong> построено неправильно или <strong>$contextNode</strong> имеет неверное значение,
         DOMXPath::query вернёт <info>false</info>.

<comment>See Also:</comment>
   * DOMXPath::evaluate


id: DOMXPath::registerNamespace
type: function
doc:
<comment>Description:</comment>
  Регистрирует пространство имён с объектом DOMXPath
    
  
  Регистрирует URI пространства имён <strong>$namespace</strong> и префикс <strong>$prefix</strong> с объектом DOMXPath.

<comment>Param:</comment>
  <info>string</info>  <strong>$prefix</strong>     Префикс.
  <info>string</info>  <strong>$namespace</strong>  URI пространства имён.

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


id: DOMXPath::registerPhpFunctions
type: function
doc:
<comment>Description:</comment>
  Регистрация PHP-функций как функций XPath
    
  
  Этот метод позволяет использовать PHP-функции в выражениях XPath.

<comment>Param:</comment>
  <info>string|array|null</info>  <strong>$restrict</strong>  Используйте этот параметр, чтобы разрешить использование только
                                определённых функций в выражениях XPath.
                                
                                Этот параметр может иметь тип <info>string</info> (имя функции) или <info>array</info> (массив
                                имён функций).

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

<comment>See Also:</comment>
   * DOMXPath::registerNamespace
   * DOMXPath::query
   * DOMXPath::evaluate


id: DOM_INDEX_SIZE_ERR
type: constant
doc:
<comment>Description:</comment>
  Если индекс или размер отрицательный или выходит за пределы возможных значений.


id: DOM_INUSE_ATTRIBUTE_ERR
type: constant
doc:
<comment>Description:</comment>
  Если пытаться добавить атрибут, который используется в другом месте.


id: DOM_INVALID_STATE_ERR
type: constant
doc:
<comment>Description:</comment>
  Если пытаться использовать объект, которого нет или невозможно использовать.


id: DOM_NAMESPACE_ERR
type: constant
doc:
<comment>Description:</comment>
  Если пытаться создать или изменить объект с некорректным пространством имён.


id: DOM_NOT_FOUND_ERR
type: constant
doc:
<comment>Description:</comment>
  Если делается попытка ссылаться на узел в контексте, которого не существует


id: DOM_NOT_SUPPORTED_ERR
type: constant
doc:
<comment>Description:</comment>
  Если реализация не поддерживает запрошенный тип объекта или операции.


id: DOM_NO_MODIFICATION_ALLOWED_ERR
type: constant
doc:
<comment>Description:</comment>
  Если происходит попытка изменить объект, который не поддерживает изменения.


id: DOM_PHP_ERR
type: constant
doc:
<comment>Description:</comment>
  Этот код ошибки не является частью спецификации DOM. Предназначена для ошибок PHP.


id: DOM_VALIDATION_ERR
type: constant
doc:
<comment>Description:</comment>
  Если вызов метода, такого как insertBefore или removeChild, сделает узел недействительным, то
  выбросит исключение и операция не будет выполнена.


id: DOM_WRONG_DOCUMENT_ERR
type: constant
doc:
<comment>Description:</comment>
  Если узел используется в другом документе, а не в том, где он был создан.


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

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


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

<comment>Return:</comment>
  <info>string</info>  Имя объекта базы данных.


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

<comment>Return:</comment>
  <info>mysql_xdevapi\Session</info>  Объект Session.


id: DateInterval
type: class
doc:
<comment>Description:</comment>
  Представляет интервалы дат.
  
  Интервал дат хранит либо определённое фиксированное время (в годах, месяцах, днях, часах и т.д.)
  или относительную строку времени в формате, поддерживаемом конструктором <class>DateTimeImmutable</class> и
  <class>DateTime</class>.
  
  Более конкретно, информация в объекте класса <class>DateInterval</class> является инструкцией для перехода от
  одной даты/времени к другой дате/времени. Этот процесс не всегда обратим.
  
  Распространённым способом создания объекта <class>DateInterval</class> является вычисление разницы между двумя
  объектами даты/времени с помощью DateTimeInterface::diff.
  
  Поскольку не существует чётко определённого способа сравнения интервалов дат, экземпляры
  <class>DateInterval</class> являются несравнимыми.


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

<comment>Param:</comment>
  <info>string</info>  <strong>$duration</strong>  Описание интервала.
                     
                     Формат описания интервала начинается с буквы <return>P</return>. Каждый период интервала
                     представлен целым числом, за которым следует указатель его типа. Возможные типы
                     приведены в таблице. Если интервал содержит периоды, обозначающие время, то их
                     описанию должна предшествовать буква <return>T</return>.
                     
                      Указатели периодов <strong>$duration</strong> Указатель периодаОписание<return>Y</return>года<return>M</return>месяцы<return>D</return>дни<return>W</return>
                     недели. Преобразуется в дни. До PHP 8.0.0 не мог использоваться совместно с <return>D</return>.
                     <return>H</return>часы<return>M</return>минуты<return>S</return>секунды
                     
                     Вот несколько простых примеров. Два дня - <return>P2D</return>. Две секунды - <return>PT2S</return>. Шесть лет и
                     пять минут - <return>P6YT5M</return>.
                     
                     Указатели должны записываться от большей величины (слева) к меньшей величине
                     (направо). То есть года должны быть до месяцев, месяцы до дней, дни до минут и
                     так далее. Таким образом, один год и четыре дня должны быть представлены как
                     <return>P1Y4D</return>, но не <return>P4D1Y</return>.
                     
                     Задать период также можно в виде даты и времени. Пример одного года и четырёх
                     дней может описываться как <return>P0001-00-04T00:00:00</return>. Но значения в этом формате не
                     должны выходить за рамки допустимых значений даты и времени (например, <return>25</return> часов
                     недопустимо)
                     
                     Эти форматы основаны на спецификации ISO 8601.

<comment>See Also:</comment>
   * <strong>DateInterval::format()</strong>
   * <strong>DateTime::add()</strong>
   * <strong>DateTime::sub()</strong>
   * <strong>DateTime::diff()</strong>


id: DateInterval::createFromDateString
type: function
doc:
<comment>Description:</comment>
  Создаёт объект класса DateInterval из даты в относительном формате
    
  
  Объектно-ориентированный стиль
  
  Процедурный стиль
  
  Использует парсер даты/времени, используемый в конструкторе <class>DateTimeImmutable</class> для создания объекта
  <class>DateInterval</class> из относительных частей разобранной строки.

<comment>Param:</comment>
  <info>string</info>  <strong>$datetime</strong>  Дата, состоящая из относительных временных фрагментов. В частности, для
                     создания объекта DateInterval из частей, записанных в относительном формате,
                     который поддерживается парсером в функциях <class>DateTimeImmutable</class>, <class>DateTime</class> и
                     <strong>strtotime()</strong>.
                     
                     Чтобы использовать строку в формате ISO-8601, например <return>P7D</return>, необходимо
                     использовать конструктор.

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


id: DateInterval::format
type: function
doc:
<comment>Description:</comment>
  Форматирует интервал
  
  Форматирует интервал.

<comment>Param:</comment>
  <info>string</info>  <strong>$format</strong>   В строке <strong>$format</strong> распознаются следующие символы. Каждому такому символу должен
                   предшествовать знак процента (<return>%</return>). Символ в строке<strong>$format</strong>ОписаниеПример
                   значения<return>%</return>Символ <return>%</return><return>%</return><return>Y</return>Годы, число, минимум две цифры с ведущими нулями<return>01</return>, <return>03</return><return>y</return>Годы,
                   число<return>1</return>, <return>3</return><return>M</return>Месяцы, число, минимум две цифры с ведущими нулями<return>01</return>, <return>03</return>, <return>12</return><return>m</return>Месяцы,
                   число<return>1</return>, <return>3</return>, <return>12</return><return>D</return>Дни, число, минимум две цифры с ведущими нулями<return>01</return>, <return>03</return>, <return>31</return><return>d</return>Дни,
                   число<return>1</return>, <return>3</return>, <return>31</return><return>a</return>Общее количество дней в качестве результата выполнения
                   DateTime::diff, либо <return>unknown</return><return>4</return>, <return>18</return>, <return>8123</return><return>H</return>Часы, число, минимум две цифры с ведущими
                   нулями<return>01</return>, <return>03</return>, <return>23</return><return>h</return>Часы, число<return>1</return>, <return>3</return>, <return>23</return><return>I</return>Минуты, число, минимум две цифры с ведущими
                   нулями<return>01</return>, <return>03</return>, <return>59</return><return>i</return>Минуты, число<return>1</return>, <return>3</return>, <return>59</return><return>S</return>Секунды, число, минимум две цифры с
                   ведущими нулями<return>01</return>, <return>03</return>, <return>57</return><return>s</return>Секунды, число<return>1</return>, <return>3</return>, <return>57</return><return>F</return>Микросекунды, число, как минимум
                   6 цифр с ведущим 0<return>007701</return>, <return>052738</return>, <return>428291</return><return>f</return>Микросекунды, число<return>7701</return>, <return>52738</return>,
                   <return>428291</return><return>R</return>Знак "<return>-</return>" при отрицательном числе, "<return>+</return>" при положительном<return>-</return>, <return>+</return><return>r</return>Знак "<return>-</return>" при
                   отрицательном числе, пусто при положительном<return>-</return>,

<comment>Return:</comment>
  <info>string</info>  Возвращает отформатированный интервал.

<comment>See Also:</comment>
   * DateTime::diff


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


id: DatePeriod::EXCLUDE_START_DATE
type: constant
doc:
<comment>Description:</comment>
  Исключает начальную дату, используется в <strong>DatePeriod::__construct()</strong>.


id: DatePeriod::INCLUDE_END_DATE
type: constant
doc:
<comment>Description:</comment>
  Включает дату окончания, используется в <strong>DatePeriod::__construct()</strong>.


id: DatePeriod::__construct
type: function
doc:
<comment>Description:</comment>
  Создаёт новый объект DatePeriod
  
  Этот вариант конструктора устарел, используйте вместо него метод
  DatePeriod::createFromISO8601String.
  
  Создаёт новый объект DatePeriod.
  
  Объекты <class>DatePeriod</class> можно использовать в качестве итератора для генерации ряда объектов
  <class>DateTimeImmutable</class> или <class>DateTime</class> из даты <strong>$start</strong>, <strong>$interval</strong> и <strong>$end</strong> или числа <strong>$recurrences</strong>.
  
  Класс возвращаемых объектов эквивалентен классу-родителю <class>DateTimeImmutable</class> или <class>DateTime</class> объекта
  <strong>$start</strong>.

<comment>Param:</comment>
  <info>DateTimeInterface</info>  <strong>$start</strong>        Начальная дата. По умолчанию включается в набор результатов.
  <info>DateInterval</info>       <strong>$interval</strong>     Интервал.
  <info>int</info>                <strong>$recurrences</strong>  Количество повторений. Число возвращаемых результатов на единицу
                                   больше этого, так как дата начала включается в набор результатов
                                   по умолчанию. Должно быть больше, чем <return>0</return>.
  <info>DateTimeInterface</info>  <strong>$end</strong>          Конечная дата. По умолчанию исключается из набора результатов.
  <info>string</info>             <strong>$isostr</strong>       Подмножество, содержащее интервал согласно спецификации ISO 8601.
                                   
                                   Примерами некоторых особенностей спецификации интервалов ISO
                                   8601, которые PHP не поддерживает, являются:
                                   
                                   нулевые вхождения (<return>R0/</return>)
                                   
                                   смещение времени, отличное от UTC (<return>Z</return>), например, <return>+02:00</return>.
  <info>int</info>                <strong>$options</strong>      Битовое поле, которое можно использовать для управления
                                   определённым поведением с начальной и конечной датами.
                                   
                                   Исключить начальную дату внутри периода из набора повторяющихся
                                   дат можно с помощью константы <info>DatePeriod::EXCLUDE_START_DATE</info>.
                                   
                                   Включить конечную дату внутри периода в набор повторяющихся дат
                                   можно с помощью константы <info>DatePeriod::INCLUDE_END_DATE</info>.


id: DatePeriod::createFromISO8601String
type: function
doc:
<comment>Description:</comment>
  Creates a new DatePeriod object from an ISO8601 string
  
  Creates a new DatePeriod object from an ISO8601 string, as specified with <strong>$specification</strong>.

<comment>Param:</comment>
  <info>string</info>  <strong>$specification</strong>  A subset of the ISO 8601 repeating interval specification.
                          
                          An example of an accepted ISO 8601 interval specifications is
                          <return>R5/2008-03-01T13:00:00Z/P1Y2M10DT2H30M</return>, which specifies:
                          
                          5 iterations (<return>R5/</return>)
                          
                          Starting at <return>2008-03-01T13:00:00Z</return>.
                          
                          Each iteration is an 1 year, 2 months, 10 days, 2 hours, and 30 minute
                          interval (<return>/P1Y2M10DT2H30M</return>).
                          
                          Examples of some ISO 8601 interval specification features that PHP does
                          not support are:
                          
                          zero occurrences (<return>R0/</return>)
                          
                          time offsets other than UTC (<return>Z</return>), such as <return>+02:00</return>.
  <info>int</info>     <strong>$options</strong>        A bit field which can be used to control certain behaviour with start- and
                          end- dates.
                          
                          With <info>DatePeriod::EXCLUDE_START_DATE</info> you exclude the start date from the
                          set of recurring dates within the period.
                          
                          With <info>DatePeriod::INCLUDE_END_DATE</info> you include the end date in the set of
                          recurring dates within the period.

<comment>Return:</comment>
  <info>static</info>  Creates a new DatePeriod object.
          
          <class>DatePeriod</class> objects created with this method can be used as an iterator to generate a
          number of <class>DateTimeImmutable</class> objects.


id: DatePeriod::getDateInterval
type: function
doc:
<comment>Description:</comment>
  Возвращает интервал
    
  
  Объектно-ориентированный стиль
  
  Возвращает объект <class>DateInterval</class>, представляющий интервал, использованный для создания периода.

<comment>Return:</comment>
  <info>DateInterval</info>  Возвращает объект <class>DateInterval</class>

<comment>See Also:</comment>
   * DatePeriod::getStartDate
   * DatePeriod::getEndDate


id: DatePeriod::getEndDate
type: function
doc:
<comment>Description:</comment>
  Возвращает конечную дату периода
    
  
  Объектно-ориентированный стиль
  
  Возвращает конечную дату периода.

<comment>Return:</comment>
  <info>DateTimeInterface|null</info>  Возвращает <info>null</info>, если <class>DatePeriod</class> не содержит конечной даты. Например, при
                          инициализации с параметром <strong>$recurrences</strong> или <strong>$isostr</strong> без указания конечной
                          даты.
                          
                          Возвращает объект <class>DateTimeImmutable</class>, когда <class>DatePeriod</class> инициализирован с
                          объектом <class>DateTimeImmutable</class> в качестве параметра <strong>$end</strong>.
                          
                          В противном случае возвращает клонированный объект (<info>object</info>) <class>DateTime</class>,
                          представляющий дату окончания.

<comment>See Also:</comment>
   * DatePeriod::getStartDate
   * DatePeriod::getDateInterval


id: DatePeriod::getRecurrences
type: function
doc:
<comment>Description:</comment>
  Получает количество повторов
  
  Объектно-ориентированный стиль
  
  Получает количество повторов.

<comment>Return:</comment>
  <info>int|null</info>  Возвращает количество повторений, заданное путём явной передачи параметра <return>$recurrences</return> в
            конструктор класса <class>DatePeriod</class> или <info>null</info> в противном случае.

<comment>See Also:</comment>
   * DatePeriod::$recurrences


id: DatePeriod::getStartDate
type: function
doc:
<comment>Description:</comment>
  Возвращает начальную дату периода
    
  
  Объектно-ориентированный стиль
  
  Возвращает начальную дату периода.

<comment>Return:</comment>
  <info>DateTimeInterface</info>  Возвращает объект <class>DateTimeImmutable</class>, когда <class>DatePeriod</class> инициализирован объектом
                     <class>DateTimeImmutable</class> в качестве параметра <strong>$start</strong>.
                     
                     Иначе возвращает объект <class>DateTime</class>.

<comment>See Also:</comment>
   * DatePeriod::getEndDate
   * DatePeriod::getDateInterval


id: DateTime
type: class
doc:
<comment>Description:</comment>
  Представление даты и времени.
  
  Класс ведёт себя так же, как и <class>DateTimeImmutable</class>, за исключением того, что объекты модифицируются
  сами при вызове таких методов модификации, как <strong>DateTime::modify()</strong>.
  
  Вызов методов для объектов класса <class>DateTime</class> изменит информацию, заключённую в этих объектах, если
  вы хотите предотвратить это, вам придётся использовать оператор <return>clone</return> для создания нового объекта.
  Используйте класс <class>DateTimeImmutable</class> вместо <class>DateTime</class>, чтобы получить рекомендуемое поведение по
  умолчанию.


id: DateTime::__construct
type: function
doc:
<comment>Description:</comment>
  Конструктор класса DateTime
  
  Этот конструктор похож на конструктор DateTimeImmutable::__construct, но работает с объектом
  <class>DateTime</class>. Учтите, что вместо этого класса лучше работать с классом <class>DateTimeImmutable</class> и его
  функциями.
  
  Возвращает новый объект DateTime.

<comment>Param:</comment>
  <info>string</info>             <strong>$datetime</strong>  Строка даты/времени. Объяснение корректных форматов дано в разделе
                                Форматы даты и времени.
                                
                                Если используется аргумент <strong>$timezone</strong>, то для получения текущего
                                времени в новом объекте достаточно передать <return>"now"</return> в качестве этого
                                аргумента.
  <info>DateTimeZone|null</info>  <strong>$timezone</strong>  Объект класса <class>DateTimeZone</class>, представляющий часовой пояс параметра
                                <strong>$datetime</strong>.
                                
                                Если аргумент <strong>$timezone</strong> не задан или <info>null</info>, будет использован текущий
                                часовой пояс.
                                
                                Значение аргумента <strong>$timezone</strong>, равно как и текущий часовой пояс не
                                будут учитываться, если в качестве аргумента <strong>$datetime</strong> передаётся
                                метка времени UNIX (например, <return>@946684800</return>) или время, в котором
                                часовой пояс уже содержится (например, <return>2010-01-28T15:00:00+02:00</return>).

<comment>Return:</comment>
  <info>unknown</info>  Возвращает созданный объект класса DateTime.

<comment>See Also:</comment>
   * DateTimeImmutable::__construct


id: DateTime::__set_state
type: function
doc:
<comment>Description:</comment>
  Обработчик __set_state
  
  Обработчик __set_state().
  
  Подобен методу DateTimeImmutable::__set_state, за исключением работы с объектом <class>DateTime</class>.

<comment>Param:</comment>
  <info>array</info>  <strong>$array</strong>  Массив для инициализации.

<comment>Return:</comment>
  <info>DateTime</info>  Возвращает новый экземпляр класса DateTime.


id: DateTime::__wakeup
type: function
doc:
<comment>Description:</comment>
  Обработчик __wakeup
  
  Обработчик __wakeup().

<comment>Return:</comment>
  <info>void</info>  Инициализирует объект DateTime.


id: DateTime::add
type: function
doc:
<comment>Description:</comment>
  Изменяет объект DateTime, добавляя количество дней, месяцев, лет, часов, минут и секунд
  
  Объектно-ориентированный стиль
  
  Процедурный стиль
  
  Прибавляет заданный объект <class>DateInterval</class> к объекту <class>DateTime</class>.
  
  Подобен методу DateTimeImmutable::add, за исключением работы с объектом <class>DateTime</class>.
  
  Процедурная версия принимает в качестве первого аргумента объект <class>DateTime</class>.

<comment>Param:</comment>
  <info>DateTime</info>      <strong>$object</strong>    Только для процедурного стиля: объект <class>DateTime</class>, возвращаемый
                           <strong>date_create()</strong>. Функция изменяет этот объект.
  <info>DateInterval</info>  <strong>$interval</strong>  Объект класса <class>DateInterval</class>.

<comment>Return:</comment>
  <info>DateTime</info>  Возвращает модифицированный объект <class>DateTime</class> для применения в цепи методов.

<comment>See Also:</comment>
   * <strong>DateTimeImmutable::add()</strong>


id: DateTime::createFromFormat
type: function
doc:
<comment>Description:</comment>
  Разбирает строку с датой согласно указанному формату
    
  
  Объектно-ориентированный стиль
  
  Процедурный стиль
  
  Возвращает новый объект DateTime, представляющий дату и время, заданные строкой <strong>$datetime</strong>, которая
  была отформатирована в указанном <strong>$format</strong>.
  
  Подобен методу DateTimeImmutable::createFromFormat и функции <strong>date_create_immutable_from_format()</strong>,
  но создаёт объект <class>DateTime</class>.
  
  Этот метод, включая параметры, примеры и мнения, документирован на странице
  DateTimeImmutable::createFromFormat.

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

<comment>See Also:</comment>
   * <strong>DateTimeImmutable::createFromFormat()</strong>


id: DateTime::createFromImmutable
type: function
doc:
<comment>Description:</comment>
  Возвращает экземпляр DateTime инкапсулирующий заданный объект DateTimeImmutable

<comment>Param:</comment>
  <info>DateTimeImmutable</info>  <strong>$object</strong>  Неизменяемый объект <class>DateTimeImmutable</class>, который нуждается в
                              преобразовании в изменяемую форму. Сам объект не изменяется, а вместо
                              этого создаётся новый экземпляр <class>DateTime</class>, содержащий те же данные:
                              дату, время и часовой пояс.

<comment>Return:</comment>
  <info>static</info>  Возвращает новый объект класса <class>DateTime</class>.


id: DateTime::createFromInterface
type: function
doc:
<comment>Description:</comment>
  Возвращает новый объект DateTime, созданный из переданного объекта, реализующего интерфейс
  DateTimeInterface

<comment>Param:</comment>
  <info>DateTimeInterface</info>  <strong>$object</strong>  Объект, реализующий интерфейс <class>DateTimeInterface</class>, из которого надо
                              получить изменяемую версию. Сам объект не модифицируется. На его
                              основе создаётся новый объект <class>DateTime</class>, содержащий ту же информацию о
                              дате, времени и часовом поясе.

<comment>Return:</comment>
  <info>DateTime</info>  Возвращает новый объект <class>DateTime</class>.


id: DateTime::diff
type: function
doc:
<comment>Description:</comment>
  Возвращает разницу между двумя объектами DateTime
  
  Объектно-ориентированный стиль
  
  Процедурный стиль
  
  Возвращает разницу между двумя объектами <class>DateTimeInterface</class>.

<comment>Param:</comment>
  <info></info>      <strong>$datetime</strong>  Дата и время для сравнения.
  <info>bool</info>  <strong>$absolute</strong>  Определяет, будет ли интервал принудительно переведен в абсолютную величину.

<comment>Return:</comment>
  <info>DateInterval</info>  Возвращает объект <class>DateInterval</class>, который представляет разницу между двумя датами.
                
                Возвращаемое значение более конкретно представляет временной интервал, который при
                применении к исходному объекту (<strong>$this</strong> или <strong>$originObject</strong>) приводит к объекту
                <strong>$targetObject</strong>. Этот процесс не всегда обратим.
                
                Метод учитывает смену часовых поясов и поэтому может возвращать интервал <return>24 hours
                and 30 minutes</return>, как в одном из примеров. Если нужно рассчитывать по абсолютному
                времени, необходимо сначала преобразовать объекты <strong>$this</strong>/<strong>$baseObject</strong> и <strong>$targetObject</strong>
                в UTC.

<comment>See Also:</comment>
   * <strong>DateInterval::format()</strong>
   * <strong>DateTime::add()</strong>
   * <strong>DateTime::sub()</strong>


id: DateTime::format
type: function
doc:
<comment>Description:</comment>
  Возвращает дату, отформатированную согласно переданному формату
  
  Объектно-ориентированный стиль
  
  Процедурный стиль
  
  Возвращает строку даты, преобразованной согласно переданному формату.

<comment>Param:</comment>
  <info>DateTimeInterface</info>  <strong>$object</strong>  Только для процедурного стиля: объект <class>DateTime</class>, возвращаемый
                              <strong>date_create()</strong>.
  <info>string</info>             <strong>$format</strong>  Шаблон результирующей строки (<info>string</info>) с датой. Смотрите параметры
                              форматирования ниже. Также существует несколько предопределённых
                              констант даты/времени, которые могут быть использованы вместо этих
                              параметров. Например: <info>DATE_RSS</info> заменяет шаблон <return>'D, d M Y H:i:s'</return>.
                              
                              В параметре <strong>$format</strong> распознаются следующие символыСимвол в строке
                              <strong>$format</strong>ОписаниеПример возвращаемого значенияДень------<return>d</return>День месяца, 2
                              цифры с ведущим нулёмОт <return>01</return> до <return>31</return><return>D</return>Текстовое представление дня недели, 3
                              символаОт <return>Mon</return> до <return>Sun</return><return>j</return>День месяца без ведущего нуляОт <return>1</return> до <return>31</return><return>l</return>
                              (строчная 'L')Полное наименование дня неделиОт <return>Sunday</return> до
                              <return>Saturday</return><return>N</return>Порядковый номер дня недели в соответствии со стандартом ISO
                              8601От <return>1</return> (понедельник) до <return>7</return> (воскресенье)<return>S</return>Английский суффикс
                              порядкового числительного дня месяца, 2 символа<return>st</return>, <return>nd</return>, <return>rd</return> или <return>th</return>.
                              Применяют совместно с <return>j</return> <return>w</return>Порядковый номер дня неделиОт <return>0</return> (воскресенье)
                              до <return>6</return> (суббота)<return>z</return>Порядковый номер дня в году (начиная с 0)От <return>0</return> до
                              <return>365</return>Неделя------<return>W</return>Порядковый номер недели года в соответствии со
                              стандартом ISO 8601; недели начинаются с понедельникаНапример: <return>42</return>
                              (42-я неделя года)Месяц------<return>F</return>Полное наименование месяца, например,
                              January или MarchОт <return>January</return> до <return>December</return><return>m</return>Порядковый номер месяца с
                              ведущим нулёмОт <return>01</return> до <return>12</return><return>M</return>Сокращённое наименование месяца, 3 символаОт
                              <return>Jan</return> до <return>Dec</return><return>n</return>Порядковый номер месяца без ведущего нуляОт <return>1</return> до
                              <return>12</return><return>t</return>Количество дней в указанном месяцеОт <return>28</return> до <return>31</return>Год------<return>L</return>Признак
                              високосного года<return>1</return>, если год високосный, иначе <return>0</return>.<return>o</return>Номер года в
                              соответствии со стандартом ISO 8601. Имеет то же значение, что и <return>Y</return>,
                              кроме случая, когда номер недели ISO (<return>W</return>) принадлежит предыдущему или
                              следующему году; тогда будет использован год этой недели.Примеры: <return>1999</return>
                              или <return>2003</return><return>X</return> Расширенное полное числовое представление года, не менее 4
                              цифр, с <return>-</return> для годов до нашей эры и <return>+</return> для годов нашей эры.  Примеры:
                              <return>-0055</return>, <return>+0787</return>, <return>+1999</return>, <return>+10191</return> <return>x</return> Расширенное полное числовое
                              представление, если требуется, или стандартное полное числовое
                              представление, если возможно (например, <return>Y</return>). Не менее четырёх цифр. Для
                              годов до нашей эры указан префикс <return>-</return>. У годов после (и включая) <return>10000</return>
                              префикс <return>+</return>.  Примеры: <return>-0055</return>, <return>0787</return>, <return>1999</return>, <return>+10191</return> <return>Y</return>Полное числовое
                              представление года, не менее 4 цифр, с <return>-</return> для годов до нашей эры.
                              Примеры: <return>-0055</return>, <return>0787</return>, <return>1999</return>, <return>2003</return>, <return>10191</return> <return>y</return>Номер года, 2 цифрыПримеры:
                              <return>99</return>, <return>03</return>Время------<return>a</return>Ante meridiem (лат. «до полудня») или Post meridiem
                              (лат. «после полудня») в нижнем регистре<return>am</return> или <return>pm</return><return>A</return>Ante meridiem или
                              Post meridiem в верхнем регистре<return>AM</return> или <return>PM</return><return>B</return>Время в формате
                              Интернет-времени (альтернативной системы отсчёта времени суток)От <return>000</return>
                              до <return>999</return><return>g</return>Часы в 12-часовом формате без ведущего нуляОт <return>1</return> до <return>12</return><return>G</return>Часы в
                              24-часовом формате без ведущего нуляОт <return>0</return> до <return>23</return><return>h</return>Часы в 12-часовом
                              формате с ведущим нулёмОт <return>01</return> до <return>12</return><return>H</return>Часы в 24-часовом формате с ведущим
                              нулёмОт <return>00</return> до <return>23</return><return>i</return>Минуты с ведущим нулёмОт <return>00</return> до <return>59</return><return>s</return>Секунды с ведущим
                              нулёмОт <return>00</return> до <return>59</return><return>u</return> Микросекунды. Учтите, что функция <strong>date()</strong> всегда
                              будет возвращать значение <return>000000</return>, т. к. она принимает целочисленный
                              (<info>int</info>) параметр, тогда как метод DateTime::format поддерживает
                              микросекунды, если объект <class>DateTime</class> создан с ними. Например: <return>654321</return><return>v</return>
                              Миллисекунды. Замечание такое же, как и для <return>u</return>. Пример: <return>654</return>Часовой
                              пояс------<return>e</return>Идентификатор часового поясаПримеры: <return>UTC</return>, <return>GMT</return>,
                              <return>Atlantic/Azores</return><return>I</return> (заглавная i)Признак летнего времени<return>1</return>, если дата
                              соответствует летнему времени, <return>0</return> в противном случае<return>O</return>Разница со
                              временем по Гринвичу без двоеточия между часами и минутамиНапример:
                              <return>+0200</return><return>P</return>Разница со временем по Гринвичу с двоеточием между часами и
                              минутамиНапример: <return>+02:00</return><return>p</return> То же, что и <return>P</return>, но возвращает <return>Z</return> вместо
                              <return>+00:00</return> (доступен, начиная с PHP 8.0.0) Например: <return>Z</return> или
                              <return>+02:00</return><return>T</return>Аббревиатура часового пояса, если известна; в противном случае
                              смещение по Гринвичу.Примеры: <return>EST</return>, <return>MDT</return>, <return>+05</return><return>Z</return>Смещение часового пояса в
                              секундах. Для часовых поясов, расположенных западнее UTC, возвращаются
                              отрицательные числа, а для расположенных восточнее UTC —
                              положительные.От <return>-43200</return> до <return>50400</return>Полная дата/время------<return>c</return>Дата в формате
                              стандарта ISO 86012004-02-12T15:19:21+00:00<return>r</return>Дата в формате RFC 222/RFC
                              5322Например: <return>Thu, 21 Dec 2000 16:01:07 +0200</return><return>U</return>Количество секунд,
                              прошедших с начала Эпохи Unix (1 января 1970 00:00:00 GMT)Смотрите
                              также <strong>time()</strong>
                              
                              Любые другие символы, встреченные в строке-шаблоне, будут выведены в
                              результирующую строку без изменений. <return>Z</return> всегда возвращает <return>0</return> при
                              использовании <strong>gmdate()</strong>.
                              
                              Поскольку эта функция принимает в качестве параметра целочисленные
                              (<info>int</info>) метки времени, форматирующий символ <return>u</return> будет полезен только при
                              работе с функцией <strong>date_format()</strong> и пользовательскими метками времени,
                              созданными функцией <strong>date_create()</strong>.

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

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


id: DateTime::getLastErrors
type: function
doc:
<comment>Description:</comment>
  Псевдоним DateTimeImmutable::getLastErrors
  
  Функция является псевдонимом:  DateTimeImmutable::getLastErrors


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

<comment>Param:</comment>
  <info>DateTimeInterface</info>  <strong>$object</strong>  Только для процедурного стиля: объект <class>DateTime</class>, возвращаемый
                              <strong>date_create()</strong>.

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


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

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

<comment>See Also:</comment>
   * <strong>DateTime::setTimestamp()</strong>
   * <strong>DateTimeImmutable::setTimestamp()</strong>
   * <strong>DateTimeInterface::format()</strong>


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

<comment>Param:</comment>
  <info>DateTimeInterface</info>  <strong>$object</strong>  Только для процедурного стиля: объект <class>DateTime</class>, возвращаемый
                              <strong>date_create()</strong>.

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

<comment>See Also:</comment>
   * <strong>DateTime::setTimezone()</strong>


id: DateTime::modify
type: function
doc:
<comment>Description:</comment>
  Изменение временной метки
  
  Объектно-ориентированный стиль
  
  Процедурный стиль
  
  Изменяет метку времени объекта DateTime путём добавления или вычитания времени в формате, принятом
  для функции <strong>DateTimeImmutable::__construct()</strong>.

<comment>Param:</comment>
  <info>DateTime</info>  <strong>$object</strong>    Только для процедурного стиля: объект <class>DateTime</class>, возвращаемый <strong>date_create()</strong>.
                       Функция изменяет этот объект.
  <info>string</info>    <strong>$modifier</strong>  Строка даты/времени. Объяснение корректных форматов дано в разделе Форматы
                       даты и времени.

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

<comment>See Also:</comment>
   * <strong>strtotime()</strong>
   * <strong>DateTimeImmutable::modify()</strong>
   * <strong>DateTime::add()</strong>
   * <strong>DateTime::sub()</strong>
   * <strong>DateTime::setDate()</strong>
   * <strong>DateTime::setISODate()</strong>
   * <strong>DateTime::setTime()</strong>
   * <strong>DateTime::setTimestamp()</strong>


id: DateTime::setDate
type: function
doc:
<comment>Description:</comment>
  Устанавливает дату
  
  Объектно-ориентированный стиль
  
  Процедурный стиль
  
  Переустанавливает текущее значение даты объекта DateTime в новое значение.
  
  Подобен методу DateTimeImmutable::setDate, за исключением работы с объектом <class>DateTime</class> и изменением
  существующего объекта.
  
  Процедурная версия принимает объект <class>DateTime</class> в качестве первого аргумента.

<comment>Param:</comment>
  <info>DateTime</info>  <strong>$object</strong>  Только для процедурного стиля: объект <class>DateTime</class>, возвращаемый <strong>date_create()</strong>.
                     Функция изменяет этот объект.
  <info>int</info>       <strong>$year</strong>    Год новой даты.
  <info>int</info>       <strong>$month</strong>   Месяц новой даты.
  <info>int</info>       <strong>$day</strong>     День новой даты.

<comment>Return:</comment>
  <info>DateTime</info>  Возвращает модифицированный объект <class>DateTime</class> для применения в цепи методов.

<comment>See Also:</comment>
   * <strong>DateTimeImmutable::setDate()</strong>


id: DateTime::setISODate
type: function
doc:
<comment>Description:</comment>
  Устанавливает дату в формате ISO
  
  Объектно-ориентированный стиль
  
  Процедурный стиль
  
  Установка даты в соответствии со стандартом ISO 8601, в котором использование недель и смещения в
  днях предпочтительней указания даты.
  
  Подобен методу DateTimeImmutable::setISODate, за исключением работы с объектом <class>DateTime</class>.
  
  Процедурная версия принимает объект <class>DateTime</class> в качестве первого аргумента.

<comment>Param:</comment>
  <info>DateTime</info>  <strong>$object</strong>     Только для процедурного стиля: объект <class>DateTime</class>, возвращаемый <strong>date_create()</strong>.
                        Функция изменяет этот объект.
  <info>int</info>       <strong>$year</strong>       Год новой даты.
  <info>int</info>       <strong>$week</strong>       Неделя новой даты.
  <info>int</info>       <strong>$dayOfWeek</strong>  Смещение относительно начала недели.

<comment>Return:</comment>
  <info>DateTime</info>  Возвращает модифицированный объект <class>DateTime</class> для применения в цепи методов.

<comment>See Also:</comment>
   * <strong>DateTimeImmutable::setISODate()</strong>


id: DateTime::setTime
type: function
doc:
<comment>Description:</comment>
  Устанавливает время
  
  Объектно-ориентированный стиль
  
  Процедурный стиль
  
  Переустанавливает текущее значение времени объекта DateTime в новое значение.
  
  Подобен методу DateTimeImmutable::setTime, за исключением работы с объектом <class>DateTime</class>.
  
  Процедурная версия принимает объект <class>DateTime</class> в качестве первого аргумента.

<comment>Param:</comment>
  <info>DateTime</info>  <strong>$object</strong>       Только для процедурного стиля: объект <class>DateTime</class>, возвращаемый
                          <strong>date_create()</strong>. Функция изменяет этот объект.
  <info>int</info>       <strong>$hour</strong>         Час нового времени.
  <info>int</info>       <strong>$minute</strong>       Минуты нового времени.
  <info>int</info>       <strong>$second</strong>       Секунды нового времени.
  <info>int</info>       <strong>$microsecond</strong>  Микросекунды.

<comment>Return:</comment>
  <info>DateTime</info>  Возвращает модифицированный объект <class>DateTime</class> для применения в цепи методов.

<comment>See Also:</comment>
   * <strong>DateTimeImmutable::setTime()</strong>


id: DateTime::setTimestamp
type: function
doc:
<comment>Description:</comment>
  Устанавливает дату и время на основе метки времени Unix
    
  
  Объектно-ориентированный стиль
  
  Процедурный стиль
  
  Устанавливает дату и время, основываясь на метке времени Unix.
  
  Подобен методу DateTimeImmutable::setTimestamp, за исключением работы с объектом <class>DateTime</class>.
  
  Процедурная версия принимает объект <class>DateTime</class> в качестве первого аргумента.

<comment>Param:</comment>
  <info>DateTime</info>  <strong>$object</strong>     Только для процедурного стиля: объект <class>DateTime</class>, возвращаемый <strong>date_create()</strong>.
                        Функция изменяет этот объект.
  <info>int</info>       <strong>$timestamp</strong>  Метка времени Unix, представляющая дату. Установка меток времени за
                        пределами диапазона целых чисел (<info>int</info>) возможно при использовании
                        DateTimeImmutable::modify с форматом <return>@</return>.

<comment>Return:</comment>
  <info>DateTime</info>  Возвращает модифицированный объект <class>DateTime</class> для применения в цепи методов.

<comment>See Also:</comment>
   * <strong>DateTimeImmutable::setTimestamp()</strong>


id: DateTime::setTimezone
type: function
doc:
<comment>Description:</comment>
  Устанавливает часовой пояс для объекта класса DateTime
    
  
  Объектно-ориентированный стиль
  
  Процедурный стиль
  
  Устанавливает новый часовой пояс для объекта (<info>object</info>) <class>DateTime</class>.
  
  Подобен методу DateTimeImmutable::setTimezone, за исключением работы с объектом <class>DateTime</class>.
  
  Процедурная версия принимает объект <class>DateTime</class> в качестве первого аргумента.

<comment>Param:</comment>
  <info>DateTime</info>      <strong>$object</strong>    Только для процедурного стиля: объект <class>DateTime</class>, возвращаемый
                           <strong>date_create()</strong>. Функция изменяет этот объект.
  <info>DateTimeZone</info>  <strong>$timezone</strong>  Объект класса <class>DateTimeZone</class>, представляющий требуемый часовой пояс.

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

<comment>See Also:</comment>
   * <strong>DateTimeImmutable::setTimezone()</strong>
   * <strong>DateTime::getTimezone()</strong>
   * <strong>DateTimeZone::__construct()</strong>


id: DateTime::sub
type: function
doc:
<comment>Description:</comment>
  Вычитает дни, месяцы, годы, часы, минуты и секунды из объекта DateTime
    
  
  Объектно-ориентированный стиль
  
  Процедурный стиль
  
  Вычитает из времени объекта DateTime заданный интервал <class>DateInterval</class>.
  
  Подобен методу DateTimeImmutable::sub, за исключением работы с объектом <class>DateTime</class>.
  
  Процедурная версия принимает объект <class>DateTime</class> в качестве первого аргумента.

<comment>Param:</comment>
  <info>DateTime</info>      <strong>$object</strong>    Только для процедурного стиля: объект <class>DateTime</class>, возвращаемый
                           <strong>date_create()</strong>. Функция изменяет этот объект.
  <info>DateInterval</info>  <strong>$interval</strong>  Объект класса <class>DateInterval</class>

<comment>Return:</comment>
  <info>DateTime</info>  Возвращает модифицированный объект <class>DateTime</class> для применения в цепи методов.

<comment>See Also:</comment>
   * <strong>DateTimeImmutable::sub()</strong>


id: DateTimeImmutable
type: class
doc:
<comment>Description:</comment>
  Представление даты и времени.
  
  Этот класс ведёт себя так же, как и класс <class>DateTime</class>, за исключением того, что при вызове методов
  изменения, таких как <strong>DateTime::modify()</strong>, возвращаются новые объекты.


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

<comment>Param:</comment>
  <info>string</info>             <strong>$datetime</strong>  Строка даты/времени. Объяснение корректных форматов дано в разделе
                                Форматы даты и времени.
                                
                                Для получения текущего времени в параметр <strong>$timezone</strong> можно передать
                                строку <return>"now"</return>.
  <info>DateTimeZone|null</info>  <strong>$timezone</strong>  Объект <class>DateTimeZone</class>, представляющий часовой пояс параметра
                                <strong>$datetime</strong>.
                                
                                Если параметр <strong>$timezone</strong> опущен или равен <info>null</info>, будет использован
                                текущий часовой пояс.
                                
                                Параметр <strong>$timezone</strong> и текущий часовой пояс будут проигнорированы,
                                если параметр <strong>$datetime</strong> либо является временной меткой UNIX
                                (например, <return>@946684800</return>), либо указан часовой пояс (например,
                                <return>2010-01-28T15:00:00+02:00</return> или <return>2010-07-05T06:00:00Z</return>).

<comment>Return:</comment>
  <info>DateTimeImmutable|false</info>  Возвращает новый экземпляр DateTimeImmutable.


id: DateTimeImmutable::__set_state
type: function
doc:
<comment>Description:</comment>
  Обработчик __set_state
  
  Обработчик __set_state().

<comment>Param:</comment>
  <info>array</info>  <strong>$array</strong>  Инициализирующий массив.

<comment>Return:</comment>
  <info>DateTimeImmutable</info>  Возвращает новый экземпляр объекта DateTimeImmutable.


id: DateTimeImmutable::add
type: function
doc:
<comment>Description:</comment>
  Возвращает новый объект с добавленным количеством дней, месяцев, лет, часов, минут и секунд
  
  Создаёт новый объект <class>DateTimeImmutable</class> и добавляет к нему указанный объект <class>DateInterval</class> для
  представления нового значения.

<comment>Param:</comment>
  <info>DateInterval</info>  <strong>$interval</strong>  Объект <class>DateInterval</class>.

<comment>Return:</comment>
  <info>DateTimeImmutable</info>  Возвращает новый объект <class>DateTimeImmutable</class> с модифицированными данными.

<comment>See Also:</comment>
   * <strong>DateTimeImmutable::sub()</strong>
   * <strong>DateTimeImmutable::diff()</strong>
   * <strong>DateTimeImmutable::modify()</strong>


id: DateTimeImmutable::createFromFormat
type: function
doc:
<comment>Description:</comment>
  Разбирает строку с датой согласно указанному формату
  
  Объектно-ориентированный стиль
  
  Процедурный стиль
  
  Возвращает новый объект DateTimeImmutable, представляющий дату и время, указанные строкой в
  параметре <strong>$datetime</strong>, которые были отформатированы в заданном формате <strong>$format</strong>.

<comment>Param:</comment>
  <info>string</info>             <strong>$format</strong>    Формат даты и времени в виде строки (<info>string</info>), которому соответствует
                                значение второго аргумента функции. Список вариантов форматирования
                                представлен ниже. В большинстве случаев, при форматировании
                                используются те же символы, что и в функции <strong>date()</strong>.
                                
                                Все поля инициализируются с текущей датой/временем. В большинстве
                                случаев будет необходимо их "обнулить" (эпоха Unix, <return>1970-01-01
                                00:00:00 UTC</return>). Для этого нужно добавить символ <return>!</return> в качестве первого
                                символа параметра <strong>$format</strong> или <return>|</return> в качестве последнего. Для получения
                                дополнительной информации смотрите документацию по каждому символу
                                ниже.
                                
                                Формат разбирается слева направо, это означает, что в некоторых
                                ситуациях порядок присутствия символов формата влияет на результат.
                                В случае <return>z</return> (день года) требуется, чтобы год уже был разобран,
                                например, с помощью символов <return>Y</return> или <return>y</return>.
                                
                                Символы для разбора чисел допускают широкий диапазон значений,
                                выходящий за пределы логического диапазона. Например, <return>d</return> (день
                                месяца) принимает значения в диапазоне от <return>00</return> до <return>99</return>. Единственным
                                ограничением является количество цифр. Когда задаются выходящие за
                                пределы диапазона значения, срабатывает механизм переполнения
                                анализатора даты/времени. Ниже показано несколько примеров такого
                                поведения.
                                
                                Это означает, что разобранные данные для буквы формата являются
                                жадными и будут считываться до количества цифр, допускаемого
                                форматом. Также это означает, что в строке <strong>$datetime</strong> уже не хватает
                                символов для следующих символов формата. Пример на этой странице
                                также иллюстрирует эту проблему.
                                
                                Список возможных символов для составления строки <strong>$format</strong> Символ в
                                строке <strong>$format</strong>ОписаниеВозможные значенияДень------<return>d</return> и <return>j</return> День месяца,
                                2 цифры с нулём в начале или без него  От <return>01</return> до <return>31</return> либо от <return>1</return> до <return>31</return>.
                                (допускается использование двузначных чисел, превышающих количество
                                дней в месяце, в этом случае разница переносится на следующий месяц.
                                Например, использование числа 33 с январём означает 2 февраля) <return>D</return> и <return>l</return>
                                Текстовое представление дня недели  От <return>Mon</return> до <return>Sun</return> либо от <return>Sunday</return> до
                                <return>Saturday</return>. Если заданное имя дня отличается от имени дня,
                                принадлежащего разобранной дате (или дате по умолчанию), то
                                происходит переполнение до следующей даты с заданным именем дня.
                                Смотрите примеры ниже для объяснения. <return>S</return> Суффикс для числа в
                                английской нумерации, 2 буквы. Эти буквы будут пропущены при разборе
                                строки. <return>st</return>, <return>nd</return>, <return>rd</return> или <return>th</return>. <return>z</return> Номер дня с начала года (начиная с 0);
                                должно предшествовать <return>Y</return> или <return>y</return>.  C <return>0</return> по <return>365</return>. (Допускаются трёхзначные
                                числа, превышающие числа в году, в этом случае разница переносится
                                на следующий год. Например, использование числа 366 с 2022 годом
                                означает 2 января 2023 года) Месяц------<return>F</return> и <return>M</return> Текстовое
                                представление месяца, например January или Sept  С <return>January</return> по
                                <return>December</return> либо с <return>Jan</return> по <return>Dec</return> <return>m</return> и <return>n</return> Числовое представление месяца с
                                первым нулём или без него  С <return>01</return> по <return>12</return> либо с <return>1</return> по <return>12</return>. (Допускаются
                                двузначные числа больше 12, в этом случае разница переносится на
                                следующий год. Например, использование числа 13 означает январь в
                                следующем году) Год------<return>X</return> и <return>x</return> Полное числовое представление года,
                                до 19 цифр, с префиксом <return>+</return> или <return>-</return>.  Примеры: <return>0055</return>, <return>787</return>, <return>1999</return>, <return>-2003</return>,
                                <return>+10191</return> <return>Y</return> Полное числовое представление года, до 4 цифр.  Примеры:
                                <return>0055</return>, <return>787</return>, <return>1999</return>, <return>2003</return>. <return>y</return> 2 цифры в представлении года (в диапазоне
                                1970-2069 включительно)  Примеры: <return>99</return> или <return>03</return> (будет расшифровано как
                                <return>1999</return> и <return>2003</return> соответственно) Время------<return>a</return> и <return>A</return> До полудня и После
                                полудня <return>am</return> или <return>pm</return><return>g</return> и <return>h</return> 12-ти часовой формат времени с первым нулём
                                или без него  С <return>1</return> по <return>12</return> либо с <return>01</return> по <return>12</return>. (допускается использование
                                двузначных чисел больше 12, в этом случае разница переносится на
                                следующий день. Например, использование числа <return>14</return> означает <return>02</return> в
                                следующем периоде AM/PM) <return>G</return> и <return>H</return> 24-х часовой формат времени с нулём в
                                начале или без него  С <return>0</return> по <return>23</return> или с <return>00</return> по <return>23</return> (допускаются
                                двузначные числа больше 24, в этом случае разница переносится на
                                следующий день. Например, использование <return>26</return> означает <return>02:00</return> следующего
                                дня) <return>i</return> Минуты с нулём в начале  С <return>00</return> по <return>59</return>. (допускается
                                использование двузначных чисел больше 59, в этом случае разница
                                переносится на следующий час. Например, использование числа <return>66</return>
                                означает <return>:06</return> следующего часа) <return>s</return>Секунды с нулём в начале От <return>00</return> до <return>59</return>.
                                (допускаются двузначные числа больше 59, в этом случае разница
                                переносится на следующую минуту. Например, использование числа <return>90</return>
                                означает <return>:30</return> следующей минуты) <return>v</return>Дробь в миллисекундах (до 3
                                цифр)Примеры: <return>12</return> (<return>0.12</return> секунд), <return>345</return> (<return>0.345</return> секунд)<return>u</return>Дробь в
                                микросекундах (до 6 цифр)Примеры: <return>45</return> (<return>0.45</return> секунд), <return>654321</return> (<return>0.654321</return>
                                секунд)Часовой пояс------<return>e</return>, <return>O</return>, <return>P</return> и <return>T</return>  Идентификатор часового пояса,
                                либо разница в часах относительно UTC, либо разница относительно UTC
                                с двоеточием между часами и минутами, либо аббревиатура часового
                                пояса Примеры: <return>UTC</return>, <return>GMT</return>, <return>Atlantic/Azores</return> или <return>+0200</return> или <return>+02:00</return> или
                                <return>EST</return>, <return>MDT</return> Дата/Время полностью------<return>U</return> Количество секунд с начала
                                Эпохи Unix (January 1 1970 00:00:00 GMT) Пример: <return>1292177455</return>Пробел и
                                Разделители------<return> </return> (пробел)Ноль или несколько символов пробела,
                                табуляции, неразрывного пробела NBSP (U+A0) или узкого неразрывного
                                пробела NNBSP (U+202F)Пример: <return>"\t"</return>, <return>"  "</return><return>#</return> Один из следующих
                                символов: <return>;</return>, <return>:</return>, <return>/</return>, <return>.</return>, <return>,</return>, <return>-</return>, <return>(</return> или <return>)</return> Пример: <return>/</return><return>;</return>, <return>:</return>, <return>/</return>, <return>.</return>, <return>,</return>, <return>-</return>, <return>(</return> или
                                <return>)</return> Символ разделитель.Пример: <return>-</return><return>?</return>Один случайный (любой) символ Пример:
                                <return>^</return> (Будьте внимательны: в UTF-8 кодировке вам может потребоваться
                                более одного <return>?</return>, так как там один символ может занимать более одного
                                байта. В таких случаях может помочь использование <return>*</return>. <return>*</return> Любое
                                количество любых символов до следующего разделителя  Пример: <return>*</return> в
                                <return>Y-*-d</return> для строки <return>2009-aWord-08</return> будет соответствовать <return>aWord</return> <return>!</return>
                                Сбрасывает все поля (год, месяц, день, час, минута, секунда и
                                часовой пояс) до нулевых значений (<return>0</return> для часа, минуты, секунды, <return>1</return>
                                для месяца и дня, <return>1970</return> для года и <return>UTC</return> для информации о часовом
                                поясе).  Без <return>!</return> все поля будут соответствовать текущему времени. <return>|</return>
                                Сбрасывает значения незаданных полей (год, месяц, день, час, минута,
                                секунда, часовой пояс) до нулевых значений. <return>Y-m-d|</return> установит год,
                                месяц и день в соответствии с данными в строке, а часы, минуты и
                                секунды установит в 0. <return>+</return> Если задан этот спецификатор, данные,
                                завершающие строку (нуль байт например) не будут вызывать ошибку,
                                только предупреждение  Используйте DateTime::getLastErrors для
                                определения, были ли в строке завершающие символы.
                                
                                Наличие в строке формата нераспознаваемых символов, отсутствующих в
                                списке выше, приведёт к ошибке разбора строки. В этом случае
                                сообщение об ошибке будет добавлено в возвращаемую структуру.
                                Получить это сообщение можно с помощью функции
                                DateTime::getLastErrors.
                                
                                Для вставки в <strong>$format</strong> буквенного символа, вы должны экранировать его
                                с помощью обратного слеша(<return>\</return>).
                                
                                Если <strong>$format</strong> не содержит символ <return>!</return>, то значения полей, не заданных в
                                строке формата, будут установлены в соответствии с текущим временем.
                                
                                Если <strong>$format</strong> содержит символ <return>!</return>, то значения полей, не заданных в
                                строке формата (равно как и значения полей слева от <return>!</return>) будут
                                установлены в соответствии со значениями полей начала Эпохи Unix.
                                
                                Если любой символ времени разобран, то все остальные поля, связанные
                                с временем, устанавливаются в "0", если они также не разобраны.
                                
                                Начало эпохи Unix 1970-01-01 00:00:00 UTC.
  <info>string</info>             <strong>$datetime</strong>  Строка, представляющая время.
  <info>DateTimeZone|null</info>  <strong>$timezone</strong>  Объект класса <class>DateTimeZone</class>, представляющий ожидаемый часовой пояс.
                                
                                Если <strong>$timezone</strong> не указан или <info>null</info> и <strong>$datetime</strong> не содержит часовой
                                пояс, то будет использован текущий часовой пояс.
                                
                                Параметр <strong>$timezone</strong> и текущий часовой пояс будут проигнорированы,
                                если параметр <strong>$datetime</strong> также содержит метку времени UNIX (то есть
                                timestamp вида <return>946684800</return>) или же указанный часовой пояс (то есть
                                <return>2010-01-28T15:00:00+02:00</return>).

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

<comment>See Also:</comment>
   * <strong>DateTimeImmutable::__construct()</strong>
   * <strong>DateTimeImmutable::getLastErrors()</strong>
   * <strong>checkdate()</strong>
   * <strong>strptime()</strong>


id: DateTimeImmutable::createFromInterface
type: function
doc:
<comment>Description:</comment>
  Возвращает новый объект DateTimeImmutable, созданный из переданного объекта, реализующего
  интерфейс
  DateTimeInterface

<comment>Param:</comment>
  <info>DateTimeInterface</info>  <strong>$object</strong>  Объект, реализующий интерфейс <class>DateTimeInterface</class>, который необходимо
                              сконвертировать в иммутабельную версию. Сам объект не изменяется.
                              Вместо этого возвращается новый объект <class>DateTimeImmutable</class> с теми же
                              значениями даты, времени и часового пояса.

<comment>Return:</comment>
  <info>DateTimeImmutable</info>  Возвращает новый объект <class>DateTimeImmutable</class>.


id: DateTimeImmutable::createFromMutable
type: function
doc:
<comment>Description:</comment>
  Возвращает новый экземпляр DateTimeImmutable, содержащий заданный объект DateTime

<comment>Param:</comment>
  <info>DateTime</info>  <strong>$object</strong>  Изменяемый объект <class>DateTime</class>, который вы хотите преобразовать в неизменяемую
                     версию. Этот объект не изменяется, но вместо этого создаётся новый экземпляр
                     <class>DateTimeImmutable</class>, содержащий ту же самую информацию.

<comment>Return:</comment>
  <info>static</info>  Возвращает новый экземпляр <class>DateTimeImmutable</class>.


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

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


id: DateTimeImmutable::modify
type: function
doc:
<comment>Description:</comment>
  Создаёт новый объект с изменённой временной меткой
  
  Создаёт новый объект <info>DateTimeImmutable</info> с изменённой временной меткой. Первоначальный объект не
  изменяется.

<comment>Param:</comment>
  <info>string</info>  <strong>$modifier</strong>  Строка даты/времени. Объяснение корректных форматов дано в разделе Форматы даты
                     и времени.

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

<comment>See Also:</comment>
   * <strong>DateTimeImmutable::add()</strong>
   * <strong>DateTimeImmutable::sub()</strong>
   * <strong>DateTimeImmutable::setDate()</strong>
   * <strong>DateTimeImmutable::setISODate()</strong>
   * <strong>DateTimeImmutable::setTime()</strong>
   * <strong>DateTimeImmutable::setTimestamp()</strong>


id: DateTimeImmutable::setDate
type: function
doc:
<comment>Description:</comment>
  Устанавливает дату
  
  Возвращает новый объект DateTimeImmutable с текущей датой объекта DateTimeImmutable, установленной
  на заданную дату.

<comment>Param:</comment>
  <info></info>     <strong>$object</strong>  Только для процедурного стиля: объект <class>DateTime</class>, возвращаемый <strong>date_create()</strong>. Функция
                изменяет этот объект.
  <info>int</info>  <strong>$year</strong>    Год даты.
  <info>int</info>  <strong>$month</strong>   Месяц даты.
  <info>int</info>  <strong>$day</strong>     День даты.

<comment>Return:</comment>
  <info>DateTimeImmutable</info>  Возвращает новый объект <class>DateTimeImmutable</class> с модифицированными данными.

<comment>See Also:</comment>
   * <strong>DateTimeImmutable::setISODate()</strong>
   * <strong>DateTimeImmutable::setTime()</strong>


id: DateTimeImmutable::setISODate
type: function
doc:
<comment>Description:</comment>
  Устанавливает дату в формате ISO
  
  Возвращает новый объект DateTimeImmutable с датой, установленной в соответствии со стандартом ISO
  8601 - с использованием смещения недель и дней, а не конкретных дат.

<comment>Param:</comment>
  <info>int</info>  <strong>$year</strong>       Год даты.
  <info>int</info>  <strong>$week</strong>       Неделя даты.
  <info>int</info>  <strong>$dayOfWeek</strong>  Смещение от первого дня недели.

<comment>Return:</comment>
  <info>DateTimeImmutable</info>  Возвращает новый объект <class>DateTimeImmutable</class> с модифицированными данными.

<comment>See Also:</comment>
   * <strong>DateTimeImmutable::setDate()</strong>
   * <strong>DateTimeImmutable::setTime()</strong>


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

<comment>Param:</comment>
  <info>int</info>  <strong>$hour</strong>         Час времени.
  <info>int</info>  <strong>$minute</strong>       Минута времени.
  <info>int</info>  <strong>$second</strong>       Секунда времени.
  <info>int</info>  <strong>$microsecond</strong>  Микросекунда времени.

<comment>Return:</comment>
  <info>DateTimeImmutable</info>  Возвращает новый объект <class>DateTimeImmutable</class> с модифицированными данными.

<comment>See Also:</comment>
   * <strong>DateTimeImmutable::setDate()</strong>
   * <strong>DateTimeImmutable::setISODate()</strong>


id: DateTimeImmutable::setTimestamp
type: function
doc:
<comment>Description:</comment>
  Устанавливает дату и время на основе метки времени Unix
  
  Возвращает новый объект <info>DateTimeImmutable</info>, построенный из старого, с датой и временем,
  установленными на основе метки времени Unix.

<comment>Param:</comment>
  <info>int</info>  <strong>$timestamp</strong>  Метка времени Unix, представляющая дату. Установка меток времени вне диапазона
                   целого числа (<info>int</info>) возможна при использовании метода DateTimeImmutable::modify с
                   форматом <return>@</return>.

<comment>Return:</comment>
  <info>DateTimeImmutable</info>  Возвращает новый объект <class>DateTimeImmutable</class> с модифицированными данными.

<comment>See Also:</comment>
   * <strong>DateTimeImmutable::getTimestamp()</strong>


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

<comment>Param:</comment>
  <info>DateTimeZone</info>  <strong>$timezone</strong>  Объект <class>DateTimeZone</class>, представляющий желаемый часовой пояс.

<comment>Return:</comment>
  <info>DateTimeImmutable</info>  Возвращает новый модифицированный объект <class>DateTimeImmutable</class> для цепочки методов.
                     Лежащий в основе момент времени не изменяется при вызове метода.

<comment>See Also:</comment>
   * <strong>DateTimeImmutable::getTimezone()</strong>
   * <strong>DateTimeZone::__construct()</strong>


id: DateTimeImmutable::sub
type: function
doc:
<comment>Description:</comment>
  Вычитает переданное количество дней, месяцев, лет, часов, минут и секунд
    
  
  Возвращает новый объект <class>DateTimeImmutable</class>, в котором указанный объект <class>DateInterval</class> вычитается из
  указанного объекта DateTimeImmutable.

<comment>Param:</comment>
  <info></info>              <strong>$object</strong>    Только для процедурного стиля: объект <class>DateTime</class>, возвращаемый
                           <strong>date_create()</strong>. Функция изменяет этот объект.
  <info>DateInterval</info>  <strong>$interval</strong>  Объект <class>DateInterval</class>.

<comment>Return:</comment>
  <info>DateTimeImmutable</info>  Возвращает новый объект <class>DateTimeImmutable</class> с модифицированными данными.

<comment>See Also:</comment>
   * <strong>DateTimeImmutable::add()</strong>
   * <strong>DateTimeImmutable::diff()</strong>
   * <strong>DateTimeImmutable::modify()</strong>


id: DateTimeInterface
type: class
doc:
<comment>Description:</comment>
  Интерфейс DateTimeInterface обобщает работу <class>DateTimeImmutable</class> или <class>DateTime</class>. Невозможно реализовать
  этот интерфейс с пользовательским классом.
  
  Общие константы, позволяющие форматировать объекты <class>DateTimeImmutable</class> или <class>DateTime</class> с помощью
  DateTimeImmutable::format и DateTime::format также определены в этом интерфейсе.


id: DateTimeZone::__construct
type: function
doc:
<comment>Description:</comment>
  Создаёт новый объект DateTimeZone
  
  Объектно-ориентированный стиль
  
  Процедурный стиль
  
  Создаёт новый объект DateTimeZone.
  
  Объект DateTimeZone предоставляет доступ к трём различным типам правил временных зон: Смещение UTC
  (тип <return>1</return>), сокращение часового пояса (тип <return>2</return>) и идентификаторы часовых поясов, опубликованные в базе
  данных часовых поясов IANA (тип <return>3</return>).
  
  Объект DateTimeZone может быть присоединён к объектам <class>DateTime</class> и <class>DateTimeImmutable</class>, чтобы иметь
  возможность отображать часовой пояс, заключённый в этих объектах в локальном часовом поясе.

<comment>Param:</comment>
  <info>string</info>  <strong>$timezone</strong>  Одно из поддерживаемых имён часовых поясов или значение смещения (+0200) или
                     аббревиатура часового пояса (BST).

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


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

<comment>Param:</comment>
  <info>DateTimeZone</info>  <strong>$object</strong>  Только для процедурного стиля: объект <class>DateTimeZone</class>, возвращаемый
                         <strong>timezone_open()</strong>.

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

<comment>See Also:</comment>
   * 
    Функция <strong>DateTimeZone::listIdentifiers()</strong> для получения полного или частичного списка
    всех поддерживаемых идентификаторов часовых поясов.
   


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

<comment>Param:</comment>
  <info>DateTimeZone</info>  <strong>$object</strong>  Объект класса <class>DateTimeZone</class>, для которого нужно получить имя.

<comment>Return:</comment>
  <info>string</info>  В зависимости от типа зоны, смещения UTC (тип 1), аббревиатуры часового пояса (тип 2) и
          идентификаторов часовых поясов, опубликованных в базе данных часовых поясов IANA (тип 3),
          строка дескриптора для создания нового объекта <class>DateTimeZone</class> с тем же смещением и/или
          правилами. Например, <return>02:00</return>, <return>CEST</return> или одно из имён часовых поясов в списке часовых поясов.


id: DateTimeZone::getOffset
type: function
doc:
<comment>Description:</comment>
  Возвращает смещение часового пояса от UTC (GMT)
  
  Объектно-ориентированный стиль
  
  Процедурный стиль
  
  Эта функция возвращает смещение от GMT для даты/времени, указанных в параметре <strong>$datetime</strong>.
  GMT-смещение рассчитывается с помощью информации о часовом поясе, содержащейся в используемом
  объекте DateTimeZone.

<comment>Param:</comment>
  <info>DateTimeZone</info>       <strong>$object</strong>    Только для процедурного стиля: объект <class>DateTimeZone</class>, возвращаемый
                                <strong>timezone_open()</strong>.
  <info>DateTimeInterface</info>  <strong>$datetime</strong>  DateTime, содержащий дату/время, относительно которых вычисляется
                                смещение.

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


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

<comment>Param:</comment>
  <info>DateTimeZone</info>  <strong>$object</strong>          Только для процедурного стиля: объект <class>DateTimeZone</class>, возвращаемый
                                 <strong>timezone_open()</strong>.
  <info>int</info>           <strong>$timestampBegin</strong>  Начальная метка времени.
  <info>int</info>           <strong>$timestampEnd</strong>    Конечная метка времени.

<comment>Return:</comment>
  <info>array|false</info>  В случае успешного выполнения возвращает численно индексированный массив массивов со
               всеми переходами или <info>false</info> в случае возникновения ошибки. Объекты DateTimeZone,
               оборачивающие тип 1 (смещения UTC) и тип 2 (сокращения), не содержат переходов и
               вызов этого метода в таком случае вернёт <info>false</info>.
               
               Если задан параметр <strong>$timestampBegin</strong>, то первая запись в возвращаемом массиве будет
               содержать элемент перехода на момент параметра <strong>$timestampBegin</strong>.
               
               Структура переходов массиваКлючТипОписание<return>ts</return><info>int</info>Метка времени
               Unix<return>time</return><info>string</info><info>DateTimeInterface::ISO8601_EXPANDED</info> (PHP 8.2 и более поздние версии)
               или <info>DateTimeInterface::ISO8601</info> (PHP 8.1 и более ранние версии) строка времени
               <return>offset</return><info>int</info>Смещение от UTC в секундах<return>isdst</return><info>bool</info>Активно ли летнее
               время<return>abbr</return><info>string</info>Аббревиатура часового пояса


id: DateTimeZone::listAbbreviations
type: function
doc:
<comment>Description:</comment>
  Возвращает ассоциативный массив, содержащий флаг перехода на летнее время, смещение и имя часового
  пояса
  
  Объектно-ориентированный стиль
  
  Процедурный стиль
  
  Возвращаемый список аббревиатур включает все исторические случаи использования аббревиатур, что
  может привести к правильным, но запутанным записям. Существуют также противоречия, поскольку <return>PST</return>
  используется как в США, так и на Филиппинах.
  
  Поэтому список, который возвращает эта функция, не подходит для создания массива с опциями для
  представления выбора часового пояса пользователям.
  
  Данные для функции предварительно компилируются из соображений производительности и не обновляются
  при использовании более новой версии timezonedb.

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

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


id: DateTimeZone::listIdentifiers
type: function
doc:
<comment>Description:</comment>
  Возвращает численно индексированный массив со всеми идентификаторами часовых поясов
  
  Объектно-ориентированный стиль
  
  Процедурный стиль

<comment>Param:</comment>
  <info>int</info>          <strong>$timezoneGroup</strong>  Одна из констант класса <class>DateTimeZone</class> (или комбинация из них).
  <info>string|null</info>  <strong>$countryCode</strong>    Двухбуквенный код страны в верхнем регистре, совместимый с ISO
                               3166-1.
                               
                               Эта опция используется только тогда, когда параметр <strong>$timezoneGroup</strong>
                               установлен в <info>DateTimeZone::PER_COUNTRY</info>.

<comment>Return:</comment>
  <info>array</info>  Возвращает массив идентификаторов часовых поясов. Возвращаются только не устаревшие
         элементы. Чтобы получить все, включая устаревшие идентификаторы часовых поясов, используйте
         <return>DateTimeZone::ALL_WITH_BC</return> в качестве значения для параметра <strong>$timezoneGroup</strong>.

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


id: DeflateContext
type: class
doc:
<comment>Description:</comment>
  Полностью непрозрачный класс, заменяющий ресурсы <return>zlib.deflate</return> в PHP 8.0.0.


id: Directory
type: class
doc:
<comment>Description:</comment>
  Экземпляры класса <class>Directory</class> создаются при помощи вызова функции <strong>dir()</strong>, а не при помощи оператора
  new.


id: Directory::close
type: function
doc:
<comment>Description:</comment>
  Закрывает дескриптор каталога

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


id: Directory::read
type: function
doc:
<comment>Description:</comment>
  Получает элемент из дескриптора каталога

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


id: Directory::rewind
type: function
doc:
<comment>Description:</comment>
  Перемещает дескриптор каталога в начало каталога

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


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


id: DirectoryIterator::__construct
type: function
doc:
<comment>Description:</comment>
  Создаёт новый итератор каталогов из пути
  
  Создаёт новый итератор каталогов из пути.

<comment>Param:</comment>
  <info>string</info>  <strong>$directory</strong>  Путь к каталогу, который необходимо обойти.

<comment>See Also:</comment>
   * <class>SplFileInfo</class>
   * <class>Iterator</class>


id: DirectoryIterator::__toString
type: function
doc:
<comment>Description:</comment>
  Получает имя файла в виде строки
  
  Получает имя файла текущего элемента <class>DirectoryIterator</class>.

<comment>Return:</comment>
  <info>string</info>  Возвращает имя файла текущего элемента <class>DirectoryIterator</class>.

<comment>See Also:</comment>
   * DirectoryIterator::getFilename
   * Магический метод __toString()


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

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

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


id: DirectoryIterator::getBasename
type: function
doc:
<comment>Description:</comment>
  Получает базовое имя текущего элемента DirectoryIterator
  
  Получает базовое имя текущего элемента <class>DirectoryIterator</class>.

<comment>Param:</comment>
  <info>string</info>  <strong>$suffix</strong>  Если базовое имя заканчивается на <strong>$suffix</strong>, то он будет отброшен.

<comment>Return:</comment>
  <info>string</info>  Базовое имя текущего элемента <class>DirectoryIterator</class>.

<comment>See Also:</comment>
   * DirectoryIterator::getFilename
   * DirectoryIterator::getPath
   * DirectoryIterator::getPathname
   * <strong>basename()</strong>
   * <strong>pathinfo()</strong>


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

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

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


id: DirectoryIterator::getFilename
type: function
doc:
<comment>Description:</comment>
  Возвращает имя файла текущего элемента DirectoryIterator
  
  Возвращает имя файла текущего элемента <class>DirectoryIterator</class>.

<comment>Return:</comment>
  <info>string</info>  Возвращает имя файла текущего элемента <class>DirectoryIterator</class>.

<comment>See Also:</comment>
   * DirectoryIterator::getBasename
   * DirectoryIterator::getPath
   * DirectoryIterator::getPathname
   * <strong>pathinfo()</strong>


id: DirectoryIterator::isDot
type: function
doc:
<comment>Description:</comment>
  Определяет, является ли текущий элемент DirectoryIterator '.' или '.'.
  
  Определяет, является ли текущий элемент <class>DirectoryIterator</class> <return>.</return> или <return>..</return>

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

<comment>See Also:</comment>
   * DirectoryIterator::getType
   * DirectoryIterator::isDir
   * DirectoryIterator::isFile
   * DirectoryIterator::isLink


id: DirectoryIterator::key
type: function
doc:
<comment>Description:</comment>
  Возвращает ключ для текущего элемента DirectoryIterator
  
  Возвращает ключ для текущего элемента <class>DirectoryIterator</class>.

<comment>Return:</comment>
  <info>mixed</info>  Ключ для текущего элемента <class>DirectoryIterator</class> в виде целого числа (<info>int</info>).

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


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

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

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


id: DirectoryIterator::rewind
type: function
doc:
<comment>Description:</comment>
  Перемотка итератора DirectoryIterator назад к началу
  
  Перемотка итератора <class>DirectoryIterator</class> назад к началу.

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

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


id: DirectoryIterator::seek
type: function
doc:
<comment>Description:</comment>
  Переход к элементу DirectoryIterator
  
  Переход к заданной позиции <class>DirectoryIterator</class>.

<comment>Param:</comment>
  <info>int</info>  <strong>$offset</strong>  Числовая позиция, начинающаяся с нуля, к которой следует перейти.

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

<comment>See Also:</comment>
   * DirectoryIterator::rewind
   * DirectoryIterator::next
   * SeekableIterator::seek


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

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

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


id: DocResult::__construct
type: function
doc:
<comment>Description:</comment>
  Конструктор DocResult
  
  Получить результаты и предупреждения документа, создаётся CollectionFind.


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

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


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

<comment>Return:</comment>
  <info>array</info>  Результат в виде ассоциативного массива, либо <info>null</info>, если результатов нет.


id: DocResult::getWarnings
type: function
doc:
<comment>Description:</comment>
  Получить предупреждения с последней операции
  
  Получает предупреждения от последней операции с MySQL-сервера.

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


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

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


id: Ds\Collection
type: class
doc:
<comment>Description:</comment>
  <class>Collection</class> - это базовый интерфейс, который покрывает функциональность общую для всех структур
  данных в этой библиотеке. Он гарантирует, что все структуры обходимы, счётный и могут быть
  преобразованы в JSON с помощью функции <strong>json_encode()</strong>.


id: Ds\Collection::clear
type: function
doc:
<comment>Description:</comment>
  Удаляет все значения
  
  Удаляет все значения из коллекции.

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


id: Ds\Collection::copy
type: function
doc:
<comment>Description:</comment>
  Возвращает копию коллекции
  
  Возвращает копию коллекции.

<comment>Return:</comment>
  <info>Ds\Collection</info>  Возвращает копию коллекции.


id: Ds\Collection::isEmpty
type: function
doc:
<comment>Description:</comment>
  Проверяет, пуста ли коллекция
  
  Проверяет, пуста ли коллекция.

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


id: Ds\Collection::toArray
type: function
doc:
<comment>Description:</comment>
  Преобразует коллекцию в массив (array)
    
  
  Преобразует коллекцию в <info>array</info>.
  
  Приведение к массиву (<info>array</info>) на данный момент не поддерживается.

<comment>Return:</comment>
  <info>array</info>  Массив (<info>array</info>), содержащий все элементы коллекции в том же порядке.


id: Ds\Deque
type: class
doc:
<comment>Description:</comment>
  Двухсторонняя очередь - это последовательность значений в непрерывном буфере, который растёт и
  уменьшаются автоматически. Deque (произносится как "deck") является аббревиатурой от "double-ended
  queue" и используется внутри <class>Ds\Queue</class>.
  
  Два указателя используются для отслеживания начала и конца. Указатели могут "обернуть" конец
  очереди, что позволяет избежать перемещения значений для освобождения места. Это делает операции
  shift и unshift такими быстрыми, что <class>Ds\Vector</class> не может с этим соперничать.
  
  Доступ к элементу по индексу требует пересчёта в зависимости от его индекса в буфере: ((head +
  position) % capacity).


id: Ds\Deque::__construct
type: function
doc:
<comment>Description:</comment>
  Создаёт новый экземпляр
  
  Создаёт новый экземпляр, используя либо объект, реализующий <class>traversable</class>, либо массив, переданные в
  качестве параметра <strong>$values</strong>.

<comment>Param:</comment>
  <info>mixed</info>  <strong>$values</strong>  Объект, реализующий интерфейс traversable или массив.


id: Ds\Deque::allocate
type: function
doc:
<comment>Description:</comment>
  Выделяет память под указанную вместимость
  
  Гарантирует, что выделено достаточно памяти под заданную вместимость (количество значений).
  Позволяет избежать динамического перераспределения памяти при добавлении значений.

<comment>Param:</comment>
  <info>int</info>  <strong>$capacity</strong>  Вместимость. Предполагаемое количество значений.
                  
                  Если новое значение вместимости меньше текущего, то она не изменится.
                  
                  Значение вместимости округляется до ближайшей степени двойки (т.е. 8, 16, 32, 64,
                  128 и т.д.)

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


id: Ds\Deque::apply
type: function
doc:
<comment>Description:</comment>
  Обновляет все значения, применяя callback-функцию к каждому значению
  
  Обновляет все значения, применяя <strong>$callback</strong>-функцию к каждому значению.

<comment>Param:</comment>
  <info>callable</info>  <strong>$callback</strong>  <info>mixed</info>callback<info>mixed</info><strong>$value</strong>
                       
                       Объект типа <info>callable</info>.
                       
                       Callback-функция должна возвращать новое значение, которое заменит текущее.

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


id: Ds\Deque::capacity
type: function
doc:
<comment>Description:</comment>
  Возвращает текущую вместимость
  
  Возвращает текущую вместимость.

<comment>Return:</comment>
  <info>int</info>  Текущая вместимость.


id: Ds\Deque::clear
type: function
doc:
<comment>Description:</comment>
  Удаляет все значения из двухсторонней очереди
  
  Удаляет все значения из двухсторонней очереди.

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


id: Ds\Deque::contains
type: function
doc:
<comment>Description:</comment>
  Проверяет, содержится ли в двухсторонней очереди заданные значения
  
  Проверяет, содержится ли в двухсторонней очереди заданные значения.

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

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


id: Ds\Deque::copy
type: function
doc:
<comment>Description:</comment>
  Возвращает поверхностную копию коллекции
  
  Возвращает поверхностную копию двухсторонней очереди.

<comment>Return:</comment>
  <info>Ds\Deque</info>  Поверхностная копия двухсторонней очереди.


id: Ds\Deque::count
type: function
doc:
<comment>Description:</comment>
  Возвращает количество элементов двухсторонней очереди
  
  Смотрите <strong>Countable::count()</strong>


id: Ds\Deque::filter
type: function
doc:
<comment>Description:</comment>
  Создаёт новую двухстороннюю очередь из элементов, выбранных с помощью заданной callback-функции
    
  
  Создаёт новую двухстороннюю очередь из элементов, выбранных с помощью заданной callback-функции.

<comment>Param:</comment>
  <info>callable</info>  <strong>$callback</strong>  <info>bool</info>callback<info>mixed</info><strong>$value</strong>
                       
                       Опциональный аргумент типа <info>callable</info>, который возвращает <info>true</info>, если значение
                       должно быть включено и <info>false</info>, если нет.
                       
                       Если callback-функция не задана, то будут включены только элементы, которые
                       приводятся к логическому значению <info>true</info> (смотрите приведение к boolean).

<comment>Return:</comment>
  <info>Ds\Deque</info>  Новая двухсторонняя очередь, содержащая значения, для которых функция <strong>$callback</strong> вернула
            <info>true</info>, либо все элементы, которые при приведении к логическому типу становятся <info>true</info>, если
            параметр <strong>$callback</strong> не задан.


id: Ds\Deque::find
type: function
doc:
<comment>Description:</comment>
  Поиск индекса по значению
    
  
  Возвращает индекс значения <strong>$value</strong> или <info>false</info>, если ничего не найдено.

<comment>Param:</comment>
  <info>mixed</info>  <strong>$value</strong>  Искомое значение.

<comment>Return:</comment>
  <info>mixed</info>  Индекс элемента или <info>false</info>, если значение не найдено.
         
         Элементы сравниваются строго (по типу и значению).


id: Ds\Deque::first
type: function
doc:
<comment>Description:</comment>
  Возвращает первый элемент двухсторонней очереди
  
  Возвращает первый элемент двухсторонней очереди.

<comment>Return:</comment>
  <info>mixed</info>  Первый элемент двухсторонней очереди.


id: Ds\Deque::get
type: function
doc:
<comment>Description:</comment>
  Возвращает значение по индексу
  
  Возвращает значение по заданному индексу.

<comment>Param:</comment>
  <info>int</info>  <strong>$index</strong>  Индекс. Первый элемент имеет индекс 0.

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


id: Ds\Deque::insert
type: function
doc:
<comment>Description:</comment>
  Вставляет значения по указанному индексу
  
  Вставляет значения по указанному индексу.

<comment>Param:</comment>
  <info>int</info>    <strong>$index</strong>   Индекс, по которому необходимо осуществить вставку. 0 \<= index \<= count
                  
                  Можно указывать индекс, равный количеству элементов двухсторонней очереди.
  <info>mixed</info>  <strong>$values</strong>  Значение или значения для вставки.

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


id: Ds\Deque::isEmpty
type: function
doc:
<comment>Description:</comment>
  Проверяет, пуста ли двухсторонняя очередь
  
  Проверяет, пуста ли двухсторонняя очередь.

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


id: Ds\Deque::join
type: function
doc:
<comment>Description:</comment>
  Склеивает все значения в строку
  
  Склеивает все значения в строку, опционально используя заданный разделитель.

<comment>Param:</comment>
  <info>string</info>  <strong>$glue</strong>  Необязательный параметр, задающий разделитель между значениями.

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


id: Ds\Deque::jsonSerialize
type: function
doc:
<comment>Description:</comment>
  Возвращает коллекцию в JSON-представлении
  
  Смотрите <strong>JsonSerializable::jsonSerialize()</strong>
  
  Никогда не используйте эту функцию напрямую.


id: Ds\Deque::last
type: function
doc:
<comment>Description:</comment>
  Возвращает последнее значение двухсторонней очереди
  
  Возвращает последнее значение двухсторонней очереди.

<comment>Return:</comment>
  <info>mixed</info>  Последний элемент двухсторонней очереди.


id: Ds\Deque::map
type: function
doc:
<comment>Description:</comment>
  Возвращает результат применения callback-функции ко всем значениям двухсторонней очереди
  
  Возвращает результат применения callback-функции, переданной в <strong>$callback</strong>, ко всем значениям
  двухсторонней очереди.

<comment>Param:</comment>
  <info>callable</info>  <strong>$callback</strong>  <info>mixed</info>callback<info>mixed</info><strong>$value</strong>
                       
                       Аргумент типа <info>callable</info>.
                       
                       Эта функция должна возвращать новое значение для каждого элемента
                       двухсторонней очереди.

<comment>Return:</comment>
  <info>Ds\Deque</info>  Результат применения <strong>$callback</strong>-функции к каждому значению двухсторонней очереди.
            
            Значения в текущей двухсторонней очереди останутся неизменными.


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

<comment>Param:</comment>
  <info>mixed</info>  <strong>$values</strong>  Объект класса <class>traversable</class> или <info>array</info>.

<comment>Return:</comment>
  <info>Ds\Deque</info>  Результат добавления всех переданных значений в двухстороннюю очередь. Фактически
            делается копия двухсторонней очереди, в которую добавляются значения.
            
            Текущий экземпляр двухсторонней очереди останется нетронутым.


id: Ds\Deque::pop
type: function
doc:
<comment>Description:</comment>
  Удаляет и возвращает последнее значение
  
  Удаляет и возвращает последнее значение.

<comment>Return:</comment>
  <info>mixed</info>  Последнее удалённое значение.


id: Ds\Deque::push
type: function
doc:
<comment>Description:</comment>
  Добавляет значения в конец двухсторонней очереди
  
  Добавляет значения в конец двухсторонней очереди.

<comment>Param:</comment>
  <info>mixed</info>  <strong>$values</strong>  Добавляемые значения.

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


id: Ds\Deque::reduce
type: function
doc:
<comment>Description:</comment>
  Уменьшает коллекцию до одного значения, используя callback-функцию
  
  Уменьшает коллекцию до одного значения, используя callback-функцию.

<comment>Param:</comment>
  <info>callable</info>  <strong>$callback</strong>  Значение, возвращённое предыдущим запуском функции или <strong>$initial</strong>, если функция
                       запущена в первый раз.
                       
                       Значение текущей итерации.
  <info>mixed</info>     <strong>$carry</strong>     Значение, возвращённое предыдущим запуском функции или <strong>$initial</strong>, если функция
                       запущена в первый раз.
  <info>mixed</info>     <strong>$value</strong>     Значение текущей итерации.
  <info>mixed</info>     <strong>$initial</strong>   Начальное значение параметра carry. Можно указать <info>null</info>.

<comment>Return:</comment>
  <info>mixed</info>  Значение, возвращённое окончательным запуском callback-функции.


id: Ds\Deque::remove
type: function
doc:
<comment>Description:</comment>
  Удаляет и возвращает значение по индексу
  
  Удаляет и возвращает значение по индексу.

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

<comment>Return:</comment>
  <info>mixed</info>  Удалённое значение.


id: Ds\Deque::reverse
type: function
doc:
<comment>Description:</comment>
  Переворачивает текущую двухстороннюю очередь
    
  
  Переворачивает текущую двухстороннюю очередь.

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


id: Ds\Deque::reversed
type: function
doc:
<comment>Description:</comment>
  Возвращает перевёрнутую копию двухсторонней очереди
  
  Возвращает перевёрнутую копию двухсторонней очереди.

<comment>Return:</comment>
  <info>Ds\Deque</info>  Перевёрнутая копия двухсторонней очереди.
              Текущая двухсторонняя очередь не изменится. 
            
            Текущая двухсторонняя очередь не изменится.


id: Ds\Deque::rotate
type: function
doc:
<comment>Description:</comment>
  Перематывает двухстороннюю очередь на заданное число значений
  
  Перематывает двухстороннюю очередь на заданное число значений. Данная операция аналогична
  выполнению заданное количество раз кода $deque-&gt;push($deque-&gt;shift()), если число оборотов
  положительно и $deque-&gt;unshift($deque-&gt;pop()), если отрицательно.

<comment>Param:</comment>
  <info>int</info>  <strong>$rotations</strong>  Количество значений, которые надо "перемотать".

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


id: Ds\Deque::set
type: function
doc:
<comment>Description:</comment>
  Заменяет значение по указанному индексу
  
  Заменяет значение по указанному индексу.

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

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


id: Ds\Deque::shift
type: function
doc:
<comment>Description:</comment>
  Удаляет и возвращает первое значение
  
  Удаляет и возвращает первое значение.

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


id: Ds\Deque::slice
type: function
doc:
<comment>Description:</comment>
  Возвращает подочередь из заданного диапазона
    
  
  Возвращает подочередь из диапазона заданного начальным индексом <strong>$index</strong> и длиной <strong>$length</strong>.

<comment>Param:</comment>
  <info>int</info>  <strong>$index</strong>   Индекс, задающий начало диапазона.
                
                Если положительный, то будет отсчитываться от начала коллекции. Если отрицательный,
                то от конца.
  <info>int</info>  <strong>$length</strong>  Положительное значение определяет, сколько элементов будет взято. Если количество
                элементов двухсторонней очереди меньше заданного значения, вернётся столько
                элементов, сколько есть.
                 Отрицательное значение задаст индекс, отсчитанный от конца двухсторонней очереди,
                определяющий конец диапазона.
                 Если длина не задана, то будут возвращены все элементы двухсторонней очереди от
                заданного индекса до конца коллекции.

<comment>Return:</comment>
  <info>Ds\Deque</info>  Подочередь из заданного диапазона.


id: Ds\Deque::sort
type: function
doc:
<comment>Description:</comment>
  Сортирует двухстороннюю очередь
    
  
  Сортирует двухстороннюю очередь, опционально используя callback-функцию <strong>$comparator</strong>.

<comment>Param:</comment>
  <info>callable</info>  <strong>$comparator</strong>  Функция сравнения должна возвращать целое, которое меньше, равно или больше
                         нуля, если первый аргумент является соответственно меньшим, равным или
                         большим, чем второй.
                         
                         Возвращение нецелых значений из функции сравнения, таких как число с
                         плавающей точкой (<info>float</info>), приведёт к внутреннему приведению возвращаемого
                         значения callback-функции к целому числу (<info>int</info>). Таким образом, значения
                         <return>0.99</return> и <return>0.1</return> будут приведены к целочисленному значению <return>0</return>, что позволит
                         сравнить эти значения как равные.

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


id: Ds\Deque::sorted
type: function
doc:
<comment>Description:</comment>
  Возвращает отсортированную по значению копию двухсторонней очереди
  
  Возвращает отсортированную копию двухсторонней очереди, опционально используя callback-функцию
  <strong>$comparator</strong>.

<comment>Param:</comment>
  <info>callable</info>  <strong>$comparator</strong>  Функция сравнения должна возвращать целое, которое меньше, равно или больше
                         нуля, если первый аргумент является соответственно меньшим, равным или
                         большим, чем второй.
                         
                         Возвращение нецелых значений из функции сравнения, таких как число с
                         плавающей точкой (<info>float</info>), приведёт к внутреннему приведению возвращаемого
                         значения callback-функции к целому числу (<info>int</info>). Таким образом, значения
                         <return>0.99</return> и <return>0.1</return> будут приведены к целочисленному значению <return>0</return>, что позволит
                         сравнить эти значения как равные.

<comment>Return:</comment>
  <info>Ds\Deque</info>  Возвращает отсортированную по значению копию двухсторонней очереди.


