eFilter

Dmi3yy · Dmi3yy · commit b73f062aea73 · 2017-10-23T16:20:16.000+03:00
diff --git a/en/03_Extras/eFilter/01_Сниппет_eFilter.md b/en/03_Extras/eFilter/01_Сниппет_eFilter.md
@@ -0,0 +1,123 @@
+## Параметри
+
+### js
+Подключение js скриптов фильтра. Значения 0/1. По умолчанию 1.
+### css
+Подключение css стилей фильтра. Значения 0/1. По умолчанию 1.
+### sliderCssJs 
+Подключение js скриптов и css стилей  слайдер (цена). Значения 0/1. По умолчанию 1.
+### ajax
+Использовать фильтрацию без перезагрузки страницы. Значения 0/1. По умолчанию  0;
+### autoSubmit
+Автосабмит формы при изменении ее параметров
+
+### filters
+Параметр  для фильтация отбора товаров. Формат DoCLister/
+
+# tv_config
+JSON масив из конфигурацией формы фильтрации. По умолчанию поле tovarparams ресурса текущего или его родителей.
+
+
+## Плейсхолдеры
+
+### eFilter_ids
+список документов для вывода (подставляем в DocLister, это происходит автоматом в сниппете getFilteredItems)
+### eFilter_form
+форма вывода фильтра - вставить плейсхолдер в нужное место шаблона
+### eFilter_form_delete
+форма удаленые установленных фильтров
+### docid 
+Ид Категории для получения товаров. По умолчанию id текущего документа.
+### cfg
+Название файла с конфигурацие html шаблона елементов формы фильтрации. По умолчанию default.
+Имя файла должно быть в формате config.название_конфигурации.php.
+
+### delete_cfg
+Название файла с конфигурацие html шаблона елементов формы для удаление выбраних параметров фильтрации. По умолчанию default.
+Имя файла должно быть в формате config.delete.название_конфигурации.php
+
+### remove_disabled
+Скрывать неактивные варианты параметров из формы. Значения 1/0. По умолчанию 0.
+
+### nosort_tv_id 
+Список тв параметров варианты которых не нужно сортировать.
+
+
+## Конфигурация шаблона формы
+Шаблоны хранятся в файле с расширением php в переменнын.
+Основние плейсхолдеры:
+### Для обертки формы:
+    * [+url+] - удрес страницы
+    * [+wrapper+] - елементы формы.
+Для работы ajax у формы должен быть id eFiltr
+    
+
+### Для обертки параметра:
+    * [+tv_id+] id тв параметра   
+    * [+name+] Название тв параметра
+    * [+wrapper+] список вариантов.
+
+### Для елементов формы (не диапазон или слайдер):
+    * [+tv_id+] - id тв параметра.
+    * [+name+] если используем checkbox, radio или dropDown List Menu вернет текстовое значение варианта параметра.
+    * [+value+] - значение параметра
+    * [+selected+] - если выбран вариант параметра вернет checked или selected.
+    * [+disabled+] - если выбрать нельзя вернет disabled
+    * [+count+] - доступное количество товаров из вариантом параметра.
+    
+### Для елементов формы диапазон или слайдер:
+    * [+tv_id+] - id тв параметра.
+    * [+name+] если используем checkbox, radio или dropDown List Menu вернет текстовое значение варианта параметра.
+    * [+value+] - значение параметра
+    * [+selected+] - если выбран вариант параметра вернет checked или selected.
+    * [+disabled+] - если выбрать нельзя вернет disabled
+    * [+count+] - доступное количество товаров из вариантом параметра.
+    * [+minval+] - Минимальное значение выбраное пользователем
+    * [+maxval+] - Максимальное значение выбраное пользователем
+    * [+minvalcurr+] - Минимальное значение
+    * [+maxvalcurr+] - Максимальное значение
+    
+Если нужно для определьонного тв параметра указать свой шаблон необходимо создать переменную в фомате  
+ТипШабнона_ИмяПеременной.    
+Пример тв параметр frameSize, обертка tplRowCheckbox_frameSize и ссылка tplOuterCheckbox_frameSize.  
+
+
+
+## Конфигурация шаблона формы сброса фильтров
+### tplDeleteFilterForm
+Обертка формы.  
+Плейсхолдеры: 
+    * [+wrapper+] 
+### tplSliderOwner 
+Обертка блока для сброса вариантов фильтрации для диапазона или слайдера.  
+Плейсхолдеры:
+* [+wrapper+]
+* [+delete_group+] - ссылка для сброса всех вариантов фильрации тв параметра
+* [+name+] - имя тв параметра
+### tplSliderInner
+Шаблон вывода ссылки для удаление фильтра диапазона или слайдера
+* [+link+] - ссылка для сброса варианта фильтрации
+* [+min+] - минимальное значение
+* [+max+] - максимальное значение
+
+### plDeleteFilterOwner
+обертка для других блоков.
+Плейсхолдеры:
+* [+wrapper+]
+* [+delete_group+] - ссылка для сброса всех вариантов фильрации тв параметра
+* [+name+] - имя тв параметра
+
+### tplDeleteFilterInner
+вывод ссылки для сброса варианта фильтра
+* [+link+] - ссылка для сброса варианта фильтрации
+* [+name+] - значение варианта
+
+
+Если нужно для определьонного тв параметра указать свой шаблон необходимо создать переменную в фомате
+ТипШабнона_ИмяПеременной.  
+Пример тв параметр frameSize, обертка tplDeleteFilterOwner_frameSize и ссылка tplDeleteFilterInner_frameSize.
+
+
+Для работы ajax при сбросе фильтров необходимо:
+* Для общей обертки формы сброса задать клас .fltr_delete_wrap  
+* Для всех ссылок сброса задать клас .fltr_delete_item_link  
diff --git a/en/03_Extras/eFilter/02_Сниппет_eFilterResult.md b/en/03_Extras/eFilter/02_Сниппет_eFilterResult.md
@@ -0,0 +1,59 @@
+ ## eFilterResult
+ Снипеет является оберткой Doclister. Если нет выбраных тв параметров ведет себя как обычный doclister  
+ и получает товары в режыме idType = parents, если форма фильтрации не пустая то в режыме documents получая плейсхолдер  
+ из списокм ids от eFilter  
+ 
+ ## Параметры
+ ### lang
+ Язык необходимо для склонения. по умолчанию ru.
+ 
+ ### pid 
+ аналог parents 
+ 
+ Для работы ajax необходима следующая структура обертки
+ ````
+ <div id="eFiltr_results_wrapper">
+     <div class="eFiltr_loader"></div>
+     <div id="eFiltr_results">[+dl.wrap+][+pages+]</div>
+ </div>
+ ````
+ 
+ Если для eFilter задан параметр ajax = 1 то стандартная пагинация переопределяеться  
+ TplNextP ``<a data-prefix="" data-page="[+num+]">&gt;</a>``  
+ TplPrevP ``<a data-prefix="" data-page="[+num+]">&lt;</a>``  
+ TplPage ``<a data-prefix="" data-page="[+num+]" class="page">[+num+]</a>``  
+ 
+ Можна задать свои шаблоны главное вместо href использовать data-page="[+num+]"  
+ и если задан параметр id для eFilterResult  в data-prefix необходимо записать id + '_'  
+ 
+ Обертка пагинации должна иметь клас .pagination
+ 
+ ### Склонение слова Товар к количеству
+ [+параметр_id.pluarl+] Склонение слова Товар к количеству
+ Для переопределения склоняемого слова необходимо прописать параметры.
+ phrase1 Товар
+ phrase2 Товара
+ phrase3 Товаров
+ 
+ 
+ ### Подгрузка товаров через ajax
+ Пример html шаблона для блока показать ищо
+ ```
+ [!if? &is=`[+параметр_id.isstop+]:!=:1`  &then=`
+    <div class="amount eFilter_more_wrap">
+        <a data-page="[+параметр_id.pages_next+]" data-prefix="[+параметр_id.isstop+]_" class="eFilter_more">Показать ещё </a>
+    </div>
+ `]]
+ ```
+ eFilter_more_wrap Клас для обертки
+ eFilter_more Клас для ссылки
+ Если id для eFilter не задан  data-prefix пустой
+ При использование Показать еще в блоке из класом eFiltr_results должны быть только товары
+ 
+ ### Количество товаров и склонение
+ Для замены количество товаров на странице и склоняемого слова товар нужно задать класы 
+ 
+ filter_display количество товаров  
+ filter_plural склоняемое слово   
+ ```[+параметр_id.pages_next+]``` номер следующей страницы
+ 
diff --git a/en/03_Extras/eFilter/03_js_api.md b/en/03_Extras/eFilter/03_js_api.md
@@ -0,0 +1,11 @@
+## calback
+
+### afterFilterSend(msg)
+
+### afterFilterComplete(_form)
+
+beforeFilterSend(_form)
+
+
+## Внимание
+Для работы ajax форма и блок товаров не должны быть в самом корне документа тоесть body.
diff --git a/en/03_Extras/eFilter/04_Сниппет_evoSortBlock.md b/en/03_Extras/eFilter/04_Сниппет_evoSortBlock.md
@@ -0,0 +1,120 @@
+Сниппет для вывода блока с настройков сортировки и выбора количества товаров на странице.
+
+## evoSortBlock
+Сниппет для формирования блока сортировки. Из приятных вещей.
+    
+
+
+## Параметры
+1. displayConfig  настройка селекта или ссылок для указания количества товаров на странице.  
+Пример: 20||30||40||все==all.  
+2. sortConfig  настройка  ссылок для указания поля по которому товары сортируються.   
+Пример: По название==pagetitle||По индексу==menuindex||Цена от маленькой==price:asc||Цена от большой==price:desc
+3. ajax - использовать ли ajax по умолчанию ноль.
+4. changeSortByClickField - изменять направление сортировки при повторном клике по параметру сортировки. 1/0. По умолчанию 0.   
+Параметр необходим если у нас нет блока для выбора направление, а надо изменять направление при клике второй раз по параметру поля.
+
+### Шаблоны
+#### Обертка
+1. ownerTpl - Основная обертка блока.  
+    Плейсхолдеры ```[+class+] [+display.block+] [+sort.block+] [+sort.direction+]```.  
+    Пример: ```<div class="[+class+]">[+display.block+][+sort.block+]</div>```
+    
+    * class Плейсхолдер из класами для обертки которые необходимы для работы js, а именно sort-wrap и ajax
+    * display.block блок выбора количества товаров
+    * sort.block Блок выбора поля для сортировки
+    * sort.direction Блок выбора направления сортировки
+#### Выбор количества товаров
+1. displayOwnerTpl - обертка блока для выбора количества елементов на странице.  
+    Плейсхолдеры: ```[+class+]">[+wrapper+]```  
+    Пример: ```<select class="[+class+]">[+wrapper+]</select>```  
+    Пример: ```<div class="[+class+]">[+wrapper+]</div>```
+    
+2. displayRowTpl - Шаблон вывода строки. ( option для селекта или тег a для блока).  
+    Плейсхолдеры: ```[+value+],[+selected+],[+data+],[+class+],[+caption+] ```  
+    Пример: ``` <option value="[+value+]" [+selected+] >[+caption+]</option>```  
+    Пример: ``` <a [+data+] class="[+class+]">[+caption+]</a> ```  
+#### Выбор поля для сортировки   
+1. sortOwnerTpl  - обертка блока для выбора поля по которому елементы сортируються на странице.  
+    Плейсхолдеры: ```[+wrapper+]``` 
+    Пример: ```<ul>[+wrapper+]</ul>``` 
+    
+2. sortRowTpl - Шаблон вывода ссылки для выбора поля.
+        Плейсхолдеры: ```[+class+],[+data+] [+caption+]``` 
+        Пример: ```<a class="[+class+]" [+data+]>[+caption+]</a>``` 
+        
+#### Выбор направления сортировки
+1. sortDirectionTpl - обертка блока выбора направления.
+    Плейсхолдеры: ```[+up+][+down+]```
+    up - сортировка asc
+    down - сортировка desc
+2. sortDirectionUpTpl - шаблон ссылки для выбора направления сортировки asc
+    Плейсхолдеры: ```[+class+][+data+]```
+    class - css клас
+    data - Дата атрибут data-value в котором хранится текущее поле а направление сортировки asc. Пример price:asc
+3. sortDirectionDescTpl - шаблон ссылки для выбора направления сортировки desc
+    Плейсхолдеры: ```[+class+][+data+]```
+    class - css клас
+    data - Дата атрибут data-value в котором хранится текущее поле а направление сортировки asc. Пример price:desc
+    
+    
+##### Классы       
+1. displayActiveClass - Клас для активного пунка в выборе количеста елементов на странице. По умолчанию active.
+2. sortActiveClass - Клас для активного пунка в выборе поля для сортировки елементов на странице.
+3. sortUpClass - Класс для ссылки выбора поля когда сортировка от маленького к большому. По умолчанию up
+4. sortDownClass - Класс для ссылки выбора поля  когда сортировка от большого к маленькому. По умолчанию down
+5. sortFieldClass - Класс для ссылок выбора поля и направления сортировки. По умолчанию set-sort-field.
+6. sortDirectionActiveClass - Клас для активной ссылки выбраного направления сортировки. По умолчанию active.
+
+
+##### Значения по умолчаеию
+1. displayDefault - количество елементов на странице по умолчанию
+2. sortFieldDefault - поле сортировки по умолчанию
+3. sortOrderDefault - направление сортировки по умолчанию
+
+
+## Устанавливаемые плейсхолдеры для работы без eFilterResult
+ * sort_display - количество товаров
+ * sort_field - поле для сортировки
+ * sort_order - направление сортировки
+Также если использовать снипет без eFilter необходимо подключить js файл eFilter.js вручную.
+А товары обернуть в обертку eFilterResult
+```
+    <div id="eFiltr_results_wrapper">
+        <div class="eFiltr_loader"></div>
+        <div id="eFiltr_results">
+        </div>
+    </div>
+    ```
+
+
+## Логика работы js.
+### Для выбора количества товаров.
+Обрабатывается клик по елементу из класом set-display-field.
+Если это тег a ( ссылка ) и событие click то информация про количество берется из дата атрибута.
+Если это событие change информация берется из атрибута value елмента option.
+Дале ajax запрос из параметром sortDisplay и значением.
+Если ajax отклчен то обновление страницы.
+
+### Для выбора поля и направления сортировки.
+Обрабатывается клик по елементу из класом set-sort-field.
+Если это тег a ( ссылка ) и событие click то информация про поле и направление берется из дата атрибута.
+Если это событие change информация берется из атрибута value елмента option.
+Дале ajax запрос из параметром sortBy и значением.
+Если ajax отклчен то обновление страницы.
+
+
+
+
+##### Пример
+    [!evoSortBlock?
+        &ownerTpl=`<div  class="sorting-block__filters [+class+]"><form action="#">[+display.block+][+sort.block+]</form></div>`
+        &displayOwnerTpl=`<div class="sorting-block__filters-amount"><span class="sorting-block__filters-label">Показывать:</span><div class="sorting-block__select"><div class="inline-select"><select class="decor-select js-select[+class+]">[+wrapper+]</select></div></div></div>`
+        &sortOwnerTpl=`<div class="sorting-block__filters-type"><span class="sorting-block__filters-label sorting-block__filters-label--type">Сортировать:</span><div class="sorting-block__filters-block"><span class="sorting-block__filters-mobile-active"><span class="sorting-block__filters-mobile-active-inner">По популярности</span></span><ul class="sorting-block__filters-list">[+wrapper+]</ul></div></div>`
+        &sortRowTpl=`<li class="sorting-block__filters-item"><a href="#"  [+data+] [+selected+]  class="sorting-block__filters-link [+class+]">[+caption+]</a></li>`
+        &sortActiveClass=`is-active`
+        &sortConfig=`Название==pagetitle||Дата поступления==menuindex||Цена==price`
+        &ajax=`1`
+    !]
+    
+    
diff --git a/en/03_Extras/eFilter/05_Модуль_eFilter.md b/en/03_Extras/eFilter/05_Модуль_eFilter.md
@@ -0,0 +1,3 @@
+Модуль для удобной настройки форм фильтрации.
+Слева дерево документов, категории берутся по параметру шаблон категорий из настроек eList.
+В корне должен быть ресурс из шаблоном указаним в параметре обезательно.
diff --git a/en/03_Extras/eFilter/index.md b/en/03_Extras/eFilter/index.md

Original file line number	Diff line number	Diff line change
`@@ -0,0 +1,3 @@`
	`1`	`+Модуль для удобной настройки форм фильтрации.`
	`2`	`+Слева дерево документов, категории берутся по параметру шаблон категорий из настроек eList.`
	`3`	`+В корне должен быть ресурс из шаблоном указаним в параметре обезательно.`