Документация для разработчиков

Альбом (список)

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

В визуальном редакторе компонент находится в Компоненты > Контент > Фотогалерея 2.0.

Компонент относится к модулю Фотогалерея.

Пример вызова компонента photogallery.section.list

Секции настроек компонента:

  • Основные параметры
  • Шаблоны ссылок
  • Настройки кеширования
  • Дополнительные настройки
  • Описание параметров

    Поле Параметр Описание
    Основные параметры
    Тип инфоблока IBLOCK_TYPE Указывается один из созданных в системе типов информационного блока.
    Инфоблок IBLOCK_ID Для выбранного типа инфоблока указывается идентификатор информационного блока, фотографии из которого будут выводиться.
    ID раздела SECTION_ID Указывается числовой код, в котором передается идентификатор раздела. Поле может быть оставлено пустым, если указан Код раздела.
    Код раздела SECTION_CODE Указывается символьный код раздела, из которого будут выбраны фотографии. Поле может быть оставлено пустым, если указан ID раздела.
    Режим работы галереи BEHAVIOUR Указывается режим работы фотогалереи:
    • SIMPLE - простой, т.е. один пользователь;
    • USER - многопользовательский.
    Если параметр принимает значение USER (многопользовательский), то необходимо настроить параметры USER_ALIAS, GALLERY_URL и GALLERY_SIZE.
    Выводить список нескольких фотографий альбома вместо отображения обложки PHOTO_LIST_MODE [Y|N] При отмеченной опции вместо обложки будет выводиться список нескольких фотографий альбома.При выборе данной опции станут доступны дополнительные поля. Дополнительные поля:
    Количество выводимых фотографий в списке альбомов SHOWN_ITEMS_COUNT Задается количество фотографий, которое будет показано на странице списка альбомов.
    Первое поле сортировки фото ELEMENT_SORT_FIELD Указывается первое поле, по которому будет происходить сортировка фотографий:
    • SHOW_COUNTER – по количеству просмотров в среднем;
    • SORT – по индексу сортировки;
    • TIMESTAMP_X – по дате последнего изменения;
    • NAME – по названию;
    • ID – по идентификатору;
    • PROPERTY_RATING – по популярности;
    • PROPERTY_FORUM_MESSAGE_CNT – по количеству комментариев на форуме;
    • PROPERTY_BLOG_COMMENTS_CNT – по количеству комментариев в блоге.
    Порядок сортировки фото ELEMENT_SORT_ORDER Указывается порядок сортировки фотографий:
    • по возрастанию (asc);
    • по убыванию (desc).
    Второе поле сортировки фото ELEMENT_SORT_FIELD1 Указывается второе поле, по которому будет происходить сортировка фотографий:
    • SHOW_COUNTER – по количеству просмотров в среднем;
    • SORT – по индексу сортировки;
    • TIMESTAMP_X – по дате последнего изменения;
    • NAME – по названию;
    • ID – по идентификатору;
    • PROPERTY_RATING – по популярности;
    • PROPERTY_FORUM_MESSAGE_CNT – по количеству комментариев на форуме;
    • PROPERTY_BLOG_COMMENTS_CNT – по количеству комментариев в блоге.
    Порядок сортировки фото ELEMENT_SORT_ORDER1 Указывается порядок сортировки фотографий:
    • по возрастанию (asc);
    • по убыванию (desc).
    Код фотогалереи USER_ALIAS Задается переменная, в которой будет передаваться символьный код фотогалереи.
    По какому полю сортируем разделы SORT_BY Указывается поле, по которому будет происходить сортировка альбомов:
    • ID – по идентификатору;
    • NAME – по названию;
    • SORT – по индексу сортировки;
    • ELEMENTS_CNT – по количеству элементов в альбоме;
    • UF_DATE – по дате.
    Порядок сортировки разделов SORT_ORD Задается порядок сортировки фотографий в разделе:
    • ASCПо возрастанию;
    • DESCПо убыванию.
    Количество элементов на странице PAGE_ELEMENTS Указывается количество альбомов, выводимых на одной странице. Весь список альбомов будет выведен с помощью постраничной навигации.
    Шаблоны ссылок
    Главная страница INDEX_URL Указывается адрес страницы со списком разделов (альбомов).
    URL страницы с содержимым раздела SECTION_URL Указывается адрес страницы с содержимым раздела (альбома).
    Альбом (редактирование) SECTION_EDIT_URL Указывается адрес страницы редактирования параметров альбома. Страница может быть создана с помощью компонента Альбом (редактирование).
    Альбом (редактирование обложки) SECTION_EDIT_ICON_URL Указывается адрес страницы выбора обложки альбома. Страница может быть создана с помощью компонента Альбом (редактирование обложки).
    Страница загрузки фото UPLOAD_URL Указывается адрес страницы загрузки фотографий. Страница может быть создана с помощью компонента Фото (загрузка).
    Содержимое галереи GALLERY_URL Указывается адрес страницы с содержимым галереи.
    Настройки кеширования
    Тип кеширования CACHE_TYPE Тип кеширования:
    • A - Авто + Управляемое: автоматически обновляет кеш компонентов в течение заданного времени или при изменении данных;
    • Y - Кешировать: для кеширования необходимо определить время кеширования;
    • N - Не кешировать: кеширования нет в любом случае.
    Время кеширования (сек.) CACHE_TIME Время кеширования, указанное в секундах.
    Дополнительные настройки
    Размер альбома (px) ALBUM_PHOTO_SIZE Указывается размер картинки обложки фотоальбома в пикселях (px). Размер задается для одной стороны картинки, вторая будет высчитана пропорционально для загружаемого изображения.
    Размер картинки-анонса альбома (px) ALBUM_PHOTO_THUMBS_SIZE Указывается размер картинки-анонса фотоальбома в пикселях (px). Размер задается для одной стороны картинки, вторая будет высчитана пропорционально для загружаемого изображения.
    Шаблон для постраничной навигации PAGE_NAVIGATION_TEMPLATE Указываются название шаблона для постраничной навигации.
    Формат вывода даты DATE_TIME_FORMAT Указывается формат показа даты и времени. В выпадающем списке перечислены все возможные варианты показа даты, формируемые внутри компонента. Выбрав пункт (другое)->, можно сформировать свой вариант на основании php-функции date.
    Устанавливать статус 404, если не найдены элемент или раздел SET_STATUS_404 [Y|N] Если система не находит в каталоге элемент или раздел, то при отмеченной опции вместо HTTP статуса 200 будет сообщаться HTTP статус 404.
    Устанавливать заголовок страницы SET_TITLE [Y|N] При отмеченной опции в качестве заголовка страницы будет установлено Альбомы.
    Размер фотогалереи GALLERY_SIZE Указывается размер галереи пользователя в Мб.


    Пользовательские комментарии

    Мы будем рады, если разработчики добавят свои комментарии по практическому использованию методов системы.

    Для этого нужно всего лишь авторизоваться на сайте

    Но помните, что Пользовательские комментарии, несмотря на модерацию, не являются официальной документацией. Ответственность за их использование несет сам пользователь.

    Также Пользовательские комментарии не являются местом для обсуждения функционала. По подобным вопросам обращайтесь на форумы.
    © «Битрикс», 2001-2019, «1С-Битрикс», 2019
    Наверх