Bitrix API

FieldAttributeManager

Table of Contents

Methods

deleteByOwnerType()  : mixed
deleteByScope()  : void
deleteByScopePrefix()  : void
extractNamesOfAlwaysRequiredFields()  : array<string|int, string>
Returns a flat list of field names that are always required, on any stage
findNeighborPhases()  : array<string|int, mixed>
getCaptionsForEntityWithStages()  : array<string|int, mixed>
Return phrases for entity editor field configurator (BX.Crm.EntityFieldAttributeConfigurator)
getEntityConfigurations()  : mixed
getEntityScopeByCategory()  : string
getEntityScopeByPreset()  : string
getItemConfigScope()  : string
Return scope for $item.
getList()  : array<string|int, mixed>
Returns data from FieldAttributeTable.
getRequiredFields()  : mixed
getRequiredSystemFields()  : mixed
getRequiredUserFields()  : mixed
isEnabled()  : mixed
isEntitySupported()  : bool
isPhaseDependent()  : mixed
onUserFieldDelete()  : mixed
onUserFieldUpdate()  : mixed
prepareEditorFieldInfosWithAttributes()  : array<string|int, string>
Adds information about attributes config from $attrConfigs to $fieldInfos.
processFieldsForStages()  : array<string|int, string>
Return list of field names that matches specified configs and stages.
processPhaseCreation()  : void
processPhaseDeletion()  : mixed
processPhaseModification()  : mixed
removeEntityConfiguration()  : mixed
resolveEntityScope()  : string
saveEntityConfiguration()  : mixed

Methods

deleteByOwnerType()

public static deleteByOwnerType(int $entityTypeId) : mixed
Parameters
$entityTypeId : int

deleteByScope()

public static deleteByScope(string $scope[, array<string|int, mixed> $excludeFields = [] ]) : void
Parameters
$scope : string
$excludeFields : array<string|int, mixed> = []

deleteByScopePrefix()

public static deleteByScopePrefix(string $scopePrefix[, array<string|int, mixed> $excludeFields = [] ]) : void
Parameters
$scopePrefix : string
$excludeFields : array<string|int, mixed> = []

extractNamesOfAlwaysRequiredFields()

Returns a flat list of field names that are always required, on any stage

public final static extractNamesOfAlwaysRequiredFields(array<string|int, mixed> $fieldsData) : array<string|int, string>
Parameters
$fieldsData : array<string|int, mixed>
  • Data that returns by self::getList() method.
Return values
array<string|int, string> —
  • Flat list of required field names

findNeighborPhases()

public static findNeighborPhases(int $phaseID[, array<string|int, mixed> $phases = [] ]) : array<string|int, mixed>
Parameters
$phaseID : int
$phases : array<string|int, mixed> = []
Return values
array<string|int, mixed>

getCaptionsForEntityWithStages()

Return phrases for entity editor field configurator (BX.Crm.EntityFieldAttributeConfigurator)

public static getCaptionsForEntityWithStages([int $entityTypeId = CCrmOwnerType::Undefined ]) : array<string|int, mixed>
Parameters
$entityTypeId : int = CCrmOwnerType::Undefined
Return values
array<string|int, mixed>

getEntityConfigurations()

public static getEntityConfigurations(mixed $entityTypeID, mixed $entityScope) : mixed
Parameters
$entityTypeID : mixed
$entityScope : mixed

getEntityScopeByCategory()

public static getEntityScopeByCategory([int|null $categoryId = 0 ]) : string
Parameters
$categoryId : int|null = 0
Return values
string

getEntityScopeByPreset()

public static getEntityScopeByPreset([int|null $presetId = 0 ]) : string
Parameters
$presetId : int|null = 0
Return values
string

getItemConfigScope()

Return scope for $item.

public static getItemConfigScope(Item $item) : string
Parameters
$item : Item
Return values
string

getList()

Returns data from FieldAttributeTable.

public static getList(int $entityTypeId, string $entityScope[, int|null $fieldOrigin = FieldOrigin::UNDEFINED ][, int|null $typeId = FieldAttributeType::REQUIRED ]) : array<string|int, mixed>
Parameters
$entityTypeId : int
$entityScope : string
$fieldOrigin : int|null = FieldOrigin::UNDEFINED
$typeId : int|null = FieldAttributeType::REQUIRED
Return values
array<string|int, mixed>

getRequiredFields()

