Elpha\Migration\Helper\ElphaUserSettingsHelper

Хелпер модуля «Эльфа: Пользовательские настройки». Для использования хелпера необходим установленный модуль "elpha.usersettings".

 

Оглавление

  1. getTabs(array $filter = []): array
  2. getTabByCode(string $code)
  3. getTabByCodeIfExists(string $code): array
  4. getTabId(string $code)
  5. getTabIdIfExists(string $code): int
  6. getTabById(int $id)
  7. getTabByIdIfExists(int $id): array
  8. exportTab(int $id)
  9. addTab(string $code, array $fields, bool $silent = false): int
  10. addTabIfNotExists(string $code, array $fields, bool $silent = false): int
  11. updateTab(int $id, array $fields, bool $silent = false): int
  12. updateTabIfExists(int $id, array $fields, bool $silent = false)
  13. saveTab(string $code, array $fields, bool $silent = false)
  14. deleteTab(string $code, bool $silent = false): bool
  15. deleteTabIfExists(string $code, bool $silent = false): bool
  16. getFieldByCode(string $code)
  17. getFieldByCodeIfExists(string $code): array
  18. getFieldId(string $code)
  19. getFieldIdIfExists(string $code): int
  20. getFieldById(int $id)
  21. getFieldByIdIfExists(int $id): array
  22. exportField(int $id)
  23. addField(string $code, array $fields, bool $silent = false): int
  24. addFieldIfNotExists(string $code, array $fields, bool $silent = false): int
  25. updateField(int $id, array $fields, bool $silent = false): int
  26. updateFieldIfExists(int $id, array $fields, bool $silent = false)
  27. saveField(string $code, array $fields, bool $silent = false): int
  28. deleteField(string $code, bool $silent = false): bool
  29. deleteFieldIfExists(string $code, bool $silent = false): bool
  30. getOption(string $key)
  31. setOption(string $key, $value): bool

getTabs(array $filter = []): array

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

Аргумент Описание
array $filter Фильтр
        
public function up(): bool
{
    $helper = $this->getHelperManager();

    $elphaUserSettingsHelper = $helper->getElphaUserSettingsHelper();

    $this->outDump($elphaUserSettingsHelper->getTabs([
        'CODE' => 'MAIN_TAB',
    ]));

    return true;
}
        
    

 

getTabByCode(string $code)

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

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

    $elphaUserSettingsHelper = $helper->getElphaUserSettingsHelper();

    $this->outDump($elphaUserSettingsHelper->getTabByCode('MAIN_TAB'));

    return true;
}
        
    

 

getTabByCodeIfExists(string $code): array

Возвращает вкладку по символьному коду, если она есть

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

    $elphaUserSettingsHelper = $helper->getElphaUserSettingsHelper();

    $this->outDump($elphaUserSettingsHelper->getTabByCodeIfExists('MAIN_TAB'));

    return true;
}
        
    

 

getTabId(string $code)

Возвращает идентификатор вкладки

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

    $elphaUserSettingsHelper = $helper->getElphaUserSettingsHelper();

    $this->outDump($elphaUserSettingsHelper->getTabId('MAIN_TAB'));

    return true;
}
        
    

 

getTabIdIfExists(string $code): int

Возвращает идентификатор вкладки, если она есть

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

    $elphaUserSettingsHelper = $helper->getElphaUserSettingsHelper();

    $this->outDump($elphaUserSettingsHelper->getTabIdIfExists('MAIN_TAB'));

    return true;
}
        
    

 

getTabById(int $id)

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

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

    $elphaUserSettingsHelper = $helper->getElphaUserSettingsHelper();

    $this->outDump($elphaUserSettingsHelper->getTabById(31));

    return true;
}
        
    

 

getTabByIdIfExists(int $id): array

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

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

    $elphaUserSettingsHelper = $helper->getElphaUserSettingsHelper();

    $this->outDump($elphaUserSettingsHelper->getTabByIdIfExists(31));

    return true;
}
        
    

 

exportTab(int $id)

Экспорт вкладки

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

    $elphaUserSettingsHelper = $helper->getElphaUserSettingsHelper();

    $this->outDump($elphaUserSettingsHelper->exportTab(31));

    return true;
}
        
    

 

addTab(string $code, array $fields, bool $silent = false): int

