Bitrix API

SetupSession extends Model

FinalYes

Class SetupSession

Constants

ERROR_INTERNAL_ADD = 'DISK_MO_28000'
ERROR_INTERNAL_DELETE = 'DISK_MO_28002'
ERROR_INTERNAL_UPDATE = 'DISK_MO_28001'
REF_OBJECT = 'object'
REF_PARENT = 'parent'
STATUS_BAD = \Bitrix\Disk\Internals\Rights\Table\RightSetupSessionTable::STATUS_BAD
STATUS_BAD_PURIFIED = \Bitrix\Disk\Internals\Rights\Table\RightSetupSessionTable::STATUS_BAD_PURIFIED
STATUS_DUPLICATE = \Bitrix\Disk\Internals\Rights\Table\RightSetupSessionTable::STATUS_DUPLICATE
STATUS_FINISHED = \Bitrix\Disk\Internals\Rights\Table\RightSetupSessionTable::STATUS_FINISHED
STATUS_FORKED = \Bitrix\Disk\Internals\Rights\Table\RightSetupSessionTable::STATUS_FORKED
STATUS_STARTED = \Bitrix\Disk\Internals\Rights\Table\RightSetupSessionTable::STATUS_STARTED

Methods

__call() : mixed: We have to normalize getMapReferenceAttributes() and use lower case.
bindParent() : $this: Binds parent session to current.
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.
delete() : bool: Deletes session.
finish() : void: Finishes the logic of setup session. It moves simple rights to original table.
forkAndRestart() : void: Restarts process of setting simple rights on the object.
getById() : static
getCreatedBy() : int
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.
getId() : mixed
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() : BaseObject
getObjectId() : int
getParent() : SetupSession
getParentId() : int
getPrimary() : mixed
getStatus() : int
getTableClassName() : string: Gets the fully qualified name of table class which belongs to current model.
isFinished() : bool
isForked() : 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 >= 5.0.0) Whether a offset exists
offsetGet() : mixed: (PHP 5 >= 5.0.0) Offset to retrieve
offsetSet() : void: (PHP 5 >= 5.0.0) Offset to set
offsetUnset() : void: (PHP 5 >= 5.0.0) Offset to unset
register() : SetupSession: Registers session to recalculate simple rights in b_disk_tmp_simple_right.
resetReferenceValue() : void
setAsDuplicate() : mixed
setObject() : $this: Sets object to setup session.
setReferenceValue() : mixed
toArray() : array<string|int, mixed>: Export model to array. Use map attributes and field getter.

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'

REF_OBJECT


    public
        mixed
    REF_OBJECT
    = 'object'

REF_PARENT


    public
        mixed
    REF_PARENT
    = 'parent'

STATUS_BAD


    public
        mixed
    STATUS_BAD
    = \Bitrix\Disk\Internals\Rights\Table\RightSetupSessionTable::STATUS_BAD

STATUS_BAD_PURIFIED


    public
        mixed
    STATUS_BAD_PURIFIED
    = \Bitrix\Disk\Internals\Rights\Table\RightSetupSessionTable::STATUS_BAD_PURIFIED

STATUS_DUPLICATE


    public
        mixed
    STATUS_DUPLICATE
    = \Bitrix\Disk\Internals\Rights\Table\RightSetupSessionTable::STATUS_DUPLICATE

STATUS_FINISHED


    public
        mixed
    STATUS_FINISHED
    = \Bitrix\Disk\Internals\Rights\Table\RightSetupSessionTable::STATUS_FINISHED

STATUS_FORKED


    public
        mixed
    STATUS_FORKED
    = \Bitrix\Disk\Internals\Rights\Table\RightSetupSessionTable::STATUS_FORKED

STATUS_STARTED


    public
        mixed
    STATUS_STARTED
    = \Bitrix\Disk\Internals\Rights\Table\RightSetupSessionTable::STATUS_STARTED

__call()

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


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

Parameters

$name : mixed
$arguments : mixed

bindParent()

Binds parent session to current.


    public
                    bindParent(SetupSession $session) : $this

Parameters

$session : SetupSession: Parent session.

Return values

$this

buildFromResult()

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


    public
            static        buildFromResult(Result $result) : static

Parameters

$result : Result: Query result.

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.

Return values

Model

className()

Returns the fully qualified name of this class.


    public
            static        className() : string

