# php_manual

id: SQLite3::lastErrorCode
type: function
doc:
<comment>Description:</comment>
  Возвращает числовой код результата последнего неудачного запроса SQLite
    
  
  Возвращает числовой код результата последнего неудачного запроса SQLite.

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


id: SQLite3::lastErrorMsg
type: function
doc:
<comment>Description:</comment>
  Возвращает текст на английском, описывающий последний неудачный запрос SQLite
    
  
  Возвращает текст на английском, описывающий последний неудачный запрос SQLite.

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


id: SQLite3::lastInsertRowID
type: function
doc:
<comment>Description:</comment>
  Возвращает идентификатор строки последней вставки (INSERT) в базу данных
  
  Возвращает идентификатор строки последней вставки (INSERT) в базу данных.

<comment>Return:</comment>
  <info>int</info>  Возвращает идентификатор строки последней вставки (INSERT) в базу данных. Если при этом
       соединении с базой данных никогда не происходило успешных операций INSERT в таблицы rowid, то
       SQLite3::lastInsertRowID возвращает <return>0</return>.


id: SQLite3::loadExtension
type: function
doc:
<comment>Description:</comment>
  Попытаться загрузить библиотеку модуля SQLite
  
  Попытаться загрузить библиотеку модуля SQLite.

<comment>Param:</comment>
  <info>string</info>  <strong>$name</strong>  Имя загружаемой библиотеки. Библиотека должна находиться в каталоге, указанном в
                 конфигурационной опции sqlite3.extension_dir.

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


id: SQLite3::open
type: function
doc:
<comment>Description:</comment>
  Открыть базу данных SQLite
  
  Открывает базу данных SQLite 3. Если сборка включает шифрование, то она будет пробовать
  использовать ключ.

<comment>Param:</comment>
  <info>string</info>  <strong>$filename</strong>       Путь к БД SQLite или <return>:memory:</return> для использования БД в памяти.
  <info>int</info>     <strong>$flags</strong>          Опциональные флаги используемые для определения, как открывать БД. По
                          умолчанию <return>SQLITE3_OPEN_READWRITE | SQLITE3_OPEN_CREATE</return>.
                          <return>SQLITE3_OPEN_READONLY</return>: Открыть БД только для чтения.
                          <return>SQLITE3_OPEN_READWRITE</return>: Открыть БД для чтения и записи.
                          <return>SQLITE3_OPEN_CREATE</return>: Создать БД, если её нет.
                          
                          <return>SQLITE3_OPEN_READONLY</return>: Открыть БД только для чтения.
                          
                          <return>SQLITE3_OPEN_READWRITE</return>: Открыть БД для чтения и записи.
                          
                          <return>SQLITE3_OPEN_CREATE</return>: Создать БД, если её нет.
  <info>string</info>  <strong>$encryptionKey</strong>  Опциональный ключ, для использования шифрования при работе с БД. Если
                          модуль шифрования не установлен, то данная опция не будет использована.

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


id: SQLite3::openBlob
type: function
doc:
<comment>Description:</comment>
  Открывает ресурс потока для чтения BLOB
  
  Открывает ресурс потока для чтения или записи BLOB, который будет выбран:
  
  SELECT <strong>$column</strong> FROM <strong>$database</strong>.<strong>$table</strong> WHERE rowid = <strong>$rowid</strong>
  
  Невозможно изменить размер BLOB путём записи в поток. Вместо этого необходимо выполнить запрос
  UPDATE, возможно, используя SQLite-функцию zeroblob(), чтобы задать желаемый размер BLOB.

<comment>Param:</comment>
  <info>string</info>  <strong>$table</strong>     Название таблицы.
  <info>string</info>  <strong>$column</strong>    Название столбца.
  <info>int</info>     <strong>$rowid</strong>     Идентификатор строки.
  <info>string</info>  <strong>$database</strong>  Символическое название базы данных
  <info>int</info>     <strong>$flags</strong>     Либо <info>SQLITE3_OPEN_READONLY</info>, либо <info>SQLITE3_OPEN_READWRITE</info>, чтобы открыть поток
                     только для чтения или для чтения и записи, соответственно.

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


id: SQLite3::prepare
type: function
doc:
<comment>Description:</comment>
  Подготавливает SQL-запрос для выполнения
  
  Подготавливает SQL-запрос для выполнения и возвращает объект <class>SQLite3Stmt</class>.

<comment>Param:</comment>
  <info>string</info>  <strong>$query</strong>  SQL-запрос на подготовку.

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

<comment>See Also:</comment>
   * SQLite3Stmt::paramCount
   * SQLite3Stmt::bindValue
   * SQLite3Stmt::bindParam


id: SQLite3::query
type: function
doc:
<comment>Description:</comment>
  Выполняет SQL-запрос
  
  Выполняет SQL-запрос и возвращает объект <class>SQLite3Result</class>. Если запрос не возвращает результат
  (например, запрос типа DLM), то возвращённый объект <class>SQLite3Result</class> бесполезен. Для подобных
  запросов используйте метод SQLite3::exec.

<comment>Param:</comment>
  <info>string</info>  <strong>$query</strong>  SQL-запрос для выполнения.

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


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

<comment>Param:</comment>
  <info>string</info>  <strong>$query</strong>      SQL запрос для выполнения.
  <info>bool</info>    <strong>$entireRow</strong>  По умолчанию, функция <strong>querySingle()</strong> возвращает значение первого столбца,
                      возвращаемого запросом. Если параметр <strong>$entireRow</strong> является <info>true</info>, то запрос
                      возвращает массив всего первого ряда.

<comment>Return:</comment>
  <info>mixed</info>  Возвращает значение первого столбца результатов или массив всей первой строки (если
         параметр <strong>$entireRow</strong> является <info>true</info>).
         
         Если запрос корректный, но результат пуст, то вернётся <info>null</info>, если параметр <strong>$entireRow</strong>
         является <info>false</info>, в противном случае возвращается пустой массив.
         
         Неверный или отсутствующий запрос возвращает <info>false</info>.


id: SQLite3::setAuthorizer
type: function
doc:
<comment>Description:</comment>
  Устанавливает callback-функцию, которая будет использоваться в качестве авторизатора для
  ограничения
  действий выражения
  
  Устанавливает callback-функцию, которая будет вызываться SQLite каждый раз при выполнении действия
  (чтение, удаление, модификация и т.д.). Это используется при подготовке SQL-выражения из
  ненадёжного источника, чтобы гарантировать, что SQL-выражения не будут пытаться получить доступ к
  данным, которые им не разрешено видеть, или чтобы они не пытались выполнить вредоносные выражения,
  которые повреждают базу данных. Например, приложение может позволить пользователю вводить
  произвольные SQL-запросы для выполнения в базе данных. Но приложение не хочет, чтобы пользователь
  мог вносить произвольные изменения в базу данных. Тогда можно установить авторизатор, который
  запрещает использование любых выражений, кроме SELECT, пока готовится введённый пользователем
  SQL-запрос.
  
  Callback-авторизатор может бывать вызван несколько раз для каждого выражения, подготовленного
  SQLite. Запросы <return>SELECT</return> или <return>UPDATE</return> будут вызывать авторизатор для каждой считываемой или
  модифицируемой колонки.
  
  При вызове авторизатора может использоваться до пяти параметров. Первый параметр передаётся
  всегда, его тип - целое число (<info>int</info>) (код действия), совпадающий с константой <return>SQLite3</return>. Другие
  параметры передаются только для некоторых действий. Данная таблица описывает второй и третий
  параметры в соответствии с действием: Список кодов действия и параметровДействиеВторой
  параметрТретий параметр<info>SQLite3::CREATE_INDEX</info>Имя индексаИмя таблицы<info>SQLite3::CREATE_TABLE</info>Имя
  таблицы<info>null</info><info>SQLite3::CREATE_TEMP_INDEX</info>Имя индексаИмя таблицы<info>SQLite3::CREATE_TEMP_TABLE</info>Имя
  таблицы<info>null</info><info>SQLite3::CREATE_TEMP_TRIGGER</info>Имя триггераИмя таблицы<info>SQLite3::CREATE_TEMP_VIEW</info>Имя
  представления<info>null</info><info>SQLite3::CREATE_TRIGGER</info>Имя триггераИмя таблицы<info>SQLite3::CREATE_VIEW</info>Имя
  представления<info>null</info><info>SQLite3::DELETE</info>Имя таблицы<info>null</info><info>SQLite3::DROP_INDEX</info>Имя индексаИмя
  таблицы<info>SQLite3::DROP_TABLE</info>Имя таблицы<info>null</info><info>SQLite3::DROP_TEMP_INDEX</info>Имя индексаИмя
  таблицы<info>SQLite3::DROP_TEMP_TABLE</info>Имя таблицы<info>null</info><info>SQLite3::DROP_TEMP_TRIGGER</info>Имя триггераИмя
  таблицы<info>SQLite3::DROP_TEMP_VIEW</info>Имя представления<info>null</info><info>SQLite3::DROP_TRIGGER</info>Имя триггераИмя
  таблицы<info>SQLite3::DROP_VIEW</info>Имя представления<info>null</info><info>SQLite3::INSERT</info>Имя таблицы<info>null</info><info>SQLite3::PRAGMA</info>Имя
  pragmaПервый аргумент, переданный pragma, или <info>null</info><info>SQLite3::READ</info>Имя таблицыИмя
  колонки<info>SQLite3::SELECT</info><info>null</info><info>null</info><info>SQLite3::TRANSACTION</info>Операция<info>null</info><info>SQLite3::UPDATE</info>Имя таблицыИмя
  колонки<info>SQLite3::ATTACH</info>Имя файла<info>null</info><info>SQLite3::DETACH</info>Имя базы данных<info>null</info><info>SQLite3::ALTER_TABLE</info>Имя базы
  данныхИмя таблицы<info>SQLite3::REINDEX</info>Имя индекса<info>null</info><info>SQLite3::ANALYZE</info>Имя
  таблицы<info>null</info><info>SQLite3::CREATE_VTABLE</info>Имя таблицыИмя модуля<info>SQLite3::DROP_VTABLE</info>Имя таблицыИмя
  модуля<info>SQLite3::FUNCTION</info><info>null</info>Имя функции<info>SQLite3::SAVEPOINT</info>ОперацияИмя точки
  сохранения<info>SQLite3::RECURSIVE</info><info>null</info><info>null</info>
  
  Четвёртым параметром будет имя базы данных (<return>"main"</return>, <return>"temp"</return> и т.д.), если необходимо.
  
  Пятый параметр callback-авторизатора - имя самого внутреннего триггера или представления,
  ответственного за попытку получения доступа, или <info>null</info>, если эта попытка получения доступа
  произведена напрямую из кода SQL верхнего уровня.
  
  Когда callback-функция возвращает <info>SQLite3::OK</info>, это значит, что запрошенная операция принята. Когда
  callback-функция возвращает <info>SQLite3::DENY</info>, вызов, запустивший авторизатор, потерпит неудачу с
  сообщением об ошибке, объясняющим, что доступ запрещён.
  
  Если код действия - <info>SQLite3::READ</info>, и callback-функция возвращает <info>SQLite3::IGNORE</info>, то
  подготовленное выражение составляется для замены на <info>null</info> значения колонки таблицы, которое бы
  считывалось, если бы вернулся код <info>SQLite3::OK</info>. Возврат <info>SQLite3::IGNORE</info> может использоваться, чтобы
  запретить недоверенному пользователю доступ к отдельным колонкам таблицы.
  
  Когда на таблицу ссылаются через <return>SELECT</return>, но из неё не извлекается ни одного значения колонок,
  (например, в запросе <return>"SELECT count(*) FROM table"</return>), то callback-авторизатор <info>SQLite3::READ </info>
  вызывается один раз для этой таблицы с именем колонки, которое равно пустой строке.
  
  Если код действия - <info>SQLite3::DELETE</info>, и callback-функция возвращает <info>SQLite3::IGNORE</info>, тогда операция
  DELETE продолжает свою работу, но с выключенной оптимизацией удаления, и все строки удаляются по
  отдельности.
  
  В соединении с базой данных одновременно может использоваться только один авторизатор. Каждый
  вызов SQLite3::setAuthorizer перезаписывает предыдущий. Отключить авторизатор можно, передав <info>null</info>
  вместо callback-функции. По умолчанию авторизатор выключен.
  
  Callback-авторизатор не должен делать ничего, что изменяет подключение к базе данных, которое
  вызвало callback-авторизатор.
  
  Заметьте, что авторизатор вызывается только тогда, когда выражение подготавливается, а не тогда,
  когда оно исполняется.
  
  Более подробную информацию можно найти в Документации SQLite3.

<comment>Param:</comment>
  <info>callable|null</info>  <strong>$callback</strong>  Функция <info>callable</info> для вызова.
                            
                            Если передан <info>null</info>, то текущий callback-авторизатор будет отключён.

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


id: SQLite3::version
type: function
doc:
<comment>Description:</comment>
  Возвращает версию библиотеки SQLite3, содержит как строковую константу, так и числовую
    
  
  Возвращает версию библиотеки SQLite3, содержит как строковую константу, так и числовую.

<comment>Return:</comment>
  <info>array</info>  Возвращает ассоциативный массив с ключами "versionString" и "versionNumber".


id: SQLite3Result
type: class
doc:
<comment>Description:</comment>
  Класс, предоставляющий доступ к результирующему набору модуля SQLite 3.


id: SQLite3Result::__construct
type: function
doc:
<comment>Description:</comment>
  Конструктор класса SQLite3Result
  
  Экземпляры <class>SQLite3Result</class> создаются с помощью SQLite3::query и SQLite3Stmt::execute.


id: SQLite3Result::columnName
type: function
doc:
<comment>Description:</comment>
  >Возвращает имя n-ого столбца
  
  Возвращает имя столбца, указанного в <strong>$column_number</strong>. Обратите внимание, что имя столбца результата
  — это значение предложения <return>AS</return> для этого столбца, если есть предложение <return>AS</return>. Если предложение <return>AS</return>
  отсутствует, тогда имя столбца не указано и может измениться с одного выпуска libsqlite3 на
  другой.

<comment>Param:</comment>
  <info>int</info>  <strong>$column</strong>  Номер столбца, начиная с нуля.

<comment>Return:</comment>
  <info>string|false</info>  Возвращает имя (<info>string</info>) столбца, указанного в <strong>$column</strong>.


id: SQLite3Result::columnType
type: function
doc:
<comment>Description:</comment>
  Возвращает тип n-ного столбца
  
  Возвращает тип столбца, указанного в <strong>$column</strong>.

<comment>Param:</comment>
  <info>int</info>  <strong>$column</strong>  Номер столбца, начиная с нуля.

<comment>Return:</comment>
  <info>int|false</info>  Возвращает тип столбца, указанного в <strong>$column</strong>. Возвращает значение <info>SQLITE3_INTEGER</info>,
             <info>SQLITE3_FLOAT</info>, <info>SQLITE3_TEXT</info>, <info>SQLITE3_BLOB</info>, <info>SQLITE3_NULL</info>) или <info>false</info>, если столбец не
             существует.


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

<comment>Param:</comment>
  <info>int</info>  <strong>$mode</strong>  Этот необязательный параметр принимает значение константы, которая указывает на тип
              массива, в который требуется поместить данные. Возможные значения параметра:
              <return>SQLITE3_ASSOC</return>, <return>SQLITE3_NUM</return> или <return>SQLITE3_BOTH</return>. <return>SQLITE3_ASSOC</return>: возвращает ассоциативный
              массив, в котором индекс соответствует имени столбца в результирующем наборе.
              <return>SQLITE3_NUM</return>: возвращает индексированный массив, в котором индекс соответствует номеру
              столбца в результирующем наборе, начиная с 0. <return>SQLITE3_BOTH</return>: возвращает индексированный
              массив, в котором индекс соответствует имени и номеру столбца в результирующем наборе,
              начиная с 0.
              
              <return>SQLITE3_ASSOC</return>: возвращает ассоциативный массив, в котором индекс соответствует имени
              столбца в результирующем наборе.
              
              <return>SQLITE3_NUM</return>: возвращает индексированный массив, в котором индекс соответствует номеру
              столбца в результирующем наборе, начиная с 0.
              
              <return>SQLITE3_BOTH</return>: возвращает индексированный массив, в котором индекс соответствует имени
              и номеру столбца в результирующем наборе, начиная с 0.

<comment>Return:</comment>
  <info>array|false</info>  Возвращает стоку из результирующего набора в виде ассоциированного или нумерованного
               массива, или обоих. Если строк больше нет, возвращает <info>false</info>.
               
               Типы значений возвращаемого массива преобразуются из типов SQLite3 по следующим
               правилам: целые числа преобразуются в <info>int</info> если помещаются в диапазон
               <info>PHP_INT_MIN</info>..<info>PHP_INT_MAX</info>, иначе в строки. Рациональные числа преобразуются в <info>float</info>,
               <return>NULL</return> в <info>null</info>, строки и BLOB в строки.


id: SQLite3Result::finalize
type: function
doc:
<comment>Description:</comment>
  Закрывает результирующий набор
  
  Закрывает результирующий набор.

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


id: SQLite3Result::numColumns
type: function
doc:
<comment>Description:</comment>
  Возвращает количество столбцов в результирующем наборе
  
  Возвращает количество столбцов в результирующем наборе.

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


id: SQLite3Result::reset
type: function
doc:
<comment>Description:</comment>
  Сбрасывает указатель результирующего набора на первую строку
  
  Сбрасывает указатель результирующего набора на первую строку.

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


id: SQLite3Stmt
type: class
doc:
<comment>Description:</comment>
  Класс, предоставляющий доступ к подготовленным запросам в модуле SQLite 3.


id: SQLite3Stmt::__construct
type: function
doc:
<comment>Description:</comment>
  Конструктор класса SQLite3Stmt
  
  Экземпляры <class>SQLite3Stmt</class> создаются с помощью SQLite3::prepare.

<comment>Param:</comment>
  <info>SQLite3</info>  <strong>$sqlite3</strong>  
  <info>string</info>   <strong>$query</strong>    


id: SQLite3Stmt::bindParam
type: function
doc:
<comment>Description:</comment>
  Связывает параметр с переменной подготовленного запроса
  
  Связывает параметр с переменной подготовленного запроса.
  
  До PHP 7.2.14 и 7.3.0, SQLite3Stmt::reset должен вызываться до первого вызова
  SQLite3Stmt::execute, если надо, чтобы связанное значение корректно обновлялось при последующих
  вызовах SQLite3Stmt::execute. Если метод SQLite3Stmt::reset не вызывался, то связанное значение не
  будет изменяться, даже если значение, присвоенное переменной, переданной SQLite3Stmt::bindParam,
  изменилось или снова был вызван метод SQLite3Stmt::bindParam.

<comment>Param:</comment>
  <info>string|int</info>  <strong>$param</strong>  Либо строка (<info>string</info>) (для именованных параметров), либо целое число (<info>int</info>) (для
                      положительных параметров), идентифицирующая переменную подготовленного
                      запроса, к которому должно быть привязано значение. Если именованный параметр
                      не начинается с двоеточия ((<return>:</return>)) или знака <return>@</return>, автоматически добавляется
                      двоеточие (<return>:</return>). Положительные параметры начинаются с 1.
  <info>mixed</info>       <strong>$var</strong>    Параметр для привязки к переменной подготовленного запроса.
  <info>int</info>         <strong>$type</strong>   Тип данных параметра для привязки. <info>SQLITE3_INTEGER</info>: Значение является целым
                      числом со знаком, которое хранится в 1, 2, 3, 4, 6 или 8 байт в зависимости от
                      величины значения. <info>SQLITE3_FLOAT</info>: Значение является числом с плавающей точкой,
                      которое хранится в виде 8-байтного числа IEEE с плавающей точкой.
                      <info>SQLITE3_TEXT</info>: Значение является текстовой строкой, которое хранится в
                      кодировке базы данных (UTF-8, UTF-16BE или UTF-16-LE). <info>SQLITE3_BLOB</info>: Значение
                      является большим двоичным объектом (blob) данных, который хранится точно так
                      же, как и входные данные. <info>SQLITE3_NULL</info>: Значение является NULL-значением.
                      
                      <info>SQLITE3_INTEGER</info>: Значение является целым числом со знаком, которое хранится в
                      1, 2, 3, 4, 6 или 8 байт в зависимости от величины значения.
                      
                      <info>SQLITE3_FLOAT</info>: Значение является числом с плавающей точкой, которое хранится в
                      виде 8-байтного числа IEEE с плавающей точкой.
                      
                      <info>SQLITE3_TEXT</info>: Значение является текстовой строкой, которое хранится в
                      кодировке базы данных (UTF-8, UTF-16BE или UTF-16-LE).
                      
                      <info>SQLITE3_BLOB</info>: Значение является большим двоичным объектом (blob) данных,
                      который хранится точно так же, как и входные данные.
                      
                      <info>SQLITE3_NULL</info>: Значение является NULL-значением.
                      
                      В PHP 7.0.7, если <strong>$type</strong> опущен, то он автоматически определяется из типа <strong>$var</strong>:
                      <info>bool</info> и <info>int</info> рассматриваются как <info>SQLITE3_INTEGER</info>, <info>float</info> как <info>SQLITE3_FLOAT</info>, <info>null</info>
                      как <info>SQLITE3_NULL</info> и все остальные как <info>SQLITE3_TEXT</info>. Раньше, если тип опущен, то
                      по умолчанию использовался <info>SQLITE3_TEXT</info>.
                      
                      Если <strong>$var</strong> равен <info>null</info>, он всегда обрабатывается как <info>SQLITE3_NULL</info>, независимо от
                      заданного <strong>$type</strong>.

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

<comment>See Also:</comment>
   * SQLite3Stmt::bindValue
   * SQLite3::prepare


id: SQLite3Stmt::bindValue
type: function
doc:
<comment>Description:</comment>
  Связывает значение параметра с переменной подготовленного запроса
  
  Связывает значение параметра с переменной подготовленного запроса.
  
  До PHP 7.2.14 и 7.3.0, если выполнен запрос, необходимо вызвать метод SQLite3Stmt::reset для того,
  чтобы можно было поменять значения связанных параметров.

<comment>Param:</comment>
  <info>string|int</info>  <strong>$param</strong>  Либо строка (<info>string</info>) (для именованных параметров), либо целое число (<info>int</info>) (для
                      положительных параметров), идентифицирующая переменную подготовленного
                      запроса, к которому должно быть привязано значение. Если именованный параметр
                      не начинается с двоеточия ((<return>:</return>)) или знака <return>@</return>, автоматически добавляется
                      двоеточие (<return>:</return>). Положительные параметры начинаются с 1.
  <info>mixed</info>       <strong>$value</strong>  Значение для привязки к переменной подготовленного запроса.
  <info>int</info>         <strong>$type</strong>   Тип данных значения для привязки. <info>SQLITE3_INTEGER</info>: Значение является целым
                      числом со знаком, которое хранится в 1, 2, 3, 4, 6 или 8 байт в зависимости от
                      величины значения. <info>SQLITE3_FLOAT</info>: Значение является числом с плавающей точкой,
                      которое хранится в виде 8-байтного числа IEEE с плавающей точкой.
                      <info>SQLITE3_TEXT</info>: Значение является текстовой строкой, которое хранится в
                      кодировке базы данных (UTF-8, UTF-16BE или UTF-16-LE). <info>SQLITE3_BLOB</info>: Значение
                      является большим двоичным объектом (blob) данных, который хранится точно так
                      же, как и входные данные. <info>SQLITE3_NULL</info>: Значение является NULL-значением.
                      
                      <info>SQLITE3_INTEGER</info>: Значение является целым числом со знаком, которое хранится в
                      1, 2, 3, 4, 6 или 8 байт в зависимости от величины значения.
                      
                      <info>SQLITE3_FLOAT</info>: Значение является числом с плавающей точкой, которое хранится в
                      виде 8-байтного числа IEEE с плавающей точкой.
                      
                      <info>SQLITE3_TEXT</info>: Значение является текстовой строкой, которое хранится в
                      кодировке базы данных (UTF-8, UTF-16BE или UTF-16-LE).
                      
                      <info>SQLITE3_BLOB</info>: Значение является большим двоичным объектом (blob) данных,
                      который хранится точно так же, как и входные данные.
                      
                      <info>SQLITE3_NULL</info>: Значение является NULL-значением.
                      
                      В PHP 7.0.7, если <strong>$type</strong> опущен, то он автоматически определяется из типа
                      <strong>$param</strong>: <info>bool</info> и <info>int</info> рассматриваются как <info>SQLITE3_INTEGER</info>, <info>float</info> как
                      <info>SQLITE3_FLOAT</info>, <info>null</info> как <info>SQLITE3_NULL</info> и всех остальных как <info>SQLITE3_TEXT</info>.
                      Раньше, если тип опущен, он по умолчанию использовался <info>SQLITE3_TEXT</info>.
                      
                      Если <strong>$param</strong> равен <info>null</info>, он всегда обрабатывается как <info>SQLITE3_NULL</info>, независимо
                      от заданного <strong>$type</strong>.

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

<comment>See Also:</comment>
   * SQLite3Stmt::bindParam
   * SQLite3::prepare


id: SQLite3Stmt::clear
type: function
doc:
<comment>Description:</comment>
  Удаляет все текущие привязанные параметры
  
  Удаляет все текущие привязанные параметры (устанавливает их на значение <info>null</info>).
  
  Метод необходимо использовать с SQLite3Stmt::reset. Если используется один, любой вызов
  SQLite3Stmt::bindValue или SQLite3Stmt::bindParam не будет иметь никакого эффекта, и все
  привязанные параметры будут иметь значение <info>null</info>.

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


id: SQLite3Stmt::close
type: function
doc:
<comment>Description:</comment>
  Закрывает подготовленный запрос
  
  Закрывает подготовленный запрос.
  
  Обратите внимание, что все объекты <class>SQLite3Result</class>, полученные при выполнении этого подготовленного
  запроса будут признаны недействительными при закрытии этого запроса.

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


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

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

<comment>See Also:</comment>
   * SQLite3::prepare
   * SQLite3Stmt::bindValue
   * SQLite3Stmt::bindParam


id: SQLite3Stmt::getSQL
type: function
doc:
<comment>Description:</comment>
  Получить SQL-запрос в виде строки из запроса
  
  Возвращает строковое представление SQL-запроса для подготовленного запроса. Если параметр <strong>$expand</strong>
  задан как <info>false</info>, будет возвращён не модифицированный SQL. Если же <strong>$expand</strong> задан как <info>true</info>, все
  подставляемые параметры запроса будут заменены на конкретные значения, либо на <return>NULL</return>, если значения
  ещё не были привязаны.

<comment>Param:</comment>
  <info>bool</info>  <strong>$expand</strong>  Заменять ли в возвращаемом SQL-запросе параметры на конкретные значения. <info>true</info>
                 поддерживается только с libsqlite 3.14.

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


id: SQLite3Stmt::paramCount
type: function
doc:
<comment>Description:</comment>
  Возвращает количество параметров в подготовленном запросе
  
  Возвращает количество параметров в подготовленном запросе.

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

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


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

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


id: SQLite3Stmt::reset
type: function
doc:
<comment>Description:</comment>
  Сбрасывает подготовленный запрос
  
  Сбрасывает подготовленный запрос в состояние до его выполнения. После сброса все привязки остаются
  неизменными.

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


id: SSH2_DEFAULT_TERMINAL
type: constant
doc:
<comment>Description:</comment>
  Принятый по умолчанию тип терминала (например, vt102, ansi, xterm, vanilla), запрашиваемый
  функцией <strong>ssh2_shell()</strong>.


id: SSH2_DEFAULT_TERM_HEIGHT
type: constant
doc:
<comment>Description:</comment>
  Принятое по умолчанию значение высоты окна терминала, принимаемое функцией <strong>ssh2_shell()</strong>.


id: SSH2_DEFAULT_TERM_UNIT
type: constant
doc:
<comment>Description:</comment>
  Принятая по умолчанию единица измерения значений ширины и высоты окна терминала, принимаемых
  функцией <strong>ssh2_shell()</strong>.


id: SSH2_DEFAULT_TERM_WIDTH
type: constant
doc:
<comment>Description:</comment>
  Принятое по умолчанию значение ширины окна терминала, принимаемое функцией <strong>ssh2_shell()</strong>.


id: SSH2_FINGERPRINT_HEX
type: constant
doc:
<comment>Description:</comment>
  Флаг для получения идентификатора сервера функцией <strong>ssh2_fingerprint()</strong> в виде строки
  шестнадцатеричных символов.


id: SSH2_FINGERPRINT_MD5
type: constant
doc:
<comment>Description:</comment>
  Флаг для получения идентификатора сервера в виде хеш-суммы MD5 функцией <strong>ssh2_fingerprint()</strong>.


id: SSH2_FINGERPRINT_RAW
type: constant
doc:
<comment>Description:</comment>
  Флаг для получения идентификатора сервера функцией <strong>ssh2_fingerprint()</strong> в виде неотформатированной
  строки восьмибитных символов.


id: SSH2_FINGERPRINT_SHA1
type: constant
doc:
<comment>Description:</comment>
  Флаг для получения идентификатора сервера в виде хеш-суммы SHA1 функцией <strong>ssh2_fingerprint()</strong>.


id: SSH2_STREAM_STDERR
type: constant
doc:
<comment>Description:</comment>
  Флаг функции <strong>ssh2_fetch_stream()</strong>, запрашивающей субканал STDERR.


id: SSH2_STREAM_STDIO
type: constant
doc:
<comment>Description:</comment>
  Флаг функции <strong>ssh2_fetch_stream()</strong>, запрашивающей субканал STDIO.


id: SSH2_TERM_UNIT_CHARS
type: constant
doc:
<comment>Description:</comment>
  Флаг для функции <strong>ssh2_shell()</strong>, определяющий, что параметры <strong>$width</strong> и <strong>$height</strong> задаются в виде
  количества символов.


id: SSH2_TERM_UNIT_PIXELS
type: constant
doc:
<comment>Description:</comment>
  Флаг для функции <strong>ssh2_shell()</strong>, определяющий, что параметры <strong>$width</strong> и <strong>$height</strong> задаются в пикселях.


id: STREAM_CAST_AS_STREAM
type: constant
doc:
<comment>Description:</comment>
  Распределение потоков, используется, когда функция <strong>stream_cast()</strong> вызывается из другого места
  (смотрите выше).


id: STREAM_CAST_FOR_SELECT
type: constant
doc:
<comment>Description:</comment>
  Распределение потоков, используется, когда функция <strong>stream_select()</strong> вызывает <strong>stream_cast()</strong>.


id: STREAM_CLIENT_ASYNC_CONNECT
type: constant
doc:
<comment>Description:</comment>
  Асинхронное открытие соединения с клиентским сокетом. Эта настройка должна использоваться
  совместно с флагом <info>STREAM_CLIENT_CONNECT</info>. Используется в функции <strong>stream_socket_client()</strong>.


id: STREAM_CLIENT_CONNECT
type: constant
doc:
<comment>Description:</comment>
  Открытие соединения с клиентским сокетом. Клиентские сокеты всегда должны включать этот флаг.
  Используется функцией <strong>stream_socket_client()</strong>.


id: STREAM_CLIENT_PERSISTENT
type: constant
doc:
<comment>Description:</comment>
  Клиентский сокет, открытый функцией <strong>stream_socket_client()</strong> будет оставаться открытым между
  загрузками страниц.


id: STREAM_FILTER_READ
type: constant
doc:
<comment>Description:</comment>
  Используется в функциях <strong>stream_filter_append()</strong> и <strong>stream_filter_prepend()</strong>. Указывает на то, что
  заданный фильтр может использоваться только в операциях чтения (reading)


id: STREAM_FILTER_WRITE
type: constant
doc:
<comment>Description:</comment>
  Используется в функциях <strong>stream_filter_append()</strong> и <strong>stream_filter_prepend()</strong>. Указывает на то, что
  заданный фильтр может использоваться только в операциях записи (writing)


id: STREAM_META_ACCESS
type: constant
doc:
<comment>Description:</comment>
  Используется в функции <strong>stream_metadata()</strong> для задания вызова <strong>chmod()</strong>.


id: STREAM_META_GROUP
type: constant
doc:
<comment>Description:</comment>
  Используется в функции <strong>stream_metadata()</strong> для задания вызова <strong>chgrp()</strong>.


id: STREAM_META_OWNER
type: constant
doc:
<comment>Description:</comment>
  Используется в функции <strong>stream_metadata()</strong> для задания вызова <strong>chown()</strong>.


id: STREAM_META_TOUCH
type: constant
doc:
<comment>Description:</comment>
  Используется в функции <strong>stream_metadata()</strong> для задания вызова <strong>touch()</strong>.


id: STREAM_NOTIFY_AUTH_REQUIRED
type: constant
doc:
<comment>Description:</comment>
  Для доступа к заданному ресурсу необходима дополнительная авторизация. Обычно выдаётся в ошибке
  уровня <strong>$severity</strong> <info>STREAM_NOTIFY_SEVERITY_ERR</info>.


id: STREAM_NOTIFY_FAILURE
type: constant
doc:
<comment>Description:</comment>
  Общая ошибка при работе с потоком. Детали смотрите в <strong>$message</strong> и <strong>$message_code</strong>.


id: STREAM_NOTIFY_MIME_TYPE_IS
type: constant
doc:
<comment>Description:</comment>
  <return>mime-type</return> ресурса идентифицирован. Описание найденного типа можно посмотреть в параметре <strong>$message</strong>.


id: STREAM_NOTIFY_PROGRESS
type: constant
doc:
<comment>Description:</comment>
  Индикатор текущего процесса передачи данных через поток. Можно узнать, сколько передано
  (<strong>$bytes_transferred</strong>), и сколько всего байт (<strong>$bytes_max</strong>).


id: STREAM_NOTIFY_REDIRECTED
type: constant
doc:
<comment>Description:</comment>
  Внешний ресурс перенаправил поток в другое место. Дополнительно смотри <strong>$message</strong>.


id: STREAM_NOTIFY_RESOLVE
type: constant
doc:
<comment>Description:</comment>
  Требуемый для потока адрес удалённого ресурса определён, либо это определение завершилось
  неудачей. Чтобы узнать, что именно произошло, смотрите <strong>$severity</strong>.


id: STREAM_REPORT_ERRORS
type: constant
doc:
<comment>Description:</comment>
  Флаг (<return>Flag</return>) указывающий, что <return>wrapper</return> может выбрасывать исключения в процессе открытия потока
  функцией <strong>trigger_error()</strong> Если этот флаг не установлен, вызывать ошибки не стоит.


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


id: STREAM_SERVER_LISTEN
type: constant
doc:
<comment>Description:</comment>
  Указывает потоку, созданному функцией <strong>stream_socket_server()</strong> и связанному флагом
  <info>STREAM_SERVER_BIND</info>, начать слушать сокет. Передачи данных, устанавливающие соединение (как TCP),
  должны использовать этот флаг, иначе сокет не включится. Использование этого флага при передаче
  без установления соединения (как UDP) вызовет ошибку.


id: STREAM_SHUT_RD
type: constant
doc:
<comment>Description:</comment>
  Используется функцией <strong>stream_socket_shutdown()</strong> для отключения дальнейшего приёма данных.


id: STREAM_SHUT_RDWR
type: constant
doc:
<comment>Description:</comment>
  Используется функцией <strong>stream_socket_shutdown()</strong> для отключения дальнейших приёма и передачи данных.


id: STREAM_SHUT_WR
type: constant
doc:
<comment>Description:</comment>
  Используется функцией <strong>stream_socket_shutdown()</strong> для отключения дальнейшей передачи данных.


id: STREAM_SOCK_DGRAM
type: constant
doc:
<comment>Description:</comment>
  Предоставляет датаграммы - сообщения без установления соединения (UDP, например).


id: STREAM_SOCK_RAW
type: constant
doc:
<comment>Description:</comment>
  Предоставляет необработанный (raw) сокет, который даёт доступ к внутренним сетевым протоколам и
  интерфейсам. Обычно сокеты этого типа доступны только root-пользователям.


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


id: STREAM_USE_PATH
type: constant
doc:
<comment>Description:</comment>
  Флаг (<return>Flag</return>), указывающий, что <return>stream</return> использует подключаемый путь (include path).


id: ST_UID
type: constant
doc:
<comment>Description:</comment>
  Последовательность аргументов, которая содержит идентификаторы UID вместо последовательности
  номеров


id: SVM::KERNEL_LINEAR
type: constant
doc:
<comment>Description:</comment>
  Очень простое ядро, которое хорошо работает для классификации проблем больших документов


id: SVM::KERNEL_RBF
type: constant
doc:
<comment>Description:</comment>
  Стандартное Гауссово RBD ядро. Хорошо обрабатывает нелинейные проблемы и является хорошим
  значением по умолчанию для классификации


id: SVM::KERNEL_SIGMOID
type: constant
doc:
<comment>Description:</comment>
  Ядро базирующееся на сигмоидной функции. Очень похоже на использование двухуровневой сигмоидной
  нейронной сети


id: SVM::NU_SVC
type: constant
doc:
<comment>Description:</comment>
  Тип NU_SVC использует другой, более гибкий подход к развесовке ошибок.


id: SVM::ONE_CLASS
type: constant
doc:
<comment>Description:</comment>
  Одноклассовая модель. Тренирует только на одном классе, используя "выпадающие" данные в качестве
  отрицательных примеров


id: SVM::OPT_C
type: constant
doc:
<comment>Description:</comment>
  Опция для параметра стоимости, контролирующего компромисс между ошибками и неопределённостями -
  фактически штраф за ошибочную классификацию обучающих примеров.


id: SVM::OPT_EPS
type: constant
doc:
<comment>Description:</comment>
  Опциональный ключ для параметра Epsilon. Используется только в Эпсилон-регрессии


