Bitrix API

Dashboard extends Model

Dashboard entity for operate with dashboard table and with it's references.

Table of Contents

Constants

ATTRIBUTE_SLICE_DELIMITER  = '__'

Methods

__call()  : void
Implement delete and add actions for nested relations.
__construct()  : mixed
Model constructor.
addRows()  : void
delete()  : bool|null
deleteRows()  : void
factoryWithHorizontalCells()  : mixed
getBoardKey()  : string
getBoardWithRowsAndWidgetsByBoardKeyUserId()  : static
Return board with fully loaded rows and widgets by board key and user id.
getClassName()  : string
getCopyForCurrentUser()  : Dashboard
Get Copy of Board and nested entities for createing board.
getCreatedAt()  : DateTime
getCurrentDbState()  : array<string|int, mixed>
getCurrentUserBoardWithEverythingByBoardKey()  : static
Return dasboard with all nested relations for current user by board key.
getDefaultBoardByBoardKey()  : static
Return dashboard by board key.
getDefaultBoardWithEverythingByBoardKey()  : static
Return default dashboard with relation entities.
getErrors()  : array<string|int, mixed>
Get Errors collections.
getGId()  : string
getId()  : mixed
getMapAttributes()  : array<string|int, mixed>
Returns the list of pair for mapping data and object properties.
getMapReferenceAttributes()  : array<string|int, mixed>
Map to set relations of this entity with other entities.
getRows()  : array<string|int, DashboardRow>
Get rows collection of current board.
getTableClassName()  : string
Gets the fully qualified name of table class which belongs to current model.
getUpdatedAt()  : DateTime
getUserId()  : int
getVersion()  : string
Get version.
load()  : static
loadAttribute()  : void
loadByBoardKeyAndUserId()  : Dashboard
Load Dashboard by board key and user id.
loadByBoardKeyMultiple()  : array<string|int, Dashboard>
Load multiple boards by board key.
loadById()  : static
save()  : Model
setBoardKey()  : void
Setter vor board key.
setCreatedAt()  : void
setGId()  : void
Gid setter.
setId()  : void
setUpdatedAt()  : void
setUserId()  : void
User id setter.
setVersion()  : void
Setterr for version.

Constants

ATTRIBUTE_SLICE_DELIMITER

public mixed ATTRIBUTE_SLICE_DELIMITER = '__'

Methods

__call()

Implement delete and add actions for nested relations.

public __call(string $name, array<string|int, mixed> $arguments) : void
Parameters
$name : string

Getter name.

$arguments : array<string|int, mixed>

Arguments passed to getter.

__construct()

Model constructor.

public __construct() : mixed

delete()

public delete() : bool|null
Return values
bool|null

factoryWithHorizontalCells()

public static factoryWithHorizontalCells([mixed $cellCount = 1 ]) : mixed
Parameters
$cellCount : mixed = 1

getBoardKey()

public getBoardKey() : string
Return values
string

getBoardWithRowsAndWidgetsByBoardKeyUserId()

Return board with fully loaded rows and widgets by board key and user id.

public static getBoardWithRowsAndWidgetsByBoardKeyUserId(string $boardKey, int $userId) : static
Parameters
$boardKey : string

Board key.

$userId : int

User id.

Return values
static

getClassName()

public static getClassName() : string
Return values
string

getCopyForCurrentUser()

Get Copy of Board and nested entities for createing board.

public getCopyForCurrentUser() : Dashboard

All priamry keys are nulled.

Return values
Dashboard

getCurrentDbState()

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

getCurrentUserBoardWithEverythingByBoardKey()

Return dasboard with all nested relations for current user by board key.

public static getCurrentUserBoardWithEverythingByBoardKey(string $boardKey) : static
Parameters
$boardKey : string

Board key.

Return values
static

getDefaultBoardByBoardKey()

Return dashboard by board key.

public static getDefaultBoardByBoardKey(string $boardKey) : static
Parameters
$boardKey : string

Board key.

Return values
static

getDefaultBoardWithEverythingByBoardKey()

Return default dashboard with relation entities.

public static getDefaultBoardWithEverythingByBoardKey(string $boardKey[, bool $createIfNotExist = true ]) : static

if not exist dashboard with this key, by default create new dashboard with this key, and return it.

Parameters
$boardKey : string

Board key.

$createIfNotExist : bool = true

Marker define create or not default board, when call this method.

Return values
static

getErrors()

Get Errors collections.

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

getGId()

public getGId() : string
Return values
string

getId()

public getId() : mixed

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

Map to set relations of this entity with other entities.

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

getTableClassName()

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

public static getTableClassName() : string
Return values
string

getUserId()

public getUserId() : int
Return values
int

getVersion()

Get version.

public getVersion() : string
Return values
string

load()

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

Filter parameters.

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

Relation keys to load.

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

Order parameters.

Return values
static

loadAttribute()

public loadAttribute(string $attributeName) : void
Parameters
$attributeName : string

Attribute name to load to property from db.

loadByBoardKeyAndUserId()

Load Dashboard by board key and user id.

public static loadByBoardKeyAndUserId(string $boardKey, int $userId) : Dashboard
Parameters
$boardKey : string

Board key.

$userId : int

User id.

Return values
Dashboard

loadByBoardKeyMultiple()

Load multiple boards by board key.

public static loadByBoardKeyMultiple(string $boardKey) : array<string|int, Dashboard>
Parameters
$boardKey : string

Board key.

Return values
array<string|int, Dashboard>

loadById()

public static loadById(mixed $id) : static
Parameters
$id : mixed

Load entity by id.

Return values
static

setBoardKey()

Setter vor board key.

public setBoardKey(string $boardKey) : void
Parameters
$boardKey : string

Board key.

setCreatedAt()

public setCreatedAt(DateTime $createdAt) : void
Parameters
$createdAt : DateTime

Record create time.

setGId()

Gid setter.

public setGId(string $gId) : void
Parameters
$gId : string

Gid for current board.

setId()

public setId(mixed $id) : void
Parameters
$id : mixed

Id property value.

setUpdatedAt()

public setUpdatedAt(DateTime $updatedAt) : void
Parameters
$updatedAt : DateTime

Record update time.

setUserId()

User id setter.

public setUserId(int $userId) : void
Parameters
$userId : int

User id.

setVersion()

Setterr for version.

public setVersion(string $version) : void
Parameters
$version : string

Version value.


        

        
    




    

    

                                

                

                                
    

        On this page

        
    


                

                            

            

    

        

            
Search results