Класс yii\sphinx\MatchBuilder

Все классы | Свойства | Методы | Константы

Наследование	yii\sphinx\MatchBuilder » yii\base\Object
Реализует	yii\base\Configurable
Доступна с версии	2.0.6
Исходный код	https://github.com/yiisoft/yii2-sphinx/blob/master/MatchBuilder.php

MatchBuilder строит выражение MATCH SphinxQL на основе спецификации, заданной объектом yii\sphinx\MatchExpression.

См. также:

Общедоступные свойства

Свойство	Тип	Описание	Определено в
$db	yii\sphinx\Connection	Подключение к Sphinx.	yii\sphinx\MatchBuilder

Защищенные свойства

Свойство	Тип	Описание	Определено в
$matchBuilders	массив	Карта ключевых слов MATCH к методам-строителям. Эти методы используются методом buildMatch() для построения выражения MATCH из синтаксиса массива.	yii\sphinx\MatchBuilder
$matchOperators	массив	Карта операторов MATCH. Эти операторы используются для замены развернутых операторов.	yii\sphinx\MatchBuilder

Общедоступные методы

Метод	Описание	Определено в
__call()	Вызывает именованный метод, который не является методом класса.	yii\base\Object
__construct()	Конструктор.	yii\sphinx\MatchBuilder
__get()	Возвращает значение свойства объекта.	yii\base\Object
__isset()	Проверяет, установлено ли свойство, т.е. определено и не равно null.	yii\base\Object
__set()	Устанавливает значение свойства объекта.	yii\base\Object
__unset()	Устанавливает свойство объекта в значение null.	yii\base\Object
build()	Генерирует выражение MATCH из объекта yii\sphinx\MatchExpression.	yii\sphinx\MatchBuilder
buildAndMatch()	Подключает два или более выражений MATCH с помощью оператора `AND` или `OR`.	yii\sphinx\MatchBuilder
buildHashMatch()	Создает MATCH на основе пар столбец-значение.	yii\sphinx\MatchBuilder
buildIgnoreMatch()	Создает игнорируемые выражения MATCH.	yii\sphinx\MatchBuilder
buildMatch()	Создает выражение MATCH.	yii\sphinx\MatchBuilder
buildMultipleMatch()	Создает выражения MAYBE, SENTENCE или PARAGRAPH.	yii\sphinx\MatchBuilder
buildProximityMatch()	Создает выражения PROXIMITY.	yii\sphinx\MatchBuilder
buildSimpleMatch()	Создает выражения MATCH, такие как `"column" operator value`.	yii\sphinx\MatchBuilder
buildZoneMatch()	Создает выражения MATCH для зон.	yii\sphinx\MatchBuilder
canGetProperty()	Возвращает значение, указывающее, можно ли прочитать свойство.	yii\base\Object
canSetProperty()	Возвращает значение, указывающее, можно ли установить свойство.	yii\base\Object
className()	Возвращает полное имя этого класса.	yii\base\Object
hasMethod()	Возвращает значение, указывающее, определен ли метод.	yii\base\Object
hasProperty()	Возвращает значение, указывающее, определено ли свойство.	yii\base\Object
init()	Инициализирует объект.	yii\base\Object

Защищенные методы

Метод	Описание	Определено в
buildMatchColumn()	Создает столбец как строку для выражения MATCH.	yii\sphinx\MatchBuilder
buildMatchValue()	Создает заполнитель для выражения MATCH.	yii\sphinx\MatchBuilder
parseParams()	Возвращает фактическое выражение MATCH, подставив значения параметров в соответствующие заполнительные метки.	yii\sphinx\MatchBuilder

Константы

Константа	Значение	Описание	Определено в
PARAM_PREFIX	':mp'	Префикс для автоматически сгенерированных параметров привязки запроса.	yii\sphinx\MatchBuilder

Подробности свойств

$db общедоступное свойство

Подключение к Sphinx.

public yii\sphinx\Connection $db = null

$matchBuilders защищенное свойство

Карта ключевых слов MATCH к методам-строителям. Эти методы используются методом buildMatch() для построения выражения MATCH из синтаксиса массива.

protected array $matchBuilders = ['AND' => 'buildAndMatch', 'OR' => 'buildAndMatch', 'IGNORE' => 'buildIgnoreMatch', 'PROXIMITY' => 'buildProximityMatch', 'MAYBE' => 'buildMultipleMatch', 'SENTENCE' => 'buildMultipleMatch', 'PARAGRAPH' => 'buildMultipleMatch', 'ZONE' => 'buildZoneMatch', 'ZONESPAN' => 'buildZoneMatch']

