Bitrix API

DocumentSession extends Model

FinalYes

Table of Contents

Constants

ERROR_INTERNAL_ADD  = 'DISK_MO_28000'
ERROR_INTERNAL_DELETE  = 'DISK_MO_28002'
ERROR_INTERNAL_UPDATE  = 'DISK_MO_28001'
REF_INFO  = 'info'
REF_OBJECT  = 'object'
REF_OWNER  = 'owner'
REF_USER  = 'user'
REF_VERSION  = 'version'
STATUS_ACTIVE  = \Bitrix\Disk\Document\Models\DocumentSessionTable::STATUS_ACTIVE
STATUS_BROKEN  = \Bitrix\Disk\Document\Models\DocumentSessionTable::STATUS_BROKEN
STATUS_NON_ACTIVE  = \Bitrix\Disk\Document\Models\DocumentSessionTable::STATUS_NON_ACTIVE
TYPE_EDIT  = \Bitrix\Disk\Document\Models\DocumentSessionTable::TYPE_EDIT
TYPE_VIEW  = \Bitrix\Disk\Document\Models\DocumentSessionTable::TYPE_VIEW

Methods

__call()  : mixed
We have to normalize getMapReferenceAttributes() and use lower case.
add()  : mixed
belongsToUser()  : bool
buildFromResult()  : static
Builds model from \Bitrix\Main\Entity\Result.
buildFromRow()  : Model
Builds model from row which received from database.
canChangeRights()  : bool
canEdit()  : bool
canRead()  : bool
canRename()  : bool
canShare()  : bool
canTransformToEdit()  : bool
canTransformUserToEdit()  : bool
canUserChangeRights()  : bool
canUserEdit()  : bool
canUserRead()  : bool
canUserRename()  : bool
canUserShare()  : bool
className()  : string
Returns the fully qualified name of this class.
cloneWithNewHash()  : self|null
countActiveSessions()  : int
createEditSession()  : self|null
createInfo()  : DocumentInfo
delete()  : bool
forkForUser()  : self|null
getById()  : static
getContext()  : DocumentSessionContext|null
getContextRaw()  : string|null
getCreateTime()  : DateTime
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.
getExternalHash()  : string
getFile()  : File|null
getFilename()  : string
getId()  : mixed
getInfo()  : DocumentInfo|null
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.
getModelList()  : array<string|int, static>
Get model list like getList
getObject()  : File|null
getObjectId()  : int
getOwner()  : EmptyUser|SystemUser|User
getOwnerId()  : int
getPrimary()  : mixed
getService()  : DocumentService|null
getServiceRaw()  : string|null
getStatus()  : int
getTableClassName()  : string
Gets the fully qualified name of table class which belongs to current model.
getType()  : int
getUser()  : EmptyUser|SystemUser|User
getUserId()  : int
getVersion()  : Version|null
getVersionId()  : int
isActive()  : bool
isBroken()  : bool
isEdit()  : bool
isExclusive()  : bool
isNonActive()  : bool
isOutdatedByFileContent()  : bool
isVersion()  : bool
isView()  : bool
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
resetReferenceValue()  : void
setAsActive()  : bool
setAsBroken()  : bool
setAsNonActive()  : bool
setReferenceValue()  : mixed
setUserId()  : self
toArray()  : array<string|int, mixed>
Export model to array. Use map attributes and field getter.
transformToEdit()  : bool

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'

STATUS_ACTIVE

public mixed STATUS_ACTIVE = \Bitrix\Disk\Document\Models\DocumentSessionTable::STATUS_ACTIVE

STATUS_BROKEN

public mixed STATUS_BROKEN = \Bitrix\Disk\Document\Models\DocumentSessionTable::STATUS_BROKEN

STATUS_NON_ACTIVE

public mixed STATUS_NON_ACTIVE = \Bitrix\Disk\Document\Models\DocumentSessionTable::STATUS_NON_ACTIVE

TYPE_EDIT

public mixed TYPE_EDIT = \Bitrix\Disk\Document\Models\DocumentSessionTable::TYPE_EDIT

TYPE_VIEW

public mixed TYPE_VIEW = \Bitrix\Disk\Document\Models\DocumentSessionTable::TYPE_VIEW

Methods

__call()

We have to normalize getMapReferenceAttributes() and use lower case.

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

belongsToUser()

public belongsToUser(int $userId) : bool
Parameters
$userId : int
Return values
bool

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

countActiveSessions()

public countActiveSessions() : int
Return values
int

createEditSession()

public createEditSession() : self|null
Return values
self|null

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

getContextRaw()

public getContextRaw() : string|null
Return values
string|null

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>

getExternalHash()

public getExternalHash() : string
Return values
string

getId()

public getId() : mixed

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>

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>

getOwner()

public getOwner() : EmptyUser|SystemUser|User
Return values
EmptyUser|SystemUser|User

getPrimary()

public getPrimary() : mixed

getServiceRaw()

public getServiceRaw() : string|null
Return values
string|null

getTableClassName()

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

public static getTableClassName() : string
Return values
string

getUser()

public getUser() : EmptyUser|SystemUser|User
Return values
EmptyUser|SystemUser|User

getVersion()

public getVersion() : Version|null
Return values
Version|null

isOutdatedByFileContent()

public isOutdatedByFileContent() : bool
Return values
bool

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

resetReferenceValue()

public resetReferenceValue(string $referenceName) : void
Parameters
$referenceName : string

setReferenceValue()

public setReferenceValue(mixed $referenceName, mixed $value) : mixed
Parameters
$referenceName : mixed
$value : mixed
Tags
throws
ArgumentException

setUserId()

public setUserId(int $userId) : self
Parameters
$userId : int
Return values
self

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>

transformToEdit()

public transformToEdit() : bool
Return values
bool 

        

        
    




    

    

                                

                

                                
    

        On this page

        
    


                

                            

            

    

        

            
Search results