Bitrix API

UserFieldManager

Table of Contents

Methods

combineUserFieldFieldsToString()  : string
Combine entityId and fieldName into a unique string.
enableEntityInUserField()  : bool
Saves new status of entity with name $entityTypeName in settings of $userField in the database.
getLinkedUserFields()  : array<string|int, array<string|int, mixed>>
Return full info about user fields from UserFieldTable by their description.
getLinkedUserFieldsDescription()  : array<string|int, array<string|int, mixed>>
Return array of descriptions about linked to crm user fields in other modules.
getLinkedUserFieldsMap()  : array<string|int, array<string|int, mixed>>
Return array of user fields that are linked to crm user fields in other modules.
getUserFieldEntity()  : mixed
isEnabledInCalendarUserField()  : bool
isEnabledInTasksUserField()  : bool
isEntityEnabledInUserField()  : bool
Return true if this entity is enabled in userField settings.
parseUserFieldFieldsFromString()  : array<string|int, mixed>|null
Return entityId and fieldName of a userField from combined name.
prepareUserFieldSignature()  : mixed
processUserFieldEntitySettings()  : array<string|int, mixed>
Enable or disable entity with name $entityTypeName in settings of a userField.
resolveEntityTypeID()  : mixed
resolveUserFieldEntityID()  : mixed

Methods

combineUserFieldFieldsToString()

Combine entityId and fieldName into a unique string.

public static combineUserFieldFieldsToString(string $entityId, string $fieldName) : string
Parameters
$entityId : string
$fieldName : string
Return values
string

enableEntityInUserField()

Saves new status of entity with name $entityTypeName in settings of $userField in the database.

public static enableEntityInUserField(array<string|int, mixed> $userField, string $entityTypeName, bool $isEnabled) : bool
Parameters
$userField : array<string|int, mixed>
$entityTypeName : string
$isEnabled : bool
Return values
bool

getLinkedUserFields()

Return full info about user fields from UserFieldTable by their description.

public static getLinkedUserFields(array<string|int, mixed> $descriptions) : array<string|int, array<string|int, mixed>>
Parameters
$descriptions : array<string|int, mixed>
Return values
array<string|int, array<string|int, mixed>>

getLinkedUserFieldsDescription()

Return array of descriptions about linked to crm user fields in other modules.

public static getLinkedUserFieldsDescription() : array<string|int, array<string|int, mixed>>
Return values
array<string|int, array<string|int, mixed>>

getLinkedUserFieldsMap()

Return array of user fields that are linked to crm user fields in other modules.

public static getLinkedUserFieldsMap() : array<string|int, array<string|int, mixed>>
Return values
array<string|int, array<string|int, mixed>> —

[string combinedUserFieldName => array userField]

getUserFieldEntity()

public static getUserFieldEntity(mixed $entityTypeID) : mixed
Parameters
$entityTypeID : mixed

isEnabledInCalendarUserField()

public static isEnabledInCalendarUserField(string $entityTypeName) : bool
Parameters
$entityTypeName : string
Return values
bool

isEnabledInTasksUserField()

public static isEnabledInTasksUserField(string $entityTypeName) : bool
Parameters
$entityTypeName : string
Return values
bool

isEntityEnabledInUserField()

Return true if this entity is enabled in userField settings.

public static isEntityEnabledInUserField(array<string|int, mixed> $userField, string $entityTypeName) : bool
Parameters
$userField : array<string|int, mixed>
$entityTypeName : string
Return values
bool

parseUserFieldFieldsFromString()

Return entityId and fieldName of a userField from combined name.

public static parseUserFieldFieldsFromString(string $combinedFields) : array<string|int, mixed>|null
Parameters
$combinedFields : string
Return values
array<string|int, mixed>|null

prepareUserFieldSignature()

public static prepareUserFieldSignature(array<string|int, mixed> $fieldInfo[, mixed $value = null ]) : mixed
Parameters
$fieldInfo : array<string|int, mixed>
$value : mixed = null

processUserFieldEntitySettings()

Enable or disable entity with name $entityTypeName in settings of a userField.

public static processUserFieldEntitySettings(array<string|int, mixed> $settings, string $entityTypeName, bool $isEnabled) : array<string|int, mixed>
Parameters
$settings : array<string|int, mixed>
$entityTypeName : string
$isEnabled : bool
Return values
array<string|int, mixed>

resolveEntityTypeID()

public static resolveEntityTypeID(mixed $userFieldEntityID) : mixed
Parameters
$userFieldEntityID : mixed

resolveUserFieldEntityID()

public static resolveUserFieldEntityID(mixed $entityTypeID) : mixed
Parameters
$entityTypeID : mixed 

        

        
    




    

    

                                

                

                                
    

        On this page

        
    


                

                            

            

    

        

            
Search results