Как создать раздел сайта под управлением «1С Битрикс: Управление сайтом». Основы программирования под Битрикс

В статье даётся краткий обзор шагов, необходимых для создания раздела сайта под управлением «1С-Битрикс: Управление сайтом 6.5». Статья может служить отправной точкой для начала изучения принципов программирования под Битрикс. В тексте статьи содержатся ссылки на соответствующие разделы документации и страницы официальных учебных курсов с более детальной информацией.

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

В статье содержится личный опыт авторов по освоению Битрикс-программирования. Поэтому статья не может рассматриваться как замена официальной документации продукта «1С-Битрикс: Управление сайтом 6.5».

Это черновой вариант статьи. Авторы будут благодарны за уточнения и дополнения.

Содержание

Основы управления контентом

Обзор административного интерфейса

Управление системой и наполнение контентом осуществляется через административный интерфейс Битрикса (см. основные термины).

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

Нам в рамках этой статьи понадобятся только разделы «Контент» и «Настройки».

Раздел «Контент» состоит из двух основных частей:

  • управление структурой сайта;
  • управление инфоблоками и их содержимым.

Основы работы со списками Битрикса

При работе с Битриксом нередко приходится сталкиваться со списками объекетов. Например, при просмотре содержимого инфоблока вы увидите список его элементов.

Экранная форма, на которой отображается список каких-либо объектов, в Битриксе называется формой отчётов.

Работа с формой отчёта во многом аналогична работе с формой списка в «1С: Предприятии».

Форма, открывающаяся по нажатию кнопки «Настройка списка», позволяет настроить, какие столбцы должны отображаться в таблице со списком объектов.

Также некоторые списки могут быть отфильтрованы по одному или нескольким полям. Для выбора полей для фильтрации можно нажать кнопку «Дополнительно» на форме настройки фильтра. Нажатие на этой же форме кнопки «Стрелка вниз» приведёт к выводу всех полей сразу. В качестве условий для поля, рядом с которыми есть знак вопроса, может вводиться не простое значение, а запрос.

Двойной щелчок по элементу списка приводит к открытию формы его редактирования.

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

Имеется также возможность совершать групповые действия с элементами списка. Для этого нужно отметить нужные элементы и внизу списка выбрать действие. Внимание! Если вы ставите флажок «Для всех», то действие применится ко всем элементам списка, а не только к тем, что отображены на текущей странице списка.

Кнопка «Быстрое редактирование» (в виде карандашика) внизу списка позволяет отредактировать основные свойства отмеченных элементов прямо в форме отчёта, не переключаясь на форму редактирования элемента.

Общие свойства объектов Битрикса

Любой объект данных Битрикса может быть активен или неактивен. Активный объект может быть отображён в публичной части сайта. Так, можно установить признак активности для инфоблока, для отдельного его свойства, для отдельного его элемента и т.д. Переведение объекта в неактивный статус обычно используется, когда он черновой и ещё не готов для боевого использования.

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

Также у большинства объектов Битрикса имеется признак «индекс сортировки». Именно по этому полю по умолчанию сортируются объекты. Например, если вы хотите, чтобы в списке инфоблоков их порядок был не произвольным, следует указать, в каком порядке их выводить. У следующего элемента списка этот индекс должен быть больше, чем у предыдущего.

Как создавать инфоблоки и наполнять их информацией

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

Создание раздела сайта обычно начинается с ревизии имеющихся в системе инфоблоков и, если необходимо, создания новых инфоблоков.

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

Создание инфоблока осуществляется в разделе «Контент».

Если создаётся набор инфоблоков похожего назначения (например, новости, статьи и анонсы), то имеет смысл создать тип инфоблоков «Материалы» и включать новые инфоблоки в этот тип.

В нижней части раздела «Контент» имеется пункт «Информ. блоки – Типы информ. блоков».

В типе инфоблоков можно указать, как будут называться разделы и элементы входящих в него инфоблоков. Эти названия могут быть переопределены при создании самих инфоблоков.

