Skip to content

Commit

Permalink
Merge pull request #766 from createit-ru/master
Browse files Browse the repository at this point in the history 
FileMan 3.2.0-pl, документация
  • Loading branch information
@Ibochkarev
Ibochkarev authored Mar 20, 2024
2 parents 1df7736 + 149c273 commit b61ae47
Show file tree
Hide file tree
Showing 3 changed files with 47 additions and 18 deletions.
3 changes: 2 additions & 1 deletion docs/components/fileman/index.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,8 @@ repository: https://github.com/createit-ru/FileMan

items: [
{ text: 'Интерфейс', link: 'interface' },
{ text: 'Сниппеты', link: 'snippets' }
{ text: 'Сниппеты', link: 'snippets' },
{ text: 'Настройки', link: 'settings' }
]
---

Expand Down
14 changes: 14 additions & 0 deletions docs/components/fileman/settings.md
View file
Original file line number Diff line number Diff line change
@@ -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 шаблонов, у ресурсов с которыми будет доступна вкладка "Файлы" |
48 changes: 31 additions & 17 deletions docs/components/fileman/snippets.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -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). |

0 comments on commit b61ae47

Please sign in to comment.