Bitrix API

Reference extends Relation

Reference field describes relation 1-to-1 or 1-to-many between two entities

Tags
subpackage

main

Table of Contents

Constants

ELEMENTAL_BOTH  = 3
ELEMENTAL_REF  = 2
ELEMENTAL_THIS  = 1

Methods

__construct()  : mixed
addFetchDataModifier()  : $this
addSaveDataModifier()  : $this
addValidator()  : $this
configureCascadeDeletePolicy()  : Relation
configureCascadeSavePolicy()  : Relation
configureJoinType()  : $this
configureSerialized()  : $this
configureTitle()  : $this
Lang phrase
getCascadeDeletePolicy()  : int
getCascadeSavePolicy()  : int
getClassByOldDataType()  : bool
getConnection()  : Connection
getDataType()  : null|string
getElementals()  : array<string|int, mixed>|bool
Returns set of strictly linked fields of this and ref entities [localFieldName => remoteFieldName]
getEntity()  : mixed
getFetchDataModifiers()  : array<string|int, mixed>|array<string|int, callable>|null
getGetterTypeHint()  : EntityObject|string
getJoinType()  : string
getLangCode()  : mixed
getName()  : mixed
getOldDataTypeByClass()  : bool
getOldDataTypeByField()  : bool
getParameter()  : mixed
getParentField()  : Field
getRefEntity()  : Entity
getRefEntityName()  : string
getReference()  : mixed
getSaveDataModifiers()  : array<string|int, mixed>|array<string|int, callable>|null
getSetterTypeHint()  : EntityObject|string
getTitle()  : mixed
getTypeMask()  : mixed
getValidators()  : array<string|int, callable>|array<string|int, Validator>
hasParameter()  : mixed
isSerialized()  : bool
modifyValueBeforeSave()  : mixed
postInitialize()  : null
Called after being initialized by Entity
resetEntity()  : mixed
serialize()  : mixed
setConnection()  : mixed
setEntity()  : mixed
setName()  : mixed
setParameter()  : mixed
setParentField()  : mixed
setSerialized()  : mixed
unserialize()  : mixed
validateValue()  : Result

Constants

ELEMENTAL_BOTH

public mixed ELEMENTAL_BOTH = 3

ELEMENTAL_REF

public mixed ELEMENTAL_REF = 2

ELEMENTAL_THIS

public mixed ELEMENTAL_THIS = 1

Methods

__construct()

public __construct(string $name, string|Entity $referenceEntity, array<string|int, mixed>|ConditionTree $referenceFilter[, array<string|int, mixed> $parameters = array() ]) : mixed
Parameters
$name : string
$referenceEntity : string|Entity
$referenceFilter : array<string|int, mixed>|ConditionTree
$parameters : array<string|int, mixed> = array()

deprecated, use configure* and add* methods instead

Tags
throws
ArgumentException
throws
SystemException

addFetchDataModifier()

public addFetchDataModifier(callable $modifier) : $this
Parameters
$modifier : callable
Tags
throws
SystemException
Return values
$this

addSaveDataModifier()

public addSaveDataModifier(callable $modifier) : $this
Parameters
$modifier : callable
Tags
throws
SystemException
Return values
$this

addValidator()

public addValidator(Validator|callable $validator) : $this
Parameters
$validator : Validator|callable
Tags
throws
SystemException
Return values
$this

configureCascadeDeletePolicy()

public configureCascadeDeletePolicy(int $cascadeDeletePolicy) : Relation
Parameters
$cascadeDeletePolicy : int
Return values
Relation

configureCascadeSavePolicy()

public configureCascadeSavePolicy(int $cascadeSavePolicy) : Relation
Parameters
$cascadeSavePolicy : int
Return values
Relation

configureJoinType()

public configureJoinType(mixed $type) : $this
Parameters
$type : mixed
Tags
throws
ArgumentException
Return values
$this

configureSerialized()

public configureSerialized() : $this
Tags
throws
SystemException
Return values
$this

configureTitle()

Lang phrase

public configureTitle(mixed $title) : $this
Parameters
$title : mixed
Return values
$this

getCascadeDeletePolicy()

public getCascadeDeletePolicy() : int
Return values
int

getCascadeSavePolicy()

public getCascadeSavePolicy() : int
Return values
int

getClassByOldDataType()

public static getClassByOldDataType(mixed $dateType) : bool
Parameters
$dateType : mixed
Return values
bool

getDataType()

public getDataType() : null|string
Return values
null|string

getElementals()

Returns set of strictly linked fields of this and ref entities [localFieldName => remoteFieldName]

public getElementals() : array<string|int, mixed>|bool
Return values
array<string|int, mixed>|bool

getEntity()

public getEntity() : mixed

getFetchDataModifiers()

public getFetchDataModifiers() : array<string|int, mixed>|array<string|int, callable>|null
Tags
throws
SystemException
Return values
array<string|int, mixed>|array<string|int, callable>|null

getJoinType()

public getJoinType() : string
Return values
string

getLangCode()

public getLangCode() : mixed

getName()

public getName() : mixed

getOldDataTypeByClass()

public static getOldDataTypeByClass(mixed $class) : bool
Parameters
$class : mixed
Return values
bool

getOldDataTypeByField()

public static getOldDataTypeByField(Field $field) : bool
Parameters
$field : Field
Return values
bool

getParameter()

public getParameter(mixed $name) : mixed
Parameters
$name : mixed

getRefEntity()

public getRefEntity() : Entity
Tags
throws
ArgumentException
throws
SystemException
Return values
Entity

getRefEntityName()

public getRefEntityName() : string
Return values
string

getReference()

public getReference() : mixed

getSaveDataModifiers()

public getSaveDataModifiers() : array<string|int, mixed>|array<string|int, callable>|null
Tags
throws
SystemException
Return values
array<string|int, mixed>|array<string|int, callable>|null

getTitle()

public getTitle() : mixed

getValidators()

public getValidators() : array<string|int, callable>|array<string|int, Validator>
Tags
throws
SystemException
Return values
array<string|int, callable>|array<string|int, Validator>

hasParameter()

public hasParameter(mixed $name) : mixed
Parameters
$name : mixed

isSerialized()

public isSerialized() : bool
Return values
bool

modifyValueBeforeSave()

public modifyValueBeforeSave(mixed $value, mixed $data) : mixed
Parameters
$value : mixed
$data : mixed
Tags
throws
SystemException

postInitialize()

Called after being initialized by Entity

public postInitialize() : null
Return values
null

resetEntity()

public resetEntity() : mixed

serialize()

public serialize(mixed $value) : mixed
Parameters
$value : mixed

setConnection()

public setConnection(mixed $connection) : mixed
Parameters
$connection : mixed

setEntity()

public setEntity(Entity $entity) : mixed
Parameters
$entity : Entity
Tags
throws
SystemException

setName()

public setName(mixed $name) : mixed
Parameters
$name : mixed

setParameter()

public setParameter(mixed $name, mixed $value) : mixed
Parameters
$name : mixed
$value : mixed

setParentField()

public setParentField(Field $parentField) : mixed
Parameters
$parentField : Field

setSerialized()

public setSerialized() : mixed
Tags
throws
SystemException

unserialize()

public unserialize(mixed $value) : mixed
Parameters
$value : mixed

validateValue()

public validateValue(mixed $value, mixed $primary, mixed $row, Result $result) : Result
Parameters
$value : mixed
$primary : mixed
$row : mixed
$result : Result
Tags
throws
ArgumentException
throws
SystemException
Return values
Result 

        

        
    




    

    

                                

                

                                
    

        On this page

        
    


                

                            

            

    

        

            
Search results