После добавления типа инфоблоков он появится в дереве. Выберите этот или другой тип инфоблоков в дереве.

В форме настроек инфоблока следует обратить внимание на следующие параметры:

  • символьный код – именно по этому англоязычному идентификатору инфоблока можно будет к нему обращаться программно;
  • название – пользовательское представление символьного кода, будет использоваться как в административном, так и в публичном интерфейсе.

На вкладке «Подписи» имеется возможность переопределить названия элементов и разделов, заданные в типе инфоблока. Их следует именовать в соответствии с правилами именования, указанными в статье «Введение».

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

Управление свойствами. Связывание инфоблоков

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

Для разных типов возможны разные настройки. Так, при выборе типа «привязка к элементам», необходимо будет выбрать инфоблок, к элементам которого будет осуществляться привязка.

Полезным может оказаться тип «список», если необходимо предоставить пользователю выбор из списка значений (но при этом этот список генерируется не на основе элементов инфоблока, как в случае типа «привязка к разделам»). Можно также дать пользователю право добавлять в этот список элементы, которых в списке ещё не было, либо ограничить его только имеющимися значениями.

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

Навигация по инфоблоку

Навигация по инфоблоку сходна с навигацией по справочнику в 1С.
Вы можете перемещаться по разделам инфоблока аналогично тому, как вы перемещаетесь по файловой структуре диска. Если список большой, то он разбивается на отдельные страницы. Подробнее см. раздел Основы работы со списками Битрикса.

Обратите внимание на столбец «Блокировка». Зелёный кружок означает доступность элемента для редактирования, красный – означает, что элемент редактируется другим пользователем и недоступен вам для редактирования, жёлтый – что элемент редактируется вами (например, в другом окне браузера).

Методика хранения данных инфоблоков

У многих начинающих пользователей Битрикса возникает вопрос о том, каким образом хранятся данные инфоблоков на табличном уровне. Этот резонный вопрос, однако, мы не будем рассматривать в данной статье, поскольку исчерпывающий ответ на этот вопрос вы найдёте на небольшой, но очень содержательной странице официальной документации «Режим хранения свойств в отдельных таблицах».

Как создать раздел сайта и пустую web-страницу

Использование раздела «Управление структурой»

В Битриксе разделы сайта совпадают с папками на диске. Однако не любая папка является разделом сайта. Чтобы папка была включена в структуру сайта, её следует создавать с помощью раздела «Структура сайта».

Обратите внимание, что в этом же разделе, помимо сайтов системы, есть ещё пункт «Файлы и папки». В этом разделе вы можете просмотреть список всех папок на диске сервера, а не только тех, что относятся к разделам.

Как папка, таки файл, принадлежащие структуре сайта, имеют два имени: физическое (под которым они записаны на диске), и пользовательское – под которым они отображаются в структуре сайта и которое доступно для пользователя.

Папки и файлы создаются так же, как разделы и элементы инфоблоков.

Страницы сайта редактируются средствами встроенного редактора системы – в визуальном, текстовом или PHP-режиме.

Шаблоны сайта

При выводе страницы сайта используется тот или иной шаблон сайта.
Шаблон сайта состоит из:

  • файла header.php (обычно это шапка + левый сайдбар);
  • файла footer.php (обычно это подвал + правый сайдбар);
  • файлы клиентских js-скриптов;
  • файлы стилей CSS;
  • файлы используемых в шаблоне картинок и т.п.

У сайта может быть несколько шаблонов (пример: для отображения основной информации, для принт-версии, для разных разделов). Какой шаблон в каких условиях применять, указывается в настройках сайта.

Шаблон может быть отредактирован в визуальном режиме (Настройки – Настройки продукта – Шаблоны сайтов). При этом header.php и footer.php редактируются слвместно, а кнопка WA (work area) позволяет вставить границу между ними: именно в точку WA будет вклиниваться HTML конкретной страницы, к которой применён данный шаблон.

Структура пустой web-страницы

