Россия

region-img

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

Пользовательские блоки на главной странице

Для создания пользовательского блока для главной страницы перейдите в папку /include/blocks/

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

Уникальность названия поможет обезопасить вас от потери данных в случае перезаписи папки с таким же именем.

Например, возьмем за основу блок «О компании» и создадим на его основе новый блок. При копировании обязательно задайте папке уникальное имя.

Папка с блоком содержит в себе 4 файла и папку локализации.

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

Содержание файлов

class.php

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

В файле требуется изменить имя класса на уникальное:

<?
use SotbitOrigamiActions;
class AboutCustom1 extends Actions
{
	public function afterSaveContent()
	{
		CBitrixComponent::clearComponentCache('bitrix:news.list','');
	}
	public function afterAdd()
	{
		CBitrixComponent::clearComponentCache('bitrix:news.list', '');
	}
}
?>

settings.php

Файл содержит в себе массив с настройками, структура которого представлена ниже:


  • block – параметры блока.
    • name – задается значение имени блока.
    • section – задается принадлежность к категории блоков. Перечень доступных категорий можно увидеть в файле /include/blocks/.sections.php.
  • fields – параметры настроек.
    • title – заголовок блока.
      • name – подпись поля.
      • type – тип поля. Доступные значения: input (текстовое поле), select (раскрывающийся список).
      • group – группа, к которой относится поле. Доступные значения указываются из названия групп настроек ниже.
      • value – значение поля.
  • groups – группы настроек.
    • titles – название группы настроек.
      • name – подпись группы.
  • ext
    • js – указывается массив с указанием файлов скриптов.
    • css – указывается массив с указанием файлов стилей.
  • style – отвечает за настройки дизайна. Не кастомизируется.

В массив можно добавить пользовательские поля. Для этого в массив fields добавьте массив c уникальным ключом, хранящий значения ключей name, type, group и value.

Пример дополнительного поля:

'image-url' =>
  [
    'name' => BitrixMainLocalizationLoc::getMessage('ABOUT_FIELD_SETTINGS_IMG_URL'),
    'type' => 'input',
    'group' => 'settings',
    'value' => '',
  ],

Поле предназначено для хранения ссылки на изображения со сторонних источников.

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

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

Пример дополнительной группы:

'settings' =>
  [
    'name' => BitrixMainLocalizationLoc::getMessage('ABOUT_GROUP_SETTINGS'),
  ],

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

Не забудьте добавить новые переменные в файл локализации.

$MESS['ABOUT_FIELD_SETTINGS_IMG_URL'] = 'Ссылка на изображения';
$MESS['ABOUT_GROUP_SETTINGS'] = 'Настройки';

В результате настройки блока примут вид:

Пример подключения файлов стилей и скриптов

 'js' => [
           $_SERVER['DOCUMENT_ROOT'].'/include/blocks/about_custom_1/js/script.js',
],
'css' =>
[ $_SERVER['DOCUMENT_ROOT'].'/include/blocks/about_custom_1/css/style.css',
],


preview.jpg

Файл содержит изображение, отображаемое при выборе блока.

content.php

Файл содержит шаблон блока, в котором требуется внести необходимые изменения.

Пример пустого блока

<?php
global $settings;
?>
<div class="puzzle_block">
  <ваше воображение> ... </ваше воображение>
</div>

Массив $settings содержит в себе данные из файла settings.php. Таким образом в блоке можно использовать значения настроек, указанных в публичной части сайта.

Массив настроек с ключами: $settings['fields']['title']['value'] хранит в себе значение текстового поля, указанного в меню редактирования в публичной части сайта.

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

Для того, чтобы созданные шаблоны компонентов не удалялись в процессе обновления решения, поместите их в папку, поиск в которой осуществляется в первую очередь, в нашем случае:
/local/templates/sotbit_origami/components.

Добавление пользовательских шаблонов компонентов рассмотрено подробнее в уроке «Шаблоны компонентов».

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

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