Граф наследования:Widget:

Открытые члены
	__construct ()

	delete ()

	deletePatternWidget ()

	addReportHandler (BaseReport $reportHandler)

	getWidgetHandler ($isRuntime=false)

	setWidgetHandler (BaseWidget $widgetHandler)

	getReports ()

	getReportsGidKeyed ()

	getReportByGId ($reportGId)

	getBoardId ()

	setBoardId ($boardId)

	getViewKey ()

	setViewKey ($viewKey)

	getFilterId ()

	getCopyForCurrentUser ()

	getWeight ()

	setWeight ($weight)

	getWidgetClass ()

	setWidgetClass ($widgetClass)

	getRow ()

	setRow (DashboardRow $row)

	isPattern ()

	setIsPattern ($isPattern)

	getParentWidget ()

	setParentWidget ($parentWidget)

	getChildWidgets ()

	getParentWidgetId ()

	setParentWidgetId ($parentWidgetId)

	getGId ()

	setGId ($gId)

	getCategoryKey ()

	setCategoryKey ($categoryKey)

	getRowId ()

	setRowId ($rowId)

	getOwnerId ()

	setOwnerId ($ownerId)

Открытые члены унаследованные от ConfigurableModel
	getConfigurations ()

	setConfigurations ($configurations)

	addConfigurationField (BaseValuable $field)

Открытые члены унаследованные от Model
	save ()

	getId ()

	setId ($id)

	getCreatedAt ()

	setCreatedAt (DateTime $createdAt)

	getUpdatedAt ()

	setUpdatedAt (DateTime $updatedAt)

	loadAttribute ($attributeName)

	getErrors ()

	getCurrentDbState ()

Открытые статические члены
static	getTableClassName ()

static	getMapAttributes ()

static	getMapReferenceAttributes ()

static	getWidgetsByBoard ($boardId)

static	getCurrentUserPatternedWidgets ()

static	getWidgetConfigurations ($widgetId)

static	getWidgetById ($widgetId)

static	getCurrentUserWidgetByGId ($widgetGId)

static	buildPseudoWidget ($params)

static	getWidgetByGId ($widgetGId)

static	getWidgetByIdWithReports ($widgetId)

static	removeCurrentUserWidgetByGId ($widgetGId)

Открытые статические члены унаследованные от Model
static	getClassName ()

static	load ($filter, array $with=array(), $order=array())

static	loadById ($id)

static	factoryWithHorizontalCells ($cellCount=1)

Защищенные данные
	$gId

	$weight

	$boardId

	$rowId

	$widgetClass

	$widgetHandler

	$viewKey

	$ownerId = 0

	$categoryKey = ''

	$isPattern = false

	$parentWidgetId = 0

	$reports = array()

	$row

	$parentWidget

	$childWidgets = array()

Защищенные данные унаследованные от ConfigurableModel
	$configurations = array()

Защищенные данные унаследованные от Model
	$id

	$createdAt

	$updatedAt

	$errors

Дополнительные унаследованные члены
Открытые атрибуты унаследованные от Model
const	ATTRIBUTE_SLICE_DELIMITER = '__'

Защищенные статические члены унаследованные от Model
static	getModelList (array $parameters)

static	prepareGetListParameters (array $parameters)

Подробное описание

См. определение в файле widget.php строка 21

Конструктор(ы)

◆ __construct()

__construct ( )

Widget constructor.

Переопределяет метод предка Model.

См. определение в файле widget.php строка 53

Методы

◆ addReportHandler()

addReportHandler ( BaseReport $reportHandler )

Attach report handler to widget handler.

Аргументы

BaseReport $reportHandler Report handler.

Возвращает: void

См. определение в файле widget.php строка 175

◆ buildPseudoWidget()

static buildPseudoWidget ( $params )

static

If parameter start with pseudo_ then create new widget. Else try to load widget by gid, and change view key.

Аргументы

array $params Parameters to build pseudo widget. [viewKey => 'number', widgetGId => 'pseudo_widget_gid'].

Возвращает: Widget

См. определение в файле widget.php строка 491

◆ delete()

delete ( )

Delete widget if it is not pattern.

Возвращает: bool|null

Переопределяет метод предка Model.

См. определение в файле widget.php строка 145

◆ deletePatternWidget()

deletePatternWidget ( )

Delete pattern widget.

Возвращает: bool|null

См. определение в файле widget.php строка 164

◆ getBoardId()

getBoardId ( )

Возвращает: string

См. определение в файле widget.php строка 272

◆ getCategoryKey()

getCategoryKey ( )

Возвращает: string

См. определение в файле widget.php строка 710

◆ getChildWidgets()

getChildWidgets ( )

Возвращает: Widget[]

См. определение в файле widget.php строка 664

◆ getCopyForCurrentUser()

getCopyForCurrentUser ( )

Perform copy of widget with copies of nested relations.

Возвращает: Widget

См. определение в файле widget.php строка 322

◆ getCurrentUserPatternedWidgets()

static getCurrentUserPatternedWidgets ( )

static

Возвращает: Widget[]

См. определение в файле widget.php строка 393

