easyComm 1.15.0 большой апдейт: ответы, улучшенные файлы и многое другогое!

Привет!

Сегодня расскажу про обновление easyComm до версии 1.15.0.
В этом обновлении огромное количество улучшений и исправлений, разных изменений.

В связи с этим: БЕКАП ПЕРЕД ОБНОВЛЕНИЕМ ОБЯЗАТЕЛЕН!!!
Эта версия содержит большое количество изменений, я не исключаю того, что будут баги.

На это обновление я затратил наверное часов 60 рабочего времени, так что в этой статье даже и не опишу всего, точно что-нибудь пропущу или забуду.

1. Ответы на сообщения

Про это у меня много раз спрашивали, будут ли ответы на сообщения (отзывы/вопросы — смотря для чего компонент используется на вашем сайте). Пора что-то сделать)))

В прошлых версиях компонента у менеджера была возможность написать на сообщение пользователя. Для этого у объекта ecMessages были доступны 2 текстовых поля: reply_author и reply_text, которые мог заполнить менеджер сайта, например так: «Администратор: спасибо за ваш отзыв».

В этой версии я добавил новую сущность Ответ (ecReply), содержащий просто имя пользователя, его почту и текст. Ответы не влияют на рейтинг, на количество отзывов или вопросов на вашем сайте. Воспринимайте их как комментарии к отзывам. В целом ecReply поддерживают вложенность (древовидность), но на фронте я не стал реализовать мощную систему вроде комментариев Tickets. Всё несколько проще, напоминает наверное ответы в telegram.
Сразу отвечу: к ответам нельзя прикреплять файлы или голосовать за них, это простое обсуждение.



Для того, чтобы функционал ответов стал доступен на сайте нужно:
1. у сниппета ecMessages включить параметр repliesEnable
2. Добавить в произвольное место страницы вызов сниппета ecReplyForm (форма добавления ответа другая, поэтому для нее свой сниппет по аналогии со знакомым ecForm).

2. Улучшил работу с прикрепленными к сообщениям файлами

1. Добавил генерацию превьюшек для изображений, чтобы страницы вашего сайта открывались быстрее. Для управления размером превью посмотрите настройки (конкретно thumbnailConfig) источника файлов easyComm.
В принципе демонстрация работы тоже не скриншоте выше. Если прикреплено изображение — видим его превью с открытием по клику, а если это файл — то видим ссылку с именем файла, его типом и размером. Само собой всё можно поменять в чанке и через css.

3. Улучшил внешний вид и внутренности стандартных чанков

Здесь много мелочей:
— я переписал чанки, стили;
— обновил js файл (в т.ч. потому что появились ответы);
— один момент изменился очень сильно: в чанке tpl сниппета ecMessages теперь выводятся все сообщения в цикле, а не сообщения по одному! Поэтому если вы делали свой чанк на его основе — просто обновится не получится! При этом такие параметры сниппета как tplWrapper, tplEmpty, outputSeparator, toSeparatePlaceholders стали не нужны и были удалены.
— чанк tpl.ecForm (это тот, который использует сниппет ecForm) тоже изменился, там теперь другие идентификаторы (id) у слоёв, это важно, новый js файл рассчитан на работу с ними.

4. Переименованы некоторые поля в БД

Переименованы поля у объектов:
— ecThread: resource > resource_id
— ecMessage: thread > thread_id
— ecVote: message > message_id
— Переименованы timestamp поля объектов (напр. createdon => created_on)

Я учел эти переименования в установщике, но БЕКАП ВСЕ РАВНО ОБЯЗАТЕЛЕН при обновлении.

5. Изменена работа уведомлений через email

Изменена работа уведомлений через email, обновились соответствующие чанки шаблонов писем и параметры сниппетов ecForm и ecMessage.

Все параметры для сниппетов прописаны, когда вы перетаскиваете в админке сниппет в область контента, в появившемся окне их можно подсмотреть и настроить.

И я решил не отправлять письмо пользователю в момент добавления нового отзыва (там ранее был текст вроде «Ваше сообщение отправлено, оно будет опубликовано после модерации»). Аналогичное сообщение выводится на фронте, зачем его дублировать на почту я не знаю. Email будет отправляться только при публикации сообщения на сайте.

6. Улучшено уведомление о добавлении сообщения

При добавлении нового сообщения или ответа мы теперь сразу его видим с предупреждением, что он не опубликован.

7. Улучшения по интерфейсу в админке

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

Версия компонента для MODX 3

upd 28.03.2024: Для MODX 3 выпущена версия 3.6.0-pl, доступна в modstrore.pro

Актуализация документации

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

[[!ecMessages? &tpl=`tpl.ecMessages.article` &votingEnable=`1` &votingAllowGuest=`1` &repliesEnable=`1` &limit=`0`]]

{if $message['replies']?}
            {foreach $message['replies'] as $reply}
                <div id="ec-{$message['thread_name']}-reply-{$reply['id']}" class="ec-reply">
                    <div class="ec-reply__header">
                        <div class="ec-reply__meta">
                            <span class="ec-reply__author">{$reply['user_name']}</span>
                            <span class="ec-reply__date">{$reply['created_on'] | dateAgo}</span>
                        </div>
                    </div>
                    <p>
                        {$reply['text']}
                    </p>
                    {if $message['replies_enable']?}
                        <div class="ec-reply__footer">
                            <a class="ec-reply__footer-link js-ec-reply" href="javascript:void(0)"
                               data-ec-thread="{$message['thread_name']}"
                               data-ec-message="{$message['id']}"
                               data-ec-parent="{$reply['id']}">{'ec_fe_reply' | lexicon}</a>
                        </div>
                    {/if}
                </div>
            {/foreach}
        {/if}

Uncaught TypeError: Cannot read properties of null (reading 'closest')
    at xmlHttpRequest.onreadystatechange (ec.js:74:104)