245  /  382
Справочник

Гаджеты и их создание

Просмотров: 30901
Дата последнего изменения: 22.02.2024
Роберт Басыров
Сложность урока:
2 уровень - несложные понятия и действия, но не расслабляйтесь.
1
2
3
4
5
Недоступно в лицензиях:
Ограничений нет
Гаджет – особый программный элемент, выполняющий функцию вывода определенных данных.

Об имеющихся гаджетах, их настройке и управлении ими, вы можете прочитать в курсах:

Для отображения гаджетов используется компонент Рабочий стол (Desktop). Этот одностраничный компонент позволяет создать настраиваемый рабочий стол с использованием этих программных элементов. В компоненте гаджеты инсталлируются вместе с главным модулем системы. Разработчики могут создавать собственные гаджеты. Компонент их увидит, если они будут размещаться в папке /bitrix/gadgets/. (Название папки обязательно должно быть в нижнем регистре.) Системные гаджеты располагаются во вложенной папке /bitrix/.

Внимание! Категорически не рекомендуется без крайней необходимости трогать структуру системных гаджетов.

Структура гаджета

  • .description.php - файл описания, содержащий массив параметров;
  • .parameters.php - файл с настройками. В данном файле формируется массив $arParameters. Особое внимание стоит обратить на ключи PARAMETERS (общие настройки) и USER_PARAMETERS (уникальные настройки конкретного пользователя);
  • файл index.php, который содержит исполняемый код, реализующий задачу гаджета;
  • языковые файлы в папке /lang/.
  • другие служебные файлы и папки.

Гаджеты и компоненты имеют похожую структуру и назначение, однако гаджеты:

  • Не используют шаблоны. HTML код зашит в файле index.php, в отличие от компонентов, где представление и логика разнесены.
  • Могут запоминать настройки для каждого пользователя, в отличие от компонентов, которые могут только выводить или не выводить информацию в зависимости от прав доступа.
  • Их настройки разделены на 2 группы: общие настройки, для гаджетов одного типа (например, для всех гаджетов Новости в рамках одного Рабочего стола), а также настройки каждого конкретного гаджета. Общие настройки задаются в компоненте Рабочий стол. Индивидуальные настройки задаются в контекстном меню каждого конкретного гаджета.

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


Служебные параметры

Служебные параметры недоступны настройке через интерфейс.


ПараметрОписание
NAME Название
DESCRIPTION Описание
ICONИконка (указать путь)
GROUP Группа, к которой относится гаджет. Указание группы определяет где в выпадающем списке гаджетов он будет показан
SU_ONLY Только для подключения у пользователя.
SG_ONLY Только для подключения в группах.
BLOG_ONLY Только для подключения в блогах.
AI_ONLY Только для подключения в административном разделе.
NOPARAMS Нет параметров

Список ссылок по теме:



24
Курсы разработаны в компании «1С-Битрикс»

Если вы нашли неточность в тексте, непонятное объяснение, пожалуйста, сообщите нам об этом в комментариях.
Развернуть комментарии