MODX Tickets настройки, документация

Tickets — довольно интересное и бесплатное дополнение для MODX на котором можно сделать раздел с вопросами-ответами, форму комментариев, блог и много другое.

Основные возможности MODX Tickets

• Создание особых разделов для тикетов в админке, со своим интерфейсом.
• Создание тикетов в админке, тоже со своими панелями и табами.
• Создание страниц с фронтенда.
• Редактирование страниц с фронтенда, с проверкой прав.
• Ajax-комментарии.
• Редактирование / удаление комментариев с админки.
• Права доступа на добавление страниц в раздел и создание комментариев.
• Собственное кэширование тикетов.
• Принудительная фильтрация тикетов при выводе на экран [mask_link href=»https://modstore.pro/packages/content/jevix» target=»_blank»]Jevix[/mask_link].
• Автоматическая установка и настройка Jevix при инсталляции пакета. 2 набора параметров, раздельно для тикетов и комментариев.
• Довольно удобный редактор [mask_link href=»http://markitup.jaysalvat.com/home/» target=»_blank»]MarkItUp[/mask_link] для тикетов и комментариев.
• Почтовые уведомления о комментариях автору тикета, и тем, кому ответили на его комментарий.
• Вывод последних комментариев и тикетов, с разбивкой по разделам и возможностью кэширования.
• Все нужные чанки оформления, прописанные параметры у сниппетов, 2 языка — русский и английский.

Установить Tickets можно из репозитория modstore.

Документация по сниппетам

[[!pdoPage?
    &element=`getTickets`
]]

[[!+page.nav]]

[[!getTicketsSections?]]

TicketComments

Выводит комментарии и форму для комментирования ресурса.

Может использоваться с любым документом MODX Сниппет вызывается некэшированным

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

Примеры

• Стандартный вызов сниппета

[[!TicketComments?]]

• Вызов сниппета с комментариями для неавторизированных пользователей

[[!TicketComments? &allowGuest=`1`]]

TicketForm

Выводит форму для создания тикета пользователем из фронтэнда. *Сниппет вызывается не кэшированным.

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

Способы вызова

[[!TicketForm?]]

Примеры использования валидатора FormIt

Возможно использование параметра validate по аналогии как он применяется в компоненте FormIt. Компонент FormIt должен быть установлен. Примеры описаны ниже.

Интеграция с FormIt

При наличии установленного компонента FormIt возможно использовать валидацию входных данных по тем же правилам. Компонент FormIt не находится в зависимостях компонента Tickets. При необходимости использования этого функционала Вы должны установить FormIt самостоятельно.

Правила использования

Валидация доступна для сниппетов TicketForm (создание/редактирование тикета), TicketComments (написание комментария). Валидация будет использоваться при указании полей в параметре сниппета validate. Возможно указание собственных валидаторов через параметр customValidators и собственных текстов для ошибки. Все существующие правила валидации FormIt можно найти на официальной странице документации компонента.

Для вывода сообщения об ошибке в одном div-е с проверяемый полем должен находится элемент **** для вывода ошибки

    <div class="form-group">
        <label for="ticket-pagetitle">[[%ticket_pagetitle]]</label>
        <input type="text" class="form-control" placeholder="[[%ticket_pagetitle]]" name="pagetitle" value=""
               maxlength="50" id="ticket-pagetitle"/>
        <span class="error"></span>
    </div>

Либо элемент может находиться в произвольной месте HTML-разметки с уникальным id вида имя_поля-error

    <span class="error" id="content-error"></span>

Примеры использования

• Использование пользовательского валидатора для цензурирования

Создаётся сниппет с именем mycensore

<?php
    $success = !preg_match_all('~(путин|трамп|розенбаум)~ui',$value,$match);
    if (!$success) {
        $validator->addError($key,'В тексте заявки обнаружены непотребные слова');
    }
    return (bool)$success;

Сниппет TicketForm вызывается с параметрами. В чанке tpl.myTicket для формы добавлены например собственные поля date, email, username, которые также валидируются стандартными правилами из FormIt.

{'!TicketForm' | snippet: [
    'customValidators'=>'mycensore',
    'validate'=>'date:required:isDate=^%m/%d/%Y^,
        email:email:required,
        username:required:islowercase,
        pagetitle:required:contains=^Hello^,
        content:minLength=^50^:mycensore',
    'content.vTextMinLength' => 'Содержимое заявки должно быть не короче 50 знаков',
    'tplFormCreate'=>'tpl.myTicket'
]}

• Цензурирование пользовательских комментариев

{'!TicketComments' | snippet: [
    'allowGuest' => 1,
    'autoPublishGuest' => 0,
    'customValidators'=>'mycensore',
    'validate'=>'text:minLength=^20^:mycensore',
    'text.vTextMinLength' => 'Комментарий должен быть не короче 20 знаков',
]}

TicketLatest

Выводит ленту последних созданных и\или прокомментированных тикетов.

*Сниппет вызывается не кэшированным.

Параметры

*Список может быть расширен общими параметрами [mask_link href=»https://docs.modx.pro/komponentyi/pdotools/obshhie-parametryi» target=»_blank»]pdoTools[/mask_link] так как Tickets работает на этой библиотеке.

Примеры

• Вывод последних тикетов

[[!TicketLatest? &limit=`5` &fastMode=`1` &action=`tickets` &tpl=`tpl.Tickets.ticket.latest`]]

• Вывод последних комментариев

[[!TicketLatest? &limit=`5` &fastMode=`1` &action=`comments` &tpl=`tpl.Tickets.comment.latest`]]

TicketMeta

Выводит информацию о текущем тикете, так же позволяет голосовать за тикет на его собственной странице. С версии 1.4.0 Сниппет может использоваться с любыми ресурсами MODX

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

Примеры вызова

• Стандартный вызов сниппета

[[!TicketMeta?]]

• Что бы посмотреть все доступные стандартные плейсхолдеры

[[!TicketMeta? &tpl=``]]

subscribeAuthor

Выводит форму подписки на автора. Подписка доступна только для авторизованных пользователей.

Параметры

Примеры

• Вызов сниппета для каждого элемента в списке тикетов, например в чанке tpl.Tickets.list.row

[[!subscribeAuthor? &createdby=`[[!+createdby]]`]]

• Вызов сниппета в карточке автора (в которой ID юзера передан в переменную +author.id )

[[!subscribeAuthor? &createdby=`[[!+author.id]]` &TicketsInit=`1`]]

Документация по интерфейсу

Создание раздела с Тикетами

Компонент Tickets поставляется без демо-данных и без шаблонов. Поэтому вам нужно предварительно их создать. Также секция тикетов и сам тикет — это расширенный стандартный «modDocument», поэтому имеет все те же TV-поля, плейсхолдеры и логику работы.

Для начала работы с компонентом Tickets необходимо создать раздел с тикетами. В корне дерева документов или папке с любой вложенностью с помощью контекстного меню необходимо выбрать Создать -> Раздел с тикетами

[[!pdoPage?
    &element=`getTickets`
]]
[[!+page.nav]]

Создание тикета

Тикет это расширенный modDocument ресурса modx При создании тикета окно экрана имеет визуально 4 категории настроек.

• Основные настройки информации (Заголовок, Расширенный заголовок, Описание, Аннотация (введение), Содержимое);
• Настройки Meta информации (Опубликован, Дата публикации, Дата отмены публикации, Шаблон, Автор, Родительский ресурс, Псевдоним);
• Системные настройки (Доступен для поиска, Кэшируемый, Опубликован Использовать HTML-редактор, Контейнер, Заморозить URI, Отключить Jevix, Выполнять теги MODX, Закрытый тикет, Не показывать в меню, Показывать в дереве);
• Вкладка с управлением комментариями от текущего тикета;

Источник: официальная документация tickets.

Настройка прав пользователей для Tickets

Для того чтобы компонент Tickets правильно функционировал и его можно было использовать по полной, необходимо что бы все авторизованные пользователи находились в общей группе со специальными правами.

Создание группы пользователя

Шестеренка -> Контроль доступа -> Новая группа пользователей

• Название — Member
• Политика бэкэнда — (нет политики)

И сохраняем.

Настройка прав доступа

После сохранения данная группа появиться слева, нажимаем по ней ПКМ и выбираем редактировать.

На вкладке Права доступа — Доступ к контекстам, нажмите Добавить контекст

• Контекст — Web
• Минимальная роль — Member — 9999
• Политика доступа — TicketUserPolicy

Все, теперь можно к примеру разрешать комментирование только авторизованным пользователям, для этого вы можете воспользоваться любым компонентом авторизации, например HybridAuth.

MODX Tickets запрет заполнения introtext

По умолчанию компонент Tickets дублирует поле content в introtext. Сегодня небольшой лайфак, от том как запретить Tickets заполнять поле introtext. Для этого необходимо написать не большой плагин, пусть он будет называться no-introtext, со следующим содержимым:

<?php
if ($modx->event->name == "OnDocFormSave") {
	if ($resource->class_key != 'Ticket') return;
	$introtext = $resource->get('introtext');
	$content = $resource->getContent();
	$generateIntrotext = $resource->getIntroText($resource->get('content'), false);
	if (empty($resource->getProperty('disable_jevix'))) {
		$generateIntrotext = $resource->Jevix($generateIntrotext);
	}
	if ($introtext == $generateIntrotext || $introtext == $content) {
	    $resource->set('introtext', '');
	    $resource->save();
	}
}

И вешаем плагину событие OnDocFormSave

Это решение подходит для тех кто в настройках секции отключает Jevix для дочерних тикетов.

Если вы используете Jevix, тогда код плагина будет таким:

<?php
if ($modx->event->name == "OnDocFormSave") {
	if ($resource->class_key != 'Ticket') return;
	$introtext = $resource->get('introtext');
	$generateIntrotext = $resource->getIntroText($resource->get('content'), false);
	if (empty($resource->getProperty('disable_jevix'))) {
		$generateIntrotext = $resource->Jevix($generateIntrotext);
	}
	if ($introtext == $generateIntrotext) {
	    $resource->set('introtext', '');
	    $resource->save();
	}
}

В следующем уроке разберем как сделать MODX блог при помощи Tickets.