| Имя параметра |
Значение параметра и комментарии |
id |
ID одного из вариантов оформления меню, которые можно найти в разделе меню администратора Навигация \ Варианты оформления меню.
Это обязательный параметр. Без него плагин вернёт пустой результат.
|
blocks |
Количество блоков, на которые нужно разбить меню.
По умолчанию: 1.
Допускаются целые положительные числа.
|
inblock |
Количество элементов в блоке.
Допускаются целые положительные числа.
Доступен, если не задан blocks.
|
fixblocks |
Фиксировать ли блоки.
Доступны только следующие варианты:
on - фиксировать (по умолчанию)off - не фиксировать
Влияет на выравнивание коротких меню: например, если в списке всего 4 записи и inblock:3, то при fixblocks:off в обоих блоках будет по 2 записи, а при fixblocks:on в первом блоке будет 3 записи, а во втором 1.
|
types |
Список типов записей, которые нужно отобразить.
По умолчанию - все типы контента.
Если нужно отобразить записи только некоторых типов, то ID типов нужно указать через запятую. Список доступных типов можно найти в разделе меню администратора Справочники \ Типы. Этот раздел доступен только при наличии в комплекте поставке Zion Pub Hub или Zion Catalog.
Также доступны следующие варианты, которые нельзя перечислять через запятую (только один из вариантов, несочетающийся ни с одним другим вариантом):
tabs - Вкладки (доступен при наличии в комплекте поставки ZIon Catalog)elements - Элементы (доступен при наличии в комплекте поставки ZIon Catalog)langs - Языки (доступен только наличии в комплекте поставки ZIon Multi-Lang)delivery - Способы доставки (доступен при наличии в комплекте поставки ZIon Catalog)transcomp - Транспортные компании (доступен при наличии в комплекте поставки ZIon xDelivery)payment - Способы оплаты (доступен при наличии в комплекте поставки ZIon Catalog)orders - Заказы активного пользователя (доступен при наличии в комплекте поставки ZIon Catalog)inorders - Товары в заказе активного пользователя (доступен при наличии в комплекте поставки ZIon Catalog)users - Зарегистрированные пользователи (доступен при наличии в комплекте поставки ZIon User Control)balans - История баланса активного пользователя (доступен при наличии в комплекте поставки ZIon Catalog и Zion User Control)chats - Чаты активного пользователя (доступен при наличии в комплекте поставки ZIon Chat)inchats - Сообщения в чате активного пользователя (доступен при наличии в комплекте поставки ZIon Chat)
Несочетающиеся значения не доступны при select:last.
|
select |
Указание на то, по какому принципу нужно выбирать записи, которые будут отображаться в меню.
Может быть заполнено значением из переменной GET[select]. При этом обязательно должна присутствовать переменная GET[menu], равная значению параметра id.
Для отображения контентных единиц доступны варианты:
children - "потомки" - непосредственные подразделы, указанного в factor раздела (по умолчанию)children-all - "все потомки" - все подразделы, указанного в factor раздела (если все подразделы имеют один и тот же тип, то для крупных сайтов рекомендуется использовать не children-all, а all с указанием нужных типов в types - это сильно снизит нагрузку на БД)all - все записи с учётом других параметров фильтрации (это рекомендуемая замена для варианта children-all, который может сильно снижать производительность на крупных сайтах)brothers - "братья" - записи с тем же место в структуре, что и указанный в factor разделparents - "предок и его братья" - надраздел, указанного в factor раздела и указанного в level уровня, а также другие разделы с тем же местом в структуреpath - "путь" - список надразделов от верхнего уровня в структуре до указанного в factor раздела (полезно, например, для создания так называемых "хлебных крошек")linked - "связи" - только те записи, с которыми связана указанная в factor записьbacklinks - "обратные связи" - только те записи, которые связаны с указанной в factor записьюlink4user - "связанные с пользователем" - только те записи, с которыми связан указанный в factor пользовательlist - "список" - только те записи, ID которых перечислены через запятую в includelast - "последние" - последние записи, просмотренные данным посетителем сайта (в этом режиме сортировка всегда ведётся от последней просмотренной записи к первой)basket - "корзина" - только те записи, которые помещены в корзину для заказов (доступен только при наличии в комплекте поставки ZIon Catalog)
Для отображения вкладок доступны варианты (при наличии в комплекте поставки ZIon Catalog):
all - все вкладкиlinked - "связи" - только те вкладки, на которых есть элементы указанной в factor контентной единицы (по умолчанию)list - "список" - только те вкладки, ID которых перечислены через запятую в include
Для отображения элементов контента доступны варианты (при наличии в комплекте поставки ZIon Catalog):
all - все элементы контента, в том числе и недоступные для указанной в factor контентной единицы (рекомендуется для организации сравнения)linked - "связи" - все элементы контента, доступные для указанной в factor контентной единицы (по умолчанию)ontabs - "на вкладках" - только те элементы контента, которые расположены на указанных в tabs вкладках указанной в factor контентной единицыlist - "список" - только те элементы контента, ID которых перечислены через запятую в include
Из списка элементов автоматически исключается htmlsource (HTML-код веб-страницы). Чтобы исключить зацикливание, следует в include указывать те элементы, из которых может производится вызов плагинов, например, maintext (Основной текст).
Для отображения языков доступен вариант (при наличии в комплекте поставки ZIon Multi-Lang):
all - все доступные языки (по умолчанию)
Для отображения пользователей доступны варианты (при наличии в комплекте поставки ZIon User Control):
all - все пользователи (по умолчанию)list - "список" - только те пользователи, ID которых перечислены через запятую в include
Для отображения истории баланса доступен вариант (при наличии в комплекте поставки ZIon Catalog и Zion User Control):
Для отображения способов доставки доступен вариант (при наличии в комплекте поставки ZIon Catalog):
all - все доступные способы доставки
Для отображения транспортных компаний доступен вариант (при наличии в комплекте поставки ZIon xDelivery):
all - все доступные траспортные компании
Для отображения способов оплаты доступен вариант (при наличии в комплекте поставки ZIon Catalog):
all - все доступные способы оплаты
Для отображения списка чатов доступны варианты (при наличии в комплекте поставки ZIon Chat):
all - все чаты активного пользователя (по умолчанию)new - только чаты активного пользователя, в которых есть непрочитанные сообщения
Для отображения сообщений в чате доступны варианты (при наличии в комплекте поставки ZIon Chat):
all - все сообщения из указанного в factor чата (по умолчанию)new - только непрочитанные сообщения из указанного в factor чата
|
search |
Если этот параметр задан, то производится поиск указанного в данном параметре текста
Рекомендации:
select - в большинстве случаев должен быть равен all, но доступны и другие вариантыfactor - желательно явно указать, если select не равен all- чтобы автоматически подставить в
search или в любое другое место искомый текст, используйте команду {plugin:current_SearchText}
Не доступен при несочетающихся вариантах types.
Не доступен при select:path и при select:list.
|
search-cols |
Указание на то, в каких столбцах производить поиск.
Поля отделяются друг от друга запятыми, (без пробелов и других символов)
Если в подсказке к полю указано {content_name}, то здесь укажите name и т.п.
Список полей проверяется. Некорректные исключаются. Если после проверки не останется ни одного корректного поля, то будет подставлено значение по умолчанию:
id,name,seo_title,seo_description,seo_keywords,maintext_value = ID, название, основные SEO-параметры, основной текст
Доступно при непустом search.
|
bigdata |
Указание на то, планируется ли обработка большого количества данных.
- Для небольших списков лучше не использовать, так как эффект от оптимизации может быть обратным
Доступны только следующие варианты:
on - оптимизироватьoff - НЕ оптимизировать (по умолчанию)
При types:elements всегда равно on
Не доступен при types:tabs и при types:users
|
level |
Уровень, разделы которого нужно вывести.
Доступен при select:parents.
По умолчанию - 0 - непосредственный надраздел и его "братья"
Допускаются целые числа
Если level больше уровня раздела, указанного в factor, то select:parents меняется на select:children, а factor становится равным ID "предка" уровня (level-1)
|
factor |
Указание на то, для какого раздела или для какого места в структуре, для какого заказа, для какого чата и т.п. нужно отобразить меню.
Доступны следующие варианты:
- ID любого раздела, например
factor:contacts (при select:children отобразит подразделы такого раздела)
. (например, factor:.)
- "верхний уровень" - при
select:children отобразит все разделы, для которых место в структуре равно (верхний уровень)
- Пустое значение (например,
factor:)
- "вне структуры" - при
select:children отобразит все разделы, для которых место в структуре равно (вне структуры)
- По умолчанию - ID открытого в данный момент раздела
- При
types:inorders - ID заказа (может принимать значения из GET[order]). Данный заказ должен быть доступен для текущего пользователя (и для администраторов). Возможно при наличии в комплекте поставки ZIon Catalog.
- При
types:inchats - ID чата (может принимать значения из GET[chat]). Данный чат должен быть доступен для текущего пользователя (иначе будет произведена переадресация на список чатов). Возможно при наличии в комплекте поставки ZIon Chat.
Также доступен вариант {content_id} - автоматически подставляемое ID раздела.
Если вызов плагина Menu производится из HTML-кода веб-страницы или из любого другого элемента данной контентной единицы, то вместо {content_id} будет подставлено ID данной контентной единицы.
Если вызов плагина Menu вызывается также из плагина Menu (например, если в надменю нужно вызвать подменю, то для вызова подменю указывайте factor:{content_id}). В этом случае соответствующее ID контентной единицы будет подставлено для каждого пункта надменю.
Доступно использование любых других свойств (не только контента)
|
fellLinks |
При любом непустом значении будет выделять, как активные, те записи, которые связаны с открытой записью.
Внимание! Так как активными (а также следующими после активных и предыдущими для активных) в этом случае могут считаться сразу несколько записей, порядок которых заранее неизвестен, использование данного параметра может привести к одновременному и многократному срабатыванию условий IS_NEXT??истина::ложь и IS_PREV??истина::ложь, что невозможно во всех других случаях. Используйте данный параметр с данными условиями на свой страх и риск! |
tabs |
ID вкладок, перечисленные через запятую, для указанной в factor контентной единицы, для которой нужно отобразить список элементов контента.
Это обязательный параметр при types:elements;select:ontabs
Доступен при types:elements и select:ontabs.
|
hidden |
Указание на то, стоит ли отображать скрытые записи.
- Скрытыми контентными единицами считаются записи без адреса.
- Скрытыми элементами контента считаются записи с пустым, нулевым или незаполненным значением.
Доступны следующие варианты:
show - показыватьhide - скрывать (по умолчанию)
При types:elements доступен, если select:ontabs или select:list. При select:list, если например в include указаны stringfield_5,number_3, то на заполненность будут проверяться поля stringfield_5_value и number_3_value - то есть поля, имена которых заканчиваются на _value. |
include |
Список ID записей, которые нужно добавить в меню.
При указании этого параметра в меню будут включены дополнительные пункты (если они существуют).
При отсутствии значения оно может быть заполнено значением из переменной GET[include]. При этом обязательно должна присутствовать переменная GET[menu], равная значению параметра id.
Если эти пункты уже есть в меню, дублирование не произойдёт.
Недоступен при types:orders, types:inorders, types:balans, types:chats и types:inchats.
Это обязательный параметр при select:list.
По умолчанию записи, добавленные через include, добавляются в конец списка. Чтобы это изменить, используйте параметр include-sort со значением, отличающимся от значения по умолчанию.
|
exclude |
Список ID записей, которые нужно исключить из меню.
На этот параметр влияют ограничения прав доступа: в него добавляется список всего, к чему нет доступа у текущего пользователя или его группы.
Этот параметр имеет больший приоритет по сравнению с include.
|
notzero |
Отображать только записи с ненулевыми значениями в указанном поле
Например:
notzero:stringfield_15_value - будут показаны только записи, у которых в поле stringfield_15_value не равно 0
Полезно использовать, например, для отображения только тех, товаров, для которых указана цена
|
positive |
Отображать только записи с положительными значениями в указанном поле
Например:
positive:number_10_value - будут показаны только записи, у которых в поле number_10_value больше 0
Полезно использовать, например, для отображения только товаров в наличии
|
checked |
Отображать только записи, у которых отмечена соответсвущая галочка
Например:
checked:checkbox_23_value - будут показаны только записи, у которых в поле checkbox_23_value равно on (отмечено)
Можно использовать не только для галочек, но и для любых полей, где может быть значение on.
|
cookie |
Имя массива куков
Список элементов из этого массива будет добавлен к include.
Доступен при select:list.
|
hidecopies |
Имя массива куков, в котором должны храниться имена контентных единиц, для которых нужно скрывать те элементы, значения которых не отличаются от значений тех же элементов у других контентных единиц в том же массиве (полезно для реализации, например, сравнения товаров)
Игнорируется, если в этом массиве есть только один элемент
Доступен при types:elements.
|
inlist |
Максимальное количество записей, которые нужно вывести в списке.
По умолчанию - 0 - все найденные записи
Допускаются целые неотрицательные числа
|
listing |
Указание на то, стоит ли отображать список подстраниц
Доступны следующие варианты:
show - всегда показыватьhide - всегда скрыватьauto - скрывать, если нет необходимости отображать (по умолчанию)
В режиме auto будет отображаться только, если подстраниц больше, чем одна. Иначе будет скрываться.
|
subpage |
Номер активной подстраницы
При отсутствии значения оно может быть заполнено значением из переменной GET[subpage]. При этом обязательно должна присутствовать переменная GET[menu], равная значению параметра id.
По умолчанию - 1 - первая подстраница
Допускаются целые положительные числа
|
maxsubpages |
Максимально допустимое количество подстраниц в пагинации
При отсутствии или при некорректном значении отображаются все подстраницы.
Допускаются целые положительные числа
|
random |
Количество случайных элементов из найденного списка, которые нужно отобразить в случайном же порядке.
По умолчанию - 0 - не использовать случайную выборку, а отобразить все элементы в обычном порядке.
Допускаются целые неотрицательный числа
|
userbrowser |
Веб-браузер посетителя, под который должна быть сделана оптимизация.
Если не указан (по умолчанию), то браузер определяется автоматически.
Доступны только следующие варианты:
Opera - классический OperaChrome - Google Chrome или другой браузер на движке Chromium (в т.ч. Яндекс.Браузер и новые Opera и Edge)Internet Explorer - Microsoft Internet Explorer или другой браузер на движке TridentFirefox - Mozilla Firefox или другой браузер на движке GeckoSafari - Apple Safati или другой браузер на движке WebKitOther - другой браузер
|
content-type |
Позволяет изменить тип контента в заголовках, передаваемых веб-сервером.
По умолчанию передаётся тип контента text/html
Внимание: при указании альтернативного типа контента, дробную черту / нужно менять на дефис -
Например:
application-xml - если нужен тип контента application/xml
|
charset |
Позволяет изменить набор (кодировку) символов в заголовках, передаваемых веб-сервером.
По умолчанию передаётся кодировка windows-1251
Внимание: кодировка применяется ко всему выводимому контенту! Помимо указания заголовка производится конвертация из кодировки windows-1251 в кодировку, указанную в данном параметре!
При content-type:application-xml рекомендуется использовать кодировку utf-8
|
filter |
Использовать ли фильтр.
Доступны следующие варианты:
on - использоватьoff - не использовать (по умолчанию)
При on можно использовать массив переменных GET[filter]. Например, если в адресной строке указано...?filter[name]=Тест&filter[type]=pages..., то из найденных с помощью других параметров записей в списке будут отображены только записи, у которых поле name равно значению Тест, а поле type равно значению pages.
Если нужна проверка не на равенство, а на соответствие другим условиям, то дополнительно нужно использовать массив переменных GET[filterFunc], В котором имена переменных должны быть такими же, как в GET[filter], а значения должны соответствовать одной из функций сравнения. Например, если в адресной строке указано...?filter[price]=100&filterFunc[price]=more..., то из найденных с помощью других параметров записей в списке будут отображены только записи, у которых поле price больше значения 100.
Доступны следующие функции:
equal - равно (по умолчанию)!equal - неравно - больше или меньшеmore - большеless - меньше!more - не больше - меньше или равно!less - не меньше - больше или равноbetween - между - больше, чем одно значение, и меньше, чем другое значение. При этом в GET[filter] должны быть указаны два значения, через ;. Например, ...?filter[price]=100;500&filterFunc[price]=between...range - диапазон - равно или больше, чем одно значение, и равно или меньше, чем другое значение. При этом в GET[filter] должны быть указаны два значения, через ;. Например, ...?filter[price]=100;500&filterFunc[price]=range...substring - подстрока (например, в строке розовый слон будет найдена подстрака слон или подстрока роз и т.п.)
Элементы GET[filter] массивов и GET[filterFunc] могут быть заменены значениями из элементов массивов POST[filter] и POST[filterFunc] с соответсвующими ключами.
Не доступен при types:tabs и types:elements.
Не доступен при select:list, select:new и select:path.
Количество элементов в массиве GET[filter] не ограничено, но многие веб-серверы и веб-браузеры не (корректно) выполняют очень длинные GET-запросы.
|
|
datefrom_...
|
Показывать только записи с датой равной или более поздней, чем указанная временная метка.
У одной контентной единицы может быть несколько полей с датой. У каждого такого поля есть свой номер. Возможна фильтрация по любому из них - достаточно просто указать его номер вместо ...
Пример временной метки текущего времени (29.11.2024 13:28:33): 1732876113
По умолчанию - 0 - отображать все записи.
Не доступен при select:path и select:list.
Не доступен при несочетающихся вариантах types.
|
dateto_... |
Аналогично datefrom_... - показывать только записи с датой равной или более ранней, чем указанная временная метка.
По умолчанию - 0 - отображать все записи.
Не доступен при select:path и select:list.
Не доступен при несочетающихся вариантах types.
|
year_... |
Показывать только записи с датой в указанном году.
У одной контентной единицы может быть несколько полей с датами. У каждого такого поля есть свой номер. Возможна сортировка по любому полю с датой - достаточно просто указать его номер вместо ...
По умолчанию - 0 - отображать все записи.
year_... имеет больший приоритет, чем datefrom_... и dateto_... - по сути переопределяет оба эти параметра.
Не доступен при select:path и select:list.
Не доступен при несочетающихся вариантах types.
|
month_... |
Показывать только записи с датой в указанном месяце.
По умолчанию - 0 - отображать все записи.
Если при наличии этого параметра параметр year_... пуст, то ему будет присвоен текущий год.
Не доступен при select:path и select:list.
Не доступен при несочетающихся вариантах types.
|
day_... |
Показывать только записи с датой в указанном дне месяца.
По умолчанию - 0 - отображать все записи.
Если при наличии этого параметра параметр month_... пуст, то ему будет присвоен текущий месяц.
Не доступен при select:path и select:list.
Не доступен при несочетающихся вариантах types.
|
sort |
Указание на то, как следует сортировать найденные записи.
Доступны следующие варианты:
id - сортировать по ID (недоступно при types:inchats)-id - сортировать по ID в обратном порядке (недоступно при types:inchats)name - сортировать по названию (недоступно при types:balans, types:orders, types:chats и types:inchats)-name - сортировать по названию в обратном порядке (недоступно при types:balans, types:orders, types:chats и types:inchats)date - сортировать по дате (доступно при types:balans, types:chats или types:inchats)-date - сортировать по дате в обратном порядке (доступно при types:balans, types:chats или types:inchats)fields - сортировка по указанному в sort-fields списку полейnone - сортировать на основе положения в базе данных (по умолчанию)-none - сортировать на основе положения в базе данных в обратном порядке (рекомендуется для новостей, статей и т.п.)
При select:linked и select:backlinks доступны варианты сортировки по возрастанию по следующим столбцам из таблицы связей:
id - ID связиfromid - ID связывающейся записиtoid - ID связываемой записиreason - причина связиinfo - информация о связиprice - цена связиdescription - описание связи
Также доступна сортировка контента по полям с датой (при наличии в комплекте поставки ZIon Pub Hub):
У одной контентной единицы может быть несколько полей с датой. У каждого такого поля есть свой номер. Возможна сортировка по любому из них - достаточно просто указать его номер в команде sort:date_... или sort:-date_... (в обратном порядке).
Если сортировка по дате недоступна, то sort:date_... будет изменено на sort:none, а sort:-date_... будет изменено на sort:-none, где ... - любой доступный номер поля с датой.
Аналогично выше описанной сортировке по датам возможна сортировка по датам, как ежегодных событий (при наличии в комплекте поставки ZIon Pub Hub):
Полезно, например, для отображения дней рождения или других праздников
В этом случае в место sort:date_... нужно написать sort:yearly_..., где ... - любой доступный номер поля с датой. Такая сортировка в обратном порядке не предусмотрена.
Значение данного параметра может быть изменено на значение из COOKIE[sort][ID меню], где ID меню равно значению параметра id.
В свою очередь в COOKIE[sort][ID меню] значение может быть записано, если одновременно в GET[sort] указано какое-либо корректное значение, а в GET[menu] указано значение параметра id.
Значение в COOKIE[sort][ID меню] будет сброшено, если одновременно в GET[sort] указано пустое значение, а в GET[menu] указано значение параметра id. При этом параметр sort будет изменён на значение по умолчанию.
Любая сортировка не доступна при select:path, select:list, select:last и types:elements.
По умолчанию записи, добавленные через include, добавляются в конец списка. Чтобы это изменить, используйте параметр include-sort со значением, отличающимся от значения по умолчанию.
|
include-sort |
Сортировать или нет записи, добавленные через include
Доступны только следующие варианты:
begin - записи будут добавлены в начало списка в том порядке, в котором они указаны в includeend - записи будут добавлены в конец списка в том порядке, в котором они указаны в include (по умолчанию)sort - записи, указанные в include, будут отсортированы также, как все остальные записи в списке
Любая сортировка не доступна при select:path, select:list, select:last и types:elements.
|
sort-fields |
Указание на то, по каким полям необходимо сортировать список.
Доступно указание нескольких полей через запятую, например, name,stringfield_2_value,number_5_value. Порядок полей имеет значение.
Если в подсказке к полю указано {content_name}, то здесь укажите name и т.п.
Если нужна сортировка в обратном порядке по тому или иному полю, то перед его названием нужно указать символ -. Например, -number_5_value.
Значение данного параметра может быть изменено на значение из COOKIE[sort-fields][ID меню], где ID меню равно значению параметра id.
В свою очередь в COOKIE[sort-fields][ID меню] значение может быть записано, если одновременно в GET[sort-fields] указано какое-либо корректное значение, а в GET[menu] указано значение параметра id.
Значение в COOKIE[sort-fields][ID меню] будет сброшено, если одновременно в GET[sort-fields] указано пустое значение, а в GET[menu] указано значение параметра id. При этом параметр sort будет изменён на значение по умолчанию.
|
sort-numbers |
Указание на то, какие поля при сортировке нужно считать числами.
Без использования этого параметра в некоторых случаях в результате сортировки вместо списка вида, 1, 2, 3, 10, 20, 100 может получиться список вида 1, 10, 100, 2, 20, 3.
Доступно указание нескольких полей через запятую, например, name,
stringfield_2_value,number_5_value. Порядок полей имеет значение.
Если в подсказке к полю указано {content_name}, то здесь укажите name и т.п.
Учитывается при использовании sort-fields.
|
reason |
При установлении связи между контентными единицами можно указать (выбрать из списка или добавить) причину связи.
Использование этого параметра позволяет отобразить связанные записи только с указанной причиной связи.
Помимо указания одной из причин также доступны следующие варианты:
!exists - будут отображены только те связи, для которых указана любая (не "пустая") причина!notexists - будут отображены только те связи, для которых причина не указана (указана "пустая" причина)- Пустое или не указанное значение (по умолчанию) - будут отображены все связи с учётом других параметров фильтрации.
Доступен при select:linked и select:backlinks и только для списков контента
|
