eFilter

KO | EN

gitlite — search

#hacktoberfest #ai #android #deep-learning #docker #java #awesome #cli #kubernetes #vue #awesome-list #mcp #ios #open-source

(★ 16)

Фильтрация ресурсов по TV. MODxEvo

eFilter 최신버젼 다운로드

최종 버전 다운로드 (.zip)

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

### author webber (web-ber12@yandex.ru)

### набор eFilter - автоматическое построение фильтров товаров в MODx Evo (версия 0.1)

### DONATE
---------
если считаете данный продукт полезным и хотите отблагодарить автора материально,
либо просто пожертвовать немного средств на развитие проекта - 
можете сделать это на любой удобный Вам электронный кошелек 
Яндекс.Деньги 410011544038803 
Webmoney WMR: R133161482227 
Webmoney WMZ: Z202420836069 
с необязательной пометкой от кого и за что именно :)

### содержит:
- модуль eLists - для удобного формирования списков значений ТВ (чтобы не захламлять дерево и визуально понятно их редактировать)
- плагин tovarParams - для показа в админке при редактировании товара только тех параметров, которые заданы для данной категории товаров
- набор сниппетов для формирования формы и проведения фильтрации

### обязательные дополнительные компоненты (без их установки решение не работает):
- сниппет DocLister
- компонент multiTV

### автоматическая установка
Найдите в Extras сниппет eFilter (версия 0.1) и нажмите установить. 
При этом создадутся все необходимые элементы и связи между ними: 
- модуль eLists 
- сниппеты (eFilter, eFilterResult, multiParams, tovarParams, getSortBlock, iFilter) 
- плагины eFilterHelper, iFilterIndexHelper, iFilterSeo 
- TV tovarparams 
Переходим к пункту "Настройка"

### ручная установка
1. установить необходимые компоненты (модуль, плагин, сниппеты). Также скопировать конфигурацию для multiTV (\assets\tvs\multitv\configs\tovarparams.config.inc)
2. создать специальный TV с именем tovarparams, описание - Параметры товара, тип ввода - CustomInput, возможные значения @INCLUDE assets/tvs/multitv/multitv.customtv.php и присвоить этот tv всем шаблонам-категориям товара
3. создать шаблон для вывода товара
4. Включить 'общие' параметры в настройках модуля и добавить зависимости
==Plugins==
tovarParams
==Snippets==
eFilter
eFilterResult
multiParams
tovarParams

### настройка

Первичная настройка производится в конфигурации модуля eLists. Его параметры - общие для всего компонента, импортирутся в другие элементы встроенными средствами "общие параметры" EvolutionCMS автоматически при установке компонента 
**ID TV параметров товара tovarparams** - вписываем сюда id нашего созданного при установке tv tovarparams 
**ID шаблонов товара** - перечисляем через запятую id шаблонов "Товар" 
**ID категории параметров** - ID категории, в которой будут храниться все tv, в которых задаются параметры товара (размер, цвет, материал и т.п.). ТВ-параметры из данной категории, которые не перечислены в настройках фильтра, будут скрыты для дочерних товаров в административной панели. 
**ID категории общих параметров** - ID категории ТВ-параметров, которые могут участвовать в фильтрации, но которые не нужно скрывать, если они не указаны. Например, цена, бренд и другие параметры, которые есть у всех товаров 
**Не включать ТВ в параметры при выводе** - - т.к. изначально в списке параметров будут выведены все параметры для данного типа товара из категории "Параметры товара", то можно его проредить, убрав ненужные ТВ (например цена, наличие и другие общие параметры для всех товаров которые можно вывести отдельно) 
**Имя чанка вывода товара** - имя чанка вывода товара в список (используется вместо задания &tpl) 
**Папка паттернов** - папка для хранения паттернов (фильтрация по типу "паттерн") 
**ID TV, используемого для связки товар-категории через tagSaver** - если вы используете для создания тегов плагин tagSaver и хотите, чтобы товары участвовали в фильтрации по притегованной категории - введите сюда id tv, которые обрабатываются плагином tagSaver 
**Обработка индексного значения перед сохранением (статический метод принимающий value,tvid,contentid)** - позволяет подменить индексируемое значение для iFilter (например при индексации параметра площадь нам необходимо использовать в фильтре диапазон). Возвращает нужное значение, которое попадет в индекс и будет использоваться при построении фильтра.

