Download the PHP package ge1i0n/bitrix-options without Composer

On this page you can find all versions of the php package ge1i0n/bitrix-options. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.

FAQ

After the download, you have to make one include require_once('vendor/autoload.php');. After that you have to import the classes with use statements.

Example:
If you use only one package a project is not needed. But if you use more then one package, without a project it is not possible to import the classes with use statements.

In general, it is recommended to use always a project to download your libraries. In an application normally there is more than one library needed.
Some PHP packages are not free to download and because of that hosted in private repositories. In this case some credentials are needed to access such packages. Please use the auth.json textarea to insert credentials, if a package is coming from a private repository. You can look here for more information.

  • Some hosting areas are not accessible by a terminal or SSH. Then it is not possible to use Composer.
  • To use Composer is sometimes complicated. Especially for beginners.
  • Composer needs much resources. Sometimes they are not available on a simple webspace.
  • If you are using private repositories you don't need to share your credentials. You can set up everything on our site and then you provide a simple download link to your team member.
  • Simplify your Composer build process. Use our own command line tool to download the vendor folder as binary. This makes your build process faster and you don't need to expose your credentials for private repositories.
Please rate this library. Is it a good library?

Example code of ge1i0n/bitrix-options

Informations about the package bitrix-options

Latest Stable Version Total Downloads

Bitrix Options — генератор форм настроек в административной панели Битрикс

Пакет для удобной генерации страниц настроек модулей в административной панели 1С-Битрикс. Позволяет описывать форму настроек в декларативном стиле через fluent-интерфейс — без шаблонов и без ручного HTML.

Содержание

Поддержка версий

BitrixOptions mpm.options PHP
1.0+ 1.0+ 7.0+
1.0+, 2.0+ 2.0+ 8.2+

Установка

Через marketplace

  1. Установить модуль mpm.options из маркетплейса Битрикс.
  2. Создать файл настроек модуля (например, options.php).
  3. Подключить модуль и вызвать генератор формы:

Через Composer

Подключение в свой модуль для маркетплейса (без Composer)

Если ваш модуль распространяется через marketplace и не использует Composer, скопируйте файлы пакета в свой модуль и зарегистрируйте автозагрузку в include.php:

Быстрый старт

Поместите этот код в options.php вашего модуля. Файл должен быть доступен из административной панели через меню «Настройки» → «Настройки продукта» → «Настройки модулей».

Демо-пример (examples/demo.php)

В пакете есть полноценный демонстрационный файл examples/demo.php, который показывает все типы полей пакета с различными комбинациями настроек. Это отличная отправная точка для изучения возможностей пакета.

Что показывает демо

Демо-страница содержит три вкладки:

Вкладка Что показывает
📋 Базовые поля Text, Textarea (с resize, без resize, количество строк), Number (с min/max/step), Checkbox, Select (одиночный и множественный)
⚙️ Дополнительные поля ColorPicker, Date, Email, Heading, Alert (все варианты icon/size/textPosition/color), HtmlEditor, Condition
🎨 Стилизация Примеры всех fluent-модификаторов: hint, tag (разные TagColor), color обводки (Color), ширина (Width), высота (Height), стиль (TextStyle), display, autocomplete, disabled/readonly

Как запустить демо

  1. Скопируйте examples/demo.php в публичную директорию вашего проекта (например, local/admin/ или bitrix/admin/).
  2. Откройте страницу в браузере: http://your-project.local/bitrix/admin/demo.php.
  3. Сохраняйте/изменяйте значения — они хранятся в Bitrix\Main\Config\Option для модуля bitrix_options_demo.
  4. Нажмите «Сбросить демо-опции» чтобы очистить все сохранённые значения.

Важно: Демо-файл предназначен только для локальной разработки. Не используйте его на боевых сайтах.

Схема работы

На странице настроек вызывается статический метод Form::make(), в который передаются:

  1. ID модуля — строка, идентификатор вашего модуля.
  2. Массив табов — описание вкладок и полей внутри них.

Каждый Tab содержит массив полей. Порядок полей соответствует порядку в массиве (в отличие от v1.x, где использовалось поле сортировки).

Типы полей

Общая информация

Все типы полей создаются через статический метод make(), который принимает:

Fluent-методы возвращают $this, поэтому их можно вызывать цепочкой.

Heading — Заголовок

Выводит заголовок-разделитель между группами полей. Заменяет группы полей из v1.x.

По умолчанию HTML экранируется. ->allowHtml() отключает экранирование — используйте с осторожностью.

Alert — Предупреждение / Информационное сообщение

Выводит блок с сообщением, используя ui.alerts из D7. Настраивается через fluent-методы:

Enums для Alert:

Enum Значения
AlertIcon INFO, WARNING, DANGER
AlertSize XS, SM, MD, LG
AlertTextPosition CENTER, INLINE, BLOCK
Color ACTIVE, SUCCESS, WARNING, DANGER, DISABLED

