Bitrix API

Entry extends Model

Table of Contents

Constants

ERROR_INTERNAL_ADD  = 'DISK_MO_28000'
ERROR_INTERNAL_DELETE  = 'DISK_MO_28002'
ERROR_INTERNAL_UPDATE  = 'DISK_MO_28001'

Methods

buildFromResult()  : static
Builds model from \Bitrix\Main\Entity\Result.
buildFromRow()  : Model
Builds model from row which received from database.
className()  : string
Returns the fully qualified name of this class.
getById()  : static
getContentSize()  : int
getContentUrl()  : string
getCreateTime()  : DateTime
getDownloadedContentSize()  : int
getErrorByCode()  : array<string|int, Error>
Getting once error with the necessary code.
getErrors()  : array<string|int, Error>
Getting array of errors.
getErrorsByCode()  : array<string|int, Error>
Getting array of errors with the necessary code.
getEtag()  : string
getId()  : int
getList()  : Result
getMapAttributes()  : array<string|int, mixed>
Returns the list of pair for mapping data and object properties.
getMapReferenceAttributes()  : array<string|int, mixed>
Returns the list attributes which is connected with another models.
getMimeType()  : string
getModelList()  : array<string|int, static>
Get model list like getList
getObject()  : BaseObject
getObjectId()  : int
getPrimary()  : mixed
getService()  : string
getServiceObjectId()  : string
getTableClassName()  : string
Gets the fully qualified name of table class which belongs to current model.
getTmpFile()  : TmpFile
getTmpFileId()  : int
getUser()  : User
getUserId()  : int
getVersion()  : Version
getVersionId()  : int
increaseDownloadedContentSize()  : mixed
isDownloaded()  : mixed
linkObject()  : mixed
linkTmpFile()  : mixed
linkVersion()  : mixed
load()  : static
Returns once model by specific filter.
loadBatchById()  : mixed
Returns list of models by specific filter by id.
loadById()  : static
offsetExists()  : bool
(PHP 5 &gt;= 5.0.0)<br/> Whether a offset exists
offsetGet()  : mixed
(PHP 5 &gt;= 5.0.0)<br/> Offset to retrieve
offsetSet()  : void
(PHP 5 &gt;= 5.0.0)<br/> Offset to set
offsetUnset()  : void
(PHP 5 &gt;= 5.0.0)<br/> Offset to unset
setContentSize()  : mixed
toArray()  : array<string|int, mixed>
Export model to array. Use map attributes and field getter.

Constants

ERROR_INTERNAL_ADD

public mixed ERROR_INTERNAL_ADD = 'DISK_MO_28000'

ERROR_INTERNAL_DELETE

public mixed ERROR_INTERNAL_DELETE = 'DISK_MO_28002'

ERROR_INTERNAL_UPDATE

public mixed ERROR_INTERNAL_UPDATE = 'DISK_MO_28001'

Methods

buildFromResult()

Builds model from \Bitrix\Main\Entity\Result.

public static buildFromResult(Result $result) : static
Parameters
$result : Result

Query result.

Tags
throws
ArgumentException
Return values
static

buildFromRow()

Builds model from row which received from database.

public static buildFromRow(array<string|int, mixed> $row[, array<string|int, mixed>|null $with = [] ]) : Model
Parameters
$row : array<string|int, mixed>

Row.

$with : array<string|int, mixed>|null = []

Description of connected entities.

Tags
throws
SystemException
Return values
Model

className()

Returns the fully qualified name of this class.

public static className() : string
Return values
string

getById()

public static getById(mixed $id[, array<string|int, mixed> $with = array() ]) : static
Parameters
$id : mixed
$with : array<string|int, mixed> = array()
Tags
throws
NotImplementedException
Return values
static

getContentSize()

public getContentSize() : int
Return values
int

getContentUrl()

public getContentUrl() : string
Return values
string

getDownloadedContentSize()

public getDownloadedContentSize() : int
Return values
int

getErrorByCode()

Getting once error with the necessary code.

public getErrorByCode(mixed $code) : array<string|int, Error>
Parameters
$code : mixed

Code of error.

Tags
inheritdoc
Return values
array<string|int, Error>

getErrors()

Getting array of errors.

public getErrors() : array<string|int, Error>
Return values
array<string|int, Error>

getErrorsByCode()

Getting array of errors with the necessary code.

public getErrorsByCode(mixed $code) : array<string|int, Error>
Parameters
$code : mixed

