Wayfinder для ModX Revo

Опубликовано: 25 Апр 2014

Wayfinder– это сниппет, который выводит список ссылок на ресурсы в дереве сайта. Обычно используется для формирования разгнообразных меню

Параметры  Wayfinder

Параметр

Описание

По умолчанию

Пример

&startId

Отправная точка (ID документа) для вывода списка документов. Используйте 0, если надо вывести все документы из корня сайта.

Id текущего документа

&startId=`0`

&displayStart

Показать начальную папку, указанную в startId

0

 

&displayStart=`1`

&level

Глубина (количество уровней) для построения меню.  '0' Проходит через все уровни.

0

 

&level=`3`

&limit

Максимальное число пунктов меню

0

 

&limit=`5`

&ignoreHidden

Игнорируем флажек  "Показывать в меню"

0

 

&ignoreHidden=`1`

&ph

Имя плейсходера для в который будет выведен результат.

0

 

&ph=`wf_menu`

&debug

Устанавливается в 1 ", чтобы включить режим отладки для дополнительного устранения неполадок.

0

 

&debug=`1`

&hideSubMenus

Установите '1 ', чтобы выводить только активные подменю.

0

 

&hideSubMenus=`1`

&removeNewLines

Устанавливается в 1, чтобы удалить символы "новой строки" из вывода,  т. е. весь результирующий код будет в виде одной строки.

0

 

&removeNewLines=`1`

&textOfLinks

Поле, чтобы измениь название ссылки. Возможные значения: menutitle, id, pagetitle, description, parent, alias, longtitle, introtext

menutitle

 

&textOfLinks=`longtitle`

&titleOfLinks

Поле, изменить title ссылки. Возможные значения:  menutitle, id, pagetitle, description, parent, alias, longtitle, introtext

pagetitle

 

&textOfLinks=`longtitle`

&rowIdPrefix

Добавлять префикс к идентификатору (id) для каждого элемента. Значение будет rowIdPrefix + docId.

0

 

&rowIdPrefix=``

&useWeblinkUrl

Когда установлено в 1, то вывод ссылки в плейсхолдер wf.link

1

 

&useWeblinkUrl=`1`

&includeDocs

Разделенный запятыми список id, которые будут включены в меню.

 

 

&includeDocs=`5,6,7`

&excludeDocs

Разделенный запятыми список id, которые необходимо исключить из меню.

0

 

&excludeDocs=`6,7,8`

&cacheResults

Кэш запросов для более быстрой загрузки  (добавлено в 2.2.0-rc1)

   

&cacheTime

Число секунд для хранения кэшированных меню, если cacheResults является 1. Установите 0, чтобы хранить неопределенное время, пока кэш не будет очищено вручную.

3600

 

&contexts

Если Вы используете контексты на сайте. По умолчанию в текущем контексте. (добавлено в  2.2.0-rc1)

в текущем контексте

&contexts=`web`

&startIdContext

(добавлено в 2.2.0-rc1)

   

&config

Внешний файл PHP для настройки Wayfinder (default | breadcrumb | cssplay-basicdropdown | cssplay-dropdown | cssplay-dropline | cssplay-flyout | cssplay-flyoutrev | cssplay-upmenu | mollio | slidingdoors)

default

 

&config=`breadcrumb`

&scheme

Формат URL, как генерировать. Возможные значения (на основе  makeURL API вызова):

  • -1 : (Значение по умолчанию) URL является относительным к site_url
  • 0 : см. http
  • 1 : см. https
  • full :URL является абсолютным, начинаются с site_url от конфигурации
  • abs : URL является абсолютным, начинаются с base_url от конфигурации
  • http : URL является абсолютным, forced to http схеме
  • https : URL является абсолютным, forced to https схеме 
     (добавлено в 2.3.1-pl)

-1

 

&sortBy

Какое поле для сортировки, например 'published'

 

 

&sortBy=`pagetitle`

&sortOrder

Сортировка, по порядку или против, 'ASC' или 'DESC'

 

 

&sortOrder=`DESC`

&where

JSON стиль параметр фильтрации. Например, когда пытаются скрыть блоге или новости из аддона Статьи:  &where=`[{"class_key:!=": "Article"}]`

   

&hereId

Определить текущее  ID для использования сниппета. Используйте значение  если шаблон указанный в hereTpl и activeRowParentTpl не работают правильно.

iterated ID

&hereId=`DESC`

&hereTpl

Шаблон hereTpl используется, когда текущий элемент отображается в меню.

   

 

Простой вызов: