Bitrix API

Type extends EntityObject

Class Type

Properties

$authContext : Context
$customData : Dictionary
$dataClass : DataManager: Entity Table class. Read-only property.
$entity : Entity
$primary : array<string|int, mixed>
$primaryAsString : string
$state : int

Methods

__call() : mixed: Magic to handle getters, setters etc.
__clone() : mixed
__construct() : mixed: EntityObject constructor
__get() : mixed: Magic read-only properties
__set() : mixed: Magic read-only properties
addTo() : mixed
collectValues() : array<string|int, mixed>: Returns all objects values as an array
defineAuthContext() : mixed
delete() : Result: ActiveRecord delete.
fill() : mixed: Fills all the values and relations of object
get() : mixed
getId() : Collection|EntityObject|mixed: Fast popular alternative to __call().
getName() : string
getTableName() : string
has() : mixed
isChanged() : mixed
isFilled() : mixed
offsetExists() : bool: ArrayAccess interface implementation.
offsetGet() : mixed|null: ArrayAccess interface implementation.
offsetSet() : void: ArrayAccess interface implementation.
offsetUnset() : void: ArrayAccess interface implementation.
remindActual() : mixed
removeAll() : mixed
removeFrom() : mixed
require() : mixed
reset() : mixed
save() : Result: ActiveRecord save.
set() : mixed
sysFillRelationCollection() : Collection
sysGetEntity() : Entity
sysGetPrimary() : array<string|int, mixed>: Returns [primary => value] array.
sysGetPrimaryAsString() : mixed
sysPostSave() : mixed
sysSaveCurrentReferences() : mixed
sysSerializePrimary() : string
unset() : mixed
wakeUp() : static: Constructs existing object from pre-selected data, including references and relations.

$authContext


        public
            Context
    $authContext

For UF values validation

$customData read-only


        public
            Dictionary
    $customData

$dataClass

Entity Table class. Read-only property.


        public
        static    DataManager
    $dataClass

$entity read-only


        public
            Entity
    $entity

$primary read-only


        public
            array<string|int, mixed>
    $primary

$primaryAsString read-only


        public
            string
    $primaryAsString

$state read-only


        public
            int
    $state

@see State

__call()

Magic to handle getters, setters etc.


    public
                    __call(mixed $name, mixed $arguments) : mixed

Parameters

$name : mixed
$arguments : mixed

__clone()


    public
                    __clone() : mixed

__construct()

EntityObject constructor


    public
        final            __construct([bool|array<string|int, mixed> $setDefaultValues = true ]) : mixed

Parameters

$setDefaultValues : bool|array<string|int, mixed> = true

__get()

Magic read-only properties


    public
                    __get(mixed $name) : mixed

Parameters

$name : mixed

__set()

Magic read-only properties


    public
                    __set(mixed $name, mixed $value) : mixed

Parameters

$name : mixed
$value : mixed

addTo()


    public
        final            addTo(mixed $fieldName, mixed $value) : mixed

Parameters

$fieldName : mixed
$value : mixed

collectValues()

Returns all objects values as an array


    public
        final            collectValues([int $valuesType = Values::ALL ][, int $fieldsMask = FieldTypeMask::ALL ][, bool $recursive = false ]) : array<string|int, mixed>

Parameters

$valuesType : int = Values::ALL
$fieldsMask : int = FieldTypeMask::ALL
$recursive : bool = false

Return values

array<string|int, mixed>

defineAuthContext()


    public
        final            defineAuthContext(Context $authContext) : mixed

Parameters

$authContext : Context

delete()

ActiveRecord delete.


    public
        final            delete() : Result

Return values

Result

fill()

Fills all the values and relations of object


    public
        final            fill([int|array<string|int, string> $fields = FieldTypeMask::ALL ]) : mixed

Parameters

$fields : int|array<string|int, string> = FieldTypeMask::ALL: Names of fields to fill

get()


    public
        final            get(mixed $fieldName) : mixed

Parameters

$fieldName : mixed

getId()

Fast popular alternative to __call().


    public
                    getId() : Collection|EntityObject|mixed

Return values

Collection|EntityObject|mixed