id: SVM::OPT_GAMMA
type: constant
doc:
<comment>Description:</comment>
  Параметр алгоритма для следующих типов ядра:  Полиноминальное, RBF и Сигмоидное


id: SVM::OPT_NU
type: constant
doc:
<comment>Description:</comment>
  Опциональный ключ для параметра nu. Используется только с типами NU_ SVM


id: SVM::OPT_PROBABILITY
type: constant
doc:
<comment>Description:</comment>
  Параметр обучения, логическое значение, определяющий, будут ли собираться и использоваться оценки
  вероятности


id: SVM::OPT_SHRINKING
type: constant
doc:
<comment>Description:</comment>
  Параметр обучения, логическое значение, определяющий использование сокращающей эвристики


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


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

<comment>Param:</comment>
  <info>array</info>  <strong>$problem</strong>          Данные по проблеме. Могут быть как массивом, так и ссылкой на файл в
                           формате SVMLight или на поток, предоставляющий источник данных в формате
                           SVMLight.
  <info>int</info>    <strong>$number_of_folds</strong>  Количество подмножеств, на которые будет разделён общих набор обучающих
                           данных. Чем больше это число, тем более короткими и менее надёжными будут
                           обучающие наборы. Хорошее число для начала - 5.

<comment>Return:</comment>
  <info>float</info>  Процент корректной классификации в виде числа в диапазоне от 0 до 1. В случае ядер NU_SVC и
         EPSILON_SVR будет возвращена среднеквадратичная ошибка.

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


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

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


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

<comment>Param:</comment>
  <info>array</info>  <strong>$params</strong>  Массив параметров обучения, где в качестве ключей используются константы SVM.

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


id: SVM::train
type: function
doc:
<comment>Description:</comment>
  Создать SVMModel на основе обучающих данных
  
  Создаёт SVMModel на основе обучающих данных.

<comment>Param:</comment>
  <info>array</info>  <strong>$problem</strong>  Есть три пути предоставления обучающих данных: файл, поток и массив. Если данные
                   предоставляются с помощью файла или потока, то на каждой строке должен
                   содержаться один обучающий пример, отформатированный следующим образом: в начале
                   должно быть целое число (обычно 1 или -1), это число обозначается термином
                   "класс", а следом за ним перечисление пар признак:значение в порядке увеличения
                   признака. Признаки должны быть целыми числами, а их значения рациональными,
                   обычно на диапазоне 0-1. В случае использования массива, данные должны быть
                   представлены в виде массива массивов, в котором каждый вложенный массив должен
                   первым элементом содержать класс, а все последующие элементы содержать пары
                   "признак" =&gt; "значение".
  <info>array</info>  <strong>$weights</strong>  Необязательный набор весовых коэффициентов для разных классов, помогающие
                   работать с несбалансированными обучающими наборами. К примеру, если у нас два
                   класса, 1 и -1, и обучающих примеров для класса -1 сильно больше, то вес для -1
                   надо выставить равным 0.5. Вес должен быть в диапазон от 0 до 1.

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


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


id: SVMModel::__construct
type: function
doc:
<comment>Description:</comment>
  Конструктор класса SVMModel
  
  Создаёт объект класса SVMModel. Обычно модели создаются методом SVM::train, но сохранённые модели
  можно восстановить напрямую.

<comment>Param:</comment>
  <info>string</info>  <strong>$filename</strong>  Имя файла, в котором сохранена модель.

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


id: SVMModel::checkProbabilityModel
type: function
doc:
<comment>Description:</comment>
  Возвращает true, если модель содержит информацию о вероятностях
  
  Возвращает <info>true</info>, если модель содержит информацию о вероятностях.

<comment>Return:</comment>
  <info>bool</info>  Возвращает логическое значение


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

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

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


id: SVMModel::getNrClass
type: function
doc:
<comment>Description:</comment>
  Возвращает количество классов, для которых обучалась модель
  
  Возвращает количество классов, для которых обучалась модель. Для одноклассовой и регрессивной
  моделей вернёт 2.

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


id: SVMModel::getSvmType
type: function
doc:
<comment>Description:</comment>
  Получить тип SVM, с которым обучалась модель
  
  Возвращает целое число, представляющее одну из констант класса SVM. Например SVM::C_SVC.

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


id: SVMModel::getSvrProbability
type: function
doc:
<comment>Description:</comment>
  Получить величину сигмы для регрессионного типа
  
  Возвращает значение сигмы для регрессионных моделей. Если информация по вероятности отсутствует
  или модель не SVR, то возвратит 0.

<comment>Return:</comment>
  <info>float</info>  Возвращает величину сигмы


id: SVMModel::load
type: function
doc:
<comment>Description:</comment>
  Загружает сохранённую модель SVM
  
  Загружает сохранённую модель SVM из файла, готовую к классификации и регрессу.

<comment>Param:</comment>
  <info>string</info>  <strong>$filename</strong>  Имя файла для загрузки.

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

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


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

<comment>Param:</comment>
  <info>array</info>  <strong>$data</strong>  Данные для классификации. Массив должен содержать элементы в формате "признак" =&gt;
                "значение", отсортированный по возрастанию признака. Признаки не обязательно должны
                представлять собой непрерывную последовательность.

<comment>Return:</comment>
  <info>float</info>  Прогнозируемое значение типа float. В случае классификации оно будет отражать метку класса,
         а в случае регрессии - рациональное число. В случае возникновения ошибки выбрасывает
         SVMException

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


id: SVMModel::predict_probability
type: function
doc:
<comment>Description:</comment>
  Возвращает вероятность класса для заданных данных
  
  Функция принимает массив данных и пытается предсказать класс, как и функция предсказания. Однако,
  дополнительно функция возвратит массив вероятностей, по одной на класс в модели, которая
  представляет вероятность того, что данные принадлежат именно к этому классу. Работает только если
  модель обучалась с параметром вероятности установленном в <info>true</info>.

<comment>Param:</comment>
  <info>array</info>  <strong>$data</strong>           Данные для классификации. Массив должен содержать элементы в формате
                         "признак" =&gt; "значение", отсортированный по возрастанию признака.
                         Признаки не обязательно должны представлять собой непрерывную
                         последовательность.
  <info></info>       <strong>$probabilities</strong>  Заданная переменная будет заполнена вероятностями. Если модель обучалась
                         без параметра вероятности, будет возвращён <info>null</info>. Созданный массив будет
                         содержать в качестве ключей метки классов, а в качестве значений - значения
                         вероятности.

<comment>Return:</comment>
  <info>float</info>  Прогнозируемое значение типа float. В случае классификации оно будет отражать метку класса,
         а в случае регрессии - рациональное число. В случае возникновения ошибки выбрасывает
         SVMException

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


id: SVMModel::save
type: function
doc:
<comment>Description:</comment>
  Сохранить готовую модель в файл
  
  Сохраняет готовую модель в файл.

<comment>Param:</comment>
  <info>string</info>  <strong>$filename</strong>  Имя файла для сохранения модели.

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

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


id: SVN_AUTH_PARAM_DEFAULT_PASSWORD
type: constant
doc:
<comment>Description:</comment>
  Свойство, определяющее пароль пользователя по умолчанию, которое будет использоваться при
  выполнении базовой аутентификации


id: SVN_AUTH_PARAM_DEFAULT_USERNAME
type: constant
doc:
<comment>Description:</comment>
  Свойство, определяющее имя пользователя по умолчанию, которое будет использоваться при выполнении
  базовой аутентификации


id: SVN_WC_STATUS_CONFLICTED
type: constant
doc:
<comment>Description:</comment>
  Локальные изменения элемента конфликтуют с изменениями в репозитории


id: SVN_WC_STATUS_EXTERNAL
type: constant
doc:
<comment>Description:</comment>
  Неверсионированный путь, заполняемый с использованием svn:externals


id: SVN_WC_STATUS_MERGED
type: constant
doc:
<comment>Description:</comment>
  Локальные изменения элемента были объединены с изменениями в репозитории


id: Schema::__construct
type: function
doc:
<comment>Description:</comment>
  Конструктор класса Schema
  
  Объект класса Schema предоставляет полный доступ к схеме (базе данных).


id: Schema::createCollection
type: function
doc:
<comment>Description:</comment>
  Добавляет коллекцию в схему
  
  Создаёт коллекцию внутри схемы.

<comment>Param:</comment>
  <info>string</info>  <strong>$name</strong>      Имя коллекции.
  <info>string</info>  <strong>$validate</strong>  Определение проверки в виде объекта JSON.

<comment>Return:</comment>
  <info>mysql_xdevapi\Collection</info>  Возвращает объект класса Collection.


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

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

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


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

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


id: Schema::getCollection
type: function
doc:
<comment>Description:</comment>
  Получает коллекцию из схемы
  
  Получает коллекцию из схемы.

<comment>Param:</comment>
  <info>string</info>  <strong>$name</strong>  Имя коллекции для извлечения.

<comment>Return:</comment>
  <info>mysql_xdevapi\Collection</info>  Возвращает объект класса Collection для выбранной коллекции.


id: Schema::getCollectionAsTable
type: function
doc:
<comment>Description:</comment>
  Получает коллекцию как объект класса Table
  
  Получает коллекцию, но как объект Table вместо объекта Collection.

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

<comment>Return:</comment>
  <info>mysql_xdevapi\Table</info>  Объект класса <class>mysql_xdevapi\Table</class> для коллекции.


id: Schema::getCollections
type: function
doc:
<comment>Description:</comment>
  Получить все коллекции схемы
  
  Получить список коллекций для этой схемы.

<comment>Return:</comment>
  <info>array</info>  Массив всех коллекций в этой схеме, где каждое значение элемента массива является объектом
         Collection с именем коллекции в качестве ключа.


id: Schema::getName
type: function
doc:
<comment>Description:</comment>
  Получить имя схемы
  
  Получить имя схемы.

<comment>Return:</comment>
  <info>string</info>  Имя схемы в виде строки, подключённой к объекту схемы.


id: Schema::getSession
type: function
doc:
<comment>Description:</comment>
  Получить сессию схемы
  
  Получение нового объекта Session из объекта Schema.

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


id: Schema::getTable
type: function
doc:
<comment>Description:</comment>
  Получить таблицу схемы
  
  Получение объекта Table для указанной таблицы в схеме.

<comment>Param:</comment>
  <info>string</info>  <strong>$name</strong>  Имя таблицы.

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


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

<comment>Return:</comment>
  <info>array</info>  Массив всех таблиц в этой схеме, где каждое значение элемента массива является объектом
         Table с именем таблицы в качестве ключа.


id: SchemaObject::getSchema
type: function
doc:
<comment>Description:</comment>
  Получает объект схемы
  
  Используется другими объектами для получения объекта схемы.

<comment>Return:</comment>
  <info>mysql_xdevapi\Schema</info>  Текущий объект Schema.


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


id: SeasLog::alert
type: function
doc:
<comment>Description:</comment>
  Записывает информацию уровня "alert" в журнал
  
  Записывает информацию уровня "alert" в журнал.  "ALERT" - Действия должны быть предприняты
  немедленно. Немедленное внимание следует уделять соответствующему персоналу для аварийного
  ремонта.
  
  "ALERT" - Действия должны быть предприняты немедленно. Немедленное внимание следует уделять
  соответствующему персоналу для аварийного ремонта.

<comment>Param:</comment>
  <info>string</info>  <strong>$message</strong>  Сообщение журнала.
  <info>array</info>   <strong>$content</strong>  Сообщение содержит заполнители, которые разработчики заменяют значениями из
                    массива содержимого. Если `message` - это `информация журнала от {NAME}`, а
                    `content` - `array('NAME' =&gt; 'Никиты')`, информация журнала будет `информация
                    журнала от Никиты`.
  <info>string</info>  <strong>$logger</strong>   `logger`, заключённый в третий параметр, будет использоваться прямо сейчас, как
                    временный регистратор, если функция SeasLog::setLogger() вызывается в
                    предварительном содержимом. Если `logger` равен NULL или "" (пустая строка),
                    SeasLog будет использовать последний регистратор, установленный методом
                    SeasLog::setLogger.

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

<comment>See Also:</comment>
   * seaslog.default_template
   * SeasLog::debug
   * SeasLog::info
   * SeasLog::notice
   * SeasLog::warning
   * SeasLog::error
   * SeasLog::critical
   * SeasLog::emergency
   * SeasLog::log


id: SeasLog::analyzerCount
type: function
doc:
<comment>Description:</comment>
  Получает количество журналов по уровню, log_path и key_word
  
  `SeasLog` получает значение счётчика `grep -ai '{level}' | grep -aic '{key_word}'`, используя
  системный канал и возвращает в PHP (массив или целое число).

<comment>Param:</comment>
  <info>string</info>  <strong>$level</strong>     Строка. Уровень журнала.
  <info>string</info>  <strong>$log_path</strong>  Строка. Путь к журналу.
  <info>string</info>  <strong>$key_word</strong>  Строка. Ключевое слово для поиска в журнале.

<comment>Return:</comment>
  <info>mixed</info>  Если `level` равен SEASLOG_ALL или не задан, возвращаются все уровни как массив. Если
         `level` равен SEASLOG_INFO или другой уровень, возвращается количество как целое число.

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


id: SeasLog::analyzerDetail
type: function
doc:
<comment>Description:</comment>
  Получает детализацию журнала по уровню, log_path, key_word, start, limit, order
  
  `SeasLog` получает результат выполнения команды `grep -ai '{level}' | grep -ai '{key_word}' |  sed
  -n '{start},{limit}'p`, использует системный канал и возвращает массив в PHP.

<comment>Param:</comment>
  <info>string</info>  <strong>$level</strong>     Строка. Уровень информации журнала.
  <info>string</info>  <strong>$log_path</strong>  Строка. Путь к информации журнала.
  <info>string</info>  <strong>$key_word</strong>  Строка. Ключевое слово для поиска информации журнала.
  <info>int</info>     <strong>$start</strong>     Целое число. По умолчанию `1`.
  <info>int</info>     <strong>$limit</strong>     Целое число. По умолчанию `20`.
  <info>int</info>     <strong>$order</strong>     Целое число. По умолчанию SEASLOG_DETAIL_ORDER_ASC. Смотрите также:
                     SEASLOG_DETAIL_ORDER_ASCSEASLOG_DETAIL_ORDER_DESC

<comment>Return:</comment>
  <info>mixed</info>  Возвращает результаты в виде массива.  Если start, limit не равны NULL, в Windows SeasLog
         выбросит исключение с сообщением: "Param start and limit don't support Windows" (Параметры
         start и limit не поддерживаются в Windows).
         
         Если start, limit не равны NULL, в Windows SeasLog выбросит исключение с сообщением: "Param
         start and limit don't support Windows" (Параметры start и limit не поддерживаются в
         Windows).

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


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

<comment>Param:</comment>
  <info>int</info>     <strong>$model</strong>   Целое число, одна из констант:
                   SEASLOG_CLOSE_LOGGER_STREAM_MOD_ALLSEASLOG_CLOSE_LOGGER_STREAM_MOD_ASSIGN
  <info>string</info>  <strong>$logger</strong>  Имя регистратора.

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

<comment>See Also:</comment>
   * SeasLog::setLogger
   * SeasLog::getLastLogger


id: SeasLog::critical
type: function
doc:
<comment>Description:</comment>
  Записывает информацию уровня "critical" в журнал
  
  Записывает информацию уровня "critical" в журнал.  "CRITICAL" - Критические условия. Требуется
  немедленный ремонт, программный компонент недоступен.
  
  "CRITICAL" - Критические условия. Требуется немедленный ремонт, программный компонент недоступен.

<comment>Param:</comment>
  <info>string</info>  <strong>$message</strong>  Сообщение журнала.
  <info>array</info>   <strong>$content</strong>  Сообщение содержит заполнители, которые разработчики заменяют значениями из
                    массива содержимого. Если `message` - это `информация журнала от {NAME}`, а
                    `content` - `array('NAME' =&gt; 'Никиты')`, информация журнала будет `информация
                    журнала от Никиты`.
  <info>string</info>  <strong>$logger</strong>   `logger`, заключённый в третий параметр, будет использоваться прямо сейчас, как
                    временный регистратор, если функция SeasLog::setLogger() вызывается в
                    предварительном содержимом. Если `logger` равен NULL или "" (пустая строка),
                    SeasLog будет использовать последний регистратор, установленный методом
                    SeasLog::setLogger.

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

<comment>See Also:</comment>
   * seaslog.default_template
   * SeasLog::debug
   * SeasLog::info
   * SeasLog::notice
   * SeasLog::warning
   * SeasLog::error
   * SeasLog::alert
   * SeasLog::emergency
   * SeasLog::log


id: SeasLog::debug
type: function
doc:
<comment>Description:</comment>
  Записывает информацию уровня "debug" в журнал
  
  Записывает информацию уровня "debug" в журнал.  "DEBUG" - Подробная информация об отладке.
  Детализированные информационные события.
  
  "DEBUG" - Подробная информация об отладке. Детализированные информационные события.

<comment>Param:</comment>
  <info>string</info>  <strong>$message</strong>  Сообщение журнала.
  <info>array</info>   <strong>$content</strong>  Сообщение содержит заполнители, которые разработчики заменяют значениями из
                    массива содержимого. Если `message` - это `информация журнала от {NAME}`, а
                    `content` - `array('NAME' =&gt; 'Никиты')`, информация журнала будет `информация
                    журнала от Никиты`.
  <info>string</info>  <strong>$logger</strong>   `logger`, заключённый в третий параметр, будет использоваться прямо сейчас, как
                    временный регистратор, если функция SeasLog::setLogger() вызывается в
                    предварительном содержимом. Если `logger` равен NULL или "" (пустая строка),
                    SeasLog будет использовать последний регистратор, установленный методом
                    SeasLog::setLogger.

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

<comment>See Also:</comment>
   * seaslog.default_template
   * SeasLog::info
   * SeasLog::notice
   * SeasLog::warning
   * SeasLog::error
   * SeasLog::critical
   * SeasLog::alert
   * SeasLog::emergency
   * SeasLog::log


id: SeasLog::emergency
type: function
doc:
<comment>Description:</comment>
  Записывает информацию уровня "emergency" в журнал
  
  Записывает информацию уровня "emergency" в журнал.  "EMERGENCY" - Система непригодна для
  использования.
  
  "EMERGENCY" - Система непригодна для использования.

<comment>Param:</comment>
  <info>string</info>  <strong>$message</strong>  Сообщение журнала.
  <info>array</info>   <strong>$content</strong>  Сообщение содержит заполнители, которые разработчики заменяют значениями из
                    массива содержимого. Если `message` - это `информация журнала от {NAME}`, а
                    `content` - `array('NAME' =&gt; 'Никиты')`, информация журнала будет `информация
                    журнала от Никиты`.
  <info>string</info>  <strong>$logger</strong>   `logger`, заключённый в третий параметр, будет использоваться прямо сейчас, как
                    временный регистратор, если функция SeasLog::setLogger() вызывается в
                    предварительном содержимом. Если `logger` равен NULL или "" (пустая строка),
                    SeasLog будет использовать последний регистратор, установленный методом
                    SeasLog::setLogger.

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

<comment>See Also:</comment>
   * seaslog.default_template
   * SeasLog::debug
   * SeasLog::info
   * SeasLog::notice
   * SeasLog::warning
   * SeasLog::error
   * SeasLog::critical
   * SeasLog::alert
   * SeasLog::log


id: SeasLog::error
type: function
doc:
<comment>Description:</comment>
  Записывает информацию уровня "error" в журнал
  
  Записывает информацию уровня "error" в журнал.  "ERROR" - Ошибки во времени выполнения, которые не
  требуют немедленных действий, но обычно должны.
  
  "ERROR" - Ошибки во времени выполнения, которые не требуют немедленных действий, но обычно должны.

<comment>Param:</comment>
  <info>string</info>  <strong>$message</strong>  Сообщение журнала.
  <info>array</info>   <strong>$content</strong>  Сообщение содержит заполнители, которые разработчики заменяют значениями из
                    массива содержимого. Если `message` - это `информация журнала от {NAME}`, а
                    `content` - `array('NAME' =&gt; 'Никиты')`, информация журнала будет `информация
                    журнала от Никиты`.
  <info>string</info>  <strong>$logger</strong>   `logger`, заключённый в третий параметр, будет использоваться прямо сейчас, как
                    временный регистратор, если функция SeasLog::setLogger() вызывается в
                    предварительном содержимом. Если `logger` равен NULL или "" (пустая строка),
                    SeasLog будет использовать последний регистратор, установленный методом
                    SeasLog::setLogger.

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

<comment>See Also:</comment>
   * seaslog.default_template
   * SeasLog::debug
   * SeasLog::info
   * SeasLog::notice
   * SeasLog::warning
   * SeasLog::critical
   * SeasLog::alert
   * SeasLog::emergency
   * SeasLog::log


id: SeasLog::flushBuffer
type: function
doc:
<comment>Description:</comment>
  Очищает буфер логов, делает дамп в файл приложения или отправляет на удалённый API с помощью
  tcp/udp
  
  Очищает буфер логов с помощью seaslog.appender: делает дамп в файл приложения или отправляет на
  удалённый API с помощью tcp/udp.  Смотрите также: seaslog.appender_retry seaslog.remote_host
  seaslog.remote_port
  
  Смотрите также: seaslog.appender_retry seaslog.remote_host seaslog.remote_port

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

<comment>See Also:</comment>
   * seaslog.use_buffer
   * seaslog.buffer_size
   * seaslog.buffer_disabled_in_cli
   * SeasLog::getBufferEnabled
   * SeasLog::getBuffer


id: SeasLog::getBasePath
type: function
doc:
<comment>Description:</comment>
  Получает базовый путь SeasLog
  
  Используйте функцию SeasLog::getBasePath, чтобы получить значение seaslog.default_basepath,
  которое настроено в php.ini (seaslog.ini).
  
  Если вы используете Seaslog::setBasePath, результат изменится.

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


id: SeasLog::getBuffer
type: function
doc:
<comment>Description:</comment>
  Получает буфер логов в памяти в виде массива

<comment>Return:</comment>
  <info>array</info>  Возвращает массив из буфера логов в памяти.

<comment>See Also:</comment>
   * seaslog.use_buffer
   * seaslog.buffer_size
   * seaslog.buffer_disabled_in_cli
   * SeasLog::getBufferEnabled
   * SeasLog::flushBuffer


id: SeasLog::getBufferEnabled
type: function
doc:
<comment>Description:</comment>
  Определяет, включён ли буфер
  
  Результат объединения seaslog.use_buffer и seaslog.buffer_disabled_in_cli.

<comment>Return:</comment>
  <info>bool</info>  Возвращает TRUE, если seaslog.use_buffer является true. Если включить
        seaslog.buffer_disabled_in_cli и запустить в cli, параметр seaslog.use_buffer будет сброшен,
        Seaslog НЕМЕДЛЕННО перезапишет данные в хранилище данных.

<comment>See Also:</comment>
   * seaslog.use_buffer
   * seaslog.buffer_size
   * seaslog.buffer_disabled_in_cli
   * SeasLog::getBuffer
   * SeasLog::flushBuffer


id: SeasLog::getDatetimeFormat
type: function
doc:
<comment>Description:</comment>
  Получает стиль формата даты и времени SeasLog
  
  Получает стиль формата даты и времени SeasLog. Используйте функцию SeasLog::getDatetimeFormat,
  чтобы получить значение seaslog.default_datetime_format, которое настроено в php.ini(seaslog.ini).

<comment>Return:</comment>
  <info>string</info>  Получает стиль формата даты и времени SeasLog seaslog.default_datetime_format.
          Использование функции SeasLog::setDatetimeFormat изменит это значение.

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


id: SeasLog::getLastLogger
type: function
doc:
<comment>Description:</comment>
  Получает последний путь регистратора SeasLog
  
  Используйте функцию SeasLog::getLastLogger, чтобы получить значение seaslog.default_logger,
  которое задано в php.ini (seaslog.ini).

<comment>Return:</comment>
  <info>string</info>  Использование функции SeasLog::setLogger изменит значение функции SeasLog::getLastLogger.

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


id: SeasLog::getRequestID
type: function
doc:
<comment>Description:</comment>
  Получает дифференцированные запросы SeasLog request_id
  
  Чтобы отличить один запрос, например, не вызывать функцию SeasLog::setRequestId, при инициализации
  запроса используется уникальное значение, генерируемое встроенной функцией `static char
  *get_uniqid()`.

<comment>Return:</comment>
  <info>string</info>  Возвращает строку, созданную встроенной функцией `static char *get_uniqid()` или заданную
          функцией SeasLog::setRequestId.

<comment>See Also:</comment>
   * SeasLog::setRequestID
   * Переменная `%Q` в
   Таблице переменных по умолчанию Seaslog.


id: SeasLog::getRequestVariable
type: function
doc:
<comment>Description:</comment>
  Получает переменную запроса SeasLog
  
  Получает переменную запроса SeasLog.

<comment>Param:</comment>
  <info>int</info>  <strong>$key</strong>  Целочисленная константа:
             SEASLOG_REQUEST_VARIABLE_DOMAIN_PORTSEASLOG_REQUEST_VARIABLE_REQUEST_URISEASLOG_REQUEST_VARIABLE_REQUEST_METHODSEASLOG_REQUEST_VARIABLE_CLIENT_IP

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

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


id: SeasLog::info
type: function
doc:
<comment>Description:</comment>
  Записывает информацию уровня "info" в журнал
  
  Записывает информацию уровня "info" в журнал.  "INFO" - Интересные события. Подчёркивает
  запущенный процесс приложения.
  
  "INFO" - Интересные события. Подчёркивает запущенный процесс приложения.

<comment>Param:</comment>
  <info>string</info>  <strong>$message</strong>  Сообщение журнала.
  <info>array</info>   <strong>$content</strong>  Сообщение содержит заполнители, которые разработчики заменяют значениями из
                    массива содержимого. Если `message` - это `информация журнала от {NAME}`, а
                    `content` - `array('NAME' =&gt; 'Никиты')`, информация журнала будет `информация
                    журнала от Никиты`.
  <info>string</info>  <strong>$logger</strong>   `logger`, заключённый в третий параметр, будет использоваться прямо сейчас, как
                    временный регистратор, если функция SeasLog::setLogger() вызывается в
                    предварительном содержимом. Если `logger` равен NULL или "" (пустая строка),
                    SeasLog будет использовать последний регистратор, установленный методом
                    SeasLog::setLogger.

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

<comment>See Also:</comment>
   * seaslog.default_template
   * SeasLog::debug
   * SeasLog::notice
   * SeasLog::warning
   * SeasLog::error
   * SeasLog::critical
   * SeasLog::alert
   * SeasLog::emergency
   * SeasLog::log


id: SeasLog::log
type: function
doc:
<comment>Description:</comment>
  Общая функция записи в журнал
  
  Общая функция записи в журнал.

<comment>Param:</comment>
  <info>string</info>  <strong>$level</strong>    Можно использовать уровень один из:
                    SEASLOG_DEBUGSEASLOG_INFOSEASLOG_NOTICESEASLOG_WARNINGSEASLOG_ERRORSEASLOG_CRITICALSEASLOG_ALERTSEASLOG_EMERGENCY
                    Или вы можете создать свой собственный уровень.
  <info>string</info>  <strong>$message</strong>  Сообщение журнала.
  <info>array</info>   <strong>$content</strong>  Сообщение содержит заполнители, которые разработчики заменяют значениями из
                    массива содержимого. Если `message` - это `информация журнала от {NAME}`, а
                    `content` - `array('NAME' =&gt; 'Никиты')`, информация журнала будет `информация
                    журнала от Никиты`.
  <info>string</info>  <strong>$logger</strong>   `logger`, заключённый в третий параметр, будет использоваться прямо сейчас, как
                    временный регистратор, если функция SeasLog::setLogger() вызывается в
                    предварительном содержимом. Если `logger` равен NULL или "" (пустая строка),
                    SeasLog будет использовать последний регистратор, установленный методом
                    SeasLog::setLogger.

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

<comment>See Also:</comment>
   * seaslog.default_template
   * SeasLog::debug
   * SeasLog::info
   * SeasLog::notice
   * SeasLog::warning
   * SeasLog::error
   * SeasLog::critical
   * SeasLog::alert
   * SeasLog::emergency


id: SeasLog::notice
type: function
doc:
<comment>Description:</comment>
  Записывает информацию уровня "notice" в журнал
  
  Записывает информацию уровня "notice" в журнал.  "NOTICE" - Нормальные, но важные события.
  Информация, которая важнее уровня "info" во время выполнения.
  
  "NOTICE" - Нормальные, но важные события. Информация, которая важнее уровня "info" во время
  выполнения.

<comment>Param:</comment>
  <info>string</info>  <strong>$message</strong>  Сообщение журнала.
  <info>array</info>   <strong>$content</strong>  Сообщение содержит заполнители, которые разработчики заменяют значениями из
                    массива содержимого. Если `message` - это `информация журнала от {NAME}`, а
                    `content` - `array('NAME' =&gt; 'Никиты')`, информация журнала будет `информация
                    журнала от Никиты`.
  <info>string</info>  <strong>$logger</strong>   `logger`, заключённый в третий параметр, будет использоваться прямо сейчас, как
                    временный регистратор, если функция SeasLog::setLogger() вызывается в
                    предварительном содержимом. Если `logger` равен NULL или "" (пустая строка),
                    SeasLog будет использовать последний регистратор, установленный методом
                    SeasLog::setLogger.

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

<comment>See Also:</comment>
   * seaslog.default_template
   * SeasLog::debug
   * SeasLog::info
   * SeasLog::warning
   * SeasLog::error
   * SeasLog::critical
   * SeasLog::alert
   * SeasLog::emergency
   * SeasLog::log


id: SeasLog::setBasePath
type: function
doc:
<comment>Description:</comment>
  Устанавливает базовый путь SeasLog
  
  Устанавливает базовый путь SeasLog.

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

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


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

<comment>Param:</comment>
  <info>string</info>  <strong>$format</strong>  Строка. Например, "Y-m-d H:i:s" или "Ymd His". Смотрите первый параметр "format"
                   функции <strong>date()</strong>.

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

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


id: SeasLog::setLogger
type: function
doc:
<comment>Description:</comment>
  Устанавливает имя регистратора SeasLog
  
  Использование функции SeasLog::setLogger изменит значение функции SeasLog::getLastLogger. Значит,
  SeasLog запишет loginfo в каталог регистратора.

<comment>Param:</comment>
  <info>string</info>  <strong>$logger</strong>  Имя регистратора.

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

<comment>See Also:</comment>
   * SeasLog::getLastLogger
   * SeasLog::closeLoggerStream


id: SeasLog::setRequestID
type: function
doc:
<comment>Description:</comment>
  Устанавливает дифференцированные запросы SeasLog request_id
  
  Чтобы отличить один запрос, например, не вызывать функцию SeasLog::setRequestId, при инициализации
  запроса используется уникальное значение, генерируемое встроенной функцией `static char
  *get_uniqid()`.

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

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

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


id: SeasLog::setRequestVariable
type: function
doc:
<comment>Description:</comment>
  Устанавливает переменную запроса SeasLog вручную
  
  Устанавливает переменную запроса SeasLog вручную.

<comment>Param:</comment>
  <info>int</info>     <strong>$key</strong>    Константа, целое число.
                  SEASLOG_REQUEST_VARIABLE_DOMAIN_PORTSEASLOG_REQUEST_VARIABLE_REQUEST_URISEASLOG_REQUEST_VARIABLE_REQUEST_METHODSEASLOG_REQUEST_VARIABLE_CLIENT_IP
  <info>string</info>  <strong>$value</strong>  Значение переменной запроса.

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

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


id: SeasLog::warning
type: function
doc:
<comment>Description:</comment>
  Записывает информацию уровня "warning" в журнал
  
  Записывает информацию уровня "warning" в журнал.  "WARNING" - Исключительные случаи, которые не
  являются ошибками. Потенциально ошибочная информация, которая требует внимания и требует
  исправления.
  
  "WARNING" - Исключительные случаи, которые не являются ошибками. Потенциально ошибочная
  информация, которая требует внимания и требует исправления.

<comment>Param:</comment>
  <info>string</info>  <strong>$message</strong>  Сообщение журнала.
  <info>array</info>   <strong>$content</strong>  Сообщение содержит заполнители, которые разработчики заменяют значениями из
                    массива содержимого. Если `message` - это `информация журнала от {NAME}`, а
                    `content` - `array('NAME' =&gt; 'Никиты')`, информация журнала будет `информация
                    журнала от Никиты`.
  <info>string</info>  <strong>$logger</strong>   `logger`, заключённый в третий параметр, будет использоваться прямо сейчас, как
                    временный регистратор, если функция SeasLog::setLogger() вызывается в
                    предварительном содержимом. Если `logger` равен NULL или "" (пустая строка),
                    SeasLog будет использовать последний регистратор, установленный методом
                    SeasLog::setLogger.

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

<comment>See Also:</comment>
   * seaslog.default_template
   * SeasLog::debug
   * SeasLog::info
   * SeasLog::notice
   * SeasLog::error
   * SeasLog::critical
   * SeasLog::alert
   * SeasLog::emergency
   * SeasLog::log


id: SeekableIterator::seek
type: function
doc:
<comment>Description:</comment>
  Перемещается к позиции
  
  Перемещается к заданной позиции в итераторе.

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

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

<comment>See Also:</comment>
   * <class>SeekableIterator</class>
   * <class>Iterator</class>


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


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


id: SensitiveParameterValue
type: class
doc:
<comment>Description:</comment>
  Класс <class>SensitiveParameterValue</class> позволяет обернуть чувствительные значения, чтобы защитить их от
  случайного раскрытия.
  
  Значения параметров с атрибутом <class>SensitiveParameter</class> будут автоматически обёрнуты внутри объекта
  <class>SensitiveParameterValue</class> в трассировках стека.


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

<comment>Param:</comment>
  <info>mixed</info>  <strong>$value</strong>  Произвольное значение, которое должно храниться внутри объекта
                 <class>SensitiveParameterValue</class>.


id: SensitiveParameterValue::__debugInfo
type: function
doc:
<comment>Description:</comment>
  Защита чувствительных значений от случайного воздействия
  
  Возвращает пустой массив (<info>array</info>) для защиты чувствительного значения от случайного раскрытия при
  использовании функции <strong>var_dump()</strong>.

<comment>Return:</comment>
  <info>array</info>  Пустой массив (<info>array</info>).


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

<comment>Return:</comment>
  <info>mixed</info>  Чувствительное значение.


id: Serializable
type: class
doc:
<comment>Description:</comment>
  Интерфейс для индивидуальной сериализации.
  
  Классы, реализующие этот интерфейс, больше не поддерживают __sleep() и __wakeup(). Метод serialize
  вызывается всякий раз, когда необходима сериализация экземпляру класса. Этот метод не вызывает
  __destruct() и не имеет никаких побочных действий кроме тех, которые запрограммированы внутри
  него. Когда данные десериализуются, класс известен и соответствующий метод unserialize()
  вызывается как конструктор вместо вызова __construct(). Если вам необходимо вызвать стандартный
  конструктор, вы можете это сделать в этом методе.
  
  Начиная с PHP 8.1.0, класс, который реализует Serializable без реализации __serialize() и
  __unserialize() выдаст предупреждение об устаревании.


id: Serializable::serialize
type: function
doc:
<comment>Description:</comment>
  Представляет объект в виде строки
  
  Возвращает строковое представление объекта.

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

<comment>See Also:</comment>
   * __sleep()
   * __serialize()


id: Serializable::unserialize
type: function
doc:
<comment>Description:</comment>
  Создаёт объект
  
  Вызывается во время десериализации объекта.
  
  Метод действует как конструктор объекта. Метод __construct() не вызывается после этого метода.

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

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

<comment>See Also:</comment>
   * __wakeup()
   * __unserialize()


id: Session::__construct
type: function
doc:
<comment>Description:</comment>
  Описание конструктора
  
  Объект Session, инициированный getSession().


id: Session::close
type: function
doc:
<comment>Description:</comment>
  Закрывает сессию
  
  Закрывает сессию с сервером.

<comment>Return:</comment>
  <info>bool</info>  <info>true</info>, если сессия закрыта.


id: Session::commit
type: function
doc:
<comment>Description:</comment>
  Фиксирует транзакцию
  
  Фиксирует транзакцию.

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


id: Session::createSchema
type: function
doc:
<comment>Description:</comment>
  Создаёт новую схему
  
  Создаёт новую схему.

<comment>Param:</comment>
  <info>string</info>  <strong>$schema_name</strong>  Имя схемы для создания.

<comment>Return:</comment>
  <info>mysql_xdevapi\Schema</info>  Объект Schema в случае успешного выполнения, в случае возникновения ошибки
                        выдаёт исключение.


id: Session::dropSchema
type: function
doc:
<comment>Description:</comment>
  Удаляет схему
  
  Удаляет схему (базу данных).

<comment>Param:</comment>
  <info>string</info>  <strong>$schema_name</strong>  Имя схемы для удаления.

<comment>Return:</comment>
  <info>bool</info>  <info>true</info>, если схема удалена, или <info>false</info> если она не существует или не может быть удалена.
        
        Генерируется ошибка уровня <info>E_WARNING</info>, если схема не существует.


id: Session::generateUUID
type: function
doc:
<comment>Description:</comment>
  Получает новый UUID
  
  Генерирует универсальный уникальный идентификатор (UUID), сгенерированный в соответствии с RFC
  4122.

<comment>Return:</comment>
  <info>string</info>  UUID; строка длиной 32 символа.


id: Session::getDefaultSchema
type: function
doc:
<comment>Description:</comment>
  Получает имя схемы по умолчанию
  
  Извлекает имя схемы по умолчанию, которая обычно устанавливается в URI соединения.

<comment>Return:</comment>
  <info>string</info>  Имя схемы по умолчанию, определённой соединением или <info>null</info>, если схема не установлена.