◆ getCurrentUserWidgetByGId()

static getCurrentUserWidgetByGId ( $widgetGId )

static

Get current user widget by widget id with nested relations,

Аргументы

string $widgetGId Widget gId.

Возвращает: Widget

См. определение в файле widget.php строка 452

◆ getFilterId()

getFilterId ( )

construct and return filter name base on widget id.

Возвращает: string

См. определение в файле widget.php строка 312

◆ getGId()

getGId ( )

Возвращает: mixed

См. определение в файле widget.php строка 691

◆ getMapAttributes()

static getMapAttributes ( )

static

Returns the list of pair for mapping data and object properties. Key is field in DataManager, value is object property.

Возвращает: array

Переопределяет метод предка Model.

См. определение в файле widget.php строка 73

◆ getMapReferenceAttributes()

static getMapReferenceAttributes ( )

static

Возвращает: array

Переопределяет метод предка Model.

См. определение в файле widget.php строка 92

◆ getOwnerId()

getOwnerId ( )

Возвращает: int

См. определение в файле widget.php строка 749

◆ getParentWidget()

getParentWidget ( )

Возвращает: Widget

См. определение в файле widget.php строка 645

◆ getParentWidgetId()

getParentWidgetId ( )

Возвращает: mixed

См. определение в файле widget.php строка 672

◆ getReportByGId()

getReportByGId ( $reportGId )

Аргументы

string $reportGId

Возвращает: Report|null

См. определение в файле widget.php строка 256

◆ getReports()

getReports ( )

Возвращает: Report[]

См. определение в файле widget.php строка 231

◆ getReportsGidKeyed()

getReportsGidKeyed ( )

Return report list, key in list get from gId.

Возвращает: Report[]

См. определение в файле widget.php строка 241

◆ getRow()

getRow ( )

Возвращает: DashboardRow

См. определение в файле widget.php строка 607

◆ getRowId()

getRowId ( )

Возвращает: mixed

См. определение в файле widget.php строка 730

◆ getTableClassName()

static getTableClassName ( )

static

Возвращает: string

Переопределяет метод предка Model.

См. определение в файле widget.php строка 62

◆ getViewKey()

getViewKey ( )

Возвращает: string

См. определение в файле widget.php строка 291

◆ getWeight()

getWeight ( )

Возвращает: int

См. определение в файле widget.php строка 568

◆ getWidgetByGId()

static getWidgetByGId ( $widgetGId )

static

Load widget with nested relations by widget gId.

Аргументы

string $widgetGId Widget gId.

Возвращает: Widget

См. определение в файле widget.php строка 516

◆ getWidgetById()

static getWidgetById ( $widgetId )

static

Load and return widget by widget id.

Аргументы

string $widgetId Widget id.

Возвращает: static

См. определение в файле widget.php строка 436

◆ getWidgetByIdWithReports()

static getWidgetByIdWithReports ( $widgetId )

static

Load widget with nested relations by widget Id.

Аргументы

string $widgetId Widget id.

Возвращает: Widget

См. определение в файле widget.php строка 532

◆ getWidgetClass()

getWidgetClass ( )

Возвращает: string

См. определение в файле widget.php строка 587

◆ getWidgetConfigurations()

static getWidgetConfigurations ( $widgetId )

static

Load widget and get configurations of loaded widget.

Аргументы

string $widgetId Widget.

Возвращает: Configuration[]

См. определение в файле widget.php строка 423

◆ getWidgetHandler()

getWidgetHandler ( $isRuntime = false )

Аргументы

bool $isRuntime

Возвращает: BaseWidget

См. определение в файле widget.php строка 192

◆ getWidgetsByBoard()

static getWidgetsByBoard ( $boardId )

static

Get Widget by board id. Load all nested relation.

Аргументы

string $boardId Board id.

Возвращает: static[]

См. определение в файле widget.php строка 379

◆ isPattern()

isPattern ( )

Возвращает: bool

См. определение в файле widget.php строка 626

◆ removeCurrentUserWidgetByGId()

static removeCurrentUserWidgetByGId ( $widgetGId )

static

Remove current user widget by gId.

Аргументы

string $widgetGId Widget gId.

Возвращает: boolean

См. определение в файле widget.php строка 547

◆ setBoardId()

setBoardId ( $boardId )

Setter for board id.

Аргументы

string $boardId Board id.

Возвращает: void

См. определение в файле widget.php строка 283

◆ setCategoryKey()

setCategoryKey ( $categoryKey )

Attach widget to category.

См. также: Category.

Аргументы

string $categoryKey Category key.

Возвращает: void

См. определение в файле widget.php строка 722

◆ setGId()

setGId ( $gId )

Setter for gId.

Аргументы

mixed $gId Value of gId.

Возвращает: void

См. определение в файле widget.php строка 702

◆ setIsPattern()

setIsPattern ( $isPattern )

Setter for pattern marker.

Аргументы

bool $isPattern Marker to set is pattern or not.

Возвращает: void

См. определение в файле widget.php строка 637

◆ setOwnerId()

setOwnerId ( $ownerId )

Attach widget to some user.

Аргументы

int $ownerId User id.

