getList(array $filter = []): array

Возвращает настройки по фильтру

Аргумент Описание
array $filter

Фильтр.

Параметры фильтра:

  • MODULE_ID — идентификатор модуля
  • NAME — символьный код настройки
  • VALUE — значение настройки
  • DESCRIPTION — описание
  • SITE_ID — идентификатор сайта
        
public function up(): bool
{
    $helper = $this->getHelperManager();

    $optionHelper = $helper->getOptionHelper();

    $this->outDump($optionHelper->getList(['MODULE_ID' => 'main',]));

    return true;
}
        
    

 

get(string $moduleId, string $name)

Возвращает настройку. Автоматически преобразует значения сериализованного массива или JSON, добавляя соответствующий тип TYPE='serialize' или TYPE='json'.

Аргумент Описание
string $moduleId Идентификатор модуля
string $name Символьный код настройки
        
public function up(): bool
{
    $helper = $this->getHelperManager();

    $optionHelper = $helper->getOptionHelper();

    $this->outDump($optionHelper->get('main', 'mp_modules_date'));

    return true;
}
        
    

 

getIfExists(string $moduleId, string $name): array

Возвращает настройку, если она есть. Автоматически преобразует значения сериализованного массива или JSON, добавляя соответствующий тип TYPE='serialize' или TYPE='json'.

Аргумент Описание
string $moduleId Идентификатор модуля
string $name Символьный код настройки
        
public function up(): bool
{
    $helper = $this->getHelperManager();

    $optionHelper = $helper->getOptionHelper();

    $this->outDump($optionHelper->getIfExists('main', 'mp_modules_date'));

    return true;
}
        
    

 

save(array $fields, bool $silent = false): bool

Сохраняет настройку

Аргумент Описание
array $fields

Поля настройки:

  • MODULE_ID — идентификатор модуля
  • NAME — символьный код настройки
  • VALUE — значение настройки
  • DESCRIPTION — описание
  • SITE_ID — идентификатор сайта
  • TYPE — тип значения настройки
bool $silent Если значение true, то сообщения не будут выведены на экран
        
public function up(): bool
{
    $helper = $this->getHelperManager();

    $optionHelper = $helper->getOptionHelper();

    $this->outDump($optionHelper->save([
        'MODULE_ID' => 'elpha.migration',
        'NAME' => 'option',
        'VALUE' => [
            1, 2, 3,
        ],
        'TYPE' => 'serialize',
    ]));

    return true;
}
        
    

 

delete(string $moduleId, string $name = null, string $siteId = null, bool $silent = false): bool

Удаляет настройку

Аргумент Описание
string $moduleId Идентификатор модуля
string $name Символьный код настройки
string $siteId Символьный код сайта
bool $silent Если значение true, то сообщения не будут выведены на экран
        
public function up(): bool
{
    $helper = $this->getHelperManager();

    $optionHelper = $helper->getOptionHelper();

    $this->outDump($optionHelper->delete('elpha.migration', 'option'));

    return true;
}
        
    

 

exports($filter = []): array

Экспорт настроек по фильтру

Аргумент Описание
array $filter

Фильтр.

Параметры фильтра:

  • MODULE_ID — идентификатор модуля
  • NAME — символьный код настройки
  • VALUE — значение настройки
  • DESCRIPTION — описание
  • SITE_ID — идентификатор сайта
        
public function up(): bool
{
    $helper = $this->getHelperManager();

    $optionHelper = $helper->getOptionHelper();

    $this->outDump($optionHelper->exports(['MODULE_ID' => 'main',]));

    return true;
}
        
    

 

export(string $moduleId)

Экспорт настроек модуля

Аргумент Описание
string $moduleId Идентификатор модуля
        
public function up(): bool
{
    $helper = $this->getHelperManager();

    $optionHelper = $helper->getOptionHelper();

    $this->outDump($optionHelper->export('main'));

    return true;
}
        
    

 

exportByName(string $moduleId, string $name)

Экспорт настроек по имени

Аргумент Описание
string $moduleId Идентификатор модуля
string $name Символьный код настройки
        
public function up(): bool
{
    $helper = $this->getHelperManager();

    $optionHelper = $helper->getOptionHelper();

    $this->outDump($optionHelper->exportByName('main', 'mp_modules_date'));

    return true;
}