id: Session::getSchema
type: function
doc:
<comment>Description:</comment>
  Получает новый объект схемы
  
  Новый объект Schema для указанного имени схемы.

<comment>Param:</comment>
  <info>string</info>  <strong>$schema_name</strong>  Имя схемы (базы данных), для которой нужно получить объект Schema.

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


id: Session::getSchemas
type: function
doc:
<comment>Description:</comment>
  Получает схемы
  
  Получить объекты схемы для всех схем, доступных в сессии.

<comment>Return:</comment>
  <info>array</info>  Массив, содержащий объекты, которые представляют все схемы, доступные в сессии.


id: Session::getServerVersion
type: function
doc:
<comment>Description:</comment>
  Получает версию сервера
  
  Получает версию сервера MySQL для сессии.

<comment>Return:</comment>
  <info>int</info>  Версия сервера MySQL для сессии в виде целого числа, такого как "80012".


id: Session::listClients
type: function
doc:
<comment>Description:</comment>
  Получает список клиентов
  
  Получить список клиентских подключений к сессии MySQL сервера.

<comment>Return:</comment>
  <info>array</info>  Массив, содержащий текущих зарегистрированных клиентов. Элементы массива: "client_id",
         "user", "host", и "sql_session".


id: Session::quoteName
type: function
doc:
<comment>Description:</comment>
  Добавляет кавычки
  
  Функция для экранирования имён и идентификаторов SQL. Экранирует идентификатор, указанный в
  соответствии с настройками текущего соединения. Эту функцию не следует использовать для
  экранирования значений.

<comment>Param:</comment>
  <info>string</info>  <strong>$name</strong>  Строка для экранирования.

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


id: Session::releaseSavepoint
type: function
doc:
<comment>Description:</comment>
  Отменяет установленную точку сохранения
  
  Отменяет ранее установленную точку сохранения.

<comment>Param:</comment>
  <info>string</info>  <strong>$name</strong>  Имя точки сохранения для отмены.

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


id: Session::rollback
type: function
doc:
<comment>Description:</comment>
  Откатывает транзакцию
  
  Откатывает транзакцию.

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


id: Session::rollbackTo
type: function
doc:
<comment>Description:</comment>
  Откатывает транзакцию до точки сохранения
  
  Откатывает транзакцию до точки сохранения.

<comment>Param:</comment>
  <info>string</info>  <strong>$name</strong>  Имя точки сохранения для отката; без учёта регистра.

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


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

<comment>Param:</comment>
  <info>string</info>  <strong>$name</strong>  Название точки сохранения. Имя генерируется автоматически, если необязательный
                 параметр <return>name</return> не определён, как 'SAVEPOINT1', 'SAVEPOINT2' и т.д.

<comment>Return:</comment>
  <info>string</info>  Название точки сохранения.


id: Session::sql
type: function
doc:
<comment>Description:</comment>
  Выполняет SQL запрос
  
  Создаёт собственный оператор SQL. Заполнители поддерживаются с помощью нативного синтаксиса "?".
  Использует метод <return>execute</return> для выполнения утверждения SQL.

<comment>Param:</comment>
  <info>string</info>  <strong>$query</strong>  Утверждение SQL для выполнения.

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


id: Session::startTransaction
type: function
doc:
<comment>Description:</comment>
  Начинает транзакцию
  
  Начинает новую транзакцию.

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


id: SessionHandler
type: class
doc:
<comment>Description:</comment>
  <class>SessionHandler</class> это специальный класс, который может использоваться для дополнения внутреннего
  обработчика сессий PHP путём создания дочерних классов от этого. Существует семь методов, которые
  являются обёртками над семью внутренними обработчиками хранения данных сессии (<strong>$open</strong>, <strong>$close</strong>,
  <strong>$read</strong>, <strong>$write</strong>, <strong>$destroy</strong>, <strong>$gc</strong> и <strong>$create_sid</strong>). По умолчанию этот класс оборачивает все внутренние
  обработчики хранения сессии, определённые в опции конфигурации session.save_handler. Эта опция по
  умолчанию имеет значение <strong>$files</strong>. Другие внутренние обработчики сессий предоставляются
  PHP-модулями, такими как SQLite (<strong>$sqlite</strong>), Memcache (<strong>$memcache</strong>) и Memcached (<strong>$memcached</strong>).
  
  Экземпляр класса <class>SessionHandler</class> может устанавливаться в качестве обработчика сессии посредством
  вызова функции <strong>session_set_save_handler()</strong>. В этом случае он станет обёрткой существующего
  внутреннего обработчика. Классы, расширяющие <class>SessionHandler</class> позволят переопределить методы
  обработчика сессии или перехватить/отфильтровать их путём вызова родительских методов-обёрток
  внутреннего обработчика сессий PHP.
  
  Это позволит вам, к примеру, перехватить методы <strong>$read</strong> и <strong>$write</strong> для шифровки/дешифровки данных
  сессии и передачи результата родительскому классу и от него. Или, к примеру, вы можете полностью
  переопределить такой метод как callback-функция сборщика мусора (<strong>$gc</strong>).
  
  Так как <class>SessionHandler</class> является обёрткой над стандартным внутренним обработчиком сессии, то
  пример, приведённый выше про шифровку данных может быть применён к любому внутреннему обработчику
  сессии даже без понимания внутреннего устройства процесса работы сессии.
  
  Для использования этого класса, во-первых, установите обработчик, который вы хотите дополнить
  используя session.save_handler. Далее передайте экземпляр класса <class>SessionHandler</class> или одного из
  классов, расширяющих его функции <strong>session_set_save_handler()</strong>.
  
  Обратите внимание, что callback-методы этого класса предназначены для внутреннего вызова PHP и не
  предназначены для вызова из кода пользовательского пространства. Возвращаемые значения одинаково
  обрабатываются внутри PHP. Дополнительную информацию о работе с сессией можно узнать из описания
  функции <strong>session_set_save_handler()</strong>.


id: SessionHandler::close
type: function
doc:
<comment>Description:</comment>
  Закрывает сессию
  
  Закрывает текущую сессию. Этот метод автоматически вызывается из PHP во время закрытия сессии или
  напрямую вызовом функции <strong>session_write_close()</strong> (которая для начала вызывает функцию
  <strong>SessionHandler::write()</strong>).
  
  Этот метод является обёрткой внутреннего обработчика сессий PHP, определённого в настройке
  ini-файла session.save_handler, которая устанавливается перед тем как обработчик активируется
  функцией <strong>session_set_save_handler()</strong>.
  
  Если этот класс расширяется путём наследования, то вызов родительского метода <strong>$close</strong> выполнит код
  обёртки, а следовательно код внутреннего обработчика. Это позволяет методу быть переопределённым
  или перехваченным.
  
  Дополнительную информацию о том, какие действия ожидаются от этого метода смотрите руководство по
  методу <strong>SessionHandlerInterface::close()</strong>.

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


id: SessionHandler::create_sid
type: function
doc:
<comment>Description:</comment>
  Возвращает новый идентификатор сессии
  
  Генерирует и возвращает новый идентификатор сессии.

<comment>Return:</comment>
  <info>string</info>  Идентификатор сессии допустимый для обработчика сессии по умолчанию.

<comment>See Also:</comment>
   * <strong>session_id()</strong>
   * <strong>session_create_id()</strong>