Code of error.

Tags
inheritdoc
Return values
array<string|int, Error>

getEtag()

public getEtag() : string
Return values
string

getId()

public getId() : int
Return values
int

getList()

public static getList(array<string|int, mixed> $parameters) : Result
Parameters
$parameters : array<string|int, mixed>
Tags
throws
NotImplementedException
Return values
Result

getMapAttributes()

Returns the list of pair for mapping data and object properties.

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

Key is field in DataManager, value is object property.

Return values
array<string|int, mixed>

getMapReferenceAttributes()

Returns the list attributes which is connected with another models.

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

getMimeType()

public getMimeType() : string
Return values
string

getModelList()

Get model list like getList

public static getModelList(array<string|int, mixed> $parameters) : array<string|int, static>
Parameters
$parameters : array<string|int, mixed>
Return values
array<string|int, static>

getObject()

public getObject() : BaseObject
Return values
BaseObject

getObjectId()

public getObjectId() : int
Return values
int

getPrimary()

public getPrimary() : mixed

getService()

public getService() : string
Return values
string

getServiceObjectId()

public getServiceObjectId() : string
Return values
string

getTableClassName()

Gets the fully qualified name of table class which belongs to current model.

public static getTableClassName() : string
Tags
throws
NotImplementedException
Return values
string

getTmpFileId()

public getTmpFileId() : int
Return values
int

getUser()

public getUser() : User
Return values
User

getUserId()

public getUserId() : int
Return values
int

getVersion()

public getVersion() : Version
Return values
Version

getVersionId()

public getVersionId() : int
Return values
int

increaseDownloadedContentSize()

public increaseDownloadedContentSize(mixed $size) : mixed
Parameters
$size : mixed

isDownloaded()

public isDownloaded() : mixed

linkObject()

public linkObject(BaseObject $object) : mixed
Parameters
$object : BaseObject

linkVersion()

public linkVersion(Version $version) : mixed
Parameters
$version : Version

load()

Returns once model by specific filter.

public static load(array<string|int, mixed> $filter[, array<string|int, mixed> $with = array() ]) : static
Parameters
$filter : array<string|int, mixed>

Filter.

$with : array<string|int, mixed> = array()

List of eager loading.

Tags
throws
NotImplementedException
Return values
static

loadBatchById()

Returns list of models by specific filter by id.

public static loadBatchById(array<string|int, mixed> $ids[, array<string|int, mixed> $with = [] ]) : mixed
Parameters
$ids : array<string|int, mixed>

List of ids.

$with : array<string|int, mixed> = []

List of eager loading.

loadById()

public static loadById(mixed $id[, array<string|int, mixed> $with = array() ]) : static
Parameters
$id : mixed
$with : array<string|int, mixed> = array()
Tags
throws
NotImplementedException
Return values
static

offsetExists()

(PHP 5 &gt;= 5.0.0)<br/> Whether a offset exists

public offsetExists(mixed $offset) : bool
Parameters
$offset : mixed

An offset to check for.

Tags
link
http://php.net/manual/en/arrayaccess.offsetexists.php
Return values
bool —

true on success or false on failure.

The return value will be casted to boolean if non-boolean was returned.

offsetGet()

(PHP 5 &gt;= 5.0.0)<br/> Offset to retrieve

public offsetGet(mixed $offset) : mixed
Parameters
$offset : mixed

The offset to retrieve.

Tags
link
http://php.net/manual/en/arrayaccess.offsetget.php
Attributes
#[ReturnTypeWillChange]
Return values
mixed —

Can return all value types.

offsetSet()

(PHP 5 &gt;= 5.0.0)<br/> Offset to set

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

The offset to assign the value to.

$value : mixed

The value to set.

Tags
link
http://php.net/manual/en/arrayaccess.offsetset.php
throws
NotSupportedException

setContentSize()

public setContentSize(mixed $size) : mixed
Parameters
$size : mixed

toArray()

Export model to array. Use map attributes and field getter.

public toArray([array<string|int, mixed> $with = [] ][, array<string|int, mixed>|null $allowedFields = null ]) : array<string|int, mixed>
Parameters
$with : array<string|int, mixed> = []
$allowedFields : array<string|int, mixed>|null = null
Return values
array<string|int, mixed> 

        

        
    




    

    

                                

                

                                
    

        On this page

        
    


                

                            

            

    

        

            
Search results