-
-
Notifications
You must be signed in to change notification settings - Fork 128
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
1 parent
72447eb
commit 73d3fcf
Showing
3 changed files
with
39 additions
and
28 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,24 +1,30 @@ | ||
| # Интерфейс | ||
|
|
||
| ## Вкладка Файлы | ||
|
|
||
| После установки компонента на странице редактирования ресурса появляется новая вкладка Файлы, содержащая таблицу прикрепленных файлов с элементами управления в верхней части. | ||
|
|
||
| Компонент предоставляет два способа для прикрепления файлов: | ||
| - с компьютера пользователя, посредством стандартного окна загрузки файлов в MODX; | ||
| - по ссылке, исключая необходимость предварительного сохранения на компьютер. | ||
|
|
||
| - с компьютера пользователя, посредством стандартного окна загрузки файлов в MODX; | ||
| - по ссылке, исключая необходимость предварительного сохранения на компьютер. | ||
|
|
||
| ## Окно редактирования файла | ||
|
|
||
| После того, как файл будет загружен, информацию о нем можно будет изменить. | ||
|
|
||
| Компонент позволяет для каждой записи указадть следующую информаци (в скобках указано имя поля в БД): | ||
| - Заголовок (title) – удобно читаемый заголовок для файла; | ||
| - Описание (description) – подробное описание файла; | ||
| - Группа (group) – группируйте файлы по подразделам при необходимости (например Документация, Сертификаты, Каталоги и т.д.); | ||
| - Название файла (name) – имя файла, с которым будет сохранен при скачивании; | ||
| - Закрыть доступ (private) – указывает, что файл не доступен по прямой ссылке, а будет скачиваться через коннектор, позволяет организовать учет количества скачиваний; | ||
| Компонент позволяет для каждой записи указадть следующую информаци (в скобках указано имя поля в БД): | ||
|
|
||
| Еще в базе сохраняются некоторые поля, недоступные для изменения: path, size, extension, internal_name, size, hash, но вы можете использовать их в своих сниппетах. | ||
| - Заголовок (title) – удобно читаемый заголовок для файла; | ||
| - Описание (description) – подробное описание файла; | ||
| - Группа (group) – группируйте файлы по подразделам при необходимости (например Документация, Сертификаты, Каталоги и т.д.); | ||
| - Название файла (name) – имя файла, с которым будет сохранен при скачивании; | ||
| - Закрыть доступ (private) – указывает, что файл не доступен по прямой ссылке, а будет скачиваться через коннектор, позволяет организовать учет количества скачиваний; | ||
|
|
||
| Еще в базе сохраняются некоторые поля, недоступные для изменения: path, size, extension, internal_name, size, hash, но вы можете использовать их в своих сниппетах. | ||
|
|
||
| ## Управление всеми прикрепленными файлами | ||
|
|
||
| Помимо управления файлами на странице ресурса реализован отдельный раздел, доступный в меню "Пакеты / FileMan", где можно увидеть общий список всех прикрепленных файлов. | ||
|
|
||
| Здесь доступны все те же возможности, кроме загрузки файлов и их сортировки (т.к. эти функции связаны с конкретным ресурсом). | ||
| Здесь доступны все те же возможности, кроме загрузки файлов и их сортировки (т.к. эти функции связаны с конкретным ресурсом). |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,26 +1,29 @@ | ||
| # Сниппеты | ||
|
|
||
| У компонента единственный сниппет fmFiles. | ||
|
|
||
| ## fmFiles | ||
|
|
||
| Сниппет предназначен для вывода списка файлов, прикрепленных к ресурсу. | ||
|
|
||
| ::: warning | ||
| Обратите внимание, что данный сниппет написан с использованием pdoTools, в чанке используется шаблонозатор Fenom. Если на вашем сайте он не установлен - сниппет работать не будет. | ||
| Обратите внимание, что данный сниппет написан с использованием [pdoTools](/components/pdotools/), в чанке используется шаблонозатор Fenom. Если на вашем сайте он не установлен - сниппет работать не будет. | ||
| ::: | ||
|
|
||
| ### Параметры | ||
|
|
||
| | Параметр | По умолчанию | Описание | | ||
| |-------------------|--------------------|---------------------------------------------------------------------------------------------------------| | ||
| | 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). | | ||
| | Параметр | По умолчанию | Описание | | ||
| |------------------|---------------------|-------------------------------------------------------------------------------------------------------| | ||
| | 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). | |