Bitrix API

Report extends ConfigurableModel

Class Report

Table of Contents

Constants

ATTRIBUTE_SLICE_DELIMITER  = '__'

Methods

__call()  : void
Implement delete and add actions for nested relations.
__construct()  : mixed
Model constructor.
addConfigurationField()  : void
Build configuration entity from valuable $field and add to configurations list
addConfigurations()  : void
delete()  : bool|null
deleteConfigurations()  : void
factoryWithHorizontalCells()  : mixed
getClassName()  : string
getConfigurations()  : array<string|int, Configuration>
getCopy()  : Report
Get copy of report entity with nested relations,
getCreatedAt()  : DateTime
getCurrentDbState()  : array<string|int, mixed>
getErrors()  : array<string|int, mixed>
Get Errors collections.
getGId()  : mixed
getId()  : mixed
getMapAttributes()  : array<string|int, mixed>
Returns the list of pair for mapping data and object properties.
getMapReferenceAttributes()  : array<string|int, mixed>
Returns map of lazy loaded attributes of current model.
getReportByGId()  : Report
Load widget with nested relations by widget gId.
getReportClassName()  : string
getReportHandler()  : BaseReport|null
Find report handler by report class name,in report provider.
getTableClassName()  : string
Gets the fully qualified name of table class which belongs to current model.
getUpdatedAt()  : DateTime
getWeight()  : mixed
getWidget()  : Widget
Get Widget, if not exist try to load it from db.
getWidgetId()  : mixed
load()  : static
loadAttribute()  : void
loadById()  : static
save()  : Model
setConfigurations()  : void
Setter for Configuration colection.
setCreatedAt()  : void
setGId()  : void
Setter for gId.
setId()  : void
setReportClassName()  : void
Setter for report class name.
setReportHandler()  : void
Setter for report handler.
setUpdatedAt()  : void
setWeight()  : void
Setter of Weight in report list of widget. (for sorting).
setWidget()  : void
Attach report to widget.
setWidgetId()  : void
Connection report to widget.

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

addConfigurationField()

Build configuration entity from valuable $field and add to configurations list

public addConfigurationField(BaseValuable $field) : void
Parameters
$field : BaseValuable

Field from create configuration.

delete()

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

factoryWithHorizontalCells()

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

getClassName()

public static getClassName() : string
Return values
string

getCopy()

Get copy of report entity with nested relations,

public getCopy() : Report
Return values
Report

getCurrentDbState()

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

getErrors()

Get Errors collections.

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

getGId()

public getGId() : mixed

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

Returns map of lazy loaded attributes of current model.

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

getReportByGId()

Load widget with nested relations by widget gId.

public static getReportByGId(string $reportGId) : Report
Parameters
$reportGId : string

Widget gId.

Return values
Report

getReportClassName()

public getReportClassName() : string
Return values
string

getReportHandler()

Find report handler by report class name,in report provider.

public getReportHandler([bool $isRuntime = false ]) : BaseReport|null

Return it if exist or return null.

Parameters
$isRuntime : bool = false
Return values
BaseReport|null

getTableClassName()

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

public static getTableClassName() : string
Return values
string

getWeight()

public getWeight() : mixed

getWidget()

Get Widget, if not exist try to load it from db.

public getWidget() : Widget
Return values
Widget

getWidgetId()

public getWidgetId() : mixed

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.

loadById()

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

Load entity by id.

Return values
static

setConfigurations()

Setter for Configuration colection.

public setConfigurations(array<string|int, Configuration> $configurations) : void
Parameters
$configurations : array<string|int, Configuration>

Configuration list.

setCreatedAt()

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

Record create time.

setGId()

Setter for gId.

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

Value og gId.

setId()

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

Id property value.

setReportClassName()

Setter for report class name.

public setReportClassName(string $reportClassName) : void
Parameters
$reportClassName : string

Report class name.

Tags
see
BaseReport::getClassName()

setReportHandler()

Setter for report handler.

public setReportHandler(BaseReport $handler) : void
Parameters
$handler : BaseReport

Report handler.

setUpdatedAt()

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

Record update time.

setWeight()

Setter of Weight in report list of widget. (for sorting).

public setWeight(mixed $weight) : void
Parameters
$weight : mixed

Weight of report.

setWidget()

Attach report to widget.

public setWidget(Widget $widget) : void
Parameters
$widget : Widget

Widget entity.

setWidgetId()

Connection report to widget.

public setWidgetId(mixed $widgetId) : void
Parameters
$widgetId : mixed

Widget id.


        

        
    




    

    

                                

                

                                
    

        On this page

        
    


                

                            

            

    

        

            
Search results