getList(array $filter = []): array

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

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

    $webFormHelper = $helper->getWebFormHelper();

    $this->outDump($webFormHelper->getList(['SID' => 'SIMPLE_FORM_1',]));

    return true;
}
        
    

 

getById(int $id)

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

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

    $webFormHelper = $helper->getWebFormHelper();

    $this->outDump($webFormHelper->getById(4));

    return true;
}
        
    

 

getByIdIfExists(int $id): array

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

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

    $webFormHelper = $helper->getWebFormHelper();

    $this->outDump($webFormHelper->getByIdIfExists(4));

    return true;
}
        
    

 

export(int $id)

Экспортирует веб-форму по идентификатору

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

    $webFormHelper = $helper->getWebFormHelper();

    $this->outDump($webFormHelper->export(4));

    return true;
}
        
    

 

getIdBySid(string $sid)

Возвращает идентификатор веб-формы по sid

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

    $webFormHelper = $helper->getWebFormHelper();

    $this->outDump($webFormHelper->getIdBySid('SIMPLE_FORM_1'));

    return true;
}
        
    

 

getIdBySidIfExists(string $sid): int

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

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

    $webFormHelper = $helper->getWebFormHelper();

    $this->outDump($webFormHelper->getIdBySidIfExists('SIMPLE_FORM_1'));

    return true;
}
        
    

 

save(array $form, bool $silent = false): int

Сохраняет веб-форму

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

    $webFormHelper = $helper->getWebFormHelper();

    $webForm = [
        'NAME' => 'Обновленная веб-форма',
        'SID' => 'SIMPLE_FORM_1',
    ];

    $this->outDump($webFormHelper->save($webForm));

    return true;
}
        
    

 

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

Удаляет веб-форму, если она есть

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

    $webFormHelper = $helper->getWebFormHelper();

    $this->outDump($webFormHelper->deleteIfExists('SIMPLE_FORM_1'));

    return true;
}
        
    

 

getFields(int $id): array

Возвращает поля веб-формы

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

    $webFormHelper = $helper->getWebFormHelper();

    $id = $webFormHelper->getIdBySidIfExists('SIMPLE_FORM_1');

    $this->outDump($webFormHelper->getFields($id));

    return true;
}
        
    

 

exportFields(int $id): array

Экспорт полей веб-формы

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

    $webFormHelper = $helper->getWebFormHelper();

    $id = $webFormHelper->getIdBySidIfExists('SIMPLE_FORM_1');

    $this->outDump($webFormHelper->exportFields($id));

    return true;
}
        
    

 

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

Сохраняет поля веб-формы

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

    $webFormHelper = $helper->getWebFormHelper();

    $id = $webFormHelper->getIdBySidIfExists('SIMPLE_FORM_1');
    $fields = $webFormHelper->getFields($id);

    $fields[0]['TITLE'] = 'Поле 1';

    $this->outDump($webFormHelper->saveFields($id, $fields));

    return true;
}
        
    

 

getStatuses(int $id): array

Возвращает статусы веб-формы

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

    $webFormHelper = $helper->getWebFormHelper();

    $id = $webFormHelper->getIdBySidIfExists('SIMPLE_FORM_1');

    $this->outDump($webFormHelper->getStatuses($id));

    return true;
}
        
    

 

exportStatuses(int $id): array

Экспорт статусов

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

    $webFormHelper = $helper->getWebFormHelper();

    $id = $webFormHelper->getIdBySidIfExists('SIMPLE_FORM_1');

    $this->outDump($webFormHelper->exportStatuses($id));

    return true;
}
        
    

 

saveStatuses(int $id, array $statuses, bool $silent = false): bool

Сохраняет статусы веб-формы

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

    $webFormHelper = $helper->getWebFormHelper();

    $id = $webFormHelper->getIdBySidIfExists('SIMPLE_FORM_1');
    $statuses = $webFormHelper->exportStatuses($id);

    $statuses[] = [
        'TITLE' => 'Новый статус',
        'ACTIVE' => 'Y',
        'C_SORT' => 200,
    ];

    $this->outDump($webFormHelper->saveStatuses($id, $statuses));

    return true;
}