Настройки¶

Общие настройки¶

Общие настройки в панели администратора находятся на странице Настройки (см. верхнее меню). Они разбиты на разделы:

• General — Общие
• Appearance — Внешний вид
• Company — Компания
• Stores — Магазины
• Checkout — Оформление заказа
• E-mails — Электронная почта
• Thumbnails — Иконки
• Sitemap — Карта сайта
• Vendors — Продавцы
• Upgrade center — Центр обновлений
• Security settings — Настройки безопасности
• Image verification — Анти-бот (CAPTCHA) — раздел скрыт, начиная с версии 4.5.1
• Logging — Журнал событий
• Reports — Отчёты
• Settings wizard — Мастер настройки

Отображение разделов и настроек зависит от edition_type (см. Приложение №1: Значения edition_type). Для каждого продавца/витрины настройки могут иметь разные значения. Каждая общая настройка, за редким исключением, обязательно принадлежит к какому-либо разделу. В случае, если настройка не привязана к разделу, то она является скрытой.

Например, в edition_type="ULT" при наличии нескольких витрин настройка Alternative currency display format (Формат отображения альтернативной валюты) будет выглядеть следующим образом:

Настройки модуля¶

Управление настройками модуля выполняется на странице Модули → Управление модулями (см. верхнее меню в панели администратора). У большинства модулей есть свои настройки. Открыть настройки модуля можно двумя путями:

• Нажмите на название модуля.
• Наведите курсор на модуль. Справа появится кнопка с изображением шестерёнки. Нажмите на неё и выберите вариант Настройки. При определённых edition_type настройки могут быть недоступны.

Например, вот настройки модуля SEO:

Работа через класс Registry¶

Класс Registry позволяет управлять настройками из любой точки приложения. Также данный класс выполняет кэширование настроек (папка var/cache/registry).

Управление настройками с помощью класса Registry выполняется следующим образом:

• Получение значения настройки ядра/модуля:

  Registry::get('settings.SECTION_NAME.SETTING_NAME');
  Registry::get('addons.ADDON_NAME.SETTING_NAME');
  

• Изменение значения настройки ядра/модуля:

  Registry::set('settings.SECTION_NAME.SETTING_NAME', 'Some value');
  Registry::set('addons.ADDON_NAME.SETTING_NAME', 'Some value');
  

Работа через класс Settings¶

Класс Settings представляет собой расширенный API, предназначенный специально для работы с настройками в CS-Cart, которые хранятся в базе данных. Класс Settings имеет довольно много методов для работы с настройками: проверка доступности настроек и считывание, изменение и удаление их значений.

Вот примеры управления настройкой elements_per_page (Elements per page, Количество элементов на странице) из раздела Settings → Appearance (Настройки → Внешний вид) с помощью класса Settings:

• Проверка доступности настройки:

  Settings::instance()->isExists('elements_per_page', 'Appearance');
  

• Получение значения настройки:

  Settings::instance()->getValue('elements_per_page', 'Appearance');
  

• Изменение значения настройки:

  Settings::instance()->updateValue('elements_per_page', $new_value, 'Appearance');
  

Объявление настроек в addon.xml¶

Для объявления настроек модуля предназначен файл addon.xml. Этот файл лежит в папке с модулем и содержит информацию о модуле и его настройках. Список настроек добавляется в секцию <settings>.

Атрибуты секции <settings>:

• layout — необязательный атрибут; определяет как будет открыто окно с настройками модуля. По умолчанию настройки будут открываться во всплывающем окне. Если указать значение separate, то настройки будут открываться в новом окне.
• edition_type — необязательный атрибут; в данном атрибуте указывается, в каких случаях будет доступна настройка (см. см. Приложение №1: Значения edition_type).

Например, <settings layout="separate" edition_type="ROOT"> означает, что настройки будут открываться в новом окне и будут доступны в режимах Все магазины и Все продавцы.

Структура секции <settings>¶

<settings layout="separate" edition_type="ROOT,ULT:VENDOR">
        <sections> <!-- Список вкладок на странице модуля -->
            <section id="section1"> <!-- Вкладка с настройками имеет следующие атрибуты:
                id — текстовый идентификатор. По данному идентификатору можно обращаться к настройке Registry::get('addons.[addon_id].[setting_id]').
                edition_type — определяет, когда данная вкладка будет доступна. Необязательный параметр; можно задать несколько значений через запятую.
            -->
                <items> <!-- Список настроек в разделе -->
                    <item id="header"> <!-- Настройки модуля
                        id — идентификатор настройки.
                        edition_type — определяет, когда данная настройка будет доступна. Необязательный параметр; можно задать несколько значений через запятую.
                    -->
                        <type>header</type> <!-- см. Приложение №2. Тип элемента:
                            input, textarea, password, checkbox, selectbox, multiple select,
                            multiple checkboxes, countries list, states list,
                            file, info, header, template
                        -->
                        <default_value>radio_1</default_value> <!-- Значение, присваиваемое настройке по умолчанию. -->
                        <variants> <!-- Варианты — для типов selectbox, multiple select,
                            multiple checkboxes, combo select -->
                            <item id="radio_1"></item> <!-- id — идентификатор варианта-->
                        </variants>
                </items>
            </section>
</settings>

Функции для работы с настройками¶

Изменять и добавлять значения настроек можно с помощью двух типов функций: variants.functions и actions.functions:

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

  Такие функции должны располагаться в файле variants.functions.post.php по пути [имя_модуля]/schemas/settings и иметь имя следующего вида: fn_settings_variants_addons_[addon_name]_[setting_name]().

  Допустим, у модуля my_changes есть настройка selectable_box, для которой нужно сгенерировать варианты значений. Для этого нужно создать файл variants.functions.post.php по пути my_changes/schemas/settings. В этот файл нужно добавить функцию с именем: fn_settings_variants_addons_my_changes_selectable_box().