id: SessionHandler::destroy
type: function
doc:
<comment>Description:</comment>
  Уничтожает сессию
  
  Уничтожает сессию. Вызывается изнутри PHP посредством функции <strong>session_regenerate_id()</strong>
  (подразумевается, что параметр <strong>$destroy</strong> установлен в <info>true</info>, функции <strong>session_destroy()</strong> или когда
  вызов <strong>session_decode()</strong> неудачен.
  
  Этот метод является обёрткой для внутреннего обработчика PHP, определённого в настройке ini-файла
  session.save_handler, который устанавливается до обработчика вызовом <strong>session_set_save_handler()</strong>.
  
  Если этот класс расширяется путём наследования, то вызов родительского метода <strong>$destroy</strong> выполнит
  код обёртки, а следовательно код внутреннего обработчика. Это позволяет методу быть
  переопределённым, перехваченным или отфильтрованным.
  
  Для дополнительной информации смотрите руководство по функции <strong>SessionHandlerInterface::destroy()</strong>.

<comment>Param:</comment>
  <info>string</info>  <strong>$id</strong>  Идентификатор уничтожаемой сессии.

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


id: SessionHandler::gc
type: function
doc:
<comment>Description:</comment>
  Очищает старые сессии
  
  Очищает сессии с истёкшим сроком жизни. Вызывается случайным образом изнутри PHP когда сессия
  стартует или когда вызвана функция <strong>session_start()</strong>. Частота, с которой она вызывается, основана на
  значении параметров конфигурации session.gc_divisor и session.gc_probability.
  
  Этот метод обёртывает внутренний обработчик сессии определённый в настройке ini-файла
  session.save_handler который устанавливается перед тем, как определяется данный обработчик в
  функции <strong>session_set_save_handler()</strong>.
  
  Если этот класс расширяется путём наследования, вызов родительского метода <strong>$gc</strong> выполнит код
  обёртки для этого метода, а также внутренний обработчик.  Это позволит методу быть
  переопределённым, или перехваченным и отфильтрованным.
  
  Для дополнительной информации о том, что ожидается от реализации этого метода смотрите
  документацию по методу <strong>SessionHandlerInterface::gc()</strong>.

<comment>Param:</comment>
  <info>int</info>  <strong>$max_lifetime</strong>  Сессии, которые не были обновлены в течение последних <strong>$max_lifetime</strong> секунд
                      удаляются.

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


id: SessionHandler::open
type: function
doc:
<comment>Description:</comment>
  Инициализирует сессию
  
  Создаёт новую сессию или повторно инициализирует существующую. Вызывается изнутри PHP когда сессия
  стартует автоматически или посредством вызова функции <strong>session_start()</strong>.
  
  Этот метод является обёрткой для внутреннего обработчика PHP определённого в настройке ini-файла
  session.save_handler, который устанавливается до определения обработчика вызовом функции
  <strong>session_set_save_handler()</strong>.
  
  Если этот класс расширяется путём наследования, вызов родительского метода <strong>$open</strong> выполнит код
  обёртки для этого метода, а также внутренний обработчик. Это позволит методу быть
  переопределённым, или перехваченным и отфильтрованным.
  
  Для дополнительной информации о том, что ожидается от реализации этого метода смотрите
  документацию по методу <strong>SessionHandlerInterface::open()</strong>.

<comment>Param:</comment>
  <info>string</info>  <strong>$path</strong>  Путь по которому сохраняется/восстанавливается сессия.
  <info>string</info>  <strong>$name</strong>  Название сессии.

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

<comment>See Also:</comment>
   * 
     Опция конфигурации session.auto-start
    


id: SessionHandler::read
type: function
doc:
<comment>Description:</comment>
  Считывает данные сессии
  
  Считывает данные сессии из хранилища и возвращает результат обратно в PHP для внутренней
  обработки. Этот метод вызывается автоматически когда PHP стартует сессию (либо автоматически или
  напрямую вызовом <strong>session_start()</strong> с последующим вызовом <strong>SessionHandler::open()</strong>.
  
  Этот метод является обёрткой внутреннего обработчика PHP, определённого в параметре ini-файла
  session.save_handler который устанавливается до того, как будет определён обработчик сессии
  вызовом  <strong>session_set_save_handler()</strong>.
  
  Если этот класс расширен путём наследования, вызов родительского метода <strong>$read</strong> вызовет обёртку для
  этого метода и, соответственно, вызов внутреннего обработчика. Это позволяет методу быть
  перегруженным, и/или перехваченные и отфильтрованным (например для расшифровки, значения параметра
  <strong>$data</strong>, которое возвращает родительский метод <strong>$read</strong>).
  
  Для дополнительной информации смотрите документацию по методу <strong>SessionHandlerInterface::read()</strong>.

<comment>Param:</comment>
  <info>string</info>  <strong>$id</strong>  Идентификатор сессии, из которой необходимо считать данные.

<comment>Return:</comment>
  <info>string|false</info>  Возвращает зашифрованную строку считанных данных. Если ничего не считано,
                возвращается <info>false</info>. Обратите внимание, что это значение возвращается в PHP для
                внутренней обработки.

<comment>See Also:</comment>
   * 
     Директива настройки session.serialize_handler.
    


id: SessionHandler::write
type: function
doc:
<comment>Description:</comment>
  Записывает данные сессии
  
  Записывает данные сессии в хранилище. Обычно вызывается при завершении скрипта, функцией
  <strong>session_write_close()</strong> или когда <strong>session_register_shutdown()</strong> терпит неудачу. PHP вызывает
  <strong>SessionHandler::close()</strong> сразу же после этого метода.
  
  Метод является обёрткой внутреннего обработчика PHP, определённого в параметре ini-файла
  session.save_handler который устанавливается до того, как будет определён обработчик сессии
  вызовом <strong>session_set_save_handler()</strong>.
  
  Если этот класс расширен путём наследования, вызов родительского метода <strong>$write</strong> вызовет обёртку для
  этого метода и, соответственно, вызов внутреннего обработчика. Это позволяет методу быть
  перегруженным или перехваченным и отфильтрованным (например, для шифрования значения параметра
  <strong>$data</strong> перед отправкой его в родительский метод <strong>$write</strong>).
  
  Для дополнительной информации смотрите документацию по методу <strong>SessionHandlerInterface::write()</strong>.

<comment>Param:</comment>
  <info>string</info>  <strong>$id</strong>    Идентификатор сессии.
  <info>string</info>  <strong>$data</strong>  Зашифрованные данные сессии. Эти данные являются результатом того, что PHP
                 внутренне шифрует суперглобальную переменную $_SESSION в сериализированную строку и
                 передаёт её в качестве параметра. Обратите внимание, что сессии используют
                 альтернативный метод сериализации.

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

<comment>See Also:</comment>
   * 
     Директива настройки конфигурации session.serialize_handler.
    


id: SessionHandlerInterface
type: class
doc:
<comment>Description:</comment>
  <class>SessionHandlerInterface</class> - это интерфейс, который определяет минимальный прототип для создания
  пользовательского обработчика сессии. Для предоставления пользовательского обработчика сессии
  функции <strong>session_set_save_handler()</strong>, используя её ООП реализацию, класс должен реализовывать этот
  интерфейс.
  
  Обратите внимание, что callback-методы этого класса созданы для внутренних вызовов PHP и не
  предназначены для вызовов из вашего кода.


id: SessionHandlerInterface::close
type: function
doc:
<comment>Description:</comment>
  Закрывает сессию
  
  Закрывает текущую сессию. Эта функция автоматически выполняется при закрытии сессии или явно через
  <strong>session_write_close()</strong>.

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


id: SessionHandlerInterface::destroy
type: function
doc:
<comment>Description:</comment>
  Уничтожает сессию
  
  Уничтожает сессию. Вызывается функциями <strong>session_regenerate_id()</strong> (с $destroy = <info>true</info>),
  <strong>session_destroy()</strong> и при неудачном завершении функции <strong>session_decode()</strong>.

<comment>Param:</comment>
  <info>string</info>  <strong>$id</strong>  Идентификатор сессии уничтожается.

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


id: SessionHandlerInterface::gc
type: function
doc:
<comment>Description:</comment>
  Очищает старые сессии
  
  Очищает сессии с истёкшим сроком жизни. Вызывается функцией <strong>session_start()</strong>, и основывается на
  опциях session.gc_divisor, session.gc_probability и session.gc_maxlifetime.

<comment>Param:</comment>
  <info>int</info>  <strong>$max_lifetime</strong>  Сессии, которые не обновлялись в течение <strong>$max_lifetime</strong> секунд, будут удалены.

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


id: SessionHandlerInterface::open
type: function
doc:
<comment>Description:</comment>
  Инициализирует сессию
  
  Повторно инициализирует существующую сессию или создаёт новую. Вызывается когда сессия стартует
  или когда вызвана функция <strong>session_start()</strong>.

<comment>Param:</comment>
  <info>string</info>  <strong>$path</strong>  Путь, по которому сохраняется/восстанавливается сессия.
  <info>string</info>  <strong>$name</strong>  Название сессии.

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

<comment>See Also:</comment>
   * <strong>session_name()</strong>
   * 
     Опция конфигурации session.auto-start
    


id: SessionHandlerInterface::read
type: function
doc:
<comment>Description:</comment>
  Читает данные сессии
  
  Читает данные сессии из хранилища сессий и возвращает результат. Вызывается сразу после старта
  сессии или когда вызвана <strong>session_start()</strong>. Обратите внимание, что перед вызовом этого метода будет
  вызвана функция <strong>SessionHandlerInterface::open()</strong>.
  
  Этот метод вызывается PHP когда стартует сессия. Этот метод должен получить данные сессии из
  хранилища по указанному её идентификатору. Строка, возвращаемая этим методом, должна иметь тот же
  сериализованный формат, что и исходная, которая передавалась функции
  <strong>SessionHandlerInterface::write()</strong>. Если запись не найдена, возвращается <info>false</info>.
  
  Данные, возвращаемые этим методом, будут расшифрованы внутри PHP, используя метод десериализации,
  указанный в session.serialize_handler. Полученные данные будут использованы для заполнения
  суперглобального массива $_SESSION.
  
  Обратите внимание, что схема сериализации данных не такая, как в функции <strong>unserialize()</strong>, и получить
  доступ к данным можно с помощью функции <strong>session_decode()</strong>.

<comment>Param:</comment>
  <info>string</info>  <strong>$id</strong>  Идентификатор сессии.

<comment>Return:</comment>
  <info>string|false</info>  Возвращает закодированную строку прочитанных данных. Если ничего не прочитано,
                возвращается <info>false</info>. Обратите внимание, что это значение передаётся для обработки
                внутри PHP.

<comment>See Also:</comment>
   * 
     INI-директива session.serialize_handler
    


id: SessionHandlerInterface::write
type: function
doc:
<comment>Description:</comment>
  Записать данные сессии
  
  Записывает данные сессии в хранилище сессий. Вызывается функцией <strong>session_write_close()</strong>, когда
  неудачно завершается функция <strong>session_register_shutdown()</strong> или во время нормального завершения
  работы. Внимание: <strong>SessionHandlerInterface::close()</strong> вызывается сразу же после этой функции.
  
  PHP вызывает этот метод, когда сессия готова для сохранения и закрытия. Кодируются данные сессии
  из суперглобального массива $_SESSION в сериализованную строку и передаются вместе с
  идентификатором сессии данному методу для хранения. Используемый метод сериализации указан в опции
  session.serialize_handler.
  
  Обратите внимание, что этот метод обычно вызывается PHP после закрытия буферов вывода, если явно
  не вызывается <strong>session_write_close()</strong>.

<comment>Param:</comment>
  <info>string</info>  <strong>$id</strong>    Идентификатор сессии.
  <info>string</info>  <strong>$data</strong>  Закодированные данные сессии. Эти данные являются результатом внутреннего
                 кодирования PHP суперглобального массива $_SESSION в сериализованную строку и
                 передачи её в качестве этого параметра. Обратите внимание, что сессии используют
                 альтернативный метод сериализации.

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

<comment>See Also:</comment>
   * 
     Директива конфигурации session.serialize_handler
    


id: SessionIdInterface
type: class
doc:
<comment>Description:</comment>
  <class>SessionIdInterface</class> - это интерфейс, который определяет необязательные методы для создания
  пользовательского обработчика сессии. Для предоставления пользовательского обработчика сессии
  функции <strong>session_set_save_handler()</strong>, используя её ООП реализацию, класс должен реализовывать этот
  интерфейс.
  
  Обратите внимание, что callback-методы этого класса созданы для внутренних вызовов PHP и не
  предназначены для вызовов из вашего кода.


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

<comment>Return:</comment>
  <info>string</info>  Новый идентификатор сессии. Обратите внимание, что это значение возвращается внутри PHP
          для обработки.

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


id: SessionUpdateTimestampHandlerInterface
type: class
doc:
<comment>Description:</comment>
  <class>SessionUpdateTimestampHandlerInterface</class> - это интерфейс, который определяет дополнительные методы
  для создания пользовательского обработчика сессии. Для предоставления пользовательского
  обработчика сессии функции <strong>session_set_save_handler()</strong>, используя её ООП реализацию, класс должен
  реализовывать этот интерфейс.
  
  Обратите внимание, что callback-методы этого класса созданы для внутренних вызовов PHP и не
  предназначены для вызовов из вашего кода.


id: SessionUpdateTimestampHandlerInterface::updateTimestamp
type: function
doc:
<comment>Description:</comment>
  Обновить метку времени
  
  Обновляет метку времени последнего изменения сеанса. Функция автоматически выполняется при
  обновлении сеанса.

<comment>Param:</comment>
  <info>string</info>  <strong>$id</strong>    Идентификатор сессии.
  <info>string</info>  <strong>$data</strong>  Данные сессии.

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


id: SessionUpdateTimestampHandlerInterface::validateId
type: function
doc:
<comment>Description:</comment>
  Проверить идентификатор
  
  Проверяет данный идентификатор сессии. Идентификатор сессии действителен, если сессия с таким
  идентификатором уже существует. Функция автоматически выполняется при запуске сессии, указывается
  идентификатор сессии и включается session.use_strict_mode.

<comment>Param:</comment>
  <info>string</info>  <strong>$id</strong>  Идентификатор сессии.

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


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


id: SimdJsonException
type: class
doc:
<comment>Description:</comment>
  Исключение, выбрасываемое функциями <strong>simdjson_decode()</strong>, <strong>simdjson_key_count()</strong>, <strong>simdjson_key_exists()</strong>
  или <strong>simdjson_key_value()</strong>.
   Возможные значения смотрите в константах коды ошибок simdjson.


id: SimdJsonValueError
type: class
doc:
<comment>Description:</comment>
  Ошибка <class>SimdJsonValueError</class> выбрасывается, когда тип аргумента функции simdjson правильный, но его
  значение неверно. Например, когда JSON-декодированное значение $depth не является положительным
  или значение $depth слишком велико.


id: SimpleXMLElement::__construct
type: function
doc:
<comment>Description:</comment>
  Создание нового объекта SimpleXMLElement
    
  
  Создаёт новый объект <class>SimpleXMLElement</class>.

<comment>Param:</comment>
  <info>string</info>  <strong>$data</strong>               Правильно сформированная XML-строка. Может быть путём или URL к
                              XML-документу, если параметр <strong>$dataIsURL</strong> установлен в <info>true</info>.
  <info>int</info>     <strong>$options</strong>            Необязательный параметр, используется для указания дополнительных
                              параметров Libxml, которые влияют на чтение документов XML. Параметры,
                              которые влияют на вывод документов XML (например, <info>LIBXML_NOEMPTYTAG</info>),
                              игнорируются.
                              
                              Для возможности доступа к глубоко вложенным элементам XML или для
                              обработки очень больших текстовых узлов может понадобиться
                              использовать <info>LIBXML_PARSEHUGE</info>.
  <info>bool</info>    <strong>$dataIsURL</strong>          По умолчанию <strong>$dataIsURL</strong> установлен в <info>false</info>. Используйте <info>true</info> для
                              указания того, что <strong>$data</strong> является путём или URL к XML-документу вместо
                              данных типа <info>string</info>.
  <info>string</info>  <strong>$namespaceOrPrefix</strong>  Префикс пространства имён или URI.
  <info>bool</info>    <strong>$isPrefix</strong>           <info>true</info>, если <strong>$namespaceOrPrefix</strong> является префиксом, <info>false</info>, если это URI;
                              по умолчанию <info>false</info>.

<comment>See Also:</comment>
   * 
   * <strong>simplexml_load_string()</strong>
   * <strong>simplexml_load_file()</strong>
   * 
   * <strong>libxml_use_internal_errors()</strong>
   * <strong>libxml_set_streams_context()</strong>


id: SimpleXMLElement::__toString
type: function
doc:
<comment>Description:</comment>
  Возвращает содержимое строки
  
  Возвращает содержимое строки, находящиеся непосредственно в элементе. Не возвращает текстовый
  контент дочерних элементов.

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

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


id: SimpleXMLElement::addAttribute
type: function
doc:
<comment>Description:</comment>
  Добавляет атрибут к SimpleXML-элементу
    
  
  Добавляет атрибут к SimpleXML-элементу.

<comment>Param:</comment>
  <info>string</info>       <strong>$qualifiedName</strong>  Название добавляемого атрибута.
  <info>string</info>       <strong>$value</strong>          Значение атрибута.
  <info>string|null</info>  <strong>$namespace</strong>      Необязательный параметр указывает на пространство имён, к которому
                               принадлежит атрибут.

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

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


id: SimpleXMLElement::addChild
type: function
doc:
<comment>Description:</comment>
  Добавляет дочерний элемент к узлу XML
    
  
  Добавляет дочерний элемент к узлу и возвращает потомка SimpleXMLElement.

<comment>Param:</comment>
  <info>string</info>       <strong>$qualifiedName</strong>  Имя добавляемого дочернего элемента.
  <info>string|null</info>  <strong>$value</strong>          Если указано, то значение (содержимое) дочернего элемента.
  <info>string|null</info>  <strong>$namespace</strong>      Если указано, то пространство имён, к которому принадлежит дочерний
                               элемент.

<comment>Return:</comment>
  <info>SimpleXMLElement|null</info>  Метод <return>addChild</return> возвращает объект <info>SimpleXMLElement</info>, представляющий
                         добавленного потомка к узлу XML в случае успешного выполнения; <info>null</info> в
                         случае возникновения ошибки.

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


id: SimpleXMLElement::asXML
type: function
doc:
<comment>Description:</comment>
  Возвращает сформированный XML-документ в виде строки на основе элемента SimpleXML
    
  
  Метод <return>asXML</return> задаёт формат данных родительских объектов в версии XML 1.0.

<comment>Param:</comment>
  <info>string|null</info>  <strong>$filename</strong>  Если указано значение в виде строки (<info>string</info>), то функция запишет данные в
                          файл, а не вернёт их.

<comment>Return:</comment>
  <info>string|bool</info>  Если <strong>$filename</strong> не указан, то функция вернёт строку (<info>string</info>) в случае успешного
               выполнения и <info>false</info> в случае возникновения ошибки. Если параметр указан, то функция
               вернёт <info>true</info>, если файл будет успешно записан и <info>false</info> в противном случае.

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


id: SimpleXMLElement::attributes
type: function
doc:
<comment>Description:</comment>
  Возвращает атрибуты элемента
  
  Эта функция возвращает названия и значения атрибутов, определённые в теге XML.
  
  SimpleXML содержит правило добавления
  итеративных свойств к большинству методов. Они не могут быть просмотрены с использованием
  <strong>var_dump()</strong> или каких-либо других средств анализа объектов.

<comment>Param:</comment>
  <info>string|null</info>  <strong>$namespaceOrPrefix</strong>  Необязательное пространство имён для извлечённых атрибутов
  <info>bool</info>         <strong>$isPrefix</strong>           По умолчанию <info>false</info>

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

<comment>See Also:</comment>
   * 


id: SimpleXMLElement::children
type: function
doc:
<comment>Description:</comment>
  Находит дочерние элементы данного узла
  
  Этот метод находит все дочерние элементы узла. Результат подчиняется стандартным правилам
  итерации.
  
  SimpleXML содержит правило добавления
  итеративных свойств к большинству методов. Они не могут быть просмотрены с использованием
  <strong>var_dump()</strong> или каких-либо других средств анализа объектов.

<comment>Param:</comment>
  <info>string|null</info>  <strong>$namespaceOrPrefix</strong>  Необязательное пространство имён XML.
  <info>bool</info>         <strong>$isPrefix</strong>           Если <strong>$isPrefix</strong> установлен в <info>true</info>, <strong>$namespaceOrPrefix</strong> будет
                                   рассмотрен как префикс. Если <info>false</info>, <strong>$namespaceOrPrefix</strong> будет
                                   рассмотрен как пространство имён URL.

<comment>Return:</comment>
  <info>SimpleXMLElement|null</info>  Возвращает элемент <class>SimpleXMLElement</class>, даже если узел не имеет дочерних
                         элементов, если узел не представляет атрибут, в этом случае функция
                         возвращает <info>null</info>.

<comment>See Also:</comment>
   * SimpleXMLElement::count
   * <strong>count()</strong>


id: SimpleXMLElement::count
type: function
doc:
<comment>Description:</comment>
  Подсчитывает количество дочерних элементов у текущего элемента
  
  Этот метод подсчитывает количество дочерних элементов у текущего элемента.

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

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


id: SimpleXMLElement::current
type: function
doc:
<comment>Description:</comment>
  Возвращает текущий элемент
  
  До версии PHP 8.0 метод SimpleXMLElement::current был объявлен только для дочернего класса
  <class>SimpleXMLIterator</class>.
  
  Метод возвращает текущий элемент в виде объекта <class>SimpleXMLElement</class>.

<comment>Return:</comment>
  <info>SimpleXMLElement</info>  Возвращает текущий элемент в виде объекта <class>SimpleXMLElement</class>.

<comment>See Also:</comment>
   * SimpleXMLElement::key
   * SimpleXMLElement::next
   * SimpleXMLElement::rewind
   * SimpleXMLElement::valid
   * <class>SimpleXMLElement</class>


id: SimpleXMLElement::getChildren
type: function
doc:
<comment>Description:</comment>
  Возвращает дочерние элементы текущего элемента
  
  До версии PHP 8.0 метод SimpleXMLElement::getChildren был объявлен только для дочернего класса
  <class>SimpleXMLIterator</class>.
  
  Метод возвращает объект <class>SimpleXMLElement</class>, содержащий дочерние элементы текущего элемента
  <class>SimpleXMLElement</class>.

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


id: SimpleXMLElement::getDocNamespaces
type: function
doc:
<comment>Description:</comment>
  Возвращает пространства имён, объявленные в документе
    
  
  Возвращает пространства имён, объявленные в документе

<comment>Param:</comment>
  <info>bool</info>  <strong>$recursive</strong>  Если указано, то возвращает все объявленные пространства имён у родительского
                    узла и его дочерних элементов. В противном случае, возвращает только объявленное
                    пространство имён корневого узла.
  <info>bool</info>  <strong>$fromRoot</strong>   Позволяет рекурсивно проверить пространства имён у дочернего узла вместо
                    корневого узла XML документа.

<comment>Return:</comment>
  <info>array|false</info>  Метод <return>getDocNamespaces</return> возвращает массив (<info>array</info>) с названиями пространств имён и
               связанными с ними URI.

<comment>See Also:</comment>
   * SimpleXMLElement::getNamespaces
   * SimpleXMLElement::registerXPathNamespace


id: SimpleXMLElement::getName
type: function
doc:
<comment>Description:</comment>
  Получает имя элемента XML
  
  Получает имя элемента XML.

<comment>Return:</comment>
  <info>string</info>  Метод <return>getName</return> возвращает имя тега XML в виде строки (<info>string</info>), на который ссылается объект
          SimpleXMLElement.


id: SimpleXMLElement::getNamespaces
type: function
doc:
<comment>Description:</comment>
  Возвращает пространства имён, используемые в документе
    
  
  Возвращает пространства имён, используемые в документе

<comment>Param:</comment>
  <info>bool</info>  <strong>$recursive</strong>  Если указано, то возвращает все используемые пространства имён у родительского
                    узла и его дочерних элементов. В противном случае возвращает только используемое
                    пространство имён корневого узла.

<comment>Return:</comment>
  <info>array</info>  Метод <return>getNamespaces</return> возвращает массив (<info>array</info>) с названиями пространств имён и связанными с
         ними URI.

<comment>See Also:</comment>
   * SimpleXMLElement::getDocNamespaces
   * SimpleXMLElement::registerXPathNamespace


id: SimpleXMLElement::hasChildren
type: function
doc:
<comment>Description:</comment>
  Проверяет, имеет ли текущий элемент дочерние элементы
  
  До версии PHP 8.0 метод SimpleXMLElement::hasChildren был объявлен только для дочернего класса
  <class>SimpleXMLIterator</class>.
  
  Метод проверяет, имеет ли текущий элемент <class>SimpleXMLElement</class> дочерние элементы.

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


id: SimpleXMLElement::key
type: function
doc:
<comment>Description:</comment>
  Возвращает имя XML-тега текущего элемента
  
  До версии PHP 8.0 метод SimpleXMLElement::key был объявлен только для дочернего класса
  <class>SimpleXMLIterator</class>.
  
  Метод получает имя XML-тега текущего элемента.

<comment>Return:</comment>
  <info>string</info>  Возвращает имя XML-тега элемента, на который ссылается текущий объект <class>SimpleXMLElement</class>.


id: SimpleXMLElement::next
type: function
doc:
<comment>Description:</comment>
  Переход к следующему элементу
  
  До версии PHP 8.0 метод SimpleXMLElement::next был объявлен только для дочернего класса
  <class>SimpleXMLIterator</class>.
  
  Метод перемещает <class>SimpleXMLElement</class> к следующему элементу.

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


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

<comment>Param:</comment>
  <info>string</info>  <strong>$prefix</strong>     Префикс используемого пространства имён в запросе XPath для получения
                      пространства имён в <strong>$namespace</strong>.
  <info>string</info>  <strong>$namespace</strong>  Используемое пространство имён для запроса XPath. Оно должно соответствовать
                      пространству имён в используемом XML-документе или запрос XPath, использующий
                      <strong>$prefix</strong> не даст никаких результатов.

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

<comment>See Also:</comment>
   * SimpleXMLElement::xpath
   * SimpleXMLElement::getDocNamespaces
   * SimpleXMLElement::getNamespaces


id: SimpleXMLElement::rewind
type: function
doc:
<comment>Description:</comment>
  Перемотка к первому элементу
  
  До версии PHP 8.0 метод SimpleXMLElement::rewind был объявлен только для дочернего класса
  <class>SimpleXMLIterator</class>.
  
  Метод перематывает <class>SimpleXMLElement</class> к первому элементу.

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


id: SimpleXMLElement::saveXML
type: function
doc:
<comment>Description:</comment>
  Псевдоним SimpleXMLElement::asXML
  
  Метод является псевдонимом:  SimpleXMLElement::asXML


id: SimpleXMLElement::valid
type: function
doc:
<comment>Description:</comment>
  Проверяет, является ли текущий элемент корректным
  
  До версии PHP 8.0 метод SimpleXMLElement::valid был объявлен только для дочернего класса
  <class>SimpleXMLIterator</class>.
  
  Метод проверяет, является ли текущий элемент корректным после вызовов SimpleXMLElement::rewind или
  SimpleXMLElement::next.

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


id: SimpleXMLElement::xpath
type: function
doc:
<comment>Description:</comment>
  Запускает запрос XPath к XML-данным
  
  Метод <return>xpath</return> ищет узлы SimpleXML с дочерними элементами, соответствующие XPath <strong>$expression</strong>.

<comment>Param:</comment>
  <info>string</info>  <strong>$expression</strong>  Путь XPath

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

<comment>See Also:</comment>
   * SimpleXMLElement::registerXPathNamespace
   * SimpleXMLElement::getDocNamespaces
   * SimpleXMLElement::getNamespaces
   * 


id: SimpleXMLIterator
type: class
doc:
<comment>Description:</comment>
  SimpleXMLIterator обеспечивает рекурсивную итерацию по всем узлам объекта <class>SimpleXMLElement</class>.


id: SoapClient
type: class
doc:
<comment>Description:</comment>
  Класс SoapClient представляет собой клиента для серверов SOAP 1.1, SOAP 1.2. Он может
  использоваться в режиме с WSDL или без него.


id: SoapClient::__call
type: function
doc:
<comment>Description:</comment>
  Вызывает SOAP-функцию (устаревший метод)
  
  Вызов этого метода напрямую устарел. Обычно функции SOAP могут вызываться как методы объекта
  <class>SoapClient</class>; в ситуациях, когда это невозможно или требуются дополнительные опции, используйте
  метод SoapClient::__soapCall..

<comment>Param:</comment>
  <info>string</info>  <strong>$name</strong>  Имя вызываемой функции SOAP.
  <info>array</info>   <strong>$args</strong>  Массив аргументов для передачи функции. Может быть упорядоченный или ассоциативный
                 массив. Обратите внимание, что большинство серверов SOAP требуют предоставления
                 имён параметров, в этом случае должен быть ассоциативный массив.

<comment>Return:</comment>
  <info>mixed</info>  Функции SOAP могут возвращать одно или несколько значений. Если функция SOAP возвращает
         только одно значение, то возвращаемое значение будет скаляром. Если возвращается несколько
         значений, то вместо них возвращается ассоциативный массив именованных выходных параметров.
         
         В случае возникновения ошибки, если объект <class>SoapClient</class> был объявлен с опцией <return>exceptions</return> со
         значением <info>false</info>, будет возвращён объект <class>SoapFault</class>.


id: SoapClient::__construct
type: function
doc:
<comment>Description:</comment>
  Конструктор класса SoapClient
  
  Создаёт объект <class>SoapClient</class> для подключения к службе SOAP.

<comment>Param:</comment>
  <info>string|null</info>  <strong>$wsdl</strong>                URI WSDL-файла, описывающего сервис, который используется для
                                    автоматической настройки клиента. Если он не указан, клиент
                                    будет работать в режиме без WSDL. mode.
                                    
                                    По умолчанию WSDL-файл будет кешироваться для повышения
                                    производительности. Чтобы отключить или настроить кеширование,
                                    смотрите раздел Опции настройки SOAP и параметр <return>cache_wsdl</return>.
  <info>array</info>        <strong>$options</strong>             Ассоциативный массив, определяющий дополнительные параметры для
                                    клиента SOAP. Если указан параметр <strong>$wsdl</strong>, это необязательно, в
                                    противном случае, по крайней мере параметры <return>location</return> и <return>url</return>
                                    должны быть указаны. <strong>$location</strong><info>string</info> URL-адрес сервера SOAP для
                                    отправки запроса.  Обязателен, если параметр <strong>$wsdl</strong> не указан.
                                    Если предоставлены и параметр <strong>$wsdl</strong> и <return>location</return>, параметр
                                    <return>location</return> будет приоритетнее расположения, указанного в
                                    WSDL-файле. <strong>$uri</strong><info>string</info> Целевое пространство имён службы SOAP.
                                    Обязателен, если параметр <strong>$wsdl</strong> не указан; в противном случае
                                    игнорируется. <strong>$style</strong><info>int</info> Определяет стиль связывания, который
                                    будет использоваться клиентом, используя константы <info>SOAP_RPC</info> и
                                    <info>SOAP_DOCUMENT</info>. Константа <info>SOAP_RPC</info> указывает на привязку в стиле
                                    RPC, где тело запроса SOAP содержит стандартное кодирование
                                    вызова функции. Константа <info>SOAP_DOCUMENT</info> указывает на привязку в
                                    стиле документа, где тело запроса SOAP содержит XML-документ с
                                    определённым службой значением.  Если указан параметр <strong>$wsdl</strong>, то
                                    этот параметр игнорируется, а стиль считывается из WSDL-файла.
                                    Если ни этот параметр, ни параметр <strong>$wsdl</strong> не указан, используется
                                    RPC-стиль. <strong>$use</strong><info>int</info> Определяет стиль кодировки, который будет
                                    использоваться клиентом, используя константы <info>SOAP_ENCODED</info> или
                                    <info>SOAP_LITERAL</info>. Константа <info>SOAP_ENCODED</info> указывает на кодирование с
                                    использованием типов определённых в спецификации SOAP. Константа
                                    <info>SOAP_LITERAL</info> указывает на кодирование с использованием схемы
                                    определённой службой.  Если указан параметр <strong>$wsdl</strong>, этот параметр
                                    игнорируется, а кодировка считывается из файла WSDL.  Если ни
                                    этот параметр, ни параметр <strong>$wsdl</strong> не указаны, используется стиль
                                    "encoded". <strong>$soap_version</strong><info>int</info> Определяет версию протокола SOAP:
                                    Константа <info>SOAP_1_1</info> для SOAP 1.1, или <info>SOAP_1_2</info> для SOAP 1.2.
                                    Если опущено, используется SOAP 1.1. <strong>$authentication</strong><info>int</info>
                                    Указывает метод аутентификации при использовании
                                    HTTP-аутентификации в запросах. Значение может быть либо
                                    <info>SOAP_AUTHENTICATION_BASIC</info>, либо <info>SOAP_AUTHENTICATION_DIGEST</info>.
                                    Если параметр не указан, но указан параметр <return>login</return>, используется
                                    Basic Authentication. <strong>$login</strong><info>string</info> Имя пользователя для
                                    использования при аутентификации HTTP Basic или Digest.
                                    <strong>$password</strong><info>string</info> Пароль для использования при аутентификации HTTP
                                    Basic или Digest.  Не следует путать с параметром <return>passphrase</return>,
                                    который используется при аутентификации сертификата клиента
                                    HTTPS. <strong>$local_cert</strong><info>string</info> Путь к клиентскому сертификату для
                                    использования с аутентификацией HTTPS. Должен быть файл в
                                    кодировке PEM, содержащий сертификат и закрытый ключ.  Файл
                                    также может включать цепочку эмитентов, которая должна идти
                                    после сертификата клиента.  Также может быть задан с помощью
                                    параметра <strong>$stream_context</strong>, который также поддерживает указание
                                    отдельного файла закрытого ключа. <strong>$passphrase</strong><info>string</info> Ключевая
                                    фраза для клиентского сертификата, указанного в параметре
                                    <return>local_cert</return>.  Не следует путать с параметром <return>password</return>, который
                                    используется для аутентификации Basic или Digest.  Можно также
                                    установить с помощью параметра <strong>$stream_context</strong>.
                                    <strong>$proxy_host</strong><info>string</info> Имя хоста для использования в качестве
                                    прокси-сервера для HTTP-запросов.  Также должен быть указан
                                    параметр <return>proxy_port</return>. <strong>$proxy_port</strong><info>int</info> TCP-порт для использования
                                    при подключении к прокси-серверу, указанному в параметре
                                    <return>proxy_host</return>. <strong>$proxy_login</strong><info>string</info> Необязательное имя пользователя
                                    для аутентификации на прокси-сервере, указанном в параметре
                                    <return>proxy_host</return>, используя HTTP Basic Authentication.
                                    <strong>$proxy_password</strong><info>string</info> Необязательный пароль для аутентификации
                                    на прокси-сервере, указанном в параметре <return>proxy_host</return>, используя
                                    HTTP Basic Authentication. <strong>$compression</strong><info>int</info> Включает сжатие HTTP
                                    SOAP запросов и ответов.  Значение должно быть побитовым ИЛИ из
                                    трёх частей: необязательная <info>SOAP_COMPRESSION_ACCEPT</info>, для
                                    отправки заголовка "Accept-Encoding"; либо константа
                                    <info>SOAP_COMPRESSION_GZIP</info> или <info>SOAP_COMPRESSION_DEFLATE</info> для указания
                                    используемого алгоритма сжатия; число от 1 до 9, чтобы указать
                                    уровень сжатия, который будет использоваться в запросе.
                                    Например, чтобы включить двустороннее сжатие gzip с максимальным
                                    уровнем сжатия, используйте <return>SOAP_COMPRESSION_ACCEPT |
                                    SOAP_COMPRESSION_GZIP | 9</return>. <strong>$encoding</strong><info>string</info> Определяет внутреннюю
                                    кодировку символов. Запросы всегда отправляются в UTF-8 и
                                    преобразуются в эту кодировку и обратно. <strong>$trace</strong><info>bool</info> Захватывает
                                    информацию о запросе и ответе, которая затем может быть доступна
                                    с помощью методов: SoapClient::__getLastRequest,
                                    SoapClient::__getLastRequestHeaders,
                                    SoapClient::__getLastResponse и
                                    SoapClient::__getLastResponseHeaders.  Если опущено, по
                                    умолчанию используется значение <info>false</info>. <strong>$classmap</strong><info>array</info>
                                    Используется для сопоставления типов, определённых в WSDL с
                                    классами PHP. Должен быть указан ассоциативный массив (<info>array</info>) с
                                    именами типов из WSDL в качестве ключей и именами классов PHP в
                                    качестве значений. Обратите внимание, что имя типа элемента не
                                    обязательно совпадает с именем элемента (тега).  Предоставляемые
                                    имена классов всегда должны быть полностью определены с помощью
                                    любых пространств имён и никогда не должны начинаться с ведущего
                                    слеша (<return>\</return>). Правильная форма может быть указана с помощью
                                    ::class.  Обратите внимание, что при создании класса конструктор
                                    вызываться не будет, но магические методы __set() и __get()
                                    будут вызываться для отдельных свойств. <strong>$typemap</strong><info>array</info>
                                    Используется для определения сопоставлений типов с помощью
                                    определяемых пользователем callback-функций. Каждое
                                    сопоставление типов должно представлять собой массив с ключами
                                    <return>type_name</return> (строка (<info>string</info>), определяющая тип элемента XML);
                                    <return>type_ns</return> (строка (<info>string</info>), содержащая пространство имён URI);
                                    <return>from_xml</return> (<info>callable</info>, принимающий один строковый параметр и
                                    возвращающий объект) и <return>to_xml</return> (<info>callable</info>, принимающий один
                                    объектный параметр и возвращающий строку). <strong>$exceptions</strong><info>bool</info>
                                    Определяет, будут ли ошибки выбрасывать исключение типа
                                    <class>SoapFault</class>.  По умолчанию значение <info>true</info> <strong>$connection_timeout</strong><info>int</info>
                                    Определяет время ожидания в секундах для соединения с сервисом
                                    SOAP. Параметр не определяет время ожидания служб с медленными
                                    ответами. Чтобы ограничить время ожидания завершения вызовов,
                                    можно использовать параметр конфигурации default_socket_timeout.
                                    <strong>$cache_wsdl</strong><info>int</info> Если указан параметр <strong>$wsdl</strong>, а также параметр
                                    soap.wsdl_cache_enabled включён, этот параметр определяет тип
                                    кеширования. Одно из значений: <info>WSDL_CACHE_NONE</info>, <info>WSDL_CACHE_DISK</info>,
                                    <info>WSDL_CACHE_MEMORY</info> или <info>WSDL_CACHE_BOTH</info>.  Доступны два типа кеша:
                                    кеширование в памяти, которое кеширует WSDL в памяти текущего
                                    процесса и дисковое кеширование, которое кеширует WSDL в файле
                                    на диске, разделяемом между всеми процессами. Каталог, который
                                    будет использоваться для дискового кеша, определяется параметром
                                    soap.wsdl_cache_dir. Оба кеша используют одинаковое время жизни,
                                    определяемое параметром soap.wsdl_cache_ttl. У кеша в памяти
                                    также есть максимальное количество записей, определяемое
                                    параметром soap.wsdl_cache_limit.  Если не указано, будет
                                    использоваться параметр конфигурации soap.wsdl_cache.
                                    <strong>$user_agent</strong><info>string</info> Значение для использования в HTTP-заголовке
                                    <return>User-Agent</return> при выполнении запросов.  Можно также установить с
                                    помощью параметра <strong>$stream_context</strong>.  Если не указано, User-Agent
                                    будет <return>"PHP-SOAP/"</return> за которым следует значение <info>PHP_VERSION</info>.
                                    <strong>$stream_context</strong><info>resource</info> Контекст stream context, созданный с
                                    помощью функции <strong>stream_context_create()</strong>, которая позволяет
                                    установить дополнительные параметры.  Контекст может включать
                                    параметры контекста сокета, параметры контекста SSL, а также
                                    выбранные опции контекста HTTP: <return>content_type</return>, <return>header</return>,
                                    <return>max_redirects</return>, <return>protocol_version</return>, и <return>user_agent</return>.  Обратите
                                    внимание, что следующие HTTP-заголовки генерируются
                                    автоматически или на основе других параметров и будут
                                    игнорироваться, если указаны в параметре контекста <return>'header'</return>:
                                    <return>host</return>, <return>connection</return>, <return>user-agent</return>, <return>content-length</return>, <return>content-type</return>,
                                    <return>cookie</return>, <return>authorization</return> и <return>proxy-authorization</return> <strong>$features</strong><info>int</info> Битовая
                                    маска для включения одной или нескольких следующих функций:
                                    <info>SOAP_SINGLE_ELEMENT_ARRAYS</info> При декодировании ответа в массив по
                                    умолчанию определяется, появляется ли имя элемента один или
                                    несколько раз в определённом родительском элементе. Для
                                    элементов, которые появляются только один раз, свойство объекта
                                    позволяет получить прямой доступ к содержимому; для элементов,
                                    которые появляются более одного раза, свойство содержит массив с
                                    содержимым каждого соответствующего элемента.  Если включена
                                    функция <info>SOAP_SINGLE_ELEMENT_ARRAYS</info>, элементы, которые появляются
                                    только один раз, помещаются в одноэлементный массив, чтобы
                                    доступ был последовательным для всех элементов. Это будет
                                    работать только при использовании WSDL, содержащего схему для
                                    ответа. Для демонстрации смотрите раздел с примерами.
                                    <info>SOAP_USE_XSI_ARRAY_TYPE</info> Если параметру <return>use</return> или свойству WSDL
                                    передано значение <return>encoded</return>, массивы принудительно используют тип
                                    <return>SOAP-ENC:Array</return>, а не специфический для схемы.
                                    <info>SOAP_WAIT_ONE_WAY_CALLS</info> Ожидание ответа, даже если WSDL
                                    указывает на односторонний запрос.  <strong>$keep_alive</strong><info>bool</info> Логическое
                                    значение, определяющее, следует ли отправлять заголовок
                                    <return>Connection: Keep-Alive</return> или <return>Connection: close</return>.  По умолчанию <info>true</info>
                                    <strong>$ssl_method</strong><info>string</info> Определяет версию протокола SSL или TLS для
                                    использования в защищённых HTTP-соединениях вместо согласования
                                    по умолчанию. Указание <info>SOAP_SSL_METHOD_SSLv2</info> или
                                    <info>SOAP_SSL_METHOD_SSLv3</info> заставит использовать SSL 2 или SSL 3,
                                    соответственно. Указание константы <info>SOAP_SSL_METHOD_SSLv23</info> не
                                    имеет никакого смысла; константа существует только для обратной
                                    совместимости. Начиная с PHP 7.2, указание константы
                                    <info>SOAP_SSL_METHOD_TLS</info> также не имеет никакого смысла; в более
                                    ранних версиях константа определяла принудительное использование
                                    TLS 1.0.  Обратите внимание, что SSL версий 2 и 3 считаются
                                    небезопасными и могут не поддерживаться установленной
                                    библиотекой OpenSSL.  Параметр объявлен УСТАРЕВШИМ, начиная с
                                    PHP 8.1.0. Более гибкой альтернативой, позволяющей указывать
                                    отдельные версии TLS, можно использовать параметр
                                    <strong>$stream_context</strong> с параметром контекста 'crypto_method'. Указание
                                    использования только TLS 1.3 [ 'crypto_method' =>
                                    STREAM_CRYPTO_METHOD_TLSv1_3_CLIENT ]
                                    ]);
                                    $client = new SoapClient("some.wsdl", ['context' => $context]);
                                    ]]> 
                                    
                                    URL-адрес сервера SOAP для отправки запроса.
                                    
                                    Обязателен, если параметр <strong>$wsdl</strong> не указан. Если предоставлены и
                                    параметр <strong>$wsdl</strong> и <return>location</return>, параметр <return>location</return> будет приоритетнее
                                    расположения, указанного в WSDL-файле.
                                    
                                    Целевое пространство имён службы SOAP.
                                    
                                    Обязателен, если параметр <strong>$wsdl</strong> не указан; в противном случае
                                    игнорируется.
                                    
                                    Определяет стиль связывания, который будет использоваться
                                    клиентом, используя константы <info>SOAP_RPC</info> и <info>SOAP_DOCUMENT</info>.
                                    Константа <info>SOAP_RPC</info> указывает на привязку в стиле RPC, где тело
                                    запроса SOAP содержит стандартное кодирование вызова функции.
                                    Константа <info>SOAP_DOCUMENT</info> указывает на привязку в стиле документа,
                                    где тело запроса SOAP содержит XML-документ с определённым
                                    службой значением.
                                    
                                    Если указан параметр <strong>$wsdl</strong>, то этот параметр игнорируется, а
                                    стиль считывается из WSDL-файла.
                                    
                                    Если ни этот параметр, ни параметр <strong>$wsdl</strong> не указан, используется
                                    RPC-стиль.
                                    
                                    Определяет стиль кодировки, который будет использоваться
                                    клиентом, используя константы <info>SOAP_ENCODED</info> или <info>SOAP_LITERAL</info>.
                                    Константа <info>SOAP_ENCODED</info> указывает на кодирование с использованием
                                    типов определённых в спецификации SOAP. Константа <info>SOAP_LITERAL</info>
                                    указывает на кодирование с использованием схемы определённой
                                    службой.
                                    
                                    Если указан параметр <strong>$wsdl</strong>, этот параметр игнорируется, а
                                    кодировка считывается из файла WSDL.
                                    
                                    Если ни этот параметр, ни параметр <strong>$wsdl</strong> не указаны,
                                    используется стиль "encoded".
                                    
                                    Определяет версию протокола SOAP: Константа <info>SOAP_1_1</info> для SOAP
                                    1.1, или <info>SOAP_1_2</info> для SOAP 1.2.
                                    
                                    Если опущено, используется SOAP 1.1.
                                    
                                    Указывает метод аутентификации при использовании
                                    HTTP-аутентификации в запросах. Значение может быть либо
                                    <info>SOAP_AUTHENTICATION_BASIC</info>, либо <info>SOAP_AUTHENTICATION_DIGEST</info>.
                                    
                                    Если параметр не указан, но указан параметр <return>login</return>, используется
                                    Basic Authentication.
                                    
                                    Имя пользователя для использования при аутентификации HTTP Basic
                                    или Digest.
                                    
                                    Пароль для использования при аутентификации HTTP Basic или
                                    Digest.
                                    
                                    Не следует путать с параметром <return>passphrase</return>, который используется
                                    при аутентификации сертификата клиента HTTPS.
                                    
                                    Путь к клиентскому сертификату для использования с
                                    аутентификацией HTTPS. Должен быть файл в кодировке PEM,
                                    содержащий сертификат и закрытый ключ.
                                    
                                    Файл также может включать цепочку эмитентов, которая должна идти
                                    после сертификата клиента.
                                    
                                    Также может быть задан с помощью параметра <strong>$stream_context</strong>,
                                    который также поддерживает указание отдельного файла закрытого
                                    ключа.
                                    
                                    Ключевая фраза для клиентского сертификата, указанного в
                                    параметре <return>local_cert</return>.
                                    
                                    Не следует путать с параметром <return>password</return>, который используется
                                    для аутентификации Basic или Digest.
                                    
                                    Можно также установить с помощью параметра <strong>$stream_context</strong>.
                                    
                                    Имя хоста для использования в качестве прокси-сервера для
                                    HTTP-запросов.
                                    
                                    Также должен быть указан параметр <return>proxy_port</return>.
                                    
                                    TCP-порт для использования при подключении к прокси-серверу,
                                    указанному в параметре <return>proxy_host</return>.
                                    
                                    Необязательное имя пользователя для аутентификации на
                                    прокси-сервере, указанном в параметре <return>proxy_host</return>, используя HTTP
                                    Basic Authentication.
                                    
                                    Необязательный пароль для аутентификации на прокси-сервере,
                                    указанном в параметре <return>proxy_host</return>, используя HTTP Basic
                                    Authentication.
                                    
                                    Включает сжатие HTTP SOAP запросов и ответов.
                                    
                                    Значение должно быть побитовым ИЛИ из трёх частей:
                                    необязательная <info>SOAP_COMPRESSION_ACCEPT</info>, для отправки заголовка
                                    "Accept-Encoding"; либо константа <info>SOAP_COMPRESSION_GZIP</info> или
                                    <info>SOAP_COMPRESSION_DEFLATE</info> для указания используемого алгоритма
                                    сжатия; число от 1 до 9, чтобы указать уровень сжатия, который
                                    будет использоваться в запросе. Например, чтобы включить
                                    двустороннее сжатие gzip с максимальным уровнем сжатия,
                                    используйте <return>SOAP_COMPRESSION_ACCEPT | SOAP_COMPRESSION_GZIP | 9</return>.
                                    
                                    Определяет внутреннюю кодировку символов. Запросы всегда
                                    отправляются в UTF-8 и преобразуются в эту кодировку и обратно.
                                    
                                    Захватывает информацию о запросе и ответе, которая затем может
                                    быть доступна с помощью методов: SoapClient::__getLastRequest,
                                    SoapClient::__getLastRequestHeaders,
                                    SoapClient::__getLastResponse и
                                    SoapClient::__getLastResponseHeaders.
                                    
                                    Если опущено, по умолчанию используется значение <info>false</info>.
                                    
                                    Используется для сопоставления типов, определённых в WSDL с
                                    классами PHP. Должен быть указан ассоциативный массив (<info>array</info>) с
                                    именами типов из WSDL в качестве ключей и именами классов PHP в
                                    качестве значений. Обратите внимание, что имя типа элемента не
                                    обязательно совпадает с именем элемента (тега).
                                    
                                    Предоставляемые имена классов всегда должны быть полностью
                                    определены с помощью любых пространств имён и никогда не должны
                                    начинаться с ведущего слеша (<return>\</return>). Правильная форма может быть
                                    указана с помощью ::class.
                                    
                                    Обратите внимание, что при создании класса конструктор
                                    вызываться не будет, но магические методы __set() и __get()
                                    будут вызываться для отдельных свойств.
                                    
                                    Используется для определения сопоставлений типов с помощью
                                    определяемых пользователем callback-функций. Каждое
                                    сопоставление типов должно представлять собой массив с ключами
                                    <return>type_name</return> (строка (<info>string</info>), определяющая тип элемента XML);
                                    <return>type_ns</return> (строка (<info>string</info>), содержащая пространство имён URI);
                                    <return>from_xml</return> (<info>callable</info>, принимающий один строковый параметр и
                                    возвращающий объект) и <return>to_xml</return> (<info>callable</info>, принимающий один
                                    объектный параметр и возвращающий строку).
                                    
                                    Определяет, будут ли ошибки выбрасывать исключение типа
                                    <class>SoapFault</class>.
                                    
                                    По умолчанию значение <info>true</info>
                                    
                                    Определяет время ожидания в секундах для соединения с сервисом
                                    SOAP. Параметр не определяет время ожидания служб с медленными
                                    ответами. Чтобы ограничить время ожидания завершения вызовов,
                                    можно использовать параметр конфигурации default_socket_timeout.
                                    
                                    Если указан параметр <strong>$wsdl</strong>, а также параметр
                                    soap.wsdl_cache_enabled включён, этот параметр определяет тип
                                    кеширования. Одно из значений: <info>WSDL_CACHE_NONE</info>, <info>WSDL_CACHE_DISK</info>,
                                    <info>WSDL_CACHE_MEMORY</info> или <info>WSDL_CACHE_BOTH</info>.
                                    
                                    Доступны два типа кеша: кеширование в памяти, которое кеширует
                                    WSDL в памяти текущего процесса и дисковое кеширование, которое
                                    кеширует WSDL в файле на диске, разделяемом между всеми
                                    процессами. Каталог, который будет использоваться для дискового
                                    кеша, определяется параметром soap.wsdl_cache_dir. Оба кеша
                                    используют одинаковое время жизни, определяемое параметром
                                    soap.wsdl_cache_ttl. У кеша в памяти также есть максимальное
                                    количество записей, определяемое параметром
                                    soap.wsdl_cache_limit.
                                    
                                    Если не указано, будет использоваться параметр конфигурации
                                    soap.wsdl_cache.
                                    
                                    Значение для использования в HTTP-заголовке <return>User-Agent</return> при
                                    выполнении запросов.
                                    
                                    Можно также установить с помощью параметра <strong>$stream_context</strong>.
                                    
                                    Если не указано, User-Agent будет <return>"PHP-SOAP/"</return> за которым следует
                                    значение <info>PHP_VERSION</info>.
                                    
                                    Контекст stream context, созданный с помощью функции
                                    <strong>stream_context_create()</strong>, которая позволяет установить
                                    дополнительные параметры.
                                    
                                    Контекст может включать параметры контекста сокета, параметры
                                    контекста SSL, а также выбранные опции контекста HTTP:
                                    <return>content_type</return>, <return>header</return>, <return>max_redirects</return>, <return>protocol_version</return>, и
                                    <return>user_agent</return>.
                                    
                                    Обратите внимание, что следующие HTTP-заголовки генерируются
                                    автоматически или на основе других параметров и будут
                                    игнорироваться, если указаны в параметре контекста <return>'header'</return>:
                                    <return>host</return>, <return>connection</return>, <return>user-agent</return>, <return>content-length</return>, <return>content-type</return>,
                                    <return>cookie</return>, <return>authorization</return> и <return>proxy-authorization</return>
                                    
                                    Битовая маска для включения одной или нескольких следующих
                                    функций: <info>SOAP_SINGLE_ELEMENT_ARRAYS</info> При декодировании ответа в
                                    массив по умолчанию определяется, появляется ли имя элемента
                                    один или несколько раз в определённом родительском элементе. Для
                                    элементов, которые появляются только один раз, свойство объекта
                                    позволяет получить прямой доступ к содержимому; для элементов,
                                    которые появляются более одного раза, свойство содержит массив с
                                    содержимым каждого соответствующего элемента.  Если включена
                                    функция <info>SOAP_SINGLE_ELEMENT_ARRAYS</info>, элементы, которые появляются
                                    только один раз, помещаются в одноэлементный массив, чтобы
                                    доступ был последовательным для всех элементов. Это будет
                                    работать только при использовании WSDL, содержащего схему для
                                    ответа. Для демонстрации смотрите раздел с примерами.
                                    <info>SOAP_USE_XSI_ARRAY_TYPE</info> Если параметру <return>use</return> или свойству WSDL
                                    передано значение <return>encoded</return>, массивы принудительно используют тип
                                    <return>SOAP-ENC:Array</return>, а не специфический для схемы.
                                    <info>SOAP_WAIT_ONE_WAY_CALLS</info> Ожидание ответа, даже если WSDL
                                    указывает на односторонний запрос.
                                    
                                    При декодировании ответа в массив по умолчанию определяется,
                                    появляется ли имя элемента один или несколько раз в определённом
                                    родительском элементе. Для элементов, которые появляются только
                                    один раз, свойство объекта позволяет получить прямой доступ к
                                    содержимому; для элементов, которые появляются более одного
                                    раза, свойство содержит массив с содержимым каждого
                                    соответствующего элемента.
                                    
                                    Если включена функция <info>SOAP_SINGLE_ELEMENT_ARRAYS</info>, элементы,
                                    которые появляются только один раз, помещаются в одноэлементный
                                    массив, чтобы доступ был последовательным для всех элементов.
                                    Это будет работать только при использовании WSDL, содержащего
                                    схему для ответа. Для демонстрации смотрите раздел с примерами.
                                    
                                    Если параметру <return>use</return> или свойству WSDL передано значение <return>encoded</return>,
                                    массивы принудительно используют тип <return>SOAP-ENC:Array</return>, а не
                                    специфический для схемы.
                                    
                                    Ожидание ответа, даже если WSDL указывает на односторонний
                                    запрос.
                                    
                                    Логическое значение, определяющее, следует ли отправлять
                                    заголовок <return>Connection: Keep-Alive</return> или <return>Connection: close</return>.
                                    
                                    По умолчанию <info>true</info>
                                    
                                    Определяет версию протокола SSL или TLS для использования в
                                    защищённых HTTP-соединениях вместо согласования по умолчанию.
                                    Указание <info>SOAP_SSL_METHOD_SSLv2</info> или <info>SOAP_SSL_METHOD_SSLv3</info>
                                    заставит использовать SSL 2 или SSL 3, соответственно. Указание
                                    константы <info>SOAP_SSL_METHOD_SSLv23</info> не имеет никакого смысла;
                                    константа существует только для обратной совместимости. Начиная
                                    с PHP 7.2, указание константы <info>SOAP_SSL_METHOD_TLS</info> также не имеет
                                    никакого смысла; в более ранних версиях константа определяла
                                    принудительное использование TLS 1.0.
                                    
                                    Обратите внимание, что SSL версий 2 и 3 считаются небезопасными
                                    и могут не поддерживаться установленной библиотекой OpenSSL.
                                    
                                    Параметр объявлен УСТАРЕВШИМ, начиная с PHP 8.1.0. Более гибкой
                                    альтернативой, позволяющей указывать отдельные версии TLS, можно
                                    использовать параметр <strong>$stream_context</strong> с параметром контекста
                                    'crypto_method'. Указание использования только TLS 1.3 [
                                    'crypto_method' => STREAM_CRYPTO_METHOD_TLSv1_3_CLIENT ]
                                    ]);
                                    $client = new SoapClient("some.wsdl", ['context' => $context]);
                                    ]]>
  <info></info>             <strong>$location</strong>            URL-адрес сервера SOAP для отправки запроса.
                                    
                                    Обязателен, если параметр <strong>$wsdl</strong> не указан. Если предоставлены и
                                    параметр <strong>$wsdl</strong> и <return>location</return>, параметр <return>location</return> будет приоритетнее
                                    расположения, указанного в WSDL-файле.
  <info></info>             <strong>$uri</strong>                 Целевое пространство имён службы SOAP.
                                    
                                    Обязателен, если параметр <strong>$wsdl</strong> не указан; в противном случае
                                    игнорируется.
  <info></info>             <strong>$style</strong>               Определяет стиль связывания, который будет использоваться
                                    клиентом, используя константы <info>SOAP_RPC</info> и <info>SOAP_DOCUMENT</info>.
                                    Константа <info>SOAP_RPC</info> указывает на привязку в стиле RPC, где тело
                                    запроса SOAP содержит стандартное кодирование вызова функции.
                                    Константа <info>SOAP_DOCUMENT</info> указывает на привязку в стиле документа,
                                    где тело запроса SOAP содержит XML-документ с определённым
                                    службой значением.
                                    
                                    Если указан параметр <strong>$wsdl</strong>, то этот параметр игнорируется, а
                                    стиль считывается из WSDL-файла.
                                    
                                    Если ни этот параметр, ни параметр <strong>$wsdl</strong> не указан, используется
                                    RPC-стиль.
  <info></info>             <strong>$use</strong>                 Определяет стиль кодировки, который будет использоваться
                                    клиентом, используя константы <info>SOAP_ENCODED</info> или <info>SOAP_LITERAL</info>.
                                    Константа <info>SOAP_ENCODED</info> указывает на кодирование с использованием
                                    типов определённых в спецификации SOAP. Константа <info>SOAP_LITERAL</info>
                                    указывает на кодирование с использованием схемы определённой
                                    службой.
                                    
                                    Если указан параметр <strong>$wsdl</strong>, этот параметр игнорируется, а
                                    кодировка считывается из файла WSDL.
                                    
                                    Если ни этот параметр, ни параметр <strong>$wsdl</strong> не указаны,
                                    используется стиль "encoded".
  <info></info>             <strong>$soap_version</strong>        Определяет версию протокола SOAP: Константа <info>SOAP_1_1</info> для SOAP
                                    1.1, или <info>SOAP_1_2</info> для SOAP 1.2.
                                    
                                    Если опущено, используется SOAP 1.1.
  <info></info>             <strong>$authentication</strong>      Указывает метод аутентификации при использовании
                                    HTTP-аутентификации в запросах. Значение может быть либо
                                    <info>SOAP_AUTHENTICATION_BASIC</info>, либо <info>SOAP_AUTHENTICATION_DIGEST</info>.
                                    
                                    Если параметр не указан, но указан параметр <return>login</return>, используется
                                    Basic Authentication.
  <info></info>             <strong>$login</strong>               Имя пользователя для использования при аутентификации HTTP Basic
                                    или Digest.
  <info></info>             <strong>$password</strong>            Пароль для использования при аутентификации HTTP Basic или
                                    Digest.
                                    
                                    Не следует путать с параметром <return>passphrase</return>, который используется
                                    при аутентификации сертификата клиента HTTPS.
  <info></info>             <strong>$local_cert</strong>          Путь к клиентскому сертификату для использования с
                                    аутентификацией HTTPS. Должен быть файл в кодировке PEM,
                                    содержащий сертификат и закрытый ключ.
                                    
                                    Файл также может включать цепочку эмитентов, которая должна идти
                                    после сертификата клиента.
                                    
                                    Также может быть задан с помощью параметра <strong>$stream_context</strong>,
                                    который также поддерживает указание отдельного файла закрытого
                                    ключа.
  <info></info>             <strong>$passphrase</strong>          Ключевая фраза для клиентского сертификата, указанного в
                                    параметре <return>local_cert</return>.
                                    
                                    Не следует путать с параметром <return>password</return>, который используется
                                    для аутентификации Basic или Digest.
                                    
                                    Можно также установить с помощью параметра <strong>$stream_context</strong>.
  <info></info>             <strong>$proxy_host</strong>          Имя хоста для использования в качестве прокси-сервера для
                                    HTTP-запросов.
                                    
                                    Также должен быть указан параметр <return>proxy_port</return>.
  <info></info>             <strong>$proxy_port</strong>          TCP-порт для использования при подключении к прокси-серверу,
                                    указанному в параметре <return>proxy_host</return>.
  <info></info>             <strong>$proxy_login</strong>         Необязательное имя пользователя для аутентификации на
                                    прокси-сервере, указанном в параметре <return>proxy_host</return>, используя HTTP
                                    Basic Authentication.
  <info></info>             <strong>$proxy_password</strong>      Необязательный пароль для аутентификации на прокси-сервере,
                                    указанном в параметре <return>proxy_host</return>, используя HTTP Basic
                                    Authentication.
  <info></info>             <strong>$compression</strong>         Включает сжатие HTTP SOAP запросов и ответов.
                                    
                                    Значение должно быть побитовым ИЛИ из трёх частей:
                                    необязательная <info>SOAP_COMPRESSION_ACCEPT</info>, для отправки заголовка
                                    "Accept-Encoding"; либо константа <info>SOAP_COMPRESSION_GZIP</info> или
                                    <info>SOAP_COMPRESSION_DEFLATE</info> для указания используемого алгоритма
                                    сжатия; число от 1 до 9, чтобы указать уровень сжатия, который
                                    будет использоваться в запросе. Например, чтобы включить
                                    двустороннее сжатие gzip с максимальным уровнем сжатия,
                                    используйте <return>SOAP_COMPRESSION_ACCEPT | SOAP_COMPRESSION_GZIP | 9</return>.
  <info></info>             <strong>$encoding</strong>            Определяет внутреннюю кодировку символов. Запросы всегда
                                    отправляются в UTF-8 и преобразуются в эту кодировку и обратно.
  <info></info>             <strong>$trace</strong>               Захватывает информацию о запросе и ответе, которая затем может
                                    быть доступна с помощью методов: SoapClient::__getLastRequest,
                                    SoapClient::__getLastRequestHeaders,
                                    SoapClient::__getLastResponse и
                                    SoapClient::__getLastResponseHeaders.
                                    
                                    Если опущено, по умолчанию используется значение <info>false</info>.
  <info></info>             <strong>$classmap</strong>            Используется для сопоставления типов, определённых в WSDL с
                                    классами PHP. Должен быть указан ассоциативный массив (<info>array</info>) с
                                    именами типов из WSDL в качестве ключей и именами классов PHP в
                                    качестве значений. Обратите внимание, что имя типа элемента не
                                    обязательно совпадает с именем элемента (тега).
                                    
                                    Предоставляемые имена классов всегда должны быть полностью
                                    определены с помощью любых пространств имён и никогда не должны
                                    начинаться с ведущего слеша (<return>\</return>). Правильная форма может быть
                                    указана с помощью ::class.
                                    
                                    Обратите внимание, что при создании класса конструктор
                                    вызываться не будет, но магические методы __set() и __get()
                                    будут вызываться для отдельных свойств.
  <info></info>             <strong>$typemap</strong>             Используется для определения сопоставлений типов с помощью
                                    определяемых пользователем callback-функций. Каждое
                                    сопоставление типов должно представлять собой массив с ключами
                                    <return>type_name</return> (строка (<info>string</info>), определяющая тип элемента XML);
                                    <return>type_ns</return> (строка (<info>string</info>), содержащая пространство имён URI);
                                    <return>from_xml</return> (<info>callable</info>, принимающий один строковый параметр и
                                    возвращающий объект) и <return>to_xml</return> (<info>callable</info>, принимающий один
                                    объектный параметр и возвращающий строку).
  <info></info>             <strong>$exceptions</strong>          Определяет, будут ли ошибки выбрасывать исключение типа
                                    <class>SoapFault</class>.
                                    
                                    По умолчанию значение <info>true</info>
  <info></info>             <strong>$connection_timeout</strong>  Определяет время ожидания в секундах для соединения с сервисом
                                    SOAP. Параметр не определяет время ожидания служб с медленными
                                    ответами. Чтобы ограничить время ожидания завершения вызовов,
                                    можно использовать параметр конфигурации default_socket_timeout.
  <info></info>             <strong>$cache_wsdl</strong>          Если указан параметр <strong>$wsdl</strong>, а также параметр
                                    soap.wsdl_cache_enabled включён, этот параметр определяет тип
                                    кеширования. Одно из значений: <info>WSDL_CACHE_NONE</info>, <info>WSDL_CACHE_DISK</info>,
                                    <info>WSDL_CACHE_MEMORY</info> или <info>WSDL_CACHE_BOTH</info>.
                                    
                                    Доступны два типа кеша: кеширование в памяти, которое кеширует
                                    WSDL в памяти текущего процесса и дисковое кеширование, которое
                                    кеширует WSDL в файле на диске, разделяемом между всеми
                                    процессами. Каталог, который будет использоваться для дискового
                                    кеша, определяется параметром soap.wsdl_cache_dir. Оба кеша
                                    используют одинаковое время жизни, определяемое параметром
                                    soap.wsdl_cache_ttl. У кеша в памяти также есть максимальное
                                    количество записей, определяемое параметром
                                    soap.wsdl_cache_limit.
                                    
                                    Если не указано, будет использоваться параметр конфигурации
                                    soap.wsdl_cache.
  <info></info>             <strong>$user_agent</strong>          Значение для использования в HTTP-заголовке <return>User-Agent</return> при
                                    выполнении запросов.
                                    
                                    Можно также установить с помощью параметра <strong>$stream_context</strong>.
                                    
                                    Если не указано, User-Agent будет <return>"PHP-SOAP/"</return> за которым следует
                                    значение <info>PHP_VERSION</info>.
  <info></info>             <strong>$stream_context</strong>      Контекст stream context, созданный с помощью функции
                                    <strong>stream_context_create()</strong>, которая позволяет установить
                                    дополнительные параметры.
                                    
                                    Контекст может включать параметры контекста сокета, параметры
                                    контекста SSL, а также выбранные опции контекста HTTP:
                                    <return>content_type</return>, <return>header</return>, <return>max_redirects</return>, <return>protocol_version</return>, и
                                    <return>user_agent</return>.
                                    
                                    Обратите внимание, что следующие HTTP-заголовки генерируются
                                    автоматически или на основе других параметров и будут
                                    игнорироваться, если указаны в параметре контекста <return>'header'</return>:
                                    <return>host</return>, <return>connection</return>, <return>user-agent</return>, <return>content-length</return>, <return>content-type</return>,
                                    <return>cookie</return>, <return>authorization</return> и <return>proxy-authorization</return>
  <info></info>             <strong>$features</strong>            Битовая маска для включения одной или нескольких следующих
                                    функций: <info>SOAP_SINGLE_ELEMENT_ARRAYS</info> При декодировании ответа в
                                    массив по умолчанию определяется, появляется ли имя элемента
                                    один или несколько раз в определённом родительском элементе. Для
                                    элементов, которые появляются только один раз, свойство объекта
                                    позволяет получить прямой доступ к содержимому; для элементов,
                                    которые появляются более одного раза, свойство содержит массив с
                                    содержимым каждого соответствующего элемента.  Если включена
                                    функция <info>SOAP_SINGLE_ELEMENT_ARRAYS</info>, элементы, которые появляются
                                    только один раз, помещаются в одноэлементный массив, чтобы
                                    доступ был последовательным для всех элементов. Это будет
                                    работать только при использовании WSDL, содержащего схему для
                                    ответа. Для демонстрации смотрите раздел с примерами.
                                    <info>SOAP_USE_XSI_ARRAY_TYPE</info> Если параметру <return>use</return> или свойству WSDL
                                    передано значение <return>encoded</return>, массивы принудительно используют тип
                                    <return>SOAP-ENC:Array</return>, а не специфический для схемы.
                                    <info>SOAP_WAIT_ONE_WAY_CALLS</info> Ожидание ответа, даже если WSDL
                                    указывает на односторонний запрос.
                                    
                                    При декодировании ответа в массив по умолчанию определяется,
                                    появляется ли имя элемента один или несколько раз в определённом
                                    родительском элементе. Для элементов, которые появляются только
                                    один раз, свойство объекта позволяет получить прямой доступ к
                                    содержимому; для элементов, которые появляются более одного
                                    раза, свойство содержит массив с содержимым каждого
                                    соответствующего элемента.
                                    
                                    Если включена функция <info>SOAP_SINGLE_ELEMENT_ARRAYS</info>, элементы,
                                    которые появляются только один раз, помещаются в одноэлементный
                                    массив, чтобы доступ был последовательным для всех элементов.
                                    Это будет работать только при использовании WSDL, содержащего
                                    схему для ответа. Для демонстрации смотрите раздел с примерами.
                                    
                                    Если параметру <return>use</return> или свойству WSDL передано значение <return>encoded</return>,
                                    массивы принудительно используют тип <return>SOAP-ENC:Array</return>, а не
                                    специфический для схемы.
                                    
                                    Ожидание ответа, даже если WSDL указывает на односторонний
                                    запрос.
  <info></info>             <strong>$keep_alive</strong>          Логическое значение, определяющее, следует ли отправлять
                                    заголовок <return>Connection: Keep-Alive</return> или <return>Connection: close</return>.
                                    
                                    По умолчанию <info>true</info>
  <info></info>             <strong>$ssl_method</strong>          Определяет версию протокола SSL или TLS для использования в
                                    защищённых HTTP-соединениях вместо согласования по умолчанию.
                                    Указание <info>SOAP_SSL_METHOD_SSLv2</info> или <info>SOAP_SSL_METHOD_SSLv3</info>
                                    заставит использовать SSL 2 или SSL 3, соответственно. Указание
                                    константы <info>SOAP_SSL_METHOD_SSLv23</info> не имеет никакого смысла;
                                    константа существует только для обратной совместимости. Начиная
                                    с PHP 7.2, указание константы <info>SOAP_SSL_METHOD_TLS</info> также не имеет
                                    никакого смысла; в более ранних версиях константа определяла
                                    принудительное использование TLS 1.0.
                                    
                                    Обратите внимание, что SSL версий 2 и 3 считаются небезопасными
                                    и могут не поддерживаться установленной библиотекой OpenSSL.
                                    
                                    Параметр объявлен УСТАРЕВШИМ, начиная с PHP 8.1.0. Более гибкой
                                    альтернативой, позволяющей указывать отдельные версии TLS, можно
                                    использовать параметр <strong>$stream_context</strong> с параметром контекста
                                    'crypto_method'. Указание использования только TLS 1.3 [
                                    'crypto_method' => STREAM_CRYPTO_METHOD_TLSv1_3_CLIENT ]
                                    ]);
                                    $client = new SoapClient("some.wsdl", ['context' => $context]);
                                    ]]>


