Bitrix API

EntityBinding

Table of Contents

Constants

ROLE_UNDEFINED  = 0

Methods

addEntityBinding()  : mixed
findBindingByEntityID()  : mixed
findBindingIndexByEntityID()  : mixed
findPrimaryBinding()  : array<string|int, mixed>|null
Try find primary binding.
getFirstEntityID()  : array<string|int, mixed>|int
Extract entity ID from first binding.
getLastEntityID()  : array<string|int, mixed>|int
Extract entity ID from last binding.
getPrimaryEntityID()  : int
Returns entity id from primary binding. If no primary binding is found, returns entity id from the first binding, like @see EntityBinding::getPrimaryOrDefault()
getPrimaryOrDefault()  : mixed
isPrimary()  : mixed
markAsPrimary()  : mixed
Mark binding as primary.
markFirstAsPrimary()  : mixed
Mark first binding as primary.
normalizeEntityBindings()  : mixed
prepareBindingChanges()  : void
Prepare binding changes, for example, newly bound/unbound entities, changed SORT field, changed primary bindings.
prepareBoundAndUnboundEntities()  : array<string|int, array<string|int, array<string|int, mixed>>>
Find entities that were bound or unbound based on previous and current bindings.
prepareEntityBindings()  : array<string|int, mixed>
Prepare entity bindings from array of entity IDs.
prepareEntityID()  : int
Extract entity ID from binding.
prepareEntityIDs()  : array<string|int, int>
Extract entity IDs from bindings.
removeBindingsWithDuplicatingEntityIDs()  : void
removeEntityBinding()  : mixed
resolveEntityFieldName()  : string
Resolve field name for specified entity type.
resolveEntityID()  : mixed
verifyEntityBinding()  : bool
Verify binding structure.

Constants

Methods

addEntityBinding()

public static addEntityBinding(mixed $entityTypeID, mixed $entityID, array<string|int, mixed> &$bindings) : mixed
Parameters
$entityTypeID : mixed
$entityID : mixed
$bindings : array<string|int, mixed>

findBindingByEntityID()

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

findBindingIndexByEntityID()

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

findPrimaryBinding()

Try find primary binding.

public static findPrimaryBinding(array<string|int, mixed> $bindings) : array<string|int, mixed>|null
Parameters
$bindings : array<string|int, mixed>

Bindings.

Return values
array<string|int, mixed>|null

getFirstEntityID()

Extract entity ID from first binding.

public static getFirstEntityID(int $entityTypeID, array<string|int, mixed> $bindings) : array<string|int, mixed>|int
Parameters
$entityTypeID : int

Entity Type ID.

$bindings : array<string|int, mixed>

Bindings.

Tags
throws
ArgumentOutOfRangeException
throws
NotSupportedException
Return values
array<string|int, mixed>|int

getLastEntityID()

Extract entity ID from last binding.

public static getLastEntityID(int $entityTypeID, array<string|int, mixed> $bindings) : array<string|int, mixed>|int
Parameters
$entityTypeID : int

Entity Type ID.

$bindings : array<string|int, mixed>

Bindings.

Tags
throws
ArgumentOutOfRangeException
throws
NotSupportedException
Return values
array<string|int, mixed>|int

getPrimaryEntityID()

Returns entity id from primary binding. If no primary binding is found, returns entity id from the first binding, like @see EntityBinding::getPrimaryOrDefault()

public static getPrimaryEntityID(int $entityTypeID, array<string|int, mixed> $bindings) : int
Parameters
$entityTypeID : int
$bindings : array<string|int, mixed>
Return values
int

getPrimaryOrDefault()

public static getPrimaryOrDefault(array<string|int, mixed> $bindings) : mixed
Parameters
$bindings : array<string|int, mixed>

isPrimary()

public static isPrimary(array<string|int, mixed> $binding) : mixed
Parameters
$binding : array<string|int, mixed>

markAsPrimary()

Mark binding as primary.

public static markAsPrimary(array<string|int, mixed> &$bindings, int $entityTypeID, int $entityID) : mixed
Parameters
$bindings : array<string|int, mixed>

Bindings.

$entityTypeID : int

Entity Type ID.

$entityID : int

Entity ID.

markFirstAsPrimary()

Mark first binding as primary.

public static markFirstAsPrimary(array<string|int, mixed> &$bindings) : mixed
Parameters
$bindings : array<string|int, mixed>

