Bitrix API

Type extends Type implements JsonSerializable

Class Type

Interfaces

JsonSerializable

Properties

$authContext : Context
$customData : Dictionary
$dataClass : mixed
$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
getCreatedBy() : int|null
getCreatedTime() : DateTime|null
getCustomSectionId() : int|null
getEntityTypeId() : int|null
getId() : Collection|EntityObject|mixed: Fast popular alternative to __call().
getIsAutomationEnabled() : bool|null
getIsBeginCloseDatesEnabled() : bool|null
getIsBizProcEnabled() : bool|null
getIsCategoriesEnabled() : bool|null
getIsClientEnabled() : bool|null
getIsCountersEnabled() : bool|null
getIsCrmTrackingEnabled() : bool|null
getIsDocumentsEnabled() : bool|null
getIsLinkWithProductsEnabled() : bool|null
getIsMycompanyEnabled() : bool|null
getIsObserversEnabled() : bool|null
getIsPaymentsEnabled() : bool|null
getIsRecyclebinEnabled() : bool|null
getIsSetOpenPermissions() : bool|null
getIsSourceEnabled() : bool|null
getIsStagesEnabled() : bool|null
getIsUseInUserfieldEnabled() : bool|null
getName() : string|null
getTableName() : string
getTitle() : string|null
getUpdatedBy() : int|null
getUpdatedTime() : DateTime|null
has() : mixed
isChanged() : mixed
isFilled() : mixed
isNew() : bool: Returns true if this object has been created recently and is not saved yet
jsonSerialize() : array<string|int, 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
setCreatedBy() : Type
setCreatedTime() : Type
setCustomSectionId() : Type
setEntityTypeId() : Type
setIsAutomationEnabled() : Type
setIsBeginCloseDatesEnabled() : Type
setIsBizProcEnabled() : Type
setIsCategoriesEnabled() : Type
setIsClientEnabled() : Type
setIsCountersEnabled() : Type
setIsCrmTrackingEnabled() : Type
setIsDocumentsEnabled() : Type
setIsLinkWithProductsEnabled() : Type
setIsMycompanyEnabled() : Type
setIsObserversEnabled() : Type
setIsPaymentsEnabled() : Type
setIsRecyclebinEnabled() : Type
setIsSetOpenPermissions() : Type
setIsSourceEnabled() : Type
setIsStagesEnabled() : Type
setName() : Type
setTitle() : Type
setUpdatedBy() : Type
setUpdatedTime() : Type
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


        public
        static    mixed
    $dataClass
     = \Bitrix\Crm\Model\Dynamic\TypeTable::class

$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

getCreatedBy()


    public
                    getCreatedBy() : int|null

Return values

int|null

getCreatedTime()


    public
                    getCreatedTime() : DateTime|null

Return values

DateTime|null

getCustomSectionId()


    public
                    getCustomSectionId() : int|null

Return values

int|null

getEntityTypeId()


    public
                    getEntityTypeId() : int|null

Return values

int|null

getId()

Fast popular alternative to __call().


    public
                    getId() : Collection|EntityObject|mixed

Return values

Collection|EntityObject|mixed

getIsAutomationEnabled()


    public
                    getIsAutomationEnabled() : bool|null

Return values

bool|null

getIsBeginCloseDatesEnabled()


    public
                    getIsBeginCloseDatesEnabled() : bool|null

Return values

bool|null

getIsBizProcEnabled()


    public
                    getIsBizProcEnabled() : bool|null

Return values

bool|null

getIsCategoriesEnabled()


    public
                    getIsCategoriesEnabled() : bool|null

Return values

bool|null

getIsClientEnabled()


    public
                    getIsClientEnabled() : bool|null

Return values

bool|null

getIsCountersEnabled()


    public
                    getIsCountersEnabled() : bool|null

Return values

bool|null

getIsCrmTrackingEnabled()


    public
                    getIsCrmTrackingEnabled() : bool|null

Return values

bool|null

getIsDocumentsEnabled()


    public
                    getIsDocumentsEnabled() : bool|null

Return values

bool|null

getIsLinkWithProductsEnabled()


    public
                    getIsLinkWithProductsEnabled() : bool|null

Return values

bool|null

getIsMycompanyEnabled()


    public
                    getIsMycompanyEnabled() : bool|null

Return values

bool|null

getIsObserversEnabled()


    public
                    getIsObserversEnabled() : bool|null

Return values

bool|null

getIsPaymentsEnabled()


    public
                    getIsPaymentsEnabled() : bool|null

Return values

bool|null

getIsRecyclebinEnabled()


    public
                    getIsRecyclebinEnabled() : bool|null

Return values

bool|null

getIsSetOpenPermissions()


    public
                    getIsSetOpenPermissions() : bool|null

Return values

bool|null

getIsSourceEnabled()


    public
                    getIsSourceEnabled() : bool|null

Return values

bool|null

getIsStagesEnabled()


    public
                    getIsStagesEnabled() : bool|null

Return values

bool|null

getIsUseInUserfieldEnabled()


    public
                    getIsUseInUserfieldEnabled() : bool|null

Return values

bool|null

getName()


    public
                    getName() : string|null

Return values

string|null

getTableName()


    public
                    getTableName() : string

Return values

string

getTitle()


    public
                    getTitle() : string|null

Return values

string|null

getUpdatedBy()


    public
                    getUpdatedBy() : int|null