id: SoapClient::__doRequest
type: function
doc:
<comment>Description:</comment>
  Выполняет SOAP-запрос
  
  Выполняет SOAP-запрос поверх HTTP.
  
  Этот метод может быть переопределён в подклассах для реализации других транспортных уровней,
  выполнения дополнительной обработки XML или других целей.

<comment>Param:</comment>
  <info>string</info>  <strong>$request</strong>   Запрос XML SOAP.
  <info>string</info>  <strong>$location</strong>  URL для запроса.
  <info>string</info>  <strong>$action</strong>    Действие SOAP.
  <info>int</info>     <strong>$version</strong>   Версия SOAP.
  <info>bool</info>    <strong>$oneWay</strong>    Если <strong>$oneWay</strong> равен <info>true</info>, метод ничего не возвращает. Этот параметр
                     используется, когда не ожидается ответа.

<comment>Return:</comment>
  <info>string|null</info>  Ответ XML SOAP.


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

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


id: SoapClient::__getFunctions
type: function
doc:
<comment>Description:</comment>
  Возвращает список доступных SOAP-функций
  
  Возвращает массив функций, описанных в WSDL для веб-службы.
  
  Эта функция работает только в режиме WSDL.

<comment>Return:</comment>
  <info>array|null</info>  Массив (<info>array</info>) прототипов функций SOAP c описанием типа возвращаемого значения, имени
              функции и типов параметров.

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


id: SoapClient::__getLastRequest
type: function
doc:
<comment>Description:</comment>
  Возвращает последний SOAP-запрос
  
  Возвращает XML, переданный в последнем SOAP-запросе.
  
  Метод работает только для объекта <class>SoapClient</class>, созданного с настройкой <return>trace</return>, равной <info>true</info>.

<comment>Return:</comment>
  <info>string|null</info>  Последний SOAP-запрос в виде строки с XML.

<comment>See Also:</comment>
   * SoapClient::__getLastRequestHeaders
   * SoapClient::__getLastResponse
   * SoapClient::__getLastResponseHeaders


id: SoapClient::__getLastRequestHeaders
type: function
doc:
<comment>Description:</comment>
  Возвращает SOAP-заголовки последнего запроса
  
  Возвращает SOAP-заголовки последнего запроса.
  
  Функция работает только, если объект <class>SoapClient</class> был создан с настройкой <return>trace</return>, равной <info>true</info>.

<comment>Return:</comment>
  <info>string|null</info>  Заголовки последнего SOAP-запроса.

<comment>See Also:</comment>
   * SoapClient::__getLastResponseHeaders
   * SoapClient::__getLastRequest
   * SoapClient::__getLastResponse


id: SoapClient::__getLastResponse
type: function
doc:
<comment>Description:</comment>
  Возвращает последний SOAP-ответ
  
  Возвращает XML, полученный в последнем SOAP-ответе.
  
  Метод работает только для объекта <class>SoapClient</class>, созданного с настройкой <return>trace</return>, равной <info>true</info>.

<comment>Return:</comment>
  <info>string|null</info>  Последний SOAP-ответ в виде строки с XML.

<comment>See Also:</comment>
   * SoapClient::__getLastResponseHeaders
   * SoapClient::__getLastRequest
   * SoapClient::__getLastRequestHeaders


id: SoapClient::__getLastResponseHeaders
type: function
doc:
<comment>Description:</comment>
  Возвращает SOAP-заголовки последнего ответа
  
  Возвращает SOAP-заголовки последнего ответа.
  
  Функция работает только, если объект <class>SoapClient</class> был создан с настройкой <return>trace</return>, равной <info>true</info>.

<comment>Return:</comment>
  <info>string|null</info>  Заголовки последнего SOAP-ответа.

<comment>See Also:</comment>
   * SoapClient::__getLastRequestHeaders
   * SoapClient::__getLastRequest
   * SoapClient::__getLastResponse


id: SoapClient::__getTypes
type: function
doc:
<comment>Description:</comment>
  Возвращает список SOAP-типов
  
  Возвращает массив типов, описанных в WSDL для веб-службы.
  
  Эта функция работает только в режиме WSDL.

<comment>Return:</comment>
  <info>array|null</info>  Массив (<info>array</info>) SOAP-типов с подробным описанием всех структур и типов.

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


id: SoapClient::__setCookie
type: function
doc:
<comment>Description:</comment>
  Устанавливает cookie для запросов SOAP
  
  Определяет cookie, которые будут отправлены с SOAP-запросами.
  
  Вызов этого метода повлияет на все последующие вызовы методов <class>SoapClient</class>.

<comment>Param:</comment>
  <info>string</info>       <strong>$name</strong>   Имя cookie.
  <info>string|null</info>  <strong>$value</strong>  Значение cookie. Если не указано, то cookie будет удалён.

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


id: SoapClient::__setLocation
type: function
doc:
<comment>Description:</comment>
  Устанавливает адрес используемой веб-службы
  
  Устанавливает URL конечной точки, затрагивающий последующие SOAP-запросы. Эквивалентна настройке
  <return>location</return>, указываемой в конструкторе SoapClient.
  
  Вызов метода необязателен. По умолчанию SoapClient использует адрес из WSDL-файла.

<comment>Param:</comment>
  <info>string|null</info>  <strong>$location</strong>  Новый URL конечной точки.

<comment>Return:</comment>
  <info>string|null</info>  Старый URL конечной точки.

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


id: SoapClient::__setSoapHeaders
type: function
doc:
<comment>Description:</comment>
  Устанавливает SOAP-заголовки для последующих вызовов
  
  Определяет заголовки для отправки вместе с SOAP-запросами.
  
  Вызов этого метода заменит любые предыдущие значения.

<comment>Param:</comment>
  <info>SoapHeader|array|null</info>  <strong>$headers</strong>  Устанавливаемые заголовки. Это может быть объект <class>SoapHeader</class> или
                                   массив объектов <class>SoapHeader</class>. Если не указано или равно <info>null</info>,
                                   заголовки будут удалены.

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


id: SoapClient::__soapCall
type: function
doc:
<comment>Description:</comment>
  Вызывает SOAP-функцию
  
  Это низкоуровневая функция API, которая позволяет сделать SOAP-вызов. Обычно в режиме WSDL функции
  SOAP вызываются как методы объекта <class>SoapClient</class>. Этот метод полезен в режиме, отличном от WSDL,
  когда <return>soapaction</return> неизвестен, <return>uri</return> отличается от URI по умолчанию или при отправке и/или получении
  SOAP-заголовков.
  
  В случае возникновения ошибки вызов SOAP-функции может привести к исключению или к возврату
  объекта <class>SoapFault</class>, если исключения отключены. Чтобы проверить, что вызов функции завершился
  неудачей, поймав исключение SoapFault, проверьте результат с помощью <strong>is_soap_fault()</strong>.

<comment>Param:</comment>
  <info>string</info>                 <strong>$name</strong>           Имя вызываемой SOAP-функции.
  <info>array</info>                  <strong>$args</strong>           Массив аргументов, передаваемых в функцию. Это может быть
                                         упорядоченный или ассоциативный массив. Обратите внимание,
                                         что большинство SOAP-серверов требуют предоставлять имена
                                         параметров, и в этом случае это должен быть ассоциативный
                                         массив.
  <info>array|null</info>             <strong>$options</strong>        Ассоциативный массив настроек, передаваемых клиенту.
                                         
                                         Настройка <return>location</return> - URL удалённой веб-службы.
                                         
                                         Настройка <return>uri</return> - целевое пространство имён SOAP-службы.
                                         
                                         Настройка <return>soapaction</return> - действие для вызова.
  <info>SoapHeader|array|null</info>  <strong>$inputHeaders</strong>   Массив заголовков, отправляемых вместе с SOAP-запросом.
  <info>array</info>                  <strong>$outputHeaders</strong>  Если указан, то этот массив будет заполнен заголовками из
                                         SOAP-ответа.

<comment>Return:</comment>
  <info>mixed</info>  Функции SOAP могут возвращать одно или несколько значений. Если функция SOAP возвращает
         только одно значение, то возвращаемое значение будет скаляром. Если возвращается несколько
         значений, то вместо них возвращается ассоциативный массив именованных выходных параметров.
         
         В случае возникновения ошибки, если объект <class>SoapClient</class> был объявлен с опцией <return>exceptions</return> со
         значением <info>false</info>, будет возвращён объект <class>SoapFault</class>.

<comment>See Also:</comment>
   * SoapClient::__construct
   * SoapParam::__construct
   * SoapVar::__construct
   * SoapHeader::__construct
   * SoapFault::__construct
   * <strong>is_soap_fault()</strong>


id: SoapFault::__construct
type: function
doc:
<comment>Description:</comment>
  Конструктор SoapFault
  
  Этот класс служит для отправки ответа на ошибку SOAP из обработчика PHP. <strong>$faultcode</strong>, <strong>$faultstring</strong>,
  <strong>$faultactor</strong> и <strong>$detail</strong> являются стандартными элементами ошибки SOAP.

<comment>Param:</comment>
  <info></info>  <strong>$faultcode</strong>    Код ошибки <class>SoapFault</class>.
  <info></info>  <strong>$faultstring</strong>  Сообщение об ошибке <class>SoapFault</class>.
  <info></info>  <strong>$faultactor</strong>   Строка идентифицирующая отправителя, вызвавшего ошибку.
  <info></info>  <strong>$detail</strong>       Детальная информация о причинах ошибки.
  <info></info>  <strong>$faultname</strong>    Может быть использовано для выбора корректной кодировки ошибки из WSDL.
  <info></info>  <strong>$headerfault</strong>  Может быть использовано во время обработки заголовка SOAP для сообщения об ошибке
                  в заголовке ответа.

<comment>See Also:</comment>
   * SoapServer::fault
   * <strong>is_soap_fault()</strong>


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

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


id: SoapHeader::__construct
type: function
doc:
<comment>Description:</comment>
  Конструктор SoapHeader
  
  Создаёт новый объект SoapHeader.

<comment>Param:</comment>
  <info>string</info>  <strong>$namespace</strong>       Пространство имён для элемента заголовка SOAP.
  <info>string</info>  <strong>$name</strong>            Имя объекта SoapHeader.
  <info>mixed</info>   <strong>$data</strong>            Содержимое заголовка SOAP. Может быть как значением PHP, так и объектом
                           <class>SoapVar</class>.
  <info></info>        <strong>$mustUnderstand</strong>  Значение атрибута <return>mustUnderstand</return> элемента заголовка SOAP.
  <info>string</info>  <strong>$actor</strong>           Значение атрибута <return>actor</return> элемента заголовка SOAP.

<comment>See Also:</comment>
   * SoapClient::__soapCall
   * SoapVar::SoapVar
   * SoapParam::SoapParam
   * SoapServer::addSoapHeader


id: SoapParam::__construct
type: function
doc:
<comment>Description:</comment>
  Конструктор SoapParam
  
  Создаёт новый объект <class>SoapParam</class>.

<comment>Param:</comment>
  <info>mixed</info>   <strong>$data</strong>  Данные для передачи или возврата. Этот параметр может передаваться непосредственно
                 как значение PHP, но в этом случае он будет называться <return>paramN</return>, и служба SOAP может
                 его не понять.
  <info>string</info>  <strong>$name</strong>  Имя параметра.

<comment>See Also:</comment>
   * SoapClient::__soapCall
   * SoapVar::SoapVar


id: SoapServer
type: class
doc:
<comment>Description:</comment>
  Класс SoapServer представляет собой сервер для протоколов SOAP 1.1 и SOAP 1.2. Его можно
  использовать с описанием службы WSDL или без него.


id: SoapServer::__construct
type: function
doc:
<comment>Description:</comment>
  Конструктор SoapServer
  
  Данный конструктор позволяет создавать объекты <class>SoapServer</class> в WSDL или не-WSDL режимах.

<comment>Param:</comment>
  <info>string|null</info>  <strong>$wsdl</strong>     Для использования SoapServer в режиме WSDL, укажите URI WSDL-файла. В
                         противном случае укажите <info>null</info> и установите опцию <return>uri</return> равной пространству
                         имён сервера.
  <info>array</info>        <strong>$options</strong>  Попытка установить версию SOAP по умолчанию (<return>soap_version</return>), внутреннюю
                         кодировку (<return>encoding</return>) и URI отправителя (<return>actor</return>).
                         
                         Опцию <return>classmap</return> можно использовать для сопоставления некоторых типов WSDL с
                         классами PHP. Данная опция должна быть массивом с ключами равными типам
                         WSDL и значениям равными именам классов PHP.
                         
                         Опция <return>typemap</return> является массивом сопоставления типов. Массив с ключами
                         <return>type_name</return>, <return>type_ns</return> (URI пространства имён), <return>from_xml</return> (callback-функция,
                         принимающая один строковый параметр) и <return>to_xml</return> (callback-функция,
                         принимающая один объект в качестве параметр).
                         
                         Опция <return>cache_wsdl</return> задаётся одной из констант: <info>WSDL_CACHE_NONE</info>,
                         <info>WSDL_CACHE_DISK</info>, <info>WSDL_CACHE_MEMORY</info> или <info>WSDL_CACHE_BOTH</info>.
                         
                         Также есть опция <return>features</return>, которая задаётся одной из констант:
                         <info>SOAP_WAIT_ONE_WAY_CALLS</info>, <info>SOAP_SINGLE_ELEMENT_ARRAYS</info> или
                         <info>SOAP_USE_XSI_ARRAY_TYPE</info>.
                         
                         опция <return>send_errors</return> может быть установлена в <info>false</info> для отправки общего
                         сообщения об ошибке ("Internal error") вместо специального сообщения об
                         ошибке, отправляемого в противном случае.

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


id: SoapServer::addFunction
type: function
doc:
<comment>Description:</comment>
  Добавляет одну или несколько функций для обработки запросов SOAP
  
  Экспортирует одну или несколько функций удалённому клиенту

<comment>Param:</comment>
  <info>array|string|int</info>  <strong>$functions</strong>  Для экспорта одной функции, передайте в этот параметр её имя в виде
                                строки.
                                
                                Для экспорта нескольких функций, передайте в этот параметр массив с
                                именами функций.
                                
                                Для экспорта всех функций, задайте параметр константой
                                <info>SOAP_FUNCTIONS_ALL</info>.
                                
                                Параметр <strong>$functions</strong> должен принимать все входящие аргументы в том же
                                порядке, как они определены в файле WSDL (они не должны принимать
                                никаких возвращаемых параметров в качестве аргументов) и должны
                                возвращать одно или больше значений. Для возврата нескольких
                                значений, они должны возвращать массив с именованными возвращаемыми
                                параметрами.

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

<comment>See Also:</comment>
   * SoapServer::__construct
   * SoapServer::setClass


id: SoapServer::addSoapHeader
type: function
doc:
<comment>Description:</comment>
  Добавить заголовок SOAP в ответ
  
  Добавляет заголовок SOAP в возвращаемый ответ на текущий запрос.

<comment>Param:</comment>
  <info>SoapHeader</info>  <strong>$header</strong>  Возвращаемый заголовок.

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


id: SoapServer::fault
type: function
doc:
<comment>Description:</comment>
  Вынуждает SoapServer вернуть ошибку
  
  Отправляет клиенту ответ на текущий запрос с сообщением об ошибке.
  
  Может быть вызвана только во время обработки запроса.

<comment>Param:</comment>
  <info>string</info>  <strong>$code</strong>     Код возвращаемой ошибки
  <info>string</info>  <strong>$string</strong>   Краткое описание ошибки
  <info>string</info>  <strong>$actor</strong>    Строка, идентифицирующая отправителя, вызвавшего ошибку
  <info>mixed</info>   <strong>$details</strong>  Детальная информация об ошибке
  <info>string</info>  <strong>$name</strong>     Имя ошибки. Может использоваться для выбора имени из WSDL-файла.

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

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


id: SoapServer::getFunctions
type: function
doc:
<comment>Description:</comment>
  Вернуть список определённых функций
  
  Вернуть список определённых функций в объекте SoapServer. Этот метод возвращает список всех
  функций, добавленных с помощью SoapServer::addFunction или SoapServer::setClass.

<comment>Return:</comment>
  <info>array</info>  <return>Массив</return> определённых функций.

<comment>See Also:</comment>
   * SoapServer::__construct
   * SoapServer::addFunction
   * SoapServer::setClass


id: SoapServer::handle
type: function
doc:
<comment>Description:</comment>
  Обработка SOAP-запроса
  
  Обрабатывает SOAP-запрос, вызывает необходимые функции и отправляет ответ клиенту.

<comment>Param:</comment>
  <info>string|null</info>  <strong>$request</strong>  SOAP-запрос. Если аргумент не задан, предполагается, что запрос находится в
                         необработанных POST-данных HTTP-запроса.

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

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


id: SoapServer::setClass
type: function
doc:
<comment>Description:</comment>
  Устанавливает класс, который обрабатывает SOAP-запросы
  
  Экспортирует все методы из указанного класса.
  
  Чтобы сохранить объект для каждого последующего запроса в рамках данной PHP-сессии, можно
  использовать метод SoapServer::setPersistence.

<comment>Param:</comment>
  <info>string</info>  <strong>$class</strong>  Имя экспортируемого класса.
  <info>mixed</info>   <strong>$args</strong>   Эти необязательные параметры будут переданы конструктору класса при создания
                  объекта.

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

<comment>See Also:</comment>
   * SoapServer::__construct
   * SoapServer::addFunction
   * SoapServer::setPersistence


id: SoapServer::setObject
type: function
doc:
<comment>Description:</comment>
  Устанавливает объект, который будет использоваться для обработки SOAP-запросов
  
  Устанавливает объект, который будет использоваться для обработки SOAP-запросов, а не только класс,
  как в SoapServer::setClass.

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

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

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


id: SoapServer::setPersistence
type: function
doc:
<comment>Description:</comment>
  Устанавливает режим сохранения SoapServer
  
  Эта функция позволяет изменять режим сохранения объекта SoapServer между запросами. Эта функция
  позволяет сохранять данные между запросами используя механизм сессий PHP. Этот метод влияет только
  на SoapServer после экспорта функций, используя SoapServer::setClass.
  
  Сохранение <info>SOAP_PERSISTENCE_SESSION</info> гарантирует сохранение только объектов заданного класса, но не
  статические данные класса. В этом случае используйте $this-&gt;bar вместо self::$bar.
  
  <info>SOAP_PERSISTENCE_SESSION</info> сериализует данные объекта класса и сохраняет их между запросами. Для
  корректной работы с ресурсами (например, <class>PDO</class>), следует использовать магические методы __wakeup() и
  __sleep().

<comment>Param:</comment>
  <info>int</info>  <strong>$mode</strong>  Одна из констант <return>SOAP_PERSISTENCE_XXX</return>.
              
              <info>SOAP_PERSISTENCE_REQUEST</info> - данные SoapServer не сохраняются между запросами. Это
              поведение по умолчанию любого объекта SoapServer после вызова setClass.
              
              <info>SOAP_PERSISTENCE_SESSION</info> - данные SoapServer сохраняются между запросами. Это
              достигается путём сериализации объекта SoapServer в $_SESSION['_bogus_session_name'],
              следовательно необходимо вызвать <strong>session_start()</strong> перед включением этого режима.

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

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


id: SoapVar
type: class
doc:
<comment>Description:</comment>
  Класс, представляющий переменную или объект для использования с сервисами SOAP.


id: SoapVar::__construct
type: function
doc:
<comment>Description:</comment>
  Конструктор SoapVar
  
  Создаёт новый объект <class>SoapVar</class>.

<comment>Param:</comment>
  <info>mixed</info>     <strong>$data</strong>            Данные для передачи или возврата.
  <info>int|null</info>  <strong>$encoding</strong>        Код кодировки, одна из констант <return>XSD_...</return>.
  <info></info>          <strong>$type_name</strong>       Имя типа.
  <info></info>          <strong>$type_namespace</strong>  Пространство имён типа.
  <info></info>          <strong>$node_name</strong>       Имя узла XML.
  <info></info>          <strong>$node_namespace</strong>  Пространство имён узла XML.

<comment>See Also:</comment>
   * SoapClient::__soapCall
   * SoapParam::__construct


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


id: SolrClient
type: class
doc:
<comment>Description:</comment>
  Используется для отправки запросов на сервер Solr. В настоящее время клонирование и сериализация
  экземпляров SolrClient не поддерживается.


id: SolrClient::DEFAULT_SYSTEM_SERVLET
type: constant
doc:
<comment>Description:</comment>
  Это начальное значение для системного сервлета, используемого для получения информации о сервере
  Solr.


id: SolrClient::DEFAULT_TERMS_SERVLET
type: constant
doc:
<comment>Description:</comment>
  Это начальное значение для терминов сервлет, используемых для TermsComponent


id: SolrClient::SYSTEM_SERVLET_TYPE
type: constant
doc:
<comment>Description:</comment>
  Используется при получении системной информации из системного сервлета.


id: SolrClient::__construct
type: function
doc:
<comment>Description:</comment>
  Конструктор объекта SolrClient
  
  Конструктор объекта SolrClient

<comment>Param:</comment>
  <info>array</info>  <strong>$clientOptions</strong>  Массив, содержащий один из следующих ключей:
                         
                         

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


id: SolrClient::__destruct
type: function
doc:
<comment>Description:</comment>
  Деструктор SolrClient
  
  Деструктор

<comment>Return:</comment>
  <info>unknown</info>  Деструктор SolrClient

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


id: SolrClient::addDocument
type: function
doc:
<comment>Description:</comment>
  Добавляет документ в индекс
  
  Метод добавляет документ в индекс.

<comment>Param:</comment>
  <info>SolrInputDocument</info>  <strong>$doc</strong>           Экземпляр SolrInputDocument.
  <info>bool</info>               <strong>$overwrite</strong>     Следует ли перезаписывать существующий документ или нет. Если
                                    указано <info>false</info>, будут разрешены дубликаты (несколько документов с
                                    одинаковым ID).
                                    
                                    В PECL Solr
                                    \< 2.0 $allowDups использовался вместо $overwrite, который выполняет те же функции с полностью противоположным флагом bool.
                                    
                                    $allowDups = false тоже самое, что и $overwrite = true
  <info>int</info>                <strong>$commitWithin</strong>  Количество миллисекунд для автоматической фиксации документа.
                                    Доступно, начиная с Solr 1.4. По умолчанию (0) означает
                                    отключено.
                                    
                                    Если значение указано, остаётся контроль над тем, когда делать
                                    фиксацию для самого Solr, оптимизируя количество коммитов до
                                    минимума, при этом соблюдая требования к задержке обновления, и
                                    Solr автоматически выполнит фиксацию, когда наступит самое
                                    старое добавление в буфер.

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

<comment>See Also:</comment>
   * SolrClient::addDocuments
   * SolrClient::commit


id: SolrClient::addDocuments
type: function
doc:
<comment>Description:</comment>
  Добавляет коллекцию экземпляров SolrInputDocument в индекс
  
  Добавляет коллекцию документов в индекс.

<comment>Param:</comment>
  <info>array</info>  <strong>$docs</strong>          Массив, содержащий коллекцию экземпляров SolrInputDocument. Этот массив
                        должен быть реальной переменной.
  <info>bool</info>   <strong>$overwrite</strong>     Стоит ли перезаписывать существующие документы или нет. Если указано
                        значение <info>false</info>, будут разрешены дубликаты (несколько документов с одинаковым
                        ID).
                        
                        В PECL Solr
                        \< 2.0 $allowDups использовался вместо $overwrite, который выполняет те же функции с полностью противоположным флагом bool.
                        
                        $allowDups = false тоже самое, что и $overwrite = true
  <info>int</info>    <strong>$commitWithin</strong>  Количество миллисекунд для автоматической фиксации документа. Доступно,
                        начиная с Solr 1.4. По умолчанию (0) означает отключено.
                        
                        Если значение указано, остаётся контроль над тем, когда делать фиксацию для
                        самого Solr, оптимизируя количество коммитов до минимума, при этом соблюдая
                        требования к задержке обновления, и Solr автоматически выполнит фиксацию,
                        когда наступит самое старое добавление в буфер.

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

<comment>See Also:</comment>
   * SolrClient::addDocument
   * SolrClient::commit


id: SolrClient::commit
type: function
doc:
<comment>Description:</comment>
  Завершает все добавления/удаления, сделанные в индексе
  
  Метод завершает все добавления/удаления, сделанные в индексе.

<comment>Param:</comment>
  <info>bool</info>  <strong>$softCommit</strong>      Обновляет 'view' индекса более производительно, но без гарантий 'on-disk'.
                         (Solr4.0+)
                         
                         Мягкая фиксация выполняется намного быстрее, поскольку она делает видимыми
                         только изменения индекса, а не файлы индекса fsync и не записывает новый
                         дескриптор индекса. В случае сбоя JVM или потери питания изменения,
                         произошедшие после последней жёсткой фиксации, будут потеряны. Коллекции
                         поиска, которые имеют требования к работе в режиме, близком к реальному
                         времени (которые хотят, чтобы изменения индекса были быстро видны для
                         поиска), захотят чаще выполнять мягкую фиксацию, а жёсткую фиксацию реже.
  <info>bool</info>  <strong>$waitSearcher</strong>    Блокировать до тех пор, пока не откроется новая поисковая система и не
                         будет зарегистрирована как основная поисковая система, сделав изменения
                         видимыми.
  <info>bool</info>  <strong>$expungeDeletes</strong>  Объединить сегменты с удалениями. (Solr1.4 +)

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

<comment>See Also:</comment>
   * SolrClient::optimize
   * SolrClient::rollback


id: SolrClient::deleteById
type: function
doc:
<comment>Description:</comment>
  Удаляет по идентификатору
  
  Удаляет документ с указанным идентификатором. Где ID - значение поля uniqueKey, объявленного в
  схеме.

<comment>Param:</comment>
  <info>string</info>  <strong>$id</strong>  Значение поля uniqueKey, объявленное в схеме

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

<comment>See Also:</comment>
   * SolrClient::deleteByIds
   * SolrClient::deleteByQuery
   * SolrClient::deleteByQueries


id: SolrClient::deleteByIds
type: function
doc:
<comment>Description:</comment>
  Удаляет по идентификаторам
  
  Удаляет набор документов с указанным набором идентификаторов.

<comment>Param:</comment>
  <info>array</info>  <strong>$ids</strong>  Массив идентификаторов, представляющих поле uniqueKey, объявленное в схеме для
               каждого удаляемого документа. Должна быть фактическая переменная php.

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

<comment>See Also:</comment>
   * SolrClient::deleteById
   * SolrClient::deleteByQuery
   * SolrClient::deleteByQueries


id: SolrClient::deleteByQueries
type: function
doc:
<comment>Description:</comment>
  Удаляет все документы, соответствующие любому из запросов
  
  Удаляет все документы, соответствующие любому из запросов

<comment>Param:</comment>
  <info>array</info>  <strong>$queries</strong>  Массив запросов. Это должна быть фактическая переменная php.

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

<comment>See Also:</comment>
   * SolrClient::deleteById
   * SolrClient::deleteByIds
   * SolrClient::deleteByQuery


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

<comment>Param:</comment>
  <info>string</info>  <strong>$query</strong>  Запрос

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

<comment>See Also:</comment>
   * SolrClient::deleteById
   * SolrClient::deleteByIds
   * SolrClient::deleteByQueries


id: SolrClient::getById
type: function
doc:
<comment>Description:</comment>
  Получает документ по идентификатору. Использует Solr Realtime Get (RTG)
  
  Получает документ по идентификатору. Использует Solr Realtime Get (RTG)

<comment>Param:</comment>
  <info>string</info>  <strong>$id</strong>  ID документа

<comment>Return:</comment>
  <info>SolrQueryResponse</info>  <info>SolrQueryResponse</info>

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


id: SolrClient::getByIds
type: function
doc:
<comment>Description:</comment>
  Получает документы по их идентификаторам. Использует Solr Realtime Get (RTG)
  
  Получает документы по их идентификаторам. Использует Solr Realtime Get (RTG)

<comment>Param:</comment>
  <info>array</info>  <strong>$ids</strong>  ID документов

<comment>Return:</comment>
  <info>SolrQueryResponse</info>  <info>SolrQueryResponse</info>

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


id: SolrClient::getDebug
type: function
doc:
<comment>Description:</comment>
  Возвращает данные отладки для последней попытки подключения
  
  Возвращает данные отладки для последней попытки подключения

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


id: SolrClient::getOptions
type: function
doc:
<comment>Description:</comment>
  Возвращает внутренние параметры клиента
  
  Возвращает внутренние параметры клиента. Очень полезно для отладки. Возвращаемые значения доступны
  только для чтения и могут быть установлены только при создании экземпляра объекта.

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

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


id: SolrClient::optimize
type: function
doc:
<comment>Description:</comment>
  Дефрагментирует индекс
  
  Дефрагментирует индекс для ускорения поиска.

<comment>Param:</comment>
  <info>int</info>   <strong>$maxSegments</strong>   Оптимизируется до максимального количества сегментов. Начиная с Solr 1.3
  <info>bool</info>  <strong>$softCommit</strong>    Обновляет 'view' индекса более производительно, но без гарантий 'on-disk'.
                       (Solr4.0+)
  <info>bool</info>  <strong>$waitSearcher</strong>  Блокировать до тех пор, пока не откроется новая поисковая система и не будет
                       зарегистрирована как основная поисковая система, сделав изменения видимыми.

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

<comment>See Also:</comment>
   * SolrClient::commit
   * SolrClient::rollback


id: SolrClient::ping
type: function
doc:
<comment>Description:</comment>
  Проверяет, работает ли сервер Solr
  
  Проверяет, доступен ли ещё сервер Solr. Отправляет запрос HEAD на сервер Apache Solr.

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


id: SolrClient::query
type: function
doc:
<comment>Description:</comment>
  Отправляет запрос на сервер
  
  Отправляет запрос на сервер.

<comment>Param:</comment>
  <info>SolrParams</info>  <strong>$query</strong>  Объект <info>SolrParams</info>. Для сложных запросов рекомендуется использовать <info>SolrQuery</info>.

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


id: SolrClient::request
type: function
doc:
<comment>Description:</comment>
  Отправляет необработанный запрос на обновление
  
  Отправляет на сервер необработанный запрос на обновление XML

<comment>Param:</comment>
  <info>string</info>  <strong>$raw_request</strong>  Строка XML с необработанным запросом к серверу.

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


id: SolrClient::rollback
type: function
doc:
<comment>Description:</comment>
  Откатывает все добавления/удаления, сделанные в индекс с момента последней фиксации
  
  Откатывает все добавления/удаления, сделанные в индекс с момента последней фиксации. Он не
  вызывает никаких прослушивателей событий и не создаёт нового поисковика.

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

<comment>See Also:</comment>
   * SolrClient::commit
   * SolrClient::optimize


id: SolrClient::setResponseWriter
type: function
doc:
<comment>Description:</comment>
  Устанавливает писатель ответа, используемый для подготовки ответа от Solr
  
  Устанавливает писатель ответа, используемый для подготовки ответа от Solr

<comment>Param:</comment>
  <info>string</info>  <strong>$responseWriter</strong>  Одно из следующих значений:

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


id: SolrClient::setServlet
type: function
doc:
<comment>Description:</comment>
  Изменяет указанный тип сервлета на новое значение
  
  Изменяет указанный тип сервлета на новое значение

<comment>Param:</comment>
  <info>int</info>     <strong>$type</strong>   Одно из следующих значений:
                  
                  
  <info>string</info>  <strong>$value</strong>  Новое значение для сервлета

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


id: SolrClient::system
type: function
doc:
<comment>Description:</comment>
  Получает информацию о сервере Solr
  
  Получает информацию о сервере Solr

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


id: SolrClient::threads
type: function
doc:
<comment>Description:</comment>
  Проверяет статус тем
  
  Проверяет статус тем

<comment>Return:</comment>
  <info>void</info>  Возвращает объект SolrGenericResponse.


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


id: SolrClientException::getInternalInfo
type: function
doc:
<comment>Description:</comment>
  Возвращает внутреннюю информацию о том, где было выброшено исключение
  
  Возвращает внутреннюю информацию о том, где было выброшено исключение.

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


id: SolrCollapseFunction::__construct
type: function
doc:
<comment>Description:</comment>
  Конструктор класса
  
  Конструктор класса Collapse Function

<comment>Param:</comment>
  <info>string</info>  <strong>$field</strong>  Имя поля для свёртывания.
                  
                  Чтобы свернуть результат. Тип поля должен быть однозначным: строка, целое число
                  или число с плавающей точкой.

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


id: SolrCollapseFunction::__toString
type: function
doc:
<comment>Description:</comment>
  Возвращает строку, представляющую построенную функцию свёртывания
  
  Возвращает строку, представляющую построенную функцию свёртывания

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


id: SolrCollapseFunction::getField
type: function
doc:
<comment>Description:</comment>
  Возвращает свёрнутое поле
  
  Возвращает свёрнутое поле.

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

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


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

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

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


id: SolrCollapseFunction::getMax
type: function
doc:
<comment>Description:</comment>
  Возвращает максимальное значение
  
  Возвращает максимальное значение числового поля или запроса функции.

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

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


id: SolrCollapseFunction::getMin
type: function
doc:
<comment>Description:</comment>
  Возвращает минимальное значение
  
  Возвращает минимальное значение числового поля или запроса функции.

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

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


id: SolrCollapseFunction::getNullPolicy
type: function
doc:
<comment>Description:</comment>
  Возвращает NULL-политику
  
  Возвращает используемую NULL-политику или null

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

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


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

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

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


id: SolrCollapseFunction::setField
type: function
doc:
<comment>Description:</comment>
  Устанавливает поле для свёртывания
  
  Имя поля для свёртывания.
   Чтобы свернуть результат. Тип поля должен быть однозначным: строка, целое число или число с
  плавающей точкой.

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

<comment>Return:</comment>
  <info>SolrCollapseFunction</info>  <info>SolrCollapseFunction</info>