$matchOperators защищенное свойство

Карта операторов MATCH. Эти операторы используются для замены развернутых операторов.

protected array $matchOperators = ['AND' => ' ', 'OR' => ' | ', 'NOT' => ' !', '=' => ' ']

Подробности методов

__construct() public method

Конструктор.

public void __construct ( $connection, $config = [] )
$connection	yii\sphinx\Connection	Подключение к Sphinx.
$config	array	Параметры, которые будут использованы для инициализации свойств объекта.

build() public method

Генерирует выражение MATCH из объекта yii\sphinx\MatchExpression.

public string build ( $match )
$match	yii\sphinx\MatchExpression	Объект yii\sphinx\MatchExpression, из которого будет сгенерировано выражение MATCH.
return	string	Сгенерированное выражение MATCH.

buildAndMatch() public method

Соединяет два или более выражений MATCH с оператором AND или OR.

public string buildAndMatch ( $operator, $operands, &$params )
$operator	string	Оператор, используемый для соединения операндов.
$operands	array	Выражения MATCH для соединения.
$params	array	Параметры выражения, которые нужно заполнить.
return	string	Выражение MATCH.

buildHashMatch() public method

Создаёт выражение MATCH на основе пар «колонка-значение».

public string buildHashMatch ( $match, &$params )
$match	array	Условие соответствия.
$params	array	Параметры выражения, которые нужно заполнить.
return	string	Выражение MATCH.

buildIgnoreMatch() public method

Создаёт игнорируемые выражения MATCH.

public string buildIgnoreMatch ( $operator, $operands, &$params )
$operator	string	Оператор, используемый для создания выражений MATCH.
$operands	array	Выражения MATCH.
$params
return	string	Выражение MATCH.

buildMatch() public method

Создаёт выражение MATCH.

public string buildMatch ( $match, &$params )
$match	string\|array	Спецификация MATCH.
$params	array	Параметры выражения, которые нужно заполнить.
return	string	Выражение MATCH.

buildMatchColumn() protected method

Создаёт колонку как строку для выражения MATCH.

protected string buildMatchColumn ( $column, $ignored = false )
$column	string	Спецификация колонки.
$ignored	boolean	Указывает, должна ли колонка быть задана как «игнорируемая».
return	string	Выражение колонки.

buildMatchValue() protected method

Создаёт заполнитель для выражения MATCH.

protected string buildMatchValue ( $value, &$params )
$value	string\|array\|yii\db\Expression
$params	array	Параметры выражения, которые нужно заполнить.
return	string	Выражение MATCH.

buildMultipleMatch() public method

Создаёт выражения MAYBE, SENTENCE или PARAGRAPH.

public string buildMultipleMatch ( $operator, $operands, &$params )
$operator	string	Оператор, используемый для создания выражений MATCH.
$operands	array	Выражения MATCH.
$params
return	string	Выражение MATCH.

buildProximityMatch() public method

Создаёт выражения PROXIMITY.

public string buildProximityMatch ( $operator, $operands, &$params )
$operator	string	Оператор, используемый для создания выражений MATCH.
$operands	array	Выражения MATCH.
$params
return	string	Выражение MATCH.

buildSimpleMatch() public method

Создаёт выражения MATCH, например, "column" operator value.

public string buildSimpleMatch ( $operator, $operands, &$params )
$operator	string	Используемый оператор. Может быть любым, например, `>`, `<=`, и т.д.
$operands	array	Содержит два имени колонок.
$params	array	Параметры выражения, которые нужно заполнить.
return	string	Выражение MATCH.
throws	yii\base\InvalidParamException	при некорректном количестве операндов.

buildZoneMatch() public method

Создаёт выражения MATCH для зон.

public string buildZoneMatch ( $operator, $operands, &$params )
$operator	string	Оператор, используемый для создания выражений MATCH.
$operands	array	Выражения MATCH.
$params
return	string	Выражение MATCH.

parseParams() protected method

Возвращает фактическое выражение MATCH путём подстановки значений параметров в соответствующие заполнитель.

защищенный строка parseParams ( $expression, $params )
$expression	строка	Строка выражения, которую нужно подготовить.
$params	массив	Параметры привязки для вставки.
возврат	строка	Обработанное выражение.

© 2008–2017 by Yii Software LLC
Licensed under the three clause BSD license.
http://www.yiiframework.com/doc-2.0/yii-sphinx-matchbuilder.html