Бітрікс є модульною системою, і в залежності від редакції може містити різний набір модулів для роботи. Кожен модуль має свій набір параметрів, деякі з них зберігаються в базі даних. Управління параметрами модулів здійснюється в адміністративному інтерфейсі, в налаштуваннях відповідного модуля.
Крім всього цього, впливати на параметри модулів можна за допомогою API битрикса. Для роботи з параметрами модулів, що зберігаються в базі даних, існує клас COption. Цей клас містить набір методів, для взаємодії з параметрами модулів. Наприклад, ми можемо отримати деякі параметри або змінити їх.
Перелік методів класу COption:
- GetOptionString — Повертає рядкове значення параметра.
- SetOptionString — Встановлює рядкове значення параметра.
- GetOptionInt — Повертає числове значення параметра.
- SetOptionInt — Встановлює числове значення параметра.
- RemoveOption — параметр Видаляє з бази.
Давайте спробуємо отримати/встановити деякі параметри, що зберігаються в базі. Для прикладу ми візьмемо пару параметрів, параметрів відображення captcha.
В адміністративній частині сайту параметри капчі знаходяться тут:
Налаштування > Налаштування продукту > CAPTCHA
Ми ж спробуємо впливати на параметри коду. Отже, припустимо відомі два параметри, які мені потрібно отримати:
CAPTCHA_arTextColor_1 — Нижня межа випадкового кольору шрифту;
CAPTCHA_arTextColor_2 — Верхня межа випадкового кольору шрифту;
Так як значення цих параметрів має рядковий тип, запит буде здійснюватись за допомогою методу GetOptionString. Подивимося, як з методом звертатися.
Синтаксис:
string
COption::GetOptionString(
string module_id,
string name,
mixed def = false,
string site = false,
bool ExactSite=false
)
Метод повертає рядкове значення параметра option_id, що належить модулю module_id.
Якщо не встановлено параметр site_id, то робиться спроба знайти числовий параметр option_id, що належить модулю module_id для поточного сайту. Якщо такого параметра немає, повертається параметр, загальний для всіх сайтів.
module_id — Ідентифікатор модуля.
name — Ідентифікатор параметра.
def — Значення за замовчуванням. Якщо default_value не задано, то значення для default_value буде братися з масиву з ім’ям ${module_id.»_default_option»} заданого у файлі /bitrix/modules/module_id/default_option.php.
site (з версії 5.0.6)- Ідентифікатор сайту, для якого будуть повернуті параметри. Необов’язковий. За замовчуванням — false (для поточного сайту або якщо не встановлено, то загальні для всіх сайтів).
ExactSite (з версії 10.0.11) – Необов’язковий параметр, за замовчуванням «false».
Отримуємо рядкові параметри:
COption::GetOptionString(“main”, “CAPTCHA_arTextColor_1”, “000000”);
COption::GetOptionString(“main”, “CAPTCHA_arTextColor_2”, “646464”);
Все досить просто, тепер давайте спробуємо визначити значення цих параметрів за допомогою методу SetOptionString.
Синтаксис:
bool COption::SetOptionString(
string module_id,
string name,
string value = “”,
mixed desc = false,
string site = “”
)
Метод встановлює рядковий параметр option_id для модуля module_id. Якщо вказано site_id, параметр встановиться тільки для цього сайту, і не буде впливати на аналогічний параметр іншого сайту. Повертає true, якщо операція пройшла успішно, у противному випадку — false.
module_id — Ідентифікатор модуля. Довжина не більше 50 символів.
name — Ідентифікатор параметра. Довжина не більше 50 символів.
value — Значення параметра. Необов’язковий. За промовчанням». Максимальна довжина збережена значення — 2000 символів.
desc — Опис параметра. Необов’язковий. За замовчуванням — «false» (опис відсутній). Починаючи з версії 14.0.0 не використовується.
site — Ідентифікатор сайту, для якого встановлюється параметр. Необов’язковий. Якщо встановлений false, то буде поточний сайт (з версії 14.0).
Встановлення строкових параметрів:
COption::SetOptionString(“main”, “CAPTCHA_arTextColor_1”, “cccccc”);
COption::SetOptionString(“main”, “CAPTCHA_arTextColor_2”, “cccccc”);
На цьому поки все. Більш докладно про методи класу ви можете подивитися інформацію в документації по роботі API битрикса.
Додав: htmaker, 04.06.2015 р.
(Ще не оцінили)
Завантаження…
Діліться з друзями:
См. також:
Налаштування часу у VMBitrix
Рубрика: Bitrix, Linux
Видалення «кинутих» кошиків в системі Бітрікс
Рубрика: Bitrix
Використання highload-блоків в Bitrix
Рубрика: Bitrix
Як виконати SQL запит в Bitrix
Рубрика: Bitrix
Як підрахувати кількість елементів в Bitrix?
Рубрика: Bitrix
Динамічне масштабування зображень в Bitrix
Рубрика: Bitrix
Виключаємо користувача з ID=1 групи адміністраторів в Bitrix
Рубрика: Bitrix
Як скинути пароль адміністратора у Bitrix?
Рубрика: Bitrix
SQL-запити в бітрікс
Рубрика: Bitrix
