Elpha\Migration\Helper\AdminHelper

Хелпер содержит вспомогательные методы для настройки админки (настройки полей списка, формы). Для использования хелпера необходимы установленные модули "iblock" и "highloadblock".

 

Оглавление

  1. getIBlockAdminElementList(string $iblockCode): array
  2. setIBlockAdminElementList(string $iblockCode, array $option = [], bool $silent = false): bool
  3. getIBlockAdminSectionList(string $iblockCode): array
  4. setIBlockAdminSectionList(string $iblockCode, array $option = [], bool $silent = false): bool
  5. getHLAdminList(string $hlName): array
  6. setHLAdminList(string $hlName, array $option = [], bool $silent = false)
  7. getOldAdminList(string $name, string $category = 'list'): array
  8. setOldAdminList(string $name, string $category = 'list', array $option = [], bool $silent = false): bool
  9. getModernAdminList(string $name, string $category = 'main.interface.grid.common'): array
  10. setModernAdminList(string $name, string $category = 'list', array $option = [], bool $silent = false): bool
  11. getAdminList(string $name, string $category = 'list'): array
  12. setAdminList(string $name, string $category = 'list', array $option = [], bool $silent = false): bool
  13. getIBlockAdminElementForm(string $iblockCode): array
  14. setIBlockAdminElementForm(string $iblockCode, array $option = [], bool $silent = false): bool
  15. getIblockAdminSectionForm(string $iblockCode): array
  16. setIBlockAdminSectionForm(string $iblockCode, array $option = [], bool $silent = false): bool
  17. getHLAdminForm(string $hlName): array
  18. setHLAdminForm(string $hlName, array $option = [], bool $silent = false): bool
  19. getAdminForm(string $name, string $category = 'form'): array
  20. setAdminForm(string $name, string $category = 'form', array $option = [], bool $silent = false): bool

getIBlockAdminElementList(string $iblockCode): array

Возвращает настройки списка элементов инфоблока

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

    $adminHelper = $helper->getAdminHelper();

    $this->outDump($adminHelper->getIBlockAdminElementList('popular_articles'));

    return true;
}
        
    

 

setIBlockAdminElementList(string $iblockCode, array $option = [], bool $silent = false): bool

Установит настройки списка элементов инфоблока

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

    $adminHelper = $helper->getAdminHelper();

    $iblockCode = 'popular_articles';

    $options = $adminHelper->getIBlockAdminElementList($iblockCode);

    $options['view']['columns']['NAME'] = [
        'CODE' => 'NAME',
        'SORT' => 1000,
    ];

    $this->outDump($adminHelper->setIBlockAdminElementList($iblockCode, $options));

    return true;
}
        
    

 

getIBlockAdminSectionList(string $iblockCode): array

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

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

    $adminHelper = $helper->getAdminHelper();

    $this->outDump($adminHelper->getIBlockAdminSectionList('popular_articles'));

    return true;
}
        
    

 

setIBlockAdminSectionList(string $iblockCode, array $option = [], bool $silent = false): bool

Установит настройки списка разделов инфоблока

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

    $adminHelper = $helper->getAdminHelper();

    $iblockCode = 'popular_articles';

    $options = $adminHelper->getIBlockAdminSectionList($iblockCode);

    $options['view']['columns']['NAME'] = [
        'CODE' => 'NAME',
        'SORT' => 1000,
    ];

    $this->outDump($adminHelper->setIBlockAdminSectionList($iblockCode, []));

    return true;
}
        
    

 

getHLAdminList(string $hlName): array

Настройки списка для highload-блока

Аргумент Описание
string $hlName Название highload-блока
        
public function up(): bool
{
    $helper = $this->getHelperManager();

    $adminHelper = $helper->getAdminHelper();

    $this->outDump($adminHelper->getHLAdminList('Reviews'));

    return true;
}
        
    

 

setHLAdminList(string $hlName, array $option = [], bool $silent = false)

Установит настройки списка highload-блока

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

    $adminHelper = $helper->getAdminHelper();

    $hlName = 'Reviews';

    $options = $adminHelper->getHLAdminList($hlName);

    $options['columns']['UF_MESSAGE'] = [
        'CODE' => 'UF_MESSAGE',
        'SORT' => 1000,
    ];

    $this->outDump($adminHelper->setHLAdminList($hlName, $options));

    return true;
}
        
    

 

getOldAdminList(string $name, string $category = 'list'): array

Возвращает настройки старого списка

Аргумент Описание
string $name Название списка
string $category Категория списка
        
public function up(): bool
{
    $helper = $this->getHelperManager();

    $adminHelper = $helper->getAdminHelper();

    $this->outDump($adminHelper->getOldAdminList('tbl_reviews', 'list'));

    return true;
}
        
    

 

setOldAdminList(string $name, string $category = 'list', array $option = [], bool $silent = false): bool

Установит настройки старого списка

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

    $adminHelper = $helper->getAdminHelper();

    $name = 'tbl_reviews';

    $options = $adminHelper->getOldAdminList($name);

    $options['columns']['UF_MESSAGE'] = [
        'CODE' => 'UF_MESSAGE',
        'SORT' => 1000,
    ];

    $this->outDump($adminHelper->setOldAdminList($name, 'list', $options));

    return true;
}
        
    

 

getModernAdminList(string $name, string $category = 'main.interface.grid.common'): array

Возвращает настройки современного списка

Аргумент Описание
string $name Название списка
string $category Категория списка
        
public function up(): bool
{
    $helper = $this->getHelperManager();

    $adminHelper = $helper->getAdminHelper();

    $this->outDump($adminHelper->getModernAdminList('tbl_iblock_element_b77c573178067d8d4b83d73baa75b70b', 'main.interface.grid.common'));

    return true;
}
        
    

 

