Bitrix API

ActiveRecord

Table of Contents

Methods

delete()  : Result
Drops object from database.
fill()  : self
Fills object's fields with provided values.
getDataClass()  : string
Returns ORM tablet class name.
getDataEntity()  : EntityObject
Returns ORM data entity.
getPrimaryId()  : int|null
isChanged()  : bool
Tells true if object has been changed.
isDeleted()  : bool
Tells true if object marked to drop.
load()  : Result
Restores object state from database.
markChanged()  : self
Marks object changed.
markDrop()  : self
Marks object to drop on save.
prepareFields()  : Result
Fills and prepares the fields of the data entity.
save()  : Result
Saves object state into database.
setPrimaryId()  : self
toArray()  : array<string|int, mixed>
Returns object state as array.

Methods

fill()

Fills object's fields with provided values.

public fill(array<string|int, mixed> $source) : self
Parameters
$source : array<string|int, mixed>
Return values
self

getDataClass()

Returns ORM tablet class name.

public static getDataClass() : string
Return values
string

getPrimaryId()

public getPrimaryId() : int|null
Return values
int|null

isChanged()

Tells true if object has been changed.

public isChanged() : bool
Return values
bool

isDeleted()

Tells true if object marked to drop.

public isDeleted() : bool
Return values
bool

markChanged()

Marks object changed.

public markChanged() : self
Return values
self

markDrop()

Marks object to drop on save.

public markDrop() : self
Return values
self

prepareFields()

Fills and prepares the fields of the data entity.

public prepareFields() : Result
Return values
Result

setPrimaryId()

public setPrimaryId(int $primaryId) : self
Parameters
$primaryId : int
Return values
self

toArray()

Returns object state as array.

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

        
On this page

Search results