### плагин iFilterIndexHelper
обеспечивает дополнительную возможность ручной переиндексации. Выводит кнопку "Индексировать" в ресурсе указанного id. Дополнительно на событии OnDocFormSave обновляет дату изменения ресурса (можно отключить).

### параметры вызова сниппета iFilter

в стандартном режиме устанавливает следующие плейсхолдеры:

**eFilter_ids** - список id подходящих под фильтр ресурсов 
**eFilter_form** - html формы фильтрации 
**eFilter_ids_cnt, eFilter_ids_cnt_ending** - данные о количестве найденных (словоформы из параметра endings) 
**eFilterSeoValues** - json с информацией для использования в режиме seoUrls 
**eFilterTime** - технический, время отработки фильтрации

В скобках - значение по-умолчанию. 
**api** - вернуть результат работы сниппета в режиме api (false - ничего не возвращает, устанавливает плейсхолдеры) 
**apiFormat** - (json) json/array . Используется совместно с api=1 
**ajax** - (0 - не использовать) фильтрация в режиме ajax 
**ajaxMode** - (1 - перезагрузка формы и результатов) 1/2 в режиме 2 происходит только перезагрузка формы (для показа количества найденных результатов), а перегрузка результатов - по клику на кнопку
**autoSubmit** - (1, да) автосабмит формы в режиме ajax 
**reloadForm** - (1, да) перезагрузка формы в режиме ajax , можно отменить 
**changeState** - (1, да) - изменять url при изменении фильтра в режиме ajax

**activeBlockClass** - класс активного (в котором выбрано хотя бы одно значение) блока в фильтре (default=active) 
**seoUrls** - (false, не использовать). 1 - использовать при фильтрации режим ЧПУ (beta) 
**choices** - (false, не использовать). 1 - показывать выбранные варианты в отдельном блоке в режиме ЧПУ (alpha) 
**disableDefaultSlider** - (false). 1 - отключить подключение скриптов и стилей слайдера noUI (чтобы использовать полностью свою обработку для фильтра типа "слайдер") 
**skipSliderCss** - (false). 1 - отключить подключение стилей слайдера noUI (чтобы использовать свой для фильтра типа "слайдер") 
**skipSliderJs** - (false). 1 - отключить подключение скриптов слайдера noUI (чтобы использовать свой для фильтра типа "слайдер") 
**disableDefaultScript** - (false). 1 - отключить исходный jquery-скрипт (чтобы использовать вместо него другой)

