FileAttach: прикрепление файлов к ресурсам для MODx Revolution

Последняя версия 1.0.10-pl1 от 06.10.2017

[English]

Может быть установлен из официального репозитария MODx http://modx.com/extras/package/fileattach.

Модуль для загрузки файлов к ресурсам в менеджере сайта и во frontend

  • Поддерживается ограничение доступа к загрузке и скачиванию политиками;
  • Есть административное управление всеми загруженными файлами на сайте;
  • Для обзора загруженных файлов есть медиа источник, он доступен при глобальной регистрации пакета во время установки;
  • Список файлов хранится в таблице
  • Поддерживается докачка файлов
  • Постраничный вывод записей

К каждому файлу можно указывать описание, режим приватности (доступность по прямой ссылке), количество скачиваний, контрольную сумму SHA1.

Файлы доступны для скачивания по прямой ссылке. Для "закрытых" файлов генерируется длинное название, не соответствующее изначальному имени файла. У "открытых" файлов имя сохраняется.

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

Поддерживает работу в СУБД MySQL и SQLSrv DB.

Минимальная версия PHP v5.3.

Разработка компонента ведется на странице: https://github.com/13hakta/FileAttach

Снимки экрана

Редактор в административном режиме

Список файлов в менеджере

Дерево медиа источника

Редактирование файла

Редактирование файла в административном режиме

Список файлов в фронтенде сайта

Окно загрузки

Чанк FileAttachTpl

Позволяет задать произвольное оформление для вывода записей файлов.

Название Описание
description Описание
docid Идентификатор ресурса, для которого загружен файл
download Количество скачиваний
fid Уникальный строковой идентификатор файла
hash Контрольная сумма SHA1
ext Расширение файла в нижнем регистре
id Идентификатор файла
internal_name  Внутреннее имя. Содержит имя файла в файловой системе
name Имя файла. Совпадает с internal_name когда private=нет
path Путь внутри медиа источника
private Признак закрытости файла
rank Порядок в списке. Можно использовать для сортировки
size Размер файла в байтах

Изначальное содержание чанка:

<p>[{+description:notempty=`<strong>[[+description]]</strong><br/>`]]
<a href="[[+url]]">[[+name]]</a> <span class="badge">[[+download]]</span>
[{+size:notempty=`<br/><small>Size: [[+size]] bytes</small>`]]
[{+ext:notempty=`<br/><small>Type: <img src="/img/[[+ext]].png" /></small>`]]

Замените в тексте "[{" на "[ [".

Сниппет FileAttach

Выводит список файлов.

Название Значение по умолчанию Описание
&groups   Ограничение доступа для просмотра списка файлов указанным группам пользователей. Перечисление через запятую
&limit 0 Ограничение вывода файлов на странице. Если не указано, то вывод всех прикрепленных файлов
&totalVar total Название плейсхолдера для вывода количества записей
&offset 0 Количество пропущенных записей в выводе
&makeURL false Создавать ссылку для скачивания файла
&outputSeparator   Разделитель вывода записей
&privateUrl false Форсировать использование обработчик скачиваний, что позволяет считать скачивания даже для открытых файлов
&resource 0 Показать файлы для документа с номером id, если не указано, то вывод только для текущего документа
&showHASH false Получить хэш файла
&showExt false Извлекать расширение файла
&showSize false Получать размер файла
&sortBy name Сортировать по полю
&sortDir ASC Направление сортировки
&toPlaceholder false Сохранять результат в плейсхолдер, вместо прямого вывода на странице
&tpl FileAttachTpl Чанк оформления каждого ряда файлов

Класс FileItem

Методы

Название Описание Параметры
generateName Сгенерировать новое имя файла length (int) = 32
getFullPath Получить полный путь к файлу  
getPath Получить путь к файлу относительно корня медиа источника  
getSize Получить размер файла  
getUrl Получить ссылку на файл  
rename Переименовать файл name (str)
sanitizeName Отфильтровать недопустимые комбинации символов в имени файла name (str)
setPrivate Установить режим приватности private (bool)

Системные настройки

Название Значение по умолчанию Описание
calchash false Вычислять контрольную сумму SHA1 при загрузке файла
download true Считать количество скачиваний
files_path Путь Путь файла относительно корня медиа источника
mediasource 1 Идентификатор медиа источника
private false Делать файл закрытым при загрузке
put_docid false Размещать файл в подкаталоге ресурса
templates   Список шаблонов документов, в которых будет активирован модуль. Перечисление через запятую
user_folders false Размещать файл в подкаталоге пользователя

Системные события

В среде MODx регистрируется системное событие faOnRemove, которому передаются два аргумента: id - номер объекта в таблице, object - объект FileItem.

Коннектор для скачивания файлов

Закрытые файлы скачиваются через коннектор, что позволяет скрыть прямую ссылку на файл и произвести подсчет количества скачиваний. Можно скачивать открытые файлы через коннектор, указав в вызове сниппета &privateUrl=`1`, при этом коннектор сделает перенаправление на прямую ссылку.

Ссылка на коннектор имеет вид: MODX_ASSETS_URL/components/fileattach/connector.php?action=web/download&ctx=web&fid=file_id, где file_id - строковой идентификатор файла в таблице БД.

В сниппете создается ссылка с указанием контекста для текущего ресурса.

Политики доступа

Список разрешений

Название Описание
fileattach.doclist Управление файлами в документе
fileattach.download Возможность скачивать файлы
fileattach.totallist Управление всеми файлами
fileattach.remove Удаление файлов во frontend
fileattach.list Получение списка файлов во frontend

Для загрузки файлов пользователю надо включить доступ для:

  • Разрешение "create" в медиа-источнике
  • Разрешение "file_upload" из шаблона AdminTemplate

Для удаления файлов во frontend разрешено удалять свои файлы, прикрепленные к соответствующему ресурсу. Для возможности удаления не только своих файлов надо включить разрешение "fileattach.totallist".

Для скачивания надо разрешить «fileattach.download».
Есть две политики, которыми можно разрешить скачивание, первая это «File Attach Download» предназначенная только для скачивания, и «File Attach Frontend» для разрешения работы во frontend.
Назначьте одну из них для группы пользователя в контексте web.

При установке модуля создается набор политик:

Название Описание
File Attach Полный доступ
File Attach Download Только скачивание
File Attach Frontend Разрешает использовать процессоры для управления файлами во frontend

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

Пример использования

В простом случае можно просто вызвать сниппет:

[[FileAttach]]

Чтобы для всех файлов считалось количество скачиваний надо чтобы они открывались через приватную ссылку:

[[FileAttach? &amp;privateUrl=`1`]]

Сортировка по порядку, заданному вручную:

[[FileAttach? &amp;sortBy=`rank`]]

Ограничение на доступ к списку только пользователям из группы Editors:

[[FileAttach? &amp;groups=`Editors`]]

Пример управления файлов во frontend

Для загрузки используется менеджер очереди загрузки, загрузка через AJAX с помощью FormData.

Смотрите во вложении

Прикрепленные файлы

faupm-1071.zip 2004
Size: 9240 bytes
SHA1: a53bf121ed56b18ea6b3122541f498ebc4cb8cdd


Метки: filemodxразработка

Просмотров: 3586
Автор: Admin
Опубликовано: 04.02.2015