PHP Class Piwik\Widget\WidgetContainerConfig

To define a widget container just place a subclass within the Widgets folder of your plugin.
Inheritance: extends WidgetConfig
Afficher le fichier Open project: piwik/piwik Class Usage Examples

Protected Properties

Свойство Type Description
$action
$id
$isWidgetizable
$layout
$module
$widgets WidgetConfig[]

Méthodes publiques

Méthode Description
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.

Method Details

addWidgetConfig() public méthode

Adds a new widget to the container widget.
public addWidgetConfig ( WidgetConfig $widget ) : static
$widget WidgetConfig
Résultat static

getId() public méthode

Get the id of the widget.
public getId ( ) : string
Résultat string

getLayout() public méthode

Gets the currently set layout.
public getLayout ( ) : string
Résultat string

getParameters() public méthode

public getParameters ( )

getUniqueId() public méthode

public getUniqueId ( )

getWidgetConfigs() public méthode

Get all added widget configs.
public getWidgetConfigs ( ) : WidgetConfig[]
Résultat WidgetConfig[]

setId() public méthode

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'
Résultat static

setLayout() public méthode

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}
Résultat static

Property Details

$action protected_oe property

protected $action

$id protected_oe property

protected $id

$isWidgetizable protected_oe property

protected $isWidgetizable

$layout protected_oe property

protected $layout

$module protected_oe property

protected $module

$widgets protected_oe property

protected WidgetConfig[],Piwik\Widget $widgets
Résultat WidgetConfig[]