Стандартные компоненты для работы с инфоблоками

При создании инфоблока можно отключить возможность группировки элементов по разделам. Мы рекомендуем всегда ее оставлять, даже если разделы не будут самостоятельной сущностью БД, как в предыдущем примере. Их всегда могут использовать администратор и контент-редактор по прямому назначению, просто для группировки огромного числа элементов.

Создание инфоблока

Старайтесь максимально использовать стандартные поля элементов. Их нельзя удалить и они в любом случае будут занимать место в БД. В поле NAME (Название) можно хранить ФИО (если нужно хранить список людей), наименование (для товаров) или даже дату обращения (для хранения результатов формы).

Если вы отказываетесь от использования поля в работе сайта, то не забудьте скрыть его во всех интерфейсах, где администратор и контент-редактор могут его увидеть. Заметка в инструкции — это хорошо, но если поля не видно, то никто и не попытается его использовать. В системе можно настраивать формы редактирования элементов и разделов, а также списки и фильтры по элементам и разделам инфоблоков.

Для всех используемых полей задумайтесь об их переименовании, если это упрощает понимание для администратора и контент-редактора. Что, например, следует написать в поле “Название” для инфоблока “Менеджеры”? Имя? Фамилию? Фамилию и инициалы? А если поле переименовать в “ФИО полное”? Вопрос отпадет сам собой и без инструкции.

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

Если вам не хватает системных предустановленных полей, вы можете добавить свои свойства. Для этого тщательно продумайте обязательность и тип свойства. Например, серия и номер паспорта — это строка или число? Два свойства или одно? Ответ будет крыться в вариантах использования этих данных в логике сайта.

Всегда создавайте свойства с символьным кодом латиницей и прописными буквами. Так вы не столкнетесь с неожиданным приведением символьного кода к верхнему регистру при работе через API модуля iblock.

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

Для непубличных служебных инфоблоков (например, списка договоров или использованных промокодов) следует отключать вкладку с SEO-полями.

Изменяя настройки отображения в панели администратора, не забывайте применять изменения “для всех”, иначе результатом ваших трудов не сможет воспользоваться никто другой.

global $importantUserMessagesFilter;
$importantUserMessagesFilter = [
    "PROPERTY_USER" => $USER->getId(),
    "PROPERTY_IMPORTANT" => "Y",
];

Список разделов

Следует разделять два случая, когда вам нужно выводить список разделов.

В первом случае вам нужно показать пользователю какое-то количество разделов. Все разделы при этом будут выглядеть однотипно. Это может быть список популярных разделов на главной странице интернет-магазина или перечень важных групп документов. В этом случае используйте bitrix:catalog.section.list.

Во втором случае вам нужно показывать разделы в зоне навигации по сайту. При этом тот раздел, в котором сейчас “находится” пользователь, должен быть выделен. В этом случае используйте связку bitrix:menu.sections и bitrix:menu.

Полезные инструменты

Компоненты для работы с инфоблоками лишь выводят данные, а хранятся они в БД и редактируются через интерфейс администратора. Но все стандартные компоненты в режиме правки позволяют редактировать, создавать и удалять элементы и разделы инфоблоков во всплывающем окне без необходимости куда-то уходить со страницы.

Задача разработчика — не нарушить работу этого механизма при доработке шаблонов сайта. Этот код размещается внутри цикла по $arResult[“ITEMS”] (для элементов) и выглядит примерно так:

А конкретно: методы addEditAction, addDeleteAction и getEditAreaID.

Культура кода в шаблонах компонентов *list

Если нет ни одной записи, компонент не должен выводить ничего, если по дизайну не требуется иного (весь шаблон должен быть обернут в if $arResult["ITEMS"] или foreach).

Компонент должен проверять любые данные перед выводом, чтобы не было пустых атрибутов href у ссылок или src у изображений, пустых кавычек или странных пустых тегов <div></div> или <span></span> в верстке.

Если компонент должен выводить свойство элемента, выберите это свойство в настройках компонента и используйте узел DISPLAY_PROPERTIES в $arResult. Если свойство у элемента заполнено и выбрано в настройках, то в DISPLAY_PROPERTIES оно будет. Так вы повысите управляемость компонента, и разработчик не будет нужен, если заказчику потребуется скрыть какое-то свойство.

Все поля должны быть выбраны в настройках компонента и в коде шаблона выводиться из узла FIELDS.

Все изображения перед выводом должны быть уменьшены до требуемых по верстке размеров. Почти всегда речь идет о сжатии картинок для анонса и детальных картинок “на лету” прямо в коде шаблона компонента до нужных размеров и/или пропорций. Но и при загрузке изображений в инфоблок рекомендуем настроить их сжатие, чтобы не хранить нечаянно загруженную ненужную фотографию сотрудника в UHD-качестве. Обычно хватает первичного сжатия до размера 2000 на 2000 пикселей, но все зависит от проекта.

Все ссылки из шаблона должны выводиться с использованием узлов DETAIL_PAGE_URL, SECTION_PAGE_URL или LIST_PAGE_URL

AJAX-режим

Многие компоненты системы могут работать в режиме без перезагрузки страницы. За это отвечает параметр AJAX_MODE. При установке этого флага любая попытка компонента увести пользователя со страницы будет перехвачена системой и запрос будет отправлен в режиме AJAX. Отправленный запрос будет в фоновом запросе браузера обработан сервером и в ответ будет отправлен итоговый html компонента.

Режим не отключает обычную работу компонента, посетители с отключенным javascript в браузере смогут пользоваться компонентом, как раньше.

Лучшее применение режим находит в комплексных компонентах, о которых будет рассказано в одной из следующих тем.