После создания web-страницы к ней применяется один из шаблонов сайта.
Соответственно, при создании пустой страницы в её начале инклудится абстрактная шапка, в конце – абстрактный подвал, а всё, что между ними, подлежит редактированию в визуальном редакторе.

Структура страницы для 1С-Bitrix

Весь текст страницы целиком может быть просмотрен во встроенном PHP-редакторе Битрикса.

Отложенные функции

Обратите внимание на SetTitle. Это – одна из отложенных функций. Так, страница устанавливает с помощью неё свой заголовок (расположенный внутри тега title). Однако фактический вывод заголовка в момент вызова функции не происходит. И любой компонент может изменить заголовок по своему усмотрению (пример: по умолчанию в коде страницы заголовок устанавливается как «Библиотечная статья», а потом компонент вывода текста статьи меняет на «О вкусной и здоровой пище»).

Обратите внимание, что, изменив в режиме редактирования PHP параметр функции SetTitle, вы измените также и пользовательское наименование этой страницы в структуре сайта.

Следует иметь в виду, что если заголовок собирается при помощи нескольких компонентов (например, текущий раздел рубрикатора + название статьи), то второй компонент не сможет запросить текущее значение заголовка (чтобы приплюсовать к нему свои данные), и поэтому следует использовать любой другой способ передачи заголовка. Например, метод $APPLICATION->GetTitle() возвращает заголовок, актуальный в данной точке исполнения кода страницы.

Как создать компонент на основе стандартного компонента

Пространства имён и автообновление

Все компоненты находятся в папке /bitrix/components. Системные компоненты находятся в папке /bitrix/components/bitrix. Содержимое этой папки обновляется системой обновлений и не должно изменяться программистом.

Пользовательские компоненты следует размещать в подпапках папки /bitrix/components. Название каждой из таких подпапок образует пространство имён. Так, если вы создадите подпапку /bitrix/components/mycompany, то все компоненты, размещённые в этой папке, будут иметь имя mycompany:имякомпонента.

Компоненты следует размещать в подпапках пространства имён. При этом если есть несколько компонентов, реализующих разные аспекты одной и той же функции, то следует их именовать в стиле имякомпонента.назначение. Например, если один из компонентов выводит список статей, а другой – саму статью целиком, то имеет смысл их назвать соответственно article.list (полное имя: mycompany:article.list) и article.detail. Если имеется комплексный компонент, агрегирующий в себе функции этих двух, то его следует назвать просто articles.

Обзор стандартных компонентов

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

Ознакомиться с имеющимися компонентами можно, загрузив визуальный редактор. Дерево компонентов (как правило, двухуровневое) расположено в правой его части. В нём компоненты сгруппированы по назначению.

За размещение и регистрацию компонента в дереве визуального редактора отвечает параметр PATH в файле .description.php.

Файловая структура компонента

Структура файлов папок компонента 2.0 для 1С-Bitrix

Принцип работы комплексного компонента (обзорно)

Идеология работы комплексного компонента существенно отличается от простого.

Структура комплексного компонента для 1С-Bitrix

Каждый шаблон комплексного компонента содержит не один файл шаблона template.php, как это сделано в простых компонентах, а столько, сколько простых компонентов объединено в комплексный (и с такими же именами).

В коде комплексного компонента определяется (как правило, на основании параметров QueryString), какой именно файл из шаблона вызывать.
Из файла шаблона происходит вызов соответствующего простого компонента – и дальше управление передаётся полностью ему.

Все шаблоны комплексных компонент включают в себя шаблоны «простых». Они расположены в папке пространство_имён_комплексного_компонента / имя_комплексного_компонента / templates / имя_шаблона_комплексного_компонента / пространство_имён_простого_компонента / имя_простого_компонента. В общем случае определение, какой именно шаблон будет использован в данном конкретном случае, следующий:

  1. в теме комплексного компонента в текущем шаблоне сайта;
  2. в теме комплексного компонента в шаблоне сайта .default;
  3. в теме самого комплексного компонента;
  4. в текущем шаблоне сайта;
  5. в шаблоне сайта .default;
  6. в простом компоненте.

