Tagger

Теги, категории и многое другое для MODX!

Надёжная и производительная система управления тегами. Кратко о возможностях:

1. Протестировано с миллионом тегов
2. Постраничный выпадающий список и автодополнение для удобного ввода тегов
3. Типы ввода: combo-box или tag-field
4. Неиспользуемые теги можно автоматически удалять из базы данных
5. Создание тегов можно ограничить CMP, а не полем ввода
6. Для ввода можно использовать облако Auto-Tag

Вывод и списки: все теги, теги из указанных групп, без неиспользуемых тегов, ресурсы с заданным тегом и т.д. Поставляет getResources условие &where, поэтому все возможности шаблонизации и сортировки getResources доступны вам.

Установка¶

Установите через Менеджер пакетов или скачайте пакет из репозитория MODX Extras.

Tagger FURL сейчас не работают при расширениях ресурсов (.html и т.п.), кроме /. Смените расширение на / хотя бы у ресурса, на котором вызывается сниппет TaggerGetResourcesWhere.

• Content -> Content Types -> HTML (.html) -> /

Группы¶

После установки настройте группы. Группы представляют поля, которые добавятся на панель ресурса. Откройте меню «Компоненты», найдите Tagger и перейдите на вкладку Groups. Добавьте новую группу.

**ПРЕДУПРЕЖДЕНИЕ** Убедитесь, что alias группы не совпадает с alias ресурса. Иначе ресурс с таким alias станет недоступен.

ПАРАМЕТРЫ ГРУППЫ:

Изменение подписей мест Tagger¶

В системных настройках пространства имён Tagger доступны ключи: tagger.place_in_tab_label, tagger.place_tvs_tab_label, tagger.place_above_content_label, tagger.place_below_content_label, tagger.place_bottom_page_label

Значение можно задать текстом или ключом лексикона. Для разных подписей по шаблону ресурса используйте такую запись:

1==Label For Template with ID 1||2==Label For Template with ID 2

Подпись по умолчанию: tagger.tab.label

Базовое использование¶

TaggerGetTags¶

Сниппет выводит теги для ресурса(ов), группы(групп) или все теги.

СВОЙСТВА:

ПЛЕЙСХОЛДЕРЫ ВЫВОДА И ПРИМЕРЫ ЗНАЧЕНИЙ:

[[+id]] => 1
[[+tag]] => News
[[+alias]] => news
[[+group]] => 3
[[+group_id]] => 3
[[+group_alias]] => mediatype
[[+group_name]] => Media Type
[[+group_field_type]] => tagger-combo-tag
[[+group_allow_new]] => 0
[[+group_remove_unused]] => 0
[[+group_allow_blank]] => 1
[[+group_allow_type]] => 0
[[+group_show_autotag]] => 0
[[+group_show_for_templates]] => 21
[[+cnt]] => 1
[[+uri]]
[[+idx]] = Number starting from one for each tag
[[+active]] => 1 (1/0 based on if current tag is active or not)

Чтобы плейсхолдер [[+active]] показывал корректное состояние, вызывайте сниппет TaggerGetTags без кэша.

ПРИМЕРЫ ИСПОЛЬЗОВАНИЯ:

// Get tags for all resources, including unused tags
[[TaggerGetTags? &showUnused=`1`]]
// Get tags from groups 1 and 3 for all resources
[[TaggerGetTags? &groups=`1,3` &rowTpl=`tag_links_tpl`]]
// Get tags for current resource
[[!TaggerGetTags? &resources=`[[*id]]` &rowTpl=`tag_links_tpl`]]
// Get tags for current resource in getResources tpl
[[!TaggerGetTags? &resources=`[[+id]]` &rowTpl=`tag_links_tpl`]]

Как переводить группы¶

Допустим, есть группа с именем Tags и alias tags. Чтобы перевести имя и/или описание, создайте записи лексикона в нужном формате.

• Откройте управление лексиконами
• Выберите пространство имён Tagger и тему custom
• Добавьте запись с ключом tagger.custom."group_alias" (в этом примере tagger.custom.tags)
• Для перевода описания добавьте запись с ключом tagger.custom."group_alias"_desc (в этом примере tagger.custom.tags_desc)
• Чтобы использовать переводы на фронтенде, вызовите TaggerGetTags с &translate=1 ([[TaggetGetTags? &translate=1]]). Появятся плейсхолдеры group_name_translated и group_description_translated

TaggerGetResourcesWhere¶

Сниппет формирует SQL-запрос для условия WHERE в getResources.

СВОЙСТВА:

ПРИМЕР ИСПОЛЬЗОВАНИЯ:

[[!getResources?
    &where=`[[!TaggerGetResourcesWhere?
    &tags=`Books,Vehicles`
    &where=`{"isfolder": 0}`]]`
]]

TaggerGetCurrentTag¶

Сниппет выводит группы и теги из параметров текущего запроса. Всегда вызывайте его без кэша: он читает значения из $_GET.

СВОЙСТВА:

ПЛЕЙСХОЛДЕРЫ ШАБЛОНОВ:

// tagTpl
[[+tag]]
[[+label]]
[[+alias]]
[[+uri]] => The URL contains all the tags of the current request, excluding the one of this template
[[+group_name]] => Name of the group the tag belongs to
[[+group_alias]] => Alias of the group the tag belongs to

// groupTpl
[[+name]] => Group name
[[+alias]] => Group alias
[[+multipleTags]] => Whether this group has more than 1 active tag
[[+tags]] => The markup of the active tags of this group

// outTpl
[[+groups]] => The markup of all the active groups

ПРИМЕР ИСПОЛЬЗОВАНИЯ:

[[!TaggerGetCurrentTag?
    &tagTpl=`@INLINE [[+label]]`
    &groupTpl=`@INLINE <li>[[+name]]: [[+tags]]</li>`
    &outTpl=`@INLINE <ul>[[+groups]]</ul>`
    &tagSeparator=`, `
]]

TaggerGetRelatedWhere¶

Сниппет возвращает связанные ресурсы с тем же тегом. Формирует SQL-условие для свойства WHERE в вызове getResources.

СВОЙСТВА:

Внутри сниппет вызывает TaggerGetResourcesWhere, поэтому доступны и его свойства (кроме &tags и &where, которые задаёт код).

ПРИМЕР ИСПОЛЬЗОВАНИЯ:

// Lists all the resources with the same parent, that share at least one tag from the group 1 with the current resource.
[[getResources?
    &where=`[[TaggerGetRelatedWhere? &groups=`1`]]`
    &parents=`[[*parent]]`
    &tpl=`@INLINE <li>[[+pagetitle]]</li>`
    &tplWrapper=`@INLINE <ul>[[+output]]</ul>`
    &limit=`0`
]]