Skip to content

Собственный тип пользовательских полей в 1С Битрикс

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

  • Привязка к пользователю
  • Выбор цвета

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

Находим подходящий стандартный тип поля

Естественно мы не будем писать всё с нуля и изобретать велосипеды, а подберём подходящий под наши задачи существующий класс реализующий нужный тип поля. Все классы пользовательских полей хранятся в главном модуле в папке /bitrix/modules/main/classes/general/ файлы классов имеют префикс usertype, здесь вы найдёте следующий набор классов:

  • usertypebool.php
  • usertypedate.php
  • usertypedbl.php
  • usertypeelement.php
  • usertypeenum.php
  • usertypefile.php
  • usertypeint.php
  • usertypesection.php
  • usertypestr.php
  • usertypestrfmt.php
  • usertypetime.php
  • usertypeurl.php

Как мы будем хранить значения? Очевидно что для пользователя это будет USER_ID, а для цвета строка, я предпочитаю hex формат  формат цвета. Следовательно нам потребуется скопировать и кастомизировать классы  usertypeenum (список) и usertypestr (строка). В принципе USER_ID можно реализовать на основе usertypeint, но давайте дадим администратору возможность удобного выбора пользователя, к тому же возможно нам потребуется сделать это поле множественным.

Подготовка  init.php и пространства имён

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

Структура папки local

первый делом рассмотрим init.php

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

Рассмотрим остальные файлы.

Файл constants.php

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

Файл autoload.php

А здесь вызовем загрузчик классов битрикс и добавим в него массив с нашими будущими классами (ссылка на документацию).

Файл event_handler.php

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

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

Как вы уже поняли и листинга файла с константами, наши классы будут лежать в директории /local/php_interface/lib/. Я предпочитаю разделять собственные классы на группы по директориям, например классы для работы с инфоблоками храню в папке Iblock, работы с каталогом в Catalog, для пользовательских свойств предлагаю создать папку UserType.

И так в директории /local/php_interface/lib/UserType/ создадим 2 файла CUserTypeUserId.php и CUserTypeColor.php. Начнём со свойства «Привязка к пользователю».  Определим пространство имён, подключим доп.классы ядра.

В принципе, этого достаточно чтобы наш новый тип свойств появился в этом списке:

Свойство привязка к пользователю

Однако, пока что оно бесполезно. Давайте добавим недостающие методы:

  • GetList() — Получаем список значений
  • GetEditFormHTML() — Получить HTML формы для редактирования свойства
  • GetEditFormHTMLMulty() — Получить HTML формы для редактирования МНОЖЕСТВЕННОГО свойства
  • GetAdminListViewHTML() — Получаем HTML для списка элементов в админке
  • getEmptyCaption() — Получаем текст для пустого значения свойства
  • GetAdminListEditHTML() — Получить HTML для редактирования свойства в списке админ-панели
  • GetAdminListEditHTMLMulty() — Получить HTML для редактирования МНОЖЕСТВЕННОГО свойства в списке админ-панели
  • GetFilterHTML() — Получаем HTML блок для фильтрации списка эдементов по этому свойству

Я не стану размещать здесь все методы, хочу отметить лишь GetList(), т.к. в стандартных классах он обычно возвращает объект CDBResult, а мне больше нравится подготовить данные для отображения заранее, поэтому в нём я получаю массив значений для отрисовки его в методах GetEditFormHTML() и подобных:

Оба класса целиком вы найдёте в конце статьи. Подключив полноценный класс мы получаем вот такое свойство:

Выбор значения собственного свойства

За вывод этого списка отвечает метод GetEditFormHTML(). В настройках свойства так же можно включить множественный вариант его работы, который выглядит так:

Множественный вариант свойства

В данном случае работает метод GetEditFormHTMLMulty(). Если у класса корректно определены метод

  • GetAdminListViewHTML()
  • GetAdminListEditHTML()
  • GetAdminListEditHTMLMulty()

Значение свойств будут так же корректно отображаться и редактироваться в списке элементов:

Множественное свойство в списке + фильтр

На скриншоте виден так же блок фильтрации, он определяется методом GetFilterHTML() . Чтобы вывести собственное свойство в фильтр его можно добавить в настройках формы фильтра так:

Фильтр списка, добавить свойство

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

Пользовательское свойство «Цвет»

Давайте разберёмся с более экзотическим классов «Цвет». Иногда нужно дать возможность контент-менеджеру определять цветовую схему элемента (новости, статьи или какой-то части её оформления), обычно для этого создаётся простое свойство типа «строка» куда записывается цвет скопированный из Photoship или ColorPicker, однако это требует больше действий от контентщика. Давайте реализуем такой функционал прямо внутри элемента.

За основу возьмём стандартный класс типа пользовательского поля «Строка» и определим для него необычный внешний вид (метод GetEditFormHTML()) . Нам так же потребуется какой-нибудь jQuery плагин для выбора цвета, я остановил свой выбор на jQuery ColorPicker он обладает нужным функционалом имеет необходимые события и довольно прост в настройке.

И так, для начала скачаем этот плагин и загрузим всё в /local/media/ как помните выше я определил константу APP_MEDIA_FOLDER.

Создаём класс для свойства «Цвет»

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

Самый примечательный метод здесь это GetEditHTML()

В нём я подключаю css и js файлы плагина и пользовательский CUserTypeColor.js в котором осуществляется запуск плагина и указаны его настройки. Здесь блок colorpickerHolder предназначен для отрисовки формы выбора цвета а в поле  colorpickerHolderInput записывается значение света, когда пользователь меняет параметры в форме или выбирает цвет на палитре при помощи мышки.  Т.к. это демонстрационный пример, методы типа GetAdminListViewHTML() унаследованы у пользовательского типа «Строка» и просто выводят значение цвета в виде HEX-кода.

В результате подключения такого класса и создания пользовательского свойства типа «Цвет» получаем вот такой вот функционал:

Собственное свойство выбор цвета

Его можно использовать для подсветки важных элементов в списке или другого визуального оформления страницы. Как и обещал все материалы из статьи прикреплю в виде архива.

Желаю удачи!

 

Хотите описанную доработку себе на сайт?
Оставьте заявку!

Оставляя заявку, вы даёте согласие на обработку персональных данных и соглашаетесь с политикой конфиденциальности
Понравилось? Поделись с друзьями:Share on VK
VK
Share on Facebook
Facebook
Tweet about this on Twitter
Twitter
ОпубликованоРазработка сайтов на 1С Битрикс

Оставьте первый комментарий!

Добавить комментарий

Ваш e-mail не будет опубликован. Обязательные поля помечены *

Защита от ботов *

Оставляя комментарий на сайте, вы даёте согласие на обработку персональных данных и соглашаетесь с политикой конфиденциальности
© it-svalka.ru 2013 - 2020 г. - Копирование материалов сайта запрещено.