Bitrix API

Item extends Item implements JsonSerializable

Class Item

Interfaces

JsonSerializable

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
getAccountCurrencyId() : string|null
getAssignedById() : array<string|int, mixed>|int
getBegindate() : Date
getCategoryId() : int|null
getClosedate() : Date
getCompanyId() : int|null
getContactId() : int|null
getCreatedBy() : int
getCreatedTime() : DateTime
getCurrencyId() : string|null
getDefaultTitle() : string
getEntityTypeId() : int
getFactory() : Factory
getId() : Collection|EntityObject|mixed: Fast popular alternative to __call().
getIsManualOpportunity() : bool
getMovedBy() : int|null
getMovedTime() : DateTime|null
getMycompanyId() : int|null
getOpened() : bool
getOpportunity() : float|null
getOpportunityAccount() : float|null
getPreviousStageId() : string|null
getSourceDescription() : string|null
getSourceId() : string|null
getStageId() : string|null
getTaxValue() : float|null
getTaxValueAccount() : float|null
getTitle() : string|null
getUpdatedBy() : int|null
getUpdatedTime() : DateTime|null
has() : mixed
isChanged() : mixed
isFilled() : mixed
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
remindActualAssignedById() : mixed
remindActualTitle() : string|null
removeAll() : mixed
removeFrom() : mixed
require() : mixed
reset() : mixed
save() : Result: ActiveRecord save.
set() : mixed
setAccountCurrencyId() : void
setAssignedById() : void
setBegindate() : void
setCategoryId() : void
setClosedate() : void
setCompanyId() : void
setContactId() : void
setCreatedBy() : void
setCreatedTime() : void
setCurrencyId() : void
setIsManualOpportunity() : void
setMovedBy() : void
setMovedTime() : void
setMycompanyId() : void
setOpened() : void
setOpportunity() : void
setOpportunityAccount() : void
setPreviousStageId() : void
setSourceDescription() : void
setSourceId() : void
setStageId() : void
setTaxValue() : void
setTaxValueAccount() : void
setTitle() : void
setUpdatedBy() : void
setUpdatedTime() : void
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

getAccountCurrencyId()


    public
                    getAccountCurrencyId() : string|null

Return values

string|null

getAssignedById()


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

Return values

array<string|int, mixed>|int

getBegindate()


    public
                    getBegindate() : Date

Return values

Date

getCategoryId()


    public
                    getCategoryId() : int|null

Return values

int|null

getClosedate()


    public
                    getClosedate() : Date

Return values

Date

getCompanyId()


    public
                    getCompanyId() : int|null

Return values

int|null

getContactId()


    public
                    getContactId() : int|null

Return values

int|null

getCreatedBy()


    public
                    getCreatedBy() : int

Return values

int

getCreatedTime()


    public
                    getCreatedTime() : DateTime

Return values

DateTime

getCurrencyId()


    public
                    getCurrencyId() : string|null

Return values

string|null

getDefaultTitle()


    public
                    getDefaultTitle() : string

Return values

string

getEntityTypeId()


    public
                    getEntityTypeId() : int

Return values

int

getFactory()


    public
                    getFactory() : Factory

Return values

Factory

getId()

Fast popular alternative to __call().


    public
                    getId() : Collection|EntityObject|mixed

Return values

Collection|EntityObject|mixed

getIsManualOpportunity()


    public
                    getIsManualOpportunity() : bool

Return values

bool

getMovedBy()


    public
                    getMovedBy() : int|null

Return values

int|null

getMovedTime()


    public
                    getMovedTime() : DateTime|null

Return values

DateTime|null

getMycompanyId()


    public
                    getMycompanyId() : int|null

Return values

int|null

getOpened()


    public
                    getOpened() : bool

Return values

bool

getOpportunity()


    public
                    getOpportunity() : float|null

Return values

float|null

getOpportunityAccount()


    public
                    getOpportunityAccount() : float|null

Return values

float|null

getPreviousStageId()


    public
                    getPreviousStageId() : string|null

Return values

string|null

getSourceDescription()


    public
                    getSourceDescription() : string|null

