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

Фотогалерея (комплексный компонент)

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

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

Компонент относится к модулю Информационные блоки.

Пример вызова компонента photo

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

  • Основные параметры
  • Управление адресами страниц
  • Управление режимом AJAX
  • Настройки кеширования
  • Дополнительные настройки
  • Настройки голосования
  • Настройки отзывов
  • Настройки фильтра
  • Настройки TOP'а
  • Настройки списка
  • Настройки детального просмотра
  • Настройки постраничной навигации
  • Настройки 404 ошибки
  • Описание параметров

    Поле Параметр Описание
    Основные параметры
    Тип инфоблока IBLOCK_TYPE Указывается один из созданных в системе типов информационного блока. После выбора инфоблока автоматически произойдёт перезагрузка формы для вывода списка инфоблоков выбранного типа. Если автоматическая перезагрузка не произошла, нажмите кнопку ОК.
    Инфоблок IBLOCK_ID Для выбранного типа инфоблока выбирается нужный информационный блок, фотографии из которого будут выводиться. Если вместо инфоблока будет выбрано другое, то в поле ниже необходимо указать идентификатор нужного инфоблока и нажать кнопку ОК.
    Управление адресами страниц
    Включить поддержку ЧПУ SEF_MODE [Y|N] При отмеченной опции будет включена поддержка ЧПУ.

    Если режим поддержки ЧПУ включен, то необходимо настроить следующие параметры: Настраиваемые параметры при включенном режиме поддержки ЧПУ:
    Каталог ЧПУ (относительно корня сайта) SEF_FOLDER Каталог ЧПУ: путь до папки, с которой работает компонент. Этот путь может как совпадать с физическим путём, так и не совпадать.
    Адреса страниц SEF_URL_TEMPLATES Указываются адреса следующих страниц:
    • sections_top - страница списка разделов с TOP\'ом фотографий;
    • section - страница раздела фотогалереи;
    • detail - страница детального просмотра фотографии.
    SEF_FOLDER, SEF_URL_TEMPLATES.

    Если режим поддержки ЧПУ выключен, то необходимо настроить следующие параметры: Настраиваемые параметры при выключенном режиме поддержки ЧПУ:
    Идентификатор раздела SECTION_ID Указывается идентификатор раздела.
    Идентификатор элемента ELEMENT_ID Указывается идентификатор элемента.
    SECTION_ID, ELEMENT_ID.
    Имена переменных VARIABLE_ALIASES Имена переменных для управления страницами.
    Управление режимом AJAX
    Включить режим AJAX AJAX_MODE [Y|N] При установленной опции для компонента будет включен режим AJAX.
    Включить прокрутку к началу компонента AJAX_OPTION_JUMP [Y|N] Если пользователь совершит AJAX-переход, то при установленой опции по окончании загрузки произойдет прокрутка к началу компонента.
    Включить подгрузку стилей AJAX_OPTION_STYLE [Y|N] Если параметр принимает значение "Y", то при совершении AJAX-переходов будет происходить подгрузка и обработка списка стилей, вызванных компонентом.
    Включить эмуляцию навигации браузера AJAX_OPTION_HISTORY [Y|N] Когда пользователь выполняет AJAX-переходы, то при включенной опции можно использовать кнопки браузера Назад и Вперед.
    Настройки кеширования
    Тип кеширования CACHE_TYPE Тип кеширования:
    • A - Авто + Управляемое: автоматически обновляет кеш компонентов в течение заданного времени или при изменении данных;
    • Y - Кешировать: для кеширования необходимо определить время кеширования;
    • N - Не кешировать: кеширования нет в любом случае.
    Время кеширования (сек.) CACHE_TIME Время кеширования, указанное в секундах.
    Кэшировать при установленном фильтре CACHE_FILTER [Y|N] При отмеченной опции каждый результат, полученный из фильтра, будет кешироваться.
    Учитывать права доступа CACHE_GROUPS [Y|N] При отмеченной опции будут учитываться права доступа при кешировании.
    Дополнительные настройки
    Устанавливать заголовок страницы SET_TITLE [Y|N] При отмеченной опции в качестве заголовка страницы будет установлено Фотогалерея.
    Устанавливать в заголовках ответа время модификации страницыSET_LAST_MODIFIED[Y|N] При отмеченной опции http-ответ сервера будет содержать время последнего изменения страницы (заголовок Last-Modified).
    Использовать дополнительное ограничение доступа USE_PERMISSIONS [Y|N] При отмеченной опции Станет активным поле Группы пользователей, имеющие доступ к детальной информации.
    Группы пользователей, имеющие доступ к детальной информации GROUP_PERMISSIONS Указываются группы пользователей, имеющие доступ к детальной информации.
    будет ограничен доступ к детальной информации элементов инфоблока.
    Настройки голосования
    Разрешить голосование USE_RATING [Y|N] При отмеченной опции посетители смогут голосовать за фотографии, выставляя баллы, на странице с детальной информацией. При установленной опции становятся доступными следующие поля: Доступные поля:
    Максимальный балл MAX_VOTE Указывается максимально возможный балл, т.е. число возможных оценок.
    Подписи к баллам VOTE_NAMES Указываются подписи к каждому баллу. В коде вводится массив, в котором задаются подписи к баллам в таком виде:
    "VOTE_NAMES" => Array("0","1","2","3","4","5"),
    Если подписи заданы, то они будут выведены вместо оценок-цифр. Если массив не задан, то будут использованы значения по умолчанию.
    MAX_VOTE и VOTE_NAMES.
    Настройки отзывов
    Разрешить отзывы USE_REVIEW [Y|N] При отмеченной опции будет доступен функционал отзывов. Функционал отзывов:
    Количество сообщений на одной странице MESSAGES_PER_PAGE Параметр определяет количество выводимых на одной странице сообщений отзывов.
    Использовать CAPTCHA USE_CAPTCHA [Y|N] При отмеченной опции будет выводиться изображение и поле ввода CAPTCHA в форме добавления отзыва в публичной части.
    Путь относительно корня сайта к папке со смайлами PATH_TO_SMILE Задается путь к папке со смайликами относительно корня сайта.
    ID форума для отзывов FORUM_ID Указывается идентификатор форума, в котором будут храниться отзывы пользователей.
    Страница чтения темы (пусто - получить из настроек форума) URL_TEMPLATES_READ Указывается относительный путь к странице чтения темы на форуме. Если поле пусто, путь к странице будет получен из настроек форума.
    Показать ссылку на форум SHOW_LINK_TO_FORUM [Y|N] При отмеченной опции на странице фотографии будет отображена ссылка на форум обсуждения.
    Начинать тему текстом элемента POST_FIRST_MESSAGE [Y|N] При отмеченной опции сообщение в отзыве будет начинаться с анонса фотографии.
    Настройки фильтра
    Показывать фильтр USE_FILTER [Y|N] При отмеченной опции становятся доступными поля настройки фильтра. Поля настройки фильтра:
    Фильтр FILTER_NAME Указывается имя переменной, в которой передается массив параметров из фильтра. Служит для определения выходящих из фильтра элементов. Если поле оставлено пустым, то используется значение по умолчанию.
    Поля FILTER_FIELD_CODE Указываются поля элементов инфоблока, по которым будет возможна фильтрация. Заполняется из публичной части редактора, удерживая клавишу Ctrl либо в коде, указывая массив:
    Array("NAME","PREVIEW_TEXT","PREVIEW_PICTURE","DETAIL_TEXT",""),
    При выборе пункта (не выбрано)-> и без указания вычисления полей в строках ниже (т.е. если задан пустой массив), на странице списка будут выведены поля по умолчанию.
    Свойства FILTER_PROPERTY_CODE Указываются свойства элементов инфоблока, по которым будет возможна фильтрация. Заполняется из публичной части редактора, удерживая клавишу Ctrl либо в коде, указывая массив. При выборе пункта (не выбрано)-> и без указания вычисления полей в строках ниже, на странице детального просмотра свойства не будут выведены.
    Настройки TOP'а
    Максимальное количество выводимых разделов SECTION_COUNT Задается максимальное количество выводимых разделов.
    Максимальное количество фотографий, выводимых в каждом разделе TOP_ELEMENT_COUNT Задается максимальное количество фотографий, выводимых в TOP’е элементов в каждом разделе.
    Количество фотографий, выводимых в одной строке таблицы списка разделов TOP_LINE_ELEMENT_COUNT Указывается количество фотографий, выводимых в одной строке таблицы списка разделов.
    По какому полю сортируем разделы SECTION_SORT_FIELD Указывается поле, по которому будет происходить сортировка разделов в TOP’е элементов:
    • SORT - по индексу сортировки;
    • TIMESTAMP_X - по дате изменения;
    • NAME - по названию;
    • ID - по идентификатору;
    • DEPTH_LEVEL - по уровню вложенности папки.
    Можно указать код любого другого поля.
    Порядок сортировки разделов SECTION_SORT_ORDER Задается порядок сортировки разделов:
    • ASCПо возрастанию;
    • DESCПо убыванию.
    По какому полю сортируем фотографии TOP_ELEMENT_SORT_FIELD Указывается поле, по которому будет происходить сортировка фотографий внутри каждого раздела:
    • SHOWS – по количеству просмотров в среднем;
    • SORT – по индексу сортировки;
    • TIMESTAMP_X – по дате последнего изменения;
    • NAME – по названию;
    • ID – по идентификатору;
    • ACTIVE_FROM – по дате активности с;
    • ACTIVE_TO – по дате активности по.
    Порядок сортировки фотографий в разделе TOP_ELEMENT_SORT_ORDER Задается порядок сортировки фотографий в разделе:
    • ASCПо возрастанию;
    • DESCПо убыванию.
    Поля TOP_FIELD_CODE Указываются поля, которые будут отображены на странице TOP'а элементов. Заполняется из публичной части редактора, удерживая клавишу Ctrl либо в коде, указывая массив:
    Array("NAME","PREVIEW_TEXT","PREVIEW_PICTURE","DETAIL_TEXT",""),
    При выборе пункта (не выбрано)-> и без указания вычисления полей в строках ниже (т.е. если задан пустой массив), на странице списка будут выведены поля по умолчанию.
    Свойства TOP_PROPERTY_CODE Указываются свойства, которые будут отображены на странице TOP'а элементов. Заполняется из публичной части редактора, удерживая клавишу Ctrl либо в коде, указывая массив. При выборе пункта (не выбрано)-> и без указания вычисления полей в строках ниже, на странице детального просмотра свойства не будут выведены.
    Настройки списка
    Количество элементов на странице SECTION_PAGE_ELEMENT_COUNT Указывается количество элементов, выводимых на одной странице. Остальные элементы будут выведены с помощью постраничной навигации.
    Количество фотографий, выводимых в одной строке таблицы раздела SECTION_LINE_ELEMENT_COUNT Указывается количество фотографий, выводимых в одной строке таблицы раздела.
    По какому полю сортируем фотографии ELEMENT_SORT_FIELD Указывается поле, по которому будет происходить сортировка фотографий внутри каждого раздела:
    • SHOWS – по количеству просмотров в среднем;
    • SORT – по индексу сортировки;
    • TIMESTAMP_X – по дате последнего изменения;
    • NAME – по названию;
    • ID – по идентификатору;
    • ACTIVE_FROM – по дате активности с;
    • ACTIVE_TO – по дате активности по.
    Порядок сортировки фотографий в разделе ELEMENT_SORT_ORDER Задается порядок сортировки фотографий в разделе:
    • ASCПо возрастанию;
    • DESCПо убыванию.
    Поля LIST_FIELD_CODE Указываются поля, которые будут отображены на странице детального просмотра. Заполняется из публичной части редактора, удерживая клавишу Ctrl либо в коде, указывая массив:
    Array("NAME","PREVIEW_TEXT","PREVIEW_PICTURE","DETAIL_TEXT",""),
    При выборе пункта (не выбрано)-> и без указания вычисления полей в строках ниже (т.е. если задан пустой массив), на странице списка будут выведены поля по умолчанию.
    Свойства LIST_PROPERTY_CODE Указываются свойства, которые будут отображены на странице детального просмотра. Заполняется из публичной части редактора, удерживая клавишу Ctrl либо в коде, указывая массив. При выборе пункта (не выбрано)-> и без указания вычисления полей в строках ниже, на странице детального просмотра свойства не будут выведены.
    Установить заголовок окна браузера из свойства LIST_BROWSER_TITLE Укажите свойство, которое будет использоваться в качестве заголовка окна браузера при просмотре списка фотографий.
    Настройки детального просмотра
    Установить ключевые слова страницы из свойства META_KEYWORDS Среди всех свойств, определенных для данного инфоблока, выбирается то, в котором содержатся ключевые слова.
    Установить описание страницы из свойства META_DESCRIPTION Среди всех свойств, определенных для данного инфоблока, выбирается то, в котором содержится описание.
    Установить заголовок окна браузера из свойства BROWSER_TITLE Среди всех свойств, определенных для данного инфоблока, выбирается то, в котором содержится заголовок окна браузера.
    Поля DETAIL_FIELD_CODE Указываются поля, которые будут отображены на странице детального просмотра. Заполняется из публичной части редактора, удерживая клавишу Ctrl либо в коде, указывая массив:
    Array("NAME","PREVIEW_TEXT","PREVIEW_PICTURE","DETAIL_TEXT",""),
    При выборе пункта (не выбрано)-> и без указания вычисления полей в строках ниже (т.е. если задан пустой массив), на странице списка будут выведены поля по умолчанию.
    Свойства DETAIL_PROPERTY_CODE Указываются свойства, которые будут отображены на странице детального просмотра. Заполняется из публичной части редактора, удерживая клавишу Ctrl либо в коде, указывая массив. При выборе пункта (не выбрано)-> и без указания вычисления полей в строках ниже, на странице детального просмотра свойства не будут выведены.
    Настройки постраничной навигации
    Выводить над списком DISPLAY_TOP_PAGER [Y|N] При отмеченной опции постраничная навигация будет выведена вверху страницы, над списком.
    Выводить под списком DISPLAY_BOTTOM_PAGER [Y|N] При отмеченной опции постраничная навигация будет выведена внизу страницы, под списком.
    Название категорий PAGER_TITLE Задается название категорий, по которым происходит перемещение при детальном просмотре (например, страница, глава и др.).
    Выводить всегда PAGER_SHOW_ALWAYS [Y|N] При отмеченной опции постраничная навигация будет выводиться всегда, даже если все элементы помещаются на одной странице.
    Название шаблона PAGER_TEMPLATE Указывается название шаблона постраничной навигации.
    Использовать обратную навигацию PAGER_DESC_NUMBERING [Y|N] При отмеченной опции будет использоваться обратная навигация. Для обратной навигации в системе происходит обратный отсчет страниц (последняя страница считается первой). Таким образом, постоянно меняется лишь последняя страница при добавлении нового элемента. Это верно, если новые элементы попадают всегда вверх списка (отсортированы по дате начала активности по убыванию).
    Время кеширования страниц для обратной навигации PAGER_DESC_NUMBERING_CACHE_TIME Задается время кеширования страниц для обратной навигации в сегундах.
    Показывать ссылку "Все" PAGER_SHOW_ALL [Y|N] При отмеченной опции в постраничную навигацию будет добавлена ссылка Все, с помощью которой можно отобразить все фотографии.
    Включить обработку ссылокPAGER_BASE_LINK_ENABLE[Y|N] При отмеченной опции доступна обработка ссылок для постраничной навигации. Станут активны дополнительные поля. Дополнительные поля:
    Url для построения ссылок (по умолчанию - автоматически)PAGER_BASE_LINKЗадается адрес для построения ссылок. Если в параметре ничего не указывать, то адрес будет построен автоматически.
    Имя массива с переменными для построения ссылок в постраничной навигацииPAGER_PARAMS_NAMEЗадается имя переменной, в которой передается массив с переменными для построения ссылок компонентом постраничной навигации.
    Настройки 404 ошибки
    Устанавливать статус 404SET_STATUS_404[Y|N] Опция служит для включения обработки ошибки 404 в компоненте.
    Показ специальной страницыSHOW_404[Y|N] При отмеченной опции будет показана специальная страница Станет активным поле:
    Страница для показа (по умолчанию /404.php)FILE_404Задается адрес страницы, которая будет отображаться при возникновении ошибки 404.
    специальная страница в случае возникновения ошибки 404, в противном случае - будет отображено специальное сообщение. Станет активным поле:
    Сообщение для показа (по умолчанию из компонента)MESSAGE_404Задается сообщение, которое будет показано в случае возникновения ошибки 404. Если ничего не указывать, то будет использоваться стандартное сообщение из компонента.


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

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

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

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

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