Логотип

Документация по макросам и шаблонам UMI.CMS

filemanager list_files()

Название

%filemanager list_files()% — Выводит список доступных для скачивания файлов.

Параметры: filemanager list_files([element_id = 0, template = 'default', per_page = 0, ignore_paging = 0, depth = '1'])

element_id

id или псевдостатический адрес раздела с файлами.

template

Имя шаблона, по которому выводится список файлов. В XSLT-шаблонизаторе игнорируется.

per_page

Количество файлов, выводимых на странице.

ignore_paging

Игнорировать переход по страницам. Если поставить значение этого параметра равным "1", и в URL страницы будет присутствовать параметр p, то для этого макроса он будет проигнорирован.

depth

Глубина поиска внутри раздела, id которого задан в параметре element_id. По умолчанию равен "1" - поиск осуществляется только среди прямых потомков раздела. 

 

Описание

Макрос выводит список файлов, заданных доступными для скачивания в модуле "Файловая система". Раздел указывается в параметре element_id. Если параметр не указан, система берет id текущей страницы.

Дополнительные сведения

Для операций с файлами и файловой системой можно также воспользоваться протоколом UFS (см. «Файловая система: протокол UFS»).

Пример вызова

udata://filemanager/list_files

XML-ответ UData

<udata module="filemanager" method="list_files" generation-time="0.031542">
  <items id="41" name="PHP Manual"
   link="/downloads/php_manual/" downloads-count="2"
   xlink:download-link="/filemanager/download/41"
   xlink:href="upage://41">
    Документация по PHP, частично переведенная на русский язык.<br />
  </items>
  <per_page>25</per_page>
  <total>1</total>
</udata>

Элементы и атрибуты

<items>

Элемент, описывающий страницу, созданную модулем "Файловая система" для файла доступного для скачивания. Содержимое элемента — описание файла.

@id

Идентификатор страницы описания файла.

@name

Название страницы описания файла.

@link

Ссылка на страницу описания.

@downloads-count

Сколько раз файл был скачан с сайта.

@xlink:download-link

Ссылка, на которую надо перейти, чтобы скачать файл.

@xlink:href

Ссылка UPage на страницу описания файла.

Вывод файлов осуществляется по шаблону, указанному в параметре template. Вы можете не указывать этот параметр, тогда для вывода будет использован шаблон по умолчанию — default.tpl.

Используемые шаблоны

Макрос оперирует шаблонами, находящимися в каталоге /tpls/filemanager/.

Используемые блоки шаблона

list_files

Общий блок для вывода всего списка файлов.

%lines%

Указывает место, куда будет выведен список файлов.

%total%

Общее количество файлов в разделе.

%per_page%

Количество элементов на странице. Используется для постраничного вывода. Смотрите макрос %system numpages()%.

list_files_row

Блок для вывода информации о каждом файле.

%name%

Имя файла.

%desc%

Описание файла.

%link%

Ссылка на подробное описание файла.

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

Добавьте общедоступные файлы в модуле «Файловая система».

Создайте файл sample.tpl в директории /tpls/filemanager/ и напишите в нем следующий код:

<?php

$FORMS = Array();

$FORMS['list_files'] = <<<END
 %lines%
 %system numpages(%total%, %per_page%, 'default')%
END;

$FORMS['list_files_row'] = <<<END
 <div id="download_info">
   <h3>%name%</h3>
   %desc% <br />
   <a href="%link%">Скачать</a>
 </div>
END;

?>

Создайте страницу downloads в модуле «Структура». В редакторе содержимого страницы введите макрос %filemanager list_files('/downloads', 'sample')%. Сохраните страницу. С помощью drag'n'drop в модуле «Структура» перенесите файлы в созданную страницу. Теперь на созданной странице должен появиться список файлов и их описание.