getList(array $filter = []): array

Возвращает список highload-блоков по фильтру

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

    $hlHelper = $helper->getHLHelper();

    $this->outDump($hlHelper->getList(['NAME' => 'Reviews',]));

    return true;
}
        
    

 

exports(array $filter = []): array

Экспорт highload-блоков по фильтру

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

    $hlHelper = $helper->getHLHelper();

    $this->outDump($hlHelper->exports(['NAME' => 'Reviews',]));

    return true;
}
        
    

 

export(string $name)

Экспортирует highload-блок

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

    $hlHelper = $helper->getHLHelper();

    $this->outDump($hlHelper->export('Reviews'));

    return true;
}
        
    

 

getByName(string $name)

Возврашает highload-блок по имени

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

    $hlHelper = $helper->getHLHelper();

    $this->outDump($hlHelper->getByName('Reviews'));

    return true;
}
        
    

 

getByNameIfExists(string $name): array

Возврашает highload-блок по имени, если он есть

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

    $hlHelper = $helper->getHLHelper();

    $this->outDump($hlHelper->getByNameIfExists('Reviews'));

    return true;
}
        
    

 

getId(string $name)

Возврашает идентификатор highload-блока по имени

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

    $hlHelper = $helper->getHLHelper();

    $this->outDump($hlHelper->getId('Reviews'));

    return true;
}
        
    

 

getIdIfExists(string $name): int

Возврашает идентификатор highload-блока по имени, если он есть

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

    $hlHelper = $helper->getHLHelper();

    $this->outDump($hlHelper->getIdIfExists('Reviews'));

    return true;
}
        
    

 

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

Сохраняет highload-блок

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

    $hlHelper = $helper->getHLHelper();

    $this->outDump($hlHelper->save([
        'NAME' => 'Reviews',
        'LANG' => [
            'ru' => [
                'NAME' => 'Новый заголовок',
            ],
        ],
    ]));

    return true;
}
        
    

 

add(array $fields, bool $silent = false)

Добавляет highload-блок

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

    $hlHelper = $helper->getHLHelper();

    $this->outDump($hlHelper->add([
        'NAME' => 'Comments',
        'TABLE_NAME' => 'comments',
        'LANG' => [
            'ru' => [
                'NAME' => 'Заголовок',
            ],
        ],
    ]));

    return true;
}
        
    

 

addIfNotExists(array $fields, bool $silent = false)

Добавляет highload-блок, если его нет

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

    $hlHelper = $helper->getHLHelper();

    $this->outDump($hlHelper->addIfNotExists([
        'NAME' => 'Comments',
        'TABLE_NAME' => 'comments',
        'LANG' => [
            'ru' => [
                'NAME' => 'Заголовок',
            ],
        ],
    ]));

    return true;
}
        
    

 

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

Добавляет highload-блок, если его нет

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

    $hlHelper = $helper->getHLHelper();

    $this->outDump($hlHelper->update(
        6,
        [
            'NAME' => 'NewComments',
            'LANG' => [
                'ru' => [
                    'NAME' => 'Заголовок',
                ],
                'en' => [
                    'NAME' => 'Caption',
                ],
            ],
        ]
    ));

    return true;
}
        
    

 

updateIfExists(string $name, array $fields, bool $silent = false)

Обновляет highload-блок, если он есть

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

    $hlHelper = $helper->getHLHelper();

    $this->outDump($hlHelper->updateIfExists(
        'NewComments',
        [
            'TABLE_NAME' => 'new_comments',
        ]
    ));

    return true;
}
        
    

 

delete(int $id, bool $silent = false): bool

Удаляет highload-блок

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

    $hlHelper = $helper->getHLHelper();

    $this->outDump($hlHelper->delete(6));

    return true;
}
        
    

 

deleteIfExists(string $name, bool $silent = false): bool

Удаляет highload-блок, если он есть

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

    $hlHelper = $helper->getHLHelper();

    $this->outDump($hlHelper->deleteIfExists('NewComments'));

    return true;
}
        
    

 

getGroupPermissions(int $id): array

Возвращает права highload-блока

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

    $hlHelper = $helper->getHLHelper();

    $this->outDump($hlHelper->getGroupPermissions(5));

    return true;
}
        
    

 

exportGroupPermissions(int $id): array

Экспортирует права highload-блока

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

    $hlHelper = $helper->getHLHelper();

    $this->outDump($hlHelper->exportGroupPermissions(5));

    return true;
}
        
    

 

setGroupPermissions(int $id, array $permissions = [], bool $silent = false): bool

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

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

    $hlHelper = $helper->getHLHelper();

    $this->outDump($hlHelper->setGroupPermissions(5, [1 => 'W']));

    return true;
}
        
    

 

importGroupPermissions(int $id, array $permissions = [], bool $silent = false): bool

Импорт прав highload-блока

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

    $hlHelper = $helper->getHLHelper();

    $this->outDump($hlHelper->importGroupPermissions(5, ['admins' => 'W']));

    return true;
}
        
    

 

getFields(string $name): array

Возвращает поля highload-блоков по имени

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

    $hlHelper = $helper->getHLHelper();

    $this->outDump($hlHelper->getFields('Reviews'));

    return true;
}
        
    

 

getField(string $name, string $fieldName)

Возвращает поле highload-блока по имени highload-блока и имени поля

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

    $hlHelper = $helper->getHLHelper();

    $this->outDump($hlHelper->getField('Reviews', 'UF_MESSAGE'));

    return true;
}
        
    

 

saveField(string $name, array $field, bool $silent = false): bool

Сохраняет поле highload-блока

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

    $hlHelper = $helper->getHLHelper();

    $this->outDump($hlHelper->saveField(
        'Reviews',
        [
            'FIELD_NAME' => 'UF_COMMENT',
            'USER_TYPE_ID' => 'string',
        ]
    ));

    return true;
}
        
    

 

deleteField(string $name, string $fieldName, bool $silent = false): bool

Удаляет поле highload-блока

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

    $hlHelper = $helper->getHLHelper();

    $this->outDump($hlHelper->deleteField('Reviews', 'UF_COMMENT'));

    return true;
}
        
    

 

deleteFieldIfExists(string $name, string $fieldName, bool $silent = false): bool

Удаляет поле highload-блока, если оно есть

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

    $hlHelper = $helper->getHLHelper();

    $this->outDump($hlHelper->deleteFieldIfExists('Reviews', 'UF_COMMENT'));

    return true;
}
        
    

 

exportFields(string $name): array

Удаляет поле highload-блока, если оно есть

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

    $hlHelper = $helper->getHLHelper();

    $this->outDump($hlHelper->exportFields('Reviews'));

    return true;
}