Беларусь

region-img

Документация Сотбит: Оригами. Для разработчика. Кастомизация шаблона без потерь при обновлении решения. Шаблоны компонентов

Шаблоны компонентов

Шаблон компонента – программный код, преобразующий данные, подготовленные компонентом, непосредственно в HTML-код.

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

  • local/templates/sotbit_origami/components/bitrix – для шаблонов компонентов Битрикс.
  • local/templates/sotbit_origami/components/sotbit – для шаблонов компонентов Сотбит.
Таким образом, шаблон компонента помещается в папку, которая проверяется в первую очередь.
Шаблоны компонентов, которые изменяются в процессе обновления решения, расположены в папке local/templates/.default/components/.

Правила выбора шаблона компонента:

  1. В первую очередь поиск шаблона осуществляется в разделе:
    /local/templates/sotbit_origami/components
  2. В случае, если указанный шаблон не найден, поиск осуществляется в разделе:
    /local/templates/.default/components
  3. Если указанный шаблон не найден в вышеперечисленных разделах, то поиск осуществляется в разделе с шаблонами Битрикс:
    /bitrix/templates/текущий_шаблон_сайта/components
  4. Далее поиск шаблона осуществляется в папке:
    /bitrix/templates/.default/components
  5. В последнюю очередь поиск шаблона осуществляется в папке:
    /bitrix/components
Особенности поиска:
  • Если имя шаблона не задано, то ищется шаблон с именем .default.
  • Если шаблон задан именем папки, то в случае простого компонента в этой папке ищется файл template.ext, а в случае комплексного – название_страницы.ext. Расширение ext сначала принимается равным php, а затем расширениям других доступных на сайте движков шаблонизации.

Подробнее о шаблонах компонентов читайте по ссылке.

Подключение компонентов

Вызов шаблона компонента выглядит следующим образом:

$APPLICATION->IncludeComponent(
	"custom:catalog.element",
	".default",
	array(...),
	$component);

Где:

custom:catalog.element – название компонента, причем по значению, стоящему до знака двоеточия, можно, как правило, определить принадлежность компонента к компании разработчика.
Так в компонентах Битрикс названия составляются по принципу bitrix:название.компонента, а для компонентов Сотбитsotbit:название.компонента. Понимание этой особенности поможет легко понять расположение компонента, а соответственно и его шаблона в файловой системе.

.default – название шаблона компонента. В файловой системе вы найдете папку с таким же названием. Исключение составляет пустое название шаблона компонента. В этом случае применяется шаблон, лежащий в папке .default.

array(...) – массив с параметрами компонента.

$component – переменная, указывающая на родительский компонент.

Таким образом, при необходимости интеграции компонента в пользовательский шаблон, например, шапки сайта требуется:

  1. Поместить код вызова компонента в шаблон.
  2. Указать название шаблона вызываемого компонента.
  3. Разместить шаблон компонента в папке, содержимое которой не изменяется в процессе обновления решения. В нашем случае это:
    /local/templates/sotbit_origami/components/bitrix/ – для компонентов Битрикс. 
    /local/templates/sotbit_origami/components/sotbit/ – для компонентов Сотбит.
Если требуется изменить стандартный шаблон, который изменяется в процессе обновления решения, например, стандартный шаблон шапки сайта, скопируйте шаблон требуемого компонента в папку, указанную в пункте 3 выше. После чего вносите все требуемые изменения в шаблоне компонента, расположенного в этой папке.

Нужна помощь в настройке решения

Оставьте заявку и мы свяжемся с вами!