Поэтому если вы изменяете комплексный компонент и вам придётся изменить шаблоны входящих в него простых (причём эти шаблоны будут использоваться только когда простой компонент работает как часть комплексного), то удобнее изменять шаблоны простых компонент, находящиеся в папке изменяемого комплексного компонента, а не в папках простых компонентов.

Копирование компонента для самостоятельного изменения

Компоненты, входящие в поставку, находятся в /bitrix/components/bitrix. Их можно использовать в своих проектах. Однако если нужно внести изменения, то надо скопировать их в собственное пространство имён.

Если копируется комплексный компонент, то нужно не забыть скопировать и сам комплексный компонент (news), и входящие в него простые компоненты (news.list). В шаблонах комплексного компонента следует первым делом изменить вызовы простых компонентов (вызов указывается с пространством имён, и поэтому bitrix надо заменить на имя вашего пространства имён).

Как написать собственный простой компонент «с нуля»

Создание структуры компонента

Удобнее всего найти наиболее похожий по функционалу стандартный компонент – и на его основе разрабатывать свой. В стандартных компонентах уже написаны (притом, корректно) вызовы поверки прав, кэша и т.п.

При разработке же «с нуля» рекомендуется создавать следующую структуру компонента.

  • Файл .description.php – название и описание компонента.
  • Файл .parameters.php – описание входных параметров.
  • Папка lang с файлами локализаций.
  • Папка templates – в ней размещается дефолтный шаблон в папке .default (в которой обязательно должен присутствовать template.*) и папка lang с переводами сообщений шаблона, в которой расположены файлы языковых сообщений (переводов) шаблона компонента. В шаблоне рекомендуется создать style.css и script.js, подключаемые автоматически.

Создание файлов описаний

В .description.php необходимо описать положение компонента в дереве компонентов визуального редактора.

В .parameters.php находится хэш-массив $arComponentParameters с описанием настраиваемых параметров компонента. На основании этого массива формируется форма настройки параметров компонента, размещённого на странице. Также в этом файле содержится код, «оживляющий» работу формы (например, после отметки пользователем флажка бывает необходимо вывести для редактирования дополнительные поля). Обратите внимание, что этот файл не вызывается при формировании пользовательской страницы и служит только для описания формы настройки.

Подмассив GROUPS массива $arComponentParameters описывает, как будут группироваться элементы управления в форме настройки компонента.

Подмасив PARAMETERS описывает собственно элементы управления и их принадлежность к каждой из группировок. При запуске компонента значения, введённые в эти элементы управления, формируют массив $arParams, доступный из кода компонента (в этот массив также входят параметры настройки выбранного шаблона компонента).

Обратите внимание, что при формировании $arParams все его значения подвергаются обработке функцией htmlspecialcharsEx. Исходные (необработанные) значения параметров сохраняются в этом же массиве с теми же ключами, но с префиксом “~”.

Создание главного файла компонента. Кэширование

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

if(!defined("B_PROLOG_INCLUDED") || B_PROLOG_INCLUDED!==true) die();

Затем следует инициализировать массив $arResult, содержащий результат работы компонента, передаваемый в код шаблона. Элементы этого массива следует заполнить значениями по умолчанию, потому что трудно гарантировать, что в процессе исполнения кода компонента все необходимые поля массива будут заполнены.

Далее необходимо проверить, сохранены ли в кэше актуальные данные. Если сохранены, то метод $this->StartResultCache() осуществляет выборку из кэша уже сформированного ранее HTML, отправляет его браузеру, заполняет $arResult (его можно использовать ниже по коду компонента, например, в отложенных функциях) и возвращает false. Если нет валидного кэша, возвращается true – и следует исполнить основной код компонента.

Создание шаблона

Системные шаблоны поставляются вместе с компонентом и лежат в подпапке templates папки компонента. Если нужно только лишь добавить новый шаблон к системному компоненту, при этом не изменяя сам компонент, то в этом случае делать копию системного компонента не нужно: достаточно создать новый шаблон в папке /bitrix/templates/шаблон_сайта/components/пространство_имён.

