Набор фильтров

Набор описывает один фильтр каталога: какие товары в него входят, какие фильтры, диапазоны и сортировки показывать, нужен ли поиск. Наборов может быть сколько угодно — например, свой у каждого магазина или раздела. Каждый набор — файл <имя>.json в папке наборов (core/components/bitfacet/data/sets/) и свой индекс.

Редактируется на вкладке «Наборы фильтров»: «Создать набор» или карандаш у набора. В окне — вкладки «Товары», «Фильтры», «Диапазоны», «Сортировки», «Поиск» и «JSON» (весь набор текстом, там же редкие настройки). После сохранения индекс пересобирается сам.

Имя набора — латиница в нижнем регистре, цифры, «-» и «_», до 64 символов: catalog, shop-2.

Источники полей

Каждый фильтр берёт значения из поля, записанного как префикс:поле. Все доступные поля с подписями — вкладка «Источники».

ПрефиксОткудаПримеры
res:поля ресурсаres:parent (раздел и все его предки), res:template, res:pagetitle, res:publishedon, res:menuindex
tv:TV по имениtv:color. Несколько значений (checkbox, listbox-multiple, tag) делятся по «||», подписи — из «Возможных значений» вида Красный==red
ms:товар MiniShop3ms:price, ms:old_price, ms:article, ms:stock, ms:vendor (производитель), ms:color, ms:size, ms:tags, ms:new, ms:popular, ms:categories (дополнительные категории)
opt:опции MiniShop3opt:material — ключ опции
var:модификации (ms3Variants)var:price, var:count, var:sku, опции модификаций
sql:ваши таблицыблок sql набора — см. «Для разработчиков»

Из чего состоит набор

БлокЧто задаёт
resourcesКакие ресурсы — товары: class_keys (классы, например MiniShop3\Model\msProduct), templates (id шаблонов), parents (id разделов — берутся все потомки), contexts, unpublished (включать неопубликованные; на сайте они всё равно не видны). Пусто — без ограничения.
facetsФильтры-списки: ключ — поле источника, значение — настройки (можно []).
numbersДиапазоны «от/до»: числа и даты.
sortsСортировки: имя → {"field": "ms:price", "label": "Цена"}. Как сравнивать (числа или строки), определяется по полю; задать вручную — "kind": "number" или "string".
searchТекстовый поиск: поля с весами и синонимы.
variantsМодификации товаров (ms3Variants).
sql, providersСвои таблицы и свои PHP-источники — «Для разработчиков».
batchСколько товаров читать из базы за один запрос при сборке (по умолчанию 1000; меньше — меньше памяти).

Пример: магазин на MiniShop3

{
    "resources": {
        "class_keys": ["MiniShop3\\Model\\msProduct"],
        "parents": [5]
    },
    "facets": {
        "section":    {"type": "tree", "from": ["res:parent", "ms:categories"], "label": "Раздел"},
        "ms:vendor":  {"label": "Бренд", "alias": "brand", "order": "count", "show": 10},
        "ms:color":   {"label": "Цвет"},
        "ms:size":    {"label": "Размер", "order": "manual", "values_order": ["xs", "s", "m", "l", "xl"]},
        "ms:instock": {"type": "bool", "from": ["ms:stock"], "label": "В наличии"},
        "opt:material": {"label": "Материал", "collapsed": true}
    },
    "numbers": {
        "ms:price": {"label": "Цена", "step": 100}
    },
    "sorts": {
        "price": {"field": "ms:price", "label": "Цена"},
        "title": {"field": "res:pagetitle", "label": "Название"},
        "new":   {"field": "res:publishedon", "label": "Новизна"}
    },
    "search": {
        "fields": {"ms:article": 5, "res:pagetitle": 3, "ms:vendor": 2, "res:introtext": 1},
        "synonyms": {"кроссовки": ["кеды", "сникерсы"]}
    }
}

Пример: каталог на TV, без MiniShop3

{
    "resources": {"templates": [4], "contexts": ["web"]},
    "facets": {
        "section":   {"type": "tree", "from": ["res:parent"]},
        "tv:brand":  {"label": "Производитель"},
        "tv:fuel":   {"label": "Топливо"},
        "tv:options": {"label": "Комплектация", "type": "multi", "mode": "and"}
    },
    "numbers": {
        "tv:power": {"label": "Мощность, кВт", "step": 1},
        "res:publishedon": {"label": "Дата", "type": "date"}
    },
    "sorts": {"title": {"field": "res:pagetitle", "label": "Название"}}
}