**endings** - ('товар,товара,товаров') - используется в плейсхолдере eFilter_ids_cnt_ending для вывода статистики результатов поиска (например, "найдено 15 товаров") 
**submitPage** - (false - используется текущая страница). ID страницы для сабмита формы, если она не совпадает с текущей и со страницей фильтрации заданной в docid 
**submitDocPage** - (false - используется страница из docid). 1- использовать для сабмита формы адрес из $_SERVER['REQUEST_URI'] (например, для страниц с кастомными роутами, не совпадающих с docid) 
**docid** ($modx->documentIdentifier) - текущая страница, для которой производить обработку фильтров и результатов. 
**formMethod** - (get)
**btnText** - (Найти) - текст на кнопке формы фильтрации
**removeDisabled** - (false). 1 - удалять в фильтре варианты, для которых нет разультатов (по-умолчанию они остаются с атрибутом и классом disabled) 
**setIntervalValues** -(false). 1 - показывать в форме начальное и конечное значение в полях фильтра типа "интервал" 
**singleCheckboxTitle** - (в наличии) - подпись чекбокса для типа фильтра "одиночный чекбокс" 
**patternFolder** - (assets/images/pattern/). Адрес с папкой изображений для типа фильтра "паттерн" 
**nosortTvId** - (false). Список tv id через запятую либо all, для которых применяется в выводе фильтра сортировка "как в админке" (для элементов, заданных вручную либо сниппетом multiParams). По-умолчанию сортировка возможных значений идет по алфавиту (для чисел - по возрастанию) 
**sortByCountTvId** - (false). 1 - сортировать в выводе формы фильтра значения по убыванию количества доступных товаров 
**parents** - ($modx->documentIdentifier). ID категории, чьи ресурсы обрабатывать (как родителя, как мультикатегорию) 
**showParent** - (0 - в фильтрации участвуют только конечные ресурсы isfolder=0). 1 - ресурсы-папки участвуют в фильтрации 
**prepareBefore** - (empty). Статический класс для обработки массива id всех ресурсов, подлежащих фильтрации (полученных на основе docid/parents). Возвращает новый массив id 
**cacheLifetime** - (3600). Время жизни кэша для списка id категории (задается для ускорения фильтрации, создается при заходе в посетителя в категорию). 
**useMultiCategories** - (false). ! - использовать не только дочерние ресурсы категории, но и ресуры, привязанные через мультикатегории. 
**fp** - (empty). Позволяет задать/переопределить параметры фильтрации из глобального массива $_GET['f']. Может передаваться как массив либо json 
**filterConfig** - (empty). Позволяет задать/переопределить параметры фильтрации из tv tovarparams для активной категории 
**ttl** - (0). Если задан данный параметр, при индексации происходит проверка наличия измененных документов за указанный промежуток времени. Может использоваться при запуске каждые 10 минут php assets/snippets/eFilter/cron.php ttl=600 (чтобы переиндексация происходила только если есть измененные за последние 10 минут ресурсы) 
**cfg** - (default). Папка с шаблонами для вывода элементов формы фильтрации (относительно assets/snippets/eFilter/tpl/)

### пример вызова сниппета eFilter
[!eFilter!] [+eFilter_form+] 
Данный сниппет, используя заданную для конкретной категории конфигурацию фильтра формирует форму и результаты фильтрации. Сама форма устанавливается в плейсхолдер [+eFilter_form+] и может быть выведена в любом месте шаблона (но обязательно после вызова фильтра). 
А результаты фильтрации выводятся сниппетом для вывода результатов eFilterResult - о нем чуть позднее.

### дополнительные параметры вызова сниппета eFilter