id: SolrCollapseFunction::setHint
type: function
doc:
<comment>Description:</comment>
  Устанавливает подсказку сворачивания
  
  Устанавливает подсказку сворачивания

<comment>Param:</comment>
  <info>string</info>  <strong>$hint</strong>  В настоящее время доступна только одна подсказка "top_fc", обозначающая FieldCache
                 верхнего уровня.

<comment>Return:</comment>
  <info>SolrCollapseFunction</info>  <info>SolrCollapseFunction</info>


id: SolrCollapseFunction::setMax
type: function
doc:
<comment>Description:</comment>
  Выбирает заголовки группы по максимальному значению числового поля или запроса функции
  
  Выбирает заголовки группы по максимальному значению числового поля или запроса функции.

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

<comment>Return:</comment>
  <info>SolrCollapseFunction</info>  <info>SolrCollapseFunction</info>


id: SolrCollapseFunction::setMin
type: function
doc:
<comment>Description:</comment>
  Устанавливает начальный размер сворачиваемых структур данных только при сворачивании по числовому
  полю
  
  Устанавливает начальный размер сворачиваемых структур данных только при сворачивании по числовому
  полю

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

<comment>Return:</comment>
  <info>SolrCollapseFunction</info>  <info>SolrCollapseFunction</info>


id: SolrCollapseFunction::setNullPolicy
type: function
doc:
<comment>Description:</comment>
  Устанавливает NULL-политику
  
  Устанавливает NULL-политику. Должна быть передана одна из 3 политик, определённых как константы
  класса. Принимает политики ignore (игнорирования), expand (развёртывания) или collapse
  (свёртывания).

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

<comment>Return:</comment>
  <info>SolrCollapseFunction</info>  <info>SolrCollapseFunction</info>


id: SolrCollapseFunction::setSize
type: function
doc:
<comment>Description:</comment>
  Устанавливает начальный размер сворачиваемых структур данных только при сворачивании по числовому
  полю
  
  Устанавливает начальный размер сворачиваемых структур данных только при сворачивании по числовому
  полю

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

<comment>Return:</comment>
  <info>SolrCollapseFunction</info>  <info>SolrCollapseFunction</info>


id: SolrDisMaxQuery::FACET_SORT_COUNT
type: constant
doc:
<comment>Description:</comment>
  Используется для указания сортировки фасета по количеству (дублируется для упрощения миграции)


id: SolrDisMaxQuery::FACET_SORT_INDEX
type: constant
doc:
<comment>Description:</comment>
  Используется для указания сортировки фасета по индексу (дублируется для упрощения миграции)


id: SolrDisMaxQuery::ORDER_ASC
type: constant
doc:
<comment>Description:</comment>
  Используется для указания того, что сортировка должна быть в возрастающем порядке (дублировать для
  упрощения миграции)


id: SolrDisMaxQuery::ORDER_DESC
type: constant
doc:
<comment>Description:</comment>
  Используется для указания, что сортировка должна быть в порядке убывания (дублируется для
  упрощения миграции)


id: SolrDisMaxQuery::TERMS_SORT_COUNT
type: constant
doc:
<comment>Description:</comment>
  Используется в TermsComponent (дублируется для упрощения миграции)


id: SolrDisMaxQuery::__construct
type: function
doc:
<comment>Description:</comment>
  Конструктор класса
  
  Конструктор класса инициализирует объект и устанавливает параметр q, если он указан

<comment>Param:</comment>
  <info>string</info>  <strong>$q</strong>  Поисковый запрос (параметр q)


id: SolrDisMaxQuery::addBigramPhraseField
type: function
doc:
<comment>Description:</comment>
  Добавляет поле фразовой биграммы (параметр pf2)
  
  Добавляет поле фразовой биграммы (параметр pf2) Выходной формат: field~slop^boost ИЛИ field^boost
  Slop не является обязательным

<comment>Param:</comment>
  <info>string</info>  <strong>$field</strong>  
  <info>string</info>  <strong>$boost</strong>  
  <info>string</info>  <strong>$slop</strong>   

<comment>Return:</comment>
  <info>SolrDisMaxQuery</info>  <info>SolrDisMaxQuery</info>

<comment>See Also:</comment>
   * SolrDisMaxQuery::removeBigramPhraseField
   * SolrDisMaxQuery::setBigramPhraseFields
   * SolrDisMaxQuery::setBigramPhraseSlop


id: SolrDisMaxQuery::addBoostQuery
type: function
doc:
<comment>Description:</comment>
  Добавляет поле повышения запроса со значением и необязательным усилением (параметр bq)
  
  Добавляет поле повышения запроса со значением [и повышение] (параметр bq)

<comment>Param:</comment>
  <info>string</info>  <strong>$field</strong>  
  <info>string</info>  <strong>$value</strong>  
  <info>string</info>  <strong>$boost</strong>  

<comment>Return:</comment>
  <info>SolrDisMaxQuery</info>  <info>SolrDisMaxQuery</info>

<comment>See Also:</comment>
   * SolrDisMaxQuery::removeBoostQuery
   * SolrDisMaxQuery::setBoostQuery


id: SolrDisMaxQuery::addPhraseField
type: function
doc:
<comment>Description:</comment>
  Добавляет поле фразы (параметр pf)
  
  Добавляет поле фразы (параметр pf)

<comment>Param:</comment>
  <info>string</info>  <strong>$field</strong>  field name
  <info>string</info>  <strong>$boost</strong>  
  <info>string</info>  <strong>$slop</strong>   

<comment>Return:</comment>
  <info>SolrDisMaxQuery</info>  <info>SolrDisMaxQuery</info>

<comment>See Also:</comment>
   * SolrDisMaxQuery::removePhraseField
   * SolrDisMaxQuery::setPhraseFields


id: SolrDisMaxQuery::addQueryField
type: function
doc:
<comment>Description:</comment>
  Добавляет поле запроса с необязательным повышением (параметр qf)
  
  Добавляет поле запроса с необязательным повышением

<comment>Param:</comment>
  <info>string</info>  <strong>$field</strong>  Имя поля
  <info>string</info>  <strong>$boost</strong>  Повышение значения. Добавляет документы с соответствующими выражениями.

<comment>Return:</comment>
  <info>SolrDisMaxQuery</info>  <info>SolrDisMaxQuery</info>

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


id: SolrDisMaxQuery::addTrigramPhraseField
type: function
doc:
<comment>Description:</comment>
  Добавляет поле триграммы (параметр pf3)
  
  Добавляет поле триграммы (параметр pf3)

<comment>Param:</comment>
  <info>string</info>  <strong>$field</strong>  Имя поля
  <info>string</info>  <strong>$boost</strong>  Поле Boost
  <info>string</info>  <strong>$slop</strong>   Поле Slop

<comment>Return:</comment>
  <info>SolrDisMaxQuery</info>  <info>SolrDisMaxQuery</info>

<comment>See Also:</comment>
   * SolrDisMaxQuery::removeTrigramPhraseField
   * SolrDisMaxQuery::setTrigramPhraseFields
   * SolrDisMaxQuery::setTrigramPhraseSlop


id: SolrDisMaxQuery::addUserField
type: function
doc:
<comment>Description:</comment>
  Добавляет поле в параметр пользовательских полей (uf)
  
  Добавляет поле в параметр пользовательских полей (uf)

<comment>Param:</comment>
  <info>string</info>  <strong>$field</strong>  Имя поля

<comment>Return:</comment>
  <info>SolrDisMaxQuery</info>  <info>SolrDisMaxQuery</info>

<comment>See Also:</comment>
   * SolrDisMaxQuery::removeUserField
   * SolrDisMaxQuery::setUserFields


id: SolrDisMaxQuery::removeBigramPhraseField
type: function
doc:
<comment>Description:</comment>
  Удаляет поле биграммы фразы (параметр pf2)
  
  Удаляет поле фразы биграммы (параметр pf2), которое было ранее добавлено с помощью
  SolrDisMaxQuery::addBigramPhraseField

<comment>Param:</comment>
  <info>string</info>  <strong>$field</strong>  Имя поля

<comment>Return:</comment>
  <info>SolrDisMaxQuery</info>  <info>SolrDisMaxQuery</info>

<comment>See Also:</comment>
   * SolrDisMaxQuery::addBigramPhraseField
   * SolrDisMaxQuery::setBigramPhraseFields
   * SolrDisMaxQuery::setBigramPhraseSlop


id: SolrDisMaxQuery::removeBoostQuery
type: function
doc:
<comment>Description:</comment>
  Удаляет частичное повышение запроса по имени поля (bq)
  
  Удаляет частичный запрос повышения из существующего запроса, только если было выполнено
  SolrDisMaxQuery::addBoostQuery.

<comment>Param:</comment>
  <info>string</info>  <strong>$field</strong>  Имя поля

<comment>Return:</comment>
  <info>SolrDisMaxQuery</info>  <info>SolrDisMaxQuery</info>

<comment>See Also:</comment>
   * SolrDisMaxQuery::addBoostQuery
   * SolrDisMaxQuery::setBoostQuery


id: SolrDisMaxQuery::removePhraseField
type: function
doc:
<comment>Description:</comment>
  Удаляет поле фразы (параметра)
  
  Удаляет поле фразы (параметра), которое было ранее добавлено с помощью
  SolrDisMaxQuery::addPhraseField

<comment>Param:</comment>
  <info>string</info>  <strong>$field</strong>  Имя поля

<comment>Return:</comment>
  <info>SolrDisMaxQuery</info>  <info>SolrDisMaxQuery</info>

<comment>See Also:</comment>
   * SolrDisMaxQuery::addPhraseField
   * SolrDisMaxQuery::setPhraseFields


id: SolrDisMaxQuery::removeQueryField
type: function
doc:
<comment>Description:</comment>
  Удаляет поле запроса (параметр qf)
  
  Удаляет поле запроса (параметр qf) из списка полей, добавленных с помощью
  SolrDisMaxQuery::addQueryField
  
  qf: При создании DisjunctionMaxQueries из пользовательского запроса он указывает поля для поиска и
  увеличивает их количество.

<comment>Param:</comment>
  <info>string</info>  <strong>$field</strong>  Имя поля

<comment>Return:</comment>
  <info>SolrDisMaxQuery</info>  <info>SolrDisMaxQuery</info>

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


id: SolrDisMaxQuery::removeTrigramPhraseField
type: function
doc:
<comment>Description:</comment>
  Удаляет поле триграммы (параметр pf3)
  
  Удаляет поле триграммы (параметр pf3)

<comment>Param:</comment>
  <info>string</info>  <strong>$field</strong>  Имя поля

<comment>Return:</comment>
  <info>SolrDisMaxQuery</info>  <info>SolrDisMaxQuery</info>

<comment>See Also:</comment>
   * SolrDisMaxQuery::addTrigramPhraseField
   * SolrDisMaxQuery::setTrigramPhraseFields
   * SolrDisMaxQuery::setTrigramPhraseSlop


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

<comment>Param:</comment>
  <info>string</info>  <strong>$field</strong>  Имя поля

<comment>Return:</comment>
  <info>SolrDisMaxQuery</info>  <info>SolrDisMaxQuery</info>

<comment>See Also:</comment>
   * SolrDisMaxQuery::addUserField
   * SolrDisMaxQuery::setUserFields


id: SolrDisMaxQuery::setBigramPhraseFields
type: function
doc:
<comment>Description:</comment>
  Устанавливает поля биграммы фразы и их усиления (и отклонения) с помощью параметра pf2
  
  Устанавливает поля биграммы фразы и их усиления (и отклонения) с помощью параметра pf2.

<comment>Param:</comment>
  <info>string</info>  <strong>$fields</strong>  Усиления полей (отклонения).

<comment>Return:</comment>
  <info>SolrDisMaxQuery</info>  <info>SolrDisMaxQuery</info>

<comment>See Also:</comment>
   * SolrDisMaxQuery::setBigramPhraseSlop
   * SolrDisMaxQuery::addBigramPhraseFields
   * SolrDisMaxQuery::removeBigramPhraseField
   * SolrDisMaxQuery::setTrigramPhraseFields


id: SolrDisMaxQuery::setBigramPhraseSlop
type: function
doc:
<comment>Description:</comment>
  Устанавливает коэффициент отклонения биграммы фразы (параметр ps2)
  
  Устанавливает коэффициент отклонения биграммы фразы (параметр ps2). Коэффициент отклонения по
  умолчанию для полей биграммы фразы.

<comment>Param:</comment>
  <info>string</info>  <strong>$slop</strong>  Коэффициент отклонения.

<comment>Return:</comment>
  <info>SolrDisMaxQuery</info>  <info>SolrDisMaxQuery</info>


id: SolrDisMaxQuery::setBoostFunction
type: function
doc:
<comment>Description:</comment>
  Устанавливает функцию усиления (параметр bf)
  
  Устанавливает функцию усиления (параметр bf)
  
  Функции (с необязательными усилениями), которые будут включены в запрос пользователя, чтобы
  повлиять на оценку. Можно использовать любую функцию, изначально поддерживаемую Solr, вместе со
  значением повышения, например.:
  
  recip(rord(myfield),1,2,3)^1.5

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

<comment>Return:</comment>
  <info>SolrDisMaxQuery</info>  <info>SolrDisMaxQuery</info>


id: SolrDisMaxQuery::setBoostQuery
type: function
doc:
<comment>Description:</comment>
  Непосредственно устанавливает параметр запроса усиления (bq)
  
  Устанавливает параметр запроса усиления (bq).

<comment>Param:</comment>
  <info>string</info>  <strong>$q</strong>  Запрос.

<comment>Return:</comment>
  <info>SolrDisMaxQuery</info>  <info>SolrDisMaxQuery</info>

<comment>See Also:</comment>
   * SolrDisMaxQuery::addBoostQuery
   * SolrDisMaxQuery::removeBoostQuery


id: SolrDisMaxQuery::setMinimumMatch
type: function
doc:
<comment>Description:</comment>
  Устанавливает минимальное соответствие "Should" (mm)
  
  Устанавливает параметр минимального соответствия "Should" (mm). Если оператор запроса по умолчанию
  - AND (И), тогда mm = 100%, если оператор запроса по умолчанию (q.op) - OR (ИЛИ), то mm = 0%.

<comment>Param:</comment>
  <info>string</info>  <strong>$value</strong>  Минимальное значение соответствия/выражение.

<comment>Return:</comment>
  <info>SolrDisMaxQuery</info>  <info>SolrDisMaxQuery</info>


id: SolrDisMaxQuery::setPhraseFields
type: function
doc:
<comment>Description:</comment>
  Устанавливает поля фразы и их усиления (и отклонения) с помощью параметра pf2
  
  Устанавливает поля фразы и их усиления (и отклонения) с помощью параметра pf2.

<comment>Param:</comment>
  <info>string</info>  <strong>$fields</strong>  Поля, усиления (отклонения).

<comment>Return:</comment>
  <info>SolrDisMaxQuery</info>  <info>SolrDisMaxQuery</info>

<comment>See Also:</comment>
   * SolrDisMaxQuery::addPhraseFields
   * SolrDisMaxQuery::removePhraseField


id: SolrDisMaxQuery::setPhraseSlop
type: function
doc:
<comment>Description:</comment>
  Устанавливает коэффициент отклонения по умолчанию для запросов фраз (параметр ps)
  
  Устанавливает коэффициент отклонения по умолчанию для фразовых запросов, построенных с полями
  "pf", "pf2" and/or "pf3" (влияет на усиление). Параметр "ps".

<comment>Param:</comment>
  <info>string</info>  <strong>$slop</strong>  Коэффициент отклонения по умолчанию.

<comment>Return:</comment>
  <info>SolrDisMaxQuery</info>  <info>SolrDisMaxQuery</info>


id: SolrDisMaxQuery::setQueryAlt
type: function
doc:
<comment>Description:</comment>
  Устанавливает альтернативный запрос (параметр q.alt)
  
  Устанавливает альтернативный запрос (параметр q.alt).
  
  Когда основной параметр q не указан или пуст. Используется параметр q.alt.

<comment>Param:</comment>
  <info>string</info>  <strong>$q</strong>  Строка запроса.

<comment>Return:</comment>
  <info>SolrDisMaxQuery</info>  <info>SolrDisMaxQuery</info>


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

<comment>Param:</comment>
  <info>string</info>  <strong>$slop</strong>  Коэффициент отклонения.

<comment>Return:</comment>
  <info>SolrDisMaxQuery</info>  <info>SolrDisMaxQuery</info>


id: SolrDisMaxQuery::setTieBreaker
type: function
doc:
<comment>Description:</comment>
  Устанавливает параметр Tie Breaker (параметр tie)
  
  Устанавливает параметр Tie Breaker (параметр tie).

<comment>Param:</comment>
  <info>string</info>  <strong>$tieBreaker</strong>  Параметр tie указывает значение с плавающей точкой (которое должно быть
                       намного меньше 1) для использования в качестве разрешения конфликтов в
                       запросах DisMax.

<comment>Return:</comment>
  <info>SolrDisMaxQuery</info>  <info>SolrDisMaxQuery</info>


id: SolrDisMaxQuery::setTrigramPhraseFields
type: function
doc:
<comment>Description:</comment>
  Непосредственно устанавливает поля триграммы фразы (параметр pf3)
  
  Непосредственно устанавливает поля триграммы фразы (параметр pf3).

<comment>Param:</comment>
  <info>string</info>  <strong>$fields</strong>  Поля триграммы фразы.

<comment>Return:</comment>
  <info>SolrDisMaxQuery</info>  <info>SolrDisMaxQuery</info>

<comment>See Also:</comment>
   * SolrDisMaxQuery::addTrigramPhraseField
   * SolrDisMaxQuery::removeTrigramPhraseField
   * SolrDisMaxQuery::setTrigramPhraseSlop


id: SolrDisMaxQuery::setTrigramPhraseSlop
type: function
doc:
<comment>Description:</comment>
  Устанавливает коэффициент отклонения триграммы фразы (параметр ps3)
  
  Устанавливает коэффициент отклонения триграммы фразы (параметр ps3).

<comment>Param:</comment>
  <info>string</info>  <strong>$slop</strong>  Коэффициент отклонения.

<comment>Return:</comment>
  <info>SolrDisMaxQuery</info>  <info>SolrDisMaxQuery</info>

<comment>See Also:</comment>
   * SolrDisMaxQuery::addTrigramPhraseField
   * SolrDisMaxQuery::removeTrigramPhraseField
   * SolrDisMaxQuery::setTrigramPhraseFields


id: SolrDisMaxQuery::setUserFields
type: function
doc:
<comment>Description:</comment>
  Устанавливает параметр пользовательских полей (uf)
  
  Устанавливает параметр пользовательских полей (uf)
  
  Пользовательские поля: указывает, какие поля схемы конечный пользователь может запрашивать.

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

<comment>Return:</comment>
  <info>SolrDisMaxQuery</info>  <info>SolrDisMaxQuery</info>

<comment>See Also:</comment>
   * SolrDisMaxQuery::addUserField
   * SolrDisMaxQuery::removeUserField


id: SolrDisMaxQuery::useDisMaxQueryParser
type: function
doc:
<comment>Description:</comment>
  Переключает QueryParser на DisMax Query Parser
  
  Переключает QueryParser на DisMax Query Parser

<comment>Return:</comment>
  <info>SolrDisMaxQuery</info>  <info>SolrDisMaxQuery</info>

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


id: SolrDisMaxQuery::useEDisMaxQueryParser
type: function
doc:
<comment>Description:</comment>
  Переключает QueryParser на EDisMax
  
  Переключает QueryParser на EDisMax. По умолчанию построитель запросов использует edismax, если он
  был переключён с помощью SolrDisMaxQuery::useDisMaxQueryParser, его можно переключить обратно с
  помощью этого метода.

<comment>Return:</comment>
  <info>SolrDisMaxQuery</info>  <info>SolrDisMaxQuery</info>


id: SolrDocument::__clone
type: function
doc:
<comment>Description:</comment>
  Создаёт копию объекта SolrDocument
  
  Создаёт копию объекта SolrDocument. Не вызываться напрямую.

<comment>Return:</comment>
  <info>void</info>  Ничего.


id: SolrDocument::__get
type: function
doc:
<comment>Description:</comment>
  Доступ к полю как свойству
  
  Магический метод для доступа к полю как свойству.

<comment>Param:</comment>
  <info>string</info>  <strong>$fieldName</strong>  Название поля

<comment>Return:</comment>
  <info>SolrDocumentField</info>  Возвращает экземпляр SolrDocumentField.


id: SolrDocument::__isset
type: function
doc:
<comment>Description:</comment>
  Проверяет, существует ли поле
  
  Проверяет, существует ли поле

<comment>Param:</comment>
  <info>string</info>  <strong>$fieldName</strong>  Название поля.

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


id: SolrDocument::__set
type: function
doc:
<comment>Description:</comment>
  Добавляет ещё одно поле в документ
  
  Добавляет ещё одно поле в документ. Используется для установки полей в качестве новых свойств.

<comment>Param:</comment>
  <info>string</info>  <strong>$fieldName</strong>   Название поля.
  <info>string</info>  <strong>$fieldValue</strong>  Значение поля.

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


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

<comment>Param:</comment>
  <info>string</info>  <strong>$fieldName</strong>  Название поля.

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


id: SolrDocument::addField
type: function
doc:
<comment>Description:</comment>
  Добавляет поле в документ
  
  Метод добавляет поле к экземпляру SolrDocument.

<comment>Param:</comment>
  <info>string</info>  <strong>$fieldName</strong>   Название поля
  <info>string</info>  <strong>$fieldValue</strong>  Значение поля.

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


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

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


id: SolrDocument::current
type: function
doc:
<comment>Description:</comment>
  Получает текущее поле
  
  Получает текущее поле

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


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

<comment>Param:</comment>
  <info>string</info>  <strong>$fieldName</strong>  Название поля

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


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

<comment>Param:</comment>
  <info>string</info>  <strong>$fieldName</strong>  Название поля

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


id: SolrDocument::getChildDocuments
type: function
doc:
<comment>Description:</comment>
  Возвращает массив дочерних документов (SolrDocument)
  
  Возвращает массив дочерних документов (SolrDocument)

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

<comment>See Also:</comment>
   * SolrDocument::hasChildDocuments
   * SolrDocument::getChildDocumentsCount


id: SolrDocument::getChildDocumentsCount
type: function
doc:
<comment>Description:</comment>
  Возвращает количество дочерних документов
  
  Возвращает количество дочерних документов

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

<comment>See Also:</comment>
   * SolrDocument::hasChildDocuments
   * SolrDocument::getChildDocuments


id: SolrDocument::getField
type: function
doc:
<comment>Description:</comment>
  Получает поле по имени
  
  Получает поле по имени.

<comment>Param:</comment>
  <info>string</info>  <strong>$fieldName</strong>  Название поля.

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


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

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


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

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


id: SolrDocument::getInputDocument
type: function
doc:
<comment>Description:</comment>
  Возвращает SolrInputDocument эквивалент объекта
  
  Возвращает SolrInputDocument эквивалент объекта. Это полезно, если вы хотите повторно
  отправить/обновить документ, полученный из запроса.

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


id: SolrDocument::hasChildDocuments
type: function
doc:
<comment>Description:</comment>
  Проверяет, есть ли у документа дочерние документы
  
  Проверяет, есть ли у документа дочерние документы

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

<comment>See Also:</comment>
   * SolrDocument::getChildDocuments
   * SolrDocument::getChildDocumentsCount


id: SolrDocument::key
type: function
doc:
<comment>Description:</comment>
  Получает текущий ключ
  
  Получает текущий ключ.

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


id: SolrDocument::merge
type: function
doc:
<comment>Description:</comment>
  Сливает источник в текущий SolrDocument
  
  Сливает источник в текущий SolrDocument.

<comment>Param:</comment>
  <info>SolrDocument</info>  <strong>$sourceDoc</strong>  Исходный документ.
  <info>bool</info>          <strong>$overwrite</strong>  Если указано <info>true</info>, тогда поля с тем же именем в целевом документе будут
                            перезаписаны.

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


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

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


id: SolrDocument::offsetExists
type: function
doc:
<comment>Description:</comment>
  Проверяет, существует ли конкретное поле
  
  Проверяет, существует ли определённое поле. Используется, когда объект обрабатывается как массив.

<comment>Param:</comment>
  <info>string</info>  <strong>$fieldName</strong>  Название поля.

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


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

<comment>Param:</comment>
  <info>string</info>  <strong>$fieldName</strong>  Название поля.

<comment>Return:</comment>
  <info>SolrDocumentField</info>  Возвращает объект SolrDocumentFiel.


id: SolrDocument::offsetSet
type: function
doc:
<comment>Description:</comment>
  Добавляет поле в документ
  
  Используется, когда объект обрабатывается как массив для добавления поля в документ.

<comment>Param:</comment>
  <info>string</info>  <strong>$fieldName</strong>   Название поля.
  <info>string</info>  <strong>$fieldValue</strong>  Значение для этого поля.

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


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

<comment>Param:</comment>
  <info>string</info>  <strong>$fieldName</strong>  Название поля.

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


id: SolrDocument::reset
type: function
doc:
<comment>Description:</comment>
  Псевдоним SolrDocument::clear
  
  Псевдоним SolrDocument::clear()

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


id: SolrDocument::rewind
type: function
doc:
<comment>Description:</comment>
  Сбрасывает внутренний указатель на начало
  
  Сбрасывает внутренний указатель на начало.

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


id: SolrDocument::serialize
type: function
doc:
<comment>Description:</comment>
  Используется для пользовательской сериализации
  
  Используется для пользовательской сериализации.

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


id: SolrDocument::sort
type: function
doc:
<comment>Description:</comment>
  Сортирует поля в документе
  
  

<comment>Param:</comment>
  <info>int</info>  <strong>$sortOrderBy</strong>    Критерий сортировки.
  <info>int</info>  <strong>$sortDirection</strong>  Направление сортировки.

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


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

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


id: SolrDocument::unserialize
type: function
doc:
<comment>Description:</comment>
  Пользовательская сериализация объектов SolrDocument
  
  Пользовательская сериализация объектов SolrDocument

<comment>Param:</comment>
  <info>string</info>  <strong>$serialized</strong>  XML-представление документа.

<comment>Return:</comment>
  <info>void</info>  Ничего.


id: SolrDocument::valid
type: function
doc:
<comment>Description:</comment>
  Проверяет, является ли текущая позиция внутренне корректной
  
  Проверяет, является ли текущая позиция внутренне корректной. Используется во время операций
  foreach.

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


id: SolrDocumentField
type: class
doc:
<comment>Description:</comment>
  Представляет поле в документе Solr. Все его свойства доступны только для чтения.


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

<comment>Return:</comment>
  <info>unknown</info>  Нет.


id: SolrDocumentField::__destruct
type: function
doc:
<comment>Description:</comment>
  Деструктор
  
  Деструктор.

<comment>Return:</comment>
  <info>unknown</info>  Нет.


id: SolrException
type: class
doc:
<comment>Description:</comment>
  Базовый класс для всех исключений, выбрасываемых классами модуля Solr.


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

<comment>Return:</comment>
  <info>unknown</info>  Нет


id: SolrGenericResponse::__destruct
type: function
doc:
<comment>Description:</comment>
  Деструктор
  
  Деструктор.

<comment>Return:</comment>
  <info>unknown</info>  Нет


id: SolrIllegalArgumentException
type: class
doc:
<comment>Description:</comment>
  Выбрасывается, когда методу передаётся недопустимый или некорректный аргумент.


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

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


id: SolrIllegalOperationException
type: class
doc:
<comment>Description:</comment>
  Выбрасывает, когда с объектом выполняется недопустимая или неподдерживаемая операция.


id: SolrInputDocument
type: class
doc:
<comment>Description:</comment>
  Этот класс представляет документ Solr, который будет отправлен в индекс Solr.


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

<comment>Return:</comment>
  <info>void</info>  Создаёт новый экземпляр SolrInputDocument.


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

<comment>Return:</comment>
  <info>unknown</info>  None.


id: SolrInputDocument::__destruct
type: function
doc:
<comment>Description:</comment>
  Деструктор
  
  Деструктор

<comment>Return:</comment>
  <info>unknown</info>  Ничего.


id: SolrInputDocument::addChildDocument
type: function
doc:
<comment>Description:</comment>
  Добавляет дочерний документ для блочной индексации
  
  Добавляет дочерний документ для создания блока документов с вложенными документами.

<comment>Param:</comment>
  <info>SolrInputDocument</info>  <strong>$child</strong>  Объект <info>SolrInputDocument</info>.

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

<comment>See Also:</comment>
   * SolrInputDocument::addChildDocuments
   * SolrInputDocument::hasChildDocuments
   * SolrInputDocument::getChildDocuments
   * SolrInputDocument::getChildDocumentsCount


id: SolrInputDocument::addChildDocuments
type: function
doc:
<comment>Description:</comment>
  Добавляет массив дочерних документов
  
  Добавляет массив дочерних документов в текущий входной документ.

<comment>Param:</comment>
  <info>array</info>  <strong>$docs</strong>  Массив (<info>array</info>) объектов <info>SolrInputDocument</info>.

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

<comment>See Also:</comment>
   * SolrInputDocument::addChildDocument
   * SolrInputDocument::hasChildDocuments
   * SolrInputDocument::getChildDocuments
   * SolrInputDocument::getChildDocumentsCount


id: SolrInputDocument::addField
type: function
doc:
<comment>Description:</comment>
  Добавляет поле в документ
  
  Для многозначных полей, если указано допустимое значение повышения, указанное значение будет
  умножено на текущее значение повышения для этого поля.

<comment>Param:</comment>
  <info>string</info>  <strong>$fieldName</strong>        Название поля
  <info>string</info>  <strong>$fieldValue</strong>       Значение поля.
  <info>float</info>   <strong>$fieldBoostValue</strong>  Индекс увеличения времени поля. Хотя он не может быть отрицательным, вы
                            всё равно можете передавать значения меньше 1.0, но они должны быть
                            больше нуля.

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


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

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


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

<comment>Param:</comment>
  <info>string</info>  <strong>$fieldName</strong>  Название поля.

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


id: SolrInputDocument::fieldExists
type: function
doc:
<comment>Description:</comment>
  Проверяет, существует ли поле
  
  Проверяет, существует ли поле

<comment>Param:</comment>
  <info>string</info>  <strong>$fieldName</strong>  Название поля.

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


id: SolrInputDocument::getBoost
type: function
doc:
<comment>Description:</comment>
  Получает текущее значение повышения для документа
  
  Получает текущее значение повышения для документа.

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


id: SolrInputDocument::getChildDocuments
type: function
doc:
<comment>Description:</comment>
  Возвращает массив дочерних документов (SolrInputDocument)
  
  Возвращает массив дочерних документов (SolrInputDocument)

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

<comment>See Also:</comment>
   * SolrInputDocument::addChildDocument
   * SolrInputDocument::addChildDocuments
   * SolrInputDocument::hasChildDocuments
   * SolrInputDocument::getChildDocumentsCount


id: SolrInputDocument::getChildDocumentsCount
type: function
doc:
<comment>Description:</comment>
  Возвращает количество дочерних документов
  
  Возвращает количество дочерних документов

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

<comment>See Also:</comment>
   * SolrInputDocument::addChildDocument
   * SolrInputDocument::addChildDocuments
   * SolrInputDocument::hasChildDocuments
   * SolrInputDocument::getChildDocuments


id: SolrInputDocument::getField
type: function
doc:
<comment>Description:</comment>
  Получает поле по имени
  
  Получает поле в документе.

<comment>Param:</comment>
  <info>string</info>  <strong>$fieldName</strong>  Название поля.

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


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

<comment>Param:</comment>
  <info>string</info>  <strong>$fieldName</strong>  Название поля.

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


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

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


id: SolrInputDocument::getFieldNames
type: function
doc:
<comment>Description:</comment>
  Возвращает массив, содержащий все поля в документе
  
  Возвращает массив, содержащий все поля в документе.

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


id: SolrInputDocument::hasChildDocuments
type: function
doc:
<comment>Description:</comment>
  Возвращает true, если у документа есть дочерние документы
  
  Проверяет, есть ли у документа дочерние документы

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

<comment>See Also:</comment>
   * SolrInputDocument::addChildDocument
   * SolrInputDocument::addChildDocuments
   * SolrInputDocument::getChildDocuments
   * SolrInputDocument::getChildDocumentsCount


id: SolrInputDocument::merge
type: function
doc:
<comment>Description:</comment>
  Объединяет один входной документ в другой
  
  Объединяет один входной документ в другой.

<comment>Param:</comment>
  <info>SolrInputDocument</info>  <strong>$sourceDoc</strong>  Исходный документ.
  <info>bool</info>               <strong>$overwrite</strong>  Если указано <info>true</info>, соответствующие поля в целевом документе будут
                                 перезаписаны.

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


id: SolrInputDocument::reset
type: function
doc:
<comment>Description:</comment>
  Псевдоним SolrInputDocument::clear
  
  Псевдоним SolrInputDocument::clear

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


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

<comment>Param:</comment>
  <info>float</info>  <strong>$documentBoostValue</strong>  Значение индекса времени для документа.

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


id: SolrInputDocument::setFieldBoost
type: function
doc:
<comment>Description:</comment>
  Устанавливает значение повышения индекса времени для поля
  
  Устанавливает значение индекса времени для поля. Заменяет текущее значение повышения для этого
  поля.

<comment>Param:</comment>
  <info>string</info>  <strong>$fieldName</strong>        Название поля.
  <info>float</info>   <strong>$fieldBoostValue</strong>  Индекс времени повышения значения.

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


id: SolrInputDocument::sort
type: function
doc:
<comment>Description:</comment>
  Сортирует поля в документе
  
  

<comment>Param:</comment>
  <info>int</info>  <strong>$sortOrderBy</strong>    Критерий сортировки
  <info>int</info>  <strong>$sortDirection</strong>  Направление сортировки

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


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

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


id: SolrModifiableParams
type: class
doc:
<comment>Description:</comment>
  Представляет коллекцию пар "имя-значение", отправляемую на сервер Solr во время запроса.


id: SolrModifiableParams::__destruct
type: function
doc:
<comment>Description:</comment>
  Деструктор
  
  Деструктор

<comment>Return:</comment>
  <info>unknown</info>  Нет


id: SolrObject
type: class
doc:
<comment>Description:</comment>
  Объект, свойства которого можно также получить с помощью синтаксиса массива. Все его свойства
  доступны только для чтения.


id: SolrObject::__construct
type: function
doc:
<comment>Description:</comment>
  Создаёт объект Solr
  
  Создаёт объект Solr.

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


id: SolrObject::__destruct
type: function
doc:
<comment>Description:</comment>
  Деструктор
  
  Пример использования

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


id: SolrObject::getPropertyNames
type: function
doc:
<comment>Description:</comment>
  Возвращает массив всех имён свойств
  
  Возвращает массив всех имён свойств.

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


id: SolrObject::offsetExists
type: function
doc:
<comment>Description:</comment>
  Проверяет, существует ли свойство
  
  Проверяет, существует ли свойство. Используется, когда объект обрабатывается как массив.

<comment>Param:</comment>
  <info>string</info>  <strong>$property_name</strong>  Название свойства.

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


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

<comment>Param:</comment>
  <info>string</info>  <strong>$property_name</strong>  Имя свойства.

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


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

<comment>Param:</comment>
  <info>string</info>  <strong>$property_name</strong>   Имя свойства.
  <info>string</info>  <strong>$property_value</strong>  Новое значение.

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


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

<comment>Param:</comment>
  <info>string</info>  <strong>$property_name</strong>  Имя свойства.

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


id: SolrParams::add
type: function
doc:
<comment>Description:</comment>
  Псевдоним SolrParams::addParam
  
  Псевдоним SolrParams::addParam

<comment>Param:</comment>
  <info>string</info>  <strong>$name</strong>   Имя параметра
  <info>string</info>  <strong>$value</strong>  Значение параметра

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


id: SolrParams::addParam
type: function
doc:
<comment>Description:</comment>
  Добавляет параметр к объекту
  
  Добавляет параметр к объекту. Используется для параметров, которые можно указывать несколько раз.

<comment>Param:</comment>
  <info>string</info>  <strong>$name</strong>   Имя параметра
  <info>string</info>  <strong>$value</strong>  Значение параметра

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


id: SolrParams::get
type: function
doc:
<comment>Description:</comment>
  Псевдоним SolrParams::getParam
  
  Псевдоним SolrParams::getParam

<comment>Param:</comment>
  <info>string</info>  <strong>$param_name</strong>  Имя параметра

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


id: SolrParams::getParam
type: function
doc:
<comment>Description:</comment>
  Возвращает значение параметра
  
  Возвращает значение параметра с именем param_name

<comment>Param:</comment>
  <info>string</info>  <strong>$param_name</strong>  Имя параметра

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


id: SolrParams::getParams
type: function
doc:
<comment>Description:</comment>
  Возвращает массив параметров, не в URL-закодированном виде
  
  Возвращает массив параметров, не в URL-закодированном виде

<comment>Return:</comment>
  <info>array</info>  Возвращает массив параметров, не в URL-закодированном виде


id: SolrParams::getPreparedParams
type: function
doc:
<comment>Description:</comment>
  Возвращает массив параметров в URL-закодированном виде
  
  Возвращает массив параметров в URL-закодированном виде

<comment>Return:</comment>
  <info>array</info>  Возвращает массив параметров в URL-закодированном виде


id: SolrParams::serialize
type: function
doc:
<comment>Description:</comment>
  Используется для пользовательской сериализации
  
  Используется для пользовательской сериализации

<comment>Return:</comment>
  <info>string</info>  Используется для пользовательской сериализации


id: SolrParams::set
type: function
doc:
<comment>Description:</comment>
  Псевдоним SolrParams::setParam
  
  Псевдоним SolrParams::setParam

<comment>Param:</comment>
  <info>string</info>  <strong>$name</strong>   Имя параметра
  <info>string</info>  <strong>$value</strong>  Значение параметра

