Фотогалерея (комплексный компонент)
Комплексный компонент фотогалереи позволяет получить полнофункциональную фотогалерею. Физически создается только одна страница на сайте. Настройки компонента дают возможность гибкие возможности управления параметрами вывода фотографий.
Пример вызова
<?$APPLICATION->IncludeComponent(
"bitrix:photo",
".default",
Array(
"SEF_MODE" => "N",
"IBLOCK_TYPE" => "photo",
"IBLOCK_ID" => "8",
"USE_RATING" => "N",
"USE_REVIEW" => "N",
"USE_FILTER" => "N",
"SECTION_COUNT" => "20",
"TOP_ELEMENT_COUNT" => "9",
"TOP_LINE_ELEMENT_COUNT" => "3",
"SECTION_SORT_FIELD" => "sort",
"SECTION_SORT_ORDER" => "asc",
"TOP_ELEMENT_SORT_FIELD" => "sort",
"TOP_ELEMENT_SORT_ORDER" => "asc",
"TOP_FIELD_CODE" => array(0=>"",),
"TOP_PROPERTY_CODE" => array(0=>"",),
"SECTION_PAGE_ELEMENT_COUNT" => "20",
"SECTION_LINE_ELEMENT_COUNT" => "3",
"ELEMENT_SORT_FIELD" => "sort",
"ELEMENT_SORT_ORDER" => "asc",
"LIST_FIELD_CODE" => array(0=>"",),
"LIST_PROPERTY_CODE" => array(0=>"",),
"META_KEYWORDS" => "-",
"META_DESCRIPTION" => "-",
"DETAIL_FIELD_CODE" => array(0=>"SHOW_COUNTER",),
"DETAIL_PROPERTY_CODE" => array(),
"DISPLAY_PANEL" => "Y",
"SET_TITLE" => "Y",
"USE_PERMISSIONS" => "N",
"CACHE_TYPE" => "A",
"CACHE_TIME" => "3600",
"CACHE_FILTER" => "N",
"DISPLAY_TOP_PAGER" => "N",
"DISPLAY_BOTTOM_PAGER" => "Y",
"PAGER_TITLE" => "Фотографии",
"PAGER_SHOW_ALWAYS" => "N",
"PAGER_TEMPLATE" => "",
"PAGER_DESC_NUMBERING" => "N",
"PAGER_DESC_NUMBERING_CACHE_TIME" => "36000",
"VARIABLE_ALIASES" => Array(
"SECTION_ID" => "SECTION_ID",
"ELEMENT_ID" => "ELEMENT_ID"
)
)
);?>
Описание параметров
Основные параметры
- IBLOCK_TYPE
- Тип информационного блока.
- IBLOCK_ID
- Код информационного блока, из которого будет выводиться информация.
Управление адресами страниц
- SEF_MODE
- Включить поддержку ЧПУ.
- VARIABLE_ALIASES
- При отключенной опции SEF_MODE доступны поля для задания Идентификатора раздела (например, SECTION_ID) и Идентификатора элемента (например, ELEMENT_ID). Данные поля задаются в виде массива, например,
"VARIABLE_ALIASES" => Array(
"SECTION_ID" => "SECTION_ID",
"ELEMENT_ID" => "ELEMENT_ID"
)
При включенной опции SEF_MODE доступны следующие параметры: - SEF_FOLDER
- Каталог ЧПУ (относительно корня сайта), который будет отображаться в URL при переходе на создаваемую страницу.
- SEF_URL_TEMPLATES
- В массиве определяются шаблоны адресов различных страниц в новостном разделе:
- Список разделов с TOP'ом фотографий. Указывается путь к начальной странице компонента – список разделов с TOP’ом фотографий. Если в текущем разделе данная страница индексная, то поле можно оставить пустым.
- Раздел фотогалереи. Путь к странице с элементами раздела. Он должен содержать ID раздела. (#SECTION_ID#). По умолчанию поле содержит #SECTION_ID#/
- Фотография детально. Путь к странице с детальной информацией. Он должен содержать ID элемента, например, #SECTION_ID#/#ELEMENT_ID#/
"SEF_URL_TEMPLATES" => Array(
"sections_top" => "top/",
"section" => "#SECTION_ID#/",
"detail" => "#SECTION_ID#/#ELEMENT_ID#/"
),
В публичной части редактора путь к каждой странице задается в отдельном поле.
Настройки кэширования
- CACHE_TYPE
- Тип кеширования:
- А - Авто: действует при включенном автокешировании на странице Настройки кэширования (Настройки > Настройки продукта > Автокеширование) и при установленном времени кеширования в поле CACHE_TIME.
- Y - Кешировать: должно быть установленовремя кеширования (CACHE_TIME). Настройки автокеширования не влияют на данный тип кеширования.
- N - Не кешировать: кеширование не происходит.
- CACHE_TIME
- Время кеширования в секундах.
- CACHE_FILTER
- Кешировать при установленном фильтре. При установленной опции каждый результат, полученный из фильтра будет кешироваться. Имеет смысл отмечать, если многие пользователи используют одну и туже выборку из фильтра.
Дополнительные настройки
- DISPLAY_PANEL
- Добавлять кнопку в режиме редактирования сайта на Административной панели и в наборе кнопок области редактирования данного компонента.
- SET_TITLE
- Устанавливать в качестве заголовка страницы имя текущего инфоблока.
- USE_PERMISSIONS
- Использовать дополнительное ограничение доступа к детальной информации элементов инфоблока. При установленной опции становится доступным следующее поле:
- GROUP_PERMISSIONS
- Выбор группы пользователей, имеющих доступ к детальной информации.
Настройки постраничной навигации
- DISPLAY_TOP_PAGER
- Навигация по страницам будет выведена вверху страницы, над списком.
- DISPLAY_BOTTOM_PAGER
- Навигация по страницам будет выведена внизу страницы, под списком.
- PAGER_TITLE
- Название категорий, по которым происходит перемещение при детальном просмотре (например, страница, глава и др.)
- PAGER_SHOW_ALWAYS
- Выводить всегда. Если данный флаг не отмечен, постраничная навигация не будет выводиться, если все элементы помещаются на одной странице. Если отмечен, то всегда будет выводиться.
- PAGER_TEMPLATE
- Название шаблона постраничной навигации. Если поле пусто, то выбирается шаблон по умолчанию (.default). Также в системе задан шаблон orange.
- PAGER_DESC_NUMBERING
- Использовать обратную навигацию, когда при добавлении нового элемента постоянно меняется только последняя страница. Остальные страницы можно закешировать на длительный срок.Это верно, если новые элементы попадают всегда вверх списка (отсортированы по дате начала активности по убыванию).
- PAGER_DESC_NUMBERING_CACHE_TIME
- Время кеширования страниц для обратной навигации.
Настройки детального просмотра
- META_KEYWORDS
- Установить ключевые слова страницы из свойств инфоблока.
- META_DESCRIPTION
- Установить описание страницы из свойств инфоблока.
- DETAIL_FIELD_CODE
- Поля, которые будут отображены на странице детального просмотра. Задается в виде массива с символьными именами полей в коде или в публичной части редактора, удерживая клавишу Ctrl. Если ничего не выбрано, то будут выведены поля по умолчанию.
- DETAIL_PROPERTY_CODE
- Свойства, которые будут отображены на странице детального просмотра. Задается в виде массива с символьными именами свойств в коде либо в публичной части редактора, удерживая клавишу Ctrl. Если ничего не выбрано, то свойства отображены не будут.
Настройки отзывов
- USE_REVIEW
- Функция подключает настройки отзывов, выводимых на странице. При установленной опции становятся доступными следующие поля:
- MESSAGES_PER_PAGE
- Количество сообщений на одной странице.
- USE_CAPTCHA
- Опция определяет вывод изображения и поля ввода CAPTCHA в форме добавления отзыва в публичной части.
- PATH_TO_SMILE
- Путь относительно корня сайта к папке со смайлами. Значение по умолчанию /bitrix/images/forum/smile/.
- FORUM_ID
- ID форума, созданного для отзывов посетителей.
- URL_TEMPLATES_READ
- Указывается относительный путь к странице чтения темы на форуме. Если поле пусто, путь к странице будет получен из настроек форума.
Настройки фильтра
- USE_FILTER
- Показывать фильтр. При отмеченной опции доступны следующие поля:
- FILTER_NAME
- Задается имя переменной, в которой передается массив параметров из фильтра. Служит для определения выходящих из фильтра элементов. Поле может быть оставлено пустым, тогда используется значение по умолчанию.
- FILTER_FIELD_CODE
- Выбор полей элементов инфоблока, по которым будет возможна фильтрация. Заполняется из публичной части редактора, удерживая клавишу Ctrl либо в коде, указывая массив:
Array("NAME","PREVIEW_TEXT","SORT",""),
- FILTER_PROPERTY_CODE
- Свойства элементов инфоблока по которым будет возможна фильтрация. Заполняется из публичной части редактора, удерживая клавишу Ctrl либо в коде, указывая массив.
Настройки TOP'а
- SECTION_COUNT
- Максимальное количество выводимых разделов.
- TOP_ELEMENT_COUNT
- Максимальное количество фотографий, выводимых в каждом разделе.
- TOP_LINE_ELEMENT_COUNT
- Количество фотографий, выводимых в одной строке таблицы списка разделов.
- SECTION_SORT_FIELD
- Указывается поле, по которому будет происходить сортировка разделов в TOP’е элементов.
- sort - по индексу сортировки;
- timestamp_x - по дате изменения;
- name - по названию;
- ID - по ID;
- depth_level - по уровню вложенности.
Можно указать код любого другого поля. - SECTION_SORT_ORDER
- Порядок сортировки разделов.
- asc – по возрастанию;
- desc – по убыванию.
- TOP_ELEMENT_SORT_FIELD
- По какому полю сортируем фотографии
- shows - по количеству просмотров в среднем;
- sort - по индексу сортировки;
- timestamp_x - по дате изменения;
- name - по названию;
- ID - по ID;
- active_from - по дате начала активности;
- active_to - по дате окончания активности.
Можно указать код любого другого поля. - TOP_ELEMENT_SORT_ORDER
- Порядок сортировки фотографий в разделе.
- asc – по возрастанию;
- desc – по убыванию.
- TOP_FIELD_CODE
- Поля, которые будут отображены на странице TOP'а элементов. Задается в виде массива с символьными именами полей в коде или в публичной части редактора, удерживая клавишу Ctrl. Если ничего не выбрано, то будут выведены поля по умолчанию.
- TOP_PROPERTY_CODE
- Свойства, которые будут отображены на странице TOP'а элементов. Задается в виде массива с символьными именами свойств в коде либо в публичной части редактора, удерживая клавишу Ctrl. Если ничего не выбрано, то свойства отображены не будут.
Настройки списка
- SECTION_PAGE_ELEMENT_COUNT
- Количество элементов на одной странице. Остальные элементы будут выведены с помощью постраничной навигации.
- SECTION_LINE_ELEMENT_COUNT
- Количество фотографий, выводимых в одной строке таблицы раздела.
- ELEMENT_SORT_FIELD
- По какому полю сортируем фотографии. Указывается поле, по которому будет происходить сортировка фотографий внутри каждого раздела.
- shows - по количеству просмотров в среднем;
- sort - по индексу сортировки;
- timestamp_x - по дате изменения;
- name - по названию;
- ID - по ID;
- active_from - по дате начала активности;
- active_to - по дате окончания активности.
Можно указать код любого другого поля. - ELEMENT_SORT_ORDER
- Порядок сортировки фотографий в разделе.
- asc – по возрастанию;
- desc – по убыванию.
- LIST_FIELD_CODE
- Поля, которые будут отображены на странице списка элементов. Задается в виде массива с символьными именами полей в коде или в публичной части редактора, удерживая клавишу Ctrl. Если ничего не выбрано, то будут выведены поля по умолчанию.
- LIST_PROPERTY_CODE
- Свойства, которые будут отображены на странице списка элементов. Задается в виде массива с символьными именами свойств в коде либо в публичной части редактора, удерживая клавишу Ctrl. Если ничего не выбрано, то свойства отображены не будут.
Настройки голосования
- USE_RATING
- Разрешить голосование. При установленной опции становятся доступными следующие поля:
- MAX_VOTE
- Максимально возможный балл, т.е. число возможных оценок.
- VOTE_NAMES
- Массив, в котором задаются подписи к баллам в таком виде:
"VOTE_NAMES" => Array("оч плохо","плохо","удв","хор","отл",""),
Если подписи заданы, то они будут выведены вместо оценок-цифр. Если массив не задан, то будут использованы значения по умолчанию.