Добавление вкладки

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

    $elphaUserSettingsHelper = $helper->getElphaUserSettingsHelper();

    $this->outDump($elphaUserSettingsHelper->addTab(
        'NEW_TAB',
        [
            'ACTIVE' => 1,
            'LOCALIZATION' => [
                'ru' => [
                    'L_NAME' => 'Новая вкладка',
                    'L_TITLE' => 'Новая вкладка из миграции',
                ],
            ],
        ]
    ));

    return true;
}
        
    

 

addTabIfNotExists(string $code, array $fields, bool $silent = false): int

Добавление вкладки, если ее нет

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

    $elphaUserSettingsHelper = $helper->getElphaUserSettingsHelper();

    $this->outDump($elphaUserSettingsHelper->addTabIfNotExists(
        'NEW_TAB',
        [
            'ACTIVE' => 1,
            'LOCALIZATION' => [
                'ru' => [
                    'L_NAME' => 'Новая вкладка',
                    'L_TITLE' => 'Новая вкладка из миграции',
                ],
            ],
        ]
    ));

    return true;
}
        
    

 

updateTab(int $id, array $fields, bool $silent = false): int

Обновление вкладки

Аргумент Описание
int $id Идентификатор вкладки
array $fields Поля вкладки
bool $silent Если значение true, то сообщения не будут выведены на экран
        
public function up(): bool
{
    $helper = $this->getHelperManager();

    $elphaUserSettingsHelper = $helper->getElphaUserSettingsHelper();

    $this->outDump($elphaUserSettingsHelper->updateTab(
        32,
        [
            'ACTIVE' => 0,
        ]
    ));

    return true;
}
        
    

 

updateTabIfExists(int $id, array $fields, bool $silent = false)

Обновление вкладки, если она есть

Аргумент Описание
int $id Идентификатор вкладки
array $fields Поля вкладки
bool $silent Если значение true, то сообщения не будут выведены на экран
        
public function up(): bool
{
    $helper = $this->getHelperManager();

    $elphaUserSettingsHelper = $helper->getElphaUserSettingsHelper();

    $this->outDump($elphaUserSettingsHelper->updateTabIfExists(
        32,
        [
            'ACTIVE' => 0,
        ]
    ));

    return true;
}
        
    

 

saveTab(string $code, array $fields, bool $silent = false)

Сохранение вкладки

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

    $elphaUserSettingsHelper = $helper->getElphaUserSettingsHelper();

    $this->outDump($elphaUserSettingsHelper->saveTab(
        'NEW_TAB',
        [
            'ACTIVE' => 0,
        ]
    ));

    return true;
}
        
    

 

deleteTab(string $code, bool $silent = false): bool

Удаляет вкладку

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

    $elphaUserSettingsHelper = $helper->getElphaUserSettingsHelper();

    $this->outDump($elphaUserSettingsHelper->deleteTab('NEW_TAB'));

    return true;
}
        
    

 

deleteTabIfExists(string $code, bool $silent = false): bool

Удаляет вкладку, если она есть

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

    $elphaUserSettingsHelper = $helper->getElphaUserSettingsHelper();

    $this->outDump($elphaUserSettingsHelper->deleteTabIfExists('NEW_TAB'));

    return true;
}
        
    

 

getFieldByCode(string $code)

Возвращает поле по коду

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

    $elphaUserSettingsHelper = $helper->getElphaUserSettingsHelper();

    $this->outDump($elphaUserSettingsHelper->getFieldByCode('UF_DEFAULT_REGION'));

    return true;
}
        
    

 

getFieldByCodeIfExists(string $code): array

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

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

    $elphaUserSettingsHelper = $helper->getElphaUserSettingsHelper();

    $this->outDump($elphaUserSettingsHelper->getFieldByCodeIfExists('UF_DEFAULT_REGION'));

    return true;
}
        
    

 

getFieldId(string $code)

Возвращает идентификатор поля по коду

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

    $elphaUserSettingsHelper = $helper->getElphaUserSettingsHelper();

    $this->outDump($elphaUserSettingsHelper->getFieldId('UF_DEFAULT_REGION'));

    return true;
}
        
    

 

getFieldIdIfExists(string $code): int

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

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

    $elphaUserSettingsHelper = $helper->getElphaUserSettingsHelper();

    $this->outDump($elphaUserSettingsHelper->getFieldIdIfExists('UF_DEFAULT_REGION'));

    return true;
}
        
    

 