<comment>Return:</comment>
  <info>void</info>  Возвращает экземпляр SolrParams в случае успешного выполнения


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

<comment>Param:</comment>
  <info>string</info>  <strong>$name</strong>   Имя параметра
  <info>string</info>  <strong>$value</strong>  Значение параметра

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


id: SolrParams::toString
type: function
doc:
<comment>Description:</comment>
  Возвращает все параметры объекта в виде пар имя-значение
  
  Возвращает все параметры объекта в виде пар имя-значение

<comment>Param:</comment>
  <info>bool</info>  <strong>$url_encode</strong>  Следует ли возвращать значения в URL-закодированном виде

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


id: SolrParams::unserialize
type: function
doc:
<comment>Description:</comment>
  Используется для пользовательской сериализации
  
  Используется для пользовательской сериализации

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

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


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

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


id: SolrPingResponse::__destruct
type: function
doc:
<comment>Description:</comment>
  Деструктор
  
  Деструктор

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


id: SolrPingResponse::getResponse
type: function
doc:
<comment>Description:</comment>
  Возвращает ответ от сервера
  
  Возвращает ответ от сервера. Он должен быть пустым, потому что является HEAD-запросом.

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


id: SolrQuery
type: class
doc:
<comment>Description:</comment>
  Представляет коллекцию пар имя-значение, отправленную на сервер Solr во время запроса.


id: SolrQuery::FACET_SORT_COUNT
type: constant
doc:
<comment>Description:</comment>
  Используется для указания того, что фасет должен сортировать по количеству


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


id: SolrQuery::ORDER_DESC
type: constant
doc:
<comment>Description:</comment>
  Используется для указания, что сортировка должна быть в порядке убывания


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

<comment>Param:</comment>
  <info>string</info>  <strong>$q</strong>  Дополнительный поисковый запрос

<comment>Return:</comment>
  <info>unknown</info>  Ничего


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

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

<comment>Return:</comment>
  <info>SolrQuery</info>  <info>SolrQuery</info>

<comment>See Also:</comment>
   * SolrQuery::setExpand
   * SolrQuery::addExpandSortField
   * SolrQuery::removeExpandSortField
   * SolrQuery::setExpandRows
   * SolrQuery::setExpandQuery
   * SolrQuery::removeExpandFilterQuery


id: SolrQuery::addExpandSortField
type: function
doc:
<comment>Description:</comment>
  Упорядочивает документы в расширенных группах (параметр expand.sort)
  
  Упорядочивает документы в расширенных группах (параметр expand.sort).

<comment>Param:</comment>
  <info>string</info>  <strong>$field</strong>  Имя поля
  <info>string</info>  <strong>$order</strong>  Порядок ASC/DESC, используя константы SolrQuery::ORDER_*.
                  
                  По умолчанию: <info>SolrQuery::ORDER_DESC</info>

<comment>Return:</comment>
  <info>SolrQuery</info>  <info>SolrQuery</info>

<comment>See Also:</comment>
   * SolrQuery::setExpand
   * SolrQuery::removeExpandSortField
   * SolrQuery::setExpandRows
   * SolrQuery::setExpandQuery
   * SolrQuery::addExpandFilterQuery
   * SolrQuery::removeExpandFilterQuery


id: SolrQuery::addFacetDateField
type: function
doc:
<comment>Description:</comment>
  Карты для facet.date
  
  Метод позволяет указать поле, которое должно рассматриваться как фасет.
  
  Может использоваться несколько раз с разными именами полей для указания нескольких полей фасетов

<comment>Param:</comment>
  <info>string</info>  <strong>$dateField</strong>  Название поля даты.

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


id: SolrQuery::addFacetDateOther
type: function
doc:
<comment>Description:</comment>
  Добавляет ещё один параметр facet.date.other
  
  Устанавливает параметр facet.date.other. Принимает необязательное переопределение поля

<comment>Param:</comment>
  <info>string</info>  <strong>$value</strong>           Значение для использования.
  <info>string</info>  <strong>$field_override</strong>  Имя поля для переопределения.

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


id: SolrQuery::addFacetField
type: function
doc:
<comment>Description:</comment>
  Добавляет другое поле к фасету
  
  Добавляет другое поле к фасету

<comment>Param:</comment>
  <info>string</info>  <strong>$field</strong>  Название поля

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


id: SolrQuery::addFacetQuery
type: function
doc:
<comment>Description:</comment>
  Добавляет фасетный запрос
  
  Добавляет фасетный запрос

<comment>Param:</comment>
  <info>string</info>  <strong>$facetQuery</strong>  Фасетный запрос

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


id: SolrQuery::addField
type: function
doc:
<comment>Description:</comment>
  Указывает, какие поля возвращать в результате
  
  Метод используется для указания набора полей для возврата, тем самым ограничивая объем данных,
  возвращаемых в ответе.
  
  Он должен вызываться несколько раз, по одному разу для каждого имени поля.

<comment>Param:</comment>
  <info>string</info>  <strong>$field</strong>  Название поля

<comment>Return:</comment>
  <info>SolrQuery</info>  Возвращает текущий объект SolrQuery


id: SolrQuery::addFilterQuery
type: function
doc:
<comment>Description:</comment>
  Определяет запрос фильтра
  
  Определяет запрос фильтра

<comment>Param:</comment>
  <info>string</info>  <strong>$fq</strong>  Фильтр запроса

<comment>Return:</comment>
  <info>SolrQuery</info>  Возвращает текущий объект SolrQuery.


id: SolrQuery::addGroupField
type: function
doc:
<comment>Description:</comment>
  Добавляет поле, которое будет использоваться для группировки результатов
  
  Имя поля, по которому группируются результаты. Поле должно быть однозначным и либо
  индексироваться, либо иметь тип поля, который имеет источник значения и работает в запросе
  функции, например, ExternalFileField. Это также должно быть строковое поле, такое как StrField или
  TextField Использует параметр group.field

<comment>Param:</comment>
  <info>string</info>  <strong>$value</strong>  Имя поля.

<comment>Return:</comment>
  <info>SolrQuery</info>  Возвращает экземпляр <class>SolrQuery</class>.

<comment>See Also:</comment>
   * SolrQuery::setGroup
   * SolrQuery::addGroupFunction
   * SolrQuery::addGroupQuery
   * SolrQuery::addGroupSortField
   * SolrQuery::setGroupFacet
   * SolrQuery::setGroupOffset
   * SolrQuery::setGroupLimit
   * SolrQuery::setGroupMain
   * SolrQuery::setGroupNGroups
   * SolrQuery::setGroupTruncate
   * SolrQuery::setGroupFormat
   * SolrQuery::setGroupCachePercent


id: SolrQuery::addGroupFunction
type: function
doc:
<comment>Description:</comment>
  Позволяет группировать результаты на основе уникальных значений запроса функции (параметр
  group.func)
  
  Добавляет функцию группировки (параметр group.func) Позволяет группировать результаты на основе
  уникальных значений запроса функции.

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

<comment>Return:</comment>
  <info>SolrQuery</info>  <info>SolrQuery</info>

<comment>See Also:</comment>
   * SolrQuery::setGroup
   * SolrQuery::addGroupField
   * SolrQuery::addGroupQuery
   * SolrQuery::addGroupSortField
   * SolrQuery::setGroupFacet
   * SolrQuery::setGroupOffset
   * SolrQuery::setGroupLimit
   * SolrQuery::setGroupMain
   * SolrQuery::setGroupNGroups
   * SolrQuery::setGroupTruncate
   * SolrQuery::setGroupFormat
   * SolrQuery::setGroupCachePercent


id: SolrQuery::addGroupQuery
type: function
doc:
<comment>Description:</comment>
  Позволяет группировать документы, соответствующие данному запросу
  
  Позволяет группировать документы, соответствующие данному запросу. Добавляет запрос в параметр
  group.query

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

<comment>Return:</comment>
  <info>SolrQuery</info>  <info>SolrQuery</info>

<comment>See Also:</comment>
   * SolrQuery::setGroup
   * SolrQuery::addGroupField
   * SolrQuery::addGroupFunction
   * SolrQuery::addGroupSortField
   * SolrQuery::setGroupFacet
   * SolrQuery::setGroupOffset
   * SolrQuery::setGroupLimit
   * SolrQuery::setGroupMain
   * SolrQuery::setGroupNGroups
   * SolrQuery::setGroupTruncate
   * SolrQuery::setGroupFormat
   * SolrQuery::setGroupCachePercent


id: SolrQuery::addGroupSortField
type: function
doc:
<comment>Description:</comment>
  Добавляет поле сортировки группы (параметр group.sort)
  
  Позволяет сортировать групповые документы, используя поле сортировки группы (параметр group.sort).

<comment>Param:</comment>
  <info>string</info>  <strong>$field</strong>  Название поля
  <info>int</info>     <strong>$order</strong>  Направление сортировки ASC/DESC, используйте константы SolrQuery::ORDER_*

<comment>Return:</comment>
  <info>SolrQuery</info>  

<comment>See Also:</comment>
   * SolrQuery::setGroup
   * SolrQuery::addGroupField
   * SolrQuery::addGroupFunction
   * SolrQuery::addGroupQuery
   * SolrQuery::setGroupFacet
   * SolrQuery::setGroupOffset
   * SolrQuery::setGroupLimit
   * SolrQuery::setGroupMain
   * SolrQuery::setGroupNGroups
   * SolrQuery::setGroupTruncate
   * SolrQuery::setGroupFormat
   * SolrQuery::setGroupCachePercent


id: SolrQuery::addHighlightField
type: function
doc:
<comment>Description:</comment>
  Соответствует hl.fl
  
  Соответствует hl.fl. Используется, чтобы указать, что выделенные фрагменты должны быть созданы для
  определённого поля.

<comment>Param:</comment>
  <info>string</info>  <strong>$field</strong>  Название поля

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


id: SolrQuery::addMltField
type: function
doc:
<comment>Description:</comment>
  Устанавливает поле для использования для подобия
  
  Соответствует mlt.fl. Указывает, что поле должно использоваться для подобия.

<comment>Param:</comment>
  <info>string</info>  <strong>$field</strong>  Название поля

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


id: SolrQuery::addMltQueryField
type: function
doc:
<comment>Description:</comment>
  Соответствует mlt.qf
  
  Соответствует mlt.qf. Используется для указания полей запроса и их повышения.

<comment>Param:</comment>
  <info>string</info>  <strong>$field</strong>  Название поля
  <info>float</info>   <strong>$boost</strong>  Значение повышения

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


id: SolrQuery::addSortField
type: function
doc:
<comment>Description:</comment>
  Используется для управления сортировкой результатов
  
  Используется для управления сортировкой результатов.

<comment>Param:</comment>
  <info>string</info>  <strong>$field</strong>  Название поля
  <info>int</info>     <strong>$order</strong>  Направление сортировки. Должно быть либо SolrQuery::ORDER_ASC, либо
                  SolrQuery::ORDER_DESC.

<comment>Return:</comment>
  <info>SolrQuery</info>  Возвращает текущий объект SolrQuery.


id: SolrQuery::addStatsFacet
type: function
doc:
<comment>Description:</comment>
  Запрашивает возврат вспомогательных результатов для значений в данном фасете
  
  Запрашивает возврат вспомогательных результатов для значений в данном фасете. Соответствует полю
  stats.facet

<comment>Param:</comment>
  <info>string</info>  <strong>$field</strong>  Название поля

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


id: SolrQuery::addStatsField
type: function
doc:
<comment>Description:</comment>
  Соответствует параметру stats.field
  
  Соответствует параметру stats.field. Метод добавляет ещё один параметр stats.field.

<comment>Param:</comment>
  <info>string</info>  <strong>$field</strong>  Название поля

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


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

<comment>Param:</comment>
  <info>SolrCollapseFunction</info>  <strong>$collapseFunction</strong>  

<comment>Return:</comment>
  <info>SolrQuery</info>  Возвращает текущий объект <info>SolrQuery</info>


id: SolrQuery::getExpand
type: function
doc:
<comment>Description:</comment>
  Возвращает true, если включено расширение группы
  
  Возвращает <info>true</info>, если включено расширение группы

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


id: SolrQuery::getExpandFilterQueries
type: function
doc:
<comment>Description:</comment>
  Возвращает запросы расширенного фильтра
  
  Возвращает запросы расширенного фильтра

<comment>Return:</comment>
  <info>array</info>  Возвращает запросы расширенного фильтра.


id: SolrQuery::getExpandQuery
type: function
doc:
<comment>Description:</comment>
  Возвращает параметр расширенного запроса expand.q
  
  Возвращает параметр расширенного запроса expand.q

<comment>Return:</comment>
  <info>array</info>  Возвращает расширенный запрос.


id: SolrQuery::getExpandRows
type: function
doc:
<comment>Description:</comment>
  Возвращает количество строк, отображаемых в каждой группе (expand.rows)
  
  Возвращает количество строк, отображаемых в каждой группе (expand.rows)

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


id: SolrQuery::getExpandSortFields
type: function
doc:
<comment>Description:</comment>
  Возвращает массив полей
  
  Возвращает массив полей

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


id: SolrQuery::getFacet
type: function
doc:
<comment>Description:</comment>
  Возвращает значение параметра фасета
  
  Возвращает значение параметра фасета.

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


id: SolrQuery::getFacetDateEnd
type: function
doc:
<comment>Description:</comment>
  Возвращает значение параметра facet.date.end
  
  Возвращает значение параметра facet.date.end. Метод принимает необязательное переопределение поля.

<comment>Param:</comment>
  <info>string</info>  <strong>$field_override</strong>  Имя поля

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


id: SolrQuery::getFacetDateFields
type: function
doc:
<comment>Description:</comment>
  Возвращает все поля facet.date
  
  Возвращает все поля facet.date

<comment>Return:</comment>
  <info>array</info>  Возвращает все поля facet.date в виде массива или <info>null</info>, если ничего не задано


id: SolrQuery::getFacetDateGap
type: function
doc:
<comment>Description:</comment>
  Возвращает значение параметра facet.date.gap
  
  Возвращает значение параметра facet.date.gap. Он принимает необязательное переопределение поля

<comment>Param:</comment>
  <info>string</info>  <strong>$field_override</strong>  Имя поля.

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


id: SolrQuery::getFacetDateHardEnd
type: function
doc:
<comment>Description:</comment>
  Возвращает значение параметра facet.date.hardend
  
  Возвращает значение параметра facet.date.hardend. Принимает необязательное переопределение поля

<comment>Param:</comment>
  <info>string</info>  <strong>$field_override</strong>  Имя поля.

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


id: SolrQuery::getFacetDateOther
type: function
doc:
<comment>Description:</comment>
  Возвращает значение параметра facet.date.other
  
  Возвращает значение параметра facet.date.other. Принимает необязательное переопределение поля

<comment>Param:</comment>
  <info>string</info>  <strong>$field_override</strong>  Имя поля.

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


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

<comment>Param:</comment>
  <info>string</info>  <strong>$field_override</strong>  Имя поля

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


id: SolrQuery::getFacetFields
type: function
doc:
<comment>Description:</comment>
  Возвращает все поля фасетов
  
  Возвращает все поля фасетов

<comment>Return:</comment>
  <info>array</info>  Возвращает массив всех полей и <info>null</info>, если ничего не задано


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

<comment>Param:</comment>
  <info>string</info>  <strong>$field_override</strong>  Имя поля, которое нужно переопределить

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


id: SolrQuery::getFacetMethod
type: function
doc:
<comment>Description:</comment>
  Возвращает значение параметра facet.method
  
  Возвращает значение параметра facet.method. Принимает необязательное переопределение поля

<comment>Param:</comment>
  <info>string</info>  <strong>$field_override</strong>  Имя поля

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


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

<comment>Param:</comment>
  <info>string</info>  <strong>$field_override</strong>  Имя поля

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


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

<comment>Param:</comment>
  <info>string</info>  <strong>$field_override</strong>  Имя поля

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


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

<comment>Param:</comment>
  <info>string</info>  <strong>$field_override</strong>  Имя поля, которое требуется переопределить.

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


id: SolrQuery::getFacetPrefix
type: function
doc:
<comment>Description:</comment>
  Возвращает префикс фасета
  
  Возвращает префикс фасета

<comment>Param:</comment>
  <info>string</info>  <strong>$field_override</strong>  Имя поля

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


id: SolrQuery::getFacetQueries
type: function
doc:
<comment>Description:</comment>
  Возвращает все фасетные запросы
  
  Возвращает все фасетные запросы

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


id: SolrQuery::getFacetSort
type: function
doc:
<comment>Description:</comment>
  Возвращает тип сортировки фасета
  
  Возвращает целое число (SolrQuery::FACET_SORT_INDEX или SolrQuery::FACET_SORT_COUNT)

<comment>Param:</comment>
  <info>string</info>  <strong>$field_override</strong>  Имя поля

<comment>Return:</comment>
  <info>int</info>  Возвращает целое число (SolrQuery::FACET_SORT_INDEX или SolrQuery::FACET_SORT_COUNT) в случае
       успешного выполнения и <info>null</info>, если значение не задано


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

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


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

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


id: SolrQuery::getGroup
type: function
doc:
<comment>Description:</comment>
  Возвращает true, если группировка включена
  
  Возвращает true, если группировка включена

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

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


id: SolrQuery::getGroupCachePercent
type: function
doc:
<comment>Description:</comment>
  Возвращает процентное значение группового кеша
  
  Возвращает процентное значение группового кеша

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

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


id: SolrQuery::getGroupFacet
type: function
doc:
<comment>Description:</comment>
  Возвращает значение параметра group.facet
  
  Возвращает значение параметра group.facet

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

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


id: SolrQuery::getGroupFields
type: function
doc:
<comment>Description:</comment>
  Возвращает групповые поля (значения параметра group.field)
  
  Возвращает групповые поля (значения параметра group.field)

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

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


id: SolrQuery::getGroupFormat
type: function
doc:
<comment>Description:</comment>
  Возвращает значение group.format
  
  Возвращает значение group.format

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

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


id: SolrQuery::getGroupFunctions
type: function
doc:
<comment>Description:</comment>
  Возвращает групповые функции (значения параметров group.func)
  
  Возвращает групповые функции (значения параметров group.func)

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

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


id: SolrQuery::getGroupLimit
type: function
doc:
<comment>Description:</comment>
  Возвращает значение group.limit
  
  Возвращает значение group.limit.

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

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


id: SolrQuery::getGroupMain
type: function
doc:
<comment>Description:</comment>
  Возвращает значение group.main
  
  Возвращает значение group.main

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

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


id: SolrQuery::getGroupNGroups
type: function
doc:
<comment>Description:</comment>
  Возвращает значение group.ngroups
  
  Возвращает значение group.ngroups

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

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


id: SolrQuery::getGroupOffset
type: function
doc:
<comment>Description:</comment>
  Возвращает значение group.offset
  
  Возвращает значение group.offset.

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

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


id: SolrQuery::getGroupQueries
type: function
doc:
<comment>Description:</comment>
  Возвращает все значения параметра group.query
  
  Возвращает все значения параметра group.query

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

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


id: SolrQuery::getGroupSortFields
type: function
doc:
<comment>Description:</comment>
  Возвращает значение group.sort
  
  Возвращает значение group.sort

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

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


id: SolrQuery::getGroupTruncate
type: function
doc:
<comment>Description:</comment>
  Возвращает значение group.truncate
  
  Возвращает значение group.truncate

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

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


id: SolrQuery::getHighlight
type: function
doc:
<comment>Description:</comment>
  Возвращает состояние параметра hl
  
  Возвращает логическое значение, указывающее, следует ли включать выделенные фрагменты в ответе на
  запрос.

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


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

<comment>Param:</comment>
  <info>string</info>  <strong>$field_override</strong>  Имя поля

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


id: SolrQuery::getHighlightFields
type: function
doc:
<comment>Description:</comment>
  Возвращает все поля, для которых Solr должен генерировать выделенные фрагменты
  
  Возвращает все поля, для которых Solr должен генерировать выделенные фрагменты.

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


id: SolrQuery::getHighlightFormatter
type: function
doc:
<comment>Description:</comment>
  Возвращает средство форматирования для выделенного вывода
  
  Возвращает средство форматирования для выделенного вывода

<comment>Param:</comment>
  <info>string</info>  <strong>$field_override</strong>  Имя поля

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


id: SolrQuery::getHighlightFragmenter
type: function
doc:
<comment>Description:</comment>
  Возвращает генератор фрагментов текста для выделенного текста
  
  Возвращает генератор фрагментов текста для выделенного текста. Принимает необязательное
  переопределение поля

<comment>Param:</comment>
  <info>string</info>  <strong>$field_override</strong>  Имя поля

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


id: SolrQuery::getHighlightFragsize
type: function
doc:
<comment>Description:</comment>
  Возвращает количество символов фрагментов для выделения
  
  Возвращает количество символов фрагментов для выделения. Ноль подразумевает отсутствие
  фрагментации. Следует использовать все поле.

<comment>Param:</comment>
  <info>string</info>  <strong>$field_override</strong>  Имя поля

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


id: SolrQuery::getHighlightHighlightMultiTerm
type: function
doc:
<comment>Description:</comment>
  Возвращает, следует ли включать выделение для запросов диапазона/подстановочных
  знаков/нечётких/префиксов
  
  Возвращает, следует ли включать выделение для запросов диапазона/подстановочных
  знаков/нечётких/префиксов

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


id: SolrQuery::getHighlightMaxAlternateFieldLength
type: function
doc:
<comment>Description:</comment>
  Возвращает максимальное количество символов поля для возврата
  
  Возвращает максимальное количество символов поля для возврата

<comment>Param:</comment>
  <info>string</info>  <strong>$field_override</strong>  Имя поля

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


id: SolrQuery::getHighlightMaxAnalyzedChars
type: function
doc:
<comment>Description:</comment>
  Возвращает максимальное количество символов в документе для поиска подходящих фрагментов
  
  Возвращает максимальное количество символов в документе для поиска подходящих фрагментов

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


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

<comment>Param:</comment>
  <info>string</info>  <strong>$field_override</strong>  Имя поля

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


id: SolrQuery::getHighlightRegexMaxAnalyzedChars
type: function
doc:
<comment>Description:</comment>
  Возвращает максимальное количество символов из поля при использовании фрагментатора регулярного
  выражения
  
  Возвращает максимальное количество символов из поля при использовании фрагментатора регулярного
  выражения

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


id: SolrQuery::getHighlightRegexPattern
type: function
doc:
<comment>Description:</comment>
  Возвращает регулярное выражение для фрагментации
  
  Возвращает регулярное выражение для фрагментации

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


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

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


id: SolrQuery::getHighlightRequireFieldMatch
type: function
doc:
<comment>Description:</comment>
  Возвращает, если поле будет выделено только в том случае, если запрос соответствует этому
  конкретному полю
  
  Возвращает, если поле будет выделено только в том случае, если запрос соответствует этому
  конкретному полю.

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


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

<comment>Param:</comment>
  <info>string</info>  <strong>$field_override</strong>  Имя поля

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


id: SolrQuery::getHighlightSimplePre
type: function
doc:
<comment>Description:</comment>
  Возвращает текст, который появляется перед выделенным выражением
  
  Возвращает текст, который появляется перед выделенным выражением. Принимает необязательное
  переопределение поля

<comment>Param:</comment>
  <info>string</info>  <strong>$field_override</strong>  Имя поля

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


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

<comment>Param:</comment>
  <info>string</info>  <strong>$field_override</strong>  Имя поля

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


id: SolrQuery::getHighlightUsePhraseHighlighter
type: function
doc:
<comment>Description:</comment>
  Возвращает состояние параметра hl.usePhraseHighlighter
  
  Возвращает, следует ли использовать SpanScorer для выделения фразовых выражений, только когда они
  появляются во фразе запроса в документе.

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


id: SolrQuery::getMlt
type: function
doc:
<comment>Description:</comment>
  Возвращает, должны ли быть включены результаты MoreLikeThis
  
  Возвращает, должны ли быть включены результаты MoreLikeThis

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


id: SolrQuery::getMltBoost
type: function
doc:
<comment>Description:</comment>
  Возвращает, будет ли запрос усилен релевантностью интересующего выражения
  
  Возвращает, будет ли запрос усилен релевантностью интересующего выражения

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


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

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


id: SolrQuery::getMltFields
type: function
doc:
<comment>Description:</comment>
  Возвращает все поля, которые нужно использовать для сравнения
  
  Возвращает все поля, которые нужно использовать для сравнения.

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


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

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


id: SolrQuery::getMltMaxNumTokens
type: function
doc:
<comment>Description:</comment>
  Возвращает максимальное количество токенов для анализа в каждом поле документа, которое не
  хранится
  с поддержкой TermVector
  
  Возвращает максимальное количество токенов для анализа в каждом поле документа, которое не
  хранится с поддержкой TermVector.

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


id: SolrQuery::getMltMaxWordLength
type: function
doc:
<comment>Description:</comment>
  Возвращает максимальную длину слова, выше которой слова будут игнорироваться
  
  Возвращает максимальную длину слова, выше которой слова будут игнорироваться.

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


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

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


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

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


id: SolrQuery::getMltMinWordLength
type: function
doc:
<comment>Description:</comment>
  Возвращает минимальную длину слова, ниже которой слова будут игнорироваться
  
  Возвращает минимальную длину слова, ниже которой слова будут игнорироваться.

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


id: SolrQuery::getMltQueryFields
type: function
doc:
<comment>Description:</comment>
  Возвращает поля запроса и их повышения
  
  Возвращает поля запроса и их повышения

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


id: SolrQuery::getQuery
type: function
doc:
<comment>Description:</comment>
  Возвращает основной запрос
  
  Возвращает основной запрос

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


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

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


id: SolrQuery::getSortFields
type: function
doc:
<comment>Description:</comment>
  Возвращает все поля сортировки
  
  Возвращает все поля сортировки

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


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

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


id: SolrQuery::getStats
type: function
doc:
<comment>Description:</comment>
  Возвращает, включена ли статистика
  
  Возвращает, включена ли статистика.

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


id: SolrQuery::getStatsFacets
type: function
doc:
<comment>Description:</comment>
  Возвращает все фасеты статистики, которые были установлены
  
  Возвращает все фасеты статистики, которые были установлены

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


id: SolrQuery::getStatsFields
type: function
doc:
<comment>Description:</comment>
  Возвращает все поля статистики
  
  Возвращает все поля статистики

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


id: SolrQuery::getTerms
type: function
doc:
<comment>Description:</comment>
  Возвращает, включён ли TermsComponent
  
  Возвращает, включён ли TermsComponent

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


id: SolrQuery::getTermsField
type: function
doc:
<comment>Description:</comment>
  Возвращает поле, из которого извлекаются выражения
  
  Возвращает поле, из которого извлекаются выражения.

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


id: SolrQuery::getTermsIncludeLowerBound
type: function
doc:
<comment>Description:</comment>
  Возвращает, нужно ли включать выражение нижней границы в набор результатов
  
  Возвращает, нужно ли включать выражение нижней границы в набор результатов

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


id: SolrQuery::getTermsIncludeUpperBound
type: function
doc:
<comment>Description:</comment>
  Возвращает, нужно ли включать выражение верхней границы в набор результатов
  
  Возвращает, нужно ли включать выражение верхней границы в набор результатов

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


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

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


id: SolrQuery::getTermsLowerBound
type: function
doc:
<comment>Description:</comment>
  Возвращает выражение для начала
  
  Возвращает выражение для начала

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


id: SolrQuery::getTermsMaxCount
type: function
doc:
<comment>Description:</comment>
  Возвращает максимальную частоту документа
  
  Возвращает максимальную частоту документа.

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


id: SolrQuery::getTermsMinCount
type: function
doc:
<comment>Description:</comment>
  Возвращает минимальную частоту возврата документов для включения
  
  Возвращает минимальную частоту возврата документов для включения

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


id: SolrQuery::getTermsPrefix
type: function
doc:
<comment>Description:</comment>
  Возвращает префикс выражения
  
  Возвращает префикс, которым должны быть ограничены совпадающие выражения. Ограничит совпадения
  только выражениями, начинающимися с префикса

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


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

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


id: SolrQuery::getTermsSort
type: function
doc:
<comment>Description:</comment>
  Возвращает целое число, указывающее, как сортируются выражения
  
  SolrQuery::TERMS_SORT_INDEX указывает, что выражения возвращаются в порядке индекса.
  SolrQuery::TERMS_SORT_COUNT подразумевает, что выражения сортируются по частоте выражения (сначала
  наивысшее количество)

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


id: SolrQuery::getTermsUpperBound
type: function
doc:
<comment>Description:</comment>
  Возвращает выражение для остановки
  
  Возвращает выражение для остановки

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


id: SolrQuery::getTimeAllowed
type: function
doc:
<comment>Description:</comment>
  Возвращает время в миллисекундах, разрешённое для завершения запроса
  
  Возвращает время в миллисекундах, разрешённое для завершения запроса.

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


id: SolrQuery::removeExpandFilterQuery
type: function
doc:
<comment>Description:</comment>
  Удаляет запрос расширенного фильтра
  
  Удаляет запрос расширенного фильтра.

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

<comment>Return:</comment>
  <info>SolrQuery</info>  <info>SolrQuery</info>

<comment>See Also:</comment>
   * SolrQuery::setExpand
   * SolrQuery::addExpandSortField
   * SolrQuery::removeExpandSortField
   * SolrQuery::setExpandRows
   * SolrQuery::setExpandQuery
   * SolrQuery::addExpandFilterQuery


id: SolrQuery::removeExpandSortField
type: function
doc:
<comment>Description:</comment>
  Удаляет расширенное поле сортировки из параметра expand.sort
  
  Удаляет расширенное поле сортировки из параметра expand.sort.

<comment>Param:</comment>
  <info>string</info>  <strong>$field</strong>  Имя поля

<comment>Return:</comment>
  <info>SolrQuery</info>  <info>SolrQuery</info>

<comment>See Also:</comment>
   * SolrQuery::setExpand
   * SolrQuery::addExpandSortField
   * SolrQuery::setExpandRows
   * SolrQuery::setExpandQuery
   * SolrQuery::addExpandFilterQuery
   * SolrQuery::removeExpandFilterQuery


id: SolrQuery::removeFacetDateField
type: function
doc:
<comment>Description:</comment>
  Удаляет одно из полей даты фасета
  
  Название поля

<comment>Param:</comment>
  <info>string</info>  <strong>$field</strong>  Имя поля даты, которое нужно удалить

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


id: SolrQuery::removeFacetDateOther
type: function
doc:
<comment>Description:</comment>
  Удаляет один из параметров facet.date.other
  
  Удаляет один из параметров facet.date.other

<comment>Param:</comment>
  <info>string</info>  <strong>$value</strong>           Значение
  <info>string</info>  <strong>$field_override</strong>  Имя поля.

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


id: SolrQuery::removeFacetField
type: function
doc:
<comment>Description:</comment>
  Удаляет один из параметров facet.date
  
  Удаляет один из параметров facet.date

<comment>Param:</comment>
  <info>string</info>  <strong>$field</strong>  Имя поля

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


id: SolrQuery::removeFacetQuery
type: function
doc:
<comment>Description:</comment>
  Удаляет один из параметров facet.query
  
  Удаляет один из параметров facet.query.

<comment>Param:</comment>
  <info>string</info>  <strong>$value</strong>  Значение

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


id: SolrQuery::removeField
type: function
doc:
<comment>Description:</comment>
  Удаляет поле из списка полей
  
  Удаляет поле из списка полей

<comment>Param:</comment>
  <info>string</info>  <strong>$field</strong>  Имя поля.

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


id: SolrQuery::removeFilterQuery
type: function
doc:
<comment>Description:</comment>
  Удаляет запрос фильтра
  
  Удаляет запрос фильтра.

<comment>Param:</comment>
  <info>string</info>  <strong>$fq</strong>  Фильтр запроса для удаления

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


id: SolrQuery::removeHighlightField
type: function
doc:
<comment>Description:</comment>
  Удаляет одно из полей, используемых для выделения
  
  Удаляет одно из полей, используемых для выделения.

<comment>Param:</comment>
  <info>string</info>  <strong>$field</strong>  Имя поля

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


id: SolrQuery::removeMltField
type: function
doc:
<comment>Description:</comment>
  Удаляет одно из полей moreLikeThis
  
  Удаляет одно из полей moreLikeThis.

<comment>Param:</comment>
  <info>string</info>  <strong>$field</strong>  Имя поля

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


id: SolrQuery::removeMltQueryField
type: function
doc:
<comment>Description:</comment>
  Удаляет одно из полей запроса moreLikeThis
  
  Удаляет одно из полей запроса moreLikeThis.

<comment>Param:</comment>
  <info>string</info>  <strong>$queryField</strong>  Поле запроса

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


id: SolrQuery::removeSortField
type: function
doc:
<comment>Description:</comment>
  Удаляет одно из полей сортировки
  
  Удаляет одно из полей сортировки

<comment>Param:</comment>
  <info>string</info>  <strong>$field</strong>  Имя поля

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


id: SolrQuery::removeStatsFacet
type: function
doc:
<comment>Description:</comment>
  Удаляет один из параметров stats.facet
  
  Удаляет один из параметров stats.facet

<comment>Param:</comment>
  <info>string</info>  <strong>$value</strong>  Значение

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


id: SolrQuery::removeStatsField
type: function
doc:
<comment>Description:</comment>
  Удаляет один из параметров stats.field
  
  Удаляет один из параметров stats.field

<comment>Param:</comment>
  <info>string</info>  <strong>$field</strong>  Имя поля.

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


id: SolrQuery::setEchoHandler
type: function
doc:
<comment>Description:</comment>
  Переключает параметр echoHandler
  
  Если установлено значение true, Solr помещает имя дескриптора, используемого в ответе, клиенту для
  целей отладки.

<comment>Param:</comment>
  <info>bool</info>  <strong>$flag</strong>  <info>true</info> или <info>false</info>

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


id: SolrQuery::setEchoParams
type: function
doc:
<comment>Description:</comment>
  Определяет, какие параметры включать в ответ
  
  Указывает Solr, какие параметры запроса должны быть включены в ответ для целей отладки, допустимые
  значения:
  
  

<comment>Param:</comment>
  <info>string</info>  <strong>$type</strong>  Тип включаемых параметров

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


id: SolrQuery::setExpand
type: function
doc:
<comment>Description:</comment>
  Включает/отключает компонент Expand
  
  Включает/отключает компонент Expand.

<comment>Param:</comment>
  <info>bool</info>  <strong>$value</strong>  Логический флаг (да или нет)

<comment>Return:</comment>
  <info>SolrQuery</info>  <info>SolrQuery</info>

<comment>See Also:</comment>
   * SolrQuery::addExpandSortField
   * SolrQuery::removeExpandSortField
   * SolrQuery::setExpandRows
   * SolrQuery::setExpandQuery
   * SolrQuery::addExpandFilterQuery
   * SolrQuery::removeExpandFilterQuery


id: SolrQuery::setExpandQuery
type: function
doc:
<comment>Description:</comment>
  Устанавливает параметр expand.q
  
  Устанавливает параметр expand.q
  
  Переопределяет основной параметр q, определяет, какие документы включить в основную группу.

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

<comment>Return:</comment>
  <info>SolrQuery</info>  <info>SolrQuery</info>

<comment>See Also:</comment>
   * SolrQuery::setExpand
   * SolrQuery::addExpandSortField
   * SolrQuery::removeExpandSortField
   * SolrQuery::setExpandRows
   * SolrQuery::addExpandFilterQuery
   * SolrQuery::removeExpandFilterQuery


id: SolrQuery::setExpandRows
type: function
doc:
<comment>Description:</comment>
  Устанавливает количество строк для отображения в каждой группе (expand.rows). По умолчанию 5
  
  Устанавливает количество строк для отображения в каждой группе (expand.rows). По умолчанию 5

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

<comment>Return:</comment>
  <info>SolrQuery</info>  <info>SolrQuery</info>

<comment>See Also:</comment>
   * SolrQuery::setExpand
   * SolrQuery::addExpandSortField
   * SolrQuery::removeExpandSortField
   * SolrQuery::setExpandQuery
   * SolrQuery::addExpandFilterQuery
   * SolrQuery::removeExpandFilterQuery


id: SolrQuery::setExplainOther
type: function
doc:
<comment>Description:</comment>
  Устанавливает общий параметр запроса explainOther
  
  Устанавливает общий параметр запроса explainOther

<comment>Param:</comment>
  <info>string</info>  <strong>$query</strong>  Запрос Lucene для идентификации набора документов

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


id: SolrQuery::setFacet
type: function
doc:
<comment>Description:</comment>
  Соответствует параметру фасета. Включает или отключает фасетирование
  
  Включает или отключает фасетирование.

<comment>Param:</comment>
  <info></info>  <strong>$value</strong>  <info>true</info> включает, а <info>false</info> отключает.

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


id: SolrQuery::setFacetDateEnd
type: function
doc:
<comment>Description:</comment>
  Соответствует facet.date.end
  
  Соответствует facet.date.end

<comment>Param:</comment>
  <info>string</info>  <strong>$value</strong>           Смотрите facet.date.end
  <info>string</info>  <strong>$field_override</strong>  Имя поля

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


id: SolrQuery::setFacetDateGap
type: function
doc:
<comment>Description:</comment>
  Соответствует facet.date.gap
  
  Соответствует facet.date.gap

<comment>Param:</comment>
  <info>string</info>  <strong>$value</strong>           Смотрите facet.date.gap
  <info>string</info>  <strong>$field_override</strong>  Имя поля

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


id: SolrQuery::setFacetDateHardEnd
type: function
doc:
<comment>Description:</comment>
  Соответствует facet.date.hardend
  
  Соответствует facet.date.hardend

<comment>Param:</comment>
  <info>bool</info>    <strong>$value</strong>           Смотрите facet.date.hardend
  <info>string</info>  <strong>$field_override</strong>  Имя поля

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