Bindings.

normalizeEntityBindings()

public static normalizeEntityBindings(mixed $entityTypeID, array<string|int, mixed> &$bindings) : mixed
Parameters
$entityTypeID : mixed
$bindings : array<string|int, mixed>

prepareBindingChanges()

Prepare binding changes, for example, newly bound/unbound entities, changed SORT field, changed primary bindings.

public static prepareBindingChanges(int $entityTypeID, array<string|int, mixed> $origin, array<string|int, mixed> $current, array<string|int, mixed> &$added, array<string|int, mixed> &$removed) : void

All possible changes that can happen to bindings are taken into account in this method.

It's primary purpose is to prepare $added and $removed arrays to pass them to bind/unbind methods.

Parameters
$entityTypeID : int

Entity Type ID.

$origin : array<string|int, mixed>

Origin bindings.

$current : array<string|int, mixed>

Current bindings.

$added : array<string|int, mixed>

Added bindings (output parameter).

$removed : array<string|int, mixed>

Removed bindings (output parameter).

prepareBoundAndUnboundEntities()

Find entities that were bound or unbound based on previous and current bindings.

public static prepareBoundAndUnboundEntities(int $entityTypeId, array<string|int, array<string|int, mixed>> $previousBindings, array<string|int, array<string|int, mixed>> $currentBindings) : array<string|int, array<string|int, array<string|int, mixed>>>

Changes in secondary fields (SORT, IS_PRIMARY) are ignored. The only thing that matters here - was entity bound or unbound

Parameters
$entityTypeId : int
$previousBindings : array<string|int, array<string|int, mixed>>
$currentBindings : array<string|int, array<string|int, mixed>>
Return values
array<string|int, array<string|int, array<string|int, mixed>>> —

= [ [], // array of bindings that were added [], // array of bindings that were removed ]

prepareEntityBindings()

Prepare entity bindings from array of entity IDs.

public static prepareEntityBindings(int $entityTypeID, array<string|int, mixed> $entityIDs) : array<string|int, mixed>
Parameters
$entityTypeID : int

Entity Type ID.

$entityIDs : array<string|int, mixed>

Entity IDs.

Tags
throws
ArgumentOutOfRangeException
throws
NotSupportedException
Return values
array<string|int, mixed>

prepareEntityID()

Extract entity ID from binding.

public static prepareEntityID(int $entityTypeID, array<string|int, mixed> $binding) : int
Parameters
$entityTypeID : int

Entity Type ID.

$binding : array<string|int, mixed>

Bindings.

Tags
throws
ArgumentOutOfRangeException
throws
NotSupportedException
Return values
int

prepareEntityIDs()

Extract entity IDs from bindings.

public static prepareEntityIDs(int $entityTypeID, array<string|int, array<string|int, mixed>> $bindings) : array<string|int, int>
Parameters
$entityTypeID : int

Entity Type ID.

$bindings : array<string|int, array<string|int, mixed>>

Bindings.

Return values
array<string|int, int>

removeBindingsWithDuplicatingEntityIDs()

public static removeBindingsWithDuplicatingEntityIDs(int $entityTypeID, array<string|int, mixed> &$bindings) : void
Parameters
$entityTypeID : int
$bindings : array<string|int, mixed>

removeEntityBinding()

public static removeEntityBinding(mixed $entityTypeID, mixed $entityID, array<string|int, mixed> &$bindings) : mixed
Parameters
$entityTypeID : mixed
$entityID : mixed
$bindings : array<string|int, mixed>

resolveEntityFieldName()

Resolve field name for specified entity type.

public static resolveEntityFieldName(int $entityTypeID) : string
Parameters
$entityTypeID : int

Entity type ID.

Return values
string

resolveEntityID()

public static resolveEntityID(mixed $entityTypeID, array<string|int, mixed> $binding) : mixed
Parameters
$entityTypeID : mixed
$binding : array<string|int, mixed>

verifyEntityBinding()

Verify binding structure.

public static verifyEntityBinding(int $entityTypeID, array<string|int, mixed> $binding) : bool
Parameters
$entityTypeID : int

Entity Type ID.

$binding : array<string|int, mixed>

Source binding.

Return values
bool 

        

        
    




    

    

                                

                

                                
    

        On this page

        
    


                

                            

            

    

        

            
Search results