События MODX и капча

Примеры витрины — Интеграция. Ниже события, капча и prefetch для расширений.

События msrOn*

Событие	Когда
msrOnBeforeReviewCreate	До создания отзыва (витрина или mgr/review/create)
msrOnReviewCreate	После создания
msrOnBeforeReviewPublish	До публикации
msrOnReviewPublish	После публикации
msrOnReviewReject	При отклонении
msrOnBeforeReviewUpdate / msrOnReviewUpdate	Правка на витрине (review/update_own) или в CMP (mgr/review/update)
msrOnBeforeReviewDelete / msrOnReviewDelete	Самоудаление на витрине
msrOnReviewVote	После «полезно»
msrOnQuestionCreate	Создание вопроса
msrOnAnswerCreate	Ответ из CMP
msrOnReviewRequestSend	Отправка письма из очереди
msrOnModeratorNotify	Перед письмом модератору о новом отзыве/вопросе с витрины
msrOnCaptchaVerify	Перед review/create и question/create

Верните false из плагина на guard-событиях, чтобы заблокировать операцию (msr_err_event_block или отмена письма модератору).

msrOnModeratorNotify

Вызывается, когда уведомления включены, статус подходит под msreviews_moderator_notify_on и список адресатов не пуст. Параметры: type (review / question), id, product_id, status, recipients (list). return false отменяет отправку.

Событие срабатывает до рендера чанка письма. Если плагин не отменил отправку, а кастомный чанк темы/тела вернул пустую строку, письмо всё равно не уйдёт (см. Настройки).

<?php
/** @var modX $modx */
/** @var array $scriptProperties */
switch ($modx->event->name) {
    case 'msrOnModeratorNotify':
        // Своё уведомление (Telegram и т.п.), штатное письмо отменить:
        return false;
}

Настройки: Уведомление модератора.

Капча (msrOnCaptchaVerify)

Встроенного виджета нет.

1. Подключите провайдера капчи на сайте.
2. Передайте HTML в &captchaHtml= у msReviewForm / msQuestionForm.
3. Создайте плагин на msrOnCaptchaVerify (ранняя сортировка).
4. Проверьте токен через API провайдера.
5. При неуспехе установите результат события в false → JSON msr_err_captcha.

modx

[[!msReviewForm?
  &product_id=`[[*id]]`
  &captchaHtml=`[[+captchaHtml]]`
]]

fenom

{'!msReviewForm' | snippet : [
  'product_id' => $_modx->resource.id,
  'captchaHtml' => $captchaBlock
]}

Prefetch агрегатов

Функция msr_prefetch_aggregates(\MODX\Revolution\modX $modx, array $productIds) в core/components/msreviews/include/helpers.php.

Вызывайте в PHP до цикла карточек каталога, когда id товаров уже известны:

require_once MODX_CORE_PATH . 'components/msreviews/include/helpers.php';
msr_prefetch_aggregates($modx, [101, 102, 103]);

После prefetch msRatingSummary и msRatingBadge читают агрегат из request-scoped кеша без N+1 запросов.

Коды msr_err_*

Ключ	Контекст
msr_err_product	Неверный product_id
msr_err_rating	Оценка не 1–5
msr_err_spam	Honeypot / blacklist
msr_err_crawler	CrawlerDetect
msr_err_rate	Rate limit
msr_err_captcha	Капча не пройдена
msr_err_token	Неверный edit_token
msr_err_self_edit_disabled	Самоправка выключена
msr_err_vote_disabled	Голосование выключено
msr_err_forbidden	Нет прав mgr
msr_err_unknown_action	Неизвестный action

Полный список — лексикон namespace msreviews, ключи msr_err_*. На витрине JS переводит через window.msrLexicon.

CrawlerDetect

Ru: CrawlerDetect + msreviews_crawler_block_enabled=1: блок review/create и question/create для ботов → msr_err_crawler.

Resource cache и фильтры

Плагин msReviews Storefront cache (msreviews_storefront_cache) поставляется с пакетом и включён по умолчанию.

События: OnHandleRequest, OnLoadWebPageCache, OnBeforeSaveWebPageCache, OnWebPagePrerender.

Зачем: при cache_resource=1 MODX кэширует HTML карточки товара без query ?msr_verified=1 и других фильтров. Плагин сбрасывает resource cache при запросе с msr_*, не сохраняет отфильтрованный HTML в кэш и обходит HTML-кэш imageoptimizer, если он установлен.

Без плагина chip-фильтры msReviewsFilters на проде могут не менять список. Подробнее: Интеграция — фильтры.

См. также

• AJAX API
• Системные настройки
• FAQ