Товары — ресурсы с шаблоном 4. "mode": "and" у «Комплектации»: показываются товары, у которых есть все отмеченные пункты.

Настройки фильтра

Редактор набора пишет их сам; во вкладке JSON — то же самое.

КлючЗначение
labelНазвание фильтра на сайте.
aliasИмя в адресе: "alias": "brand" → /katalog/brand-nike/. По умолчанию — часть ключа после «:» (ms:color → color).
typefacet — одно значение у товара, multi — несколько, bool — да/нет, tree — дерево разделов; у диапазонов number или date. По умолчанию — из источника.
fromСписок полей-источников, если ключ фильтра — своё имя: "from": ["res:parent", "ms:categories"].
modeor (по умолчанию) — товар подходит, если у него есть любое из отмеченных значений; and — все сразу. «and» имеет смысл у полей с несколькими значениями (теги, свойства).
orderПорядок значений: пусто — как в источнике, alpha — по алфавиту, count — по числу товаров во всём каталоге, manual — свой (values_order).
values_orderСвой порядок — ключи значений. Удобнее задать на вкладке «Значения» перетаскиванием.
showСначала показать N значений, остальные — под «Показать все (M)». 0 — все.
collapsedtrue — группа свёрнута, пока в ней ничего не выбрано.
stepУ диапазона: шаг полей «от/до», подсказки с границами округляются до него.
labels, merge, hideСвои подписи, объединение и скрытие значений — пишет вкладка «Значения».
Если правите файл набора вручную (не в админке), пересоберите индекс: «Обзор» → «Пересобрать» или php core/components/bitfacet/cli/rebuild.php <набор>.

Значения: дубли, опечатки, подписи

Данные в магазине редко бывают чистыми: «Nike», «NIKE», «Найк». Вкладка «Значения» показывает все значения фильтра с числом товаров:

Данные товаров не меняются — правила хранятся в наборе:

"ms:vendor": {
    "merge":  {"nike inc": "nike", "найк": "nike"},
    "hide":   ["без бренда"],
    "labels": {"nike": "Nike"}
}

Ключи значений — как в индексе: без пробелов по краям, в нижнем регистре.

Поиск

Блок search включает поле поиска в фильтре. fields — где искать и вес поля (чем больше, тем выше в выдаче), synonyms — синонимы, работают в обе стороны.

Ищутся все слова запроса сразу; учитываются окончания (куртки = куртка), начало последнего слова (крас → красный), транслит (kurtka), неверная раскладка (rehnrf), опечатки и синонимы. Найденное сужает фильтр, счётчики считаются по найденному, сортировка по умолчанию — по релевантности.

Вкладка «Поиск»: проверка любого запроса и журнал запросов посетителей; у запроса без результатов — синоним одной кнопкой.

Модификации (ms3Variants)

Если у товаров есть модификации (размер, цвет, цена у каждой), добавьте блок variants и фильтры из полей var::

"variants": {"pseudo": true},
"facets":  {"var:size": {"label": "Размер"}, "var:color": {"label": "Цвет"}},
"numbers": {"var:price": {"label": "Цена"}}

Все условия по модификациям выполняются у одной модификации: «размер M + красный» найдёт товар, только если есть красная модификация размера M. Сортировка по var:price — по минимальной цене модификаций. pseudo — товар без модификаций считается одной модификацией из своих полей (цена, остаток, артикул, опции). Таблицы ms3Variants по умолчанию — ms3_product_variants и ms3_variant_options; другие — в variants.config (меняет только sudo).

Обновление индекса. ms3Variants не вызывает события MODX при правке модификаций и списании их остатка, поэтому плагин обновления об этих изменениях не узнаёт: они попадут в индекс при ближайшей пересборке — вручную на вкладке «Индекс» или автоматически по расписанию (крон, не реже чем раз в bitfacet.rebuild_max_age часов). Если модификации меняются часто, уменьшите rebuild_max_age. Совместимость проверена с ms3Variants 1.0.2-beta.