Шаблоны компонентов рекомендуется копировать средствами Битрикса. Для этого необходимо перейти на нужную страницу, переключиться в режим «Редактировать сайт» и нажать кнопку «Копировать шаблон» (она обычно расположена рядом с кнопкой настройки параметров компонента).

Рекомендуется создавать шаблон в виде папки. Имя шаблона по умолчанию – .default, имена других шаблонов можно задавать произвольно.

При создании шаблонов необходимо также соблюдать правила оформления, продиктованные соображениями безопасности и совместимости (см. файл template_recomendations.doc).

Модификатор результата работы компонента

Можно создать файл result_modifier.php, который подключается непосредственно перед подключением шаблона компонента. Этот файл получает на вход массив результатов работы компонента $arResult и массив параметров вызова компонента $arParams – а на выходе имеет изменённый массив $arResult.

Схема работы файла .result_modifier.php для 1С-Bitrix

Это может потребоваться, например, если нужно использовать стандартный компонент с нестандартным шаблоном (и при этом шаблон требует другой состав полей $arResult).

Такая технология позволяет использовать стандартный компонент (который будет нормально обновляться с помощью SiteUpdate) и разрабатывать собственные шаблоны – при этом не ограничиваясь данными, возвращаемыми стандартным компонентом.

Как встроить вызов компонента в web-страницу

Редактирование параметров компонента

Встраивание компонента производится на уровне редактирования PHP-файла web-страницы. Отредактировать его можно по FTP, с помощью функции «редактировать как PHP» менеджера файлов Битрикса (см. Структура web-страницы) либо прямо в визуальном редакторе.

При работе в режиме визуального редактора необходимо перетащить компонент в нужное место страницы из дерева компонентов. Обратите внимание, что некоторые браузеры (например, Maxthon) при перетаскивании открывают ссылки в новом окне, так что для работы с компонентами эту функцию нужно отключить.

При клике по размещённому на странице компоненту в нижней части редактора появляется форма редактирования $arParameters. Введённые в неё значения сохраняются в системе одновременно с сохранением страницы.

Быстрое редактирование параметров компонента

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

Быстрое редактирование параметров компоненты 2.0 для 1С-Bitrix

Поэтому рекомендуется использовать формы быстрого редактирования параметров. Для этого можно в пользовательском режиме сайта перейти на страницу с редактируемым компонентом и перейти в режим «Редактировать сайт». В этом режиме каждый компонент обрамляется рамкой, над которой располагается контекстная панель.

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

Заключение

Итак, типовая последовательность действия при создании раздела сайта следующая.

  1. Создать инфологическую модель раздела.
  2. Создать/модифицировать необходимые инфоблоки (в том числе настроить связи между инфоблоками).
  3. Добавить в новые инфоблоки по нескольку элементов (и разделов, если необходимо). Так вы сразу сможете видеть содержимое инфоблоков, как только разместите соответствующие компонеты на странице.
  4. Определить для нового раздела шаблон сайта из уже имеющихся либо создать новый шаблон сайта.
  5. При помощи файлового менеджера Битрикса создать раздел сайта (плюс папку на диске сервера).
  6. Создать индексный файл раздела (index.php).
  7. Выбрать необходимые компоненты из имеющихся системных:

    • если требуется модификация самих компонентов, то скопировать их в собственное пространство имён;
    • если требуется модификация только шаблона, то следует создать новый пользовательский шаблон (например, копированием наиболее похожего системного);
    • если требуется модификация только шаблона, но при этом данных, отдаваемых стандартным компонентов, немного не хватает, то можно создать скрипт-модификатор, который дополнит результат работы компонента необходимыми данными;
    • однако рекомендуется по возможности использовать системные компоненты без какой бы то ни было модификации: они достаточно универсальны и имеют множество настраиваемых параметров и шаблонов.
  8. С помощью визуального редактора разместить компоненты на странице и отладить их работу. При отладке удобнее пользоваться режимом «Редактирование сайта».