&ajax=`1` - необходимо работать в режиме ajax (default 0)
 &ajaxMode=`2` - 1 - перезагрузка и формы и результатов в режиме ajax, 2 - перегружается только форма, а результаты обновляются только после ручного сабмита формы (default 1)
 &autoSubmit=`0` - автоматический сабмит формы при каждом изменении (default -1)
 &changeState=`0` - изменение url при каждом ajax-запросе (default 1)
 &docid - страница, для которой формируется фильтр (default - текущая страница)
 &cfg - название конфига для вывода фильтра из папки configs (по-умолчанию - default и соответственно конфиг с именем config.default.php)
 &removeDisabled=`1` - удалять из формы варианты, для которых нет результатов (default - 0)
 &btnText - текст на кнопке формы (по-умолчанию "Найти")
 &hideZero=`1` - скрывать ли цифру 0 в вариантах, где ничего не найдено (default - 0)
 &nosortTvId - перечень tv, для которых в выводе формы не нужно применять сортировку (по-умолчанию варианты сортируются "по алфавиту" - для строк, и "по возрастанию" - для значений, распознанных как числовые)
 &sortByCountTvId - список id tv для которых необходимо применять при выводе сортировку по количеству доступных вариантов (допустимые значения - список id через запятую либо all - применять для всех)
 &sortByCountDynamic - изменять порядок вывода значений после каждого выбора так, чтобы поддерживать сортировку по количеству доступных вариантов (допустимое значение - 1)
 &DLFilterType=`tv` - тип применяемого DocLister фильтра (default tvd)
 &endings - список из тре слов для plural через запятую (по-умолчанию 'товар,товара,товаров')
 &cntTpl - шаблон для вывода надписи о количестве найденных в форму (по-умолчанию 'Найдено: [+cnt+] [+ending+]')
 &tvConfig - конфиг tovarparams для формирования фильтра (по-умолчанию берется конфиг текущей категории либо первый непустой конфиг родителя)
 &fp - массив для передачи данных запроса на фильтрацию (по-умолчанию используется массив $_GET)
 &submitDocPage=`1` - сабмит формы будет произведен на страницу, заданную в docid
 &submitPage=`25` - id страницы, на которую нужно сабмитить форму (имеет приоритет перед submitDocPage)
 &allowZero=`1` - разрешает 0 в значениях чекбокса
 &useRegexp=`1` - только для сильных духом:)
 &commaAsSeparator=`all`||&commaAsSeparator=`1,2,3` - распознавать запятую как разделитель значений для всех TV (all) либо только для указанных по id (1,2,3)
 &useMultiCategories=`1` - используется плагин MultiCategories для прикрепления товара к множественным категориям
 &evobabel=`1` - для использования переводов evoBabel для названий значений, названий фильтров и категорий фильтров
 &blang=`1` - для использования переводов bLang для названий значений, названий фильтров и категорий фильтров
 &translator=`myCustomTranslator::translate` - для использования собственного переводчика (передается 2 параметра - строка для перевода и значение по-умолчанию)
 &hideSingleVariant=`1` - скрывать блок, если доступен только 1 вариант выбора

**Eсли хотим искать только по заданным документам, то до вызова [!eFilter!] устанавливаем их спискок в плейсхолдер eFilter_search_ids** 
 
в режиме ajax три callback-функции javascript
 - beforeFilterSend(_form) - исполняется до отправки состояния формы на сервер 
 - afterFilterSend(msg) - исполняется после получения ответа от сервера msg 
 - afterFilterComplete(_form) - исполняется после обновления фильтра и результатов поиска из ответа на сервере 
 
js-события (вызывать $(document).on("before-efilter-send") ...
 - "before-efilter-send", [ _form, updateAll ] - перед отправкой данных на сервер 
 - "before-efilter-update", [ msg, _form, updateAll ] - при получении данных с сервера перед вставкой на страницу 
 - "after-efilter-update", [ msg, _form, updateAll ] - после вставки новых данных на страницу 
 - "after-efilter-change-state", [ state ] - после изменения url в адресной строке 
 
### пример вызова сниппета eFilterResult - для вывода результатов фильтрации (выведет в том числе и пагинацию)

[!eFilterResult? &parents=`[*id*]` &depth=`3` &paginate=`pages` &display=`15` &tvList=`image,price`!]

в данном сниппете используется DocLister, собственно, параметры вызова аналогичны.
        В чанке вывода товара в список &tpl плейсхолдер [+params+] будет заменен на список установленных для данной категории товаров параметров товара
        В параметре &tvList=`image,price` включаем нужные параметры из других категорий, а также общих tv-параметров для всех видов товаров

### полезно
В нужном месте шаблона вывода товара (он у нас общий для всех видов товаров) помещаем вызов сниппета [[tovarParams]] для вывода нужного списка нужных ТВ из категории "Параметры товара" (id этой категории задан в модуле и он важен для всей работы).

### Сотрудничество:
---------
По вопросам сотрудничества обращайтесь на электронный ящик web-ber12@yandex.ru

eFilter

eFilter 최신버젼 다운로드

오늘의 추천 프로젝트

Was this content helpful?

Recent Feedback

eFilter

eFilter 최신버젼 다운로드

오늘의 추천 프로젝트

Was this content helpful?

Recent Feedback

Download README