getFields(string $entityId): array

Возвращает пользовательские поля сущности. Для полей типа "список" в результате присутствуют значения списка под ключем 'ENUMS'.

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

    $userTypeHelper = $helper->getUserTypeHelper();

    $this->outDump($userTypeHelper->getFields('BLOG_POST'));

    return true;
}
        
    

 

exportFields(string $entityId): array

Экспортирует все пользовательские поля сущности. Для полей типа "список" в результате присутствуют значения списка под ключем 'ENUMS'.

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

    $userTypeHelper = $helper->getUserTypeHelper();

    $this->outDump($userTypeHelper->exportFields('BLOG_POST'));

    return true;
}
        
    

 

getFieldById(int $fieldId)

Возвращает пользовательское поле по идентификатору. Для полей типа "список" в результате присутствуют значения списка под ключем 'ENUMS'.

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

    $userTypeHelper = $helper->getUserTypeHelper();

    $this->outDump($userTypeHelper->getFieldById(10));

    return true;
}
        
    

 

getFieldByIdIfExists(int $fieldId): array

Возвращает пользовательское поле по идентификатору, если оно есть. Для полей типа "список" в результате присутствуют значения списка под ключем 'ENUMS'.

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

    $userTypeHelper = $helper->getUserTypeHelper();

    $this->outDump($userTypeHelper->getFieldByIdIfExists(10));

    return true;
}
        
    

 

getField(string $entityId, string $fieldName)

Возвращает пользовательское поле по идентификатору, если оно есть. Для полей типа "список" в результате присутствуют значения списка под ключем 'ENUMS'.

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

    $userTypeHelper = $helper->getUserTypeHelper();

    $this->outDump($userTypeHelper->getField('BLOG_POST', 'UF_STATUS'));

    return true;
}
        
    

 

getFieldIfExists(string $entityId, string $fieldName): array

Возвращает пользовательское поле, если оно есть. Для полей типа "список" в результате присутствуют значения списка под ключем 'ENUMS'.

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

    $userTypeHelper = $helper->getUserTypeHelper();

    $this->outDump($userTypeHelper->getFieldIfExists('BLOG_POST', 'UF_STATUS'));

    return true;
}
        
    

 

exportField(int $fieldId)

Экспорт пользовательского поля. Для полей типа "список" в результате присутствуют значения списка под ключем 'ENUMS'.

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

    $userTypeHelper = $helper->getUserTypeHelper();

    $this->outDump($userTypeHelper->getFieldIfExists('BLOG_POST', 'UF_STATUS'));

    return true;
}
        
    

 

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

Сохраняет пользовательское поле. Для пользовательского поля типа "список" возможно передать значения списка под ключем 'ENUMS'.

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

    $userTypeHelper = $helper->getUserTypeHelper();

    $this->outDump($userTypeHelper->saveField([
        'ENTITY_ID' => 'BLOG_POST',
        'FIELD_NAME' => 'UF_VIEWS',
        'USER_TYPE_ID' => 'enumeration',
        'ENUMS' => [
            [
                'XML_ID' => 'XML_ID1',
                'VALUE' => 'VALUE1',
            ],
            [
                'XML_ID' => 'XML_ID2',
                'VALUE' => 'VALUE2',
            ],
        ],
    ]));

    return true;
}
        
    

 

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

Обновляет пользователькое поле. Для пользовательского поля типа "список" возможно передать значения списка под ключем 'ENUMS'.

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

    $userTypeHelper = $helper->getUserTypeHelper();

    $this->outDump($userTypeHelper->updateField(
        78,
        [
            'XML_ID' => 'XML_VIEWS',
        ]
    ));

    return true;
}
        
    

 

updateFieldIfExists(string $entityId, string $fieldName, array $fields, bool $silent = false)

Обновляет пользовательское поле, если оно есть. Для пользовательского поля типа "список" возможно передать значения списка под ключем 'ENUMS'.

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

    $userTypeHelper = $helper->getUserTypeHelper();

    $this->outDump($userTypeHelper->updateFieldIfExists(
        'BLOG_POST',
        'UF_VIEWS',
        [
            'XML_ID' => 'XML_VIEWS',
        ]
    ));

    return true;
}
        
    

 

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

Добавляет пользовательское поле. Для пользовательского поля типа "список" возможно передать значения списка под ключем 'ENUMS'.

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

    $userTypeHelper = $helper->getUserTypeHelper();

    $this->outDump($userTypeHelper->addField(
        'BLOG_POST',
        'UF_VIEWS',
        [
            'ENTITY_ID' => 'BLOG_POST',
            'FIELD_NAME' => 'UF_VIEWS',
            'USER_TYPE_ID' => 'enumeration',
            'ENUMS' => [
                [
                    'XML_ID' => 'XML_ID1',
                    'VALUE' => 'VALUE1',
                ],
                [
                    'XML_ID' => 'XML_ID2',
                    'VALUE' => 'VALUE2',
                ],
            ],
        ]
    ));

    return true;
}
        
    

 

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

Добавляет пользователькое поле, если его нет. Для пользовательского поля типа "список" возможно передать значения списка под ключем 'ENUMS'.

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

    $userTypeHelper = $helper->getUserTypeHelper();

    $this->outDump($userTypeHelper->addFieldIfNotExists(
        'BLOG_POST',
        'UF_VIEWS',
        [
            'ENTITY_ID' => 'BLOG_POST',
            'FIELD_NAME' => 'UF_VIEWS',
            'USER_TYPE_ID' => 'enumeration',
            'ENUMS' => [
                [
                    'XML_ID' => 'XML_ID1',
                    'VALUE' => 'VALUE1',
                ],
                [
                    'XML_ID' => 'XML_ID2',
                    'VALUE' => 'VALUE2',
                ],
            ],
        ]
    ));

    return true;
}
        
    

 

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

Удаление пользователького поля

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

    $userTypeHelper = $helper->getUserTypeHelper();

    $this->outDump($userTypeHelper->deleteField('BLOG_POST', 'UF_VIEWS'));

    return true;
}
        
    

 

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

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

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

    $userTypeHelper = $helper->getUserTypeHelper();

    $this->outDump($userTypeHelper->deleteFieldIfExists('BLOG_POST', 'UF_VIEWS'));

    return true;
}
        
    

 

setEnums(int $fieldId, array $newEnums): bool

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

Аргумент Описание
int $fieldId Идентификатор пользовательского поля
array $newEnums Значения пользовательского поля типа "список"
        
public function up(): bool
{
    $helper = $this->getHelperManager();

    $userTypeHelper = $helper->getUserTypeHelper();

    $fieldId = $userTypeHelper->addFieldIfNotExists(
        'BLOG_POST',
        'UF_VIEWS',
        [
            'ENTITY_ID' => 'BLOG_POST',
            'FIELD_NAME' => 'UF_VIEWS',
            'USER_TYPE_ID' => 'enumeration',
        ]
    );

    $this->outDump($userTypeHelper->setEnums(
        $fieldId,
        [
            [
                'XML_ID' => 'XML_ID1',
                'VALUE' => 'VALUE1',
            ],
            [
                'XML_ID' => 'XML_ID2',
                'VALUE' => 'VALUE2',
            ],
        ]
    ));

    return true;
}
        
    

 

getEnums(int $fieldId): array

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

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

    $userTypeHelper = $helper->getUserTypeHelper();

    $this->outDump($userTypeHelper->getEnums(80));

    return true;
}