Возвращает: void

См. определение в файле widget.php строка 760

◆ setParentWidget()

setParentWidget ( $parentWidget )

parent Widget entity.

Аргументы

Widget $parentWidget Widget entity.

Возвращает: void

См. определение в файле widget.php строка 656

◆ setParentWidgetId()

setParentWidgetId ( $parentWidgetId )

Setter for parent widget id.

Аргументы

mixed $parentWidgetId Parent widget id.

Возвращает: void

См. определение в файле widget.php строка 683

◆ setRow()

setRow ( DashboardRow $row )

Setter for row.

Аргументы

DashboardRow $row Row Entity where place widget.

Возвращает: void

См. определение в файле widget.php строка 618

◆ setRowId()

setRowId ( $rowId )

Setter for row id.

Аргументы

mixed $rowId Value of row id.

Возвращает: void

См. определение в файле widget.php строка 741

◆ setViewKey()

setViewKey ( $viewKey )

Setter for view key.

Аргументы

string $viewKey View key.

Возвращает: void

См. определение в файле widget.php строка 302

◆ setWeight()

setWeight ( $weight )

Setter for widget position.

Аргументы

string $weight Position of widget in row.

Возвращает: void

См. определение в файле widget.php строка 579

◆ setWidgetClass()

setWidgetClass ( $widgetClass )

Widget handler class name.

См. также: BaseWidget::getClassName().

Аргументы

string $widgetClass Widget handler class name.

Возвращает: void

См. определение в файле widget.php строка 599

◆ setWidgetHandler()

setWidgetHandler ( BaseWidget $widgetHandler )

Setter for widget handler. Set class name and set widget handler.

Аргументы

BaseWidget $widgetHandler Widget handler.

Возвращает: void

См. определение в файле widget.php строка 222

Данные класса

◆ $boardId

$boardId

protected

См. определение в файле widget.php строка 25

◆ $categoryKey

$categoryKey = ''

protected

См. определение в файле widget.php строка 34

◆ $childWidgets

Widget[] $childWidgets = array()

protected

См. определение в файле widget.php строка 48

◆ $gId

$gId

protected

См. определение в файле widget.php строка 23

◆ $isPattern

$isPattern = false

protected

См. определение в файле widget.php строка 35

◆ $ownerId

$ownerId = 0

protected

См. определение в файле widget.php строка 33

◆ $parentWidget

Widget $parentWidget

protected

См. определение в файле widget.php строка 45

◆ $parentWidgetId

$parentWidgetId = 0

protected

См. определение в файле widget.php строка 36

◆ $reports

Report[] $reports = array()

protected

См. определение в файле widget.php строка 39

◆ $row

DashboardRow $row

protected

См. определение в файле widget.php строка 42

◆ $rowId

$rowId

protected

См. определение в файле widget.php строка 26

◆ $viewKey

$viewKey

protected

См. определение в файле widget.php строка 32

◆ $weight

$weight

protected

См. определение в файле widget.php строка 24

◆ $widgetClass

$widgetClass

protected

См. определение в файле widget.php строка 27

◆ $widgetHandler

BaseWidget $widgetHandler

protected

См. определение в файле widget.php строка 31

Bitrix-D7 23.9

Открытые члены

Открытые статические члены

Защищенные данные

Дополнительные унаследованные члены

Подробное описание

Конструктор(ы)

◆ __construct()

Методы

◆ addReportHandler()

◆ buildPseudoWidget()

◆ delete()

◆ deletePatternWidget()

◆ getBoardId()

◆ getCategoryKey()

◆ getChildWidgets()

◆ getCopyForCurrentUser()

◆ getCurrentUserPatternedWidgets()

◆ getCurrentUserWidgetByGId()

◆ getFilterId()

◆ getGId()

◆ getMapAttributes()

◆ getMapReferenceAttributes()

◆ getOwnerId()

◆ getParentWidget()

◆ getParentWidgetId()

◆ getReportByGId()

◆ getReports()

◆ getReportsGidKeyed()

◆ getRow()

◆ getRowId()

◆ getTableClassName()

◆ getViewKey()

◆ getWeight()

◆ getWidgetByGId()

◆ getWidgetById()

◆ getWidgetByIdWithReports()

◆ getWidgetClass()

◆ getWidgetConfigurations()

◆ getWidgetHandler()

◆ getWidgetsByBoard()

◆ isPattern()

◆ removeCurrentUserWidgetByGId()

◆ setBoardId()

◆ setCategoryKey()

◆ setGId()

◆ setIsPattern()

◆ setOwnerId()

◆ setParentWidget()

◆ setParentWidgetId()

◆ setRow()

◆ setRowId()

◆ setViewKey()

◆ setWeight()

◆ setWidgetClass()

◆ setWidgetHandler()

Данные класса

◆ $boardId

◆ $categoryKey

◆ $childWidgets

◆ $gId

◆ $isPattern

◆ $ownerId

◆ $parentWidget

◆ $parentWidgetId

◆ $reports

◆ $row

◆ $rowId

◆ $viewKey

◆ $weight

◆ $widgetClass

◆ $widgetHandler