[Tickets] Версия 1.4.0-beta4 - Загрузка файлов

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

Кто не видел - вот исходная тема. Начиналось всё довольно безобидно: попросили соединить Uploadify и Tickets. В процессе соединения оказалось, что выходит ерунда, поэтому пришлось делать всё по-полной.

Итого, я провозился аж 4 дня, вместо 1 запланированного. Но результат того стоит:

Подробности под катом.

Логика работы

Все файлы загружаются сразу при добавлении и сохраняются в новую таблицу TicketFile. В зависимости от типа файла (картинка или нет), генерируется уменьшенная копия и сохраняется в поле thumb.

Правила загрузки и генерации превью, как обычно, прописаны в источнике медиа. Стандартный для Tickets устанавливается вместе с обновлением. Обратите внимание: в отличии от MS2 всегда генерируется только одна превьюшка, поэтому формат JSON массива немного другой.

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

Если картинка вам не нужна - её можно удалить, вернее, поставить флаг deleted. Физически же файл и запись в БД будут удалены при обновлении формы (только для новых файлов) или при сохранении тикета (для всех).

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

Удаляемый тикеты обводятся красной рамкой, новые - синей. Все стили, как обычно, в default.css.

Новые параметры сниппета TicketForm: - allowFiles - Разрешить загрузку файлов? Если да - то подключится загрузчик и нужные скрипты.

• source - Источник медиа-файлов, в который будут сохранены изображения. По умолчанию берется системны настройка tickets.source_default, в которую прописывается источник Tickets Files.
• tplFiles - Чанк-обертка всего блока работы с файлами. Загружчик, список файлов и прогрессбар.
• tplFile - Чанк оформление файла, который не является изображением.
• tplImage - Чанк офомрления картинок.

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

Да, старый баг с несохранением этих фиолтеовых параметров при открытии в окошке никуда не делся. Используйте быстрое редактирование двойным кликом на значении.

Загрузчик

Непосредственно загрузкой файлов занимается мега-скрипт Plupload, который работает везде, умеет drug & drop, ресайз на клиенте и еще много чего.

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

Также на клиенте будет проверено расширение файла, а в окне выборе будут активны только разрешенные типы.

Контроль целостности

Ссылку на загруженный файл можно сразу вставить в тикет - пока он не сохранен путь у картинок будет такой:

/assets/images/tickets/0/имяфайла.png
/assets/images/tickets/0/имяфайла_thumb.jpg

Обратите внимание, что путь указывает на нулевой ресурс. При сохранении этот путь заменится на реальный id документа.

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

Физический перенос файла в новую директорию прописан в методе TicketFile::save() и срабатывает при смене родителя.

Вывод загруженных файлов

Выводом загруженных файлов посетителям занимается сниппет TicketMeta. У него появились новые параметры, и по умолчанию он показывает только те файлы, ссылки на которые отсутствуют в контенте тикета. - getFiles - Выводить список загруженных файлов?

• tplFile - Чанк оформления сслыки на файл.
• unusedFiles - Выводить только файлы, неиспользованные в контенте документа.

Обертка для вывода файлов прописана в чанке tpl.Tickets.meta, в быстром плейсхолдере has_files.

Понятное дело, что файлы можно выводить и при помощи pdoResources:

[[!pdoResources?
    &class=`TicketFile`
    &where=`{"parent":16}`
    &sortby=`createdon`
    &sortdir=`ASC`
]]

Сортировку нужно указать обязательно, иначе сниппет попытается сортировать по колонке publishedon, которая у TicketFile отсутствует.

Заключение

Вот и появился у нас компонент, который умеет создавать страницы с фронтенда, комментировать, голосовать и даже загружать файлы.

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

Напоминаю, что это по-прежнему бета-версия, которую нужно тестировать. Учитывая, что используется Plupload, загрузка должны работать везде, даже на HTML4, а вот отсутствие глюков в php я вам не обещаю. Свой сайт я пока не обновляю, скорее всего, новый Tickets будет использоваться уже сразу на http://modx.pro.

При обновлении советую обратить внимание на чанки: - tpl.Tickets.form.create

• tpl.Tickets.form.update
• tpl.Tickets.meta

Они были изменены и их нужно обновить при установке, или вручную из репозитория.

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