• actions.functions вызываются при установке и удалении модулей. Например, такие функции используется для того, чтобы создать поля в базе данных под настройки модуля или удалить эти поля при удалении модуля.

  Данные функции должны располагаться в файле actions.functions.post.php по пути [имя_модуля]/schemas/settings и иметь имя следующего вида: fn_settings_actions_addons_[addon_name]_[setting_name]().

  Допустим, у модуля my_changes есть настройка page_type, дла которой нужно написать такую функцию. Для этого нужно создать файл actions.functions.post.php по пути my_changes/schemas/settings. В этот файл нужно добавить функцию с именем: function fn_settings_actions_addons_my_changes_page_type().

Таблица settings_sections¶

В таблице settings_sections хранится перечень разделов настроек. Данная таблица содержит следующие основные поля:

• section_id — идентификатор раздела.

• parent_id — идентификатор родительского раздела.

• edition_type — когда раздел будет доступен; это поле указывает на то, будет ли доступен раздел в CS-Cart или Multi-Vendor, и какой уровень доступа должен быть у пользователя. Свойство может быть указано как в единственном числе, так и несколько вариантов через запятую (например, ROOT,ULT:VENDOR).

• name — название раздела.

• position — позиция раздела.

• type — тип раздела:

  • CORE — основной раздел настроек (ядро). Все разделы этого типа перечислены на странице Настройки в панели администратора (контроллер settings.php).
  • ADDON — раздел настроек модуля. Все разделы этого типа выводятся либо во всплывающем окне, либо на отдельной странице и содержат настройки того или иного модуля (контроллер addons.php).
  • TAB — подраздел настроек (вкладка). Может принадлежать как к разделу ядра, так и к разделу настроек модуля. У каждого такого подраздела в поле parent_id указан ID того раздела, к которому он приписан.
  • SEPARATE_TAB — подраздел настроек (вкладка). Может принадлежать разделу ядра и настроек модуля, но добавляется в виде отдельного контейнера. У каждого такого подраздела в поле parent_id указан ID того раздела, к которому он приписан.

  Примечание

  Подразделы могут быть приписаны к разделам с типом CORE или ADDON.

Пример записи в базе данных раздела с настройками Внешний вид (Appearance):

Ниже описано, как узнать идентификатор раздела в панели администратора:

• Общие настройки: откройте страницу Настройки и выберите какой-либо раздел. Название раздела будет в URL в адресной строке браузера (параметр section_id).

  Например, у раздела Внешний вид в URL в параметре section_id будет значение Appearance. URL будет выглядеть следующим образом: example.com/admin.php?dispatch=settings.manage&section_id=Appearance

• Настройки модуля: откройте страницу Модули → Управление модулями и нажмите на кнопку с изображением шестерёнки рядом с нужным модулем. Если навести курсор на вариант Удалить, то в нижней части окна браузера должна появиться ссылка. В ссылке будет название модуля, по которому к этому модулю можно обращаться в коде (параметр addon).

  Например: для модуля С этим товаром часто покупают… наименование будет customers_also_bought, а URL будет выглядеть примерно так (здесь приведена только интересующая нас часть): example.com/admin.php?dispatch=…&addon=customers_also_bought&…

Таблица settings_objects¶

В таблице settings_objects хранится перечень общих настроек и настроек модуля и их значения. Данная таблица содержит следующие основные поля:

• object_id — идентификатор настройки.
• edition_type — когда настройка будет доступна; это поле указывает на то, будет ли доступна настройка в CS-Cart или Multi-Vendor, и какой уровень доступа должен быть у пользователя.
• name — название настройки.
• section_id — идентификатор раздела, к которому принадлежит настройка.
• section_tab_id — идентификатор вкладки, если настройка располагается во вкладке.
• type — тип настройки.
• value — значение настройки.
• position — позиция настройки.

Пример записи в базе данных настройки company_name (Company name, Название компании) из раздела Settings → Company (Настройки → Компания):

Чтобы узнать идентификатор настройки, нужно посмотреть HTML-код страницы с настройкой. Например, узнаем идентификатор настройки elements_per_page (Elements per page, Количество элементов на странице) из раздела Settings → Appearance (Настройки → Внешний вид).

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

Таблица settings_variants¶

В таблице settings_variants хранится перечень вариантов значений для настроек с типом selectbox, multiple select и multiple checkboxes. В настройках с данным типом значение выбирается из заранее определенного списка (группы).

Например, на странице Настройки → Журнал событий есть настройка Заказы. Информация о том, какие варианты выбраны, хранится в настройке log_type_orders (таблица settings_objects). А список возможных вариантов данной настройки хранится в таблице settings_variants.

Получить список всех доступных вариантов для какой-либо настройки можно по полю object_id. Если в таблице нет вариантов для настройки, то значит они формируются динамически с помощью variants.functions.

Таблица settings_descriptions¶

В таблице settings_descriptions хранятся названия разделов, вариантов значений, а также названия настроек и всплывающие подсказки для различных языков. Основные поля таблицы:

• object_id — идентификатор настройки.
• object_type — тип объекта; возможные варианты:
  • V — название для варианта значения (таблица settings_variants).
  • O — название для настройки (таблица settings_objects).
  • S — название для раздела (таблица settings_sections).
• lang_code — код языка.
• value — перевод настройки/раздела/варианта значения.
• tooltip — всплывающая подсказка настройки/раздела/варианта значения.

В этой таблице будут храниться названия для всех языков, установленных в магазине. Следовательно, при поиске нужного значения, наряду с полями object_id и object_type, нужно учитывать и поле lang_code.