getName()


    public
                    getName() : string

Return values

string

getTableName()


    public
                    getTableName() : string

Return values

string

has()


    public
        final            has(mixed $fieldName) : mixed

Parameters

$fieldName : mixed

isChanged()


    public
        final            isChanged(mixed $fieldName) : mixed

Parameters

$fieldName : mixed

isFilled()


    public
        final            isFilled(mixed $fieldName) : mixed

Parameters

$fieldName : mixed

offsetExists()

ArrayAccess interface implementation.


    public
                    offsetExists(mixed $offset) : bool

Parameters

$offset : mixed

Return values

bool

offsetGet()

ArrayAccess interface implementation.


    public
                    offsetGet(mixed $offset) : mixed|null

Parameters

$offset : mixed

Return values

mixed|null

offsetSet()

ArrayAccess interface implementation.


    public
                    offsetSet(mixed $offset, mixed $value) : void

Parameters

$offset : mixed
$value : mixed

offsetUnset()

ArrayAccess interface implementation.


    public
                    offsetUnset(mixed $offset) : void

Parameters

$offset : mixed

remindActual()


    public
        final            remindActual(mixed $fieldName) : mixed

Parameters

$fieldName : mixed

removeAll()


    public
        final            removeAll(mixed $fieldName) : mixed

Parameters

$fieldName : mixed

removeFrom()


    public
        final            removeFrom(mixed $fieldName, mixed $value) : mixed

Parameters

$fieldName : mixed
$value : mixed

require()


    public
        final            require(mixed $fieldName) : mixed

Parameters

$fieldName : mixed

reset()


    public
        final            reset(mixed $fieldName) : mixed

Parameters

$fieldName : mixed

save()

ActiveRecord save.


    public
        final            save() : Result

Return values

Result

set()


    public
        final            set(mixed $fieldName, mixed $value) : mixed

Parameters

$fieldName : mixed
$value : mixed

sysFillRelationCollection()


    public
                    sysFillRelationCollection(OneToMany|ManyToMany|string $field) : Collection

Parameters

$field : OneToMany|ManyToMany|string

Return values

Collection

sysGetEntity()


    public
                    sysGetEntity() : Entity

Return values

Entity

sysGetPrimary()

Returns [primary => value] array.


    public
                    sysGetPrimary() : array<string|int, mixed>

Return values

array<string|int, mixed>

sysGetPrimaryAsString()


    public
                    sysGetPrimaryAsString() : mixed

sysPostSave()


    public
                    sysPostSave() : mixed

sysSaveCurrentReferences()


    public
                    sysSaveCurrentReferences() : mixed

sysSerializePrimary()


    public
            static        sysSerializePrimary(array<string|int, mixed> $primary, Entity $entity) : string

Parameters

$primary : array<string|int, mixed>
$entity : Entity

Return values

string

unset()


    public
        final            unset(mixed $fieldName) : mixed

Parameters

$fieldName : mixed

wakeUp()

Constructs existing object from pre-selected data, including references and relations.


    public
        final    static        wakeUp(mixed $row) : static

Parameters

$row : mixed: Array of [field => value] or single scalar primary value.

Return values

static

Type extends EntityObject

Tags

Table of Contents

Properties

Methods

Properties

$authContext

$customData read-only

$dataClass

$entity read-only

$primary read-only

$primaryAsString read-only

$state read-only

Methods

__call()

Parameters

Tags

__clone()

__construct()

Parameters

Tags

__get()

Parameters

Tags

__set()

Parameters

Tags

addTo()

Parameters

Tags

collectValues()

Parameters

Tags

Return values

defineAuthContext()

Parameters

delete()

Tags

Return values

fill()

Parameters

Tags

get()

Parameters

Tags

getId()

Tags

Return values

getName()

Return values

getTableName()

Return values

has()

Parameters

Tags

isChanged()

Parameters

Tags

isFilled()

Parameters

Tags

offsetExists()

Parameters

Tags

Return values

offsetGet()

Parameters

Tags

Attributes

Return values

offsetSet()

Parameters

Tags

offsetUnset()

Parameters

remindActual()

Parameters

Tags

removeAll()

Parameters