Return values

int|null

getUpdatedTime()


    public
                    getUpdatedTime() : DateTime|null

Return values

DateTime|null

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

isNew()

Returns true if this object has been created recently and is not saved yet


    public
                    isNew() : bool

Return values

bool

jsonSerialize()


    public
                    jsonSerialize([bool|null $allData = true ]) : array<string|int, mixed>

Parameters

$allData : bool|null = true

Return values

array<string|int, 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

setCreatedBy()


    public
                    setCreatedBy(int $createdById) : Type

Parameters

$createdById : int

Return values

Type

setCreatedTime()


    public
                    setCreatedTime(DateTime $createdTime) : Type

Parameters

$createdTime : DateTime

Return values

Type

setCustomSectionId()


    public
                    setCustomSectionId(int|null $customSectionId) : Type

Parameters

$customSectionId : int|null

Return values

Type

setEntityTypeId()


    public
                    setEntityTypeId(int $entityTypeId) : Type

Parameters

$entityTypeId : int

Return values

Type

setIsAutomationEnabled()


    public
                    setIsAutomationEnabled(bool $isAutomationEnabled) : Type

Parameters

$isAutomationEnabled : bool

Return values

Type

setIsBeginCloseDatesEnabled()


    public
                    setIsBeginCloseDatesEnabled(bool $isBeginCloseDatesEnabled) : Type

Parameters

$isBeginCloseDatesEnabled : bool

Return values

Type

setIsBizProcEnabled()


    public
                    setIsBizProcEnabled(bool $isBizProcEnabled) : Type

Parameters

$isBizProcEnabled : bool

Return values

Type

setIsCategoriesEnabled()


    public
                    setIsCategoriesEnabled(bool $isCategoriesEnabled) : Type

Parameters

$isCategoriesEnabled : bool

Return values

Type

setIsClientEnabled()


    public
                    setIsClientEnabled(bool $isClientEnabled) : Type

Parameters

$isClientEnabled : bool

Return values

Type

setIsCountersEnabled()


    public
                    setIsCountersEnabled(bool $isCountersEnabled) : Type

Parameters

$isCountersEnabled : bool

Return values

Type

setIsCrmTrackingEnabled()


    public
                    setIsCrmTrackingEnabled(bool $isCrmTrackingEnabled) : Type

Parameters

$isCrmTrackingEnabled : bool

Return values

Type

setIsDocumentsEnabled()


    public
                    setIsDocumentsEnabled(bool $isDocumentsEnabled) : Type

Parameters

$isDocumentsEnabled : bool

Return values

Type

setIsLinkWithProductsEnabled()


    public
                    setIsLinkWithProductsEnabled(bool $isLinkWithProductsEnabled) : Type

Parameters

$isLinkWithProductsEnabled : bool

Return values

Type

setIsMycompanyEnabled()


    public
                    setIsMycompanyEnabled(bool $isMycompanyEnabled) : Type

Parameters

$isMycompanyEnabled : bool

Return values

Type

setIsObserversEnabled()


    public
                    setIsObserversEnabled(bool $isObserversEnabled) : Type

Parameters

$isObserversEnabled : bool

Return values

Type

setIsPaymentsEnabled()


    public
                    setIsPaymentsEnabled(bool $isPaymentsEnabled) : Type

Parameters

$isPaymentsEnabled : bool

Return values

Type

setIsRecyclebinEnabled()


    public
                    setIsRecyclebinEnabled(bool $isRecyclebinEnabled) : Type

Parameters

$isRecyclebinEnabled : bool

Return values

Type

setIsSetOpenPermissions()


    public
                    setIsSetOpenPermissions(bool $isSetOpenPermissions) : Type

Parameters

$isSetOpenPermissions : bool

Return values

Type

setIsSourceEnabled()


    public
                    setIsSourceEnabled(bool $isSourceEnabled) : Type

Parameters

$isSourceEnabled : bool

Return values

Type

setIsStagesEnabled()


    public
                    setIsStagesEnabled(bool $isStagesEnabled) : Type

Parameters

$isStagesEnabled : bool

Return values

Type

setName()


    public
                    setName(string $name) : Type

Parameters

$name : string

Return values

Type

setTitle()


    public
                    setTitle(string $title) : Type

Parameters

$title : string

Return values

Type

setUpdatedBy()


    public
                    setUpdatedBy(int $createdById) : Type

Parameters

$createdById : int

Return values

Type

setUpdatedTime()


    public
                    setUpdatedTime(DateTime $updatedTime) : Type

Parameters

$updatedTime : DateTime

Return values

Type

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 Type implements JsonSerializable

Tags

Table of Contents

Interfaces

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

getCreatedBy()

Return values

getCreatedTime()

Return values

getCustomSectionId()

Return values

getEntityTypeId()

Return values

getId()

Tags

Return values

getIsAutomationEnabled()

Return values

getIsBeginCloseDatesEnabled()

Return values

getIsBizProcEnabled()

Return values

getIsCategoriesEnabled()

Return values

getIsClientEnabled()

Return values

getIsCountersEnabled()

Return values

getIsCrmTrackingEnabled()

Return values

getIsDocumentsEnabled()

Return values

getIsLinkWithProductsEnabled()

Return values

getIsMycompanyEnabled()

Return values

getIsObserversEnabled()

Return values

getIsPaymentsEnabled()