# php_manual

id: Memcached::replaceByKey
type: function
doc:
<comment>Description:</comment>
  Заменяет существующую запись с заданным ключом на указанном сервере
  
  <strong>Memcached::replaceByKey()</strong> работает аналогично Memcached::replace, за исключением того, что
  произвольный <strong>$server_key</strong> может быть использован для определения сервера и установки значения с
  ключом <strong>$key</strong> на конкретный сервер. Это полезно когда необходимо держать несколько связанных
  значений на конкретном сервере.

<comment>Param:</comment>
  <info>string</info>  <strong>$server_key</strong>  Ключ, идентифицирующий сервер, на котором хранится значение. Вместо
                       хеширования по ключу самого элемента, мы хешируем по ключу сервера при выборе
                       подключаемого сервера memcached. Данный подход позволяет группировать
                       связанные элементы вместе на одном сервере, что улучшает эффективность
                       групповых операций.
  <info>string</info>  <strong>$key</strong>         Ключ, под которым сохраняется значение.
  <info>mixed</info>   <strong>$value</strong>       Сохраняемое значение.
  <info>int</info>     <strong>$expiration</strong>  Время хранения объекта, по умолчанию равно 0. Для более подробной информации
                       смотрите Время хранения объекта.

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

<comment>See Also:</comment>
   * Memcached::replace
   * Memcached::set
   * Memcached::add


id: Memcached::resetServerList
type: function
doc:
<comment>Description:</comment>
  Очищает список серверов
  
  <strong>Memcached::resetserverlist()</strong> удаляет все сервера memcache из пула, делая его снова пустым.

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

<comment>See Also:</comment>
   * Memcached::addServer
   * Memcached::addServers


id: Memcached::set
type: function
doc:
<comment>Description:</comment>
  Сохраняет запись
  
  <strong>Memcached::set()</strong> сохраняет значение <strong>$value</strong> на memcache сервере под указанным ключом <strong>$key</strong>. Параметр
  <strong>$expiration</strong> может быть использован для контроля, когда срок действия значения считается истёкшим.
  
  Значение может быть любым доступным в PHP типом, кроме ресурса, потому что этот тип не может быть
  представлен в сериализованном виде. Если установлен параметр <info>Memcached::OPT_COMPRESSION</info>, то
  сериализованное значение будет также сжато перед сохранением.

<comment>Param:</comment>
  <info>string</info>  <strong>$key</strong>         Ключ, под которым сохраняется значение.
  <info>mixed</info>   <strong>$value</strong>       Сохраняемое значение.
  <info>int</info>     <strong>$expiration</strong>  Время хранения объекта, по умолчанию равно 0. Для более подробной информации
                       смотрите Время хранения объекта.

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

<comment>See Also:</comment>
   * Memcached::setByKey
   * Memcached::add
   * Memcached::replace


id: Memcached::setByKey
type: function
doc:
<comment>Description:</comment>
  Сохраняет запись на указанном сервере
  
  <strong>Memcached::setByKey()</strong> работает аналогично Memcached::set, за исключением того, что произвольный
  <strong>$server_key</strong> может быть использован для определения сервера и установки значения с ключом <strong>$key</strong> на
  конкретный сервер. Это полезно когда необходимо держать несколько связанных значений на конкретном
  сервере.

<comment>Param:</comment>
  <info>string</info>  <strong>$server_key</strong>  Ключ, идентифицирующий сервер, на котором хранится значение. Вместо
                       хеширования по ключу самого элемента, мы хешируем по ключу сервера при выборе
                       подключаемого сервера memcached. Данный подход позволяет группировать
                       связанные элементы вместе на одном сервере, что улучшает эффективность
                       групповых операций.
  <info>string</info>  <strong>$key</strong>         Ключ, под которым сохраняется значение.
  <info>mixed</info>   <strong>$value</strong>       Сохраняемое значение.
  <info>int</info>     <strong>$expiration</strong>  Время хранения объекта, по умолчанию равно 0. Для более подробной информации
                       смотрите Время хранения объекта.

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

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


id: Memcached::setMulti
type: function
doc:
<comment>Description:</comment>
  Сохраняет несколько записей
  
  <strong>Memcached::setMulti()</strong> похож на метод Memcached::set, но вместо одной пары ключ/значение, работает
  с несколькими записями, переданными в <strong>$items</strong> в виде массива. Параметр <strong>$expiration</strong>, устанавливающий
  срок хранения записи, применяется ко всем записям.

<comment>Param:</comment>
  <info>array</info>  <strong>$items</strong>       Сохраняемый массив пар ключей/значений.
  <info>int</info>    <strong>$expiration</strong>  Время хранения объекта, по умолчанию равно 0. Для более подробной информации
                      смотрите Время хранения объекта.

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

<comment>See Also:</comment>
   * Memcached::setMultiByKey
   * Memcached::set


id: Memcached::setMultiByKey
type: function
doc:
<comment>Description:</comment>
  Сохраняет несколько записей на указанном сервере
  
  <strong>Memcached::setMultiByKey()</strong> работает аналогично Memcached::setMulti, за исключением того, что
  произвольный <strong>$server_key</strong> может быть использован для определения сервера и установки значения с
  ключом <strong>$key</strong> на конкретный сервер. Это полезно когда необходимо держать несколько связанных
  значений на конкретном сервере.

<comment>Param:</comment>
  <info>string</info>  <strong>$server_key</strong>  Ключ, идентифицирующий сервер, на котором хранится значение. Вместо
                       хеширования по ключу самого элемента, мы хешируем по ключу сервера при выборе
                       подключаемого сервера memcached. Данный подход позволяет группировать
                       связанные элементы вместе на одном сервере, что улучшает эффективность
                       групповых операций.
  <info>array</info>   <strong>$items</strong>       Сохраняемый массив пар ключей/значений.
  <info>int</info>     <strong>$expiration</strong>  Время хранения объекта, по умолчанию равно 0. Для более подробной информации
                       смотрите Время хранения объекта.

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

<comment>See Also:</comment>
   * Memcached::setMulti
   * Memcached::set


id: Memcached::setOption
type: function
doc:
<comment>Description:</comment>
  Устанавливает значение параметра для Memcached
  
  Метод устанавливает значение параметра для Memcached, переданного в <strong>$option</strong>. Некоторые параметры
  определены в библиотеке libmemcached, а некоторые указаны в модуле.

<comment>Param:</comment>
  <info>int</info>    <strong>$option</strong>  Одна из констант <return>Memcached::OPT_*</return>. Изучите раздел константы Memcached для
                  получения более полной информации.
  <info>mixed</info>  <strong>$value</strong>   Значение, которое необходимо установить.
                  
                  Параметры, перечисленные ниже, требуют значений, указанных с помощью констант.
                  <return>Memcached::OPT_HASH</return> требует <return>Memcached::HASH_*</return> значений.<return>Memcached::OPT_DISTRIBUTION</return>
                  требует <return>Memcached::DISTRIBUTION_*</return> значений.

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

<comment>See Also:</comment>
   * Memcached::getOption
   * Memcached::setOptions
   * Memcached константы


id: Memcached::setOptions
type: function
doc:
<comment>Description:</comment>
  Устанавливает несколько Memcached параметров
  
  <strong>Memcached::setOptions()</strong> аналогичен методу Memcached::setOption, но принимает массив параметров.

<comment>Param:</comment>
  <info>array</info>  <strong>$options</strong>  Ассоциативный массив с параметрами, где в качестве ключа выступает название
                   параметра, а в качестве значения- новое значение данного параметра.

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

<comment>See Also:</comment>
   * Memcached::getOption
   * Memcached::setOption
   * Memcached Constants


id: Memcached::setSaslAuthData
type: function
doc:
<comment>Description:</comment>
  Устанавливает учётные данные для аутентификации
  
  <strong>Memcached::setSaslAuthData()</strong> устанавливает имя пользователя и пароль, которые должны быть
  использованы для SASL аутентификации с серверами memcache.
  
  Данный метод доступен только в случае, если модуль memcached собран с поддержкой SASL. Обратитесь
  к разделу установка Memcached, чтобы узнать, как это сделать.

<comment>Param:</comment>
  <info>string</info>  <strong>$username</strong>  Имя пользователя для аутентификации.
  <info>string</info>  <strong>$password</strong>  Пароль для аутентификации.

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


id: Memcached::touch
type: function
doc:
<comment>Description:</comment>
  Устанавливает новый срок хранения для записи
  
  <strong>Memcached::touch()</strong> устанавливает новый срок хранения для записи с указанным ключом.

<comment>Param:</comment>
  <info>string</info>  <strong>$key</strong>         Ключ, под которым сохраняется значение.
  <info>int</info>     <strong>$expiration</strong>  Время хранения объекта, по умолчанию равно 0. Для более подробной информации
                       смотрите Время хранения объекта.

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

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


id: Memcached::touchByKey
type: function
doc:
<comment>Description:</comment>
  Устанавливает новый срок хранения для записи на указанном сервере
  
  <strong>Memcached::touchByKey()</strong> работает аналогично Memcached::touch, за исключением того, что
  произвольный <strong>$server_key</strong> может быть использован для определения сервера и установки значения с
  ключом <strong>$key</strong> на конкретный сервер.

<comment>Param:</comment>
  <info>string</info>  <strong>$server_key</strong>  Ключ, идентифицирующий сервер, на котором хранится значение. Вместо
                       хеширования по ключу самого элемента, мы хешируем по ключу сервера при выборе
                       подключаемого сервера memcached. Данный подход позволяет группировать
                       связанные элементы вместе на одном сервере, что улучшает эффективность
                       групповых операций.
  <info>string</info>  <strong>$key</strong>         Ключ, под которым сохраняется значение.
  <info>int</info>     <strong>$expiration</strong>  Время хранения объекта, по умолчанию равно 0. Для более подробной информации
                       смотрите Время хранения объекта.

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

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


id: MessageFormatter
type: class
doc:
<comment>Description:</comment>
  MessageFormatter - это класс, позволяющий создавать склеиваемые, независимые от языка сообщения.
  Методы этого класса используются для создания всех сообщений, показываемых пользователю.
  
  Класс MessageFormatter собирает сообщение из разных фрагментов (таких как текст, числа и даты),
  поставляемых программой. Данный класс позволяет программе не задумываться о том, в каком порядке
  эти фрагменты надо склеивать. Класс использует спецификации форматирования для сборки этих
  фрагментов в сообщение, хранящееся в виде одной строки в хранилище ресурсов. К примеру,
  MessageFormatter позволит напечатать фразу "Finished printing x out of y files..." таким образом,
  чтобы обеспечить гибкость перевода.
  
  Ранее сообщение для конечного пользователя создавалось как законченная фраза и обрабатывалась как
  строка. Такая процедура приводила к проблемам локализации, поскольку структура фразы, порядок
  слов, формат чисел и прочее сильно отличались в разных языках. Нейтральная к языку процедура
  создания сообщений держит каждую часть сообщения отдельно и предоставляет ключи к данным.
  Используя эти ключи, класс MessageFormatter может склеивать части сообщения, преобразовывать их в
  соответствии с локалью и отображать в виде грамотного сообщения конечному пользователю.
  
  MessageFormatter берет набор объектов, форматирует их и вставляет в шаблон в нужных местах.
  Совместно с MessageFormatter полезно использовать средства форматирования выбора (choice
  formatter) для обработки множественного/единственного числа, сравнения чисел и выбора из массива
  элементов. Обычно формат сообщения берётся из ресурсов, а аргументы передаются во время
  выполнения.


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

<comment>Param:</comment>
  <info>string</info>  <strong>$locale</strong>   Локаль, используемая при форматировании аргументов
  <info>string</info>  <strong>$pattern</strong>  Строка (<info>string</info>) шаблона для вставки аргументов. В шаблоне используется
                    "дружественный к апострофам" синтаксис; подробнее смотрите в разделе
                    Quoting/Escaping.

<comment>Return:</comment>
  <info>MessageFormatter|null</info>  Объект <class>MessageFormatter</class> или <info>null</info> в случае возникновения ошибки.

<comment>See Also:</comment>
   * <strong>msgfmt_format()</strong>
   * <strong>msgfmt_parse()</strong>
   * <strong>msgfmt_get_error_code()</strong>
   * <strong>msgfmt_get_error_message()</strong>


id: MessageFormatter::format
type: function
doc:
<comment>Description:</comment>
  Форматирует сообщение
  
  Объектно-ориентированный стиль
  
  Процедурный стиль
  
  Форматирует сообщение, подставляя данные в строку формата в соответствии с правилами локали.

<comment>Param:</comment>
  <info>MessageFormatter</info>  <strong>$formatter</strong>  Объект <class>MessageFormatter</class>
  <info>array</info>             <strong>$values</strong>     Аргументы для вставки в строку формата

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

<comment>See Also:</comment>
   * <strong>msgfmt_create()</strong>
   * <strong>msgfmt_parse()</strong>
   * <strong>msgfmt_format_message()</strong>
   * <strong>msgfmt_get_error_code()</strong>
   * <strong>msgfmt_get_error_message()</strong>


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

<comment>Param:</comment>
  <info>string</info>  <strong>$locale</strong>   Локаль, используемая для форматирования частей, зависящих от локали
  <info>string</info>  <strong>$pattern</strong>  Строка (<info>string</info>) шаблона для вставки аргументов. В шаблоне используется
                    "дружественный к апострофам" синтаксис; подробнее смотрите в разделе
                    Quoting/Escaping.
  <info>array</info>   <strong>$values</strong>   Массив значений (<info>array</info>) для вставки в строку формата (<info>string</info>).

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

<comment>See Also:</comment>
   * <strong>msgfmt_create()</strong>
   * <strong>msgfmt_parse()</strong>
   * <strong>msgfmt_get_error_code()</strong>
   * <strong>msgfmt_get_error_message()</strong>


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

<comment>Param:</comment>
  <info>MessageFormatter</info>  <strong>$formatter</strong>  Объект <class>MessageFormatter</class>

<comment>Return:</comment>
  <info>int</info>  Код ошибки, одно из значений UErrorCode. Начальное значение - U_ZERO_ERROR.

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


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

<comment>Param:</comment>
  <info>MessageFormatter</info>  <strong>$formatter</strong>  Объект <class>MessageFormatter</class>

<comment>Return:</comment>
  <info>string</info>  Описание последней ошибки.

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


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

<comment>Param:</comment>
  <info>MessageFormatter</info>  <strong>$formatter</strong>  Объект <class>MessageFormatter</class>

<comment>Return:</comment>
  <info>string</info>  Имя локали.

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


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

<comment>Param:</comment>
  <info>MessageFormatter</info>  <strong>$formatter</strong>  Объект <class>MessageFormatter</class>

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

<comment>See Also:</comment>
   * <strong>msgfmt_create()</strong>
   * <strong>msgfmt_set_pattern()</strong>


id: MessageFormatter::parse
type: function
doc:
<comment>Description:</comment>
  Разбирает строку согласно шаблону
  
  Объектно-ориентированный стиль
  
  Процедурный стиль
  
  Разбирает входную строку (<info>string</info>) и возвращает все извлечённые элементы в виде массива (<info>array</info>).

<comment>Param:</comment>
  <info>MessageFormatter</info>  <strong>$formatter</strong>  Объект <class>MessageFormatter</class>.
  <info>string</info>            <strong>$string</strong>     Строка (<info>string</info>) для разбора.

<comment>Return:</comment>
  <info>array|false</info>  Массив (<info>array</info>), содержащий извлечённые элементы или <info>false</info> в случае возникновения
               ошибки.

<comment>See Also:</comment>
   * <strong>msgfmt_create()</strong>
   * <strong>msgfmt_format()</strong>
   * <strong>msgfmt_parse_message()</strong>


id: MessageFormatter::parseMessage
type: function
doc:
<comment>Description:</comment>
  Быстро разбирает входную строку
  
  Объектно-ориентированный стиль
  
  Процедурный стиль
  
  Разбирает входную строку без явного создания объекта форматирования. Используйте эту функцию,
  когда операция форматирования выполняется только один раз и не требует сохранения параметров или
  состояния.

<comment>Param:</comment>
  <info>string</info>  <strong>$locale</strong>   Локаль, используемая для разбора частей, зависящих от локали
  <info>string</info>  <strong>$pattern</strong>  Шаблон, использующийся для разбора <strong>$message</strong>.
  <info>string</info>  <strong>$message</strong>  Строка (<info>string</info>) для разбора, соответствующая <strong>$pattern</strong>.

<comment>Return:</comment>
  <info>array|false</info>  Массив (<info>array</info>), содержащий извлечённые элементы или <info>false</info> в случае возникновения
               ошибки.

<comment>See Also:</comment>
   * <strong>msgfmt_create()</strong>
   * <strong>msgfmt_format_message()</strong>
   * <strong>msgfmt_parse()</strong>


id: MessageFormatter::setPattern
type: function
doc:
<comment>Description:</comment>
  Устанавливает шаблон, используемый средством форматирования
  
  Объектно-ориентированный стиль
  
  Процедурный стиль
  
  Устанавливает шаблон, используемый средством форматирования.

<comment>Param:</comment>
  <info>MessageFormatter</info>  <strong>$formatter</strong>  Объект <class>MessageFormatter</class>
  <info>string</info>            <strong>$pattern</strong>    Строка (<info>string</info>) шаблона для использования в этом средстве
                                форматирования сообщения. В шаблоне используется "дружественный к
                                апострофам" синтаксис; подробнее смотрите в разделе
                                Quoting/Escaping.

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

<comment>See Also:</comment>
   * <strong>msgfmt_create()</strong>
   * <strong>msgfmt_get_pattern()</strong>


id: MongoDB\BSON\Binary
type: class
doc:
<comment>Description:</comment>
  Тип BSON для бинарных данных (т.е. массива байт). Бинарные значения также имеют подтип,
  обозначающий, какой тип данных содержится в массиве байт. Подтипы с нуля до 127 предопределены или
  зарезервированы. Подтипы с 128-255 задаются пользователем.


id: MongoDB\BSON\Binary::TYPE_COLUMN
type: constant
doc:
<comment>Description:</comment>
  Данные столбца. Подтип используется для коллекций временных рядов.


id: MongoDB\BSON\Binary::TYPE_ENCRYPTED
type: constant
doc:
<comment>Description:</comment>
  Зашифрованное значение. Этот подтип используется для шифрования на стороне клиента.


id: MongoDB\BSON\Binary::TYPE_MD5
type: constant
doc:
<comment>Description:</comment>
  Хеш MD5. При использовании этого типа, бинарные данные должны быть длиной 16 байт.


id: MongoDB\BSON\Binary::TYPE_OLD_BINARY
type: constant
doc:
<comment>Description:</comment>
  Бинарные данные (объявлена устаревшей, используйте <info>MongoDB\BSON\Binary::TYPE_GENERIC</info>)


id: MongoDB\BSON\Binary::TYPE_OLD_UUID
type: constant
doc:
<comment>Description:</comment>
  Универсальный уникальный идентификатор (объявлена устаревшей. Используйте
  <info>MongoDB\BSON\Binary::TYPE_UUID</info>). При использовании этого типа, бинарные данные должны быть длиной
  16 байт.
  
  Исторически другие значения кодированные этим типов, но другими драйверами, базируются на других
  конвенциях (например, разный тип порядка байт), что делает его непереносимым. Драйвер PHP не
  применяет каких-либо обработок для данных этого типа.


id: MongoDB\BSON\Binary::TYPE_USER_DEFINED
type: constant
doc:
<comment>Description:</comment>
  Пользовательский тип. В то время как типы с 0 по 127 предопределены, либо зарезервированы, типы со
  128 по 255 могут использоваться для чего угодно.


id: MongoDB\BSON\Binary::TYPE_UUID
type: constant
doc:
<comment>Description:</comment>
  Универсальный уникальный идентификатор. При использовании этого типа, бинарные данные должны быть
  длиной 16 байт RFC 4122.


id: MongoDB\BSON\Binary::__construct
type: function
doc:
<comment>Description:</comment>
  Создаёт новый Binary

<comment>Param:</comment>
  <info>string</info>  <strong>$data</strong>  Двоичные данные.
  <info>int</info>     <strong>$type</strong>  8-разрядное целое число, обозначающее тип данных. По умолчанию принимает значение
                 <info>MongoDB\BSON\Binary::TYPE_GENERIC</info>, если не указано.

<comment>See Also:</comment>
   * Типы BSON


id: MongoDB\BSON\Binary::__toString
type: function
doc:
<comment>Description:</comment>
  Возвращает данные Binary
  
  Метод является псевдонимом:  MongoDB\BSON\Binary::getData.

<comment>Return:</comment>
  <info>string</info>  Возвращает данные Binary.

<comment>See Also:</comment>
   * MongoDB\BSON\Binary::getData
   * Типы BSON


id: MongoDB\BSON\Binary::getData
type: function
doc:
<comment>Description:</comment>
  Возвращает данные Binary

<comment>Return:</comment>
  <info>string</info>  Возвращает данные Binary.

<comment>See Also:</comment>
   * Типы BSON


id: MongoDB\BSON\Binary::getType
type: function
doc:
<comment>Description:</comment>
  Возвращает тип Binary

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

<comment>See Also:</comment>
   * Типы BSON


id: MongoDB\BSON\Binary::jsonSerialize
type: function
doc:
<comment>Description:</comment>
  Возвращает представление, которое можно преобразовать в JSON

<comment>Return:</comment>
  <info>mixed</info>  Возвращает данные, которые можно сериализовать с помощью <strong>json_encode()</strong> для создания
         расширенного JSON-представления <class>MongoDB\BSON\Binary</class>.
         
         Вывод соответствует выводу функции <strong>MongoDB\BSON\toJSON()</strong>, которая использует
         унаследованный, специфичный для драйвера, расширенный формат JSON. Он не обязательно будет
         подходить под relaxed или canonical представления расширенного JSON, используемых в
         <strong>MongoDB\BSON\toRelaxedExtendedJSON()</strong> и <strong>MongoDB\BSON\toCanonicalExtendedJSON()</strong>,
         соответственно.

<comment>See Also:</comment>
   * JsonSerializable::jsonSerialize
   * <strong>json_encode()</strong>
   * <strong>MongoDB\BSON\toCanonicalExtendedJSON()</strong>
   * <strong>MongoDB\BSON\toRelaxedExtendedJSON()</strong>
   * MongoDB Extended JSON


id: MongoDB\BSON\Binary::serialize
type: function
doc:
<comment>Description:</comment>
  Сериализует Binary

<comment>Return:</comment>
  <info>string</info>  Возвращает сериализованное представление <class>MongoDB\BSON\Binary</class>.

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


id: MongoDB\BSON\Binary::unserialize
type: function
doc:
<comment>Description:</comment>
  Десериализует Binary

<comment>Param:</comment>
  <info>string</info>  <strong>$data</strong>  Сериализованный <class>MongoDB\BSON\Binary</class>.

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

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


id: MongoDB\BSON\BinaryInterface
type: class
doc:
<comment>Description:</comment>
  Этот интерфейс реализован <class>MongoDB\BSON\Binary</class>, но также может использоваться в качестве параметра,
  возвращаемого значения или типа свойства в классах пользовательского пространства.


id: MongoDB\BSON\BinaryInterface::__toString
type: function
doc:
<comment>Description:</comment>
  Возвращает данные BinaryInterface
  
  Метод является псевдонимом:  MongoDB\BSON\BinaryInterface::getData.

<comment>Return:</comment>
  <info>string</info>  Возвращает данные BinaryInterface.

<comment>See Also:</comment>
   * MongoDB\BSON\BinaryInterface::getData
   * MongoDB\BSON\Binary::__toString


id: MongoDB\BSON\BinaryInterface::getData
type: function
doc:
<comment>Description:</comment>
  Возвращает данные BinaryInterface

<comment>Return:</comment>
  <info>string</info>  Возвращает данные BinaryInterface.

<comment>See Also:</comment>
   * MongoDB\BSON\Binary::getData


id: MongoDB\BSON\BinaryInterface::getType
type: function
doc:
<comment>Description:</comment>
  Возвращает тип BinaryInterface

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

<comment>See Also:</comment>
   * MongoDB\BSON\Binary::getType


id: MongoDB\BSON\DBPointer
type: class
doc:
<comment>Description:</comment>
  Тип BSON для типа "DBPointer". Этот тип BSON устарел, и этот класс не может быть создан. Он будет
  создан из типа BSON DBPointer во время преобразования BSON в PHP, а также при преобразовании
  обратно в BSON при хранении документов в базе данных.


id: MongoDB\BSON\DBPointer::__construct
type: function
doc:
<comment>Description:</comment>
  Создаёт новый DBPointer (не используется)
  
  Объекты <class>MongoDB\BSON\DBPointer</class> создаются путём преобразования из устаревшего типа BSON и не могут
  быть созданы напрямую.

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


id: MongoDB\BSON\DBPointer::__toString
type: function
doc:
<comment>Description:</comment>
  Возвращает пустую строку

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

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


id: MongoDB\BSON\DBPointer::jsonSerialize
type: function
doc:
<comment>Description:</comment>
  Возвращает представление, которое можно преобразовать в JSON

<comment>Return:</comment>
  <info>mixed</info>  Возвращает данные, которые могут быть сериализованы с помощью <strong>json_encode()</strong> для создания
         расширенного JSON-представления <class>MongoDB\BSON\DBPointer</class>.
         
         Вывод соответствует выводу функции <strong>MongoDB\BSON\toJSON()</strong>, которая использует
         унаследованный, специфичный для драйвера, расширенный формат JSON. Он не обязательно будет
         подходить под relaxed или canonical представления расширенного JSON, используемых в
         <strong>MongoDB\BSON\toRelaxedExtendedJSON()</strong> и <strong>MongoDB\BSON\toCanonicalExtendedJSON()</strong>,
         соответственно.

<comment>See Also:</comment>
   * JsonSerializable::jsonSerialize
   * <strong>json_encode()</strong>
   * <strong>MongoDB\BSON\toCanonicalExtendedJSON()</strong>
   * <strong>MongoDB\BSON\toRelaxedExtendedJSON()</strong>
   * MongoDB Extended JSON


id: MongoDB\BSON\DBPointer::serialize
type: function
doc:
<comment>Description:</comment>
  Сериализует DBPointer

<comment>Return:</comment>
  <info>string</info>  Возвращает сериализованное представление <class>MongoDB\BSON\DBPointer</class>.

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


id: MongoDB\BSON\DBPointer::unserialize
type: function
doc:
<comment>Description:</comment>
  Десериализует DBPointer

<comment>Param:</comment>
  <info>string</info>  <strong>$data</strong>  Сериализированный <class>MongoDB\BSON\DBPointer</class>.

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

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


id: MongoDB\BSON\Decimal128
type: class
doc:
<comment>Description:</comment>
  Тип BSON для Decimal128 формата с плавающей точкой, который поддерживает числа до 34 десятичных
  знаков (то есть значимых цифр) и диапазон экспонент от -6143 до +6144.
  
  В отличие от типа double BSON (то есть <info>float</info> в PHP), который хранит только приблизительные
  значения десятичных значений, тип данных decimal хранит точное значение. Например,
  <return>MongoDB\BSON\Decimal128('9.99')</return> имеет точное значение 9ю99, где двойное значение 9ю99 будет иметь
  приблизительное значение 9.9900000000000002131628….
  
  <class>MongoDB\BSON\Decimal128</class> совместим только с MongoDB 3.4+. При попытке использовать тип BSON с более
  ранними версиями приведёт к ошибке.


id: MongoDB\BSON\Decimal128::__construct
type: function
doc:
<comment>Description:</comment>
  Создаёт новый Decimal128
  
  <class>MongoDB\BSON\Decimal128</class> совместим только с MongoDB 3.4+. При попытке использовать тип BSON с более
  ранними версиями приведёт к ошибке.

<comment>Param:</comment>
  <info>string</info>  <strong>$value</strong>  Десятичная строка.

<comment>See Also:</comment>
   * Формат с плавающей точкой Decimal128
   * Типы BSON


id: MongoDB\BSON\Decimal128::__toString
type: function
doc:
<comment>Description:</comment>
  Возвращает строковое представление Decimal128

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

<comment>See Also:</comment>
   * Формат с плавающей точкой Decimal128
   * Типы BSON


id: MongoDB\BSON\Decimal128::jsonSerialize
type: function
doc:
<comment>Description:</comment>
  Возвращает представление, которое можно преобразовать в JSON

<comment>Return:</comment>
  <info>mixed</info>  Возвращает данные, которые могут быть сериализованы <strong>json_encode()</strong> для создания расширенного
         JSON-представления <class>MongoDB\BSON\Decimal128</class>.
         
         Вывод соответствует выводу функции <strong>MongoDB\BSON\toJSON()</strong>, которая использует
         унаследованный, специфичный для драйвера, расширенный формат JSON. Он не обязательно будет
         подходить под relaxed или canonical представления расширенного JSON, используемых в
         <strong>MongoDB\BSON\toRelaxedExtendedJSON()</strong> и <strong>MongoDB\BSON\toCanonicalExtendedJSON()</strong>,
         соответственно.

<comment>See Also:</comment>
   * JsonSerializable::jsonSerialize
   * <strong>json_encode()</strong>
   * <strong>MongoDB\BSON\toCanonicalExtendedJSON()</strong>
   * <strong>MongoDB\BSON\toRelaxedExtendedJSON()</strong>
   * MongoDB Extended JSON


id: MongoDB\BSON\Decimal128::serialize
type: function
doc:
<comment>Description:</comment>
  Сериализирует Decimal128

<comment>Return:</comment>
  <info>string</info>  Возвращает сериализованное представление <class>MongoDB\BSON\Decimal128</class>.

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


id: MongoDB\BSON\Decimal128::unserialize
type: function
doc:
<comment>Description:</comment>
  Десериализует Decimal128

<comment>Param:</comment>
  <info>string</info>  <strong>$data</strong>  Сериализованный <class>MongoDB\BSON\Decimal128</class>.

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

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


id: MongoDB\BSON\Decimal128Interface
type: class
doc:
<comment>Description:</comment>
  Этот интерфейс реализован <class>MongoDB\BSON\Decimal128</class>, но также может использоваться в качестве
  параметра, возвращаемого значения или типа свойства в классах пользовательского пространства.


id: MongoDB\BSON\Decimal128Interface::__toString
type: function
doc:
<comment>Description:</comment>
  Возвращает строковое представление Decimal128Interface

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

<comment>See Also:</comment>
   * MongoDB\BSON\Decimal128::__toString


id: MongoDB\BSON\Document
type: class
doc:
<comment>Description:</comment>
  Представляет BSON-документ. Класс используется при чтении данных в виде необработанного BSON и не
  может быть модифицирован.


id: MongoDB\BSON\Document::__construct
type: function
doc:
<comment>Description:</comment>
  Создаёт новый BSON-документ (не используется)
  
  Объекты <class>MongoDB\BSON\Document</class> создаются с помощью статических фабричных методов и не могут быть
  инициализированы напрямую.

<comment>See Also:</comment>
   * MongoDB\BSON\Document::fromPHP
   * MongoDB\BSON\Document::fromBSON
   * MongoDB\BSON\Document::fromJSON
   * Типы BSON


id: MongoDB\BSON\Document::__toString
type: function
doc:
<comment>Description:</comment>
  Возвращает строковое представление данного BSON-документа

<comment>Return:</comment>
  <info>string</info>  Возвращает строковое представление данного BSON-документа

<comment>See Also:</comment>
   * Типы BSON


id: MongoDB\BSON\Document::fromBSON
type: function
doc:
<comment>Description:</comment>
  Создаёт новый экземпляр документа из BSON-строки

<comment>Param:</comment>
  <info>string</info>  <strong>$bson</strong>  Строка, содержащая документ в формате BSON.

<comment>Return:</comment>
  <info>MongoDB\BSON\Document</info>  

<comment>See Also:</comment>
   * MongoDB\BSON\Document::fromPHP
   * MongoDB\BSON\Document::fromJSON
   * Типы BSON


id: MongoDB\BSON\Document::fromJSON
type: function
doc:
<comment>Description:</comment>
  Создаёт новый экземпляр документа из строки JSON
  
  Преобразует файл extended JSON в его BSON-представление.

<comment>Param:</comment>
  <info>string</info>  <strong>$json</strong>  JSON-значение, подлежащее преобразованию.

<comment>Return:</comment>
  <info>MongoDB\BSON\Document</info>  

<comment>See Also:</comment>
   * MongoDB\BSON\Document::fromPHP
   * MongoDB\BSON\Document::fromBSON
   * <strong>MongoDB\BSON\fromJSON()</strong>
   * MongoDB Extended JSON
   * Типы BSON


id: MongoDB\BSON\Document::fromPHP
type: function
doc:
<comment>Description:</comment>
  Создаёт новый экземпляр документа из данных PHP

<comment>Param:</comment>
  <info>object|array</info>  <strong>$value</strong>  PHP-объект или массив, содержащий документ. При передаче массива с числовыми
                        ключами числовые значения преобразуются в строки и используются в качестве
                        ключей документа.

<comment>Return:</comment>
  <info>MongoDB\BSON\Document</info>  

<comment>See Also:</comment>
   * MongoDB\BSON\Document::fromBSON
   * MongoDB\BSON\Document::fromJSON
   * <strong>MongoDB\BSON\fromPHP()</strong>
   * Типы BSON


id: MongoDB\BSON\Document::get
type: function
doc:
<comment>Description:</comment>
  Возвращает значение ключа в документе

<comment>Param:</comment>
  <info>string</info>  <strong>$key</strong>  Ключ, который необходимо извлечь из документа.

<comment>Return:</comment>
  <info>mixed</info>  Возвращает значение, связанное с заданным ключом. Если ключ отсутствует в документе, будет
         выброшено исключение.
         
         Если в BSON-документе встречается значение, закодированное как 64-битное целое число, то
         возвращаемым значением этого метода будет экземпляр <class>MongoDB\BSON\Int64</class>.

<comment>See Also:</comment>
   * MongoDB\BSON\Document::has
   * Типы BSON


id: MongoDB\BSON\Document::getIterator
type: function
doc:
<comment>Description:</comment>
  Возвращает итератор для документа BSON

<comment>Return:</comment>
  <info>MongoDB\BSON\Iterator</info>  Возвращает экземпляр <class>MongoDB\BSON\Iterator</class>, который может быть использован
                         для итерации по всем ключам в документе.

<comment>See Also:</comment>
   * Типы BSON


id: MongoDB\BSON\Document::has
type: function
doc:
<comment>Description:</comment>
  Возвращает, присутствует ли ключ в документе

<comment>Param:</comment>
  <info>string</info>  <strong>$key</strong>  Ключ, который необходимо искать в документе.

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

<comment>See Also:</comment>
   * MongoDB\BSON\Document::get
   * Типы BSON


id: MongoDB\BSON\Document::serialize
type: function
doc:
<comment>Description:</comment>
  Сериализует документ

<comment>Return:</comment>
  <info>string</info>  Возвращает сериализованное представление <class>MongoDB\BSON\Document</class>.

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


id: MongoDB\BSON\Document::toCanonicalExtendedJSON
type: function
doc:
<comment>Description:</comment>
  Возвращает Canonical Extended JSON-представление BSON-документа
  
  Преобразует BSON-документ в его Canonical Extended JSON представление. Формат Canonical
  предпочитает точность типов за счёт краткости вывода и наиболее подходит для получения вывода,
  который может быть преобразован обратно в BSON без потери информации о типе (например, числовые
  типы останутся дифференцированными).

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

<comment>See Also:</comment>
   * MongoDB\BSON\Document::fromJSON
   * MongoDB\BSON\Document::toRelaxedExtendedJSON
   * <strong>MongoDB\BSON\toCanonicalExtendedJSON()</strong>
   * Спецификация Extended JSON
   * Типы BSON


id: MongoDB\BSON\Document::toPHP
type: function
doc:
<comment>Description:</comment>
  Возвращает PHP-представление документа BSON
  
  Десериализует BSON-документ в его PHP-представление. Параметр <strong>$typeMap</strong> может быть использован для
  управления типами PHP, используемыми для преобразования BSON-массивов и документов (как корневых,
  так и встроенных).
  
  Документы BSON технически могут содержать повторяющиеся ключи, поскольку документы хранятся в виде
  списка пар ключ-значение; однако приложениям следует воздерживаться от создания документов с
  дубликатами ключей, поскольку поведение сервера и драйвера может быть неопределённым. Поскольку
  объекты и массивы PHP не могут иметь повторяющихся ключей, данные также могут быть потеряны при
  декодировании документа BSON с повторяющимися ключами.

<comment>Param:</comment>
  <info>array|null</info>  <strong>$typeMap</strong>  Конфигурация карты типов.

<comment>Return:</comment>
  <info>array|object</info>  Десериализованное PHP-значение.
                
                Если в BSON-документе встречается значение, закодированное как 64-битное целое
                число, то возвращаемым значением будет экземпляр <class>MongoDB\BSON\Int64</class>.

<comment>See Also:</comment>
   * <strong>MongoDB\BSON\toPHP()</strong>
   * Типы BSON


id: MongoDB\BSON\Document::toRelaxedExtendedJSON
type: function
doc:
<comment>Description:</comment>
  Возвращает Relaxed Extended JSON представление BSON-документа
  
  Преобразует BSON-документ в Relaxed Extended JSON представление. Формат Relaxed предпочитает
  использовать примитивы типов JSON в ущерб верности типов и наиболее подходит для создания вывода,
  который может быть легко использован веб-интерфейсами и людьми.

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

<comment>See Also:</comment>
   * MongoDB\BSON\Document::fromJSON
   * MongoDB\BSON\Document::toCanonicalExtendedJSON
   * <strong>MongoDB\BSON\toRelaxedExtendedJSON()</strong>
   * Спецификация Extended JSON
   * Типы BSON


id: MongoDB\BSON\Document::unserialize
type: function
doc:
<comment>Description:</comment>
  Десериализует BSON-документ

<comment>Param:</comment>
  <info>string</info>  <strong>$data</strong>  Сериализованный <class>MongoDB\BSON\Document</class>.

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

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


id: MongoDB\BSON\Int64
type: class
doc:
<comment>Description:</comment>
  Тип BSON для 64-разрядного целого числа. При декодировании BSON в данные PHP этот класс
  используется, когда 64-битное целое число не может быть представлено как целое число PHP на
  32-битных платформах. Эти объекты поддерживают перегруженные арифметические, побитовые операторы и
  операторы сравнения.
  
  При работе с необработанными BSON данными с помощью классов <class>MongoDB\BSON\Document</class>,
  <class>MongoDB\BSON\PackedArray</class> и <class>MongoDB\BSON\Iterator</class>, любое 64-битное целое число будет возвращено как
  экземпляр этого класса, независимо от платформы и того, может ли значение быть представлено как
  целое число PHP. Это гарантирует, что значения могут быть переданы по кругу без изменения типа.
  
  Во время кодирования BSON объекты этого класса будут преобразованы обратно в 64-битный
  целочисленный тип, даже если значение помещается в 32-битное целое число. Это позволяет явно
  хранить значения как 64-битные целые числа в BSON.


id: MongoDB\BSON\Int64::__construct
type: function
doc:
<comment>Description:</comment>
  Создаёт новый Int64
  
  Создаёт новый экземпляр <class>MongoDB\BSON\Int64</class> для заданного целого числа.

<comment>Param:</comment>
  <info>int|string</info>  <strong>$value</strong>  Значение, присваиваемое экземпляру <class>Int64</class>. Это значение может быть
                      предоставлено как целое число (<info>int</info>) или строка (<info>string</info>), последнее требуется
                      на 32-битных платформах для представления 64-битных значений.

<comment>See Also:</comment>
   * Типы BSON


id: MongoDB\BSON\Int64::__toString
type: function
doc:
<comment>Description:</comment>
  Возвращает строковое представление Int64

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

<comment>See Also:</comment>
   * Типы BSON


id: MongoDB\BSON\Int64::jsonSerialize
type: function
doc:
<comment>Description:</comment>
  Возвращает представление, которое можно преобразовать в JSON

<comment>Return:</comment>
  <info>mixed</info>  Возвращает данные, которые могут быть сериализованы с помощью <strong>json_encode()</strong> для создания
         расширенного JSON-представления <class>MongoDB\BSON\Int64</class>.
         
         Вывод соответствует функции <strong>MongoDB\BSON\toCanonicalExtendedJSON()</strong>, которая использует
         канонический расширенный формат JSON. Это отличается от других классов BSON, которые
         используют устаревший расширенный формат JSON для конкретного драйвера
         (<strong>MongoDB\BSON\toJSON()</strong>), чтобы обеспечить правильное представление 64-разрядного
         целочисленного значения на 32-разрядных платформах.

<comment>See Also:</comment>
   * JsonSerializable::jsonSerialize
   * <strong>json_encode()</strong>
   * <strong>MongoDB\BSON\toCanonicalExtendedJSON()</strong>
   * <strong>MongoDB\BSON\toRelaxedExtendedJSON()</strong>
   * MongoDB Extended JSON


id: MongoDB\BSON\Int64::serialize
type: function
doc:
<comment>Description:</comment>
  Сериализует Int64

<comment>Return:</comment>
  <info>string</info>  Возвращает сериализованное представление <class>MongoDB\BSON\Int64</class>.

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


id: MongoDB\BSON\Int64::unserialize
type: function
doc:
<comment>Description:</comment>
  Десериализует Int64

<comment>Param:</comment>
  <info>string</info>  <strong>$data</strong>  Сериализованный <class>MongoDB\BSON\Int64</class>.

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

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


id: MongoDB\BSON\Iterator::__construct
type: function
doc:
<comment>Description:</comment>
  Создаёт новый итератор BSON (не используется)
  
  Объекты <class>MongoDB\BSON\Iterator</class> создаются путём вызова MongoDB\BSON\Document::getIterator или
  MongoDB\BSON\PackedArray::getIterator и не могут быть инициализированы напрямую.

<comment>See Also:</comment>
   * MongoDB\BSON\Document::getIterator
   * MongoDB\BSON\PackedArray::getIterator
   * Типы BSON


id: MongoDB\BSON\Iterator::current
type: function
doc:
<comment>Description:</comment>
  Возвращает текущий элемент

<comment>Return:</comment>
  <info>mixed</info>  Возвращает значение текущего элемента.
         
         Если в структуре BSON встречается значение, закодированное как 64-битное целое число, то
         возвращаемым значением метода будет экземпляр <class>MongoDB\BSON\Int64</class>.

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


id: MongoDB\BSON\Iterator::key
type: function
doc:
<comment>Description:</comment>
  Возвращает ключ текущего элемента

<comment>Return:</comment>
  <info>string|int</info>  Возвращает ключ текущего элемента. При итерации BSON-документа ключом всегда будет
              строка (<info>string</info>). При итерации массива BSON ключом будет целое число (<info>int</info>).

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


id: MongoDB\BSON\Iterator::next
type: function
doc:
<comment>Description:</comment>
  Перемещает итератор к следующему элементу

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

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


id: MongoDB\BSON\Iterator::rewind
type: function
doc:
<comment>Description:</comment>
  Перематывает итератор к первому элементу

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

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


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

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

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


id: MongoDB\BSON\Javascript
type: class
doc:
<comment>Description:</comment>
  Тип BSON для кода Javascript. Может быть указан необязательный документ области видимости, который
  сопоставляет идентификаторы со значениями и определяет область, в которой код должен оцениваться
  сервером.
  
  Этот тип BSON в основном используется при выполнении команд базы данных, которые принимают функцию
  Javascript в качестве параметра, например mapReduce.


id: MongoDB\BSON\Javascript::__construct
type: function
doc:
<comment>Description:</comment>
  Конструктор Javascript

<comment>Param:</comment>
  <info>string</info>             <strong>$code</strong>   Код Javascript.
  <info>array|object|null</info>  <strong>$scope</strong>  Контекст Javascript.

<comment>See Also:</comment>
   * Типы BSON


id: MongoDB\BSON\Javascript::__toString
type: function
doc:
<comment>Description:</comment>
  Возвращает код JavaScript
  
  Метод является псевдонимом:  MongoDB\BSON\Javascript::getCode.

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

<comment>See Also:</comment>
   * MongoDB\BSON\Javascript::getCode
   * Типы BSON


id: MongoDB\BSON\Javascript::getCode
type: function
doc:
<comment>Description:</comment>
  Возвращает код JavaScript

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

<comment>See Also:</comment>
   * Типы BSON


id: MongoDB\BSON\Javascript::getScope
type: function
doc:
<comment>Description:</comment>
  Возвращает область документа JavaScript

<comment>Return:</comment>
  <info>object|null</info>  Возвращает область документа JavaScript или <info>null</info> в случае, если области нет.

<comment>See Also:</comment>
   * Типы BSON


id: MongoDB\BSON\Javascript::jsonSerialize
type: function
doc:
<comment>Description:</comment>
  Возвращает представление, которое может быть преобразовано в JSON

<comment>Return:</comment>
  <info>mixed</info>  Возвращает данные, которые могут быть сериализованы <strong>json_encode()</strong> для создания
         JSON-представления <class>MongoDB\BSON\Javascript</class>.
         
         Вывод соответствует выводу функции <strong>MongoDB\BSON\toJSON()</strong>, которая использует
         унаследованный, специфичный для драйвера, расширенный формат JSON. Он не обязательно будет
         подходить под relaxed или canonical представления расширенного JSON, используемых в
         <strong>MongoDB\BSON\toRelaxedExtendedJSON()</strong> и <strong>MongoDB\BSON\toCanonicalExtendedJSON()</strong>,
         соответственно.

<comment>See Also:</comment>
   * JsonSerializable::jsonSerialize
   * <strong>json_encode()</strong>
   * <strong>MongoDB\BSON\toCanonicalExtendedJSON()</strong>
   * <strong>MongoDB\BSON\toRelaxedExtendedJSON()</strong>
   * Расширенный JSON MongoDB


id: MongoDB\BSON\Javascript::serialize
type: function
doc:
<comment>Description:</comment>
  Сериализовать JavaScript

<comment>Return:</comment>
  <info>string</info>  Возвращает сериализованное представление <class>MongoDB\BSON\Javascript</class>.

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


id: MongoDB\BSON\Javascript::unserialize
type: function
doc:
<comment>Description:</comment>
  Десериализовать JavaScript

<comment>Param:</comment>
  <info>string</info>  <strong>$data</strong>  Сериализованный <class>MongoDB\BSON\Javascript</class>.

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

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


id: MongoDB\BSON\JavascriptInterface
type: class
doc:
<comment>Description:</comment>
  Этот интерфейс реализован <class>MongoDB\BSON\Javascript</class>, но также может использоваться в качестве
  параметра, возвращаемого значения или типа свойства в классах пользовательского пространства.


id: MongoDB\BSON\JavascriptInterface::__toString
type: function
doc:
<comment>Description:</comment>
  Возвращает код JavascriptInterface
  
  Метод является псевдонимом:  MongoDB\BSON\JavascriptInterface::getCode.

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

<comment>See Also:</comment>
   * MongoDB\BSON\JavascriptInterface::getCode
   * MongoDB\BSON\Javascript::__toString


id: MongoDB\BSON\JavascriptInterface::getCode
type: function
doc:
<comment>Description:</comment>
  Возвращает код JavascriptInterface

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

<comment>See Also:</comment>
   * MongoDB\BSON\Javascript::getCode


id: MongoDB\BSON\JavascriptInterface::getScope
type: function
doc:
<comment>Description:</comment>
  Возвращает области видимости документа JavascriptInterface

<comment>Return:</comment>
  <info>object|null</info>  Возвращает области видимости документа JavascriptInterface.

<comment>See Also:</comment>
   * MongoDB\BSON\Javascript::getScope


id: MongoDB\BSON\MaxKey
type: class
doc:
<comment>Description:</comment>
  Специальный тип BSON, который сравнивает выше всех других возможных значений элемента BSON.
  
  Это внутренний тип MongoDB, используемый для индексации и шардинга.


id: MongoDB\BSON\MaxKey::jsonSerialize
type: function
doc:
<comment>Description:</comment>
  Возвращает представление, которое можно преобразовать в JSON

<comment>Return:</comment>
  <info>mixed</info>  Возвращает данные, которые могут быть сериализованы с помощью <strong>json_encode()</strong> для создания
         расширенного JSON-представления <class>MongoDB\BSON\MaxKey</class>.
         
         Вывод соответствует выводу функции <strong>MongoDB\BSON\toJSON()</strong>, которая использует
         унаследованный, специфичный для драйвера, расширенный формат JSON. Он не обязательно будет
         подходить под relaxed или canonical представления расширенного JSON, используемых в
         <strong>MongoDB\BSON\toRelaxedExtendedJSON()</strong> и <strong>MongoDB\BSON\toCanonicalExtendedJSON()</strong>,
         соответственно.

<comment>See Also:</comment>
   * JsonSerializable::jsonSerialize
   * <strong>json_encode()</strong>
   * <strong>MongoDB\BSON\toCanonicalExtendedJSON()</strong>
   * <strong>MongoDB\BSON\toRelaxedExtendedJSON()</strong>
   * MongoDB Extended JSON


id: MongoDB\BSON\MaxKey::serialize
type: function
doc:
<comment>Description:</comment>
  Сериализует MaxKey

<comment>Return:</comment>
  <info>string</info>  Возвращает сериализованное представление <class>MongoDB\BSON\MaxKey</class>.

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


id: MongoDB\BSON\MaxKey::unserialize
type: function
doc:
<comment>Description:</comment>
  Десериализует MaxKey

<comment>Param:</comment>
  <info>string</info>  <strong>$data</strong>  Сериализованный <class>MongoDB\BSON\MaxKey</class>.

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

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


id: MongoDB\BSON\MinKey
type: class
doc:
<comment>Description:</comment>
  Специальный тип BSON, который сравнивает ниже всех других возможных значений элемента BSON.
  
  Это внутренний тип MongoDB, используемый для индексации и шардинга.


id: MongoDB\BSON\MinKey::jsonSerialize
type: function
doc:
<comment>Description:</comment>
  Возвращает представление, которое можно преобразовать в JSON

<comment>Return:</comment>
  <info>mixed</info>  Возвращает данные, которые могут быть сериализованы с помощью <strong>json_encode()</strong> для создания
         расширенного JSON-представления <class>MongoDB\BSON\MinKey</class>.
         
         Вывод соответствует выводу функции <strong>MongoDB\BSON\toJSON()</strong>, которая использует
         унаследованный, специфичный для драйвера, расширенный формат JSON. Он не обязательно будет
         подходить под relaxed или canonical представления расширенного JSON, используемых в
         <strong>MongoDB\BSON\toRelaxedExtendedJSON()</strong> и <strong>MongoDB\BSON\toCanonicalExtendedJSON()</strong>,
         соответственно.

<comment>See Also:</comment>
   * JsonSerializable::jsonSerialize
   * <strong>json_encode()</strong>
   * <strong>MongoDB\BSON\toCanonicalExtendedJSON()</strong>
   * <strong>MongoDB\BSON\toRelaxedExtendedJSON()</strong>
   * MongoDB Extended JSON


id: MongoDB\BSON\MinKey::serialize
type: function
doc:
<comment>Description:</comment>
  Сериализует MinKey

<comment>Return:</comment>
  <info>string</info>  Возвращает сериализованное представление <class>MongoDB\BSON\MinKey</class>.

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


id: MongoDB\BSON\MinKey::unserialize
type: function
doc:
<comment>Description:</comment>
  Десериализует MinKey

<comment>Param:</comment>
  <info>string</info>  <strong>$data</strong>  Сериализованный <class>MongoDB\BSON\MinKey</class>.

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

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


id: MongoDB\BSON\ObjectId
type: class
doc:
<comment>Description:</comment>
  Тип BSON для ObjectId. Значение состоит из 12 байтов, где первые четыре байта являются меткой
  времени, которая отражает создание ObjectId. В частности, значение состоит из:
  
  4-байтовое значение, представляющее секунды с начала эпохи Unix,
  
  5-байтовое случайное число, уникальное для машины и процесса, и
  
  3-байтовый счётчик, начинающийся со случайного значения.
  
  В MongoDB каждый документ, хранящийся в коллекции, требует уникального поля <return>_id</return>, которое действует
  как первичный ключ. Если во вставленном документе пропущено поле <return>_id</return>, драйвер автоматически
  создаёт ObjectId для поля <return>_id</return>.
  
  Использование ObjectIds для поля <return>_id</return> обеспечивает следующие дополнительные преимущества:
  
  Время создания ObjectId можно получить с помощью метода MongoDB\BSON\ObjectId::getTimestamp.
  
  Сортировка по полю <return>_id</return>, в котором хранятся значения ObjectId, примерно эквивалентна сортировке по
  времени создания.


id: MongoDB\BSON\ObjectId::__construct
type: function
doc:
<comment>Description:</comment>
  Создаёт новый ObjectId

<comment>Param:</comment>
  <info>string|null</info>  <strong>$id</strong>  24-символьная шестнадцатеричная строка. Если не указано, драйвер сгенерирует
                    ObjectId.

<comment>See Also:</comment>
   * Справка по ObjectId
   * Типы BSON: ObjectId


id: MongoDB\BSON\ObjectId::__toString
type: function
doc:
<comment>Description:</comment>
  Возвращает шестнадцатеричное представление ObjectId

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

<comment>See Also:</comment>
   * Справка по ObjectId
   * Типы BSON: ObjectId


id: MongoDB\BSON\ObjectId::getTimestamp
type: function
doc:
<comment>Description:</comment>
  Возвращает метку времени ObjectId
  
  Компонент метки времени в ObjectId - это его наиболее значимые 32 бита, которые обозначают
  количество секунд с начала эпохи Unix. Это значение читается, как 32-разрядное целое число без
  знака с порядком байтов в старшем порядке.
  
  Так как целочисленный тип в PHP является знаковым, некоторые значения, полученные с помощью этого
  метода, могут превратиться в отрицательные целые числа на 32-битных платформах. Для получения
  строкового представления беззнакового целого можно воспользоваться шаблоном форматирования "%u"
  функции <strong>sprintf()</strong>.

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

<comment>See Also:</comment>
   * Справка по ObjectId
   * Типы BSON: ObjectId


id: MongoDB\BSON\ObjectId::jsonSerialize
type: function
doc:
<comment>Description:</comment>
  Возвращает представление, которое можно преобразовать в JSON

<comment>Return:</comment>
  <info>mixed</info>  Возвращает данные, которые могут быть сериализованы с помощью <strong>json_encode()</strong> для создания
         расширенного JSON-представления <class>MongoDB\BSON\ObjectId</class>.
         
         Вывод соответствует выводу функции <strong>MongoDB\BSON\toJSON()</strong>, которая использует
         унаследованный, специфичный для драйвера, расширенный формат JSON. Он не обязательно будет
         подходить под relaxed или canonical представления расширенного JSON, используемых в
         <strong>MongoDB\BSON\toRelaxedExtendedJSON()</strong> и <strong>MongoDB\BSON\toCanonicalExtendedJSON()</strong>,
         соответственно.

<comment>See Also:</comment>
   * JsonSerializable::jsonSerialize
   * <strong>json_encode()</strong>
   * <strong>MongoDB\BSON\toCanonicalExtendedJSON()</strong>
   * <strong>MongoDB\BSON\toRelaxedExtendedJSON()</strong>
   * MongoDB Extended JSON


id: MongoDB\BSON\ObjectId::serialize
type: function
doc:
<comment>Description:</comment>
  Сериализует ObjectId

<comment>Return:</comment>
  <info>string</info>  Возвращает сериализованное представление <class>MongoDB\BSON\ObjectId</class>.

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


id: MongoDB\BSON\ObjectId::unserialize
type: function
doc:
<comment>Description:</comment>
  Десериализует ObjectId

<comment>Param:</comment>
  <info>string</info>  <strong>$data</strong>  Сериализованный <class>MongoDB\BSON\ObjectId</class>.

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

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


id: MongoDB\BSON\ObjectIdInterface
type: class
doc:
<comment>Description:</comment>
  Этот интерфейс реализован с помощью <class>MongoDB\BSON\ObjectId</class>, но также может быть использован для в
  качестве параметра, возвращаемого значения или типа свойства в классах пользовательского
  пространства.


id: MongoDB\BSON\ObjectIdInterface::__toString
type: function
doc:
<comment>Description:</comment>
  Возвращает шестнадцатеричное представление ObjectIdInterface

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

<comment>See Also:</comment>
   * MongoDB\BSON\ObjectId::__toString


id: MongoDB\BSON\ObjectIdInterface::getTimestamp
type: function
doc:
<comment>Description:</comment>
  Возвращает компонент отметки времени ObjectIdInterface

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

<comment>See Also:</comment>
   * MongoDB\BSON\ObjectId::getTimestamp


id: MongoDB\BSON\PackedArray
type: class
doc:
<comment>Description:</comment>
  Представляет массив BSON. Класс используется при чтении данных в виде необработанного BSON и не
  может быть модифицирован.


id: MongoDB\BSON\PackedArray::__construct
type: function
doc:
<comment>Description:</comment>
  Создаёт новый массив BSON (не используется)
  
  Объекты <class>MongoDB\BSON\PackedArray</class> создаются с помощью статических фабричных методов и не могут быть
  инициализированы напрямую.

<comment>See Also:</comment>
   * MongoDB\BSON\PackedArray::fromPHP
   * Типы BSON


id: MongoDB\BSON\PackedArray::__toString
type: function
doc:
<comment>Description:</comment>
  Возвращает строковое представление BSON-массива

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

<comment>See Also:</comment>
   * Типы BSON


id: MongoDB\BSON\PackedArray::fromPHP
type: function
doc:
<comment>Description:</comment>
  Создаёт новый экземпляр массива BSON из данных PHP

<comment>Param:</comment>
  <info>array</info>  <strong>$value</strong>  Массив PHP для преобразования в массив BSON. Массив должен быть списком (т.е. иметь
                 последовательные числовые ключи, начинающиеся с <info>0</info>).

<comment>Return:</comment>
  <info>MongoDB\BSON\PackedArray</info>  

<comment>See Also:</comment>
   * <strong>MongoDB\BSON\fromPHP()</strong>
   * Типы BSON


id: MongoDB\BSON\PackedArray::get
type: function
doc:
<comment>Description:</comment>
  Возвращает значение индекса массива

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

<comment>Return:</comment>
  <info>mixed</info>  Возвращает значение, связанное с заданным индексом. Если индекс не присутствует в
         документе, то будет выброшено исключение.
         
         Если в массиве BSON встречается значение, закодированное как 64-битное целое число, то
         возвращаемым значением метода будет экземпляр <class>MongoDB\BSON\Int64</class>.

<comment>See Also:</comment>
   * MongoDB\BSON\PackedArray::has
   * Типы BSON


id: MongoDB\BSON\PackedArray::getIterator
type: function
doc:
<comment>Description:</comment>
  Возвращает итератор для массива BSON

<comment>Return:</comment>
  <info>MongoDB\BSON\Iterator</info>  Возвращает экземпляр <class>MongoDB\BSON\Iterator</class>, который может быть использован
                         для итерации по всем индексам в массиве.

<comment>See Also:</comment>
   * Типы BSON


id: MongoDB\BSON\PackedArray::has
type: function
doc:
<comment>Description:</comment>
  Возвращает, присутствует ли индекс в массиве

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

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

<comment>See Also:</comment>
   * MongoDB\BSON\PackedArray::get
   * Типы BSON


id: MongoDB\BSON\PackedArray::serialize
type: function
doc:
<comment>Description:</comment>
  Сериализация массива BSON

<comment>Return:</comment>
  <info>string</info>  Возвращает сериализованное представление массива <class>MongoDB\BSON\PackedArray</class>.

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


id: MongoDB\BSON\PackedArray::toPHP
type: function
doc:
<comment>Description:</comment>
  Возвращает PHP-представление массива BSON

<comment>Param:</comment>
  <info>array|null</info>  <strong>$typeMap</strong>  Конфигурация карты типов.

<comment>Return:</comment>
  <info>array|object</info>  Декодированное значение PHP.
                
                Если в массиве BSON встречается значение, закодированное как 64-битное целое число,
                то возвращаемым значением метода будет экземпляр <class>MongoDB\BSON\Int64</class>.

<comment>See Also:</comment>
   * <strong>MongoDB\BSON\toPHP()</strong>
   * Типы BSON


id: MongoDB\BSON\PackedArray::unserialize
type: function
doc:
<comment>Description:</comment>
  Десериализует массив BSON

<comment>Param:</comment>
  <info>string</info>  <strong>$data</strong>  Сериализованный <class>MongoDB\BSON\PackedArray</class>.

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

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


id: MongoDB\BSON\Persistable
type: class
doc:
<comment>Description:</comment>
  Классы могут реализовывать этот интерфейс для использования преимуществ автоматического ODM
  (сопоставление документов объекта) поведения в драйвере. Во время сериализации драйвер вставляет
  свойство __pclass, содержащее имя класса PHP, в данные, возвращаемые
  <strong>MongoDB\BSON\Serializable::bsonSerialize()</strong>. Во время десериализации то же свойство __pclass будет
  использоваться для вывода класса PHP (независимого от любой конфигурации типа карты), которая
  должна быть создана до вызова <strong>MongoDB\BSON\Unserializable::bsonUnserialize()</strong>. Смотрите  для
  получения дополнительной информации.
  
  Даже если <strong>MongoDB\BSON\Serializable::bsonSerialize()</strong> вернёт последовательный массив, внедрение
  свойства __pclass приведёт к сериализации объекта, как документа BSON.


id: MongoDB\BSON\Persistable::bsonSerialize
type: function
doc:
<comment>Description:</comment>
  Предоставляет массив или документ для сериализации в формате BSON
  
  Вызывается при сериализации объекта в BSON. Метод должен возвращать массив (<info>array</info>), <class>stdClass</class> или
  <class>MongoDB\BSON\Document</class>.
  
  Возвращаемое значение всегда будет сериализовано в виде BSON-документа. Сериализованный документ
  будет включать поле, содержащее имя класса объекта. По этой причине в данном методе невозможно
  вернуть экземпляр класса <class>MongoDB\BSON\PackedArray</class>.
  
  Пользователям рекомендуется включать свойство _id (например, <class>MongoDB\BSON\ObjectId</class>,
  инициализированное в вашем конструкторе) при возвращении данных для корневого документа BSON;
  иначе драйверу или базе данных придётся генерировать <class>MongoDB\BSON\ObjectId</class> при добавлении или
  обновлении документа, соответственно.

<comment>Return:</comment>
  <info>array|stdClass|MongoDB\BSON\Document</info>  Массив (<info>array</info>), <class>stdClass</class> или <class>MongoDB\BSON\Document</class>, который
                                        должен быть сериализован в виде BSON-документа.

<comment>See Also:</comment>
   * <strong>MongoDB\BSON\Serializable::bsonSerialize()</strong>
   * <strong>MongoDB\BSON\Unserializable::bsonUnserialize()</strong>
   * MongoDB\BSON\Persistable
   * 


id: MongoDB\BSON\Regex
type: class
doc:
<comment>Description:</comment>
  Тип BSON для шаблона регулярного выражения и дополнительные флаги.
  
  Этот тип BSON в основном используется при запросах к базе данных. В качестве альтернативы можно
  использовать оператор запроса $regex.


id: MongoDB\BSON\Regex::__construct
type: function
doc:
<comment>Description:</comment>
  Создаёт новый Regex

<comment>Param:</comment>
  <info>string</info>  <strong>$pattern</strong>  Шаблон регулярного выражения.
                    
                    Шаблон не должен быть заключён в символы-разделители.
  <info>string</info>  <strong>$flags</strong>    Флаги регулярных выражений. Символы в этом аргументе будут отсортированы в
                    алфавитном порядке.

<comment>See Also:</comment>
   * Типы BSON
   * Поддерживаемые флаги регулярных выражений


id: MongoDB\BSON\Regex::__toString
type: function
doc:
<comment>Description:</comment>
  Возвращает строковое представление Regex

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

<comment>See Also:</comment>
   * Типы BSON


id: MongoDB\BSON\Regex::getFlags
type: function
doc:
<comment>Description:</comment>
  Возвращает флаги Regex

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

<comment>See Also:</comment>
   * Типы BSON
   * Поддерживаемые флаги регулярных выражений


id: MongoDB\BSON\Regex::getPattern
type: function
doc:
<comment>Description:</comment>
  Возвращает шаблон Regex

<comment>Return:</comment>
  <info>string</info>  Возвращает шаблон Regex.

<comment>See Also:</comment>
   * Типы BSON


id: MongoDB\BSON\Regex::jsonSerialize
type: function
doc:
<comment>Description:</comment>
  Возвращает представление, которое можно преобразовать в JSON

<comment>Return:</comment>
  <info>mixed</info>  Возвращает данные, которые могут быть сериализованы с помощью <strong>json_encode()</strong> для создания
         расширенного JSON-представления <class>MongoDB\BSON\Regex</class>.
         
         Вывод соответствует выводу функции <strong>MongoDB\BSON\toJSON()</strong>, которая использует
         унаследованный, специфичный для драйвера, расширенный формат JSON. Он не обязательно будет
         подходить под relaxed или canonical представления расширенного JSON, используемых в
         <strong>MongoDB\BSON\toRelaxedExtendedJSON()</strong> и <strong>MongoDB\BSON\toCanonicalExtendedJSON()</strong>,
         соответственно.

<comment>See Also:</comment>
   * JsonSerializable::jsonSerialize
   * <strong>json_encode()</strong>
   * <strong>MongoDB\BSON\toCanonicalExtendedJSON()</strong>
   * <strong>MongoDB\BSON\toRelaxedExtendedJSON()</strong>
   * MongoDB Extended JSON


id: MongoDB\BSON\Regex::serialize
type: function
doc:
<comment>Description:</comment>
  Сериализует Regex

<comment>Return:</comment>
  <info>string</info>  Возвращает сериализованное представление <class>MongoDB\BSON\Regex</class>.

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


id: MongoDB\BSON\Regex::unserialize
type: function
doc:
<comment>Description:</comment>
  Десериализует Regex

<comment>Param:</comment>
  <info>string</info>  <strong>$data</strong>  Сериализованный <class>MongoDB\BSON\Regex</class>.

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

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


id: MongoDB\BSON\RegexInterface
type: class
doc:
<comment>Description:</comment>
  Этот интерфейс реализован <class>MongoDB\BSON\Regex</class>, в качестве параметра, возвращаемого значения или
  типа свойства в классах пользовательского пространства.


id: MongoDB\BSON\RegexInterface::__toString
type: function
doc:
<comment>Description:</comment>
  Возвращает строковое представление RegexInterface

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

<comment>See Also:</comment>
   * MongoDB\BSON\Regex::__toString


id: MongoDB\BSON\RegexInterface::getFlags
type: function
doc:
<comment>Description:</comment>
  Возвращает флаги RegexInterface

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

<comment>See Also:</comment>
   * MongoDB\BSON\Regex::getFlags


id: MongoDB\BSON\RegexInterface::getPattern
type: function
doc:
<comment>Description:</comment>
  Возвращает шаблон RegexInterface

<comment>Return:</comment>
  <info>string</info>  Возвращает шаблон RegexInterface.

<comment>See Also:</comment>
   * MongoDB\BSON\Regex::getPattern


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


id: MongoDB\BSON\Serializable::bsonSerialize
type: function
doc:
<comment>Description:</comment>
  Предоставляет массив или документ для сериализации в BSON
  
  Вызывается во время сериализации объекта в BSON. Метод должен возвращать <info>array</info> или <class>stdClass</class>.
  
  Корневые документы (например, MongoDB\BSON\Serializable, переданные в <strong>MongoDB\BSON\fromPHP()</strong>)
  всегда будут сериализованы, как документ BSON. Для значений полей ассоциативные массивы и
  экземпляры <class>stdClass</class> будут сериализованы в виде документа BSON, а последовательные массивы
  (например, последовательные числовые индексы, начинающиеся с <return>0</return>) будут сериализованы в виде массива
  BSON.
  
  Пользователям рекомендуется включать свойство _id (например, <class>MongoDB\BSON\ObjectId</class>,
  инициализированный в вашем конструкторе) при возврате данных для корневого документа BSON; в
  противном случае драйвер или база данных должны будут сгенерировать <class>MongoDB\BSON\ObjectId</class> при
  вставке или слиянии документа, соответственно.

<comment>Return:</comment>
  <info>array|object</info>  <info>array</info> или <class>stdClass</class> для сериализации в виде массива или документа BSON.

<comment>See Also:</comment>
   * <strong>MongoDB\BSON\Unserializable::bsonUnserialize()</strong>
   * MongoDB\BSON\Persistable
   * 


id: MongoDB\BSON\Symbol
type: class
doc:
<comment>Description:</comment>
  Тип BSON для типа "Symbol". Этот тип BSON устарел, и этот класс не может быть создан. Он будет
  создан из типа символа BSON во время преобразования BSON в PHP, а также при преобразовании обратно
  в BSON при хранении документов в базе данных.


id: MongoDB\BSON\Symbol::__construct
type: function
doc:
<comment>Description:</comment>
  Создаёт новый Symbol (не используется)
  
  Объекты <class>MongoDB\BSON\Symbol</class> создаются путём преобразования из устаревшего типа BSON и не могут
  быть созданы напрямую.

<comment>See Also:</comment>
   * Типы BSON


id: MongoDB\BSON\Symbol::__toString
type: function
doc:
<comment>Description:</comment>
  Возвращает Symbol в виде строки

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

<comment>See Also:</comment>
   * Типы BSON


id: MongoDB\BSON\Symbol::jsonSerialize
type: function
doc:
<comment>Description:</comment>
  Возвращает представление, которое можно преобразовать в JSON

<comment>Return:</comment>
  <info>mixed</info>  Возвращает данные, которые могут быть сериализованы с помощью <strong>json_encode()</strong> для создания
         расширенного JSON-представления <class>MongoDB\BSON\Symbol</class>.
         
         Вывод соответствует выводу функции <strong>MongoDB\BSON\toJSON()</strong>, которая использует
         унаследованный, специфичный для драйвера, расширенный формат JSON. Он не обязательно будет
         подходить под relaxed или canonical представления расширенного JSON, используемых в
         <strong>MongoDB\BSON\toRelaxedExtendedJSON()</strong> и <strong>MongoDB\BSON\toCanonicalExtendedJSON()</strong>,
         соответственно.

<comment>See Also:</comment>
   * JsonSerializable::jsonSerialize
   * <strong>json_encode()</strong>
   * <strong>MongoDB\BSON\toCanonicalExtendedJSON()</strong>
   * <strong>MongoDB\BSON\toRelaxedExtendedJSON()</strong>
   * MongoDB Extended JSON


id: MongoDB\BSON\Symbol::serialize
type: function
doc:
<comment>Description:</comment>
  Сериализует Symbol

<comment>Return:</comment>
  <info>string</info>  Возвращает сериализованное представление <class>MongoDB\BSON\Symbol</class>.

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


id: MongoDB\BSON\Symbol::unserialize
type: function
doc:
<comment>Description:</comment>
  Десериализует Symbol

<comment>Param:</comment>
  <info>string</info>  <strong>$data</strong>  Сериализованный <class>MongoDB\BSON\Symbol</class>.

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

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


id: MongoDB\BSON\Timestamp
type: class
doc:
<comment>Description:</comment>
  Представляет метку времени BSON. Значение состоит из 4-байтовой метки времени (т.е. секунды с
  начала эпохи) и 4-байтового приращения.
  
  Это внутренний тип MongoDB, используемый для репликации и разделения. Он не предназначен для
  общего хранения дат (вместо него следует использовать <class>MongoDB\BSON\UTCDateTime</class>).


id: MongoDB\BSON\Timestamp::__construct
type: function
doc:
<comment>Description:</comment>
  Создаёт новый Timestamp

<comment>Param:</comment>
  <info>int</info>  <strong>$increment</strong>  32-разрядное целое число, обозначающее увеличивающийся порядковый номер для
                   операций в течение данной секунды.
  <info>int</info>  <strong>$timestamp</strong>  32-разрядное целое число, обозначающее секунды с начала эпохи Unix.

<comment>See Also:</comment>
   * Типы BSON: Timestamps


id: MongoDB\BSON\Timestamp::__toString
type: function
doc:
<comment>Description:</comment>
  Возвращает строковое представление Timestamp

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

<comment>See Also:</comment>
   * Типы BSON: Timestamps


id: MongoDB\BSON\Timestamp::getIncrement
type: function
doc:
<comment>Description:</comment>
  Возвращает компонент приращения Timestamp
  
  Компонент приращения Timestamp - это его младшие 32 бита, которые обозначают порядковый номер
  приращения для операций в течение данной секунды. Это значение читается как 32-разрядное целое
  число без знака с порядком байтов в старшем порядке.
  
  Так как целочисленный тип в PHP является знаковым, некоторые значения, полученные с помощью этого
  метода, могут превратиться в отрицательные целые числа на 32-битных платформах. Для получения
  строкового представления беззнакового целого можно воспользоваться шаблоном форматирования "%u"
  функции <strong>sprintf()</strong>.

<comment>Return:</comment>
  <info>int</info>  Возвращает компонент приращения Timestamp.
       
       В 32-битных системах этот метод может возвращать отрицательное число. Хотя части приращения и
       отметки времени типа отметки времени BSON состоят из двух 32-разрядных значений без знака,
       PHP не может представить их на 32-разрядных платформах.

<comment>See Also:</comment>
   * Типы BSON: Timestamps


id: MongoDB\BSON\Timestamp::getTimestamp
type: function
doc:
<comment>Description:</comment>
  Возвращает компонент отметки времени Timestamp
  
  Компонент отметки времени Timestamp - это его наиболее значимые 32 бита, которые обозначают
  количество секунд с начала эпохи Unix. Это значение читается, как 32-разрядное целое число без
  знака с порядком байтов в старшем порядке.
  
  Так как целочисленный тип в PHP является знаковым, некоторые значения, полученные с помощью этого
  метода, могут превратиться в отрицательные целые числа на 32-битных платформах. Для получения
  строкового представления беззнакового целого можно воспользоваться шаблоном форматирования "%u"
  функции <strong>sprintf()</strong>.

<comment>Return:</comment>
  <info>int</info>  Возвращает компонент отметки времени Timestamp.
       
       В 32-битных системах этот метод может возвращать отрицательное число. Хотя части приращения и
       отметки времени типа отметки времени BSON состоят из двух 32-разрядных значений без знака,
       PHP не может представить их на 32-разрядных платформах.

<comment>See Also:</comment>
   * Типы BSON: Timestamps


id: MongoDB\BSON\Timestamp::jsonSerialize
type: function
doc:
<comment>Description:</comment>
  Возвращает представление, которое можно преобразовать в JSON

<comment>Return:</comment>
  <info>mixed</info>  Возвращает данные, которые могут быть сериализованы с помощью <strong>json_encode()</strong> для создания
         расширенного JSON-представления <class>MongoDB\BSON\Timestamp</class>.
         
         Вывод соответствует выводу функции <strong>MongoDB\BSON\toJSON()</strong>, которая использует
         унаследованный, специфичный для драйвера, расширенный формат JSON. Он не обязательно будет
         подходить под relaxed или canonical представления расширенного JSON, используемых в
         <strong>MongoDB\BSON\toRelaxedExtendedJSON()</strong> и <strong>MongoDB\BSON\toCanonicalExtendedJSON()</strong>,
         соответственно.

<comment>See Also:</comment>
   * JsonSerializable::jsonSerialize
   * <strong>json_encode()</strong>
   * <strong>MongoDB\BSON\toCanonicalExtendedJSON()</strong>
   * <strong>MongoDB\BSON\toRelaxedExtendedJSON()</strong>
   * MongoDB Extended JSON


id: MongoDB\BSON\Timestamp::serialize
type: function
doc:
<comment>Description:</comment>
  Сериализует Timestamp

<comment>Return:</comment>
  <info>string</info>  Возвращает сериализованное представление <class>MongoDB\BSON\Timestamp</class>.

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


id: MongoDB\BSON\Timestamp::unserialize
type: function
doc:
<comment>Description:</comment>
  Десериализует Timestamp

<comment>Param:</comment>
  <info>string</info>  <strong>$data</strong>  Сериализованный <class>MongoDB\BSON\Timestamp</class>.

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

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


id: MongoDB\BSON\TimestampInterface
type: class
doc:
<comment>Description:</comment>
  Этот интерфейс реализован с помощью <class>MongoDB\BSON\Timestamp</class>, но также может использоваться в
  качестве параметра, возвращаемого значения или типа свойства в классах пользовательского
  пространства.


id: MongoDB\BSON\TimestampInterface::__toString
type: function
doc:
<comment>Description:</comment>
  Возвращает строковое представление TimestampInterface

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

<comment>See Also:</comment>
   * MongoDB\BSON\Timestamp::__toString


id: MongoDB\BSON\TimestampInterface::getIncrement
type: function
doc:
<comment>Description:</comment>
  Возвращает инкрементный компонент TimestampInterface

<comment>Return:</comment>
  <info>int</info>  Возвращает инкрементный компонент TimestampInterface.
       
       В 32-битных системах этот метод может возвращать отрицательное число. Хотя части приращения и
       отметки времени типа отметки времени BSON состоят из двух 32-разрядных значений без знака,
       PHP не может представлять их на 32-разрядных платформах.

<comment>See Also:</comment>
   * MongoDB\BSON\Timestamp::getIncrement


id: MongoDB\BSON\TimestampInterface::getTimestamp
type: function
doc:
<comment>Description:</comment>
  Возвращает компонент отметки времени TimestampInterface

<comment>Return:</comment>
  <info>int</info>  Возвращает компонент отметки времени TimestampInterface.
       
       В 32-битных системах этот метод может возвращать отрицательное число. Хотя части приращения и
       отметки времени типа отметки времени BSON состоят из двух 32-разрядных значений без знака,
       PHP не может представлять их на 32-разрядных платформах.

<comment>See Also:</comment>
   * MongoDB\BSON\Timestamp::getTimestamp


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


id: MongoDB\BSON\UTCDateTime
type: class
doc:
<comment>Description:</comment>
  Представляет дату BSON. Значение представляет собой 64-разрядное целое число, представляющее
  количество миллисекунд с начала эпохи Unix (1 января 1970 г.). Отрицательные значения представляют
  даты до 1970 года.


id: MongoDB\BSON\UTCDateTime::__construct
type: function
doc:
<comment>Description:</comment>
  Создаёт новый UTCDateTime

<comment>Param:</comment>
  <info>int|float|string|DateTimeInterface|null</info>  <strong>$milliseconds</strong>  Количество миллисекунд со времён Unix (1
                                                          января 1970 г.). Отрицательные значения
                                                          представляют даты до 1970 года. Это
                                                          значение может быть представлено как
                                                          64-разрядный <info>int</info>. Для совместимости в
                                                          32-битных системах этот параметр также
                                                          может быть представлен, как <info>float</info> или
                                                          <info>string</info>.
                                                          
                                                          Если аргумент является <class>DateTimeInterface</class>,
                                                          из этого значения будет получено
                                                          количество миллисекунд, прошедших с начала
                                                          эпохи Unix.
                                                          
                                                          Если этот аргумент равен <info>null</info>, будет
                                                          использоваться текущее время по умолчанию.

<comment>See Also:</comment>
   * Типы BSON: Date


id: MongoDB\BSON\UTCDateTime::__toString
type: function
doc:
<comment>Description:</comment>
  Возвращает строковое представление UTCDateTime

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

<comment>See Also:</comment>
   * Типы BSON: Date


id: MongoDB\BSON\UTCDateTime::jsonSerialize
type: function
doc:
<comment>Description:</comment>
  Возвращает представление, которое можно преобразовать в JSON

<comment>Return:</comment>
  <info>mixed</info>  Возвращает данные, которые могут быть сериализованы с помощью <strong>json_encode()</strong> для создания
         расширенного JSON-представления <class>MongoDB\BSON\UTCDateTime</class>.
         
         Вывод соответствует выводу функции <strong>MongoDB\BSON\toJSON()</strong>, которая использует
         унаследованный, специфичный для драйвера, расширенный формат JSON. Он не обязательно будет
         подходить под relaxed или canonical представления расширенного JSON, используемых в
         <strong>MongoDB\BSON\toRelaxedExtendedJSON()</strong> и <strong>MongoDB\BSON\toCanonicalExtendedJSON()</strong>,
         соответственно.

<comment>See Also:</comment>
   * JsonSerializable::jsonSerialize
   * <strong>json_encode()</strong>
   * <strong>MongoDB\BSON\toCanonicalExtendedJSON()</strong>
   * <strong>MongoDB\BSON\toRelaxedExtendedJSON()</strong>
   * MongoDB Extended JSON


id: MongoDB\BSON\UTCDateTime::serialize
type: function
doc:
<comment>Description:</comment>
  Сериализует UTCDateTime

<comment>Return:</comment>
  <info>string</info>  Возвращает сериализованное представление <class>MongoDB\BSON\UTCDateTime</class>.

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


id: MongoDB\BSON\UTCDateTime::toDateTime
type: function
doc:
<comment>Description:</comment>
  Возвращает представление DateTime этого UTCDateTime

<comment>Return:</comment>
  <info>DateTime</info>  Возвращает представление <class>DateTime</class> этого UTCDateTime. Возвращённый <class>DateTime</class> будет
            использовать часовой пояс UTC.

<comment>See Also:</comment>
   * Типы BSON: Date


id: MongoDB\BSON\UTCDateTime::unserialize
type: function
doc:
<comment>Description:</comment>
  Десериализует UTCDateTime

<comment>Param:</comment>
  <info>string</info>  <strong>$data</strong>  Сериализованный <class>MongoDB\BSON\UTCDateTime</class>.

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

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


id: MongoDB\BSON\UTCDateTimeInterface
type: class
doc:
<comment>Description:</comment>
  Этот интерфейс реализован с помощью <class>MongoDB\BSON\UTCDateTime</class>, но также может использоваться в
  качестве параметра, возвращаемого значения или типа свойства в классах пользовательского
  пространства.


id: MongoDB\BSON\UTCDateTimeInterface::__toString
type: function
doc:
<comment>Description:</comment>
  Возвращает строковое представление UTCDateTimeInterface

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

<comment>See Also:</comment>
   * MongoDB\BSON\UTCDateTime::__toString


id: MongoDB\BSON\UTCDateTimeInterface::toDateTime
type: function
doc:
<comment>Description:</comment>
  Возвращает представление DateTime этого UTCDateTimeInterface

<comment>Return:</comment>
  <info>DateTime</info>  Возвращает представление <class>DateTime</class> этого UTCDateTimeInterface. Возвращённый <class>DateTime</class>
            должен использовать часовой пояс UTC.

<comment>See Also:</comment>
   * MongoDB\BSON\UTCDateTime::toDateTime


id: MongoDB\BSON\Undefined
type: class
doc:
<comment>Description:</comment>
  Тип BSON для типа "Undefined". Этот тип BSON устарел, и этот класс не может быть создан. Он будет
  создан из неопределённого типа BSON при преобразовании BSON в PHP, а также может быть преобразован
  обратно в BSON при хранении документов в базе данных.


id: MongoDB\BSON\Undefined::__construct
type: function
doc:
<comment>Description:</comment>
  Создаёт новый Undefined (не используется)
  
  Объекты <class>MongoDB\BSON\Undefined</class> создаются путём преобразования из устаревшего типа BSON и не могут
  быть созданы напрямую.

<comment>See Also:</comment>
   * Типы BSON


id: MongoDB\BSON\Undefined::__toString
type: function
doc:
<comment>Description:</comment>
  Возвращает пустую строку

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

<comment>See Also:</comment>
   * Типы BSON


id: MongoDB\BSON\Undefined::jsonSerialize
type: function
doc:
<comment>Description:</comment>
  Возвращает представление, которое можно преобразовать в JSON

<comment>Return:</comment>
  <info>mixed</info>  Возвращает данные, которые могут быть сериализованы с помощью <strong>json_encode()</strong> для создания
         расширенного JSON-представления <class>MongoDB\BSON\Undefined</class>.
         
         Вывод соответствует выводу функции <strong>MongoDB\BSON\toJSON()</strong>, которая использует
         унаследованный, специфичный для драйвера, расширенный формат JSON. Он не обязательно будет
         подходить под relaxed или canonical представления расширенного JSON, используемых в
         <strong>MongoDB\BSON\toRelaxedExtendedJSON()</strong> и <strong>MongoDB\BSON\toCanonicalExtendedJSON()</strong>,
         соответственно.

<comment>See Also:</comment>
   * JsonSerializable::jsonSerialize
   * <strong>json_encode()</strong>
   * <strong>MongoDB\BSON\toCanonicalExtendedJSON()</strong>
   * <strong>MongoDB\BSON\toRelaxedExtendedJSON()</strong>
   * MongoDB Extended JSON


id: MongoDB\BSON\Undefined::serialize
type: function
doc:
<comment>Description:</comment>
  Сериализует Undefined

<comment>Return:</comment>
  <info>string</info>  Возвращает сериализованное представление <class>MongoDB\BSON\Undefined</class>.

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


id: MongoDB\BSON\Undefined::unserialize
type: function
doc:
<comment>Description:</comment>
  Десериализует Undefined

<comment>Param:</comment>
  <info>string</info>  <strong>$data</strong>  Сериализованный <class>MongoDB\BSON\Undefined</class>.

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

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


id: MongoDB\BSON\Unserializable
type: class
doc:
<comment>Description:</comment>
  Классы, которые реализуют этот интерфейс, могут быть указаны в карте типов для десериализации
  массивов и документов BSON (как корневых, так и встроенных).


id: MongoDB\BSON\Unserializable::bsonUnserialize
type: function
doc:
<comment>Description:</comment>
  Создаёт объект из массива BSON или документа
  
  Вызывается во время десериализации объекта из BSON. Свойства массива BSON или документа будут
  переданы в метод в виде массива (<info>array</info>).
  
  Не забудьте проверить свойство _id при обработке данных из документа BSON.
  
  Данный метод служит в качестве конструктора объекта Метод __construct() не будет вызываться после
  этого метода.

<comment>Param:</comment>
  <info>array</info>  <strong>$data</strong>  Свойства в массиве BSON или в документе.

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

<comment>See Also:</comment>
   * <strong>MongoDB\BSON\Serializable::bsonSerialize()</strong>
   * MongoDB\BSON\Persistable
   * 


id: MongoDB\BSON\fromJSON
type: function
doc:
<comment>Description:</comment>
  Возвращает представление BSON значения JSON
  
  Преобразует строку Extended JSON в её представление BSON.

<comment>Param:</comment>
  <info>string</info>  <strong>$json</strong>  Значение JSON для преобразования.

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

<comment>See Also:</comment>
   * MongoDB\BSON\Document::fromJSON
   * <strong>MongoDB\BSON\toJSON()</strong>
   * MongoDB Extended JSON
   * MongoDB BSON


id: MongoDB\BSON\fromPHP
type: function
doc:
<comment>Description:</comment>
  Возвращает представление BSON значения PHP
  
  Сериализует массив или объект PHP (например, документ) в его представление BSON. Возвращённая
  двоичная строка будет описывать документ BSON.

<comment>Param:</comment>
  <info>array|object</info>  <strong>$value</strong>  Значение PHP для сериализации.

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

<comment>See Also:</comment>
   * MongoDB\BSON\Document::fromPHP
   * <strong>MongoDB\BSON\toPHP()</strong>
   * MongoDB BSON
   * 


id: MongoDB\BSON\toCanonicalExtendedJSON
type: function
doc:
<comment>Description:</comment>
  Возвращает Canonical Extended JSON представление для значения BSON
  
  Преобразует строку BSON в её Canonical Extended JSON представление. Канонический формат
  предпочитает точность типов за счёт краткого вывода и наиболее подходит для создания выходных
  данных, которые могут быть преобразованы обратно в BSON без какой-либо потери информации о типе
  (например, числовые типы останутся дифференцированными).

<comment>Param:</comment>
  <info>string</info>  <strong>$bson</strong>  Значение BSON для преобразования.

<comment>Return:</comment>
  <info>string</info>  Преобразованное значение JSON.

<comment>See Also:</comment>
   * MongoDB\BSON\Document::fromJSON
   * MongoDB\BSON\Document::toCanonicalExtendedJSON
   * <strong>MongoDB\BSON\fromJSON()</strong>
   * <strong>MongoDB\BSON\toRelaxedExtendedJSON()</strong>
   * Спецификация Extended JSON
   * MongoDB BSON


id: MongoDB\BSON\toJSON
type: function
doc:
<comment>Description:</comment>
  Возвращает Legacy Extended JSON представление значения BSON
  
  Преобразует строку BSON в её Legacy Extended JSON представление.
  
  Существует несколько форматов JSON для представления BSON. Эта функция реализует "строгий режим",
  определённый в MongoDB Extended JSON, который был заменён каноническими и упрощёнными форматами,
  определёнными в Спецификации Extended JSON и реализованными <strong>MongoDB\BSON\toCanonicalExtendedJSON()</strong>
  и <strong>MongoDB\BSON\toRelaxedExtendedJSON()</strong> соответственно.
  
  JSON не поддерживает <info>NAN</info> и <info>INF</info>, а формат Legacy Extended JSON MongoDB не определяет альтернативное
  представление для этих значений (libbson будет выводить литералы <return>nan</return> и <return>inf</return>, которые могут не
  распознаться, как корректный JSON). Если вы работаете с BSON, который может содержать неконечные
  числа, используйте <strong>MongoDB\BSON\toCanonicalExtendedJSON()</strong> или
  <strong>MongoDB\BSON\toRelaxedExtendedJSON()</strong>.

<comment>Param:</comment>
  <info>string</info>  <strong>$bson</strong>  Значение BSON для преобразования.

<comment>Return:</comment>
  <info>string</info>  Преобразованное значение JSON.

<comment>See Also:</comment>
   * <strong>MongoDB\BSON\fromJSON()</strong>
   * <strong>MongoDB\BSON\toCanonicalExtendedJSON()</strong>
   * <strong>MongoDB\BSON\toRelaxedExtendedJSON()</strong>
   * MongoDB Extended JSON
   * MongoDB BSON


id: MongoDB\BSON\toPHP
type: function
doc:
<comment>Description:</comment>
  Возвращает PHP представление значения BSON
  
  Десериализует документ BSON (т.е. двоичную строку) в его представление PHP. Параметр <strong>$typeMap</strong>
  может использоваться для управления типами PHP, используемыми для преобразования массивов и
  документов BSON (как корневых, так и встроенных).
  
  Документы BSON технически могут содержать повторяющиеся ключи, поскольку документы хранятся в виде
  списка пар ключ-значение; однако приложениям следует воздерживаться от создания документов с
  дубликатами ключей, поскольку поведение сервера и драйвера может быть неопределённым. Поскольку
  объекты и массивы PHP не могут иметь повторяющихся ключей, данные также могут быть потеряны при
  декодировании документа BSON с повторяющимися ключами.

<comment>Param:</comment>
  <info>string</info>  <strong>$bson</strong>     Значение BSON для десериализации.
  <info>array</info>   <strong>$typeMap</strong>  Конфигурация карты типов.

<comment>Return:</comment>
  <info>array|object</info>  Десериализованное значение PHP.

<comment>See Also:</comment>
   * MongoDB\BSON\Document::toPHP
   * <strong>MongoDB\BSON\fromPHP()</strong>
   * MongoDB BSON
   * 


id: MongoDB\BSON\toRelaxedExtendedJSON
type: function
doc:
<comment>Description:</comment>
  Возвращает Relaxed Extended JSON представление значения BSON
  
  Преобразует строку BSON в её представление Relaxed Extended JSON. Расслабленный формат
  предпочитает использование примитивов типа JSON за счёт точности типов и наиболее подходит для
  получения выходных данных, которые могут быть легко использованы веб API и людьми.

<comment>Param:</comment>
  <info>string</info>  <strong>$bson</strong>  Значение BSON для преобразования.

<comment>Return:</comment>
  <info>string</info>  Преобразованное значение JSON.

<comment>See Also:</comment>
   * MongoDB\BSON\Document::fromJSON
   * MongoDB\BSON\Document::toRelaxedExtendedJSON
   * <strong>MongoDB\BSON\fromJSON()</strong>
   * <strong>MongoDB\BSON\toCanonicalExtendedJSON()</strong>
   * Extended JSON
   * MongoDB BSON


id: MongoDB\Driver\BulkWrite
type: class
doc:
<comment>Description:</comment>
  Класс <class>MongoDB\Driver\BulkWrite</class> собирает одну или несколько операций записи, которые должны быть
  отправлены на сервер. После добавления любого количества операций вставки, обновления или
  удаления, коллекция может быть выполнена с помощью MongoDB\Driver\Manager::executeBulkWrite.
  
  Операции записи могут быть отсортированы (по умолчанию) или не отсортированы. Отсортированные
  операции записи отправляются на сервер в указанном порядке для последовательного выполнения. В
  случае возникновения ошибки записи, любые оставшиеся операции будут прерваны. Неотсортированные
  операции отправляются на сервер в произвольном порядке, где они могут выполняться параллельно.
  Сообщения об ошибках, которые возникают, будут отправлены после выполнения всех операций.


id: MongoDB\Driver\BulkWrite::__construct
type: function
doc:
<comment>Description:</comment>
  Создаёт новый объект BulkWrite
  
  Создаёт новый <class>MongoDB\Driver\BulkWrite</class>, который является изменяемым объектом, к которому могут
  быть добавлены одна и несколько операций записи. Операции записи могут быть выполнены с помощью
  MongoDB\Driver\Manager::executeBulkWrite.

<comment>Param:</comment>
  <info>array|null</info>  <strong>$options</strong>  optionsОпцияТипОписаниеЗначение по умолчаниюbypassDocumentValidation<info>bool</info>
                        Если <info>true</info>, позволяет выполнять операции вставки или обновления, чтобы обойти
                        проверку уровня документа.  Этот параметр доступен в MongoDB 3.2+ и
                        игнорируется в более старых версиях сервера, которые не поддерживают
                        проверку уровня сервера. <info>false</info>comment<info>mixed</info> Произвольный комментарий,
                        помогающий отследить операцию с помощью профилировщика базы данных, вывода
                        CurrentOp и журналов.  Опция доступна в MongoDB 4.4+ и приведёт к исключению
                        во время выполнения, если указана для более старой версии сервера.
                        let<info>array</info><info>object</info></info> Карта имён и значений параметров. Значения должны быть
                        константами или закрытыми выражениями, которые не ссылаются на поля
                        документа. К параметрам можно обращаться как к переменным в контексте
                        агрегированного выражения (например, <return>$$var</return>).  Опция доступна в MongoDB 5.0+
                        и приведёт к исключению во время выполнения, если указана для более старой
                        версии сервера. ordered<info>bool</info> Отсортированные операции (<info>true</info>) выполняется
                        последовательно на сервере MongoDB, тогда как неотсортированные операции
                        (<info>false</info>) отправляются на сервере в произвольном порядке и могут выполняться
                        параллельно. <info>true</info>
                        
                        Если <info>true</info>, позволяет выполнять операции вставки или обновления, чтобы обойти
                        проверку уровня документа.
                        
                        Этот параметр доступен в MongoDB 3.2+ и игнорируется в более старых версиях
                        сервера, которые не поддерживают проверку уровня сервера.
                        
                        Произвольный комментарий, помогающий отследить операцию с помощью
                        профилировщика базы данных, вывода CurrentOp и журналов.
                        
                        Опция доступна в MongoDB 4.4+ и приведёт к исключению во время выполнения,
                        если указана для более старой версии сервера.
                        
                        Карта имён и значений параметров. Значения должны быть константами или
                        закрытыми выражениями, которые не ссылаются на поля документа. К параметрам
                        можно обращаться как к переменным в контексте агрегированного выражения
                        (например, <return>$$var</return>).
                        
                        Опция доступна в MongoDB 5.0+ и приведёт к исключению во время выполнения,
                        если указана для более старой версии сервера.

<comment>See Also:</comment>
   * MongoDB\Driver\Manager::executeBulkWrite
   * <class>MongoDB\Driver\WriteResult</class>


id: MongoDB\Driver\BulkWrite::count
type: function
doc:
<comment>Description:</comment>
  Подсчитывает количество операций записи в порции
  
  Возвращает количество операций записи, добавленных в объект <class>MongoDB\Driver\BulkWrite</class>.

<comment>Return:</comment>
  <info>int</info>  Возвращает количество операций записи, добавленных в объект <class>MongoDB\Driver\BulkWrite</class>.


id: MongoDB\Driver\BulkWrite::delete
type: function
doc:
<comment>Description:</comment>
  Добавление операции удаления в порцию
  
  Добавляет операцию удаления в объект <class>MongoDB\Driver\BulkWrite</class>.

<comment>Param:</comment>
  <info>array|object</info>  <strong>$filter</strong>         Предикат запроса. Пустой предикат совпадёт со всеми элементами
                                коллекции.
                                
                                При вычислении критериев запроса, MongoDB сравнивает типы и значения
                                в соответствии с собственными правилами сравнения типов BSON,
                                отличных от правил сравнения и приведения типов PHP. Когда
                                используется специальный тип BSON,  критерия запроса должна
                                соответствовать классу BSON (т.е. использовать <class>MongoDB\BSON\ObjectId</class>
                                для выборке по ObjectId).
  <info>array|null</info>    <strong>$deleteOptions</strong>  deleteOptionsОпцияТипОписаниеЗначение по
                                умолчаниюcollation<info>array</info><info>object</info></info>Сопоставление позволяет пользователям
                                указывать специфичные для конкретного языка правила для сравнения
                                строк, такие как реакцию на регистр букв и надстрочные знаки. Если
                                задано сопоставление, то поле <return>"locale"</return> также обязательно. Описание
                                полей смотрите в разделе Сопоставление.  Если сопоставление не
                                задано явно, но у коллекции определено сопоставление по умолчанию,
                                то будет использовано оно. Если нет ни того ни того, то MongoDB
                                будет использовать простое бинарное сравнение строк.  Эта опция
                                доступна в MongoDB 3.4+ и, если будет использована для более старых
                                версий, вызовет исключение во время исполнения.
                                hint<info>string</info><info>array</info><info>object</info></info> Индекс спецификации. Укажите либо имя индекса
                                в виде строки, либо шаблон ключа индекса. Если указано, то система
                                запросов будет рассматривать планы только с использованием индекса
                                подсказок.  Опция доступна с MongoDB 4.4+ и приведёт к исключению во
                                время выполнения, если она указан для более старой версии сервера.
                                limit<info>bool</info>Удалить все подходящие документа (<info>false</info>) или только первый
                                найденный документ (<info>true</info>)<info>false</info>
                                
                                Сопоставление позволяет пользователям указывать специфичные для
                                конкретного языка правила для сравнения строк, такие как реакцию на
                                регистр букв и надстрочные знаки. Если задано сопоставление, то поле
                                <return>"locale"</return> также обязательно. Описание полей смотрите в разделе
                                Сопоставление.
                                
                                Если сопоставление не задано явно, но у коллекции определено
                                сопоставление по умолчанию, то будет использовано оно. Если нет ни
                                того ни того, то MongoDB будет использовать простое бинарное
                                сравнение строк.
                                
                                Эта опция доступна в MongoDB 3.4+ и, если будет использована для
                                более старых версий, вызовет исключение во время исполнения.
                                
                                Индекс спецификации. Укажите либо имя индекса в виде строки, либо
                                шаблон ключа индекса. Если указано, то система запросов будет
                                рассматривать планы только с использованием индекса подсказок.
                                
                                Опция доступна с MongoDB 4.4+ и приведёт к исключению во время
                                выполнения, если она указан для более старой версии сервера.

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

<comment>See Also:</comment>
   * MongoDB\Driver\Manager::executeBulkWrite
   * <class>MongoDB\Driver\WriteResult</class>


id: MongoDB\Driver\BulkWrite::insert
type: function
doc:
<comment>Description:</comment>
  Добавить операцию вставки в порцию
  
  Добавляем операцию вставки в <class>MongoDB\Driver\BulkWrite</class>.

<comment>Param:</comment>
  <info>array|object</info>  <strong>$document</strong>  Документ для вставки.

<comment>Return:</comment>
  <info>mixed</info>  Возвращает <return>_id</return> добавленного документа. Если в <strong>$document</strong> не был задан <return>_id</return>, будет возвращён
         <class>MongoDB\BSON\ObjectId</class>, сгенерированный для вставки.

<comment>See Also:</comment>
   * MongoDB\Driver\Manager::executeBulkWrite
   * <class>MongoDB\Driver\WriteResult</class>
   * <class>MongoDB\BSON\ObjectId</class>
   * MongoDB\BSON\Persistable


id: MongoDB\Driver\BulkWrite::update
type: function
doc:
<comment>Description:</comment>
  Добавить операцию обновления в порцию
  
  Добавляет операцию обновления в <class>MongoDB\Driver\BulkWrite</class>.

<comment>Param:</comment>
  <info>array|object</info>  <strong>$filter</strong>         Предикат запроса. Пустой предикат совпадёт со всеми элементами
                                коллекции.
                                
                                При вычислении критериев запроса, MongoDB сравнивает типы и значения
                                в соответствии с собственными правилами сравнения типов BSON,
                                отличных от правил сравнения и приведения типов PHP. Когда
                                используется специальный тип BSON,  критерия запроса должна
                                соответствовать классу BSON (т.е. использовать <class>MongoDB\BSON\ObjectId</class>
                                для выборке по ObjectId).
  <info>array|object</info>  <strong>$newObj</strong>         Документ, содержащий операторы обновления (например, <return>$set</return>),
                                заменяющий документ (например, только выражения <return>field:value</return>) или
                                конвейер агрегации.
  <info>array|null</info>    <strong>$updateOptions</strong>  updateOptionsОпцияТипОписаниеЗначение по умолчаниюarrayFilters<info>array</info>
                                Массив документов фильтров, который определяет, какие элементы
                                массива будут изменены для операции обновления в поле массива.
                                Смотрите Указывайте arrayFilters для операций обновления массива в
                                руководстве MongoDB для получения дополнительной информации.  Опция
                                доступна с MongoDB 3.6+ и приведёт к исключению во время выполнения,
                                если она указан для более старой версии сервера.
                                collation<info>array</info><info>object</info></info>Сопоставление позволяет пользователям указывать
                                специфичные для конкретного языка правила для сравнения строк, такие
                                как реакцию на регистр букв и надстрочные знаки. Если задано
                                сопоставление, то поле <return>"locale"</return> также обязательно. Описание полей
                                смотрите в разделе Сопоставление.  Если сопоставление не задано
                                явно, но у коллекции определено сопоставление по умолчанию, то будет
                                использовано оно. Если нет ни того ни того, то MongoDB будет
                                использовать простое бинарное сравнение строк.  Эта опция доступна в
                                MongoDB 3.4+ и, если будет использована для более старых версий,
                                вызовет исключение во время исполнения. hint<info>string</info><info>array</info><info>object</info></info> Индекс
                                спецификации. Укажите либо имя индекса в виде строки, либо шаблон
                                ключа индекса. Если указано, то система запросов будет рассматривать
                                планы только с использованием индекса подсказок.  Опция доступна с
                                MongoDB 4.4+ и приведёт к исключению во время выполнения, если она
                                указан для более старой версии сервера. multi<info>bool</info> Обновить только
                                первый найденный документ, если <info>false</info> или все подходящие документы
                                при <info>true</info>. Эта опция не может быть <info>true</info>, когда <strong>$newObj</strong> - заменяющий
                                документ. <info>false</info>upsert<info>bool</info> Если <strong>$filter</strong> не соответствует
                                существующему документу, будет вставлен новый документ. Документ
                                будет создан из <strong>$newObj</strong>, если он заменяющий документ (т.е.
                                отсутствуют операторы обновления); в противном случае операторы в
                                <strong>$newObj</strong> будут применяться к <strong>$filter</strong> для создания нового документа.
                                <info>false</info>
                                
                                Массив документов фильтров, который определяет, какие элементы
                                массива будут изменены для операции обновления в поле массива.
                                Смотрите Указывайте arrayFilters для операций обновления массива в
                                руководстве MongoDB для получения дополнительной информации.
                                
                                Опция доступна с MongoDB 3.6+ и приведёт к исключению во время
                                выполнения, если она указан для более старой версии сервера.
                                
                                Сопоставление позволяет пользователям указывать специфичные для
                                конкретного языка правила для сравнения строк, такие как реакцию на
                                регистр букв и надстрочные знаки. Если задано сопоставление, то поле
                                <return>"locale"</return> также обязательно. Описание полей смотрите в разделе
                                Сопоставление.
                                
                                Если сопоставление не задано явно, но у коллекции определено
                                сопоставление по умолчанию, то будет использовано оно. Если нет ни
                                того ни того, то MongoDB будет использовать простое бинарное
                                сравнение строк.
                                
                                Эта опция доступна в MongoDB 3.4+ и, если будет использована для
                                более старых версий, вызовет исключение во время исполнения.
                                
                                Индекс спецификации. Укажите либо имя индекса в виде строки, либо
                                шаблон ключа индекса. Если указано, то система запросов будет
                                рассматривать планы только с использованием индекса подсказок.
                                
                                Опция доступна с MongoDB 4.4+ и приведёт к исключению во время
                                выполнения, если она указан для более старой версии сервера.

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

<comment>See Also:</comment>
   * MongoDB\Driver\Manager::executeBulkWrite
   * <class>MongoDB\Driver\WriteResult</class>


id: MongoDB\Driver\ClientEncryption
type: class
doc:
<comment>Description:</comment>
  Класс <class>MongoDB\Driver\ClientEncryption</class> обрабатывает как создание ключей шифрования на стороне
  клиента, так и ручное шифрование/дешифрование.


id: MongoDB\Driver\ClientEncryption::AEAD_AES_256_CBC_HMAC_SHA_512_DETERMINISTIC
type: constant
doc:
<comment>Description:</comment>
  Определяет алгоритм для детерминированного шифрования, который подходит для запросов.


id: MongoDB\Driver\ClientEncryption::ALGORITHM_INDEXED
type: constant
doc:
<comment>Description:</comment>
  Определяет алгоритм для индексированной, зашифрованной полезной нагрузки, которая может быть
  использована с шифрованием с возможностью запроса.
  
  Для добавления или запроса с индексированной, зашифрованной полезной нагрузкой
  <class>MongoDB\Driver\Manager</class> должен быть настроен с опцией драйвера <return>"autoEncryption"</return>. Опция
  <return>"bypassQueryAnalysis"</return> автоматического шифрования может быть установлена как <info>true</info>. Параметр
  <return>"bypassAutoEncryption"</return> автоматического шифрования должен быть <info>false</info>.


id: MongoDB\Driver\ClientEncryption::ALGORITHM_RANGE_PREVIEW
type: constant
doc:
<comment>Description:</comment>
  Определяет алгоритм для диапазона, зашифрованной полезной нагрузки, которая может быть
  использована с шифрованием с возможностью запроса.
  
  Для выполнения запроса с зашифрованной полезной нагрузкой диапазона <class>MongoDB\Driver\Manager</class> должен
  быть настроен с опцией драйвера <return>"autoEncryption"</return>. Опция <return>"bypassQueryAnalysis"</return> автоматического
  шифрования может быть <info>true</info>. Параметр <return>"bypassAutoEncryption"</return> автоматического шифрования должен быть
  <info>false</info>.
  
  Алгоритм диапазона является экспериментальным. Он не предназначен для публичного использования.
  
  Драйвер PHP пока не поддерживает запросы диапазона для типов полей decimal128 BSON.


id: MongoDB\Driver\ClientEncryption::ALGORITHM_UNINDEXED
type: constant
doc:
<comment>Description:</comment>
  Указывает алгоритм для неиндексированной, зашифрованной полезной нагрузки.


id: MongoDB\Driver\ClientEncryption::QUERY_TYPE_EQUALITY
type: constant
doc:
<comment>Description:</comment>
  Определяет тип запроса равенства, который используется в сочетании с
  <info>MongoDB\Driver\ClientEncryption::ALGORITHM_INDEXED</info>.


id: MongoDB\Driver\ClientEncryption::QUERY_TYPE_RANGE_PREVIEW
type: constant
doc:
<comment>Description:</comment>
  Задаёт тип запроса диапазона, который используется в сочетании с
  <info>MongoDB\Driver\ClientEncryption::ALGORITHM_RANGE_PREVIEW</info>.


id: MongoDB\Driver\ClientEncryption::__construct
type: function
doc:
<comment>Description:</comment>
  Создаёт новый объект ClientEncryption
  
  Создаёт новый объект <class>MongoDB\Driver\ClientEncryption</class> с указанными опциями.

<comment>Param:</comment>
  <info>array</info>  <strong>$options</strong>  ОпцииОпцияТипОписаниеkeyVaultClient<class>MongoDB\Driver\Manager</class> Менеджер, используемый
                   для маршрутизации запросов ключей данных. Опция является обязательной (в отличие
                   от функции <strong>MongoDB\Driver\Manager::createClientEncryption()</strong>).
                   keyVaultNamespace<info>string</info>Полное пространство имён (например,
                   <return>"databaseName.collectionName"</return>), обозначающее коллекцию, которая содержит все
                   ключи данных, используемые для шифрования и дешифрования. Обязательный
                   параметр.kmsProviders<info>array</info> Документ, содержащий конфигурацию для одного или
                   нескольких провайдеров KMS, которые используются для шифрования ключей данных.
                   Поддерживаются провайдеры <return>"aws"</return>, <return>"azure"</return>, <return>"gcp"</return> и <return>"local"</return>, и, по крайней мере,
                   один из них должен быть указан.  Если для <return>"aws"</return>, <return>"azure"</return> или <return>"gcp"</return> указан пустой
                   документ, драйвер попытается сконфигурировать провайдера, используя
                   Автоматические учётные данные.  Формат для <return>"aws"</return> выглядит следующим образом: ,
                   secretAccessKey: , sessionToken:
                   }
                   ]]> Формат для <return>"azure"</return> выглядит следующим образом: , clientId: , clientSecret: ,
                   identityPlatformEndpoint:  // По умолчанию "login.microsoftonline.com"
                   
                   }
                   ]]> Формат для <return>"gcp"</return> выглядит следующим образом: , privateKey: |, endpoint:  //
                   По умолчанию "oauth2.googleapis.com"
                   
                   }
                   ]]> Формат для <return>"kmip"</return> выглядит следующим образом: 
                   }
                   ]]> Формат для <return>"local"</return> выглядит следующим образом: |
                   }
                   ]]>tlsOptions<info>array</info> Документ, содержащий конфигурацию TLS для одного или
                   нескольких KMS провайдеров. Поддерживаются провайдеры <return>"aws"</return>, <return>"azure"</return>, <return>"gcp"</return> и
                   <return>"kmip"</return>. Все провайдеры поддерживают следующие опции: : { tlsCaFile: ,
                   tlsCertificateKeyFile: , tlsCertificateKeyFilePassword: ,
                   tlsDisableOCSPEndpointCheck:
                   }
                   ]]>
                   
                   Документ, содержащий конфигурацию для одного или нескольких провайдеров KMS,
                   которые используются для шифрования ключей данных. Поддерживаются провайдеры
                   <return>"aws"</return>, <return>"azure"</return>, <return>"gcp"</return> и <return>"local"</return>, и, по крайней мере, один из них должен быть
                   указан.
                   
                   Если для <return>"aws"</return>, <return>"azure"</return> или <return>"gcp"</return> указан пустой документ, драйвер попытается
                   сконфигурировать провайдера, используя Автоматические учётные данные.
                   
                   Формат для <return>"aws"</return> выглядит следующим образом:
                   
                   Формат для <return>"azure"</return> выглядит следующим образом:
                   
                   Формат для <return>"gcp"</return> выглядит следующим образом:
                   
                   Формат для <return>"kmip"</return> выглядит следующим образом:
                   
                   Формат для <return>"local"</return> выглядит следующим образом:
                   
                   Документ, содержащий конфигурацию TLS для одного или нескольких KMS провайдеров.
                   Поддерживаются провайдеры <return>"aws"</return>, <return>"azure"</return>, <return>"gcp"</return> и <return>"kmip"</return>. Все провайдеры
                   поддерживают следующие опции:

<comment>See Also:</comment>
   * <strong>MongoDB\Driver\Manager::createClientEncryption()</strong>
   * Явное (ручное) шифрование уровня полей на стороне клиента в руководстве по MongoDB


id: MongoDB\Driver\ClientEncryption::addKeyAltName
type: function
doc:
<comment>Description:</comment>
  Добавляет альтернативное имя к документу с ключом
  
  Добавляет параметр <strong>$keyAltName</strong> в набор альтернативных имён для документа с ключом с заданным UUID
  <strong>$keyId</strong>.

<comment>Param:</comment>
  <info>MongoDB\BSON\Binary</info>  <strong>$keyId</strong>       Экземпляр <class>MongoDB\BSON\Binary</class> с подтипом 4 (UUID),
                                    идентифицирующий документ с ключом.
  <info>string</info>               <strong>$keyAltName</strong>  Альтернативное имя для добавления в документ с ключом.

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

<comment>See Also:</comment>
   * <strong>MongoDB\Driver\ClientEncryption::getKeyByAltName()</strong>
   * <strong>MongoDB\Driver\ClientEncryption::removeKeyAltName()</strong>


id: MongoDB\Driver\ClientEncryption::createDataKey
type: function
doc:
<comment>Description:</comment>
  Создаёт документ с ключом
  
  Создаёт новый документ с ключом шифрования и кладёт его в коллекцию хранилища ключей.

<comment>Param:</comment>
  <info>string</info>      <strong>$kmsProvider</strong>  Провайдер KMS (<return>"local"</return>, <return>"aws"</return>), который будет использоваться для
                            шифрования нового ключа данных.
  <info>array|null</info>  <strong>$options</strong>      ОпцииОпцияТипОписаниеmasterKey<info>array</info> Документ masterKey определяет
                            специфический для KMS ключ, используемый для шифрования нового ключа
                            данных. Параметр обязателен, если параметр <strong>$kmsProvider</strong> не является
                            <return>"local"</return>. Параметры провайдера
                            <return>"aws"</return>ПараметрТипОписаниеregionСтрокаОбязательный.keyСтрокаОбязательный.
                            Имя ресурса Amazon (ARN) для главного ключа клиента AWS
                            (CMK).endpointСтрокаНеобязательный. Альтернативный идентификатор хоста
                            для отправки запросов KMS. Может содержать номер порта.Параметры
                            провайдера <return>"azure"</return>ПараметрТипОписаниеkeyVaultEndpointСтрокаОбязательный.
                            Хост с необязательным портом (например,
                            "example.vault.azure.net").keyNameСтрокаОбязательный.keyVersionСтрокаНеобязательный.
                            Определённая версия именованного ключа. По умолчанию используется
                            первичная версия ключа.Параметры провайдера
                            <return>"gcp"</return>ПараметрТипОписаниеprojectIdСтрокаОбязательный.locationСтрокаОбязательный.keyRingСтрокаОбязательный.keyNameСтрокаОбязательный.keyVersionСтрокаНеобязательный.
                            Определённая версия именованного ключа. По умолчанию используется
                            первичная версия ключа.endpointСтрокаНеобязательный. Хост с
                            дополнительным портом. По умолчанию "cloudkms.googleapis.com"..Параметры
                            провайдера <return>"kmip"</return>ПараметрТипОписаниеkeyIdСтрокаНеобязательный.
                            Уникальный идентификатор 96-байтового управляемого объекта секретных
                            данных KMIP. Если не указан, драйвер создаёт случайный 96-байтовый
                            управляемый объект секретных данных KMIP.endpointСтрокаНеобязательный.
                            Хост с дополнительным портом.keyAltNames<info>array</info> Опциональный список
                            альтернативных имён использующихся для ссылки на ключ. Если ключ создан
                            с использованием альтернативных имён, то при шифровании можно ссылаться
                            на уникальное альтернативное имя вместо <return>_id</return>.
                            keyMaterial<class>MongoDB\BSON\Binary</class> Необязательное 96-байтовое значение для
                            использования в качестве материала пользовательского ключа для
                            создаваемого ключа данных. Если задан keyMaterial, то используется
                            пользовательский материал ключа для шифрования и расшифровки данных. В
                            противном случае материал ключа для нового ключа данных генерируется из
                            криптографически защищённого случайного устройства.
                            
                            Документ masterKey определяет специфический для KMS ключ, используемый
                            для шифрования нового ключа данных. Параметр обязателен, если параметр
                            <strong>$kmsProvider</strong> не является <return>"local"</return>.
                            
                            Параметры провайдера
                            <return>"aws"</return>ПараметрТипОписаниеregionСтрокаОбязательный.keyСтрокаОбязательный.
                            Имя ресурса Amazon (ARN) для главного ключа клиента AWS
                            (CMK).endpointСтрокаНеобязательный. Альтернативный идентификатор хоста
                            для отправки запросов KMS. Может содержать номер порта.
                            
                            Параметры провайдера
                            <return>"azure"</return>ПараметрТипОписаниеkeyVaultEndpointСтрокаОбязательный. Хост с
                            необязательным портом (например,
                            "example.vault.azure.net").keyNameСтрокаОбязательный.keyVersionСтрокаНеобязательный.
                            Определённая версия именованного ключа. По умолчанию используется
                            первичная версия ключа.
                            
                            Параметры провайдера
                            <return>"gcp"</return>ПараметрТипОписаниеprojectIdСтрокаОбязательный.locationСтрокаОбязательный.keyRingСтрокаОбязательный.keyNameСтрокаОбязательный.keyVersionСтрокаНеобязательный.
                            Определённая версия именованного ключа. По умолчанию используется
                            первичная версия ключа.endpointСтрокаНеобязательный. Хост с
                            дополнительным портом. По умолчанию "cloudkms.googleapis.com"..
                            
                            Параметры провайдера <return>"kmip"</return>ПараметрТипОписаниеkeyIdСтрокаНеобязательный.
                            Уникальный идентификатор 96-байтового управляемого объекта секретных
                            данных KMIP. Если не указан, драйвер создаёт случайный 96-байтовый
                            управляемый объект секретных данных KMIP.endpointСтрокаНеобязательный.
                            Хост с дополнительным портом.
                            
                            Опциональный список альтернативных имён использующихся для ссылки на
                            ключ. Если ключ создан с использованием альтернативных имён, то при
                            шифровании можно ссылаться на уникальное альтернативное имя вместо <return>_id</return>.
                            
                            Необязательное 96-байтовое значение для использования в качестве
                            материала пользовательского ключа для создаваемого ключа данных. Если
                            задан keyMaterial, то используется пользовательский материал ключа для
                            шифрования и расшифровки данных. В противном случае материал ключа для
                            нового ключа данных генерируется из криптографически защищённого
                            случайного устройства.

<comment>Return:</comment>
  <info>MongoDB\BSON\Binary</info>  Возвращает идентификатор нового ключа в виде объекта <class>MongoDB\BSON\Binary</class> с
                       подтипом 4 (UUID).


id: MongoDB\Driver\ClientEncryption::decrypt
type: function
doc:
<comment>Description:</comment>
  Расшифровать данных
  
  Расшифровывает значение.

<comment>Param:</comment>
  <info>MongoDB\BSON\Binary</info>  <strong>$value</strong>  Объект класса <class>MongoDB\BSON\Binary</class> с подтипом 6, содержащий
                               зашифрованные данные.

<comment>Return:</comment>
  <info>mixed</info>  Возвращает расшифрованные данные в том виде, как они были переданы в
         <strong>MongoDB\Driver\ClientEncryption::encrypt()</strong>.

<comment>See Also:</comment>
   * <strong>MongoDB\Driver\ClientEncryption::encrypt()</strong>


id: MongoDB\Driver\ClientEncryption::deleteKey
type: function
doc:
<comment>Description:</comment>
  Удаляет документ с ключом
  
  Удаляет документ с ключом с заданным UUID <strong>$keyId</strong> из коллекции хранилища ключей.

<comment>Param:</comment>
  <info>MongoDB\BSON\Binary</info>  <strong>$keyId</strong>  Экземпляр <class>MongoDB\BSON\Binary</class> с подтипом 4 (UUID), идентифицирующий
                               документ с ключом.

<comment>Return:</comment>
  <info>object</info>  Возвращает результат внутренней операции <return>deleteOne</return> над коллекцией хранилища ключей.


id: MongoDB\Driver\ClientEncryption::encrypt
type: function
doc:
<comment>Description:</comment>
  Шифрует данные
  
  Шифрует данные.

<comment>Param:</comment>
  <info>mixed</info>       <strong>$value</strong>    Значение для шифрования. Метод может зашифровать любые данные, которые могут
                        быть записаны в MongoDB.
  <info>array|null</info>  <strong>$options</strong>  Encryption optionsОпцияТипОписаниеalgorithm<info>string</info> Алгоритм шифрования,
                        который будет использоваться. Опция является обязательной. Укажите одну из
                        следующих констант ClientEncryption:
                        <info>MongoDB\Driver\ClientEncryption::AEAD_AES_256_CBC_HMAC_SHA_512_DETERMINISTIC</info><info>MongoDB\Driver\ClientEncryption::AEAD_AES_256_CBC_HMAC_SHA_512_RANDOM</info><info>MongoDB\Driver\ClientEncryption::ALGORITHM_INDEXED</info><info>MongoDB\Driver\ClientEncryption::ALGORITHM_UNINDEXED</info><info>MongoDB\Driver\ClientEncryption::ALGORITHM_RANGE_PREVIEW</info>contentionFactor<info>int</info>
                        Коэффициент сдерживания при оценке запросов с индексированными,
                        зашифрованными полезными нагрузками.  Опция применяется и может быть указана
                        только тогда, когда опция <return>algorithm</return> равна
                        <info>MongoDB\Driver\ClientEncryption::ALGORITHM_INDEXED</info> или
                        <info>MongoDB\Driver\ClientEncryption::ALGORITHM_RANGE_PREVIEW</info>. keyAltName<info>string</info>
                        Идентифицирует документ коллекции хранилища ключей по <return>keyAltName</return>. Опция
                        является взаимоисключающей с <return>keyId</return> и требуется ровно один.
                        keyId<class>MongoDB\BSON\Binary</class> Идентифицирует ключ данных по <return>_id</return>. Значением
                        является UUID (двоичный подтип 4). Опция является взаимоисключающей с
                        <return>keyAltName</return> и требуется ровно один. queryType<info>int</info> Тип запроса для оценки
                        запросов с индексированными, зашифрованными полезными нагрузками. Укажите
                        одну из следующих констант ClientEncryption:
                        <info>MongoDB\Driver\ClientEncryption::QUERY_TYPE_EQUALITY</info><info>MongoDB\Driver\ClientEncryption::QUERY_TYPE_RANGE_PREVIEW</info>
                        Опция применяется и может быть указана только тогда, когда опция <return>algorithm</return>
                        равна <info>MongoDB\Driver\ClientEncryption::ALGORITHM_INDEXED</info> или
                        <info>MongoDB\Driver\ClientEncryption::ALGORITHM_RANGE_PREVIEW</info>. rangeOpts<info>array</info>
                        Опции индекса для шифруемого поля с поддержкой запросов "rangePreview".
                        Приведённые ниже параметры должны соответствовать значениям, установленным в
                        <return>encryptedFields</return> целевой коллекции. Для полей типа double и decimal128 BSON,
                        <return>min</return>, <return>max</return> и <return>precision</return> должны быть либо все установлены, либо все должны
                        отсутствовать. Опции индекса диапазонаОпцияТипОписаниеmin<info>mixed</info>Обязательное,
                        если установлено значение <return>precision</return>.max<info>mixed</info>Обязательное, если установлено
                        значение <return>precision</return>.sparsity<info>int</info>Обязательное.precision<info>int</info>Необязательное. Может
                        быть установлено только для типов полей BSON double или decimal128.
                        
                        Алгоритм шифрования, который будет использоваться. Опция является
                        обязательной. Укажите одну из следующих констант ClientEncryption:
                        
                        Коэффициент сдерживания при оценке запросов с индексированными,
                        зашифрованными полезными нагрузками.
                        
                        Опция применяется и может быть указана только тогда, когда опция <return>algorithm</return>
                        равна <info>MongoDB\Driver\ClientEncryption::ALGORITHM_INDEXED</info> или
                        <info>MongoDB\Driver\ClientEncryption::ALGORITHM_RANGE_PREVIEW</info>.
                        
                        Идентифицирует документ коллекции хранилища ключей по <return>keyAltName</return>. Опция
                        является взаимоисключающей с <return>keyId</return> и требуется ровно один.
                        
                        Идентифицирует ключ данных по <return>_id</return>. Значением является UUID (двоичный подтип
                        4). Опция является взаимоисключающей с <return>keyAltName</return> и требуется ровно один.
                        
                        Тип запроса для оценки запросов с индексированными, зашифрованными полезными
                        нагрузками. Укажите одну из следующих констант ClientEncryption:
                        
                        Опция применяется и может быть указана только тогда, когда опция <return>algorithm</return>
                        равна <info>MongoDB\Driver\ClientEncryption::ALGORITHM_INDEXED</info> или
                        <info>MongoDB\Driver\ClientEncryption::ALGORITHM_RANGE_PREVIEW</info>.
                        
                        Опции индекса для шифруемого поля с поддержкой запросов "rangePreview".
                        Приведённые ниже параметры должны соответствовать значениям, установленным в
                        <return>encryptedFields</return> целевой коллекции. Для полей типа double и decimal128 BSON,
                        <return>min</return>, <return>max</return> и <return>precision</return> должны быть либо все установлены, либо все должны
                        отсутствовать.
                        
                        Опции индекса диапазонаОпцияТипОписаниеmin<info>mixed</info>Обязательное, если
                        установлено значение <return>precision</return>.max<info>mixed</info>Обязательное, если установлено
                        значение <return>precision</return>.sparsity<info>int</info>Обязательное.precision<info>int</info>Необязательное. Может
                        быть установлено только для типов полей BSON double или decimal128.

<comment>Return:</comment>
  <info>MongoDB\BSON\Binary</info>  Возвращает зашифрованные данные в виде объекта <class>MongoDB\BSON\Binary</class> с подтипом
                       6.

<comment>See Also:</comment>
   * <strong>MongoDB\Driver\ClientEncryption::decrypt()</strong>


id: MongoDB\Driver\ClientEncryption::encryptExpression
type: function
doc:
<comment>Description:</comment>
  Шифрует совпадение или агрегированное выражение
  
  Шифрует совпадение или агрегированное выражение для запроса индекса диапазона.
  
  Для выполнения запроса с зашифрованным диапазоном полезной нагрузки драйвер <class>MongoDB\Driver\Manager</class>
  должен быть сконфигурирован с опцией <return>"autoEncryption"</return>. Опция <return>"bypassQueryAnalysis"</return> автоматического
  шифрования может иметь значение <info>true</info>. Опция <return>"bypassAutoEncryption"</return> автоматического шифрования
  должна иметь значение <info>false</info>.
  
  Алгоритм работы с диапазоном является экспериментальным. Он не предназначен для публичного
  использования.
  
  Драйвер PHP пока не поддерживает запросы диапазонов для типов полей decimal128 BSON.

<comment>Param:</comment>
  <info>array|object</info>  <strong>$expr</strong>     Соответствие или агрегированное выражение, которое необходимо зашифровать.
                          В выражениях должен использоваться хотя бы один из операторов <return>$gt</return>, <return>$gte</return>,
                          <return>$lt</return> или <return>$lte</return>. Оператор верхнего уровня <return>$and</return> необходим, даже если
                          используется только один оператор сравнения.
                          
                          Пример поддерживаемого выражения соответствия (применяется для запросов и
                          этапа агрегации <return>$match</return>) выглядит следующим образом:
                          
                          Пример поддерживаемого агрегированного выражения выглядит следующим
                          образом:
  <info>array|null</info>    <strong>$options</strong>  Encryption optionsОпцияТипОписаниеalgorithm<info>string</info> Алгоритм шифрования,
                          который будет использоваться. Опция является обязательной. Укажите одну из
                          следующих констант ClientEncryption:
                          <info>MongoDB\Driver\ClientEncryption::AEAD_AES_256_CBC_HMAC_SHA_512_DETERMINISTIC</info><info>MongoDB\Driver\ClientEncryption::AEAD_AES_256_CBC_HMAC_SHA_512_RANDOM</info><info>MongoDB\Driver\ClientEncryption::ALGORITHM_INDEXED</info><info>MongoDB\Driver\ClientEncryption::ALGORITHM_UNINDEXED</info><info>MongoDB\Driver\ClientEncryption::ALGORITHM_RANGE_PREVIEW</info>contentionFactor<info>int</info>
                          Коэффициент сдерживания при оценке запросов с индексированными,
                          зашифрованными полезными нагрузками.  Опция применяется и может быть
                          указана только тогда, когда опция <return>algorithm</return> равна
                          <info>MongoDB\Driver\ClientEncryption::ALGORITHM_INDEXED</info> или
                          <info>MongoDB\Driver\ClientEncryption::ALGORITHM_RANGE_PREVIEW</info>. keyAltName<info>string</info>
                          Идентифицирует документ коллекции хранилища ключей по <return>keyAltName</return>. Опция
                          является взаимоисключающей с <return>keyId</return> и требуется ровно один.
                          keyId<class>MongoDB\BSON\Binary</class> Идентифицирует ключ данных по <return>_id</return>. Значением
                          является UUID (двоичный подтип 4). Опция является взаимоисключающей с
                          <return>keyAltName</return> и требуется ровно один. queryType<info>int</info> Тип запроса для оценки
                          запросов с индексированными, зашифрованными полезными нагрузками. Укажите
                          одну из следующих констант ClientEncryption:
                          <info>MongoDB\Driver\ClientEncryption::QUERY_TYPE_EQUALITY</info><info>MongoDB\Driver\ClientEncryption::QUERY_TYPE_RANGE_PREVIEW</info>
                          Опция применяется и может быть указана только тогда, когда опция <return>algorithm</return>
                          равна <info>MongoDB\Driver\ClientEncryption::ALGORITHM_INDEXED</info> или
                          <info>MongoDB\Driver\ClientEncryption::ALGORITHM_RANGE_PREVIEW</info>. rangeOpts<info>array</info>
                          Опции индекса для шифруемого поля с поддержкой запросов "rangePreview".
                          Приведённые ниже параметры должны соответствовать значениям, установленным
                          в <return>encryptedFields</return> целевой коллекции. Для полей типа double и decimal128
                          BSON, <return>min</return>, <return>max</return> и <return>precision</return> должны быть либо все установлены, либо все
                          должны отсутствовать. Опции индекса
                          диапазонаОпцияТипОписаниеmin<info>mixed</info>Обязательное, если установлено значение
                          <return>precision</return>.max<info>mixed</info>Обязательное, если установлено значение
                          <return>precision</return>.sparsity<info>int</info>Обязательное.precision<info>int</info>Необязательное. Может быть
                          установлено только для типов полей BSON double или decimal128.
                          
                          Алгоритм шифрования, который будет использоваться. Опция является
                          обязательной. Укажите одну из следующих констант ClientEncryption:
                          
                          Коэффициент сдерживания при оценке запросов с индексированными,
                          зашифрованными полезными нагрузками.
                          
                          Опция применяется и может быть указана только тогда, когда опция <return>algorithm</return>
                          равна <info>MongoDB\Driver\ClientEncryption::ALGORITHM_INDEXED</info> или
                          <info>MongoDB\Driver\ClientEncryption::ALGORITHM_RANGE_PREVIEW</info>.
                          
                          Идентифицирует документ коллекции хранилища ключей по <return>keyAltName</return>. Опция
                          является взаимоисключающей с <return>keyId</return> и требуется ровно один.
                          
                          Идентифицирует ключ данных по <return>_id</return>. Значением является UUID (двоичный
                          подтип 4). Опция является взаимоисключающей с <return>keyAltName</return> и требуется ровно
                          один.
                          
                          Тип запроса для оценки запросов с индексированными, зашифрованными
                          полезными нагрузками. Укажите одну из следующих констант ClientEncryption:
                          
                          Опция применяется и может быть указана только тогда, когда опция <return>algorithm</return>
                          равна <info>MongoDB\Driver\ClientEncryption::ALGORITHM_INDEXED</info> или
                          <info>MongoDB\Driver\ClientEncryption::ALGORITHM_RANGE_PREVIEW</info>.
                          
                          Опции индекса для шифруемого поля с поддержкой запросов "rangePreview".
                          Приведённые ниже параметры должны соответствовать значениям, установленным
                          в <return>encryptedFields</return> целевой коллекции. Для полей типа double и decimal128
                          BSON, <return>min</return>, <return>max</return> и <return>precision</return> должны быть либо все установлены, либо все
                          должны отсутствовать.
                          
                          Опции индекса диапазонаОпцияТипОписаниеmin<info>mixed</info>Обязательное, если
                          установлено значение <return>precision</return>.max<info>mixed</info>Обязательное, если установлено
                          значение <return>precision</return>.sparsity<info>int</info>Обязательное.precision<info>int</info>Необязательное.
                          Может быть установлено только для типов полей BSON double или decimal128.

<comment>Return:</comment>
  <info>object</info>  Возвращает зашифрованное выражение в виде объекта.

<comment>See Also:</comment>
   * <strong>MongoDB\Driver\Manager::__construct()</strong>


id: MongoDB\Driver\ClientEncryption::getKey
type: function
doc:
<comment>Description:</comment>
  Получает документ с ключом
  
  Находит единственный документ с ключом в коллекции хранилища ключей с заданным UUID <strong>$keyId</strong>.

<comment>Param:</comment>
  <info>MongoDB\BSON\Binary</info>  <strong>$keyId</strong>  Экземпляр <class>MongoDB\BSON\Binary</class> с подтипом 4 (UUID), идентифицирующий
                               документ с ключом.

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


id: MongoDB\Driver\ClientEncryption::getKeyByAltName
type: function
doc:
<comment>Description:</comment>
  Получает документ с ключом по альтернативному имени
  
  Находит единственный документ с ключом в коллекции хранилища ключей с заданным альтернативным
  именем <strong>$keyAltName</strong>.

<comment>Param:</comment>
  <info>string</info>  <strong>$keyAltName</strong>  Альтернативное имя документа с ключом.

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

<comment>See Also:</comment>
   * <strong>MongoDB\Driver\ClientEncryption::addKeyAltName()</strong>
   * <strong>MongoDB\Driver\ClientEncryption::removeKeyAltName()</strong>


id: MongoDB\Driver\ClientEncryption::getKeys
type: function
doc:
<comment>Description:</comment>
  Получает все документы с ключом
  
  Находит все документы с ключом в коллекции хранилища ключей.

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


id: MongoDB\Driver\ClientEncryption::removeKeyAltName
type: function
doc:
<comment>Description:</comment>
  Удаляет альтернативное имя из документа с ключом
  
  Удаляет параметр <strong>$keyAltName</strong> из набора альтернативных имён для документа с ключом с заданным UUID
  <strong>$keyId</strong>.

<comment>Param:</comment>
  <info>MongoDB\BSON\Binary</info>  <strong>$keyId</strong>       Экземпляр <class>MongoDB\BSON\Binary</class> с подтипом 4 (UUID),
                                    идентифицирующий документ с ключом.
  <info>string</info>               <strong>$keyAltName</strong>  Альтернативное имя для удаления из документа с ключом.

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

<comment>See Also:</comment>
   * <strong>MongoDB\Driver\ClientEncryption::addKeyAltName()</strong>
   * <strong>MongoDB\Driver\ClientEncryption::getKeyByAltName()</strong>


id: MongoDB\Driver\ClientEncryption::rewrapManyDataKey
type: function
doc:
<comment>Description:</comment>
  Переворачивает ключи данных
  
  Переворачивает (т.е. расшифровывает и заново шифрует) ноль или более ключей данных в коллекции
  хранилища ключей, которые соответствуют заданному фильтру (<strong>$filter</strong>).
  
  Если опция <return>"provider"</return> не указана, совпадающие ключи данных будут повторно зашифрованы с помощью
  текущего поставщика KMS. В противном случае совпадающие ключи данных будут зашифрованы заново в
  соответствии с указанными опциями <return>"provider"</return> и <return>"masterKey"</return>.

<comment>Param:</comment>
  <info>array|object</info>  <strong>$filter</strong>   Предикат запроса. Пустой предикат совпадёт со всеми элементами коллекции.
                          
                          При вычислении критериев запроса, MongoDB сравнивает типы и значения в
                          соответствии с собственными правилами сравнения типов BSON, отличных от
                          правил сравнения и приведения типов PHP. Когда используется специальный
                          тип BSON,  критерия запроса должна соответствовать классу BSON (т.е.
                          использовать <class>MongoDB\BSON\ObjectId</class> для выборке по ObjectId).
  <info>array|null</info>    <strong>$options</strong>  Параметры RewrapManyDataKeyПараметрТипОписаниеprovider<info>string</info> KMS-провайдер
                          (например, <return>"local"</return>, <return>"aws"</return>), который будет использоваться для повторного
                          шифрования совпавших ключей данных.  Если провайдер KMS не указан, то
                          совпадающие ключи данных будут повторно зашифрованы с помощью текущего
                          провайдера KMS. masterKey<info>array</info> Параметр masterKey определяет специфический
                          для KMS ключ, используемый для шифрования нового ключа данных. Параметр не
                          должен указываться без параметра <return>"provider"</return>. Параметр необходим, если
                          указан <return>"provider"</return>, а не <return>"local"</return>. Параметры провайдера
                          <return>"aws"</return>ПараметрТипОписаниеregionСтрокаОбязательный.keyСтрокаОбязательный.
                          Имя ресурса Amazon (ARN) для главного ключа клиента AWS
                          (CMK).endpointСтрокаНеобязательный. Альтернативный идентификатор хоста для
                          отправки запросов KMS. Может содержать номер порта.Параметры провайдера
                          <return>"azure"</return>ПараметрТипОписаниеkeyVaultEndpointСтрокаОбязательный. Хост с
                          необязательным портом (например,
                          "example.vault.azure.net").keyNameСтрокаОбязательный.keyVersionСтрокаНеобязательный.
                          Определённая версия именованного ключа. По умолчанию используется
                          первичная версия ключа.Параметры провайдера
                          <return>"gcp"</return>ПараметрТипОписаниеprojectIdСтрокаОбязательный.locationСтрокаОбязательный.keyRingСтрокаОбязательный.keyNameСтрокаОбязательный.keyVersionСтрокаНеобязательный.
                          Определённая версия именованного ключа. По умолчанию используется
                          первичная версия ключа.endpointСтрокаНеобязательный. Хост с дополнительным
                          портом. По умолчанию "cloudkms.googleapis.com"..Параметры провайдера
                          <return>"kmip"</return>ПараметрТипОписаниеkeyIdСтрокаНеобязательный. Уникальный
                          идентификатор 96-байтового управляемого объекта секретных данных KMIP.
                          Если не указан, драйвер создаёт случайный 96-байтовый управляемый объект
                          секретных данных KMIP.endpointСтрокаНеобязательный. Хост с дополнительным
                          портом.
                          
                          KMS-провайдер (например, <return>"local"</return>, <return>"aws"</return>), который будет использоваться для
                          повторного шифрования совпавших ключей данных.
                          
                          Если провайдер KMS не указан, то совпадающие ключи данных будут повторно
                          зашифрованы с помощью текущего провайдера KMS.
                          
                          Параметр masterKey определяет специфический для KMS ключ, используемый для
                          шифрования нового ключа данных. Параметр не должен указываться без
                          параметра <return>"provider"</return>. Параметр необходим, если указан <return>"provider"</return>, а не
                          <return>"local"</return>.
                          
                          Параметры провайдера
                          <return>"aws"</return>ПараметрТипОписаниеregionСтрокаОбязательный.keyСтрокаОбязательный.
                          Имя ресурса Amazon (ARN) для главного ключа клиента AWS
                          (CMK).endpointСтрокаНеобязательный. Альтернативный идентификатор хоста для
                          отправки запросов KMS. Может содержать номер порта.
                          
                          Параметры провайдера
                          <return>"azure"</return>ПараметрТипОписаниеkeyVaultEndpointСтрокаОбязательный. Хост с
                          необязательным портом (например,
                          "example.vault.azure.net").keyNameСтрокаОбязательный.keyVersionСтрокаНеобязательный.
                          Определённая версия именованного ключа. По умолчанию используется
                          первичная версия ключа.
                          
                          Параметры провайдера
                          <return>"gcp"</return>ПараметрТипОписаниеprojectIdСтрокаОбязательный.locationСтрокаОбязательный.keyRingСтрокаОбязательный.keyNameСтрокаОбязательный.keyVersionСтрокаНеобязательный.
                          Определённая версия именованного ключа. По умолчанию используется
                          первичная версия ключа.endpointСтрокаНеобязательный. Хост с дополнительным
                          портом. По умолчанию "cloudkms.googleapis.com"..
                          
                          Параметры провайдера <return>"kmip"</return>ПараметрТипОписаниеkeyIdСтрокаНеобязательный.
                          Уникальный идентификатор 96-байтового управляемого объекта секретных
                          данных KMIP. Если не указан, драйвер создаёт случайный 96-байтовый
                          управляемый объект секретных данных KMIP.endpointСтрокаНеобязательный.
                          Хост с дополнительным портом.

<comment>Return:</comment>
  <info>object</info>  Возвращает объект, у которого будет необязательное свойство <return>bulkWriteResult</return>, содержащее
          результат внутренней операции <return>bulkWrite</return> в виде объекта. Если ни один ключ данных не
          соответствует фильтру или запись не была признана, свойство <return>bulkWriteResult</return> будет равно
          <info>null</info>.


id: MongoDB\Driver\Command
type: class
doc:
<comment>Description:</comment>
  Класс <class>MongoDB\Driver\Command</class> - это объект значения, представляющий команду базы данных.
  
  Чтобы предоставить Помощников команд (Command Helpers) должен быть создан объект
  <class>MongoDB\Driver\Command</class>.


id: MongoDB\Driver\Command::__construct
type: function
doc:
<comment>Description:</comment>
  Создаёт новый объект Command
  
  Создаёт новый объект класса <class>MongoDB\Driver\Command</class>, который является неизменяемым значением,
  представляющим команду базы данных. Эту команду впоследствии можно запустить с помощью
  MongoDB\Driver\Manager::executeCommand.
  
  Полный документ команды, включающий её имя и прочие опции,, должен быть задан в параметре
  <strong>$document</strong>. Параметр <strong>$commandOptions</strong> используется только для определения опций запуска команды и
  результирующий <class>MongoDB\Driver\Cursor</class>.

<comment>Param:</comment>
  <info>array|object</info>  <strong>$document</strong>        Полный документ команды, который будет передан серверу.
  <info>array|null</info>    <strong>$commandOptions</strong>  Не используйте этот параметр для указания опций, описанных в
                                 руководстве по командам MongoDB. Этот параметр можно использовать
                                 только для опций перечисленных ниже.
                                 
                                 commandOptionsОпцияТипОписаниеmaxAwaitTimeMS<info>int</info> Положительное целое
                                 число, определяющие ограничение времени в миллисекундах, на которое
                                 сервер может блокировать операцию getMore, если данные отсутствуют.
                                 Эта опция может использоваться только совместно с командами,
                                 возвращающими хвостовые (tailable) курсоры. (например Change
                                 Streams).
                                 
                                 Положительное целое число, определяющие ограничение времени в
                                 миллисекундах, на которое сервер может блокировать операцию
                                 getMore, если данные отсутствуют. Эта опция может использоваться
                                 только совместно с командами, возвращающими хвостовые (tailable)
                                 курсоры. (например Change Streams).

<comment>See Also:</comment>
   * MongoDB\Driver\Manager::executeCommand
   * <class>MongoDB\Driver\Cursor</class>


id: MongoDB\Driver\Cursor
type: class
doc:
<comment>Description:</comment>
  Класс <class>MongoDB\Driver\Cursor</class> содержит результаты команды MongoDB command или запроса и может быть
  возвращён MongoDB\Driver\Manager::executeCommand или MongoDB\Driver\Manager::executeQuery
  соответственно.


id: MongoDB\Driver\Cursor::__construct
type: function
doc:
<comment>Description:</comment>
  Создаёт новый объект Cursor (не используется)
  
  Объекты <class>MongoDB\Driver\Cursor</class> возвращаются в результате выполнения команды или запроса и не могут
  быть созданы напрямую.

<comment>See Also:</comment>
   * <strong>MongoDB\Driver\Manager::executeCommand()</strong>
   * <strong>MongoDB\Driver\Manager::executeQuery()</strong>
   * <strong>MongoDB\Driver\Server::executeCommand()</strong>
   * <strong>MongoDB\Driver\Server::executeQuery()</strong>


id: MongoDB\Driver\Cursor::current
type: function
doc:
<comment>Description:</comment>
  Возвращает текущий элемент

<comment>Return:</comment>
  <info>array|object|null</info>  Возвращает текущий документ в виде массива или объекта, в зависимости от
                     настроек курсора. Если итерация не была начата, либо текущая позиция не
                     корректна, будет возвращён <info>null</info>.

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


id: MongoDB\Driver\Cursor::getId
type: function
doc:
<comment>Description:</comment>
  Возвращает идентификатор для курсора
  
  Возвращает <class>MongoDB\Driver\CursorId</class>, связанный с этим курсором. Идентификатор курсора однозначно
  идентифицирует курсор на сервере.

<comment>Return:</comment>
  <info>MongoDB\Driver\CursorId</info>  Возвращает <class>MongoDB\Driver\CursorId</class> для курсора.

<comment>See Also:</comment>
   * <class>MongoDB\Driver\CursorId</class>
   * <strong>MongoDB\Driver\CursorId::__toString()</strong>


id: MongoDB\Driver\Cursor::getServer
type: function
doc:
<comment>Description:</comment>
  Возвращает сервер, связанный с курсором
  
  Возвращает <class>MongoDB\Driver\Server</class>, связанный с курсором. Это сервер, который выполнил
  <class>MongoDB\Driver\Query</class> или <class>MongoDB\Driver\Command</class>.

<comment>Return:</comment>
  <info>MongoDB\Driver\Server</info>  Возвращает <class>MongoDB\Driver\Server</class>, связанный с курсором.

<comment>See Also:</comment>
   * <class>MongoDB\Driver\Server</class>


id: MongoDB\Driver\Cursor::isDead
type: function
doc:
<comment>Description:</comment>
  Проверяет, исчерпан ли курсор или может содержать дополнительные результаты
  
  Проверяет, нет ли у курсора дополнительных результатов. Этот метод аналогичен методу
  cursor.isExhausted() в оболочке MongoDB и в первую очередь полезен при выполнении итерации
  хвостовых курсоров.
  
  Курсор не имеет дополнительных результатов и считается "мёртвым", если выполняется одно из
  следующих условий: Текущий пакет был полностью повторён и идентификатор курсора равен нулю (то
  есть getMore не может быть выполнен).Произошла ошибка при итерации курсора.Курсор достиг своего
  установленного предела.
  
  Преднамеренно не всегда возможно определить, имеет ли курсор дополнительные результаты. Случаи,
  когда курсор может иметь больше доступных данных, следующие:  В текущем пакете есть дополнительные
  документы, которые буферизируются на стороне клиента. Итерация извлечёт документ из локального
  буфера.  В текущем пакете нет дополнительных документов (то есть локального буфера), но
  идентификатор курсора не равен нулю. Итерация будет запрашивать больше документов с сервера с
  помощью операции getMore, которая может возвращать или не возвращать дополнительные результаты
  и/или указывать, что курсор был закрыт на сервере, возвращая ноль для его идентификатора.

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

<comment>See Also:</comment>
   * Хвостовые курсоры в руководстве MongoDB
   * cursor.isExhausted() в руководстве MongoDB


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

<comment>Return:</comment>
  <info>int</info>  Числовой индекс текущего результата в курсоре.

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


id: MongoDB\Driver\Cursor::next
type: function
doc:
<comment>Description:</comment>
  Перемещает курсор на следующий результат

<comment>Return:</comment>
  <info>void</info>  Сдвигает текущую позицию к следующему результату в курсоре.

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


id: MongoDB\Driver\Cursor::rewind
type: function
doc:
<comment>Description:</comment>
  Перемещает курсор к первому результату
  
  Если курсор продвинулся дальше своей первой позиции, то его переместить к первому результату уже
  не получится.

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

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


id: MongoDB\Driver\Cursor::setTypeMap
type: function
doc:
<comment>Description:</comment>
  Устанавливает карту типа для десериализации BSON
  
  Устанавливает конфигурацию карты типов, которая будет использоваться при десериализации
  результатов BSON в значения PHP.

<comment>Param:</comment>
  <info></info>  <strong>$typeMap</strong>  Конфигурация карты типов.

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

<comment>See Also:</comment>
   * 


id: MongoDB\Driver\Cursor::toArray
type: function
doc:
<comment>Description:</comment>
  Возвращает массив, содержащий все результаты курсора
  
  Итерирует курсор и возвращает его результаты в виде массива. <strong>MongoDB\Driver\Cursor::setTypeMap()</strong>
  может использоваться для управления тем, как документы десериализованы в значение PHP.

<comment>Return:</comment>
  <info>array</info>  Возвращает массив (<info>array</info>), содержащий все результаты курсора.

<comment>See Also:</comment>
   * <strong>MongoDB\Driver\Cursor::setTypeMap()</strong>


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

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

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


id: MongoDB\Driver\CursorId
type: class
doc:
<comment>Description:</comment>
  Класс <class>MongoDB\Driver\CursorID</class> - объект значения, который представляет идентификатор курсора.
  Экземпляры этого класса возвращаются <strong>MongoDB\Driver\Cursor::getId()</strong>.


id: MongoDB\Driver\CursorId::__construct
type: function
doc:
<comment>Description:</comment>
  Создаёт новый объект CursorId (не используется)
  
  Объекты <class>MongoDB\Driver\CursorId</class> возвращаются из <strong>MongoDB\Driver\Cursor::getId()</strong> и не могут созданы
  напрямую.

<comment>See Also:</comment>
   * <strong>MongoDB\Driver\Cursor::getId()</strong>


id: MongoDB\Driver\CursorId::__toString
type: function
doc:
<comment>Description:</comment>
  Строковое представление идентификатора курсора
  
  Возвращает идентификатор курсора в виде строки (<info>string</info>).

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

<comment>See Also:</comment>
   * <strong>MongoDB\Driver\Cursor::getId()</strong>


id: MongoDB\Driver\CursorId::serialize
type: function
doc:
<comment>Description:</comment>
  Сериализация CursorId

<comment>Return:</comment>
  <info>string</info>  Возвращает сериализованное представление <class>MongoDB\Driver\CursorId</class>.

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


id: MongoDB\Driver\CursorId::unserialize
type: function
doc:
<comment>Description:</comment>
  Десериализация CursorId

<comment>Param:</comment>
  <info>string</info>  <strong>$data</strong>  Сериализованный <class>MongoDB\Driver\CursorId</class>.

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

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


id: MongoDB\Driver\CursorInterface
type: class
doc:
<comment>Description:</comment>
  Интерфейс, реализованный <class>MongoDB\Driver\Cursor</class>, но также может использоваться в качестве
  параметра, возвращаемого значения или типа свойства в классах пользовательского пространства.


id: MongoDB\Driver\CursorInterface::getId
type: function
doc:
<comment>Description:</comment>
  Возвращает идентификатор курсора
  
  Возвращает <class>MongoDB\Driver\CursorId</class> связанный с курсором. Каждый курсор на сервере имеет уникальный
  идентификатор.

<comment>Return:</comment>
  <info>MongoDB\Driver\CursorId</info>  Возвращает <class>MongoDB\Driver\CursorId</class> для курсора.

<comment>See Also:</comment>
   * MongoDB\Driver\Cursor::getId
   * <class>MongoDB\Driver\CursorId</class>
   * <strong>MongoDB\Driver\CursorId::__toString()</strong>


id: MongoDB\Driver\CursorInterface::getServer
type: function
doc:
<comment>Description:</comment>
  Возвращает сервер, с которым связан курсор
  
  Возвращает <class>MongoDB\Driver\Server</class> связанный с курсором. Это тот сервер, на котором запущены
  <class>MongoDB\Driver\Query</class> или <class>MongoDB\Driver\Command</class>.

<comment>Return:</comment>
  <info>MongoDB\Driver\Server</info>  Возвращает <class>MongoDB\Driver\Server</class> связанный с курсором.

<comment>See Also:</comment>
   * MongoDB\Driver\Cursor::getServer
   * <class>MongoDB\Driver\Server</class>


id: MongoDB\Driver\CursorInterface::isDead
type: function
doc:
<comment>Description:</comment>
  Проверить, можно ли ещё получить из курсора результаты
  
  Проверяет, можно ли попытаться получить из курсора результаты. Изначально курсор находится в
  статусе "жив"(alive), но в следующих случаях может перейти в статус "мёртв"(dead): При очередной
  вычитке не хвостового курсора не был возвращён документПроизошла ошибкаКурсор прочитал последний
  батч до завершенияКурсор достиг предустановленного лимита Это в первую очередь полезно при работе
  с хвостовыми курсорами.

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

<comment>See Also:</comment>
   * MongoDB\Driver\Cursor::isDead


id: MongoDB\Driver\CursorInterface::setTypeMap
type: function
doc:
<comment>Description:</comment>
  Задать сопоставление типов для десериализации BSON
  
  Задать сопоставление типов для использования при десериализации результатов BSON в значения PHP.

<comment>Param:</comment>
  <info></info>  <strong>$typeMap</strong>  Конфигурация карты типов.

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

<comment>See Also:</comment>
   * MongoDB\Driver\Cursor::setTypeMap
   * 


id: MongoDB\Driver\CursorInterface::toArray
type: function
doc:
<comment>Description:</comment>
  Вернуть все результаты для данного курсора в виде массива
  
  Итерирует курсор и возвращает результаты в виде массива. Для контроля десериализации в типы PHP
  можно использовать <strong>MongoDB\Driver\CursorInterface::setTypeMap()</strong>.

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

<comment>See Also:</comment>
   * MongoDB\Driver\Cursor::toArray
   * <strong>MongoDB\Driver\CursorInterface::setTypeMap()</strong>


id: MongoDB\Driver\Exception\AuthenticationException
type: class
doc:
<comment>Description:</comment>
  Выбрасывается, когда драйвер не может выполнить аутентификацию с сервером.


id: MongoDB\Driver\Exception\CommandException::getResultDocument
type: function
doc:
<comment>Description:</comment>
  Возвращает результат документа для неудавшейся команды
  
  Возвращает результат документа для неудавшейся команды.

<comment>Return:</comment>
  <info>object</info>  Документ результата для неудавшейся команды.

<comment>See Also:</comment>
   * <strong>MongoDB\Driver\Manager::executeCommand()</strong>


id: MongoDB\Driver\Exception\ConnectionException
type: class
doc:
<comment>Description:</comment>
  Базовый класс для исключений, выбрасывающихся, когда драйвер не может установить подключение к
  базе данных.


id: MongoDB\Driver\Exception\ConnectionTimeoutException
type: class
doc:
<comment>Description:</comment>
  Выбрасывается, когда драйверу не удаётся установить соединение с базой данных в течение
  определённого периода времени (connectTimeoutMS). или выбор сервера не удался
  (serverSelectionTimeoutMS).


id: MongoDB\Driver\Exception\EncryptionException
type: class
doc:
<comment>Description:</comment>
  Базовый класс для исключений бросаемых в процессе шифрования на стороне клиента.


id: MongoDB\Driver\Exception\Exception
type: class
doc:
<comment>Description:</comment>
  Базовой интерфейс для всех исключений драйвера. Его можно использовать, что поймать только
  исключения, возникающие из самого драйвера.


id: MongoDB\Driver\Exception\ExecutionTimeoutException
type: class
doc:
<comment>Description:</comment>
  Выбрасывается, когда запрос или команда не завершается в течение определённого периода времени
  (например, maxTimeMS).


id: MongoDB\Driver\Exception\InvalidArgumentException
type: class
doc:
<comment>Description:</comment>
  Выбрасывается, когда методу драйвера переданы некорректные аргументы (например, недопустимые типы
  опций).


id: MongoDB\Driver\Exception\LogicException
type: class
doc:
<comment>Description:</comment>
  Выбрасывается при неправильном использовании драйвера (например, перемотка в начало курсора).


id: MongoDB\Driver\Exception\RuntimeException
type: class
doc:
<comment>Description:</comment>
  Выбрасывается, когда драйвер обнаруживает ошибку во время выполнения (например, внутренняя ошибка
  из libmongoc).


id: MongoDB\Driver\Exception\RuntimeException::hasErrorLabel
type: function
doc:
<comment>Description:</comment>
  Возвращает, связана ли метка ошибки с исключением
  
  Возвращает, был ли установлен <strong>$errorLabel</strong> для этого исключения. Метки ошибок устанавливаются либо
  сервером, либо драйвером, чтобы указать конкретные ситуации, в которых может потребоваться принять
  решение о способе обработки конкретного исключения. Такой ситуацией может быть в проверке, можно
  ли безопасно повторить транзакцию, которая не удалась из-за временной ошибки (например, проблемы с
  сетью или конфликт транзакций). Примерами меток ошибок являются <return>TransientTransactionError</return> и
  <return>UnknownTransactionCommitResult</return>.

<comment>Param:</comment>
  <info>string</info>  <strong>$errorLabel</strong>  Название <return>errorLabel</return> для проверки.

<comment>Return:</comment>
  <info>bool</info>  Связана ли переданное значение параметра <return>errorLabel</return> с соответствующим исключением.

<comment>See Also:</comment>
   * <strong>MongoDB\Driver\Session::commitTransaction()</strong>
   * Документация MongoDB по транзакциям


id: MongoDB\Driver\Exception\SSLConnectionException
type: class
doc:
<comment>Description:</comment>
  Выбрасывается, когда драйверу не удаётся установить SSL-соединение с сервером.


id: MongoDB\Driver\Exception\ServerException
type: class
doc:
<comment>Description:</comment>
  Базовый класс для исключений, выброшенных сервером. Код этого исключения и его подклассы будут
  соответствовать исходному коду ошибки с сервера.


id: MongoDB\Driver\Exception\UnexpectedValueException
type: class
doc:
<comment>Description:</comment>
  Выбрасывается, когда драйвер сталкивается с неожиданным значением (например, во время сериализации
  или десериализации BSON).


id: MongoDB\Driver\Exception\WriteException
type: class
doc:
<comment>Description:</comment>
  Базовый класс для исключений, вызванных неудачной операцией записи. Это исключение содержит объект
  <class>MongoDB\Driver\WriteResult</class>.


id: MongoDB\Driver\Exception\WriteException::getWriteResult
type: function
doc:
<comment>Description:</comment>
  Возвращает WriteResult для операции записи закончившейся ошибкой
  
  Возвращает объект <class>MongoDB\Driver\WriteResult</class> для операции записи, которая закончилась ошибкой.
  Более подробную информацию об ошибке можно получить с помощью методов
  <strong>MongoDB\Driver\WriteResult::getWriteErrors()</strong> и <strong>MongoDB\Driver\WriteResult::getWriteConcernError()</strong>.

<comment>Return:</comment>
  <info>MongoDB\Driver\WriteResult</info>  Объект <class>MongoDB\Driver\WriteResult</class> для операции записи закончившейся
                              ошибкой.

<comment>See Also:</comment>
   * <class>MongoDB\Driver\WriteResult</class>
   * <strong>MongoDB\Driver\Manager::executeBulkWrite()</strong>


id: MongoDB\Driver\Manager
type: class
doc:
<comment>Description:</comment>
  Класс <class>MongoDB\Driver\Manager</class> является основной точкой входа в модуль. Он отвечает за поддержание
  соединений с MongoDB (будь то автономный сервер, набор реплик или распределённый кластер).
  
  При инициализации класса Manager не происходит подключение к MongoDB. Это означает, что
  <class>MongoDB\Driver\Manager</class> всегда может быть создан, даже если сервера MongoDB не работают.
  
  Любая запись или запрос будут выбрасывать исключение соединения, поскольку соединения создаются
  "лениво" (по требованию). Сервер MongoDB также может быть недоступен в течение всего времени
  выполнения скрипта. Поэтому важно, чтобы все действия с Manager были обёрнуты в блок try/catch.


id: MongoDB\Driver\Manager::__construct
type: function
doc:
<comment>Description:</comment>
  Создаёт новый Manager MongoDB
  
  Создаёт новый объект <class>MongoDB\Driver\Manager</class> с переданными параметрами.
  
  В спецификации по обнаружению и мониторингу сервера, этот конструктор не выполняет ввода-вывода.
  Соединения будут инициализироваться по требованию, когда выполняется первая операция.
  
  При передаче любых URI-опций, связанных с SSL или TLS, через строку подключения или параметр
  <strong>$uriOptions</strong>, драйвер неявно включает TLS при соединениях. Чтобы предотвратить это, либо явно
  отключите опцию <return>tls</return>, либо не передавайте никаких TLS-опций.
  
  На Unix, драйвер MongoDB чувствителен к сценариям, которые используют системный вызов fork() без
  последующего exec(). Пользователям рекомендуется не переиспользовать экземпляр
  <class>MongoDB\Driver\Manager</class> в дочернем процессе. child process.

<comment>Param:</comment>
  <info>string|null</info>  <strong>$uri</strong>            URI-адрес подключения mongodb://: 
                               
                               Подробнее о поддерживаемых URI параметрах, смотрите раздел Параметры
                               строки подключения в руководстве MongoDB. Параметры пула подключения
                               не поддерживаются, т.к. PHP-драйвер не реализует пулы подключений.
                               
                               <strong>$uri</strong> - это URL, поэтому любые специальные символы в его компонентах
                               должны закодированы в соответствии RFC 3986. Это особенно актуально
                               для имени пользователя и пароля, которые часто могут содержать
                               специальные символы, такие как <return>@</return>, <return>:</return>, или <return>%</return>. При подключении через
                               доменный сокет Unix, путь сокета может содержать специальные символы,
                               например слеши, которые необходимо закодировать. Функция
                               <strong>rawurlencode()</strong> может использоваться для кодирования составных частей
                               URI-адреса.
                               
                               Компонент <return>defaultAuthDb</return> может использоваться для указания имени базы
                               данных, связанной с учётными данными пользователя; однако параметр
                               URI <return>authSource</return> будет иметь приоритет, если он указан. Если ни
                               <return>defaultAuthDb</return>, ни <return>authSource</return> не указаны, база данных <return>admin</return> будет
                               использоваться по умолчанию. Компонент <return>defaultAuthDb</return> не имеет смысла
                               при отсутствии учётных данных пользователя.
  <info>array|null</info>   <strong>$uriOptions</strong>     Дополнительные параметры строки подключения, которые будут
                               перезаписывать любые параметры с тем же именем в параметре <strong>$uri</strong>.
                               
                               uriOptionsНазвание опцииТипОписаниеappname<info>string</info> В MongoDB 3.4+
                               появилась возможность добавлять аннотации к соединениям с
                               метаданными, предоставляемыми подключающимся клиентом. Эти метаданные
                               включаются в журналы логирования сервера при установлении соединения,
                               а также записываются в журналы медленных запросов, если включено
                               профилирование базы данных.  Эта опция может использоваться для
                               указания имени приложения, которое будет включено в метаданные.
                               Значение не может превышать 128 символов. authMechanism<info>string</info>
                               Механизм аутентификации, который MongoDB будет использовать для
                               аутентификации соединения. Для просмотра дополнительных сведений и
                               списка поддерживаемых значений, смотрите раздел Параметры
                               аутентификации в руководстве MongoDB. authMechanismProperties<info>array</info>
                               Свойства для выбранного механизма аутентификации. Для просмотра
                               дополнительных сведений и списка поддерживаемых значений, смотрите
                               раздел Спецификация аутентификации драйвера.  Если не указана в
                               строке URI-адреса, эта опция представляется в виде массива пар
                               ключ-значение. Ключи и значения в этом массиве должны быть строками.
                               authSource<info>string</info> Имя базы данных, связанное с учётными данными
                               пользователя. По умолчанию используется компонент базы данных из
                               URI-адреса соединения или база данных <return>admin</return>, если оба не указаны.
                               Для механизмов аутентификации, которые делегируют хранение учётных
                               данных другим службам (например, GSSAPI), значение должно быть
                               <return>"$external"</return>. canonicalizeHostname<info>bool</info> Если <info>true</info>, драйвер будет
                               преобразовывать реальное имя хоста для IP-адреса сервера перед
                               аутентификацией через SASL. Некоторые базовые слои GSSAPI уже делают
                               это, но эта функциональность может быть отключена в их конфигурации
                               (например, <return>krb.conf</return>). По умолчанию <info>false</info>.  Этот параметр является
                               устаревшим псевдонимом для свойства <return>"CANONICALIZE_HOST_NAME"</return>
                               параметра URI <return>"authMechanismProperties"</return>. compressors<info>string</info> Имеющий
                               приоритет, список разделённых запятыми компрессоров, которые клиент
                               хочет использовать. Сообщения сжаты только в том случае, если клиент
                               и сервер совместно используют любые компрессоры, а компрессор,
                               используемый в каждом направлении, будет зависеть от индивидуальной
                               конфигурации сервера или драйвера. Смотрите Спецификация компрессии
                               драйвера для получения дополнительной информации. connectTimeoutMS<info>int</info>
                               Время ожидания в миллисекундах при попытке соединения. По умолчанию -
                               10 000 миллисекунд. directConnection<info>bool</info> Этот параметр можно
                               использовать для управления поведением обнаружения набора реплик,
                               если в строке подключения указан только один хост. По умолчанию,
                               предоставление одного члена в строке подключения приведёт к
                               установлению прямого подключения или обнаружению дополнительных
                               членов в зависимости от того, отсутствует или отсутствует опция URI
                               <return>"replicaSet"</return> соответственно. Укажите <info>false</info>, чтобы вызвать обнаружение
                               (если <return>"replicaSet"</return> опущен) или укажите <info>true</info>, чтобы форсировать прямое
                               соединение (если <return>"replicaSet"</return> присутствует). gssapiServiceName<info>string</info>
                               Устанавливает имя службы Kerberos при подключении к керберизованными
                               экземплярам MongoDB. Это значение должно совпадать именем службы,
                               установленным в экземплярах MongoDB (т.е. с параметром сервер,
                               saslServiceName ). По умолчанию используется <return>"mongodb"</return>.  Этот
                               параметр является устаревшим псевдонимом для свойства <return>"SERVICE_NAME"</return>
                               параметра URI <return>"authMechanismProperties"</return>. heartbeatFrequencyMS<info>int</info>
                               Задаёт интервал в миллисекундах между проверками драйвера топологии
                               MongoDB, отсчитываемыми с конца предыдущей проверки до начала
                               следующей. По умолчанию - 60 000 миллисекунд.  Согласно Спецификации
                               по обнаружению и мониторингу сервера, это значение не может быть
                               меньше 500 миллисекунд. journal<info>bool</info> Соответствует параметру гарантий
                               записи <strong>$journal</strong>. Если <info>true</info>, для записи будет требоваться
                               подтверждение от MongoDB, что операция была записана в журнал.
                               Подробнее смотрите <class>MongoDB\Driver\WriteConcern</class>. loadBalanced<info>bool</info>
                               Указывает, подключается ли драйвер к кластеру MongoDB через
                               балансировщик нагрузки. Если <info>true</info>, драйвер может подключаться только
                               к одному узлу (указанному либо строкой подключения, либо поиском
                               SRV), параметр URI <return>"directConnection"</return> не может быть <info>true</info> и опция URI
                               <return>"replicaSet"</return> должна быть опущена. По умолчанию <info>false</info>.
                               localThresholdMS<info>int</info> Размер в миллисекундах окна задержки для выбора
                               среди нескольких подходящих экземпляров MongoDB при разрешении
                               предпочтения чтения. По умолчанию - 15 миллисекунд.
                               maxStalenessSeconds<info>int</info> Соответствует параметру предпочтениям чтения
                               <return>"maxStalenessSeconds"</return>. Указывает в секундах насколько устаревшим
                               может быть вторичный узел в наборе реплик, прежде чем клиент
                               перестанет его использовать для операций чтения. По умолчанию не
                               задано максимальное отставание репликации (staleness) и клиенты не
                               будут учитывать отставание вторичного узла при выборе при выборе
                               направления операции чтения. Подробнее смотрите
                               <class>MongoDB\Driver\ReadPreference</class>.  Если указана, максимальное отставание
                               должно быть 32-битным целым числом, большим или равным
                               <info>MongoDB\Driver\ReadPreference::SMALLEST_MAX_STALENESS_SECONDS</info> (т.е.
                               90 секунд). password<info>string</info> Пароль для аутентификации пользователя.
                               Эта опция полезна, если пароль содержит специальные символы, которые
                               в противном случае должны были закодированы для URI-адреса
                               подключения. readConcernLevel<info>string</info> Соответствует параметру гарантий
                               чтения <strong>$level</strong> Определяет уровень изоляции чтения. Подробнее смотрите
                               <class>MongoDB\Driver\ReadConcern</class>. readPreference<info>string</info> Соответствует
                               параметру предпочтениям чтения <strong>$mode</strong> По умолчанию - <return>"primary"</return>.
                               Подробнее смотрите <class>MongoDB\Driver\ReadPreference</class>.
                               readPreferenceTags<info>array</info> Соответствует параметру предпочтениям чтения
                               <strong>$tagSets</strong>. Наборы тегов позволяют настраивать операции чтения для
                               определённых членов набора реплики. Подробнее смотрите
                               <class>MongoDB\Driver\ReadPreference</class>.  Если в строке URI не указано, этот
                               параметр представляется как как массив, соответствующий формату,
                               ожидаемому <strong>MongoDB\Driver\ReadPreference::__construct()</strong>.
                               replicaSet<info>string</info> Задаёт имя набора реплики. retryReads<info>bool</info> Указывает,
                               должен ли драйвер автоматически повторять определённые операции
                               чтения, которые не выполняются из-за временных сетевых ошибок или
                               выборов набора реплик. Требуется MongoDB 3.6+. По умолчанию <info>true</info>.
                               Смотрите Спецификацию по Retryable Reads для получения дополнительной
                               информации. retryWrites<info>bool</info> Указывает, должен ли драйвер
                               автоматически повторять определённые операции записи, которые не
                               выполняются из-за временных сетевых ошибок или выборов набора реплик.
                               Требуется MongoDB 3.6+. По умолчанию <info>true</info>.  Смотрите Retryable Writes
                               в руководстве MongoDB для получения дополнительной информации.
                               safe<info>bool</info> Если <info>true</info>, указывает <return>1</return> для параметра <strong>$w</strong> гарантии записи по
                               умолчанию. Если <info>false</info>, указывается <return>0</return>. Подробнее смотрите
                               <class>MongoDB\Driver\WriteConcern</class>.  Эта опция устарела и не должна
                               использоваться. serverSelectionTimeoutMS<info>int</info> Указывает как долго в
                               миллисекунд блокировать выбор сервера перед выбросом исключения. По
                               умолчанию - 30 000 миллисекунд. serverSelectionTryOnce<info>bool</info> Если <info>true</info>,
                               то сообщает драйверу сканировать развёртывание MongoDB только один
                               раз после неудачной попытки выбора сервера, а затем либо выбрать
                               сервер или создать ошибку. Когда <info>false</info>, драйвер блокирует выбор и
                               выполняет поиск сервера до истечения времени, указанного в параметре
                               <return>"serverSelectionTimeoutMS"</return>. По умолчанию - <info>true</info>.
                               socketCheckIntervalMS<info>int</info> Если сокет не использовался в последнее
                               время, драйвер должен проверить с помощью команды <return>hello</return>, прежде чем
                               использовать его для любой операции. По умолчанию - 5 000
                               миллисекунд. socketTimeoutMS<info>int</info> Время в миллисекундах, чтобы
                               попытаться отправить или получить в сокет до истечения времени. По
                               умолчанию - 300 000 миллисекунд (т.е. 5 минут). srvMaxHosts<info>int</info>
                               Максимальное количество результатов SRV для случайного выбора при
                               первоначальном заполнении посевного списка или, во время опроса SRV,
                               при добавлении новых узлов к топологии. По умолчанию <return>0</return> (т.е. без
                               максимума). srvServiceName<info>string</info> Имя службы, используемое для поиска
                               SRV в начальном списке DNS seedlist обнаружения и опроса SRV. По
                               умолчанию <return>"mongodb"</return>. ssl<info>bool</info> Создаёт соединение с TLS/SSL, если <info>true</info>.
                               По умолчанию - <info>false</info>.  Параметр является устаревшим псевдонимом для
                               параметра URI <return>"tls"</return>. tls<info>bool</info> Инициирует соединение с TLS/SSL, если
                               <info>true</info>. По умолчанию <info>false</info>. tlsAllowInvalidCertificates<info>bool</info> Указывает,
                               должен ли драйвер выдавать ошибку, если сертификат TLS сервера
                               недействителен. По умолчанию <info>false</info>.  Отключение проверки сертификата
                               создаёт уязвимость. tlsAllowInvalidHostnames<info>bool</info> Указывает, должен ли
                               драйвер выдавать ошибку при несоответствии имени хоста сервера и
                               имени хоста, указанного в сертификате TLS. По умолчанию <info>false</info>.
                               Отключение проверки сертификата создаёт уязвимость. Разрешение
                               недопустимых имён хоста может привести к атаке типа "человек
                               посередине" (man-in-the-middle). tlsCAFile<info>string</info> Путь к файлу с одним
                               или несколькими центрами сертификации, которые следует считать
                               доверенными при установлении соединения TLS. По умолчанию будет
                               использоваться хранилище системных сертификатов.
                               tlsCertificateKeyFile<info>string</info> Путь к файлу сертификата клиента или
                               файлу закрытого ключа клиента; в случае, если они оба необходимы,
                               файлы должны быть объединены. tlsCertificateKeyFilePassword<info>string</info>
                               Пароль для расшифровки закрытого ключа клиента (т.е. параметра URI
                               <return>"tlsCertificateKeyFile"</return>), который будет использоваться для соединений
                               TLS. tlsDisableCertificateRevocationCheck<info>bool</info> Если <info>true</info>, драйвер не
                               будет пытаться проверить статус отзыва сертификата (например, OCSP,
                               CRL). По умолчанию <info>false</info>. tlsDisableOCSPEndpointCheck<info>bool</info> Если <info>true</info>,
                               драйвер не будет пытаться связаться с конечной точкой ответа OCSP,
                               если это необходимо (то есть ответ OCSP не сшивается). По умолчанию
                               <info>false</info>. tlsInsecure<info>bool</info> Ослабьте ограничения TLS в максимально
                               возможной степени. При значении <info>true</info> этот параметр имеет тот же
                               эффект, что и указание значения <info>true</info> для обоих параметров URI
                               <return>"tlsAllowInvalidCertificates"</return> и <return>"tlsAllowInvalidHostnames"</return>. По
                               умолчанию <info>false</info>.  Отключение проверки сертификата создаёт уязвимость.
                               Разрешение недопустимых имён хоста может привести к атаке типа
                               "человек посередине" (man-in-the-middle). username<info>string</info> Имя
                               пользователя для аутентификации. Эта опция полезна, если имя
                               пользователя содержит специальные символы, которые в противном случае
                               должны были быть закодированы в URL для URI-адреса подключения.
                               w<info>int</info><info>string</info></info> Соответствует параметру гарантий записи <strong>$w</strong>. Подробнее
                               смотрите <class>MongoDB\Driver\WriteConcern</class>. wTimeoutMS<info>int</info><info>string</info></info>
                               Соответствует параметру гарантий записи <strong>$wtimeout</strong>. Указывает срок в
                               миллисекундах для гарантии записи. Подробнее смотрите
                               <class>MongoDB\Driver\WriteConcern</class>.  Если указан, <return>wTimeoutMS</return> должен быть
                               32-битным целым числом со знаком, большим или равным нулю.
                               zlibCompressionLevel<info>int</info> Указывает уровень сжатия для использования
                               zlib. Эта опция ничего не делает, если <return>zlib</return> не включён в URL опции
                               <return>"compressors"</return>. Смотрите Спецификация компрессии драйвера для
                               получения дополнительной информации.
                               
                               В MongoDB 3.4+ появилась возможность добавлять аннотации к
                               соединениям с метаданными, предоставляемыми подключающимся клиентом.
                               Эти метаданные включаются в журналы логирования сервера при
                               установлении соединения, а также записываются в журналы медленных
                               запросов, если включено профилирование базы данных.
                               
                               Эта опция может использоваться для указания имени приложения, которое
                               будет включено в метаданные. Значение не может превышать 128
                               символов.
                               
                               Механизм аутентификации, который MongoDB будет использовать для
                               аутентификации соединения. Для просмотра дополнительных сведений и
                               списка поддерживаемых значений, смотрите раздел Параметры
                               аутентификации в руководстве MongoDB.
                               
                               Свойства для выбранного механизма аутентификации. Для просмотра
                               дополнительных сведений и списка поддерживаемых значений, смотрите
                               раздел Спецификация аутентификации драйвера.
                               
                               Если не указана в строке URI-адреса, эта опция представляется в виде
                               массива пар ключ-значение. Ключи и значения в этом массиве должны
                               быть строками.
                               
                               Имя базы данных, связанное с учётными данными пользователя. По
                               умолчанию используется компонент базы данных из URI-адреса соединения
                               или база данных <return>admin</return>, если оба не указаны.
                               
                               Для механизмов аутентификации, которые делегируют хранение учётных
                               данных другим службам (например, GSSAPI), значение должно быть
                               <return>"$external"</return>.
                               
                               Если <info>true</info>, драйвер будет преобразовывать реальное имя хоста для
                               IP-адреса сервера перед аутентификацией через SASL. Некоторые базовые
                               слои GSSAPI уже делают это, но эта функциональность может быть
                               отключена в их конфигурации (например, <return>krb.conf</return>). По умолчанию <info>false</info>.
                               
                               Этот параметр является устаревшим псевдонимом для свойства
                               <return>"CANONICALIZE_HOST_NAME"</return> параметра URI <return>"authMechanismProperties"</return>.
                               
                               Имеющий приоритет, список разделённых запятыми компрессоров, которые
                               клиент хочет использовать. Сообщения сжаты только в том случае, если
                               клиент и сервер совместно используют любые компрессоры, а компрессор,
                               используемый в каждом направлении, будет зависеть от индивидуальной
                               конфигурации сервера или драйвера. Смотрите Спецификация компрессии
                               драйвера для получения дополнительной информации.
                               
                               Время ожидания в миллисекундах при попытке соединения. По умолчанию -
                               10 000 миллисекунд.
                               
                               Этот параметр можно использовать для управления поведением
                               обнаружения набора реплик, если в строке подключения указан только
                               один хост. По умолчанию, предоставление одного члена в строке
                               подключения приведёт к установлению прямого подключения или
                               обнаружению дополнительных членов в зависимости от того, отсутствует
                               или отсутствует опция URI <return>"replicaSet"</return> соответственно. Укажите <info>false</info>,
                               чтобы вызвать обнаружение (если <return>"replicaSet"</return> опущен) или укажите
                               <info>true</info>, чтобы форсировать прямое соединение (если <return>"replicaSet"</return>
                               присутствует).
                               
                               Устанавливает имя службы Kerberos при подключении к керберизованными
                               экземплярам MongoDB. Это значение должно совпадать именем службы,
                               установленным в экземплярах MongoDB (т.е. с параметром сервер,
                               saslServiceName ). По умолчанию используется <return>"mongodb"</return>.
                               
                               Этот параметр является устаревшим псевдонимом для свойства
                               <return>"SERVICE_NAME"</return> параметра URI <return>"authMechanismProperties"</return>.
                               
                               Задаёт интервал в миллисекундах между проверками драйвера топологии
                               MongoDB, отсчитываемыми с конца предыдущей проверки до начала
                               следующей. По умолчанию - 60 000 миллисекунд.
                               
                               Согласно Спецификации по обнаружению и мониторингу сервера, это
                               значение не может быть меньше 500 миллисекунд.
                               
                               Соответствует параметру гарантий записи <strong>$journal</strong>. Если <info>true</info>, для
                               записи будет требоваться подтверждение от MongoDB, что операция была
                               записана в журнал. Подробнее смотрите <class>MongoDB\Driver\WriteConcern</class>.
                               
                               Указывает, подключается ли драйвер к кластеру MongoDB через
                               балансировщик нагрузки. Если <info>true</info>, драйвер может подключаться только
                               к одному узлу (указанному либо строкой подключения, либо поиском
                               SRV), параметр URI <return>"directConnection"</return> не может быть <info>true</info> и опция URI
                               <return>"replicaSet"</return> должна быть опущена. По умолчанию <info>false</info>.
                               
                               Размер в миллисекундах окна задержки для выбора среди нескольких
                               подходящих экземпляров MongoDB при разрешении предпочтения чтения. По
                               умолчанию - 15 миллисекунд.
                               
                               Соответствует параметру предпочтениям чтения <return>"maxStalenessSeconds"</return>.
                               Указывает в секундах насколько устаревшим может быть вторичный узел в
                               наборе реплик, прежде чем клиент перестанет его использовать для
                               операций чтения. По умолчанию не задано максимальное отставание
                               репликации (staleness) и клиенты не будут учитывать отставание
                               вторичного узла при выборе при выборе направления операции чтения.
                               Подробнее смотрите <class>MongoDB\Driver\ReadPreference</class>.
                               
                               Если указана, максимальное отставание должно быть 32-битным целым
                               числом, большим или равным
                               <info>MongoDB\Driver\ReadPreference::SMALLEST_MAX_STALENESS_SECONDS</info> (т.е.
                               90 секунд).
                               
                               Соответствует параметру предпочтениям чтения <strong>$mode</strong> По умолчанию -
                               <return>"primary"</return>. Подробнее смотрите <class>MongoDB\Driver\ReadPreference</class>.
                               
                               Соответствует параметру предпочтениям чтения <strong>$tagSets</strong>. Наборы тегов
                               позволяют настраивать операции чтения для определённых членов набора
                               реплики. Подробнее смотрите <class>MongoDB\Driver\ReadPreference</class>.
                               
                               Если в строке URI не указано, этот параметр представляется как как
                               массив, соответствующий формату, ожидаемому
                               <strong>MongoDB\Driver\ReadPreference::__construct()</strong>.
                               
                               Задаёт имя набора реплики.
                               
                               Указывает, должен ли драйвер автоматически повторять определённые
                               операции чтения, которые не выполняются из-за временных сетевых
                               ошибок или выборов набора реплик. Требуется MongoDB 3.6+. По
                               умолчанию <info>true</info>.
                               
                               Смотрите Спецификацию по Retryable Reads для получения дополнительной
                               информации.
                               
                               Указывает, должен ли драйвер автоматически повторять определённые
                               операции записи, которые не выполняются из-за временных сетевых
                               ошибок или выборов набора реплик. Требуется MongoDB 3.6+. По
                               умолчанию <info>true</info>.
                               
                               Смотрите Retryable Writes в руководстве MongoDB для получения
                               дополнительной информации.
                               
                               Если <info>true</info>, указывает <return>1</return> для параметра <strong>$w</strong> гарантии записи по умолчанию.
                               Если <info>false</info>, указывается <return>0</return>. Подробнее смотрите
                               <class>MongoDB\Driver\WriteConcern</class>.
                               
                               Эта опция устарела и не должна использоваться.
                               
                               Указывает как долго в миллисекунд блокировать выбор сервера перед
                               выбросом исключения. По умолчанию - 30 000 миллисекунд.
                               
                               Если <info>true</info>, то сообщает драйверу сканировать развёртывание MongoDB
                               только один раз после неудачной попытки выбора сервера, а затем либо
                               выбрать сервер или создать ошибку. Когда <info>false</info>, драйвер блокирует
                               выбор и выполняет поиск сервера до истечения времени, указанного в
                               параметре <return>"serverSelectionTimeoutMS"</return>. По умолчанию - <info>true</info>.
                               
                               Если сокет не использовался в последнее время, драйвер должен
                               проверить с помощью команды <return>hello</return>, прежде чем использовать его для
                               любой операции. По умолчанию - 5 000 миллисекунд.
                               
                               Время в миллисекундах, чтобы попытаться отправить или получить в
                               сокет до истечения времени. По умолчанию - 300 000 миллисекунд (т.е.
                               5 минут).
                               
                               Максимальное количество результатов SRV для случайного выбора при
                               первоначальном заполнении посевного списка или, во время опроса SRV,
                               при добавлении новых узлов к топологии. По умолчанию <return>0</return> (т.е. без
                               максимума).
                               
                               Имя службы, используемое для поиска SRV в начальном списке DNS
                               seedlist обнаружения и опроса SRV. По умолчанию <return>"mongodb"</return>.
                               
                               Создаёт соединение с TLS/SSL, если <info>true</info>. По умолчанию - <info>false</info>.
                               
                               Параметр является устаревшим псевдонимом для параметра URI <return>"tls"</return>.
                               
                               Инициирует соединение с TLS/SSL, если <info>true</info>. По умолчанию <info>false</info>.
                               
                               Указывает, должен ли драйвер выдавать ошибку, если сертификат TLS
                               сервера недействителен. По умолчанию <info>false</info>.
                               
                               Отключение проверки сертификата создаёт уязвимость.
                               
                               Указывает, должен ли драйвер выдавать ошибку при несоответствии имени
                               хоста сервера и имени хоста, указанного в сертификате TLS. По
                               умолчанию <info>false</info>.
                               
                               Отключение проверки сертификата создаёт уязвимость. Разрешение
                               недопустимых имён хоста может привести к атаке типа "человек
                               посередине" (man-in-the-middle).
                               
                               Путь к файлу с одним или несколькими центрами сертификации, которые
                               следует считать доверенными при установлении соединения TLS. По
                               умолчанию будет использоваться хранилище системных сертификатов.
                               
                               Путь к файлу сертификата клиента или файлу закрытого ключа клиента; в
                               случае, если они оба необходимы, файлы должны быть объединены.
                               
                               Пароль для расшифровки закрытого ключа клиента (т.е. параметра URI
                               <return>"tlsCertificateKeyFile"</return>), который будет использоваться для соединений
                               TLS.
                               
                               Если <info>true</info>, драйвер не будет пытаться проверить статус отзыва
                               сертификата (например, OCSP, CRL). По умолчанию <info>false</info>.
                               
                               Если <info>true</info>, драйвер не будет пытаться связаться с конечной точкой
                               ответа OCSP, если это необходимо (то есть ответ OCSP не сшивается).
                               По умолчанию <info>false</info>.
                               
                               Ослабьте ограничения TLS в максимально возможной степени. При
                               значении <info>true</info> этот параметр имеет тот же эффект, что и указание
                               значения <info>true</info> для обоих параметров URI <return>"tlsAllowInvalidCertificates"</return>
                               и <return>"tlsAllowInvalidHostnames"</return>. По умолчанию <info>false</info>.
                               
                               Отключение проверки сертификата создаёт уязвимость. Разрешение
                               недопустимых имён хоста может привести к атаке типа "человек
                               посередине" (man-in-the-middle).
                               
                               Соответствует параметру гарантий записи <strong>$w</strong>. Подробнее смотрите
                               <class>MongoDB\Driver\WriteConcern</class>.
                               
                               Соответствует параметру гарантий записи <strong>$wtimeout</strong>. Указывает срок в
                               миллисекундах для гарантии записи. Подробнее смотрите
                               <class>MongoDB\Driver\WriteConcern</class>.
                               
                               Если указан, <return>wTimeoutMS</return> должен быть 32-битным целым числом со знаком,
                               большим или равным нулю.
                               
                               Указывает уровень сжатия для использования zlib. Эта опция ничего не
                               делает, если <return>zlib</return> не включён в URL опции <return>"compressors"</return>. Смотрите
                               Спецификация компрессии драйвера для получения дополнительной
                               информации.
  <info>array|null</info>   <strong>$driverOptions</strong>  driverOptionsОпцияТипОписаниеallow_invalid_hostname<info>bool</info> Отключает
                               проверку имени хоста, если <info>true</info>. По умолчанию - <info>false</info>.  Разрешение
                               недопустимых имён хоста может привести к атаке типа "человек
                               посередине" (man-in-the-middle).  Этот параметр является устаревшим
                               псевдонимом для параметра URI <return>"tlsAllowInvalidHostnames"</return>
                               autoEncryption<info>array</info> Предоставляет опции для включения автоматического
                               шифрования на уровне поля на стороне клиента.  Автоматическое
                               шифрование - функция только для Enterprise версии, которая
                               применяется только к операциям над коллекцией. Автоматическое
                               шифрование не поддерживается для операций над базой данных или
                               представлением, а операции, которые не обходятся, приведут к ошибке
                               (смотрите libmongocrypt: Список разрешений на автоматическое
                               шифрование). Чтобы обойти автоматическое шифрование для всех
                               операций, установите <return>bypassAutoEncryption</return> в значение <info>true</info>.
                               Автоматическое шифрование требует, чтобы у аутентифицированного
                               пользователя была привилегия listCollections.  Явное
                               шифрование/дешифрование и автоматическая расшифровка - это функция
                               Community версии. Драйвер все ещё может автоматически расшифровывать,
                               если у опции <return>bypassAutoEncryption</return> установлено значение <info>true</info>.
                               Поддерживаются следующие опции:
                                Опции для автоматического
                               шифрованияОпцияТипОписаниеkeyVaultClient<class>MongoDB\Driver\Manager</class>Менеджер
                               используется для маршрутизации запросов ключей данных в отдельный
                               кластер MongoDB. По умолчанию используется текущий менеджер и
                               кластер.keyVaultNamespace<info>string</info>Полное пространство имён (например,
                               <return>"databaseName.collectionName"</return>), обозначающее коллекцию, которая
                               содержит все ключи данных, используемые для шифрования и
                               дешифрования. Обязательный параметр.kmsProviders<info>array</info> Документ,
                               содержащий конфигурацию для одного или нескольких провайдеров KMS,
                               которые используются для шифрования ключей данных. Поддерживаются
                               провайдеры <return>"aws"</return>, <return>"azure"</return>, <return>"gcp"</return> и <return>"local"</return>, и, по крайней мере, один
                               из них должен быть указан.  Если для <return>"aws"</return>, <return>"azure"</return> или <return>"gcp"</return> указан
                               пустой документ, драйвер попытается сконфигурировать провайдера,
                               используя Автоматические учётные данные.  Формат для <return>"aws"</return> выглядит
                               следующим образом: , secretAccessKey: , sessionToken:
                               }
                               ]]> Формат для <return>"azure"</return> выглядит следующим образом: , clientId: ,
                               clientSecret: , identityPlatformEndpoint:  // По умолчанию
                               "login.microsoftonline.com"
                               
                               }
                               ]]> Формат для <return>"gcp"</return> выглядит следующим образом: , privateKey: |,
                               endpoint:  // По умолчанию "oauth2.googleapis.com"
                               
                               }
                               ]]> Формат для <return>"kmip"</return> выглядит следующим образом: 
                               }
                               ]]> Формат для <return>"local"</return> выглядит следующим образом: |
                               }
                               ]]>tlsOptions<info>array</info> Документ, содержащий конфигурацию TLS для одного
                               или нескольких KMS провайдеров. Поддерживаются провайдеры <return>"aws"</return>,
                               <return>"azure"</return>, <return>"gcp"</return> и <return>"kmip"</return>. Все провайдеры поддерживают следующие опции:
                               : { tlsCaFile: , tlsCertificateKeyFile: ,
                               tlsCertificateKeyFilePassword: , tlsDisableOCSPEndpointCheck:
                               }
                               ]]>schemaMap<info>array</info><info>object</info></info> Карта пространств имён коллекции в локальную
                               схему JSON. Используется для настройки автоматического шифрования.
                               Дополнительную информацию смотрите в Правилах автоматического
                               шифрования в руководстве по MongoDB. Ошибкой является указание
                               коллекции как в <return>schemaMap</return>, так и в <return>encryptedFieldsMap</return>.  Добавление
                               <return>schemaMap</return> обеспечивает большую безопасность, чем использование схем
                               JSON, полученных с сервера. Это защищает от вредоносного сервера,
                               рекламирующего ложную схему JSON, которая может заставить клиента
                               отправлять незашифрованные данные, которые должны быть зашифрованы.
                               Схемы, поставляемые в <return>schemaMap</return>, применяются только для настройки
                               автоматического шифрования на стороне клиента. Другие правила
                               проверки в схеме JSON не будут применяться драйвером и приведут к
                               ошибке. bypassAutoEncryption<info>bool</info> Если <info>true</info>, <return>mongocryptd</return> не будет
                               появляться автоматически. Используется для отключения автоматического
                               шифрования. По умолчанию <info>false</info>. bypassQueryAnalysis<info>bool</info> Если <info>true</info>,
                               автоматический анализ исходящих команд будет отключён и <return>mongocryptd</return>
                               не будет появляться автоматически. Это позволяет использовать явное
                               шифрование для запроса индексированных полей без необходимости
                               использования лицензированной корпоративной библиотеки <return>crypt_shared</return>
                               или процесса <return>mongocryptd</return>. По умолчанию установлено значение <info>false</info>.
                               encryptedFieldsMap<info>array</info><info>object</info></info> Карта пространств имён коллекции в
                               документе <return>encryptedFields</return>. Используется для настройки шифрования с
                               возможностью запроса. Смотрите Шифрование полей и возможность
                               запросов в руководстве по MongoDB для получения дополнительной
                               информации. Ошибкой является указание коллекции как в
                               <return>encryptedFieldsMap</return>, так и в <return>schemaMap</return>.  Указание <return>encryptedFieldsMap</return>
                               обеспечивает большую безопасность, чем полагаться на <return>encryptedFields</return>,
                               полученные от сервера. Это защищает от злонамеренного сервера,
                               рекламирующего ложные <return>encryptedFields</return>. extraOptions<info>array</info><return>extraOptions</return>
                               относится к процессу <return>mongocryptd</return>. Поддерживаются следующие параметры:
                               <return>mongocryptdURI</return> (<info>string</info>): URI для подключения к существующему процессу
                               <return>mongocryptd</return>. По умолчанию <return>"mongodb://localhost:27020"</return>.
                               <return>mongocryptdBypassSpawn</return> (<info>bool</info>): Если <info>true</info>, предотвращает создание
                               драйвером <return>mongocryptd</return>. По умолчанию <info>false</info>. <return>mongocryptdSpawnPath</return>
                               (<info>string</info>): Абсолютный путь для поиска двоичного файла <return>mongocryptd</return>. По
                               умолчанию это пустая строка, использующая системные пути.
                               <return>mongocryptdSpawnArgs</return> (<info>array</info>): Массив строковых аргументов для
                               передачи в <return>mongocryptd</return> при создании. По умолчанию
                               <return>["--idleShutdownTimeoutSecs=60"]</return>. <return>cryptSharedLibPath</return> (<info>string</info>):
                               Абсолютный путь к библиотеке общего доступа <return>crypt_shared</return>. По
                               умолчанию - пустая строка и использует системные пути.
                               <return>cryptSharedLibRequired</return> (<info>bool</info>): Если <info>true</info>, требует, чтобы драйвер
                               загружал <return>crypt_shared</return>. По умолчанию <info>false</info>.  Смотрите Руководство по
                               шифрованию на стороне клиента, чтобы получить больше информации.
                               Автоматическое шифрование — это только корпоративная функция, которая
                               применяется только к операциям над коллекцией. Автоматическое
                               шифрование не поддерживается для операций с базой данных или
                               представлением, операции, которые не получится обойти, приведут к
                               ошибке. Чтобы обойти автоматическое шифрование для всех операций,
                               установите <return>bypassAutoEncryption=true</return> в <return>autoEncryption</return>. Для получения
                               дополнительной информации о разрешённых операциях смотрите
                               Руководство по шифрованию на стороне клиента. ca_dir<info>string</info> Путь к
                               корректно захешированному каталогу сертификатов. По умолчанию будет
                               использоваться хранилище системных сертификатов. ca_file<info>string</info> Путь к
                               файлу с одним или несколькими центрами сертификации, которые следует
                               считать доверенными при установлении соединения TLS. По умолчанию
                               будет использоваться хранилище системных сертификатов.  Параметр
                               является устаревшим псевдонимом для параметра URI <return>"tlsCAFile"</return>.
                               context<info>resource</info>Параметры контекста SSL для использования в качестве
                               запасного варианта, если не указана опция драйвера или эквивалентная
                               ей опция URI. Обратите внимание, что драйвер не обращается к
                               контексту потока по умолчанию (т.е. <strong>stream_context_get_default()</strong>).
                               Поддерживаются следующие параметры контекста: Резервные параметры
                               контекста SSLПараметр драйвераПараметр контекста (запасной
                               вариант)ca_dircapathca_filecafilepem_filelocal_certpem_pwdpassphraseweak_cert_validationallow_self_signed
                               Параметр поддерживается для обратной совместимости, но его следует
                               считать устаревшим. crl_file<info>string</info>Путь к файлу списка аннулированных
                               сертификатов.disableClientPersistence<info>bool</info> Если <info>true</info>, Manager будет
                               использовать новый клиент libmongoc, который не будет сохраняться или
                               использоваться другими объектами Manager. Когда этот объект Manager
                               будет освобождён, его клиент будет уничтожен, а все соединения будут
                               закрыты. По умолчанию <info>false</info>.  Disabling client persistence is not
                               generally recommended. driver<info>array</info> Позволяет пользовательским
                               драйверам добавлять свои метаданные к рукопожатию сервера. По
                               умолчанию драйвер передаёт своё собственное имя, версию и платформу
                               (то есть версию PHP) в рукопожатие. Пользовательские драйверы могут
                               указывать строки для ключей <return>"name"</return>, <return>"version"</return> и <return>"platform"</return> этого
                               массива, которые будут добавлены к соответствующие поля в документе
                               рукопожатия.  Информация о рукопожатии ограничена 512 байтами.
                               Драйвер урезает данные рукопожатия, чтобы соответствовать этой
                               512-байтовой строке. Драйверам и ODM рекомендуется сохранять
                               краткость своих метаданных. pem_file<info>string</info> Путь к сертификату в
                               формате PEM для аутентификации клиента.  Этот параметр является
                               устаревшим псевдонимом для параметра URI <return>"tlsCertificateKeyFile"</return>.
                               pem_pwd<info>string</info> Парольная фраза к PEM-закодированному сертификату (если
                               есть).  Этот параметр является устаревшим псевдонимом для параметра
                               URI <return>"tlsCertificateKeyFilePassword"</return>.
                               serverApi<class>MongoDB\Driver\ServerApi</class> Опция используется для объявления
                               версии API сервера для менеджера. Если не указана, версия API не
                               объявляется. weak_cert_validation<info>bool</info> Отключает проверку сертификат,
                               если <info>true</info>. По умолчанию - <info>false</info>  Этот параметр является устаревшим
                               псевдонимом для параметра URI <return>"tlsAllowInvalidCertificates"</return>.
                               
                               Отключает проверку имени хоста, если <info>true</info>. По умолчанию - <info>false</info>.
                               
                               Разрешение недопустимых имён хоста может привести к атаке типа
                               "человек посередине" (man-in-the-middle).
                               
                               Этот параметр является устаревшим псевдонимом для параметра URI
                               <return>"tlsAllowInvalidHostnames"</return>
                               
                               Предоставляет опции для включения автоматического шифрования на
                               уровне поля на стороне клиента.
                               
                               Автоматическое шифрование - функция только для Enterprise версии,
                               которая применяется только к операциям над коллекцией. Автоматическое
                               шифрование не поддерживается для операций над базой данных или
                               представлением, а операции, которые не обходятся, приведут к ошибке
                               (смотрите libmongocrypt: Список разрешений на автоматическое
                               шифрование). Чтобы обойти автоматическое шифрование для всех
                               операций, установите <return>bypassAutoEncryption</return> в значение <info>true</info>.
                               
                               Автоматическое шифрование требует, чтобы у аутентифицированного
                               пользователя была привилегия listCollections.
                               
                               Явное шифрование/дешифрование и автоматическая расшифровка - это
                               функция Community версии. Драйвер все ещё может автоматически
                               расшифровывать, если у опции <return>bypassAutoEncryption</return> установлено
                               значение <info>true</info>.
                               
                               Поддерживаются следующие опции:
                                Опции для автоматического
                               шифрованияОпцияТипОписаниеkeyVaultClient<class>MongoDB\Driver\Manager</class>Менеджер
                               используется для маршрутизации запросов ключей данных в отдельный
                               кластер MongoDB. По умолчанию используется текущий менеджер и
                               кластер.keyVaultNamespace<info>string</info>Полное пространство имён (например,
                               <return>"databaseName.collectionName"</return>), обозначающее коллекцию, которая
                               содержит все ключи данных, используемые для шифрования и
                               дешифрования. Обязательный параметр.kmsProviders<info>array</info> Документ,
                               содержащий конфигурацию для одного или нескольких провайдеров KMS,
                               которые используются для шифрования ключей данных. Поддерживаются
                               провайдеры <return>"aws"</return>, <return>"azure"</return>, <return>"gcp"</return> и <return>"local"</return>, и, по крайней мере, один
                               из них должен быть указан.  Если для <return>"aws"</return>, <return>"azure"</return> или <return>"gcp"</return> указан
                               пустой документ, драйвер попытается сконфигурировать провайдера,
                               используя Автоматические учётные данные.  Формат для <return>"aws"</return> выглядит
                               следующим образом: , secretAccessKey: , sessionToken:
                               }
                               ]]> Формат для <return>"azure"</return> выглядит следующим образом: , clientId: ,
                               clientSecret: , identityPlatformEndpoint:  // По умолчанию
                               "login.microsoftonline.com"
                               
                               }
                               ]]> Формат для <return>"gcp"</return> выглядит следующим образом: , privateKey: |,
                               endpoint:  // По умолчанию "oauth2.googleapis.com"
                               
                               }
                               ]]> Формат для <return>"kmip"</return> выглядит следующим образом: 
                               }
                               ]]> Формат для <return>"local"</return> выглядит следующим образом: |
                               }
                               ]]>tlsOptions<info>array</info> Документ, содержащий конфигурацию TLS для одного
                               или нескольких KMS провайдеров. Поддерживаются провайдеры <return>"aws"</return>,
                               <return>"azure"</return>, <return>"gcp"</return> и <return>"kmip"</return>. Все провайдеры поддерживают следующие опции:
                               : { tlsCaFile: , tlsCertificateKeyFile: ,
                               tlsCertificateKeyFilePassword: , tlsDisableOCSPEndpointCheck:
                               }
                               ]]>schemaMap<info>array</info><info>object</info></info> Карта пространств имён коллекции в локальную
                               схему JSON. Используется для настройки автоматического шифрования.
                               Дополнительную информацию смотрите в Правилах автоматического
                               шифрования в руководстве по MongoDB. Ошибкой является указание
                               коллекции как в <return>schemaMap</return>, так и в <return>encryptedFieldsMap</return>.  Добавление
                               <return>schemaMap</return> обеспечивает большую безопасность, чем использование схем
                               JSON, полученных с сервера. Это защищает от вредоносного сервера,
                               рекламирующего ложную схему JSON, которая может заставить клиента
                               отправлять незашифрованные данные, которые должны быть зашифрованы.
                               Схемы, поставляемые в <return>schemaMap</return>, применяются только для настройки
                               автоматического шифрования на стороне клиента. Другие правила
                               проверки в схеме JSON не будут применяться драйвером и приведут к
                               ошибке. bypassAutoEncryption<info>bool</info> Если <info>true</info>, <return>mongocryptd</return> не будет
                               появляться автоматически. Используется для отключения автоматического
                               шифрования. По умолчанию <info>false</info>. bypassQueryAnalysis<info>bool</info> Если <info>true</info>,
                               автоматический анализ исходящих команд будет отключён и <return>mongocryptd</return>
                               не будет появляться автоматически. Это позволяет использовать явное
                               шифрование для запроса индексированных полей без необходимости
                               использования лицензированной корпоративной библиотеки <return>crypt_shared</return>
                               или процесса <return>mongocryptd</return>. По умолчанию установлено значение <info>false</info>.
                               encryptedFieldsMap<info>array</info><info>object</info></info> Карта пространств имён коллекции в
                               документе <return>encryptedFields</return>. Используется для настройки шифрования с
                               возможностью запроса. Смотрите Шифрование полей и возможность
                               запросов в руководстве по MongoDB для получения дополнительной
                               информации. Ошибкой является указание коллекции как в
                               <return>encryptedFieldsMap</return>, так и в <return>schemaMap</return>.  Указание <return>encryptedFieldsMap</return>
                               обеспечивает большую безопасность, чем полагаться на <return>encryptedFields</return>,
                               полученные от сервера. Это защищает от злонамеренного сервера,
                               рекламирующего ложные <return>encryptedFields</return>. extraOptions<info>array</info><return>extraOptions</return>
                               относится к процессу <return>mongocryptd</return>. Поддерживаются следующие параметры:
                               <return>mongocryptdURI</return> (<info>string</info>): URI для подключения к существующему процессу
                               <return>mongocryptd</return>. По умолчанию <return>"mongodb://localhost:27020"</return>.
                               <return>mongocryptdBypassSpawn</return> (<info>bool</info>): Если <info>true</info>, предотвращает создание
                               драйвером <return>mongocryptd</return>. По умолчанию <info>false</info>. <return>mongocryptdSpawnPath</return>
                               (<info>string</info>): Абсолютный путь для поиска двоичного файла <return>mongocryptd</return>. По
                               умолчанию это пустая строка, использующая системные пути.
                               <return>mongocryptdSpawnArgs</return> (<info>array</info>): Массив строковых аргументов для
                               передачи в <return>mongocryptd</return> при создании. По умолчанию
                               <return>["--idleShutdownTimeoutSecs=60"]</return>. <return>cryptSharedLibPath</return> (<info>string</info>):
                               Абсолютный путь к библиотеке общего доступа <return>crypt_shared</return>. По
                               умолчанию - пустая строка и использует системные пути.
                               <return>cryptSharedLibRequired</return> (<info>bool</info>): Если <info>true</info>, требует, чтобы драйвер
                               загружал <return>crypt_shared</return>. По умолчанию <info>false</info>.  Смотрите Руководство по
                               шифрованию на стороне клиента, чтобы получить больше информации.
                               
                               Документ, содержащий конфигурацию для одного или нескольких
                               провайдеров KMS, которые используются для шифрования ключей данных.
                               Поддерживаются провайдеры <return>"aws"</return>, <return>"azure"</return>, <return>"gcp"</return> и <return>"local"</return>, и, по
                               крайней мере, один из них должен быть указан.
                               
                               Если для <return>"aws"</return>, <return>"azure"</return> или <return>"gcp"</return> указан пустой документ, драйвер
                               попытается сконфигурировать провайдера, используя Автоматические
                               учётные данные.
                               
                               Формат для <return>"aws"</return> выглядит следующим образом:
                               
                               Формат для <return>"azure"</return> выглядит следующим образом:
                               
                               Формат для <return>"gcp"</return> выглядит следующим образом:
                               
                               Формат для <return>"kmip"</return> выглядит следующим образом:
                               
                               Формат для <return>"local"</return> выглядит следующим образом:
                               
                               Документ, содержащий конфигурацию TLS для одного или нескольких KMS
                               провайдеров. Поддерживаются провайдеры <return>"aws"</return>, <return>"azure"</return>, <return>"gcp"</return> и
                               <return>"kmip"</return>. Все провайдеры поддерживают следующие опции:
                               
                               Карта пространств имён коллекции в локальную схему JSON. Используется
                               для настройки автоматического шифрования. Дополнительную информацию
                               смотрите в Правилах автоматического шифрования в руководстве по
                               MongoDB. Ошибкой является указание коллекции как в <return>schemaMap</return>, так и в
                               <return>encryptedFieldsMap</return>.
                               
                               Добавление <return>schemaMap</return> обеспечивает большую безопасность, чем
                               использование схем JSON, полученных с сервера. Это защищает от
                               вредоносного сервера, рекламирующего ложную схему JSON, которая может
                               заставить клиента отправлять незашифрованные данные, которые должны
                               быть зашифрованы.
                               
                               Схемы, поставляемые в <return>schemaMap</return>, применяются только для настройки
                               автоматического шифрования на стороне клиента. Другие правила
                               проверки в схеме JSON не будут применяться драйвером и приведут к
                               ошибке.
                               
                               Карта пространств имён коллекции в документе <return>encryptedFields</return>.
                               Используется для настройки шифрования с возможностью запроса.
                               Смотрите Шифрование полей и возможность запросов в руководстве по
                               MongoDB для получения дополнительной информации. Ошибкой является
                               указание коллекции как в <return>encryptedFieldsMap</return>, так и в <return>schemaMap</return>.
                               
                               Указание <return>encryptedFieldsMap</return> обеспечивает большую безопасность, чем
                               полагаться на <return>encryptedFields</return>, полученные от сервера. Это защищает от
                               злонамеренного сервера, рекламирующего ложные <return>encryptedFields</return>.
                               
                               <return>extraOptions</return> относится к процессу <return>mongocryptd</return>. Поддерживаются
                               следующие параметры:
                               
                               Смотрите Руководство по шифрованию на стороне клиента, чтобы получить
                               больше информации.
                               
                               Автоматическое шифрование — это только корпоративная функция, которая
                               применяется только к операциям над коллекцией. Автоматическое
                               шифрование не поддерживается для операций с базой данных или
                               представлением, операции, которые не получится обойти, приведут к
                               ошибке. Чтобы обойти автоматическое шифрование для всех операций,
                               установите <return>bypassAutoEncryption=true</return> в <return>autoEncryption</return>. Для получения
                               дополнительной информации о разрешённых операциях смотрите
                               Руководство по шифрованию на стороне клиента.
                               
                               Путь к корректно захешированному каталогу сертификатов. По умолчанию
                               будет использоваться хранилище системных сертификатов.
                               
                               Путь к файлу с одним или несколькими центрами сертификации, которые
                               следует считать доверенными при установлении соединения TLS. По
                               умолчанию будет использоваться хранилище системных сертификатов.
                               
                               Параметр является устаревшим псевдонимом для параметра URI
                               <return>"tlsCAFile"</return>.
                               
                               Параметры контекста SSL для использования в качестве запасного
                               варианта, если не указана опция драйвера или эквивалентная ей опция
                               URI. Обратите внимание, что драйвер не обращается к контексту потока
                               по умолчанию (т.е. <strong>stream_context_get_default()</strong>). Поддерживаются
                               следующие параметры контекста:
                               
                               Параметр поддерживается для обратной совместимости, но его следует
                               считать устаревшим.
                               
                               Если <info>true</info>, Manager будет использовать новый клиент libmongoc, который
                               не будет сохраняться или использоваться другими объектами Manager.
                               Когда этот объект Manager будет освобождён, его клиент будет
                               уничтожен, а все соединения будут закрыты. По умолчанию <info>false</info>.
                               
                               Disabling client persistence is not generally recommended.
                               
                               Позволяет пользовательским драйверам добавлять свои метаданные к
                               рукопожатию сервера. По умолчанию драйвер передаёт своё собственное
                               имя, версию и платформу (то есть версию PHP) в рукопожатие.
                               Пользовательские драйверы могут указывать строки для ключей <return>"name"</return>,
                               <return>"version"</return> и <return>"platform"</return> этого массива, которые будут добавлены к
                               соответствующие поля в документе рукопожатия.
                               
                               Информация о рукопожатии ограничена 512 байтами. Драйвер урезает
                               данные рукопожатия, чтобы соответствовать этой 512-байтовой строке.
                               Драйверам и ODM рекомендуется сохранять краткость своих метаданных.
                               
                               Путь к сертификату в формате PEM для аутентификации клиента.
                               
                               Этот параметр является устаревшим псевдонимом для параметра URI
                               <return>"tlsCertificateKeyFile"</return>.
                               
                               Парольная фраза к PEM-закодированному сертификату (если есть).
                               
                               Этот параметр является устаревшим псевдонимом для параметра URI
                               <return>"tlsCertificateKeyFilePassword"</return>.
                               
                               Опция используется для объявления версии API сервера для менеджера.
                               Если не указана, версия API не объявляется.
                               
                               Отключает проверку сертификат, если <info>true</info>. По умолчанию - <info>false</info>
                               
                               Этот параметр является устаревшим псевдонимом для параметра URI
                               <return>"tlsAllowInvalidCertificates"</return>.

<comment>See Also:</comment>
   * Обработка подключения и сохранение
   * Формат строки соединения MongoDB


id: MongoDB\Driver\Manager::addSubscriber
type: function
doc:
<comment>Description:</comment>
  Регистрирует подписчика на событие мониторинга в данном объекте Manager
    
  
  Регистрирует подписчика на событие мониторинга в данном объекте Manager. Подписчик будет уведомлен
  обо всех событиях для этого объекта Manager.
  
  Если <strong>$subscriber</strong> уже зарегистрирован в данном объекте Manager, эта функция будет недоступна. Если
  <strong>$subscriber</strong> также зарегистрирован глобально, он всё равно будет получать уведомление только один
  раз о каждом событии для этого объекта Manager.

<comment>Param:</comment>
  <info>MongoDB\Driver\Monitoring\Subscriber</info>  <strong>$subscriber</strong>  Подписчик событий мониторинга, который должен
                                                     быть зарегистрирован в данном объекте Manager.

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

<comment>See Also:</comment>
   * <strong>MongoDB\Driver\Manager::removeSubscriber()</strong>
   * MongoDB\Driver\Monitoring\Subscriber
   * MongoDB\Driver\Monitoring\CommandSubscriber
   * <strong>MongoDB\Driver\Monitoring\addSubscriber()</strong>
   * 


id: MongoDB\Driver\Manager::createClientEncryption
type: function
doc:
<comment>Description:</comment>
  Создание нового объекта ClientEncryption
  
  Создаёт новый объект <class>MongoDB\Driver\ClientEncryption</class> с заданными параметрами.

<comment>Param:</comment>
  <info>array</info>  <strong>$options</strong>  optionsПараметрТипОписаниеkeyVaultClient<class>MongoDB\Driver\Manager</class>Менеджер
                   используется для маршрутизации запросов ключей данных в отдельный кластер
                   MongoDB. По умолчанию используется текущий менеджер и
                   кластер.keyVaultNamespace<info>string</info>Полное пространство имён (например,
                   <return>"databaseName.collectionName"</return>), обозначающее коллекцию, которая содержит все
                   ключи данных, используемые для шифрования и дешифрования. Обязательный
                   параметр.kmsProviders<info>array</info> Документ, содержащий конфигурацию для одного или
                   нескольких провайдеров KMS, которые используются для шифрования ключей данных.
                   Поддерживаются провайдеры <return>"aws"</return>, <return>"azure"</return>, <return>"gcp"</return> и <return>"local"</return>, и, по крайней мере,
                   один из них должен быть указан.  Если для <return>"aws"</return>, <return>"azure"</return> или <return>"gcp"</return> указан пустой
                   документ, драйвер попытается сконфигурировать провайдера, используя
                   Автоматические учётные данные.  Формат для <return>"aws"</return> выглядит следующим образом: ,
                   secretAccessKey: , sessionToken:
                   }
                   ]]> Формат для <return>"azure"</return> выглядит следующим образом: , clientId: , clientSecret: ,
                   identityPlatformEndpoint:  // По умолчанию "login.microsoftonline.com"
                   
                   }
                   ]]> Формат для <return>"gcp"</return> выглядит следующим образом: , privateKey: |, endpoint:  //
                   По умолчанию "oauth2.googleapis.com"
                   
                   }
                   ]]> Формат для <return>"kmip"</return> выглядит следующим образом: 
                   }
                   ]]> Формат для <return>"local"</return> выглядит следующим образом: |
                   }
                   ]]>tlsOptions<info>array</info> Документ, содержащий конфигурацию TLS для одного или
                   нескольких KMS провайдеров. Поддерживаются провайдеры <return>"aws"</return>, <return>"azure"</return>, <return>"gcp"</return> и
                   <return>"kmip"</return>. Все провайдеры поддерживают следующие опции: : { tlsCaFile: ,
                   tlsCertificateKeyFile: , tlsCertificateKeyFilePassword: ,
                   tlsDisableOCSPEndpointCheck:
                   }
                   ]]>
                   
                   Документ, содержащий конфигурацию для одного или нескольких провайдеров KMS,
                   которые используются для шифрования ключей данных. Поддерживаются провайдеры
                   <return>"aws"</return>, <return>"azure"</return>, <return>"gcp"</return> и <return>"local"</return>, и, по крайней мере, один из них должен быть
                   указан.
                   
                   Если для <return>"aws"</return>, <return>"azure"</return> или <return>"gcp"</return> указан пустой документ, драйвер попытается
                   сконфигурировать провайдера, используя Автоматические учётные данные.
                   
                   Формат для <return>"aws"</return> выглядит следующим образом:
                   
                   Формат для <return>"azure"</return> выглядит следующим образом:
                   
                   Формат для <return>"gcp"</return> выглядит следующим образом:
                   
                   Формат для <return>"kmip"</return> выглядит следующим образом:
                   
                   Формат для <return>"local"</return> выглядит следующим образом:
                   
                   Документ, содержащий конфигурацию TLS для одного или нескольких KMS провайдеров.
                   Поддерживаются провайдеры <return>"aws"</return>, <return>"azure"</return>, <return>"gcp"</return> и <return>"kmip"</return>. Все провайдеры
                   поддерживают следующие опции:

<comment>Return:</comment>
  <info>MongoDB\Driver\ClientEncryption</info>  Возвращает новый экземпляр <class>MongoDB\Driver\ClientEncryption</class>.

<comment>See Also:</comment>
   * <strong>MongoDB\Driver\ClientEncryption::__construct()</strong>
   * Страница в руководстве по MongoDB: Явное (ручное) шифрование на уровне поля на стороне клиента


id: MongoDB\Driver\Manager::executeBulkWrite
type: function
doc:
<comment>Description:</comment>
  Выполняет одну или несколько операций записи
  
  Выполняет одну или несколько операций записи на основном сервере.
  
  Объект класса <class>MongoDB\Driver\BulkWrite</class> может быть создан с одной или несколькими операциями записи
  различного типа (например, обновлениями, удалениями и вставками). Драйвер попытается отправить
  операции одного и того же типа на сервер с минимальным количества запросов, чтобы сократить
  обращения к серверу.

<comment>Param:</comment>
  <info>string</info>                    <strong>$namespace</strong>  Полностью определённое имя (т.е.
                                        <return>"databaseName.collectionName"</return>).
  <info>MongoDB\Driver\BulkWrite</info>  <strong>$bulk</strong>       Записи для выполнения.
  <info></info>                          <strong>$опции</strong>  optionsОпцияТипОписаниеsession<class>MongoDB\Driver\Session</class> Сессия
                                        для связывания с операцией.
                                        writeConcern<class>MongoDB\Driver\WriteConcern</class> Гарантия записи для
                                        применения к операции.
                                        
                                        Сессия для связывания с операцией.
                                        
                                        Гарантия записи для применения к операции.

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

<comment>See Also:</comment>
   * <class>MongoDB\Driver\BulkWrite</class>
   * <class>MongoDB\Driver\WriteResult</class>
   * <class>MongoDB\Driver\WriteConcern</class>
   * <strong>MongoDB\Driver\Server::executeBulkWrite()</strong>


id: MongoDB\Driver\Manager::executeCommand
type: function
doc:
<comment>Description:</comment>
  Выполняет команду базы данных
  
  Выбирает сервер в соответствии с опцией <return>"readPreference"</return> и выполняет запрос на этом сервере. По
  умолчанию будет использоваться предпочтение чтения из URI URI подключения MongoDB.
  
  Этот метод не применяет особую логику к команде. Хотя этот метод принимает <return>"readConcern"</return> и
  <return>"writeConcern"</return>, которые будут включены в документы коанды, эти опции не будут соответствовать
  значениям по умолчанию из MongoDB URI соединения , и не будет учитываться версия сервера MongoDB.
  Поэтому пользователям рекомендуется использовать конкретные методы команды чтения и/или записи
  если это возможно.

<comment>Param:</comment>
  <info>string</info>                                    <strong>$db</strong>       Имя базы данных, в которой запускается
                                                      команда.
  <info>MongoDB\Driver\Command</info>                    <strong>$command</strong>  Команда для выполнения.
  <info>array|MongoDB\Driver\ReadPreference|null</info>  <strong>$options</strong>  
                                                      optionsОпцияТипОписаниеreadConcern<class>MongoDB\Driver\ReadConcern</class>
                                                      Гарантия чтения для применения к операции.
                                                      Эта опция доступна в MongoDB 3.2+ и приведёт к
                                                      исключению во время выполнения, если указана
                                                      для более старой версии сервера.
                                                      readPreference<class>MongoDB\Driver\ReadPreference</class>
                                                      Предпочтение чтения, используемая для выбора
                                                      сервера для выполнения операции.
                                                      session<class>MongoDB\Driver\Session</class> Сессия для
                                                      связывания с операцией.
                                                      writeConcern<class>MongoDB\Driver\WriteConcern</class>
                                                      Гарантия записи для применения к операции.
                                                      
                                                      Гарантия чтения для применения к операции.
                                                      
                                                      Эта опция доступна в MongoDB 3.2+ и приведёт к
                                                      исключению во время выполнения, если указана
                                                      для более старой версии сервера.
                                                      
                                                      Предпочтение чтения, используемая для выбора
                                                      сервера для выполнения операции.
                                                      
                                                      Сессия для связывания с операцией.
                                                      
                                                      Гарантия записи для применения к операции.
                                                      
                                                      При использовании <return>"session"</return> и наличии
                                                      незавершённых транзакций, вы не можете указать
                                                      <return>"readConcern"</return> or <return>"writeConcern"</return> option. Это
                                                      приведёт к выбрасыванию исключения
                                                      <class>MongoDB\Driver\Exception\InvalidArgumentException</class>.
                                                      Вместо этого вы должны установить эти две
                                                      опции при создании транзакции с помощью
                                                      MongoDB\Driver\Session::startTransaction.

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

<comment>See Also:</comment>
   * <class>MongoDB\Driver\Command</class>
   * <class>MongoDB\Driver\Cursor</class>
   * <strong>MongoDB\Driver\Manager::executeReadCommand()</strong>
   * <strong>MongoDB\Driver\Manager::executeReadWriteCommand()</strong>
   * <strong>MongoDB\Driver\Manager::executeWriteCommand()</strong>
   * <strong>MongoDB\Driver\Server::executeCommand()</strong>


id: MongoDB\Driver\Manager::executeQuery
type: function
doc:
<comment>Description:</comment>
  Выполняет запрос к базе данных
  
  Выбирает сервер в соответствии с опцией <return>"readPreference"</return> и выполняет запрос на этом сервере. По
  умолчанию будет использоваться предпочтение чтения из URI URI подключения MongoDB.

<comment>Param:</comment>
  <info>string</info>                                    <strong>$namespace</strong>  Полностью определённое имя (т.е.
                                                        <return>"databaseName.collectionName"</return>).
  <info>MongoDB\Driver\Query</info>                      <strong>$query</strong>      Запрос для выполнения.
  <info>array|MongoDB\Driver\ReadPreference|null</info>  <strong>$options</strong>    
                                                        optionsОпцияТипОписаниеreadPreference<class>MongoDB\Driver\ReadPreference</class>
                                                        Предпочтение чтения, используемая для выбора
                                                        сервера для выполнения операции.
                                                        session<class>MongoDB\Driver\Session</class> Сессия для
                                                        связывания с операцией.
                                                        
                                                        Предпочтение чтения, используемая для выбора
                                                        сервера для выполнения операции.
                                                        
                                                        Сессия для связывания с операцией.

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

<comment>See Also:</comment>
   * <class>MongoDB\Driver\Cursor</class>
   * <class>MongoDB\Driver\Query</class>
   * <class>MongoDB\Driver\ReadPreference</class>
   * <strong>MongoDB\Driver\Server::executeQuery()</strong>


id: MongoDB\Driver\Manager::executeReadCommand
type: function
doc:
<comment>Description:</comment>
  Выполняет команду базы данных, которая читает
  
  Выбирает сервер в соответствии с опцией <return>"readPreference"</return> и выполняет команду на сервере. По
  умолчанию будет использоваться предпочтение чтения из URI подключения MongoDB.
  
  Этот метод будет применять логику, специфичную для команд, которые читают (например, count) и
  учитывают версию сервера MongoDB. Опция <return>"readConcern"</return> будет по умолчанию соответствовать
  соответствующему значению из URI подключения MongoDB.

<comment>Param:</comment>
  <info>string</info>                  <strong>$db</strong>       Имя базы данных, в которой запускается команда.
  <info>MongoDB\Driver\Command</info>  <strong>$command</strong>  Команда для выполнения.
  <info>array|null</info>              <strong>$options</strong>  optionsОпцияТипОписаниеreadConcern<class>MongoDB\Driver\ReadConcern</class>
                                    Гарантия чтения для применения к операции.  Эта опция доступна в
                                    MongoDB 3.2+ и приведёт к исключению во время выполнения, если
                                    указана для более старой версии сервера.
                                    readPreference<class>MongoDB\Driver\ReadPreference</class> Предпочтение чтения,
                                    используемая для выбора сервера для выполнения операции.
                                    session<class>MongoDB\Driver\Session</class> Сессия для связывания с операцией.
                                    
                                    Гарантия чтения для применения к операции.
                                    
                                    Эта опция доступна в MongoDB 3.2+ и приведёт к исключению во
                                    время выполнения, если указана для более старой версии сервера.
                                    
                                    Предпочтение чтения, используемая для выбора сервера для
                                    выполнения операции.
                                    
                                    Сессия для связывания с операцией.
                                    
                                    При использовании <return>"session"</return> и наличии незавершённых транзакций,
                                    вы не можете указать <return>"readConcern"</return> or <return>"writeConcern"</return> option. Это
                                    приведёт к выбрасыванию исключения
                                    <class>MongoDB\Driver\Exception\InvalidArgumentException</class>. Вместо этого
                                    вы должны установить эти две опции при создании транзакции с
                                    помощью MongoDB\Driver\Session::startTransaction.

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

<comment>See Also:</comment>
   * <class>MongoDB\Driver\Command</class>
   * <class>MongoDB\Driver\Cursor</class>
   * <strong>MongoDB\Driver\Manager::executeCommand()</strong>
   * <strong>MongoDB\Driver\Manager::executeReadWriteCommand()</strong>
   * <strong>MongoDB\Driver\Manager::executeWriteCommand()</strong>
   * <strong>MongoDB\Driver\Server::executeReadCommand()</strong>


id: MongoDB\Driver\Manager::executeReadWriteCommand
type: function
doc:
<comment>Description:</comment>
  Выполняет команду базы данных, которая читает и пишет
  
  Выполняет команду на основном сервере.
  
  Этот метод будет применять логику, специфичную для команд, которые читают и пишут (например,
  aggregate) и учитывают версию сервера MongoDB. Параметры <return>"readConcern"</return> и <return>"writeConcern"</return> по
  умолчанию соответствуют соответствующим значениям из URI подключения MongoDB.

<comment>Param:</comment>
  <info>string</info>                  <strong>$db</strong>       Имя базы данных, в которой запускается команда.
  <info>MongoDB\Driver\Command</info>  <strong>$command</strong>  Команда для выполнения.
  <info>array|null</info>              <strong>$options</strong>  optionsОпцияТипОписаниеreadConcern<class>MongoDB\Driver\ReadConcern</class>
                                    Гарантия чтения для применения к операции.  Эта опция доступна в
                                    MongoDB 3.2+ и приведёт к исключению во время выполнения, если
                                    указана для более старой версии сервера.
                                    session<class>MongoDB\Driver\Session</class> Сессия для связывания с операцией.
                                    writeConcern<class>MongoDB\Driver\WriteConcern</class> Гарантия записи для
                                    применения к операции.
                                    
                                    Гарантия чтения для применения к операции.
                                    
                                    Эта опция доступна в MongoDB 3.2+ и приведёт к исключению во
                                    время выполнения, если указана для более старой версии сервера.
                                    
                                    Сессия для связывания с операцией.
                                    
                                    Гарантия записи для применения к операции.
                                    
                                    При использовании <return>"session"</return> и наличии незавершённых транзакций,
                                    вы не можете указать <return>"readConcern"</return> or <return>"writeConcern"</return> option. Это
                                    приведёт к выбрасыванию исключения
                                    <class>MongoDB\Driver\Exception\InvalidArgumentException</class>. Вместо этого
                                    вы должны установить эти две опции при создании транзакции с
                                    помощью MongoDB\Driver\Session::startTransaction.

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

<comment>See Also:</comment>
   * <class>MongoDB\Driver\Command</class>
   * <class>MongoDB\Driver\Cursor</class>
   * <strong>MongoDB\Driver\Manager::executeCommand()</strong>
   * <strong>MongoDB\Driver\Manager::executeReadCommand()</strong>
   * <strong>MongoDB\Driver\Manager::executeWriteCommand()</strong>
   * <strong>MongoDB\Driver\Server::executeReadWriteCommand()</strong>


id: MongoDB\Driver\Manager::executeWriteCommand
type: function
doc:
<comment>Description:</comment>
  Выполняет команду базы данных, которая пишет
  
  Выполняет команду на основном сервере.
  
  Этот метод будет применять логику, специфичную для команд, которые пишут (например, drop) и
  учитывают версию сервера MongoDB. Опция <return>"writeConcern"</return> по умолчанию будет соответствовать значению
  из URI подключения MongoDB.
  
  Метод не предназначен для выполнения insert, update, или delete команд. Пользователям
  рекомендуется использовать   <strong>MongoDB\Driver\Manager::executeBulkWrite()</strong> для этих команд.

<comment>Param:</comment>
  <info>string</info>                  <strong>$db</strong>       Имя базы данных, в которой запускается команда.
  <info>MongoDB\Driver\Command</info>  <strong>$command</strong>  Команда для выполнения.
  <info>array|null</info>              <strong>$options</strong>  optionsОпцияТипОписаниеsession<class>MongoDB\Driver\Session</class> Сессия для
                                    связывания с операцией. writeConcern<class>MongoDB\Driver\WriteConcern</class>
                                    Гарантия записи для применения к операции.
                                    
                                    Сессия для связывания с операцией.
                                    
                                    Гарантия записи для применения к операции.
                                    
                                    При использовании <return>"session"</return> и наличии незавершённых транзакций,
                                    вы не можете указать <return>"readConcern"</return> or <return>"writeConcern"</return> option. Это
                                    приведёт к выбрасыванию исключения
                                    <class>MongoDB\Driver\Exception\InvalidArgumentException</class>. Вместо этого
                                    вы должны установить эти две опции при создании транзакции с
                                    помощью MongoDB\Driver\Session::startTransaction.

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

<comment>See Also:</comment>
   * <class>MongoDB\Driver\Command</class>
   * <class>MongoDB\Driver\Cursor</class>
   * <strong>MongoDB\Driver\Manager::executeCommand()</strong>
   * <strong>MongoDB\Driver\Manager::executeReadCommand()</strong>
   * <strong>MongoDB\Driver\Manager::executeReadWriteCommand()</strong>
   * <strong>MongoDB\Driver\Server::executeWriteCommand()</strong>


id: MongoDB\Driver\Manager::getEncryptedFieldsMap
type: function
doc:
<comment>Description:</comment>
  Возвращает опцию автоматического шифрования encryptedFieldsMap для Manager
  
  Возвращает параметр <return>encryptedFieldsMap</return> автоматического шифрования для Manager, если он указан.

<comment>Return:</comment>
  <info>array|object|null</info>  Параметр <return>encryptedFieldsMap</return> автоматического шифрования для Manager или <info>null</info>,
                     если он не был указан.

<comment>See Also:</comment>
   * <strong>MongoDB\Driver\Manager::__construct()</strong>


id: MongoDB\Driver\Manager::getReadConcern
type: function
doc:
<comment>Description:</comment>
  Возвращает ReadConcern для Manager
  
  Возвращает <class>MongoDB\Driver\ReadConcern</class> для Manager, полученный из его URI-опций. Это гарантия
  чтения по умолчанию для запросов и команд, выполняемых в Manager.

<comment>Return:</comment>
  <info>MongoDB\Driver\ReadConcern</info>  <class>MongoDB\Driver\ReadConcern</class> для Manager.

<comment>See Also:</comment>
   * <class>MongoDB\Driver\ReadConcern</class>
   * <strong>MongoDB\Driver\Manager::__construct()</strong>


id: MongoDB\Driver\Manager::getReadPreference
type: function
doc:
<comment>Description:</comment>
  Возвращает ReadPreference для Manager
  
  Возвращает <class>MongoDB\Driver\ReadPreference</class> для Manager, полученный из его URI-опций. Это
  предпочтение чтения по умолчанию для запросов и команд, выполняемых в Manager.

<comment>Return:</comment>
  <info>MongoDB\Driver\ReadPreference</info>  Возвращает <class>MongoDB\Driver\ReadPreference</class> для Manager.

<comment>See Also:</comment>
   * <class>MongoDB\Driver\ReadPreference</class>
   * <strong>MongoDB\Driver\Manager::__construct()</strong>


id: MongoDB\Driver\Manager::getServers
type: function
doc:
<comment>Description:</comment>
  Возвращает серверы, к которым подключён менеджер
  
  Возвращает массив (<info>array</info>) экземпляров <class>MongoDB\Driver\Server</class>, к которым подключён текущий менеджер.
  
  Поскольку драйвер подключается к базе данных лениво, этот метод может возвращать пустой массив
  (<info>array</info>), если он вызывается перед выполнением операции в <class>MongoDB\Driver\Manager</class>.

<comment>Return:</comment>
  <info>array</info>  Возвращает массив (<info>array</info>) экземпляров <class>MongoDB\Driver\Server</class>, к которым подключён менеджер.

<comment>See Also:</comment>
   * <class>MongoDB\Driver\Server</class>
   * <strong>MongoDB\Driver\Manager::selectServer()</strong>


id: MongoDB\Driver\Manager::getWriteConcern
type: function
doc:
<comment>Description:</comment>
  Возвращает WriteConcern для Manager
  
  Возвращает <class>MongoDB\Driver\WriteConcern</class> для Manager, полученный из его URI-опций. Это гарантия
  записи по умолчанию для запросов и команд, выполняемых в Manager.

<comment>Return:</comment>
  <info>MongoDB\Driver\WriteConcern</info>  <class>MongoDB\Driver\WriteConcern</class> для Manager.

<comment>See Also:</comment>
   * <class>MongoDB\Driver\WriteConcern</class>
   * <strong>MongoDB\Driver\Manager::__construct()</strong>


id: MongoDB\Driver\Manager::removeSubscriber
type: function
doc:
<comment>Description:</comment>
  Отменяет регистрацию подписчика на событие мониторинга в данном объекте Manager
    
  
  Отменяет регистрацию подписчика на событие мониторинга в данном объекте Manager.
  
  Если <strong>$subscriber</strong> ещё не зарегистрирован в данном объекте Manager, функция отработает без
  результата.

<comment>Param:</comment>
  <info>MongoDB\Driver\Monitoring\Subscriber</info>  <strong>$subscriber</strong>  Подписчик на событие мониторинга, которому
                                                     необходимо отменить регистрацию в данном
                                                     объекте Manager.

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

<comment>See Also:</comment>
   * <strong>MongoDB\Driver\Manager::addSubscriber()</strong>
   * MongoDB\Driver\Monitoring\Subscriber
   * MongoDB\Driver\Monitoring\CommandSubscriber
   * <strong>MongoDB\Driver\Monitoring\removeSubscriber()</strong>
   * 


id: MongoDB\Driver\Manager::selectServer
type: function
doc:
<comment>Description:</comment>
  Выбрать сервер, соответствующий предпочтениям чтения
  
  Выбирает <class>MongoDB\Driver\Server</class>, соответствующий <strong>$readPreference</strong>. Если параметр <strong>$readPreference</strong>
  равен <info>null</info> или опущен, по умолчанию будет выбран первичный сервер. Это можно использовать для
  предварительного выбора сервера, чтобы выполнить проверку версии перед выполнением операции.
  
  В отличие от <strong>MongoDB\Driver\Manager::getServers()</strong>, этот метод будет инициализировать подключение к
  базе данных и при необходимости выполнять обнаружение сервера. Подробнее смотрите. Спецификацию
  выбора сервера.

<comment>Param:</comment>
  <info>MongoDB\Driver\ReadPreference|null</info>  <strong>$readPreference</strong>  Предпочтение чтения используется для выбора
                                                       сервера. Если <info>null</info> или опущен, по умолчанию
                                                       будет выбран первичный сервер.

<comment>Return:</comment>
  <info>MongoDB\Driver\Server</info>  Возвращает <class>MongoDB\Driver\Server</class>, соответствующий предпочтению чтения.

<comment>See Also:</comment>
   * <class>MongoDB\Driver\Server</class>
   * <strong>MongoDB\Driver\Manager::getServers()</strong>
   * Спецификация выбора сервера


id: MongoDB\Driver\Manager::startSession
type: function
doc:
<comment>Description:</comment>
  Запускает новый клиентский сеанс для использования с этим клиентом
  
  Создаёт <class>MongoDB\Driver\Session</class> для указанных параметров. Сеанс затем может быть указан при
  выполнении команд, запросов и операций записи.
  
  <class>MongoDB\Driver\Session</class> может использоваться только с <class>MongoDB\Driver\Manager</class>, из которого он был
  создан.

<comment>Param:</comment>
  <info>array|null</info>  <strong>$options</strong>  optionsОпцияТипОписаниеПо умолчаниюcausalConsistency<info>bool</info> Настраивает
                        причинную согласованность в сеансе. Если <info>true</info>, каждая операция в сеансе
                        будет причинно упорядочена после предыдущей операции чтения или записи.
                        Установите на <info>false</info>, чтобы отключить причинную согласованность.  Смотрите
                        Причинную согласованность в руководстве MongoDB для получения дополнительной
                        информации. <info>true</info>defaultTransactionOptions<info>array</info> Параметры по умолчанию для
                        применения к вновь создаваемым транзакциям. Эти параметры используются, если
                        они не переопределяются, когда транзакция запускается с различным значением
                        для каждого параметра. optionsОпцияТипОписаниеmaxCommitTimeMSinteger
                        Максимальный период времени в миллисекундах, в течение которого может
                        выполняться одна команда <return>commitTransaction</return>.  Если указано, <return>maxCommitTimeMS</return>
                        должно быть 32-разрядным целым числом со знаком, большим или равным нулю.
                        readConcern<class>MongoDB\Driver\ReadConcern</class> Гарантия чтения для применения к
                        операции.  Эта опция доступна в MongoDB 3.2+ и приведёт к исключению во
                        время выполнения, если указана для более старой версии сервера.
                        readPreference<class>MongoDB\Driver\ReadPreference</class> Предпочтение чтения,
                        используемая для выбора сервера для выполнения операции.
                        writeConcern<class>MongoDB\Driver\WriteConcern</class> Гарантия записи для применения к
                        операции.  Эта опция доступна в MongoDB 4.0+. <return>[]</return>snapshot<info>bool</info> Опция
                        настраивает чтение моментальных снимков в сессии. Если <info>true</info>, временная метка
                        будет получена из первой поддерживаемой операции чтения в сессии (т.е. <return>find</return>,
                        <return>aggregate</return> или unsharded <return>distinct</return>). Последующие операции чтения в рамках
                        сессии будут затем использовать уровень гарантии чтения <return>"snapshot"</return> для
                        чтения данных, подтверждённых большинством, из этой временной метки.
                        Установите значение <info>false</info> для отключения чтения моментальных снимков.  Для
                        чтения моментальных снимков требуется MongoDB 5.0+, и их нельзя использовать
                        с причинно-согласованной связью, транзакциями или операциями записи. Если
                        <return>"snapshot"</return> равен <info>true</info>, <return>"causalConsistency"</return> по умолчанию будет <info>false</info>.
                        Смотрите гарантию чтения "snapshot" в руководстве MongoDB для получения
                        дополнительной информации. <info>false</info>
                        
                        Настраивает причинную согласованность в сеансе. Если <info>true</info>, каждая операция в
                        сеансе будет причинно упорядочена после предыдущей операции чтения или
                        записи. Установите на <info>false</info>, чтобы отключить причинную согласованность.
                        
                        Смотрите Причинную согласованность в руководстве MongoDB для получения
                        дополнительной информации.
                        
                        Параметры по умолчанию для применения к вновь создаваемым транзакциям. Эти
                        параметры используются, если они не переопределяются, когда транзакция
                        запускается с различным значением для каждого параметра.
                        
                        optionsОпцияТипОписаниеmaxCommitTimeMSinteger Максимальный период времени в
                        миллисекундах, в течение которого может выполняться одна команда
                        <return>commitTransaction</return>.  Если указано, <return>maxCommitTimeMS</return> должно быть 32-разрядным
                        целым числом со знаком, большим или равным нулю.
                        readConcern<class>MongoDB\Driver\ReadConcern</class> Гарантия чтения для применения к
                        операции.  Эта опция доступна в MongoDB 3.2+ и приведёт к исключению во
                        время выполнения, если указана для более старой версии сервера.
                        readPreference<class>MongoDB\Driver\ReadPreference</class> Предпочтение чтения,
                        используемая для выбора сервера для выполнения операции.
                        writeConcern<class>MongoDB\Driver\WriteConcern</class> Гарантия записи для применения к
                        операции.
                        
                        Максимальный период времени в миллисекундах, в течение которого может
                        выполняться одна команда <return>commitTransaction</return>.
                        
                        Если указано, <return>maxCommitTimeMS</return> должно быть 32-разрядным целым числом со
                        знаком, большим или равным нулю.
                        
                        Гарантия чтения для применения к операции.
                        
                        Эта опция доступна в MongoDB 3.2+ и приведёт к исключению во время
                        выполнения, если указана для более старой версии сервера.
                        
                        Предпочтение чтения, используемая для выбора сервера для выполнения
                        операции.
                        
                        Гарантия записи для применения к операции.
                        
                        Эта опция доступна в MongoDB 4.0+.
                        
                        Опция настраивает чтение моментальных снимков в сессии. Если <info>true</info>, временная
                        метка будет получена из первой поддерживаемой операции чтения в сессии (т.е.
                        <return>find</return>, <return>aggregate</return> или unsharded <return>distinct</return>). Последующие операции чтения в
                        рамках сессии будут затем использовать уровень гарантии чтения <return>"snapshot"</return>
                        для чтения данных, подтверждённых большинством, из этой временной метки.
                        Установите значение <info>false</info> для отключения чтения моментальных снимков.
                        
                        Для чтения моментальных снимков требуется MongoDB 5.0+, и их нельзя
                        использовать с причинно-согласованной связью, транзакциями или операциями
                        записи. Если <return>"snapshot"</return> равен <info>true</info>, <return>"causalConsistency"</return> по умолчанию будет
                        <info>false</info>.
                        
                        Смотрите гарантию чтения "snapshot" в руководстве MongoDB для получения
                        дополнительной информации.

<comment>Return:</comment>
  <info>MongoDB\Driver\Session</info>  Возвращает <class>MongoDB\Driver\Session</class>.

<comment>See Also:</comment>
   * <class>MongoDB\Driver\Session</class>
   * Причинная согласованность в руководстве MongoDB


id: MongoDB\Driver\Monitoring\CommandFailedEvent
type: class
doc:
<comment>Description:</comment>
  Класс <class>MongoDB\Driver\Monitoring\CommandFailedEvent</class> содержит информацию о неудачной команде.


id: MongoDB\Driver\Monitoring\CommandFailedEvent::getCommandName
type: function
doc:
<comment>Description:</comment>
  Возвращает имя команды
  
  Возвращает имя команды (например, <return>"find"</return>, <return>"aggregate"</return>).

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

<comment>See Also:</comment>
   * 


id: MongoDB\Driver\Monitoring\CommandFailedEvent::getDurationMicros
type: function
doc:
<comment>Description:</comment>
  Возвращает длительность команды в микросекундах
  
  Длительность команды - это рассчитанное значение, которое включает время отправки сообщения и
  получение ответа от сервера.

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

<comment>See Also:</comment>
   * 


id: MongoDB\Driver\Monitoring\CommandFailedEvent::getError
type: function
doc:
<comment>Description:</comment>
  Возвращает исключение, связанное с неудачной командой

<comment>Return:</comment>
  <info>Exception</info>  Возвращает исключение (<class>Exception</class>), связанное с неудачной командой.

<comment>See Also:</comment>
   * 


id: MongoDB\Driver\Monitoring\CommandFailedEvent::getOperationId
type: function
doc:
<comment>Description:</comment>
  Возвращает идентификатор операции команды
  
  Идентификатор операции генерируется драйвером и может использоваться для связывания событий
  вместе, таких как операций массовой записи, которые могут быть разделены на несколько команд на
  уровне протокола.
  
  Поскольку несколько команд могут совместно использовать один и тот же идентификатор операции,
  нецелесообразно использовать его для связывания объектов событий друг с другом. Вместо этого
  следует использовать идентификатор запроса, возвращённый
  MongoDB\Driver\Monitoring\CommandFailedEvent::getRequestId.

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

<comment>See Also:</comment>
   * MongoDB\Driver\Monitoring\CommandStartedEvent::getOperationId
   * MongoDB\Driver\Monitoring\CommandFailedEvent::getRequestId
   * 


id: MongoDB\Driver\Monitoring\CommandFailedEvent::getReply
type: function
doc:
<comment>Description:</comment>
  Возвращает документ ответа команды
  
  Ответный документ будет преобразован из BSON в PHP с использованием правил десериализации по
  умолчанию (например, документы BSON будут преобразованы в <info>stdClass</info>).

<comment>Return:</comment>
  <info>object</info>  Возвращает документ ответа команды в виде объекта <class>stdClass</class>.

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


id: MongoDB\Driver\Monitoring\CommandFailedEvent::getRequestId
type: function
doc:
<comment>Description:</comment>
  Возвращает идентификатор запроса команды
  
  Идентификатор запроса генерируется драйвером и может использоваться для связывания
  <class>MongoDB\Driver\Monitoring\CommandFailedEvent</class> с предыдущим
  <class>MongoDB\Driver\Monitoring\CommandStartedEvent</class>.

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

<comment>See Also:</comment>
   * MongoDB\Driver\Monitoring\CommandStartedEvent::getRequestId
   * 


id: MongoDB\Driver\Monitoring\CommandFailedEvent::getServer
type: function
doc:
<comment>Description:</comment>
  Возвращает сервер, на котором была выполнена команда
  
  Возвращает <class>MongoDB\Driver\Server</class>, на котором была выполнена команда.

<comment>Return:</comment>
  <info>MongoDB\Driver\Server</info>  Возвращает <class>MongoDB\Driver\Server</class>, на котором была выполнена команда.

<comment>See Also:</comment>
   * MongoDB\Driver\Monitoring\CommandStartedEvent::getServer
   * 


id: MongoDB\Driver\Monitoring\CommandFailedEvent::getServerConnectionId
type: function
doc:
<comment>Description:</comment>
  Возвращает идентификатор соединения с сервером для команды
  
  Возвращает идентификатор соединения с сервером для команды. Идентификатор подключения к серверу
  отличается от сервера (т.е. <strong>MongoDB\Driver\Monitoring\CommandFailedEvent::getServer()</strong>) и
  возвращается в поле "connectionId" ответа команды <return>hello</return> в MongoDB 4.2+.

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


id: MongoDB\Driver\Monitoring\CommandFailedEvent::getServiceId
type: function
doc:
<comment>Description:</comment>
  Возвращает идентификатор службы балансировщика нагрузки для команды
  
  Если драйвер подключён к кластеру MongoDB через балансировщик нагрузки, идентификатор службы
  соответствует полю <return>serviceId</return> в ответе на команду <return>hello</return>.

<comment>Return:</comment>
  <info>MongoDB\BSON\ObjectId|null</info>  Возвращает идентификатор службы балансировщика нагрузки или <info>null</info>, если
                              драйвер не подключён к балансировщику нагрузки.


id: MongoDB\Driver\Monitoring\CommandStartedEvent
type: class
doc:
<comment>Description:</comment>
  Класс <class>MongoDB\Driver\Monitoring\CommandStartedEvent</class> содержит информацию о запущенной команды.


id: MongoDB\Driver\Monitoring\CommandStartedEvent::getCommand
type: function
doc:
<comment>Description:</comment>
  Возвращает документ команды
  
  Документ ответа будет преобразован из BSON в PHP используя правила десериализации (например,
  документы BSON будут преобразованы в <info>stdClass</info>).

<comment>Return:</comment>
  <info>object</info>  Возвращает документ команды в виде объекта <class>stdClass</class>.

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


id: MongoDB\Driver\Monitoring\CommandStartedEvent::getDatabaseName
type: function
doc:
<comment>Description:</comment>
  Возвращает базу данных, на которой выполнялась команда

<comment>Return:</comment>
  <info>string</info>  Возвращает базу данных, на которой была выполнена команда.

<comment>See Also:</comment>
   * 


id: MongoDB\Driver\Monitoring\CommandStartedEvent::getOperationId
type: function
doc:
<comment>Description:</comment>
  Возвращает идентификатор операции команды
  
  Идентификатор операции генерируется драйвером и может использоваться для связывания событий
  вместе, таких как операций массовой записи, которые могут быть разделены на несколько команд на
  уровне протокола.
  
  Поскольку несколько команд могут совместно использовать один и тот же идентификатор операции,
  нецелесообразно использовать его для связывания объектов событий друг с другом. Вместо этого
  следует использовать идентификатор запроса, возвращённый
  MongoDB\Driver\Monitoring\CommandStartedEvent::getRequestId.

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

<comment>See Also:</comment>
   * MongoDB\Driver\Monitoring\CommandFailedEvent::getOperationId
   * MongoDB\Driver\Monitoring\CommandSucceededEvent::getOperationId
   * MongoDB\Driver\Monitoring\CommandStartedEvent::getRequestId
   * 


id: MongoDB\Driver\Monitoring\CommandStartedEvent::getRequestId
type: function
doc:
<comment>Description:</comment>
  Возвращает идентификатор запроса команды
  
  Идентификатор запроса генерируется драйвером и может использоваться для связывания
  <class>MongoDB\Driver\Monitoring\CommandStartedEvent</class> с последующим
  <class>MongoDB\Driver\Monitoring\CommandFailedEvent</class> или <class>MongoDB\Driver\Monitoring\CommandSucceededEvent</class>.

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

<comment>See Also:</comment>
   * MongoDB\Driver\Monitoring\CommandFailedEvent::getRequestId
   * MongoDB\Driver\Monitoring\CommandSucceededEvent::getRequestId
   * 


id: MongoDB\Driver\Monitoring\CommandStartedEvent::getServer
type: function
doc:
<comment>Description:</comment>
  Возвращает сервер, на котором была выполнена команда
  
  Возвращает <class>MongoDB\Driver\Server</class>, на котором была выполнена команда.

<comment>Return:</comment>
  <info>MongoDB\Driver\Server</info>  Возвращает <class>MongoDB\Driver\Server</class>, на котором была выполнена команда.

<comment>See Also:</comment>
   * MongoDB\Driver\Monitoring\CommandFailedEvent::getServer
   * MongoDB\Driver\Monitoring\CommandSucceededEvent::getServer
   * 


id: MongoDB\Driver\Monitoring\CommandStartedEvent::getServerConnectionId
type: function
doc:
<comment>Description:</comment>
  Возвращает идентификатор соединения с сервером для команды
  
  Возвращает идентификатор соединения с сервером для команды. Идентификатор соединения с сервером
  отличается от сервера (т.е. <strong>MongoDB\Driver\Monitoring\CommandStartedEvent::getServer()</strong>) и
  возвращается в поле "connectionId" из ответа команды <return>hello</return> в MongoDB 4.2+.

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


id: MongoDB\Driver\Monitoring\CommandSubscriber
type: class
doc:
<comment>Description:</comment>
  Классы могут реализовать этот интерфейс для регистрации подписчика событий, который уведомляется о
  каждом, успешном или неудачном событии команды. Для подробной информации смотрите .


id: MongoDB\Driver\Monitoring\CommandSubscriber::commandFailed
type: function
doc:
<comment>Description:</comment>
  Метод уведомления о неудачной команде
  
  Если подписчик зарегистрирован, драйвер вызовет этот метод в случае возникновения ошибки команды.

<comment>Param:</comment>
  <info>MongoDB\Driver\Monitoring\CommandFailedEvent</info>  <strong>$event</strong>  Объект события, содержащий информацию о
                                                        неудачной команде.

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

<comment>See Also:</comment>
   * <class>MongoDB\Driver\Monitoring\CommandFailedEvent</class>
   * <strong>MongoDB\Driver\Monitoring\addSubscriber()</strong>
   * <strong>MongoDB\Driver\Manager::addSubscriber()</strong>
   * 


id: MongoDB\Driver\Monitoring\CommandSubscriber::commandStarted
type: function
doc:
<comment>Description:</comment>
  Метод уведомления о запущенной команде
  
  Если подписчик зарегистрирован, драйвер вызовет этот метод при запуске команды.

<comment>Param:</comment>
  <info>MongoDB\Driver\Monitoring\CommandStartedEvent</info>  <strong>$event</strong>  Объект события, содержащий информацию о
                                                         запущенной команде.

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

<comment>See Also:</comment>
   * <class>MongoDB\Driver\Monitoring\CommandStartedEvent</class>
   * <strong>MongoDB\Driver\Monitoring\addSubscriber()</strong>
   * <strong>MongoDB\Driver\Manager::addSubscriber()</strong>
   * 


id: MongoDB\Driver\Monitoring\CommandSubscriber::commandSucceeded
type: function
doc:
<comment>Description:</comment>
  Метод уведомления об успешной команде
  
  Если подписчик зарегистрирован, драйвер вызовет этот метод в случае успешного выполнения команды.

<comment>Param:</comment>
  <info>MongoDB\Driver\Monitoring\CommandSucceededEvent</info>  <strong>$event</strong>  Объект события, содержащий информацию об
                                                           успешной команде.

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

<comment>See Also:</comment>
   * <class>MongoDB\Driver\Monitoring\CommandSucceededEvent</class>
   * <strong>MongoDB\Driver\Monitoring\addSubscriber()</strong>
   * <strong>MongoDB\Driver\Manager::addSubscriber()</strong>
   * 


id: MongoDB\Driver\Monitoring\CommandSucceededEvent
type: class
doc:
<comment>Description:</comment>
  Класс <class>MongoDB\Driver\Monitoring\CommandSucceededEvent</class> содержит информацию об успешной команде.


id: MongoDB\Driver\Monitoring\CommandSucceededEvent::getOperationId
type: function
doc:
<comment>Description:</comment>
  Возвращает идентификатор операции команды
  
  Идентификатор операции генерируется драйвером и может использоваться для связывания событий
  вместе, таких как операций массовой записи, которые могут быть разделены на несколько команд на
  уровне протокола.
  
  Поскольку несколько команд могут совместно использовать один и тот же идентификатор операции,
  нецелесообразно использовать его для связывания объектов событий друг с другом. Вместо этого
  следует использовать идентификатор запроса, возвращённый
  MongoDB\Driver\Monitoring\CommandSucceededEvent::getRequestId.

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

<comment>See Also:</comment>
   * MongoDB\Driver\Monitoring\CommandStartedEvent::getOperationId
   * MongoDB\Driver\Monitoring\CommandSucceededEvent::getRequestId
   * 


id: MongoDB\Driver\Monitoring\CommandSucceededEvent::getReply
type: function
doc:
<comment>Description:</comment>
  Возвращает документ ответа команды
  
  Документ ответа будет преобразован из BSON в PHP с использованием правил десериализации (например,
  документы BSON будут преобразованы в <info>stdClass</info>).

<comment>Return:</comment>
  <info>object</info>  Возвращает документ ответа команды в виде объекта <class>stdClass</class>.

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


id: MongoDB\Driver\Monitoring\CommandSucceededEvent::getRequestId
type: function
doc:
<comment>Description:</comment>
  Возвращает идентификатор запроса команды
  
  Идентификатор запроса генерируется драйвером и может использоваться для связывания
  <class>MongoDB\Driver\Monitoring\CommandSucceededEvent</class> с предыдущим
  <class>MongoDB\Driver\Monitoring\CommandStartedEvent</class>.

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

<comment>See Also:</comment>
   * MongoDB\Driver\Monitoring\CommandStartedEvent::getRequestId
   * 


id: MongoDB\Driver\Monitoring\CommandSucceededEvent::getServer
type: function
doc:
<comment>Description:</comment>
  Возвращает сервер, на котором была выполнена команда
  
  Возвращает <class>MongoDB\Driver\Server</class>, на котором была выполнена команда.

<comment>Return:</comment>
  <info>MongoDB\Driver\Server</info>  Возвращает <class>MongoDB\Driver\Server</class>, на котором была выполнена команда.

<comment>See Also:</comment>
   * MongoDB\Driver\Monitoring\CommandStartedEvent::getServer
   * MongoDB\Driver\Cursor::getServer
   * MongoDB\Driver\WriteResult::getServer
   * 


id: MongoDB\Driver\Monitoring\CommandSucceededEvent::getServerConnectionId
type: function
doc:
<comment>Description:</comment>
  Возвращает идентификатор соединения с сервером для команды
  
  Возвращает идентификатор соединения с сервером для команды. Идентификатор соединения с сервером
  отличается от сервера (т.е. <strong>MongoDB\Driver\Monitoring\CommandSucceededEvent::getServer()</strong>) и
  возвращается в поле "connectionId" из ответа команды <return>hello</return> в MongoDB 4.2+.

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


id: MongoDB\Driver\Monitoring\LogSubscriber
type: class
doc:
<comment>Description:</comment>
  Classes implementing this interface may be registered as a subscriber and receive log messages
  from the driver. This is similar to stream-based debug logging (i.e. mongodb.debug) except that
  trace-level log messages are not received.
  
  As with stream-based logging, it is only possible to register a logger globally using
  <strong>MongoDB\Driver\Monitoring\addSubscriber()</strong>. The driver is not able to distinguish log messages for
  individual <class>MongoDB\Driver\Manager</class> objects.


id: MongoDB\Driver\Monitoring\LogSubscriber::LEVEL_CRITICAL
type: constant
doc:
<comment>Description:</comment>
  Critical log level. An error condition with slightly less severity. This constant exists for
  consistency with libmongoc; however, the driver is unlikely to use it in practice.


id: MongoDB\Driver\Monitoring\LogSubscriber::LEVEL_DEBUG
type: constant
doc:
<comment>Description:</comment>
  Debug log level. Detailed information that may be helpful when debugging an application.


id: MongoDB\Driver\Monitoring\LogSubscriber::LEVEL_ERROR
type: constant
doc:
<comment>Description:</comment>
  Error log level. An error condition that the driver is unable to report through its API. This is
  the most severe log level in the driver.


id: MongoDB\Driver\Monitoring\LogSubscriber::LEVEL_INFO
type: constant
doc:
<comment>Description:</comment>
  Info log level. High-level information about normal driver behavior.


id: MongoDB\Driver\Monitoring\LogSubscriber::LEVEL_MESSAGE
type: constant
doc:
<comment>Description:</comment>
  Message or notice log level. Indicates an event that is unusual but not problematic.


id: MongoDB\Driver\Monitoring\LogSubscriber::LEVEL_WARNING
type: constant
doc:
<comment>Description:</comment>
  Warning log level. Indicates a situation where undesirable application behavior may occur.


id: MongoDB\Driver\Monitoring\LogSubscriber::log
type: function
doc:
<comment>Description:</comment>
  Notification method for a log message
  
  If the subscriber has been registered, the driver will call this method for each logged message.

<comment>Param:</comment>
  <info>int</info>     <strong>$level</strong>    The severity level. This will be one of the interface constants.
  <info>string</info>  <strong>$domain</strong>   The name of the driver component that emitted the log message.
  <info>string</info>  <strong>$message</strong>  The log message.

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

<comment>See Also:</comment>
   * <strong>MongoDB\Driver\Monitoring\addSubscriber()</strong>


id: MongoDB\Driver\Monitoring\SDAMSubscriber
type: class
doc:
<comment>Description:</comment>
  Классы могут реализовать этот интерфейс для регистрации подписчика событий, который получает
  уведомления о различных событиях SDAM. Дополнительную информацию смотрите в руководстве по
  Обнаружению и мониторингу серверов и Мониторингу SDAM.


id: MongoDB\Driver\Monitoring\SDAMSubscriber::serverChanged
type: function
doc:
<comment>Description:</comment>
  Метод уведомления об изменении описания сервера
  
  Если подписчик был зарегистрирован, драйвер будет вызывать этот метод, если описание сервера
  изменилось.

<comment>Param:</comment>
  <info>MongoDB\Driver\Monitoring\ServerChangedEvent</info>  <strong>$event</strong>  Объект события, содержащий информацию об
                                                        изменённом описании сервера.

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

<comment>See Also:</comment>
   * <class>MongoDB\Driver\Monitoring\ServerChangedEvent</class>
   * <strong>MongoDB\Driver\Monitoring\addSubscriber()</strong>
   * <strong>MongoDB\Driver\Manager::addSubscriber()</strong>


id: MongoDB\Driver\Monitoring\SDAMSubscriber::serverClosed
type: function
doc:
<comment>Description:</comment>
  Метод уведомления о закрытии сервера
  
  Если подписчик был зарегистрирован, драйвер вызовет этот метод, если сервер закрылся.

<comment>Param:</comment>
  <info>MongoDB\Driver\Monitoring\ServerClosedEvent</info>  <strong>$event</strong>  Объект события, содержащий информацию о
                                                       закрытом сервере.

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

<comment>See Also:</comment>
   * <class>MongoDB\Driver\Monitoring\ServerClosedEvent</class>
   * <strong>MongoDB\Driver\Monitoring\addSubscriber()</strong>
   * <strong>MongoDB\Driver\Manager::addSubscriber()</strong>


id: MongoDB\Driver\Monitoring\SDAMSubscriber::serverHeartbeatFailed
type: function
doc:
<comment>Description:</comment>
  Метод уведомления о неудачном heartbeat сервера
  
  Если подписчик был зарегистрирован, драйвер вызовет этот метод, в случае возникновения ошибки
  heartbeat сервера (т.е. команды hello, вызванной через мониторинг сервера).

<comment>Param:</comment>
  <info>MongoDB\Driver\Monitoring\ServerHeartbeatFailedEvent</info>  <strong>$event</strong>  Объект события, содержащий
                                                                информацию о неработающем heartbeat
                                                                сервера.

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

<comment>See Also:</comment>
   * <class>MongoDB\Driver\Monitoring\ServerHeartbeatFailedEvent</class>
   * <strong>MongoDB\Driver\Monitoring\addSubscriber()</strong>
   * <strong>MongoDB\Driver\Manager::addSubscriber()</strong>


id: MongoDB\Driver\Monitoring\SDAMSubscriber::serverHeartbeatStarted
type: function
doc:
<comment>Description:</comment>
  Метод уведомления о запущенном heartbeat сервера
  
  Если подписчик был зарегистрирован, драйвер вызовет этот метод при запуске heartbeat сервера (т.е.
  команды hello, вызванной через мониторинг сервера).

<comment>Param:</comment>
  <info>MongoDB\Driver\Monitoring\ServerHeartbeatStartedEvent</info>  <strong>$event</strong>  Объект события, содержащий
                                                                 информацию о запущенном heartbeat
                                                                 сервера.

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

<comment>See Also:</comment>
   * <class>MongoDB\Driver\Monitoring\ServerHeartbeatStartedEvent</class>
   * <strong>MongoDB\Driver\Monitoring\addSubscriber()</strong>
   * <strong>MongoDB\Driver\Manager::addSubscriber()</strong>


id: MongoDB\Driver\Monitoring\SDAMSubscriber::serverHeartbeatSucceeded
type: function
doc:
<comment>Description:</comment>
  Метод уведомления об успешном heartbeat сервера
  
  Если подписчик был зарегистрирован, драйвер вызовет этот метод, в случае успешного выполнения
  heartbeat сервера (т.е. команды hello, вызванной через мониторинг сервера).

<comment>Param:</comment>
  <info>MongoDB\Driver\Monitoring\ServerHeartbeatSucceededEvent</info>  <strong>$event</strong>  Объект события, содержащий
                                                                   информацию об успешном heartbeat
                                                                   сервера.

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

<comment>See Also:</comment>
   * <class>MongoDB\Driver\Monitoring\ServerHeartbeatSucceededEvent</class>
   * <strong>MongoDB\Driver\Monitoring\addSubscriber()</strong>
   * <strong>MongoDB\Driver\Manager::addSubscriber()</strong>


id: MongoDB\Driver\Monitoring\SDAMSubscriber::serverOpening
type: function
doc:
<comment>Description:</comment>
  Метод уведомления об открытии сервера
  
  Если подписчик был зарегистрирован, драйвер вызовет этот метод, когда будет открыт сервер.

<comment>Param:</comment>
  <info>MongoDB\Driver\Monitoring\ServerOpeningEvent</info>  <strong>$event</strong>  Объект события, содержащий информацию об
                                                        открытом сервере.

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

<comment>See Also:</comment>
   * <class>MongoDB\Driver\Monitoring\ServerOpeningEvent</class>
   * <strong>MongoDB\Driver\Monitoring\addSubscriber()</strong>
   * <strong>MongoDB\Driver\Manager::addSubscriber()</strong>


id: MongoDB\Driver\Monitoring\SDAMSubscriber::topologyChanged
type: function
doc:
<comment>Description:</comment>
  Метод уведомления об изменении описания топологии
  
  Если подписчик был зарегистрирован, драйвер вызовет этот метод, если описание топологии изменится.

<comment>Param:</comment>
  <info>MongoDB\Driver\Monitoring\TopologyChangedEvent</info>  <strong>$event</strong>  Объект события, содержащий информацию об
                                                          изменённом описании топологии.

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

<comment>See Also:</comment>
   * <class>MongoDB\Driver\Monitoring\TopologyChangedEvent</class>
   * <strong>MongoDB\Driver\Monitoring\addSubscriber()</strong>
   * <strong>MongoDB\Driver\Manager::addSubscriber()</strong>


id: MongoDB\Driver\Monitoring\SDAMSubscriber::topologyClosed
type: function
doc:
<comment>Description:</comment>
  Метод уведомления о закрытии топологии
  
  Если подписчик был зарегистрирован, драйвер вызовет этот метод, если топология будет закрыта.

<comment>Param:</comment>
  <info>MongoDB\Driver\Monitoring\TopologyClosedEvent</info>  <strong>$event</strong>  Объект события, содержащий информацию о
                                                         закрытой топологии.

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

<comment>See Also:</comment>
   * <class>MongoDB\Driver\Monitoring\TopologyClosedEvent</class>
   * <strong>MongoDB\Driver\Monitoring\addSubscriber()</strong>
   * <strong>MongoDB\Driver\Manager::addSubscriber()</strong>


id: MongoDB\Driver\Monitoring\SDAMSubscriber::topologyOpening
type: function
doc:
<comment>Description:</comment>
  Метод уведомления об открытии топологии
  
  Если подписчик был зарегистрирован, драйвер вызовет этот метод, когда топология будет открыта.

<comment>Param:</comment>
  <info>MongoDB\Driver\Monitoring\TopologyOpeningEvent</info>  <strong>$event</strong>  Объект события, содержащий информацию об
                                                          открытой топологии.

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

<comment>See Also:</comment>
   * <class>MongoDB\Driver\Monitoring\TopologyOpeningEvent</class>
   * <strong>MongoDB\Driver\Monitoring\addSubscriber()</strong>
   * <strong>MongoDB\Driver\Manager::addSubscriber()</strong>


id: MongoDB\Driver\Monitoring\ServerChangedEvent
type: class
doc:
<comment>Description:</comment>
  Класс <class>MongoDB\Driver\Monitoring\ServerChangedEvent</class> инкапсулирует информацию об изменении описания
  сервера.


id: MongoDB\Driver\Monitoring\ServerChangedEvent::getHost
type: function
doc:
<comment>Description:</comment>
  Возвращает имя хоста сервера

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


id: MongoDB\Driver\Monitoring\ServerChangedEvent::getNewDescription
type: function
doc:
<comment>Description:</comment>
  Возвращает новое описание сервера

<comment>Return:</comment>
  <info>MongoDB\Driver\ServerDescription</info>  Возвращает новое описание (<class>MongoDB\Driver\ServerDescription</class>)
                                    сервера.


id: MongoDB\Driver\Monitoring\ServerChangedEvent::getPort
type: function
doc:
<comment>Description:</comment>
  Возвращает порт, на котором прослушивается сервер

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


id: MongoDB\Driver\Monitoring\ServerChangedEvent::getPreviousDescription
type: function
doc:
<comment>Description:</comment>
  Возвращает предыдущее описание сервера

<comment>Return:</comment>
  <info>MongoDB\Driver\ServerDescription</info>  Возвращает предыдущее описание
                                    (<class>MongoDB\Driver\ServerDescription</class>) сервера.


id: MongoDB\Driver\Monitoring\ServerChangedEvent::getTopologyId
type: function
doc:
<comment>Description:</comment>
  Возвращает идентификатор топологии, связанный с этим сервером

<comment>Return:</comment>
  <info>MongoDB\BSON\ObjectId</info>  Возвращает идентификатор топологии.


id: MongoDB\Driver\Monitoring\ServerClosedEvent
type: class
doc:
<comment>Description:</comment>
  Класс <class>MongoDB\Driver\Monitoring\ServerClosedEvent</class> инкапсулирует информацию о закрытом сервере.


id: MongoDB\Driver\Monitoring\ServerHeartbeatFailedEvent
type: class
doc:
<comment>Description:</comment>
  Класс <class>MongoDB\Driver\Monitoring\ServerHeartbeatFailedEvent</class> инкапсулирует информацию о неудачном
  heartbeat сервера.


id: MongoDB\Driver\Monitoring\ServerHeartbeatFailedEvent::getDurationMicros
type: function
doc:
<comment>Description:</comment>
  Возвращает продолжительность heartbeat в микросекундах
  
  Продолжительность heartbeat - это расчётное значение, которое включает в себя время отправки
  сообщения и получения ответа от сервера.

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


id: MongoDB\Driver\Monitoring\ServerHeartbeatFailedEvent::getError
type: function
doc:
<comment>Description:</comment>
  Возвращает исключение, связанное с неудачным выполнением heartbeat

<comment>Return:</comment>
  <info>Exception</info>  Возвращает исключение (<class>Exception</class>), связанное с неудачным выполнением heartbeat.


id: MongoDB\Driver\Monitoring\ServerHeartbeatFailedEvent::isAwaited
type: function
doc:
<comment>Description:</comment>
  Возвращает, использовался ли в heartbeat потоковый протокол
  
  Возвращает, использовался ли в heartbeat потоковый протокол. Драйвер PHP не использует потоковый
  протокол для мониторинга, поэтому этот метод всегда будет возвращать <info>false</info>.

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


id: MongoDB\Driver\Monitoring\ServerHeartbeatStartedEvent
type: class
doc:
<comment>Description:</comment>
  Класс <class>MongoDB\Driver\Monitoring\ServerHeartbeatStartedEvent</class> инкапсулирует информацию о запущенном
  heartbeat сервера.


id: MongoDB\Driver\Monitoring\ServerHeartbeatSucceededEvent
type: class
doc:
<comment>Description:</comment>
  Класс <class>MongoDB\Driver\Monitoring\ServerHeartbeatSucceededEvent</class> инкапсулирует информацию об успешном
  heartbeat сервера.


id: MongoDB\Driver\Monitoring\ServerHeartbeatSucceededEvent::getReply
type: function
doc:
<comment>Description:</comment>
  Возвращает документ ответа heartbeat
  
  Документ ответа будет преобразован из BSON в PHP с использованием правил десериализации по
  умолчанию (например, документы BSON будут преобразованы в <info>stdClass</info>).

<comment>Return:</comment>
  <info>object</info>  Возвращает документ ответа heartbeat в виде объекта <class>stdClass</class>.

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


id: MongoDB\Driver\Monitoring\ServerOpeningEvent
type: class
doc:
<comment>Description:</comment>
  Класс <class>MongoDB\Driver\Monitoring\ServerOpeningEvent</class> инкапсулирует информацию об открытом сервере.


id: MongoDB\Driver\Monitoring\ServerOpeningEvent::getTopologyId
type: function
doc:
<comment>Description:</comment>
  Returns the topology ID associated with this server

<comment>Return:</comment>
  <info>MongoDB\BSON\ObjectId</info>  Returns the topology ID.


id: MongoDB\Driver\Monitoring\Subscriber
type: class
doc:
<comment>Description:</comment>
  Базовый интерфейс для подписчиков событий. Используется как тип параметра в функциях
  <strong>MongoDB\Driver\Monitoring\addSubscriber()</strong> и <strong>MongoDB\Driver\Monitoring\removeSubscriber()</strong>, и не
  должен реализовываться напрямую.


id: MongoDB\Driver\Monitoring\TopologyChangedEvent
type: class
doc:
<comment>Description:</comment>
  Класс <class>MongoDB\Driver\Monitoring\TopologyChangedEvent</class> инкапсулирует информацию об изменённом
  описании топологии.


id: MongoDB\Driver\Monitoring\TopologyChangedEvent::getNewDescription
type: function
doc:
<comment>Description:</comment>
  Возвращает новое описание топологии

<comment>Return:</comment>
  <info>MongoDB\Driver\TopologyDescription</info>  Возвращает новое описание (<class>MongoDB\Driver\TopologyDescription</class>)
                                      топологии.


id: MongoDB\Driver\Monitoring\TopologyChangedEvent::getPreviousDescription
type: function
doc:
<comment>Description:</comment>
  Возвращает предыдущее описание топологии

<comment>Return:</comment>
  <info>MongoDB\Driver\TopologyDescription</info>  Возвращает предыдущее описание
                                      (<class>MongoDB\Driver\TopologyDescription</class>) топологии.


id: MongoDB\Driver\Monitoring\TopologyChangedEvent::getTopologyId
type: function
doc:
<comment>Description:</comment>
  Возвращает идентификатор топологии

<comment>Return:</comment>
  <info>MongoDB\BSON\ObjectId</info>  Возвращает идентификатор топологии.


id: MongoDB\Driver\Monitoring\TopologyClosedEvent
type: class
doc:
<comment>Description:</comment>
  Класс <class>MongoDB\Driver\Monitoring\TopologyClosedEvent</class> инкапсулирует информацию о закрытой топологии.


id: MongoDB\Driver\Monitoring\TopologyOpeningEvent
type: class
doc:
<comment>Description:</comment>
  Класс <class>MongoDB\Driver\Monitoring\TopologyOpeningEvent</class> инкапсулирует информацию об открытой
  топологии.


id: MongoDB\Driver\Monitoring\addSubscriber
type: function
doc:
<comment>Description:</comment>
  Глобальная регистрация подписчика на событие мониторинга
  
  Глобально регистрирует подписчика на событие мониторинга. Подписчик будет уведомлён обо всех
  событиях в драйвере для любого менеджера.
  
  Если <strong>$subscriber</strong> уже зарегистрирован глобально, функция отработает без результата. Если
  <strong>$subscriber</strong> также зарегистрирован с одним или несколькими менеджерами, он все равно получит
  уведомление один раз о каждом событии для каждого менеджера.

<comment>Param:</comment>
  <info>MongoDB\Driver\Monitoring\Subscriber</info>  <strong>$subscriber</strong>  Подписчик событий мониторинга для глобальной
                                                     регистрации.

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

<comment>See Also:</comment>
   * <strong>MongoDB\Driver\Monitoring\removeSubscriber()</strong>
   * MongoDB\Driver\Monitoring\Subscriber
   * MongoDB\Driver\Monitoring\CommandSubscriber
   * <strong>MongoDB\Driver\Manager::addSubscriber()</strong>
   * 


id: MongoDB\Driver\Monitoring\removeSubscriber
type: function
doc:
<comment>Description:</comment>
  Отменяет глобальную регистрацию подписчика на событие мониторинга
  
  Отменяет глобальную регистрацию подписчика на событие мониторинга.
  
  Если <strong>$subscriber</strong> ещё не зарегистрирован глобально, функция отработает без результата.

<comment>Param:</comment>
  <info>MongoDB\Driver\Monitoring\Subscriber</info>  <strong>$subscriber</strong>  Подписчик на событие мониторинга для глобальной
                                                     отмены регистрации.

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

<comment>See Also:</comment>
   * <strong>MongoDB\Driver\Monitoring\addSubscriber()</strong>
   * MongoDB\Driver\Monitoring\Subscriber
   * MongoDB\Driver\Monitoring\CommandSubscriber
   * <strong>MongoDB\Driver\Manager::removeSubscriber()</strong>
   * 


id: MongoDB\Driver\Query
type: class
doc:
<comment>Description:</comment>
  Класс <class>MongoDB\Driver\Query</class> - это объект значения, представляющий запрос базы данных.


id: MongoDB\Driver\Query::__construct
type: function
doc:
<comment>Description:</comment>
  Создаёт новый запрос
  
  Создаёт новый <class>MongoDB\Driver\Query</class>, который является объектом неизменяемого значения,
  представляющим запрос к базе данных. Затем запрос может быть выполнен с помощью
  MongoDB\Driver\Manager::executeQuery.

<comment>Param:</comment>
  <info>array|object</info>  <strong>$filter</strong>        Предикат запроса. Пустой предикат совпадёт со всеми элементами
                               коллекции.
                               
                               При вычислении критериев запроса, MongoDB сравнивает типы и значения
                               в соответствии с собственными правилами сравнения типов BSON,
                               отличных от правил сравнения и приведения типов PHP. Когда
                               используется специальный тип BSON,  критерия запроса должна
                               соответствовать классу BSON (т.е. использовать <class>MongoDB\BSON\ObjectId</class>
                               для выборке по ObjectId).
  <info>array|null</info>    <strong>$queryOptions</strong>  queryOptionsОпцияТипОписаниеallowDiskUse<info>bool</info> Позволяет MongoDB
                               использовать временные файлы на диске для хранения данных,
                               превышающих предел системной памяти в 100 мегабайт, при обработке
                               операции сортировки блокировки. allowPartialResults<info>bool</info> Для запросов
                               к изолированной коллекции возвращает частичные результаты из mongos,
                               если некоторые шарды недоступны, вместо выдачи ошибки.  Возврат к
                               устаревшей <return>"partial"</return> опции, если она не указана. awaitData<info>bool</info>
                               Используйте совместно с опцией <return>"tailable"</return>, чтобы временно
                               заблокировать операцию getMore для курсора, если в конце данных, а не
                               возвращать никаких данных. После истечения времени ожидания запрос
                               возвращается, как обычно. batchSize<info>int</info> Количество документов для
                               возврата в первом пакете. По умолчанию - 101. Размер пакета 0
                               означает, что курсор будет установлен, но никакие документы не будут
                               возвращены в первом пакете.  В версиях MongoDB до 3.2, где запросы
                               используют устаревший проводной протокол OP_QUERY, размер пакета,
                               равный 1, будет закрывать курсор независимо от количества совпадающих
                               документов. collation<info>array</info><info>object</info></info>Сопоставление позволяет пользователям
                               указывать специфичные для конкретного языка правила для сравнения
                               строк, такие как реакцию на регистр букв и надстрочные знаки. Если
                               задано сопоставление, то поле <return>"locale"</return> также обязательно. Описание
                               полей смотрите в разделе Сопоставление.  Если сопоставление не задано
                               явно, но у коллекции определено сопоставление по умолчанию, то будет
                               использовано оно. Если нет ни того ни того, то MongoDB будет
                               использовать простое бинарное сравнение строк.  Эта опция доступна в
                               MongoDB 3.4+ и, если будет использована для более старых версий,
                               вызовет исключение во время исполнения. comment<info>mixed</info> Произвольный
                               комментарий, помогающий отследить операцию с помощью профилировщика
                               базы данных, вывода CurrentOp и журналов.  Комментарий может быть
                               любым допустимым типом BSON для MongoDB 4.4+. Более ранние версии
                               сервера поддерживают только строковые значения.  Возврат к
                               устаревшему модификатору <return>"$comment"</return>, если он не указан. exhaust<info>bool</info>
                               Потоковая передача данных на полную мощность в нескольких
                               "дополнительных" пакетах при условии, что клиент полностью прочитает
                               все запрашиваемые данные. Быстрее, когда вы извлекаете много данных и
                               знаете, что хотите все это перенести. Примечание: клиент не имеет
                               права не читать все данные, если он не закрывает соединение.  Эта
                               опция не поддерживается командой find в MongoDB 3.2+ и заставит
                               драйвер использовать устаревшую версию проводного протокола (то есть
                               OP_QUERY). explain<info>bool</info> Если <info>true</info>, возвращённый <class>MongoDB\Driver\Cursor</class>
                               будет содержать один документ, который описывает процесс и индексы,
                               используемые для возврата запроса.  Возврат к устаревшему
                               модификатору <return>"$explain"</return>, если он не указан.  Эта опция не
                               поддерживается командой find в MongoDB 3.2+ и будет учитываться
                               только при использовании устаревшей версии проводного протокола (т.е.
                               OP_QUERY). Команда explain должна использоваться на MongoDB 3.0+.
                               hint<info>string</info><info>array</info><info>object</info></info> Индекс спецификации. Укажите либо имя индекса в
                               виде строки, либо шаблон ключа индекса. Если указано, то система
                               запросов будет рассматривать планы только с использованием
                               хинтованного индекса.  Откат к устаревшей опции <return>"hint"</return>, если она не
                               указана. let<info>array</info><info>object</info></info> Карта имён и значений параметров. Значения
                               должны быть константами или закрытыми выражениями, которые не
                               ссылаются на поля документа. К параметрам можно обращаться как к
                               переменным в контексте агрегированного выражения (например, <return>$$var</return>).
                               Опция доступна в MongoDB 5.0+ и приведёт к исключению во время
                               выполнения, если указана для более старой версии сервера. limit<info>int</info>
                               Максимальное количество документов для возврата. Если не указано, то
                               по умолчанию используется без ограничений. Значение 0 эквивалентно
                               установке без ограничения.  Отрицательное значение будет
                               интерпретироваться как положительное значение с параметром
                               <return>"singleBatch"</return>, установленным в значение <info>true</info>. Это поведение
                               поддерживается для обратной совместимости, но его следует считать
                               устаревшим. max<info>array</info><info>object</info></info>Эксклюзивная верхняя граница для
                               определённого индекса.  Возврат к устаревшему модификатору <return>"$max"</return>,
                               если он не указан. maxAwaitTimeMS<info>int</info> Положительное целое число,
                               обозначающее ограничение времени в миллисекундах для сервера, чтобы
                               заблокировать операцию getMore, если данные недоступны. Эта опция
                               должна использоваться только в сочетании с опциями <return>"tailable"</return> и
                               <return>"awaitData"</return>. maxScan<info>int</info> Эта опция устарела и не должна
                               использоваться.  Целое положительное число, обозначающее максимальное
                               количество документов или индексных ключей для сканирования при
                               выполнении запроса.  Возврат к устаревшему модификатору <return>"$maxScan"</return>,
                               если он не указан. maxTimeMS<info>int</info> Накопленный лимит времени в
                               миллисекундах для операций обработки на курсоре. MongoDB прерывает
                               операцию в ближайшей следующей точке прерывания.  Возврат к
                               устаревшему модификатору <return>"$maxTimeMS"</return>, если он не указан.
                               min<info>array</info><info>object</info></info>Включающая нижняя граница для определённого индекса.
                               Возврат к устаревшему модификатору <return>"$min"</return>, если он не указан.
                               modifiers<info>array</info>Метаоператоры, изменяющие вывод или поведение запроса.
                               Использование этих операторов не рекомендуется в пользу именованных
                               опций. noCursorTimeout<info>bool</info> Запрещает серверу синхронизировать
                               незанятые курсоры после периода бездействия (10 минут).
                               oplogReplay<info>bool</info> Внутреннее использование для наборов реплик. Чтобы
                               использовать oplogReplay, вы должны включить в фильтр следующее
                               условие:  [ '$gte' =>  ] ]
                               ]]>Опция устарела с версии 1.8.0.projection<info>array</info><info>object</info></info>Спецификация
                               проекции для определения полей, которые необходимо включить в
                               возвращаемые документы.  Если вы используете функцию ODM для
                               десериализации документов в качестве их исходного класса PHP,
                               убедитесь, что вы включили поле __pclass в проекцию. Это необходимо
                               для работы десериализации, и без неё драйвер вернёт (по умолчанию)
                               объект <class>stdClass</class>. readConcern<class>MongoDB\Driver\ReadConcern</class> Гарантии
                               чтения, чтобы применить к операции. По умолчанию будут использоваться
                               гарантии чтения из URI подключения MongoDB.  Эта опция доступна в
                               MongoDB 3.2+ и приведёт к исключению во время выполнения, если
                               указано для более старой версии сервера. returnKey<info>bool</info> Если <info>true</info>,
                               возвращает только индексные ключи в результирующих документах.
                               Значением по умолчанию является <info>false</info>. Если <info>true</info> и команда find не
                               используют индекс, возвращённые документы будут пустыми.  Возврат к
                               устаревшему модификатору <return>"$returnKey"</return>, если он не указан.
                               showRecordId<info>bool</info> Определяет, возвращать ли идентификатор записи для
                               каждого документа. Если <info>true</info>, добавляет поле <return>"$recordId"</return> верхнего
                               уровня к возвращённым документам.  Возврат к устаревшему модификатору
                               <return>"$showDiskLoc"</return>, если он не указан. singleBatch<info>bool</info> Определяет,
                               закрывать ли курсор после первого пакета. По умолчанию <info>false</info>.
                               skip<info>int</info>Количество документов для пропуска. По умолчанию
                               0.snapshot<info>bool</info> Эта опция устарела и не должна использоваться.
                               Запрещает курсору возвращать документ более одного раза из-за
                               промежуточной операции записи.  Возврат к устаревшему модификатору
                               <return>"$snapshot"</return>, если он не указан. sort<info>array</info><info>object</info></info>Спецификация
                               сортировки для упорядочения результатов. Возврат к устаревшему
                               модификатору <return>"$orderby"</return>, если он не указан. tailable<info>bool</info>Возвращает
                               настраиваемый курсор для ограниченной коллекции.
                               
                               Позволяет MongoDB использовать временные файлы на диске для хранения
                               данных, превышающих предел системной памяти в 100 мегабайт, при
                               обработке операции сортировки блокировки.
                               
                               Для запросов к изолированной коллекции возвращает частичные
                               результаты из mongos, если некоторые шарды недоступны, вместо выдачи
                               ошибки.
                               
                               Возврат к устаревшей <return>"partial"</return> опции, если она не указана.
                               
                               Количество документов для возврата в первом пакете. По умолчанию -
                               101. Размер пакета 0 означает, что курсор будет установлен, но
                               никакие документы не будут возвращены в первом пакете.
                               
                               В версиях MongoDB до 3.2, где запросы используют устаревший проводной
                               протокол OP_QUERY, размер пакета, равный 1, будет закрывать курсор
                               независимо от количества совпадающих документов.
                               
                               Сопоставление позволяет пользователям указывать специфичные для
                               конкретного языка правила для сравнения строк, такие как реакцию на
                               регистр букв и надстрочные знаки. Если задано сопоставление, то поле
                               <return>"locale"</return> также обязательно. Описание полей смотрите в разделе
                               Сопоставление.
                               
                               Если сопоставление не задано явно, но у коллекции определено
                               сопоставление по умолчанию, то будет использовано оно. Если нет ни
                               того ни того, то MongoDB будет использовать простое бинарное
                               сравнение строк.
                               
                               Эта опция доступна в MongoDB 3.4+ и, если будет использована для
                               более старых версий, вызовет исключение во время исполнения.
                               
                               Произвольный комментарий, помогающий отследить операцию с помощью
                               профилировщика базы данных, вывода CurrentOp и журналов.
                               
                               Комментарий может быть любым допустимым типом BSON для MongoDB 4.4+.
                               Более ранние версии сервера поддерживают только строковые значения.
                               
                               Возврат к устаревшему модификатору <return>"$comment"</return>, если он не указан.
                               
                               Потоковая передача данных на полную мощность в нескольких
                               "дополнительных" пакетах при условии, что клиент полностью прочитает
                               все запрашиваемые данные. Быстрее, когда вы извлекаете много данных и
                               знаете, что хотите все это перенести. Примечание: клиент не имеет
                               права не читать все данные, если он не закрывает соединение.
                               
                               Эта опция не поддерживается командой find в MongoDB 3.2+ и заставит
                               драйвер использовать устаревшую версию проводного протокола (то есть
                               OP_QUERY).
                               
                               Если <info>true</info>, возвращённый <class>MongoDB\Driver\Cursor</class> будет содержать один
                               документ, который описывает процесс и индексы, используемые для
                               возврата запроса.
                               
                               Возврат к устаревшему модификатору <return>"$explain"</return>, если он не указан.
                               
                               Эта опция не поддерживается командой find в MongoDB 3.2+ и будет
                               учитываться только при использовании устаревшей версии проводного
                               протокола (т.е. OP_QUERY). Команда explain должна использоваться на
                               MongoDB 3.0+.
                               
                               Индекс спецификации. Укажите либо имя индекса в виде строки, либо
                               шаблон ключа индекса. Если указано, то система запросов будет
                               рассматривать планы только с использованием хинтованного индекса.
                               
                               Откат к устаревшей опции <return>"hint"</return>, если она не указана.
                               
                               Карта имён и значений параметров. Значения должны быть константами
                               или закрытыми выражениями, которые не ссылаются на поля документа. К
                               параметрам можно обращаться как к переменным в контексте
                               агрегированного выражения (например, <return>$$var</return>).
                               
                               Опция доступна в MongoDB 5.0+ и приведёт к исключению во время
                               выполнения, если указана для более старой версии сервера.
                               
                               Максимальное количество документов для возврата. Если не указано, то
                               по умолчанию используется без ограничений. Значение 0 эквивалентно
                               установке без ограничения.
                               
                               Отрицательное значение будет интерпретироваться как положительное
                               значение с параметром <return>"singleBatch"</return>, установленным в значение <info>true</info>.
                               Это поведение поддерживается для обратной совместимости, но его
                               следует считать устаревшим.
                               
                               Эксклюзивная верхняя граница для определённого индекса.
                               
                               Возврат к устаревшему модификатору <return>"$max"</return>, если он не указан.
                               
                               Положительное целое число, обозначающее ограничение времени в
                               миллисекундах для сервера, чтобы заблокировать операцию getMore, если
                               данные недоступны. Эта опция должна использоваться только в сочетании
                               с опциями <return>"tailable"</return> и <return>"awaitData"</return>.
                               
                               Эта опция устарела и не должна использоваться.
                               
                               Целое положительное число, обозначающее максимальное количество
                               документов или индексных ключей для сканирования при выполнении
                               запроса.
                               
                               Возврат к устаревшему модификатору <return>"$maxScan"</return>, если он не указан.
                               
                               Накопленный лимит времени в миллисекундах для операций обработки на
                               курсоре. MongoDB прерывает операцию в ближайшей следующей точке
                               прерывания.
                               
                               Возврат к устаревшему модификатору <return>"$maxTimeMS"</return>, если он не указан.
                               
                               Включающая нижняя граница для определённого индекса.
                               
                               Возврат к устаревшему модификатору <return>"$min"</return>, если он не указан.
                               
                               Внутреннее использование для наборов реплик. Чтобы использовать
                               oplogReplay, вы должны включить в фильтр следующее условие:
                               
                                [ '$gte' =>  ] ]
                               ]]>
                               
                               Опция устарела с версии 1.8.0.
                               
                               Спецификация проекции для определения полей, которые необходимо
                               включить в возвращаемые документы.
                               
                               Если вы используете функцию ODM для десериализации документов в
                               качестве их исходного класса PHP, убедитесь, что вы включили поле
                               __pclass в проекцию. Это необходимо для работы десериализации, и без
                               неё драйвер вернёт (по умолчанию) объект <class>stdClass</class>.
                               
                               Гарантии чтения, чтобы применить к операции. По умолчанию будут
                               использоваться гарантии чтения из URI подключения MongoDB.
                               
                               Эта опция доступна в MongoDB 3.2+ и приведёт к исключению во время
                               выполнения, если указано для более старой версии сервера.
                               
                               Если <info>true</info>, возвращает только индексные ключи в результирующих
                               документах. Значением по умолчанию является <info>false</info>. Если <info>true</info> и
                               команда find не используют индекс, возвращённые документы будут
                               пустыми.
                               
                               Возврат к устаревшему модификатору <return>"$returnKey"</return>, если он не указан.
                               
                               Определяет, возвращать ли идентификатор записи для каждого документа.
                               Если <info>true</info>, добавляет поле <return>"$recordId"</return> верхнего уровня к возвращённым
                               документам.
                               
                               Возврат к устаревшему модификатору <return>"$showDiskLoc"</return>, если он не указан.
                               
                               Эта опция устарела и не должна использоваться.
                               
                               Запрещает курсору возвращать документ более одного раза из-за
                               промежуточной операции записи.
                               
                               Возврат к устаревшему модификатору <return>"$snapshot"</return>, если он не указан.
                               
                               Спецификация сортировки для упорядочения результатов.
                               
                               Возврат к устаревшему модификатору <return>"$orderby"</return>, если он не указан.

<comment>See Also:</comment>
   * MongoDB\Driver\Manager::executeQuery
   * <class>MongoDB\Driver\Cursor</class>


id: MongoDB\Driver\ReadConcern
type: class
doc:
<comment>Description:</comment>
  <class>MongoDB\Driver\ReadConcern</class> контролирует уровень изоляции для операций чтения для наборов реплик и
  сегментов наборов реплик. Эта опция требует MongoDB 3.2 или новее.


id: MongoDB\Driver\ReadConcern::AVAILABLE
type: constant
doc:
<comment>Description:</comment>
  По умолчанию для чтения против вторичных, когда <return>afterClusterTime</return> и <return>level</return> не указаны.
  
  Запрос возвращает самые последние данные экземпляра. Не гарантирует, что данные были записаны
  большинству членов набора реплик (то есть могут быть откаты).
  
  Для неохраняемых коллекций (включая коллекции в автономном развёртывании или развёртывании набора
  реплик), <return>"local"</return> и <return>"available"</return> гарантии чтения ведут себя одинаково.
  
  Для сегментированного кластера <return>"available"</return> гарантии чтения обеспечивает большую терпимость для
  разделов, поскольку она не ожидает гарантий согласованности. Однако запрос с <return>"available"</return>
  гарантиями чтения может вернуть потерянные документы, если в сегменте выполняется миграция
  фрагментов, поскольку <return>"available"</return> гарантий чтения, в отличие от <return>"local"</return> гарантий чтения, не
  связывается с первичным сервером сегмента или серверами конфигурации для получения обновлённых
  метаданных.


id: MongoDB\Driver\ReadConcern::LINEARIZABLE
type: constant
doc:
<comment>Description:</comment>
  Запрос возвращает данные, которые отражают все успешные записи, выпущенные с гарантиями записи
  <return>"majority"</return> и подтверждённые до начала операции чтения. Для наборов реплик, которые выполняются с
  параметром <return>writeConcernMajorityJournalDefault</return>, установленным в значение <info>true</info>, линеаризуемые
  гарантии чтения возвращают данные, которые никогда не будут откатываться.
  
  Если для <return>writeConcernMajorityJournalDefault</return> задано значение <info>false</info>, MongoDB не будет ожидать, что
  <return>w: "majority"</return> записей будет устойчивым, прежде чем подтвердить записи. Таким образом, операции
  записи <return>"majority"</return> могут откатываться в случае потери члена набора реплик.
  
  Вы можете указать линеаризуемые гарантии чтения для операций чтения только на основном сервере.
  
  Линеаризуемые гарантии чтения применяются только в том случае, если в операциях чтения указан
  фильтр запроса, который однозначно идентифицирует один документ.
  
  Всегда используйте <return>maxTimeMS</return> с линеаризуемыми гарантиями чтения, если большинство элементов,
  несущих данные, недоступно. <return>maxTimeMS</return> гарантирует, что операция не блокируется бесконечно, и
  вместо этого гарантирует, что операция возвращает ошибку, если проблема чтения не может быть
  выполнена.
  
  Для линеаризуемых гарантий чтения требуется MongoDB 3.4.


id: MongoDB\Driver\ReadConcern::LOCAL
type: constant
doc:
<comment>Description:</comment>
  По умолчанию для чтения по первичному, если <return>level</return> не указан, и для чтения по вторичному, если
  <return>level</return> не указан, но задано <return>afterClusterTime</return>.
  
  Запрос возвращает самые последние данные экземпляра. Не гарантирует, что данные были записаны
  большинству членов набора реплик (то есть могут быть откаты).


id: MongoDB\Driver\ReadConcern::MAJORITY
type: constant
doc:
<comment>Description:</comment>
  Запрос возвращает самые последние данные экземпляра, которые были признаны записанными большинству
  членов в наборе реплик.
  
  Чтобы использовать уровень гарантий чтения <return>"majority"</return>, наборы реплик должны использовать механизм
  хранения WiredTiger и протокол выбора версии 1.


id: MongoDB\Driver\ReadConcern::SNAPSHOT
type: constant
doc:
<comment>Description:</comment>
  Гарантия чтения <return>"snapshot"</return> доступна для транзакций с несколькими документами, а начиная с MongoDB
  5.0 также доступна для некоторых операций чтения не только для транзакций с несколькими
  документами.
  
  Если транзакция не является частью причинно-согласованного сессии, после фиксации транзакции с
  проблемой записи <return>"majority"</return>, операции транзакции гарантированно прочитают из моментального снимка
  зафиксированных большинством данных.
  
  Если транзакция является частью причинно-согласованной сессии, при фиксации транзакции с проблемой
  записи <return>"majority"</return>, операции транзакции гарантированно считывают из моментального снимка данные,
  подтверждённые большинством, что обеспечивает причинную согласованность с операций,
  непосредственно предшествующей началу транзакции.
  
  Вне транзакций с несколькими документами, проблема чтения <return>"snapshot"</return> доступна на первичных и
  вторичных серверах для следующих операций чтения: <return>find</return>, <return>aggregate</return> и <return>distinct</return> (для необработанных
  коллекций). Все остальные команды чтения запрещают <return>"snapshot"</return>.


id: MongoDB\Driver\ReadConcern::__construct
type: function
doc:
<comment>Description:</comment>
  Создаёт новый ReadConcern
  
  Создаёт новый <class>MongoDB\Driver\ReadConcern</class>, который является объектом неизменяемого значения.

<comment>Param:</comment>
  <info>string|null</info>  <strong>$level</strong>  Уровень гарантий чтения. Вы можете использовать, но не ограничиваясь этим,
                       одну из констант класса.

<comment>See Also:</comment>
   * Справка по гарантиям чтения


id: MongoDB\Driver\ReadConcern::bsonSerialize
type: function
doc:
<comment>Description:</comment>
  Возвращает объект для сериализации BSON

<comment>Return:</comment>
  <info>stdClass</info>  Возвращает объект для сериализации ReadConcern, как BSON.

<comment>See Also:</comment>
   * MongoDB\BSON\Serializable::bsonSerialize
   * Справка по гарантиям чтения


id: MongoDB\Driver\ReadConcern::getLevel
type: function
doc:
<comment>Description:</comment>
  Возвращает опцию "level" ReadConcern

<comment>Return:</comment>
  <info>string|null</info>  Возвращает опцию "level" ReadConcern.

<comment>See Also:</comment>
   * Справка по гарантиям чтения


id: MongoDB\Driver\ReadConcern::isDefault
type: function
doc:
<comment>Description:</comment>
  Проверяет, является ли гарантией чтения по умолчанию
  
  Возвращает, является ли это гарантией чтения по умолчанию (т.е. параметры не указаны). Этот метод
  в первую очередь предназначен для использования в сочетании с
  MongoDB\Driver\Manager::getReadConcern, чтобы определить, был ли построен Manager без каких-либо
  гарантий чтения.
  
  Драйвер не будет включать в себя гарантии чтения по умолчанию в своих операциях чтения (например,
  MongoDB\Driver\Manager::executeQuery), чтобы сервер мог применять свои собственные значения по
  умолчанию. Библиотеки, которые обращаются к гарантиям чтения Manager, чтобы включить его в свои
  собственные команды чтения, должны использовать этот метод, чтобы гарантировать, что гарантии
  чтения по умолчанию остаются неустановленными.

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

<comment>See Also:</comment>
   * MongoDB\Driver\Manager::getReadConcern
   * Справка по гарантиям чтения


id: MongoDB\Driver\ReadConcern::serialize
type: function
doc:
<comment>Description:</comment>
  Сериализация ReadConcern

<comment>Return:</comment>
  <info>string</info>  Возвращает сериализованное представление <class>MongoDB\Driver\ReadConcern</class>.

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


id: MongoDB\Driver\ReadConcern::unserialize
type: function
doc:
<comment>Description:</comment>
  Десериализация ReadConcern

<comment>Param:</comment>
  <info>string</info>  <strong>$data</strong>  Сериализованный <class>MongoDB\Driver\ReadConcern</class>.

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

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


id: MongoDB\Driver\ReadPreference::NEAREST
type: constant
doc:
<comment>Description:</comment>
  Операции считываются из узла набора реплик с наименьшей задержкой в сети, независимо от типа.


id: MongoDB\Driver\ReadPreference::NO_MAX_STALENESS
type: constant
doc:
<comment>Description:</comment>
  Значение по умолчанию для параметра <return>"maxStalenessSeconds"</return> чтобы указать на ограничение на
  максимальное запаздывание (staleness), что означает, что драйвер не будет учитывать задержку
  вторичных узлов при выборе направления для операции чтения.


id: MongoDB\Driver\ReadPreference::PRIMARY
type: constant
doc:
<comment>Description:</comment>
  Все операции чтения из текущей реплики установлены первичными. Это предпочтение чтения по
  умолчанию для MongoDB.


id: MongoDB\Driver\ReadPreference::PRIMARY_PREFERRED
type: constant
doc:
<comment>Description:</comment>
  В большинстве случаев операции читаются из первичного узла, но если он недоступен, операции
  читаются с вторичных узлов.


id: MongoDB\Driver\ReadPreference::RP_NEAREST
type: constant
doc:
<comment>Description:</comment>
  Операции считываются из члена набора реплик с наименьшей задержкой сети, независимо от типа члена.


id: MongoDB\Driver\ReadPreference::RP_PRIMARY
type: constant
doc:
<comment>Description:</comment>
  Все операции считываются из текущего первичного узла набора реплик. Это предпочтение чтения по
  умолчанию для MongoDB.


id: MongoDB\Driver\ReadPreference::RP_PRIMARY_PREFERRED
type: constant
doc:
<comment>Description:</comment>
  В большинстве ситуация операции считываются из первичного узла, но если он недоступен, операции
  считываются из вторичных членов.


id: MongoDB\Driver\ReadPreference::RP_SECONDARY_PREFERRED
type: constant
doc:
<comment>Description:</comment>
  В большинстве ситуация операции считываются из вторичных узлов, но если они недоступны, операции
  считываются из первичного узла.


id: MongoDB\Driver\ReadPreference::SECONDARY_PREFERRED
type: constant
doc:
<comment>Description:</comment>
  В большинстве случаев операции читаются из вторичных узлов, но если они недоступны, операции
  читаются с первичного.


id: MongoDB\Driver\ReadPreference::SMALLEST_MAX_STALENESS_SECONDS
type: constant
doc:
<comment>Description:</comment>
  Минимальное значение для параметра  <return>"maxStalenessSeconds"</return> равно 90 секундам. Драйвер оценивает
  запаздывание (staleness) вторичных узлов, периодически проверяя последнюю дату записи каждого
  члена набора реплик. Поскольку эти проверки являются нечастыми, оценка запаздывания является
  грубой. Таким образом, драйвер не может обеспечить максимальную величину запаздывания менее 90
  секунд.


id: MongoDB\Driver\ReadPreference::__construct
type: function
doc:
<comment>Description:</comment>
  Создать новый ReadPreference
  
  Создаёт новый <class>MongoDB\Driver\ReadPreference</class>, который является неизменяемым объектом значения.

<comment>Param:</comment>
  <info>string|int</info>  <strong>$mode</strong>     Режим предпочтения
                        чтенияЗначениеОписание<info>MongoDB\Driver\ReadPreference::RP_PRIMARY</info> or <return>"primary"</return>
                        Все операции считывается из текущего первичного узла набора реплик. Это
                        предпочтение чтения по умолчанию для MongoDB.
                        <info>MongoDB\Driver\ReadPreference::RP_PRIMARY_PREFERRED</info> or <return>"primaryPreferred"</return> В
                        большинстве ситуаций операции считываются из первичного узла, но если он
                        недоступен, операции считываются из вторичных узлов.
                        <info>MongoDB\Driver\ReadPreference::RP_SECONDARY</info> или <return>"secondary"</return> Все операции
                        считываются из вторичных узлов набора реплик.
                        <info>MongoDB\Driver\ReadPreference::RP_SECONDARY_PREFERRED</info> или
                        <return>"secondaryPreferred"</return> В большинстве ситуаций операции считываются из
                        вторичных членов, но если вторичные члены недоступны, операции считываются
                        из первичного узла. <info>MongoDB\Driver\ReadPreference::RP_NEAREST</info> or <return>"nearest"</return>
                        Операции считываются из члена набора реплик с наименьшей задержкой сети,
                        независимо от типа члена.
                        
                        Все операции считывается из текущего первичного узла набора реплик. Это
                        предпочтение чтения по умолчанию для MongoDB.
                        
                        В большинстве ситуаций операции считываются из первичного узла, но если он
                        недоступен, операции считываются из вторичных узлов.
                        
                        Все операции считываются из вторичных узлов набора реплик.
                        
                        В большинстве ситуаций операции считываются из вторичных членов, но если
                        вторичные члены недоступны, операции считываются из первичного узла.
                        
                        Операции считываются из члена набора реплик с наименьшей задержкой сети,
                        независимо от типа члена.
  <info>array|null</info>  <strong>$tagSets</strong>  Наборы тегов позволяют настраивать операции чтения для определённых членов
                        набора реплик. Этот параметр должен быть массивом ассоциативных массивов,
                        каждый из которых содержит ноль или несколько пар ключ-значение. При выборе
                        сервера для операции чтения драйвер пытается выбрать узел, имеющий все теги
                        в наборе (т.е. ассоциативный массив пар ключ-значение). Если выбор не
                        удался, the driver will attempt subsequent sets. Пустой набор тегов
                        (<return>array()</return>) будет соответствовать любому узлу и может использоваться как
                        резервный.
                        
                        Теги не совместимы с режимом <info>MongoDB\Driver\ReadPreference::RP_PRIMARY</info>, и,
                        как правило, применяется только при выборе вторичного члена набора для
                        операции чтения. Однако режим <info>MongoDB\Driver\ReadPreference::RP_NEAREST</info> в
                        сочетании с набором тегов, выбирает соответствующий член с наименьшей
                        задержкой сети. Этот член может быть первичным или вторичным.
  <info>array|null</info>  <strong>$options</strong>  optionsОпцияТипОписаниеhedge<info>object</info><info>array</info></info>Указывает, использовать ли
                        хеджированные чтения, которые поддерживаются MongoDB 4.4+ для закрытых
                        запросов. Хеджированные чтения с сервера доступны для всех неосновных
                        предпочтений чтения и включаются по умолчанию при использовании режима
                        <return>"nearest"</return>. Этот параметр позволяет явно разрешить чтение с хеджированием на
                        сервере для неосновных предпочтений чтения, указав <return>['enabled' =&gt; true]</return>,
                        или явно отключив серверное чтение с хеджированием для предпочтения чтения
                        <return>"nearest"</return>, указав <return>['enabled' =&gt; false]</return>. maxStalenessSeconds<info>int</info> Определяет
                        максимальное отставание репликации или "staleness", для чтения из вторичных
                        узлов. Когда оцениваемая staleness вторичных узлов превышает это значение,
                        драйвер прекращает использовать её для операций чтения.  Если указано,
                        максимальный staleness должен быть 32-битным числом без знака, большим или
                        равным <info>MongoDB\Driver\ReadPreference::SMALLEST_MAX_STALENESS_SECONDS</info>.  По
                        умолчанию используется <info>MongoDB\Driver\ReadPreference::NO_MAX_STALENESS</info>, что
                        означает, что драйвер не будет учитывать отставания вторичных узлов при
                        выборе направления для операции чтения.  Этот параметр несовместим с режимом
                        <info>MongoDB\Driver\ReadPreference::RP_PRIMARY</info>. Указание максимальной staleness
                        также требует, чтобы все экземпляры MongoDB в развёртывании использовали
                        MongoDB 3.4+. Исключение будет выброшено во время выполнения, если
                        экземпляры MongoDB в развёртывании имеют более старую версию.
                        
                        Указывает, использовать ли хеджированные чтения, которые поддерживаются
                        MongoDB 4.4+ для закрытых запросов.
                        
                        Хеджированные чтения с сервера доступны для всех неосновных предпочтений
                        чтения и включаются по умолчанию при использовании режима <return>"nearest"</return>. Этот
                        параметр позволяет явно разрешить чтение с хеджированием на сервере для
                        неосновных предпочтений чтения, указав <return>['enabled' =&gt; true]</return>, или явно
                        отключив серверное чтение с хеджированием для предпочтения чтения <return>"nearest"</return>,
                        указав <return>['enabled' =&gt; false]</return>.
                        
                        Определяет максимальное отставание репликации или "staleness", для чтения из
                        вторичных узлов. Когда оцениваемая staleness вторичных узлов превышает это
                        значение, драйвер прекращает использовать её для операций чтения.
                        
                        Если указано, максимальный staleness должен быть 32-битным числом без знака,
                        большим или равным
                        <info>MongoDB\Driver\ReadPreference::SMALLEST_MAX_STALENESS_SECONDS</info>.
                        
                        По умолчанию используется <info>MongoDB\Driver\ReadPreference::NO_MAX_STALENESS</info>,
                        что означает, что драйвер не будет учитывать отставания вторичных узлов при
                        выборе направления для операции чтения.
                        
                        Этот параметр несовместим с режимом
                        <info>MongoDB\Driver\ReadPreference::RP_PRIMARY</info>. Указание максимальной staleness
                        также требует, чтобы все экземпляры MongoDB в развёртывании использовали
                        MongoDB 3.4+. Исключение будет выброшено во время выполнения, если
                        экземпляры MongoDB в развёртывании имеют более старую версию.

<comment>See Also:</comment>
   * Руководство по предпочтению чтения


id: MongoDB\Driver\ReadPreference::bsonSerialize
type: function
doc:
<comment>Description:</comment>
  Возвращает объект сериализации BSON

<comment>Return:</comment>
  <info>stdClass</info>  Возвращает объект сериализации ReadPreference как BSON.

<comment>See Also:</comment>
   * MongoDB\BSON\Serializable::bsonSerialize
   * Справочная информация по предпочтению чтения


id: MongoDB\Driver\ReadPreference::getHedge
type: function
doc:
<comment>Description:</comment>
  Возвращает опцию "hedge" из ReadPreference

<comment>Return:</comment>
  <info>object|null</info>  Возвращает опцию "hedge" из ReadPreference.

<comment>See Also:</comment>
   * документация по Read Preference


id: MongoDB\Driver\ReadPreference::getMaxStalenessSeconds
type: function
doc:
<comment>Description:</comment>
  Возвращает параметр "maxStalenessSeconds" ReadPreference

<comment>Return:</comment>
  <info>int</info>  Возвращает параметр "maxStalenessSeconds" ReadPreference. Если не указана максимальная
       staleness, возвращается <info>MongoDB\Driver\ReadPreference::NO_MAX_STALENESS</info>.

<comment>See Also:</comment>
   * Руководство по предпочтению чтения


id: MongoDB\Driver\ReadPreference::getMode
type: function
doc:
<comment>Description:</comment>
  Возвращает параметр "mode" ReadPreference

<comment>Return:</comment>
  <info>int</info>  Возвращает параметр "mode" ReadPreference

<comment>See Also:</comment>
   * MongoDB\Driver\ReadPreference::getModeString
   * Руководство по предпочтению чтения


id: MongoDB\Driver\ReadPreference::getModeString
type: function
doc:
<comment>Description:</comment>
  Возвращает опцию "mode" объекта ReadPreference в виде строки

<comment>Return:</comment>
  <info>string</info>  Возвращает опцию "mode" объекта ReadPreference в виде строки.

<comment>See Also:</comment>
   * MongoDB\Driver\ReadPreference::getMode
   * Документация по Read Preference


id: MongoDB\Driver\ReadPreference::getTagSets
type: function
doc:
<comment>Description:</comment>
  Возвращает параметр "tagSets" ReadPreference

<comment>Return:</comment>
  <info>array</info>  Возвращает параметр "tagSets" ReadPreference.

<comment>See Also:</comment>
   * Справочная информация по предпочтению чтения


id: MongoDB\Driver\ReadPreference::serialize
type: function
doc:
<comment>Description:</comment>
  Сериализация ReadPreference

<comment>Return:</comment>
  <info>string</info>  Возвращает сериализованное представление <class>MongoDB\Driver\ReadPreference</class>.

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


id: MongoDB\Driver\ReadPreference::unserialize
type: function
doc:
<comment>Description:</comment>
  Десериализация ReadPreference

<comment>Param:</comment>
  <info>string</info>  <strong>$data</strong>  Сериализованный <class>MongoDB\Driver\ReadPreference</class>.

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

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


id: MongoDB\Driver\Server::TYPE_LOAD_BALANCER
type: constant
doc:
<comment>Description:</comment>
  Тип сервера балансировщика нагрузки, возвращаемый MongoDB\Driver\Server::getType.


id: MongoDB\Driver\Server::TYPE_POSSIBLE_PRIMARY
type: constant
doc:
<comment>Description:</comment>
  Тип набора реплик возможного основного сервера, возвращаемый MongoDB\Driver\Server::getType.
  
  Сервер может быть идентифицирован как возможный основной, если он ещё не был проверен, но другая
  память набора реплик думает, что он является основным.


id: MongoDB\Driver\Server::TYPE_RS_ARBITER
type: constant
doc:
<comment>Description:</comment>
  Тип набора реплик арбитра сервера, возвращаемый MongoDB\Driver\Server::getType.


id: MongoDB\Driver\Server::TYPE_RS_GHOST
type: constant
doc:
<comment>Description:</comment>
  Призрачный тип набора реплик, возвращаемый MongoDB\Driver\Server::getType.
  
  Серверы могут быть идентифицированы как таковые, по крайней мере, в трёх ситуациях: кратко во
  время запуска сервера; в неинициализированном наборе реплик; или когда сервер держится в стороне
  (т.е. удаляется из конфигурации набора реплик). Они не могут быть запрошены, и их список хостов не
  может быть использован для обнаружения текущей конфигурации набора реплик; однако клиент может
  отслеживать этот сервер в надежде, что он переходит в более полезное состояние.


id: MongoDB\Driver\Server::TYPE_RS_OTHER
type: constant
doc:
<comment>Description:</comment>
  Другой тип набора реплик сервера, возвращаемый MongoDB\Driver\Server::getType.
  
  Такие серверы могут быть скрыты, запускаются или восстанавливаются. Они не могут быть запрошены,
  но их списки хостов полезны для обнаружения текущей конфигурации набора реплик.


id: MongoDB\Driver\Server::TYPE_RS_PRIMARY
type: constant
doc:
<comment>Description:</comment>
  Тип набора реплик основного сервера, возвращаемый MongoDB\Driver\Server::getType.


id: MongoDB\Driver\Server::TYPE_RS_SECONDARY
type: constant
doc:
<comment>Description:</comment>
  Тип набора реплик вторичного сервера, возвращаемый MongoDB\Driver\Server::getType.


id: MongoDB\Driver\Server::TYPE_STANDALONE
type: constant
doc:
<comment>Description:</comment>
  Автономный тип сервера, возвращаемый MongoDB\Driver\Server::getType.


id: MongoDB\Driver\Server::TYPE_UNKNOWN
type: constant
doc:
<comment>Description:</comment>
  Неизвестный тип сервера, возвращаемый MongoDB\Driver\Server::getType.


id: MongoDB\Driver\Server::__construct
type: function
doc:
<comment>Description:</comment>
  Создаёт новый Server (не используется)
  
  Объекты <class>MongoDB\Driver\Server</class> создаются внутри <class>MongoDB\Driver\Manager</class>, когда соединение с базой
  данных установлено и могут быть возвращены <strong>MongoDB\Driver\Manager::getServers()</strong> и
  <strong>MongoDB\Driver\Manager::selectServer()</strong>.

<comment>See Also:</comment>
   * <strong>MongoDB\Driver\Manager::getServers()</strong>
   * <strong>MongoDB\Driver\Manager::selectServer()</strong>


id: MongoDB\Driver\Server::executeBulkWrite
type: function
doc:
<comment>Description:</comment>
  Выполнить одну или несколько операций записи на сервере
  
  Выполняет одну или несколько операций записи на сервере.
  
  Объект <class>MongoDB\Driver\BulkWrite</class> может быть создан с одной или несколькими операциями записи
  различного типа (например, обновления, удаления и вставки). Драйвер попытается отправить операции
  одного типа на сервер в виде как можно меньшего количества запросов для сокращения обращений к
  серверу.

<comment>Param:</comment>
  <info>string</info>                                  <strong>$namespace</strong>  Полностью определённое имя (т.е.
                                                      <return>"databaseName.collectionName"</return>).
  <info>MongoDB\Driver\BulkWrite</info>                <strong>$bulk</strong>       Записи для выполнения.
  <info>array|MongoDB\Driver\WriteConcern|null</info>  <strong>$options</strong>    
                                                      optionsОпцияТипОписаниеsession<class>MongoDB\Driver\Session</class>
                                                      Сессия для связывания с операцией.
                                                      writeConcern<class>MongoDB\Driver\WriteConcern</class>
                                                      Гарантия записи для применения к операции.
                                                      
                                                      Сессия для связывания с операцией.
                                                      
                                                      Гарантия записи для применения к операции.

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

<comment>See Also:</comment>
   * <class>MongoDB\Driver\BulkWrite</class>
   * <class>MongoDB\Driver\WriteResult</class>
   * <class>MongoDB\Driver\WriteConcern</class>
   * <strong>MongoDB\Driver\Manager::executeBulkWrite()</strong>


id: MongoDB\Driver\Server::executeCommand
type: function
doc:
<comment>Description:</comment>
  Выполнить команду базы данных на сервере
  
  Выполняет команду на сервере.
  
  Этот метод не применяет особую логику к команде. Хотя этот метод принимает <return>"readConcern"</return> и
  <return>"writeConcern"</return>, которые будут включены в документы коанды, эти опции не будут соответствовать
  значениям по умолчанию из MongoDB URI соединения , и не будет учитываться версия сервера MongoDB.
  Поэтому пользователям рекомендуется использовать конкретные методы команды чтения и/или записи
  если это возможно.
  
  Опция <return>"readPreference"</return> не контролирует сервер, к которому драйвер выполняет операцию; она всегда
  будет выполняться на этом объекте сервера. Вместо этого, он может быть использован при выполнении
  операции на втором узле (из набора реплик, не автономный) или на узле mongos для обеспечения того,
  что драйвер устанавливает проводной протокол соответствующим образом или добавляет предпочтение
  чтения к операции, соответственно.

<comment>Param:</comment>
  <info>string</info>                                    <strong>$db</strong>       Имя базы данных, в которой запускается
                                                      команда.
  <info>MongoDB\Driver\Command</info>                    <strong>$command</strong>  Команда для выполнения.
  <info>array|MongoDB\Driver\ReadPreference|null</info>  <strong>$options</strong>  
                                                      optionsОпцияТипОписаниеreadConcern<class>MongoDB\Driver\ReadConcern</class>
                                                      Гарантия чтения для применения к операции.
                                                      Эта опция доступна в MongoDB 3.2+ и приведёт к
                                                      исключению во время выполнения, если указана
                                                      для более старой версии сервера.
                                                      readPreference<class>MongoDB\Driver\ReadPreference</class>
                                                      Предпочтение чтения, используемая для выбора
                                                      сервера для выполнения операции.
                                                      session<class>MongoDB\Driver\Session</class> Сессия для
                                                      связывания с операцией.
                                                      writeConcern<class>MongoDB\Driver\WriteConcern</class>
                                                      Гарантия записи для применения к операции.
                                                      
                                                      Гарантия чтения для применения к операции.
                                                      
                                                      Эта опция доступна в MongoDB 3.2+ и приведёт к
                                                      исключению во время выполнения, если указана
                                                      для более старой версии сервера.
                                                      
                                                      Предпочтение чтения, используемая для выбора
                                                      сервера для выполнения операции.
                                                      
                                                      Сессия для связывания с операцией.
                                                      
                                                      Гарантия записи для применения к операции.
                                                      
                                                      При использовании <return>"session"</return> и наличии
                                                      незавершённых транзакций, вы не можете указать
                                                      <return>"readConcern"</return> or <return>"writeConcern"</return> option. Это
                                                      приведёт к выбрасыванию исключения
                                                      <class>MongoDB\Driver\Exception\InvalidArgumentException</class>.
                                                      Вместо этого вы должны установить эти две
                                                      опции при создании транзакции с помощью
                                                      MongoDB\Driver\Session::startTransaction.

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

<comment>See Also:</comment>
   * <class>MongoDB\Driver\Command</class>
   * <class>MongoDB\Driver\Cursor</class>
   * <strong>MongoDB\Driver\Server::executeReadCommand()</strong>
   * <strong>MongoDB\Driver\Server::executeReadWriteCommand()</strong>
   * <strong>MongoDB\Driver\Server::executeWriteCommand()</strong>
   * <strong>MongoDB\Driver\Manager::executeCommand()</strong>


id: MongoDB\Driver\Server::executeQuery
type: function
doc:
<comment>Description:</comment>
  Выполняет запрос к базе данных на сервере
  
  Выполняет запрос на сервере.
  
  Опция <return>"readPreference"</return> не управляет сервером, которому драйвер выполняет операцию; он всегда будет
  выполняться на этом объекте сервера. Вместо этого его можно использовать при выдаче операции на
  вторичном сервере (из соединения с репликой, а не автономном) или узел mongos, чтобы
  гарантировать, что драйвер соответственно устанавливает проводной протокол или добавляет
  предпочтения чтения к операции, соответственно.

<comment>Param:</comment>
  <info>string</info>                                    <strong>$namespace</strong>  Полностью определённое имя (т.е.
                                                        <return>"databaseName.collectionName"</return>).
  <info>MongoDB\Driver\Query</info>                      <strong>$query</strong>      Запрос для выполнения.
  <info>array|MongoDB\Driver\ReadPreference|null</info>  <strong>$options</strong>    
                                                        optionsОпцияТипОписаниеreadPreference<class>MongoDB\Driver\ReadPreference</class>
                                                        Предпочтение чтения, используемая для выбора
                                                        сервера для выполнения операции.
                                                        session<class>MongoDB\Driver\Session</class> Сессия для
                                                        связывания с операцией.
                                                        
                                                        Предпочтение чтения, используемая для выбора
                                                        сервера для выполнения операции.
                                                        
                                                        Сессия для связывания с операцией.

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

<comment>See Also:</comment>
   * <class>MongoDB\Driver\Cursor</class>
   * <class>MongoDB\Driver\Query</class>
   * <class>MongoDB\Driver\ReadPreference</class>
   * <strong>MongoDB\Driver\Manager::executeQuery()</strong>


id: MongoDB\Driver\Server::executeReadCommand
type: function
doc:
<comment>Description:</comment>
  Выполняет команду базы данных, которая читает на сервере
  
  Выполняет команду на этом сервере.
  
  Этот метод будет применять логику, специфичную для команд, которые читают (например, count) и
  учитывают версию сервера MongoDB. Опция <return>"readConcern"</return> будет по умолчанию соответствовать
  соответствующему значению из URI подключения MongoDB.
  
  Опция <return>"readPreference"</return> не контролирует сервер, к которому драйвер выполняет операцию; она всегда
  будет выполняться на этом объекте сервера. Вместо этого, он может быть использован при выполнении
  операции на втором узле (из набора реплик, не автономный) или на узле mongos для обеспечения того,
  что драйвер устанавливает проводной протокол соответствующим образом или добавляет предпочтение
  чтения к операции, соответственно.

<comment>Param:</comment>
  <info>string</info>                  <strong>$db</strong>       Имя базы данных, в которой запускается команда.
  <info>MongoDB\Driver\Command</info>  <strong>$command</strong>  Команда для выполнения.
  <info>array|null</info>              <strong>$options</strong>  optionsОпцияТипОписаниеreadConcern<class>MongoDB\Driver\ReadConcern</class>
                                    Гарантия чтения для применения к операции.  Эта опция доступна в
                                    MongoDB 3.2+ и приведёт к исключению во время выполнения, если
                                    указана для более старой версии сервера.
                                    readPreference<class>MongoDB\Driver\ReadPreference</class> Предпочтение чтения,
                                    используемая для выбора сервера для выполнения операции.
                                    session<class>MongoDB\Driver\Session</class> Сессия для связывания с операцией.
                                    
                                    Гарантия чтения для применения к операции.
                                    
                                    Эта опция доступна в MongoDB 3.2+ и приведёт к исключению во
                                    время выполнения, если указана для более старой версии сервера.
                                    
                                    Предпочтение чтения, используемая для выбора сервера для
                                    выполнения операции.
                                    
                                    Сессия для связывания с операцией.
                                    
                                    При использовании <return>"session"</return> и наличии незавершённых транзакций,
                                    вы не можете указать <return>"readConcern"</return> or <return>"writeConcern"</return> option. Это
                                    приведёт к выбрасыванию исключения
                                    <class>MongoDB\Driver\Exception\InvalidArgumentException</class>. Вместо этого
                                    вы должны установить эти две опции при создании транзакции с
                                    помощью MongoDB\Driver\Session::startTransaction.

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

<comment>See Also:</comment>
   * <class>MongoDB\Driver\Command</class>
   * <class>MongoDB\Driver\Cursor</class>
   * <strong>MongoDB\Driver\Server::executeCommand()</strong>
   * <strong>MongoDB\Driver\Server::executeReadWriteCommand()</strong>
   * <strong>MongoDB\Driver\Server::executeWriteCommand()</strong>
   * <strong>MongoDB\Driver\Manager::executeReadCommand()</strong>


id: MongoDB\Driver\Server::executeReadWriteCommand
type: function
doc:
<comment>Description:</comment>
  Выполняет команду базы данных, которая читает и пишет на сервере
  
  Выполняет команду на сервере.
  
  Этот метод будет применять логику, специфичную для команд, которые читают и пишут (например,
  aggregate) и учитывают версию сервера MongoDB. Параметры <return>"readConcern"</return> и <return>"writeConcern"</return> по
  умолчанию соответствуют соответствующим значениям из URI подключения MongoDB.

<comment>Param:</comment>
  <info>string</info>                  <strong>$db</strong>       Имя базы данных, в которой запускается команда.
  <info>MongoDB\Driver\Command</info>  <strong>$command</strong>  Команда для выполнения.
  <info>array|null</info>              <strong>$options</strong>  optionsОпцияТипОписаниеreadConcern<class>MongoDB\Driver\ReadConcern</class>
                                    Гарантия чтения для применения к операции.  Эта опция доступна в
                                    MongoDB 3.2+ и приведёт к исключению во время выполнения, если
                                    указана для более старой версии сервера.
                                    session<class>MongoDB\Driver\Session</class> Сессия для связывания с операцией.
                                    writeConcern<class>MongoDB\Driver\WriteConcern</class> Гарантия записи для
                                    применения к операции.
                                    
                                    Гарантия чтения для применения к операции.
                                    
                                    Эта опция доступна в MongoDB 3.2+ и приведёт к исключению во
                                    время выполнения, если указана для более старой версии сервера.
                                    
                                    Сессия для связывания с операцией.
                                    
                                    Гарантия записи для применения к операции.
                                    
                                    При использовании <return>"session"</return> и наличии незавершённых транзакций,
                                    вы не можете указать <return>"readConcern"</return> or <return>"writeConcern"</return> option. Это
                                    приведёт к выбрасыванию исключения
                                    <class>MongoDB\Driver\Exception\InvalidArgumentException</class>. Вместо этого
                                    вы должны установить эти две опции при создании транзакции с
                                    помощью MongoDB\Driver\Session::startTransaction.

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

<comment>See Also:</comment>
   * <class>MongoDB\Driver\Command</class>
   * <class>MongoDB\Driver\Cursor</class>
   * <strong>MongoDB\Driver\Server::executeCommand()</strong>
   * <strong>MongoDB\Driver\Server::executeReadCommand()</strong>
   * <strong>MongoDB\Driver\Server::executeWriteCommand()</strong>
   * <strong>MongoDB\Driver\Manager::executeReadWriteCommand()</strong>


id: MongoDB\Driver\Server::executeWriteCommand
type: function
doc:
<comment>Description:</comment>
  Выполняет команду базы данных, которая пишет на сервере
  
  Выполняет команду на этом сервере.
  
  Этот метод будет применять логику, специфичную для команд, которые пишут (например, drop) и
  учитывают версию сервера MongoDB. Опция <return>"writeConcern"</return> по умолчанию будет соответствовать
  соответствующему значению из URI подключения MongoDB.
  
  Метод не предназначен для выполнения insert, update, или delete команд. Пользователям
  рекомендуется использовать   <strong>MongoDB\Driver\Manager::executeBulkWrite()</strong> для этих команд.

<comment>Param:</comment>
  <info>string</info>                  <strong>$db</strong>       Имя базы данных, в которой запускается команда.
  <info>MongoDB\Driver\Command</info>  <strong>$command</strong>  Команда для выполнения.
  <info>array|null</info>              <strong>$options</strong>  optionsОпцияТипОписаниеsession<class>MongoDB\Driver\Session</class> Сессия для
                                    связывания с операцией. writeConcern<class>MongoDB\Driver\WriteConcern</class>
                                    Гарантия записи для применения к операции.
                                    
                                    Сессия для связывания с операцией.
                                    
                                    Гарантия записи для применения к операции.
                                    
                                    При использовании <return>"session"</return> и наличии незавершённых транзакций,
                                    вы не можете указать <return>"readConcern"</return> or <return>"writeConcern"</return> option. Это
                                    приведёт к выбрасыванию исключения
                                    <class>MongoDB\Driver\Exception\InvalidArgumentException</class>. Вместо этого
                                    вы должны установить эти две опции при создании транзакции с
                                    помощью MongoDB\Driver\Session::startTransaction.

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

<comment>See Also:</comment>
   * <class>MongoDB\Driver\Command</class>
   * <class>MongoDB\Driver\Cursor</class>
   * <strong>MongoDB\Driver\Server::executeCommand()</strong>
   * <strong>MongoDB\Driver\Server::executeReadCommand()</strong>
   * <strong>MongoDB\Driver\Server::executeReadWriteCommand()</strong>
   * <strong>MongoDB\Driver\Manager::executeWriteCommand()</strong>


id: MongoDB\Driver\Server::getHost
type: function
doc:
<comment>Description:</comment>
  Возвращает имя хоста сервера
  
  Возвращает имя хоста сервера.

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

<comment>See Also:</comment>
   * <strong>MongoDB\Driver\Server::getInfo()</strong>
   * <strong>MongoDB\Driver\ServerDescription::getHost()</strong>


id: MongoDB\Driver\Server::getInfo
type: function
doc:
<comment>Description:</comment>
  Возвращает массив информации, описывающий сервер
  
  Возвращает массив информации, описывающий сервер. Этот массив получен из последнего ответа команды
  hello, полученного с помощью мониторинга сервера.
  
  Когда драйвер подключён к балансировщику нагрузки, метод вернёт ответ на команду hello от
  резервного сервера при первоначальном подтверждении соединения. Это отличается от других методов
  (например, <strong>MongoDB\Driver\Server::getType()</strong>), которые возвращают информацию о самом балансировщике
  нагрузки.

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

<comment>See Also:</comment>
   * <strong>MongoDB\Driver\ServerDescription::getHelloResponse()</strong>
   * Команда hello в руководстве MongoDB
   * Руководство по обнаружению и мониторингу серверов


