Сниппеты

11 апреля 2017, 14:32

ecForm

Сниппет выводит форму добавления нового сообщения.

Сниппет можно вызывать кешированным, так как его назначение - только вывести html код формы и новую цепочку. При первом вызове сниппет создает в базе новую цепочку сообщений (объект ecThread), привязанную к текущему ресурсу. При любом вызове сниппета (а не только при первом) в поле properties объекта ecThread записываются в формате json все параметры сниппета, что бы в дальшейшем можно было их использовать.

Параметры сниппета

Параметр По-умолчанию Описание
thread resource-[[*id]] Имя цепочки сообщений. Должно быть уникальным.
formId как thread Используется на фронтенд для идентификации формы при наличии нескольких форм на одной странице.
allowedFields user_name, user_email, user_contacts, subject, rating, text Список разрешенных для заполнения полей в форме.
requiredFields user_name, text Список обязательных полей.
antispamField address Имя поля, используемого как антиспам. Это поле должно быть скрыто от пользователя через css, и он его не заполнит, в то время, как спам-роботы будут его заполнять.
autoPublish Автопубликация сообщений. Возможны варианты "пустое значение" - автопубликация отключена, "OnlyLogged" - автопубликация, если пользователь авторизован в текущем контексте, "All" - автопубликация сообщений от всех пользователей.
tplForm tpl.ecForm Чанк с формой
tplSuccess tpl.ecForm.Success Чанк с сообщением об успешной отправке сообщения.
mailManager E-mail администратора для уведомлений о новых сообщениях, перекрывает настройку ec_mail_manager. Используя этот параметр вы можете указать разные адреса для разных вызовов сниппета ecForm
newEmailSubjUser Тема email письма пользователю о том, что он оставил сообщение, перекрывает настройку ec_mail_new_subject_user
tplNewEmailUser tpl.ecForm.New.Email.User Чанк с шаблоном email письма пользователя о том, что он оставил сообщение. Если параметр пуст - письмо отправлено не будет.
newEmailSubjManager Тема email письма менеджеру о новом сообщении на сайте, перекрывает настройку ec_mail_new_subject_manager
tplNewEmailManager tpl.ecForm.New.Email.Manager Чанк с шаблоном email письма менеджеру о новом сообщении на сайте. Если параметр пуст - письмо отправлено не будет.
updateEmailSubjUser Тема email письма пользователю о публикации сообщения или ответе на него, перекрывает настройку ec_mail_update_subject_user
tplUpdateEmailUser tpl.ecForm.Update.Email.User Чанк с шаблоном email письма пользователю о публикации сообщения или ответе на него. Если параметр пуст - письмо отправлено не будет.

Зависимости

Важно! Для работы формы отправки сообщения необходимо наличие подключенного на странице jquery и плагина jquery.form (не поставляется с компонентом, необходимо подключать вручную!). Если последний не подключен - вы увидите сообщение "Can`t find jQuery ajaxForm plugin!".

ecMessages

Сниппет выводит сообщения из определенной цепочки. Обязательно вызывать некешированным, т.к. при публикации сообщений из админки кеш сайта не очищается.

Параметры сниппета

Параметр По-умолчанию Описание
thread resource-[[*id]] Имя цепочки сообщений.
threads Список цепочек, из которых необходимо выводить сообщения, через запятую (например "resource-1,resource-2"). Укажите *, что бы вывести сообщения из всех цепочек. Параметр имеет приоритет над параметром thread.
subject Отфильтровать сообщения по Теме (поле subject)
tpl tpl.ecMessages.Row Чанк для вывода одного сообщения. В чанке доступны поля сообщения, цепочки (с префиксом thread_). Используя параметр resourceFields, можно включить в выборку и поля ресурса.
tplWrapper Чанк обертка. Используйте в нем плейсхолдер [[+output]]. Кроме того, если используется вывод сообщений только из одной цепочки, то будут доступны все поля thread как плейсхолдеры, а также рейтинг цепочки в отформатированном виде [[+rating_wilson_percent]] и [[+rating_simple_percent]]
sortby date Поле для сортировки
sortdir DESC Направление сортировки
limit 10 Ограничение выборки
showUnpublished 0 Показывать неопубликованные сообщения
showDeleted 0 Показывать удаленные сообщения
resourceFields Добавить в выборку поля ресурса (с префиксом resource_), например: "id,pagetitle,longtitle,introtext". Поля id и pagetitle добавляются всегда, но лучше их явно указать, т.к. это поведение может быть изменено в будущем.
outputSeparator \n Разделитель вывода строк
toPlaceholder Если указан этот параметр, то результат будет сохранен в плейсхолдер, вместо прямого вывода на странице.
toSeparatePlaceholders Задать плейсхолдер для каждого сообщения
showLog 0 Показывать лог

ecMessagesCount

Сниппет выводит количество сообщений из определенной цепочки (или цепочек). Обязательно вызывать некешированным, т.к. при публикации сообщений из админки кеш сайта не очищается.

Параметры сниппета

Параметр По-умолчанию Описание
thread resource-[[*id]] Имя цепочки сообщений.
threads Список цепочек, из которых необходимо выводить сообщения, через запятую (например "resource-1,resource-2"). Укажите *, что бы вывести сообщения из всех цепочек. Параметр имеет приоритет над параметром thread.
subject Отфильтровать сообщения по Теме (поле subject)
showUnpublished 0 Показывать неопубликованные сообщения
showDeleted 0 Показывать удаленные сообщения

ecThreadRating

Сниппет выводит рейтинг указанной цепочки. Обязательно вызывать некешированным, т.к. при публикации сообщений из админки кеш сайта не очищается.

Параметры сниппета

Параметр По-умолчанию Описание
thread resource-[[*id]] Имя цепочки сообщений.
tpl tpl.ecThreadRating Чанк для вывода рейтинга. Доступны плейсхолдеры rating_simple, rating_simple_percent, rating_wilson, rating_wilson_percent, а также все поля объекта ecThread
toPlaceholder Если заполнить параметр, то результат будет установлен в плейсхолдет с таким именем

Следующий документ
Плагины и кастомизация