Return values

string|null

getSourceId()


    public
                    getSourceId() : string|null

Return values

string|null

getStageId()


    public
                    getStageId() : string|null

Return values

string|null

getTaxValue()


    public
                    getTaxValue() : float|null

Return values

float|null

getTaxValueAccount()


    public
                    getTaxValueAccount() : float|null

Return values

float|null

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

jsonSerialize()


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

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

remindActualAssignedById()


    public
                    remindActualAssignedById() : mixed

remindActualTitle()


    public
                    remindActualTitle() : string|null

Return values

string|null

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

setAccountCurrencyId()


    public
                    setAccountCurrencyId(string $accountCurrencyId) : void

Parameters

$accountCurrencyId : string

setAssignedById()


    public
                    setAssignedById(array<string|int, mixed>|int $value) : void

Parameters

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

setBegindate()


    public
                    setBegindate(Date $date) : void

Parameters

$date : Date

setCategoryId()


    public
                    setCategoryId(int $categoryId) : void

Parameters

$categoryId : int

setClosedate()


    public
                    setClosedate(Date $date) : void

Parameters

$date : Date

setCompanyId()


    public
                    setCompanyId(int $companyId) : void

Parameters

$companyId : int

setContactId()


    public
                    setContactId(int $contactId) : void

Parameters

$contactId : int

setCreatedBy()


    public
                    setCreatedBy(int $userId) : void

Parameters

$userId : int

setCreatedTime()


    public
                    setCreatedTime(DateTime $dateTime) : void

Parameters

$dateTime : DateTime

setCurrencyId()


    public
                    setCurrencyId(string $currencyId) : void

Parameters

$currencyId : string

setIsManualOpportunity()


    public
                    setIsManualOpportunity(bool $isManualOpportunity) : void

Parameters

$isManualOpportunity : bool

setMovedBy()


    public
                    setMovedBy(int $userId) : void

Parameters

$userId : int

setMovedTime()


    public
                    setMovedTime(DateTime $dateTime) : void

Parameters

$dateTime : DateTime

setMycompanyId()


    public
                    setMycompanyId(int $mycompanyId) : void

Parameters

$mycompanyId : int

setOpened()


    public
                    setOpened(bool $isOpened) : void

Parameters

$isOpened : bool

setOpportunity()


    public
                    setOpportunity(float $opportunity) : void

Parameters

$opportunity : float

setOpportunityAccount()


    public
                    setOpportunityAccount(float $opportunityAccount) : void

Parameters

$opportunityAccount : float

setPreviousStageId()


    public
                    setPreviousStageId(string $stageId) : void

Parameters

$stageId : string

setSourceDescription()


    public
                    setSourceDescription(string $sourceDescription) : void

Parameters

$sourceDescription : string

setSourceId()


    public
                    setSourceId(string $sourceId) : void

Parameters

$sourceId : string

setStageId()


    public
                    setStageId(string $stageId) : void

Parameters

$stageId : string

setTaxValue()


    public
                    setTaxValue(float $taxValue) : void

Parameters

$taxValue : float

setTaxValueAccount()


    public
                    setTaxValueAccount(float $taxValueAccount) : void

Parameters

$taxValueAccount : float

setTitle()


    public
                    setTitle(string $title) : void

Parameters

$title : string

setUpdatedBy()


    public
                    setUpdatedBy(int $userId) : void

Parameters

$userId : int

setUpdatedTime()


    public
                    setUpdatedTime(DateTime $dateTime) : void

Parameters

$dateTime : DateTime

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

Item extends Item implements JsonSerializable

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

getAccountCurrencyId()

Return values

getAssignedById()

Return values

getBegindate()

Return values

getCategoryId()

Return values

getClosedate()

Return values

getCompanyId()

Return values

getContactId()

Return values

getCreatedBy()

Return values

getCreatedTime()

Return values

getCurrencyId()

Return values

getDefaultTitle()

Return values

getEntityTypeId()

Return values

getFactory()

Return values

getId()

Tags

Return values

getIsManualOpportunity()

Return values

getMovedBy()

Return values

getMovedTime()

Return values