setModernAdminList(string $name, string $category = 'list', array $option = [], bool $silent = false): bool

Установит настройки нового списка

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

    $adminHelper = $helper->getAdminHelper();

    $name = 'tbl_iblock_element_b77c573178067d8d4b83d73baa75b70b';

    $options = $adminHelper->getModernAdminList($name);

    $options['view']['columns']['NAME'] = [
        'CODE' => 'NAME',
        'SORT' => 1000,
    ];

    \CUserOptions::DeleteOptionsByName('main.interface.grid', $name);
    $this->outDump($adminHelper->setModernAdminList($name, 'main.interface.grid.common', $options));

    return true;
}
        
    

 

getAdminList(string $name, string $category = 'list'): array

Возвращает настройки списка

Аргумент Описание
string $name Название списка
string $category Категория списка
        
public function up(): bool
{
    $helper = $this->getHelperManager();

    $adminHelper = $helper->getAdminHelper();

    $this->outDump($adminHelper->getAdminList('tbl_iblock_element_b77c573178067d8d4b83d73baa75b70b', 'main.interface.grid.common'));

    return true;
}
        
    

 

setAdminList(string $name, string $category = 'list', array $option = [], bool $silent = false): bool

Установит настройки списка

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

    $adminHelper = $helper->getAdminHelper();

    $name = 'tbl_iblock_element_b77c573178067d8d4b83d73baa75b70b';

    $options = $adminHelper->getAdminList($name, 'main.interface.grid.common');

    $options['view']['columns'] .= ',NAME';

    \CUserOptions::DeleteOptionsByName('main.interface.grid', $name);
    $this->outDump($adminHelper->setAdminList($name, 'main.interface.grid.common', $options));

    return true;
}
        
    

 

getIBlockAdminElementForm(string $iblockCode): array

Возвращает настройки формы редактирования элемента инфоблока

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

    $adminHelper = $helper->getAdminHelper();

    $this->outDump($adminHelper->getIBlockAdminElementForm('popular_articles'));

    return true;
}
        
    

 

setIBlockAdminElementForm(string $iblockCode, array $option = [], bool $silent = false): bool

Устанавливает настройки формы редактирования элемента инфоблока

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

    $adminHelper = $helper->getAdminHelper();

    $iblockCode = 'popular_articles';

    $options = $adminHelper->getIBlockAdminElementForm($iblockCode);

    $options['Элемент']['ACTIVE'] = [
        'CODE' => 'ACTIVE',
        'TITLE' => 'Активность',
        'SORT' => 1000,
    ];

    $this->outDump($adminHelper->setIBlockAdminElementForm($iblockCode, $options));

    return true;
}
        
    

 

getIblockAdminSectionForm(string $iblockCode): array

Возвращает настройки формы редактирования раздела инфоблока

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

    $adminHelper = $helper->getAdminHelper();

    $this->outDump($adminHelper->getIblockAdminSectionForm('popular_articles'));

    return true;
}
        
    

 

setIBlockAdminSectionForm(string $iblockCode, array $option = [], bool $silent = false): bool

Устанавливает настройки формы редактирования раздела инфоблока

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

    $adminHelper = $helper->getAdminHelper();

    $iblockCode = 'popular_articles';

    $options = $adminHelper->getIblockAdminSectionForm($iblockCode);

    $options['Раздел']['ACTIVE'] = [
        'CODE' => 'ACTIVE',
        'TITLE' => 'Активность',
        'SORT' => 1000,
    ];

    $this->outDump($adminHelper->setIBlockAdminSectionForm($iblockCode, $options));

    return true;
}
        
    

 

getHLAdminForm(string $hlName): array

Возвращает настройки формы редактирования элемента highload-блока

Аргумент Описание
string $hlName Название highload-блока
        
public function up(): bool
{
    $helper = $this->getHelperManager();

    $adminHelper = $helper->getAdminHelper();

    $this->outDump($adminHelper->getHLAdminForm('Reviews'));

    return true;
}
        
    

 

setHLAdminForm(string $hlName, array $option = [], bool $silent = false): bool

Устанавливает настройки формы редактирования highload-блока

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

    $adminHelper = $helper->getAdminHelper();

    $hlName = 'Reviews';

    $options = $adminHelper->getHLAdminForm($hlName);

    $options['Общие данные']['UF_MESSAGE'] = [
        'CODE' => 'UF_MESSAGE',
        'TITLE' => 'Сообщение',
        'SORT' => 1000,
    ];

    $this->outDump($adminHelper->setHLAdminForm($hlName, $options));

    return true;
}
        
    

 

getAdminForm(string $name, string $category = 'form'): array

Возвращает настройки формы редактирования

Аргумент Описание
string $name Название
string $category Категория
        
public function up(): bool
{
    $helper = $this->getHelperManager();

    $adminHelper = $helper->getAdminHelper();

    $this->outDump($adminHelper->getAdminForm('hlrow_edit_5'));

    return true;
}
        
    

 

setAdminForm(string $name, string $category = 'form', array $option = [], bool $silent = false): bool

Устанавливает настройки формы редактирования

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

    $adminHelper = $helper->getAdminHelper();

    $name = 'hlrow_edit_5';

    $options = $adminHelper->getAdminForm($name);

    $options['Общие данные']['UF_MESSAGE'] = [
        'CODE' => 'UF_MESSAGE',
        'TITLE' => 'Сообщение',
        'SORT' => 1000,
    ];

    $this->outDump($adminHelper->setAdminForm($name, 'form', $options));

    return true;
}