getFieldById(int $id)

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

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

    $elphaUserSettingsHelper = $helper->getElphaUserSettingsHelper();

    $this->outDump($elphaUserSettingsHelper->getFieldById(33));

    return true;
}
        
    

 

getFieldByIdIfExists(int $id): array

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

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

    $elphaUserSettingsHelper = $helper->getElphaUserSettingsHelper();

    $this->outDump($elphaUserSettingsHelper->getFieldByIdIfExists(33));

    return true;
}
        
    

 

exportField(int $id)

Экспорт поля

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

    $elphaUserSettingsHelper = $helper->getElphaUserSettingsHelper();

    $this->outDump($elphaUserSettingsHelper->exportField(33));

    return true;
}
        
    

 

addField(string $code, array $fields, bool $silent = false): int

Добавляет поле

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

    $elphaUserSettingsHelper = $helper->getElphaUserSettingsHelper();

    $this->outDump($elphaUserSettingsHelper->addField(
        'UF_COMMENT',
        [
            'ACTIVE' => 1,
            'TAB_CODE' => 'MAIN_TAB',
            'UF' => [
                'USER_TYPE_ID' => 'string',
            ],
        ]
    ));

    return true;
}
        
    

 

addFieldIfNotExists(string $code, array $fields, bool $silent = false): int

Добавляет поле, если его нет

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

    $elphaUserSettingsHelper = $helper->getElphaUserSettingsHelper();

    $this->outDump($elphaUserSettingsHelper->addFieldIfNotExists(
        'UF_COMMENT',
        [
            'ACTIVE' => 1,
            'TAB_CODE' => 'MAIN_TAB',
            'UF' => [
                'USER_TYPE_ID' => 'string',
            ],
        ]
    ));

    return true;
}
        
    

 

updateField(int $id, array $fields, bool $silent = false): int

Обновляет поле

Аргумент Описание
int $id Идентификатор поля
array $fields Поля
bool $silent Если значение true, то сообщения не будут выведены на экран
        
public function up(): bool
{
    $helper = $this->getHelperManager();

    $elphaUserSettingsHelper = $helper->getElphaUserSettingsHelper();

    $this->outDump($elphaUserSettingsHelper->updateField(
        35,
        [
            'ACTIVE' => 0,
            'TAB_CODE' => 'TAB1',
        ]
    ));

    return true;
}
        
    

 

updateFieldIfExists(int $id, array $fields, bool $silent = false)

Обновляет поле, если оно есть

Аргумент Описание
int $id Идентификатор поля
array $fields Поля
bool $silent Если значение true, то сообщения не будут выведены на экран
        
public function up(): bool
{
    $helper = $this->getHelperManager();

    $elphaUserSettingsHelper = $helper->getElphaUserSettingsHelper();

    $this->outDump($elphaUserSettingsHelper->updateFieldIfExists(
        35,
        [
            'ACTIVE' => 0,
            'TAB_CODE' => 'TAB1',
        ]
    ));

    return true;
}
        
    

 

saveField(string $code, array $fields, bool $silent = false): int

Сохраняет поле

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

    $elphaUserSettingsHelper = $helper->getElphaUserSettingsHelper();

    $this->outDump($elphaUserSettingsHelper->saveField(
        'UF_COMMENT',
        [
            'ACTIVE' => 1,
        ]
    ));

    return true;
}
        
    

 

deleteField(string $code, bool $silent = false): bool

Удаляет поле

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

    $elphaUserSettingsHelper = $helper->getElphaUserSettingsHelper();

    $this->outDump($elphaUserSettingsHelper->deleteField('UF_COMMENT'));

    return true;
}
        
    

 

deleteFieldIfExists(string $code, bool $silent = false): bool

Удаляет поле, если оно есть

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

    $elphaUserSettingsHelper = $helper->getElphaUserSettingsHelper();

    $this->outDump($elphaUserSettingsHelper->deleteFieldIfExists('UF_COMMENT'));

    return true;
}
        
    

 

getOption(string $key)

Возвращает значение поля

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

    $elphaUserSettingsHelper = $helper->getElphaUserSettingsHelper();

    $this->outDump($elphaUserSettingsHelper->getOption('UF_COMMENT'));

    return true;
}
        
    

 

setOption(string $key, $value): bool

Устанавливает значение поля

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

    $elphaUserSettingsHelper = $helper->getElphaUserSettingsHelper();

    $this->outDump($elphaUserSettingsHelper->setOption('UF_COMMENT', 'value'));

    return true;
}