Эта страница - для разработчиков, которые адаптируют модуль к теме или связывают его с другим кодом. Customer Messages построен на библиотеке Ka Extensions: модуль не изменяет файлы OpenCart, его изменения применяются библиотекой (переопределения kamod и патчи .xml) и пересобираются через Расширения > Модификации > Обновить.
Файлы
| Папка | Содержимое |
|---|---|
admin/controller/extension/ka_extensions/ka_messages/ |
Страницы админ-панели: обращения, обращение, диалоги сообщений, блокировки, вложения; controller/ содержит переопределения страниц OpenCart (меню, настройки магазина). |
admin/controller/extension/ka_extensions/ka_messages.php |
Страница настроек, установка и структура базы данных. |
catalog/controller/extension/ka_extensions/ka_messages/ |
Страницы покупателя (обращения, обращение, вложения), cron.php; controller/ содержит переопределения контроллеров аккаунта, истории заказов, формы обратной связи и писем-оповещений. |
catalog/model/extension/ka_extensions/ka_messages/cron.php |
Импорт писем из почтового ящика. |
system/library/extension/ka_extensions/ka_messages/ |
Общие модели (обращения, сообщения, вложения, письма), чтение IMAP, список блокировок, правила для изображений и вложений, преобразование HTML / Markdown. |
admin/view/template/extension/ka_extensions/ka_messages/, catalog/view/theme/default/template/extension/ka_extensions/ka_messages/ |
Шаблоны, включая mail/ с шаблонами писем. |
system/config/ka_messages.php |
Ключ подписи писем, создаётся при установке. |
Папки customer_verification, ka_messages_for_mv |
Входящие в комплект расширения Customer Email Verification и Messages For Multivendor. |
Таблицы базы данных
| Таблица | Содержимое |
|---|---|
ka_tickets |
Обращения: тема, статус (O / C), признак «Отвечено», назначенный администратор, заметка к обращению, источник, проверка email. |
ka_ticket_customers |
Покупатели каждого обращения. |
ka_ticket_messages |
Сообщения: обращение, ID и тип автора (C - покупатель, U - пользователь админ-панели, V - продавец), текст, исходное сообщение при разделении. |
ka_ticket_attachments |
Прикреплённые файлы и изображения сообщений. Файлы находятся в . |
ka_ticket_message_emails |
Статус доставки писем сообщений по получателям: S - отправлено, F - ошибка, L - отправляется, попытки, последняя ошибка. |
ka_ticket_bans |
Правила блокировки. |
ka_user_settings |
Сохранённые фильтры списков администраторов. |
Установка также добавляет customer.customer_note и поля проверки email в таблицу покупателей.
Формат сообщений
Сообщения хранятся в Markdown. Редактор (Summernote) отправляет HTML, модуль при сохранении преобразует его в Markdown, а для показа и писем - обратно в HTML с помощью Parsedown. Изображения хранятся как ссылки , отдельно в папках шаблонов admin и catalog. Включены файлы _en и _ru; если в магазине нет файла для языка получателя, используется шаблон _en (getTemplateForLanguage() из AModelEmails). Темы «Обращение №N назначено вам» и «Обращение №N закрыто» находятся в языковом файле extension/ka_extensions/ka_messages/mail.php. Шаблоны получают:
| Переменная | Содержимое |
|---|---|
reply_above_this_line |
Строка-маркер; оставляйте её вверху. |
ticket |
Обращение с ticket_id, subject, customers (список записей покупателей), author, email_verified. |
recipient |
Получатель: запись покупателя, пользователя админ-панели или продавца (firstname, lastname, email). |
message.body |
Сообщение в виде HTML. |
attachments |
Список name и url прикреплённых файлов. |
Сохраняйте маркер в своих шаблонах, иначе цитируемый текст не будет удаляться из ответов.
Привязка ответов
Каждое письмо получает Message-ID вида , а также In-Reply-To и References с ID предыдущих сообщений обращения. Входящие письма сопоставляются сначала по In-Reply-To, затем по References, начиная с самого нового ID. ID с неверной подписью игнорируются. Тема никогда не разбирается.
Создание обращения из своего кода
Форма обратной связи создаёт обращения через системную модель обращений catalog. Тот же вызов могут использовать другие расширения:
$kamodel_tickets = $this->load->kamodel('extension/ka_extensions/ka_messages/system_tickets'); $ticket_id = $kamodel_tickets->addTicket([ 'customer_id' => $customer_id, 'subject' => 'Return request for order #15', 'body' => 'Text of the first message (Markdown)', 'source' => 'form', 'email_verified' => 1, ]);
Обращению назначается пользователь по умолчанию, администратор и покупатель получают письма о новом обращении. Чтобы найти или создать аккаунт покупателя для email, используйте fetchCustomersFromEmails() модели extension/ka_extensions/ka_messages/cron, как это делает форма обратной связи.
Пользовательские темы
Шаблоны покупателя находятся в папке темы default. Если ваша тема неправильно показывает страницы обращений, скопируйте шаблоны из catalog/view/theme/default/template/extension/ka_extensions/ka_messages/ по тому же пути в вашей теме и поправьте разметку. Изменения страниц аккаунта, истории заказов и обратной связи - это патчи .twig.xml; если патч не находит своё место в шаблоне вашей темы, ссылка или кнопка не добавляется.