Text — Текстовое поле

Базовое поле, от которого наследуются все остальные (Date, Email, Number, Checkbox и др.).

Date — Поле для даты

Текстовое поле с типом date.

Email — Поле для email

Текстовое поле с типом email.

Number — Числовое поле

Текстовое поле с типом number. Дополнительные методы: min(), max(), step().

Checkbox — Переключатель

Хранит значение в формате Y / N, отображается как чекбокс.

ColorPicker — Выбор цвета

Поле выбора цвета. Дополнительные методы: cols(), rows().

Важно: При сохранении страницы, если цвет не выбран, по умолчанию сохраняется чёрный.

Textarea — Многострочное поле

Поле для многострочного ввода.

Enums для Resize: NO_RESIZE, RESIZE_X, RESIZE_Y, RESIZE_BOTH.

Select — Выбор из списка

Селектор с поддержкой одиночного/множественного выбора.

При multiple() имя поля в форме становится KEY[], а значение в БД хранится в сериализованном виде.

HtmlEditor — HTML-редактор

Редактор с переключением между режимами text, html и визуальный редактор.

Condition — Конструктор условий

Поле выбора условий, основанное на классе CCatalogCondTree. Используется для построения сложных логических условий (например, правил работы с корзиной). Значение хранится в БД в формате base64(serialize(...)).

Общие трейты (fluent-методы)

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

Трейт Методы Описание Применяется в
WithModuleId setModuleId() Устанавливает ID модуля (вызывается автоматически из Tab::view()) Все поля
WithHint setHint() Добавляет всплывающую подсказку с иконкой Text, Textarea, Number, Checkbox, HtmlEditor и др.
WithTag setTag(string, TagColor) Добавляет цветной тег рядом с полем Text, Number, Email, Date, Checkbox, ColorPicker
WithColor setColor(Color) Устанавливает цвет обводки поля Text, Number, Email, Date, Checkbox, ColorPicker, Alert
WithStyleClass getClassFromProps() Собирает CSS-классы из свойств (display, width, height, color, style) Text, Alert
WithDisplayWithoutValue — Для полей, которые отображают информацию, но не хранят значения Alert, Heading

Enum-классы

Enum Значения Для чего
Color ACTIVE, SUCCESS, WARNING, DANGER, DISABLED, HOVER Цвет обводки
Width DEFAULT, AUTO, W25, W33, W50, W75, FULL Ширина поля
Height XS, SM, MD, LG Высота поля
TextStyle ROUND, UNDERLINE, NO_BORDER Стиль текстового поля
Display INLINE, BLOCK Режим отображения
TagColor PRIMARY, SUCCESS, DANGER, WARNING, INFO Цвет тега
Resize NO_RESIZE, RESIZE_X, RESIZE_Y, RESIZE_BOTH Направление ресайза Textarea

Безопасность

Экранирование данных

Все данные, выводимые в HTML-атрибуты, экранируются через htmlspecialchars(). Это защищает от XSS-атак при вводе специальных символов в названия, значения и другие текстовые поля.

allowHtml() — осознанный риск

Метод allowHtml() доступен для полей Alert и Heading. Он отключает экранирование, позволяя выводить HTML-разметку.

Используйте allowHtml() только когда:

Если вы передаёте пользовательские данные в поле с allowHtml(), убедитесь, что они экранированы самостоятельно.

Сериализация

Поля Select (множественный), HtmlEditor и Condition хранят данные в сериализованном виде. Пакет корректно обрабатывает краевые случаи: false, пустую строку, некорректный base64.

Тестирование

Пакет имеет 177 PHPUnit-тестов, которые покрывают:

Запуск тестов

Структура тестов

Как работают тесты (без реального Bitrix)

Тесты не требуют установленного 1С-Битрикс. Вместо него используются моки в tests/Mocks/:

Это позволяет запускать тесты в любой среде, где есть PHP и Composer.

Как написать свой тест

Тестирование с mock-данными

Моки Option позволяют проверить чтение/запись значений без базы данных:

Статический анализ

Пакет проверяется PHPStan на уровне --level=9:

Структура пакета

Миграция с v1 на v2

Если вы используете старую версию пакета с конфигурацией в виде массивов, утилита миграции автоматически преобразует v1-конфиг в современный fluent-код v2.

Подробнее: migration/docs/MIGRATION.md Примеры конфигураций: migration/examples/

Дополнительно

Разработка

Запуск тестов

Статический анализ

All versions of bitrix-options with dependencies

PHP Build Version
Package Version
Requires php Version >=8.2
ext-mbstring Version *
Composer command for our command line client (download client) This client runs in each environment. You don't need a specific PHP version etc. The first 20 API calls are free. Standard composer command

The package ge1i0n/bitrix-options contains the following files

Loading the files please wait ...