public static getRequiredFields(mixed $entityTypeID, mixed $entityID, array<string|int, mixed> $entityData[, mixed $fieldOrigin = 0 ][, array<string|int, mixed> $options = null ]) : mixed
Parameters
$entityTypeID : mixed
$entityID : mixed
$entityData : array<string|int, mixed>
$fieldOrigin : mixed = 0
$options : array<string|int, mixed> = null

getRequiredSystemFields()

public static getRequiredSystemFields(mixed $entityTypeID, mixed $entityID, array<string|int, mixed> $entityData) : mixed
Parameters
$entityTypeID : mixed
$entityID : mixed
$entityData : array<string|int, mixed>

getRequiredUserFields()

public static getRequiredUserFields(mixed $entityTypeID, mixed $entityID, array<string|int, mixed> $entityData) : mixed
Parameters
$entityTypeID : mixed
$entityID : mixed
$entityData : array<string|int, mixed>

isEntitySupported()

public static isEntitySupported(int $entityTypeId) : bool
Parameters
$entityTypeId : int
Return values
bool

onUserFieldDelete()

public static onUserFieldDelete(array<string|int, mixed> $fields, mixed $ID) : mixed
Parameters
$fields : array<string|int, mixed>
$ID : mixed

onUserFieldUpdate()

public static onUserFieldUpdate(array<string|int, mixed> $fields, mixed $ID) : mixed
Parameters
$fields : array<string|int, mixed>
$ID : mixed

prepareEditorFieldInfosWithAttributes()

Adds information about attributes config from $attrConfigs to $fieldInfos.

public static prepareEditorFieldInfosWithAttributes(array<string|int, mixed> $attrConfigs, array<string|int, mixed> &$fieldInfos) : array<string|int, string>

Returns array of fieldNames that required by this config.

Parameters
$attrConfigs : array<string|int, mixed>

Config to get information from.

$fieldInfos : array<string|int, mixed>

Field parameters to add information to.

Return values
array<string|int, string>

processFieldsForStages()

Return list of field names that matches specified configs and stages.

public static processFieldsForStages(array<string|int, mixed> $fieldsData, EO_Status_Collection $collection, string $currentStageId) : array<string|int, string>
Parameters
$fieldsData : array<string|int, mixed>
  • Data that returns by self::getList() method.
$collection : EO_Status_Collection
  • Stages collection for which settings should be processed.
$currentStageId : string
  • Current stage identifier.
Return values
array<string|int, string> —
  • Flat array of required field names

processPhaseCreation()

public static processPhaseCreation(string $phaseID, int $entityTypeID, string $entityScope, array<string|int, mixed> $phases) : void
Parameters
$phaseID : string
$entityTypeID : int
$entityScope : string
$phases : array<string|int, mixed>

processPhaseDeletion()

public static processPhaseDeletion(mixed $phaseID, mixed $entityTypeID, mixed $entityScope[, array<string|int, mixed> $phases = [] ]) : mixed
Parameters
$phaseID : mixed
$entityTypeID : mixed
$entityScope : mixed
$phases : array<string|int, mixed> = []

processPhaseModification()

public static processPhaseModification(mixed $phaseID, mixed $entityTypeID, mixed $entityScope, array<string|int, mixed> $phases) : mixed
Parameters
$phaseID : mixed
$entityTypeID : mixed
$entityScope : mixed
$phases : array<string|int, mixed>

removeEntityConfiguration()

public static removeEntityConfiguration(mixed $typeID, mixed $fieldName, mixed $entityTypeID[, mixed $entityScope = '' ]) : mixed
Parameters
$typeID : mixed
$fieldName : mixed
$entityTypeID : mixed
$entityScope : mixed = ''

resolveEntityScope()

public static resolveEntityScope(mixed $entityTypeId, mixed $entityId[, array<string|int, mixed> $options = null ]) : string
Parameters
$entityTypeId : mixed
$entityId : mixed
$options : array<string|int, mixed> = null
Return values
string

saveEntityConfiguration()

public static saveEntityConfiguration(array<string|int, mixed> $config, mixed $fieldName, mixed $entityTypeID, mixed $entityScope) : mixed
Parameters
$config : array<string|int, mixed>
$fieldName : mixed
$entityTypeID : mixed
$entityScope : mixed 

        

        
    




    

    

                                

                

                                
    

        On this page

        
    


                

                            

            

    

        

            
Search results