README

Установка через composer

Пример composer.json с установкой модуля в local/modules/

{
  "extra": {
    "installer-paths": {
      "local/modules/{$name}/": ["type:bitrix-module"]
    }
  },
  "require": {
    "claramente/claramente.options": "dev-master"
  }
}

1. Запустить composer require claramente/claramente.options dev-master

2. В административном разделе установить модуль claramente.options (/bitrix/admin/partner_modules.php?lang=ru)

3. Подключить модуль в /local/php_interface/init.php или в /bitrix/php_interface/init.php добавив строчку CModule::IncludeModule('claramente.options')

4. После установки модуля он будет доступен в разделе Контент => Параметры сайта (/bitrix/admin/claramente_options.php?lang=ru)

Использование модуля

• Получение значения опции для текущего языка: cm_option(code, site_id)
• Получение значения опции для всех языков: cm_option_all_lang(code, site_id)
• Установка нового значения опции: cm_option_set(code, site_id, value)
• Проверка существования опции для текущего языка: cm_option_exists(code, site_id)
• Проверка заполнения опции для текущего языка: cm_option_filled(code, site_id)

О модуле

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

Аналог модуля COption из BX, но с расширенными возможностями: поддерживает удобное форматирование строк в административной панели, позволяет задавать тип данных, устанавливать ограничения и создавать новые типы. Модуль поддерживает возможность мультиязычности. Для каждой опции есть настройка - "Одно значение для всех языков", которое позволяет завести одно значение для всех языков или множество значений под конкретный язык.

В системе доступны несколько предустановленных типов данных:

• Строка
• Строки (множественный ввод, поддержка тысяч строк)
• Флаг (true/false)
• Дата
• Список
• Файл

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

Страница настроек параметров сайта

Страница настроек параметра

Оптимизация работы модуля

1. Кэширование SQL-запросов

Модуль поддерживает возможность кэширования SQL-запросов. Для кэширования отдельных запросов необходимо передать в cm_option последним параметром время кэширования в секундах.

Для включения глобального кэширования следует определить глобальную константу со временем кэша:

const CLARAMENTE_OPTIONS_CACHE_TIME = 3600;

Обратите внимание, что константа должна быть объявлена до вызова метода cm_option.

2. Предварительная загрузка данных

Модуль поддерживает возможность загрузки всех опций сразу. Любой вызов метода cm_option сначала загружает все данные, после чего последующие запросы используют загруженные данные без дополнительных обращений к базе данных.

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

const CLARAMENTE_OPTIONS_PRELOADER = true;

Обратите внимание, что константа должна быть объявлена до вызова метода cm_option.