Return values

string

delete()

Deletes session.


    public
                    delete() : bool

Return values

bool

finish()

Finishes the logic of setup session. It moves simple rights to original table.


    public
                    finish() : void

forkAndRestart()

Restarts process of setting simple rights on the object.


    public
                    forkAndRestart() : void

getById()


    public
            static        getById(mixed $id[, array<string|int, mixed> $with = array() ]) : static

Parameters

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

Return values

static

getCreatedBy()


    public
                    getCreatedBy() : int

Return values

int

getCreateTime()


    public
                    getCreateTime() : DateTime

Return values

DateTime

getErrorByCode()

Getting once error with the necessary code.


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

Parameters

$code : mixed: Code of error.

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.

Return values

array<string|int, Error>

getId()


    public
                    getId() : mixed

getList()


    public
            static        getList(array<string|int, mixed> $parameters) : Result

Parameters

$parameters : array<string|int, mixed>

Return values

Result

getMapAttributes()

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


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

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>

getObject()


    public
                    getObject() : BaseObject

Return values

BaseObject

getObjectId()


    public
                    getObjectId() : int

Return values

int

getParent()


    public
                    getParent() : SetupSession

Return values

SetupSession

getParentId()


    public
                    getParentId() : int

Return values

int

getPrimary()


    public
                    getPrimary() : mixed

getStatus()


    public
                    getStatus() : int

Return values

int

getTableClassName()

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


    public
            static        getTableClassName() : string

Return values

string

isFinished()


    public
                    isFinished() : bool

Return values

bool

isForked()


    public
                    isForked() : 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.

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()

Return values

static

offsetExists()

(PHP 5 >= 5.0.0) Whether a offset exists


    public
                    offsetExists(mixed $offset) : bool

Parameters

$offset : mixed: An offset to check for.

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 >= 5.0.0) Offset to retrieve


    public
                    offsetGet(mixed $offset) : mixed

Parameters

$offset : mixed: The offset to retrieve.

Return values

mixed —

Can return all value types.

offsetSet()

(PHP 5 >= 5.0.0) 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.

offsetUnset()

(PHP 5 >= 5.0.0) Offset to unset


    public
                    offsetUnset(mixed $offset) : void

Parameters

$offset : mixed: The offset to unset.

register()

Registers session to recalculate simple rights in b_disk_tmp_simple_right.


    public
            static        register(int $objectId[, int|null $createdBy = null ]) : SetupSession

Parameters

$objectId : int: Object id.
$createdBy : int|null = null: User id.

Return values

SetupSession

resetReferenceValue()


    public
                    resetReferenceValue(string $referenceName) : void

Parameters

$referenceName : string

setAsDuplicate()


    public
                    setAsDuplicate() : mixed

setObject()

Sets object to setup session.


    public
                    setObject(BaseObject $object) : $this

Parameters

$object : BaseObject: Object.

Return values

$this

setReferenceValue()


    public
                    setReferenceValue(mixed $referenceName, mixed $value) : mixed

Parameters

$referenceName : mixed
$value : 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>

SetupSession extends Model

Table of Contents

Constants

Methods

Constants

ERROR_INTERNAL_ADD

ERROR_INTERNAL_DELETE

ERROR_INTERNAL_UPDATE

REF_OBJECT

REF_PARENT

STATUS_BAD

STATUS_BAD_PURIFIED

STATUS_DUPLICATE

STATUS_FINISHED

STATUS_FORKED

STATUS_STARTED

Methods

__call()

Parameters

bindParent()

Parameters

Return values

buildFromResult()

Parameters

Tags

Return values

buildFromRow()

Parameters

Tags

Return values

className()

Return values

delete()

Tags

Return values

finish()

forkAndRestart()

getById()

Parameters

Tags

Return values

getCreatedBy()

Return values

getCreateTime()

Return values

getErrorByCode()

Parameters

Tags

Return values

getErrors()

Return values

getErrorsByCode()

Parameters

Tags

Return values

getId()

getList()

Parameters

Tags

Return values

getMapAttributes()

Return values

getMapReferenceAttributes()

Return values

getModelList()

Parameters

Return values

getObject()

Return values

getObjectId()

Return values

getParent()

Return values

getParentId()

Return values

getPrimary()

getStatus()

Return values

getTableClassName()

Tags