PHP Класс Piwik\Widget\WidgetContainerConfig

To define a widget container just place a subclass within the Widgets folder of your plugin.
Наследование: extends WidgetConfig
Показать файл Открыть проект Примеры использования класса

Защищенные свойства (Protected)

Свойство Тип Описание
$action
$id
$isWidgetizable
$layout
$module
$widgets WidgetConfig[]

Открытые методы

Метод Описание
addWidgetConfig ( WidgetConfig $widget ) : static Adds a new widget to the container widget.
getId ( ) : string Get the id of the widget.
getLayout ( ) : string Gets the currently set layout.
getParameters ( )
getUniqueId ( )
getWidgetConfigs ( ) : WidgetConfig[] Get all added widget configs.
setId ( string $id ) : static Sets (overwrites) the id of the widget container.
setLayout ( string $layout ) : static Sets the layout of the container widget.

Описание методов

addWidgetConfig() публичный Метод

Adds a new widget to the container widget.
public addWidgetConfig ( WidgetConfig $widget ) : static
$widget WidgetConfig
Результат static

getId() публичный Метод

Get the id of the widget.
public getId ( ) : string
Результат string

getLayout() публичный Метод

Gets the currently set layout.
public getLayout ( ) : string
Результат string

getParameters() публичный Метод

public getParameters ( )

getUniqueId() публичный Метод

public getUniqueId ( )

getWidgetConfigs() публичный Метод

Get all added widget configs.
public getWidgetConfigs ( ) : WidgetConfig[]
Результат WidgetConfig[]

setId() публичный Метод

The id can be used by any plugins to add more widgets to this container and it will be also used for the unique widget id and in the URL to render this widget.
public setId ( string $id ) : static
$id string eg 'Products' or 'Contents'
Результат static

setLayout() публичный Метод

By default widgets within a container are displayed one after another. In case you want to change this behaviour you can specify a layout that will be recognized by the UI. It is not yet possible to define custom layouts.
public setLayout ( string $layout ) : static
$layout string eg 'ByDimension' see {@link Piwik\Plugins\CoreHome\CoreHome::WIDGET_CONTAINER_LAYOUT_BY_DIMENSION}
Результат static

Описание свойств

$action защищенное свойство

protected $action

$id защищенное свойство

protected $id

$isWidgetizable защищенное свойство

protected $isWidgetizable

$layout защищенное свойство

protected $layout

$module защищенное свойство

protected $module

$widgets защищенное свойство

protected WidgetConfig[],Piwik\Widget $widgets
Результат WidgetConfig[]