From 149c273c0a2e4c8d24af0d6838a1041f7b90dd75 Mon Sep 17 00:00:00 2001 From: Alexey Date: Wed, 20 Mar 2024 17:43:10 +0300 Subject: [PATCH] =?UTF-8?q?FileMan=203.2.0-pl,=20=D0=B4=D0=BE=D0=BA=D1=83?= =?UTF-8?q?=D0=BC=D0=B5=D0=BD=D1=82=D0=B0=D1=86=D0=B8=D1=8F?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- docs/components/fileman/index.md | 3 +- docs/components/fileman/settings.md | 14 +++++++++ docs/components/fileman/snippets.md | 48 +++++++++++++++++++---------- 3 files changed, 47 insertions(+), 18 deletions(-) create mode 100644 docs/components/fileman/settings.md diff --git a/docs/components/fileman/index.md b/docs/components/fileman/index.md index 69649680..7884a4d4 100644 --- a/docs/components/fileman/index.md +++ b/docs/components/fileman/index.md @@ -8,7 +8,8 @@ repository: https://github.com/createit-ru/FileMan items: [ { text: 'Интерфейс', link: 'interface' }, - { text: 'Сниппеты', link: 'snippets' } + { text: 'Сниппеты', link: 'snippets' }, + { text: 'Настройки', link: 'settings' } ] --- diff --git a/docs/components/fileman/settings.md b/docs/components/fileman/settings.md new file mode 100644 index 00000000..4c2402c1 --- /dev/null +++ b/docs/components/fileman/settings.md @@ -0,0 +1,14 @@ +# Настройки + +В таблице приведены настройки компонента, доступные в меню "Системные настройки", пространство имен "fileman". + +| Настройка | По умолчанию | Описание | +|---------------------|---------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------| +| fileman_auto_title | Да | Автоматически формировать заголовок из имени файла (без расширения) при загрузке | +| fileman_calchash | Нет | Вычислять SHA1 хэш файла при загрузке | +| fileman_grid_fields | id, name, title, description, group, private, download | Поля, через запятую, которые будут выводится в списке файлов | +| fileman_mediasource | 1 | Источник файлов, с которым работает компонент | +| fileman_path | files/{resource}/ | Путь внутри файлового источника. Должно завершаться на "/". Поддерживает переменные {year},{month},{day},{user},{resource}. Напр. files/{resource}/{year}/ | +| fileman_pdotools | Нет | Использовать парсер pdoTools и шаблонизатор Fenom | +| fileman_private | Нет | Сохранять файлы по умолчанию со случайным именем чтобы нельзя было получить доступ к файлу по названию. Подсчет скачиваний ведется только для закрытых файлов | +| fileman_templates | пусто | Список id шаблонов, у ресурсов с которыми будет доступна вкладка "Файлы" | \ No newline at end of file diff --git a/docs/components/fileman/snippets.md b/docs/components/fileman/snippets.md index 054f069d..ef4d0027 100644 --- a/docs/components/fileman/snippets.md +++ b/docs/components/fileman/snippets.md @@ -6,25 +6,39 @@ Сниппет предназначен для вывода списка файлов, прикрепленных к ресурсу. +# Поддержка pdoTools и шаблонизатора Fenom + ::: warning -Обратите внимание, что данный сниппет написан с использованием [pdoTools](/components/pdotools/), в чанке используется шаблонозатор Fenom. Если на вашем сайте он не установлен - сниппет работать не будет. +До версии 3.1.5-pl включительно компонент в своей работе использовал библиотеку [pdoTools](/components/pdotools/), а единственный чанк был написан с использованием шаблонизатора Fenom. ::: -### Параметры +Начиная с версия 3.2.0-pl компонент может работать как с использованием pdoTools (и шаблонизатора Fenom), так и с использованием стандартного парсера MODx. + +Управление производится системной настройкой ```fileman_pdotools```: -| Параметр | По умолчанию | Описание | -|------------------|---------------------|-------------------------------------------------------------------------------------------------------| -| tpl | `tpl.FileMan.Files` | Единственный чанк оформления результата работы, написан на шаблонизаторе Fenom. | -| sortBy | `sort_order` | Поле, по которому будут отсортированы файлы. | -| sortDir | `ASC` | Направление сортировки, ASC или DESC. | -| limit | `0` | Ограничить кол-во результатов, по умолчанию 0 - выводить все. | -| offset | `0` | С какого элемента выводить файлы, используется при постраничном выводе результатов сниппетом pdoPage. | -| totalVar | `total` | В плейсхолдер с таким названием будет установлено общее кол-во файлов при постраничном выводе. | -| toPlaceholder | | Результат работы будет сохранен в плейсхолдер, вместо вывода на страницу. | -| ids | | Позволяет указать список id файлов (через запятую) которые нужно вывести. | -| resource | | Id ресурса, с которым работаем, по умолчанию - текущий. | -| showGroups | `1` | Показывать группы файлов. | -| makeUrl | `1` | Если файлы нужно скачивать, то следует сформировать ссылки на них. | -| privateUrl | `0` | Можно форсировать private mode для всех файлов. | -| includeTimeStamp | `0` | Если нужно получить дату изменения файла на диске (будет доступна как timestamp). | +* **Настройка включена и pdoTools установлен:**\ +Сниппет fmFiles использует в своей работе только параметр `tpl` и единственный чанк, указанный в нем. В чанке можно (и нужно) использовать шаблонизатор Fenom. +* **Настройка выключена:**\ +Сниппет fmFiles использует в своей работе только параметры `tplRow`, `tplGroup`, `tplWrapper`, `wrapIfEmpty` и указанные в них чанки. В чанках используется стандартный синтаксис MODx. + +### Параметры +| | Параметр | По умолчанию | Описание | +|---|------------------|---------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| | tpl | `tpl.FileMan.Files` | Единый чанк оформления результата работы, написан на шаблонизаторе Fenom. Этот параметр работает только при установленном pdoTools и включенной настройке "fileman_pdotools" | +| | tplRow | `tpl.FileMan.Row` | Чанк для оформления строки с одним файлом (если настройка "fileman_pdotools" выключена). В качестве плейсхолдеров доступны все поля объекта fmFile. | +| | tplGroup | `tpl.FileMan.Group` | Чанк для оформления группы (если настройка "fileman_pdotools" выключена). Доступны плейсхолдеры [[+group]] и [[+output]]. | +| | tplWrapper | | Чанк-обертка результата (если настройка "fileman_pdotools" выключена). Доступен плейсхолдер [[+output]]. | +| | wrapIfEmpty | `0` | Оборачивать ли пустой результат работы в tplWrapper (если файлов нет). | +| | sortBy | `sort_order` | Поле, по которому будут отсортированы файлы. | +| | sortDir | `ASC` | Направление сортировки, ASC или DESC. | +| | limit | `0` | Ограничить кол-во результатов, по умолчанию 0 - выводить все. | +| | offset | `0` | С какого элемента выводить файлы, используется при постраничном выводе результатов сниппетом pdoPage. | +| | totalVar | `total` | В плейсхолдер с таким названием будет установлено общее кол-во файлов при постраничном выводе. | +| | toPlaceholder | | Результат работы будет сохранен в плейсхолдер, вместо вывода на страницу. | +| | ids | | Позволяет указать список id файлов (через запятую) которые нужно вывести. | +| | resource | | Id ресурса, с которым работаем, по умолчанию - текущий. | +| | showGroups | `1` | Показывать группы файлов. | +| | makeUrl | `1` | Если файлы нужно скачивать, то следует сформировать ссылки на них. | +| | privateUrl | `0` | Можно форсировать private mode для всех файлов. | +| | includeTimeStamp | `0` | Если нужно получить дату изменения файла на диске (будет доступна как timestamp). |