PHP 클래스 Piwik\Widget\WidgetContainerConfig

To define a widget container just place a subclass within the Widgets folder of your plugin.

상속: extends WidgetConfig

보호된 프로퍼티들

프로퍼티	타입	설명
$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[]