Компонент предназначен для прикрепления файлов к заказу miniShop2, как из бек-энда, так и из фронт-энда.
В бек-энде файлы отображаются на вкладке, встроенной в окошко редактирования заказа miniShop2.

Как известно, после оформления заказа анонимом, на указанный email при заказе создаётся пользователь. Так вот этот пользователь прикрепляется и к файлам, которые были загружены при оформлении заказа.


Вывод формы загрузки файлов
Сниппет лучше всего размещать в чанке tpl.msOrder, чтобы в пустой корзине форма не отображалась.

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

• tpl — Шаблон вызова формы,
• order — ID заказа. По-умолчанию 0,
• user — ID пользователя. По-умолчанию текущий,
• source — Источник файлов. По-умолчанию указывается из настройки msof_source,
• anonym — Позволять ли анонимам пользоваться формой,
• dropzone — Массив параметров Dropzone, можно JSON,
• maxFiles — Максимальное кол-во файлов. По-умолчанию 2,
• maxFilesize — Максимальный размер файла в MB. По-умолчанию 2.

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

{'!msofForm' | snippet : [
    'maxFiles' => 20,
    'maxFilesize' => 10,
    'anonym' => false,
]}

Важно

Чтобы пользователь мог загружать файлы из фронт-энда, добавьте его группе политику доступа msOrderFilesPolicy. Тоже касается и анонимов.
После этого не забудьте сделать:
— Управление => Перезагрузить права доступа
— Управление => Завершить все сеансы
И сбросить кеш, на всякий случай!


Вывод файлов в письме пользователю/менеджеру
В нужном месте шаблона письма пишем вызов сниппета pdoResources с нашей моделью msOrderFiles:

{'!pdoResources' | snippet : [
    'class' => 'msOrderFile',
    'loadModels' => 'msOrderFiles',
    'where' => [
        'order_id' => $order['id'],
        'active' => 1,
    ],
    'sortby' => '{"rank":"ASC"}',
    'tplWrapper' => '@INLINE <ul>{$output}</ul>',
    'tpl' => '@INLINE <li><a href="{("site_url" | option) ~ $url}">{$name}</a></li>',
]}

Важно учитывать, что это решение 100% работает для miniShop2 >= 2.4, т.к. проверялось только на нём. Хотя можно попытаться совместить и с более ранними версиями магазина, скорее всего, даже без существенных правок.


Вывод списка файлов заказа
Чтобы вывести список файлов определённого заказа (например, в личном кабинете юзера), нужно воспользоваться сниппетом pdoResources:

{'!pdoResources' | snippet : [
    'class' => 'msOrderFile',
    'loadModels' => 'msOrderFiles',
    'where' => [
        'active' => 1,
        'order_id' => 10,
    ],
    'sortby' => '{"rank":"ASC"}',
    'tplWrapper' => '@INLINE <ul>{$output}</ul>',
    'tpl' => '@INLINE
        <li><a href="{$url}">{$name}</a></li>
    ',
]}

Плейсхолдеры для параметра tpl

• id — id файла заказа,
• order_id — id заказа в ms2,
• source — id источника файлов,
• name — название файла,
• description — описание файла,
• file — имя файла с расширением,
• url — путь до файла, начиная от корня сайта,
• mime — тип файла, по стандарту MIME,
• ext — расширение файла,
• hash — хеш, который используется для сравнения уникальности загружаемого файла,
• size — размер файла в байтах,
• createdon — дата загрузки файла,
• createdby — id юзера, который загрузил файл,
• rank — номер позиции файла в списке,
• active — является ли файл активным.

Источник файлов msOrderFiles

В источнике файлов, помимо стандартных настроек (basePath, baseUrl), можно указать и такие:

• allowedFileTypes — список расширений файлов, которые разрешается загружать,
• fileNameType — знакома многим из ms2Gallery, означает метод переименования файла,
• positionNewFiles — позиция новых файлов в списке. Другими словами, куда загружать новые файлы: в начало или в конец.

Автор выражает благодарность Михаилу Воеводскому за идею дополнения.
Обсуждение компонента в сообществе MODX.PRO.