id: SolrQuery::setFacetDateStart
type: function
doc:
<comment>Description:</comment>
  Соответствует facet.date.start
  
  Соответствует facet.date.start

<comment>Param:</comment>
  <info>string</info>  <strong>$value</strong>           Смотрите facet.date.start
  <info>string</info>  <strong>$field_override</strong>  Имя поля.

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


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

<comment>Param:</comment>
  <info></info>        <strong>$value</strong>           Минимальная частота
  <info>string</info>  <strong>$field_override</strong>  Имя поля.

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


id: SolrQuery::setFacetLimit
type: function
doc:
<comment>Description:</comment>
  Соответствует facet.limit
  
  Соответствует facet.limit. Устанавливает максимальное количество ограничений, которые должны быть
  возвращены для полей фасета.

<comment>Param:</comment>
  <info>int</info>     <strong>$limit</strong>           Максимальное количество ограничений
  <info>string</info>  <strong>$field_override</strong>  Имя поля

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


id: SolrQuery::setFacetMethod
type: function
doc:
<comment>Description:</comment>
  Задаёт тип алгоритма, который следует использовать при фасетировании поля
  
  Задаёт тип алгоритма, который следует использовать при фасетировании поля. Метод допускает
  переопределение необязательного поля.

<comment>Param:</comment>
  <info>string</info>  <strong>$method</strong>          Используемый метод.
  <info>string</info>  <strong>$field_override</strong>  Имя поля.

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


id: SolrQuery::setFacetMinCount
type: function
doc:
<comment>Description:</comment>
  Соответствует facet.mincount
  
  Устанавливает минимальное количество полей фасетов, которые должны быть включены в ответ

<comment>Param:</comment>
  <info>int</info>     <strong>$mincount</strong>        Минимальное количество
  <info>string</info>  <strong>$field_override</strong>  Имя поля.

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


id: SolrQuery::setFacetMissing
type: function
doc:
<comment>Description:</comment>
  Соответствует facet.missing
  
  Используется для обозначения того, что в дополнение к основанным на выражениях ограничениям поля
  фасета должно быть вычислено количество всех результатов сопоставления, которые не имеют значения
  для поля.

<comment>Param:</comment>
  <info>bool</info>    <strong>$flag</strong>            <info>true</info> включает эту функцию, <info>false</info> отключает её.
  <info>string</info>  <strong>$field_override</strong>  Имя поля.

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


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

<comment>Param:</comment>
  <info>int</info>     <strong>$offset</strong>          Смещение
  <info>string</info>  <strong>$field_override</strong>  Имя поля.

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


id: SolrQuery::setFacetPrefix
type: function
doc:
<comment>Description:</comment>
  Определяет строковый префикс, с помощью которого ограничиваются выражения, на которых выполняется
  фасет
  
  Определяет строковый префикс, с помощью которого ограничиваются выражения, на которых выполняется
  фасет.

<comment>Param:</comment>
  <info>string</info>  <strong>$prefix</strong>          Строковый префикс
  <info>string</info>  <strong>$field_override</strong>  Имя поля.

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


id: SolrQuery::setFacetSort
type: function
doc:
<comment>Description:</comment>
  Определяет порядок ограничений поля фасета
  
  Определяет порядок ограничений поля фасета

<comment>Param:</comment>
  <info>int</info>     <strong>$facetSort</strong>       Используйте SolrQuery::FACET_SORT_INDEX для сортировки по порядку индекса
                           или SolrQuery::FACET_SORT_COUNT для сортировки по количеству.
  <info>string</info>  <strong>$field_override</strong>  Имя поля.

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


id: SolrQuery::setGroup
type: function
doc:
<comment>Description:</comment>
  Включает/отключает группировку результатов (параметр group)
  
  Включает/отключает группировку результатов (параметр group)

<comment>Param:</comment>
  <info>bool</info>  <strong>$value</strong>  

<comment>Return:</comment>
  <info>SolrQuery</info>  

<comment>See Also:</comment>
   * SolrQuery::getGroup
   * SolrQuery::addGroupField
   * SolrQuery::addGroupFunction
   * SolrQuery::addGroupQuery
   * SolrQuery::addGroupSortField
   * SolrQuery::setGroupFacet
   * SolrQuery::setGroupOffset
   * SolrQuery::setGroupLimit
   * SolrQuery::setGroupMain
   * SolrQuery::setGroupNGroups
   * SolrQuery::setGroupTruncate
   * SolrQuery::setGroupFormat
   * SolrQuery::setGroupCachePercent


id: SolrQuery::setGroupCachePercent
type: function
doc:
<comment>Description:</comment>
  Включает кеширование для группировки результатов
  
  Установка для этого параметра числа больше 0 включает кеширование для группировки результатов.
  Группа результатов выполняет два поиска; эта опция кеширует второй поиск. Значение сервера по
  умолчанию - 0.
   Тестирование показало, что групповое кеширование улучшает только время поиска с логическими
  запросами, запросами с подстановочными знаками и нечёткими запросами. Для простых запросов, таких
  как выражение или запросы "сопоставить все", групповое кеширование снижает производительность.
  Параметр group.cache.percent

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

<comment>Return:</comment>
  <info>SolrQuery</info>  

<comment>See Also:</comment>
   * SolrQuery::setGroup
   * SolrQuery::addGroupField
   * SolrQuery::addGroupFunction
   * SolrQuery::addGroupQuery
   * SolrQuery::addGroupSortField
   * SolrQuery::setGroupFacet
   * SolrQuery::setGroupOffset
   * SolrQuery::setGroupLimit
   * SolrQuery::setGroupMain
   * SolrQuery::setGroupNGroups
   * SolrQuery::setGroupTruncate
   * SolrQuery::setGroupFormat


id: SolrQuery::setGroupFacet
type: function
doc:
<comment>Description:</comment>
  Устанавливает параметр group.facet
  
  Определяет, нужно ли вычислять сгруппированные фасеты для фасетов поля, указанных в параметрах
  facet.field. Сгруппированные фасеты вычисляются на основе первой указанной группы.

<comment>Param:</comment>
  <info>bool</info>  <strong>$value</strong>  

<comment>Return:</comment>
  <info>SolrQuery</info>  

<comment>See Also:</comment>
   * SolrQuery::setGroup
   * SolrQuery::addGroupField
   * SolrQuery::addGroupFunction
   * SolrQuery::addGroupQuery
   * SolrQuery::addGroupSortField
   * SolrQuery::setGroupOffset
   * SolrQuery::setGroupLimit
   * SolrQuery::setGroupMain
   * SolrQuery::setGroupNGroups
   * SolrQuery::setGroupTruncate
   * SolrQuery::setGroupFormat
   * SolrQuery::setGroupCachePercent


id: SolrQuery::setGroupFormat
type: function
doc:
<comment>Description:</comment>
  Устанавливает формат группы, структуру результата (параметр group.format)
  
  Устанавливает параметр group.format. Если для этого параметра установлено значение simple,
  сгруппированные документы представляются в одном плоском списке, а параметры start и rows влияют
  на количество документов, а не на группы. Допустимые значения: grouped/simple

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

<comment>Return:</comment>
  <info>SolrQuery</info>  

<comment>See Also:</comment>
   * SolrQuery::setGroup
   * SolrQuery::addGroupField
   * SolrQuery::addGroupFunction
   * SolrQuery::addGroupQuery
   * SolrQuery::addGroupSortField
   * SolrQuery::setGroupFacet
   * SolrQuery::setGroupOffset
   * SolrQuery::setGroupLimit
   * SolrQuery::setGroupMain
   * SolrQuery::setGroupNGroups
   * SolrQuery::setGroupTruncate
   * SolrQuery::setGroupCachePercent


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

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

<comment>Return:</comment>
  <info>SolrQuery</info>  

<comment>See Also:</comment>
   * SolrQuery::setGroup
   * SolrQuery::addGroupField
   * SolrQuery::addGroupFunction
   * SolrQuery::addGroupQuery
   * SolrQuery::addGroupSortField
   * SolrQuery::setGroupFacet
   * SolrQuery::setGroupOffset
   * SolrQuery::setGroupMain
   * SolrQuery::setGroupNGroups
   * SolrQuery::setGroupTruncate
   * SolrQuery::setGroupFormat
   * SolrQuery::setGroupCachePercent


id: SolrQuery::setGroupMain
type: function
doc:
<comment>Description:</comment>
  Если true, результат первой команды группировки полей используется в качестве основного списка
  результатов в ответе с использованием group.format=simple
  
  Если <info>true</info>, результат первой команды группировки полей используется в качестве основного списка
  результатов в ответе с использованием <return>group.format=simple</return>.

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

<comment>Return:</comment>
  <info>SolrQuery</info>  Возвращает экземпляр <class>SolrQuery</class>.

<comment>See Also:</comment>
   * SolrQuery::setGroup
   * SolrQuery::addGroupField
   * SolrQuery::addGroupFunction
   * SolrQuery::addGroupQuery
   * SolrQuery::addGroupSortField
   * SolrQuery::setGroupFacet
   * SolrQuery::setGroupOffset
   * SolrQuery::setGroupMain
   * SolrQuery::setGroupNGroups
   * SolrQuery::setGroupTruncate
   * SolrQuery::setGroupFormat
   * SolrQuery::setGroupCachePercent


id: SolrQuery::setGroupNGroups
type: function
doc:
<comment>Description:</comment>
  Если true, Solr включает в результаты количество групп, которые соответствуют запросу
  
  Если true, Solr включает в результаты количество групп, которые соответствуют запросу.

<comment>Param:</comment>
  <info>bool</info>  <strong>$value</strong>  

<comment>Return:</comment>
  <info>SolrQuery</info>  

<comment>See Also:</comment>
   * SolrQuery::setGroup
   * SolrQuery::addGroupField
   * SolrQuery::addGroupFunction
   * SolrQuery::addGroupQuery
   * SolrQuery::addGroupSortField
   * SolrQuery::setGroupFacet
   * SolrQuery::setGroupOffset
   * SolrQuery::setGroupLimit
   * SolrQuery::setGroupMain
   * SolrQuery::setGroupTruncate
   * SolrQuery::setGroupFormat
   * SolrQuery::setGroupCachePercent


id: SolrQuery::setGroupOffset
type: function
doc:
<comment>Description:</comment>
  Устанавливает параметр group.offset
  
  Устанавливает параметр group.offset

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

<comment>Return:</comment>
  <info>SolrQuery</info>  

<comment>See Also:</comment>
   * SolrQuery::setGroup
   * SolrQuery::addGroupField
   * SolrQuery::addGroupFunction
   * SolrQuery::addGroupQuery
   * SolrQuery::addGroupSortField
   * SolrQuery::setGroupFacet
   * SolrQuery::setGroupLimit
   * SolrQuery::setGroupMain
   * SolrQuery::setGroupNGroups
   * SolrQuery::setGroupTruncate
   * SolrQuery::setGroupFormat
   * SolrQuery::setGroupCachePercent


id: SolrQuery::setGroupTruncate
type: function
doc:
<comment>Description:</comment>
  Если true, подсчёт фасетов основан на наиболее релевантном документе каждой группы,
  соответствующей
  запросу
  
  Если true, подсчёт фасетов основан на наиболее релевантном документе каждой группы,
  соответствующей запросу. Значение сервера по умолчанию - false. Параметр group.truncate

<comment>Param:</comment>
  <info>bool</info>  <strong>$value</strong>  

<comment>Return:</comment>
  <info>SolrQuery</info>  

<comment>See Also:</comment>
   * SolrQuery::setGroup
   * SolrQuery::addGroupField
   * SolrQuery::addGroupFunction
   * SolrQuery::addGroupQuery
   * SolrQuery::addGroupSortField
   * SolrQuery::setGroupFacet
   * SolrQuery::setGroupOffset
   * SolrQuery::setGroupLimit
   * SolrQuery::setGroupMain
   * SolrQuery::setGroupNGroups
   * SolrQuery::setGroupFormat
   * SolrQuery::setGroupCachePercent


id: SolrQuery::setHighlight
type: function
doc:
<comment>Description:</comment>
  Включает или отключает выделение
  
  Установив значение <info>true</info> позволяет создавать выделенные фрагменты в ответе на запрос.
  
  Установив значение <info>false</info> отключает выделение

<comment>Param:</comment>
  <info>bool</info>  <strong>$flag</strong>  Включает или отключает выделение

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


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

<comment>Param:</comment>
  <info>string</info>  <strong>$field</strong>           Имя резервного поля
  <info>string</info>  <strong>$field_override</strong>  Имя поля, для которого мы переопределяем этот параметр.

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


id: SolrQuery::setHighlightFormatter
type: function
doc:
<comment>Description:</comment>
  Задаёт средство форматирования для вывода выделения
  
  Задаёт средство форматирования для вывода выделения

<comment>Param:</comment>
  <info>string</info>  <strong>$formatter</strong>       В настоящее время единственное допустимое значение - "simple"
  <info>string</info>  <strong>$field_override</strong>  Имя поля

<comment>Return:</comment>
  <info>SolrQuery</info>  Возвращает экземпляр <class>SolrQuery</class>.


id: SolrQuery::setHighlightFragmenter
type: function
doc:
<comment>Description:</comment>
  Устанавливает генератор текстовых фрагментов для выделенного текста
  
  Задаёт генератор текстового фрагмента для выделенного текста.

<comment>Param:</comment>
  <info>string</info>  <strong>$fragmenter</strong>      Стандартный фрагментер - разрыв. Другой вариант - регулярное выражение,
                           которое пытается создать фрагменты, похожие на определённое регулярное
                           выражение.
  <info>string</info>  <strong>$field_override</strong>  Имя поля

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


id: SolrQuery::setHighlightFragsize
type: function
doc:
<comment>Description:</comment>
  Размер фрагментов, которые следует учитывать при выделении
  
  Устанавливает размер в символах фрагментов для выделения. "0" указывает, что следует использовать
  все значение поля (без фрагментации).

<comment>Param:</comment>
  <info>int</info>     <strong>$size</strong>            Размер в символах фрагментов, которые следует учитывать при выделении
  <info>string</info>  <strong>$field_override</strong>  Имя поля

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


id: SolrQuery::setHighlightHighlightMultiTerm
type: function
doc:
<comment>Description:</comment>
  Использовать SpanScorer для выделения выражений
  
  Использовать SpanScorer для выделения фразовых выражений, только когда они появляются во фразе
  запроса в документе.

<comment>Param:</comment>
  <info>bool</info>  <strong>$flag</strong>  Следует ли использовать SpanScorer для выделения фразовых выражений только тогда,
               когда они появляются во фразе запроса в документе.

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


id: SolrQuery::setHighlightMaxAlternateFieldLength
type: function
doc:
<comment>Description:</comment>
  Устанавливает максимальное количество символов поля для возврата
  
  Если SolrQuery::setHighlightAlternateField() было передано значение <info>true</info>, этот параметр указывает
  максимальное количество символов поля для возврата
  
  Любое значение меньше или равное 0 означает неограниченное.

<comment>Param:</comment>
  <info>int</info>     <strong>$fieldLength</strong>     Длина поля
  <info>string</info>  <strong>$field_override</strong>  Имя поля

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


id: SolrQuery::setHighlightMaxAnalyzedChars
type: function
doc:
<comment>Description:</comment>
  Задаёт количество символов в документе для поиска подходящих фрагментов
  
  Задаёт количество символов в документе для поиска подходящих фрагментов

<comment>Param:</comment>
  <info>int</info>  <strong>$value</strong>  Количество символов в документе для поиска подходящих фрагментов

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


id: SolrQuery::setHighlightMergeContiguous
type: function
doc:
<comment>Description:</comment>
  Свёртывать ли смежные фрагменты в один фрагмент
  
  Свёртывать ли смежные фрагменты в один фрагмент

<comment>Param:</comment>
  <info></info>        <strong>$value</strong>           Свёртывать ли смежные фрагменты в один фрагмент
  <info>string</info>  <strong>$field_override</strong>  Имя поля

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


id: SolrQuery::setHighlightRegexMaxAnalyzedChars
type: function
doc:
<comment>Description:</comment>
  Задаёт максимальное количество символов для анализа
  
  Задаёт максимальное количество символов для анализа из поля при использовании фрагментера
  регулярного выражения

<comment>Param:</comment>
  <info>int</info>  <strong>$maxAnalyzedChars</strong>  Максимальное количество символов для анализа из поля при использовании
                          фрагментера регулярного выражения

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


id: SolrQuery::setHighlightRegexPattern
type: function
doc:
<comment>Description:</comment>
  Задаёт регулярное выражение для фрагментации
  
  Задаёт регулярное выражение для фрагментации. Можно использовать для извлечения предложений

<comment>Param:</comment>
  <info>string</info>  <strong>$value</strong>  Регулярное выражение для фрагментации. Можно использовать для извлечения
                  предложений

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


id: SolrQuery::setHighlightRegexSlop
type: function
doc:
<comment>Description:</comment>
  Устанавливает коэффициент, на который фрагментатор регулярного выражения может отклониться от
  идеального размера фрагмента
  
  Коэффициент, на который фрагментатор регулярного выражения может отклониться от идеального размера
  фрагмента (указанного в SolrQuery::setHighlightFragsize) для соответствия регулярному выражению.

<comment>Param:</comment>
  <info>float</info>  <strong>$factor</strong>  Коэффициент, на который фрагментатор регулярного выражения может отклониться от
                  идеального размера фрагмента

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


id: SolrQuery::setHighlightRequireFieldMatch
type: function
doc:
<comment>Description:</comment>
  Требовать сопоставления полей при выделении
  
  Если <info>true</info>, тогда поле будет выделено только в том случае, если запрос соответствует этому
  конкретному полю.
  
  Будет работать, только если для SolrQuery::setHighlightUsePhraseHighlighter() установлено значение
  <info>true</info>

<comment>Param:</comment>
  <info>bool</info>  <strong>$flag</strong>  <info>true</info> или <info>false</info>

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


id: SolrQuery::setHighlightSimplePost
type: function
doc:
<comment>Description:</comment>
  Устанавливает текст, который появляется после выделенного выражения
  
  Устанавливает текст, который появляется после выделенного выражения

<comment>Param:</comment>
  <info>string</info>  <strong>$simplePost</strong>      Устанавливает текст, который появляется после выделенного выражения
                           
                           ]]>
  <info>string</info>  <strong>$field_override</strong>  Имя поля

<comment>Return:</comment>
  <info>SolrQuery</info>  Возвращает экземпляр <class>SolrQuery</class>.


id: SolrQuery::setHighlightSimplePre
type: function
doc:
<comment>Description:</comment>
  Устанавливает текст, который появляется перед выделенным выражением
  
  Устанавливает текст, который появляется перед выделенным выражением
  
  ]]>

<comment>Param:</comment>
  <info>string</info>  <strong>$simplePre</strong>       Текст, который появляется перед выделенным выражением
  <info>string</info>  <strong>$field_override</strong>  Имя поля

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


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

<comment>Param:</comment>
  <info>int</info>     <strong>$value</strong>           Максимальное количество выделенных фрагментов для создания для каждого
                           поля
  <info>string</info>  <strong>$field_override</strong>  Имя поля

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


id: SolrQuery::setHighlightUsePhraseHighlighter
type: function
doc:
<comment>Description:</comment>
  Следует ли выделять выражения только тогда, когда они появляются во фразе запроса
  
  Устанавливает, следует ли использовать SpanScorer для выделения выражений только тогда, когда они
  появляются во фразе запроса в документе.

<comment>Param:</comment>
  <info></info>  <strong>$value</strong>  Устанавливает, следует ли использовать SpanScorer для выделения выражений только тогда,
            когда они появляются во фразе запроса в документе.

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


id: SolrQuery::setMlt
type: function
doc:
<comment>Description:</comment>
  Включает или отключает moreLikeThis
  
  Включает или отключает moreLikeThis

<comment>Param:</comment>
  <info>bool</info>  <strong>$flag</strong>  <info>true</info> включает и <info>false</info> выключает.

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


id: SolrQuery::setMltBoost
type: function
doc:
<comment>Description:</comment>
  Устанавливает, будет ли запрос усилен релевантностью интересного выражения
  
  Устанавливает, будет ли запрос усилен релевантностью интересного выражения

<comment>Param:</comment>
  <info></info>  <strong>$value</strong>  Установите <info>true</info> или <info>false</info>

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


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

<comment>Param:</comment>
  <info>int</info>  <strong>$count</strong>  Количество похожих документов, возвращаемых для каждого результата

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


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

<comment>Param:</comment>
  <info>int</info>  <strong>$value</strong>  Максимальное количество выражений запроса, которые будут включены в любой
               сгенерированный запрос

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


id: SolrQuery::setMltMaxNumTokens
type: function
doc:
<comment>Description:</comment>
  Задаёт максимальное количество токенов для анализа
  
  Задаёт максимальное количество токенов для анализа в каждом примере поля документа, которое не
  хранится с поддержкой TermVector.

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

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


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

<comment>Param:</comment>
  <info>int</info>  <strong>$maxWordLength</strong>  Максимальная длина слова, выше которой слова будут игнорироваться.

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


id: SolrQuery::setMltMinDocFrequency
type: function
doc:
<comment>Description:</comment>
  Устанавливает частоту mltMinDoc
  
  Частота, с которой будут игнорироваться слова, которых нет, по крайней мере, в таком количестве
  документов.

<comment>Param:</comment>
  <info>int</info>  <strong>$minDocFrequency</strong>  Частота, с которой будут игнорироваться слова, которых нет, по крайней
                         мере, в таком количестве документов.

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


id: SolrQuery::setMltMinTermFrequency
type: function
doc:
<comment>Description:</comment>
  Устанавливает частоту, ниже которой выражения будут игнорироваться в исходной документации
  
  Устанавливает частоту, ниже которой выражения будут игнорироваться в исходной документации

<comment>Param:</comment>
  <info>int</info>  <strong>$minTermFrequency</strong>  Частота, ниже которой выражения будут игнорироваться в исходной
                          документации.

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


id: SolrQuery::setMltMinWordLength
type: function
doc:
<comment>Description:</comment>
  Устанавливает минимальную длину слова
  
  Устанавливает минимальную длину слова, ниже которой слова будут игнорироваться.

<comment>Param:</comment>
  <info>int</info>  <strong>$minWordLength</strong>  Минимальная длина слова, ниже которой слова будут игнорироваться

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


id: SolrQuery::setOmitHeader
type: function
doc:
<comment>Description:</comment>
  Исключает заголовок из возвращаемых результатов
  
  Исключает заголовок из возвращаемых результатов

<comment>Param:</comment>
  <info>bool</info>  <strong>$flag</strong>  <info>true</info> исключает заголовок из результата.

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


id: SolrQuery::setQuery
type: function
doc:
<comment>Description:</comment>
  Устанавливает поисковый запрос
  
  Устанавливает поисковый запрос

<comment>Param:</comment>
  <info>string</info>  <strong>$query</strong>  Поисковый запрос

<comment>Return:</comment>
  <info>SolrQuery</info>  Возвращает текущий объект SolrQuery.


id: SolrQuery::setRows
type: function
doc:
<comment>Description:</comment>
  Задаёт максимальное количество строк, возвращаемых в результате
  
  Задаёт максимальное количество строк, возвращаемых в результате

<comment>Param:</comment>
  <info>int</info>  <strong>$rows</strong>  Максимальное количество возвращаемых строк

<comment>Return:</comment>
  <info>SolrQuery</info>  Возвращает текущий объект SolrQuery.


id: SolrQuery::setShowDebugInfo
type: function
doc:
<comment>Description:</comment>
  Флаг для отображения отладочной информации
  
  Показывать ли отладочную информацию

<comment>Param:</comment>
  <info>bool</info>  <strong>$flag</strong>  Показывать ли отладочную информацию. <info>true</info> или <info>false</info>

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


id: SolrQuery::setStart
type: function
doc:
<comment>Description:</comment>
  Определяет количество пропускаемых строк
  
  Определяет количество пропускаемых строк. Полезно в разбивке на страницы результатов.

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

<comment>Return:</comment>
  <info>SolrQuery</info>  Возвращает текущий объект SolrQuery.


id: SolrQuery::setStats
type: function
doc:
<comment>Description:</comment>
  Включает или отключает компонент Stats
  
  Включает или отключает компонент Stats.

<comment>Param:</comment>
  <info>bool</info>  <strong>$flag</strong>  <info>true</info> включает компонент Stats, а <info>false</info> отключает.

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


id: SolrQuery::setTerms
type: function
doc:
<comment>Description:</comment>
  Включает или отключает TermsComponent
  
  Включает или отключает TermsComponent

<comment>Param:</comment>
  <info>bool</info>  <strong>$flag</strong>  <info>true</info> включает. <info>false</info> отключает

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


id: SolrQuery::setTermsField
type: function
doc:
<comment>Description:</comment>
  Устанавливает имя поля, из которого нужно получить выражение
  
  Устанавливает имя поля, из которого нужно получить выражение

<comment>Param:</comment>
  <info>string</info>  <strong>$fieldname</strong>  Имя поля

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


id: SolrQuery::setTermsIncludeLowerBound
type: function
doc:
<comment>Description:</comment>
  Включает нижнюю границу выражения в набор результатов
  
  Включает нижнюю границу выражения в набор результатов

<comment>Param:</comment>
  <info>bool</info>  <strong>$flag</strong>  Включает нижнюю границу выражения в набор результатов

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


id: SolrQuery::setTermsIncludeUpperBound
type: function
doc:
<comment>Description:</comment>
  Включает верхнюю границу выражения в набор результатов
  
  Включает верхнюю границу выражения в набор результатов

<comment>Param:</comment>
  <info>bool</info>  <strong>$flag</strong>  <info>true</info> or <info>false</info>

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


id: SolrQuery::setTermsLimit
type: function
doc:
<comment>Description:</comment>
  Устанавливает максимальное количество возвращаемых выражений
  
  Устанавливает максимальное количество возвращаемых выражений

<comment>Param:</comment>
  <info>int</info>  <strong>$limit</strong>  Максимальное количество возвращаемых терминов. Все выражения будут возвращены, если
               лимит отрицательный.

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


id: SolrQuery::setTermsLowerBound
type: function
doc:
<comment>Description:</comment>
  Определяет выражение, с которого нужно начинать
  
  Определяет выражение, с которого нужно начинать

<comment>Param:</comment>
  <info>string</info>  <strong>$lowerBound</strong>  Нижняя граница выражения

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


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

<comment>Param:</comment>
  <info>int</info>  <strong>$frequency</strong>  Максимальная частота

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


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

<comment>Param:</comment>
  <info>int</info>  <strong>$frequency</strong>  Минимальная частота

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


id: SolrQuery::setTermsPrefix
type: function
doc:
<comment>Description:</comment>
  Ограничивает совпадения выражениями, начинающимися с префикса
  
  Ограничивает совпадения выражениями, начинающимися с префикса

<comment>Param:</comment>
  <info>string</info>  <strong>$prefix</strong>  Ограничивает совпадения выражениями, начинающимися с префикса

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


id: SolrQuery::setTermsReturnRaw
type: function
doc:
<comment>Description:</comment>
  Вернуть необработанные символы проиндексированного выражения
  
  Если true, возвращает необработанные символы проиндексированного выражения, независимо от того,
  человекочитаемые ли они.

<comment>Param:</comment>
  <info></info>  <strong>$value</strong>  <info>true</info> or <info>false</info>

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


id: SolrQuery::setTermsSort
type: function
doc:
<comment>Description:</comment>
  Определяет, как сортировать возвращённые условия
  
  Если SolrQuery::TERMS_SORT_COUNT, сортирует термины по частоте (наибольшее количество сначала).
  Если SolrQuery::TERMS_SORT_INDEX, возвращает условия в порядке индекса

<comment>Param:</comment>
  <info>int</info>  <strong>$sortType</strong>  SolrQuery::TERMS_SORT_INDEX или SolrQuery::TERMS_SORT_COUNT

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


id: SolrQuery::setTermsUpperBound
type: function
doc:
<comment>Description:</comment>
  Устанавливает условие для остановки
  
  Устанавливает условие для остановки

<comment>Param:</comment>
  <info>string</info>  <strong>$upperBound</strong>  Условие для остановки

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


id: SolrQuery::setTimeAllowed
type: function
doc:
<comment>Description:</comment>
  Время, отведённое на поиск
  
  Время, отведённое для завершения поиска. Это значение относится только к поиску, а не к запросам в
  целом. Время в миллисекундах. Значения, меньшие или равные нулю, не предполагают ограничения по
  времени. Частичные результаты могут быть возвращены, если они есть.

<comment>Param:</comment>
  <info>int</info>  <strong>$timeAllowed</strong>  Время, отведённое для завершения поиска.

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


id: SolrResponse::getDigestedResponse
type: function
doc:
<comment>Description:</comment>
  Возвращает ответ XML как сериализованные данные PHP
  
  Возвращает ответ XML как сериализованные данные PHP

<comment>Return:</comment>
  <info>string</info>  Возвращает ответ XML как сериализованные данные PHP


id: SolrResponse::getHttpStatus
type: function
doc:
<comment>Description:</comment>
  Возвращает HTTP-статус ответа
  
  Возвращает HTTP-статус ответа.

<comment>Return:</comment>
  <info>int</info>  Возвращает HTTP-статус ответа.


id: SolrResponse::getHttpStatusMessage
type: function
doc:
<comment>Description:</comment>
  Возвращает более подробную информацию о статусе HTTP
  
  Возвращает более подробную информацию о статусе HTTP.

<comment>Return:</comment>
  <info>string</info>  Возвращает более подробную информацию о статусе HTTP


id: SolrResponse::getRawRequest
type: function
doc:
<comment>Description:</comment>
  Возвращает необработанный запрос, отправленный на сервер Solr
  
  Возвращает необработанный запрос, отправленный на сервер Solr.

<comment>Return:</comment>
  <info>string</info>  Возвращает необработанный запрос, отправленный на сервер Solr


id: SolrResponse::getRawRequestHeaders
type: function
doc:
<comment>Description:</comment>
  Возвращает необработанные заголовки запроса, отправленные на сервер Solr
  
  Возвращает необработанные заголовки запроса, отправленные на сервер Solr.

<comment>Return:</comment>
  <info>string</info>  Возвращает необработанные заголовки запроса, отправленные на сервер Solr


id: SolrResponse::getRawResponse
type: function
doc:
<comment>Description:</comment>
  Возвращает необработанный ответ с сервера
  
  Возвращает необработанный ответ с сервера.

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


id: SolrResponse::getRawResponseHeaders
type: function
doc:
<comment>Description:</comment>
  Возвращает необработанные заголовки ответа с сервера
  
  Возвращает необработанные заголовки ответа с сервера.

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


id: SolrResponse::getRequestUrl
type: function
doc:
<comment>Description:</comment>
  Возвращает полный URL-адрес, на который был отправлен запрос
  
  Возвращает полный URL-адрес, на который был отправлен запрос.

<comment>Return:</comment>
  <info>string</info>  Возвращает полный URL-адрес, на который был отправлен запрос


id: SolrResponse::getResponse
type: function
doc:
<comment>Description:</comment>
  Возвращает SolrObject, представляющий ответ XML от сервера
  
  Возвращает SolrObject, представляющий ответ XML от сервера.

<comment>Return:</comment>
  <info>SolrObject</info>  Возвращает SolrObject, представляющий ответ XML от сервера


id: SolrResponse::setParseMode
type: function
doc:
<comment>Description:</comment>
  Устанавливает режим разбора
  
  Устанавливает режим разбора.

<comment>Param:</comment>
  <info>int</info>  <strong>$parser_mode</strong>  SolrResponse::PARSE_SOLR_DOC анализирует документы в экземплярах SolrDocument.
                     SolrResponse::PARSE_SOLR_OBJ разбирает документ на SolrObjects.

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


id: SolrResponse::success
type: function
doc:
<comment>Description:</comment>
  Был ли запрос успешным?
  
  Используется для проверки успешности запроса к серверу.

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


id: SolrServerException
type: class
doc:
<comment>Description:</comment>
  Исключение, возникающее в случае возникновении ошибки на самом сервере Solr.


id: SolrServerException::getInternalInfo
type: function
doc:
<comment>Description:</comment>
  Возвращает внутреннюю информацию о том, где было выброшено исключение
  
  Возвращает внутреннюю информацию о том, где было выброшено исключение.

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


id: SolrUtils
type: class
doc:
<comment>Description:</comment>
  Содержит служебные методы для получения текущей версии модуля и подготовки фраз запроса.
  
  Также содержит метод для экранирования строк запроса и анализа ответов XML.


id: SolrUtils::digestXmlResponse
type: function
doc:
<comment>Description:</comment>
  Преобразует XML-строку ответа в SolrObject
  
  Метод преобразует XML-строку ответа с сервера Apache Solr в SolrObject. В случае возникновения
  ошибки выбрасывает исключение SolrException.

<comment>Param:</comment>
  <info>string</info>  <strong>$xmlresponse</strong>  Строка ответа XML от сервера Solr.
  <info>int</info>     <strong>$parse_mode</strong>   Используйте SolrResponse::PARSE_SOLR_OBJ или SolrResponse::PARSE_SOLR_DOC

<comment>Return:</comment>
  <info>SolrObject</info>  Возвращает SolrObject, представляющий ответ XML.
              
              Если для параметра parse_mode установлено значение SolrResponse::PARSE_SOLR_OBJ,
              документы Solr будут анализироваться как экземпляры SolrObject.
              
              Если установлено значение SolrResponse::PARSE_SOLR_DOC, они будут проанализированы как
              экземпляры SolrDocument.


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

<comment>Param:</comment>
  <info>string</info>  <strong>$str</strong>  Строка запроса, которую нужно экранировать.

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


id: SolrUtils::getSolrVersion
type: function
doc:
<comment>Description:</comment>
  Возвращает текущую версию модуля Solr
  
  Возвращает текущую версию Solr.

<comment>Return:</comment>
  <info>string</info>  Текущая версия модуля Apache Solr.


id: SolrUtils::queryPhrase
type: function
doc:
<comment>Description:</comment>
  Подготавливает фразу из неэкранированной строки запроса Lucene
  
  Подготавливает фразу из неэкранированной строки запроса Lucene.

<comment>Param:</comment>
  <info>string</info>  <strong>$str</strong>  Строка запроса Lucene.

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


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


id: SplDoublyLinkedList::IT_MODE_FIFO
type: constant
doc:
<comment>Description:</comment>
  Список будет повторяться по порядку "первым пришёл - первым вышел", как очередь.


id: SplDoublyLinkedList::IT_MODE_LIFO
type: constant
doc:
<comment>Description:</comment>
  Список будет повторяться по порядку "последним пришёл - первым вышел", как стек.


id: SplDoublyLinkedList::add
type: function
doc:
<comment>Description:</comment>
  Добавляет/вставляет новое значение по указанному индексу
  
  Вставляет значение <strong>$value</strong> по указанному индексу <strong>$index</strong>. Предыдущее значение (и все последующие),
  смещаются вверх по списку.

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

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


id: SplDoublyLinkedList::bottom
type: function
doc:
<comment>Description:</comment>
  Получает узел, находящийся в начале двусвязного списка

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


id: SplDoublyLinkedList::count
type: function
doc:
<comment>Description:</comment>
  Подсчитывает количество элементов в двусвязном списке

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


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

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


id: SplDoublyLinkedList::getIteratorMode
type: function
doc:
<comment>Description:</comment>
  Возвращает режим итерации

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


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

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


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

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


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

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


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

<comment>Param:</comment>
  <info>int</info>  <strong>$index</strong>  Проверяемый индекс.

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


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

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

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


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

<comment>Param:</comment>
  <info>int|null</info>  <strong>$index</strong>  Индекс. Если <info>null</info>, следующее значение будет добавлено после последнего элемента.
  <info>mixed</info>     <strong>$value</strong>  Новое значение для индекса <strong>$index</strong>.

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


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

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

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


id: SplDoublyLinkedList::pop
type: function
doc:
<comment>Description:</comment>
  Удаляет (выталкивает) узел, находящийся в конце двусвязного списка

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


id: SplDoublyLinkedList::prev
type: function
doc:
<comment>Description:</comment>
  Перемещает итератор к предыдущему элементу
  
  Перемещает итератор к предыдущему узлу.

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


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

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

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


id: SplDoublyLinkedList::rewind
type: function
doc:
<comment>Description:</comment>
  Возвращает итератор в начало
  
  Возвращает итератор в начало.

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


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

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

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


id: SplDoublyLinkedList::setIteratorMode
type: function
doc:
<comment>Description:</comment>
  Устанавливает режим итерации

<comment>Param:</comment>
  <info>int</info>  <strong>$mode</strong>  Существуют два ортогональных набора режимов, которые могут быть установлены:
              
              Направление итерации (одно из двух):
              
              <info>SplDoublyLinkedList::IT_MODE_LIFO</info> (Стек)
              
              <info>SplDoublyLinkedList::IT_MODE_FIFO</info> (Очередь)
              
              Поведение итератора (одно из двух):
              
              <info>SplDoublyLinkedList::IT_MODE_DELETE</info> (Элементы удаляются итератором)
              
              <info>SplDoublyLinkedList::IT_MODE_KEEP</info> (Итератор обходит элементы, не удаляя их)
              
              По умолчанию используется режим: <info>SplDoublyLinkedList::IT_MODE_FIFO</info> |
              <info>SplDoublyLinkedList::IT_MODE_KEEP</info>
              
              Направление итерации нельзя изменить для классов <class>SplStack</class> и <class>SplQueue</class>, оно всегда
              <info>SplDoublyLinkedList::IT_MODE_FIFO</info>. Попытка изменить его приведёт к выбрасыванию
              исключения <class>RuntimeException</class>.

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


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

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


id: SplDoublyLinkedList::top
type: function
doc:
<comment>Description:</comment>
  Получает узел, находящийся в конце двусвязного списка

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


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

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

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

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


