Method |
Description |
|
addToContainerWidget ( string $containerId, WidgetConfig $widget ) |
Add a widget to a widget container. It doesn't matter whether the container was added to this list already
or whether the container is added later. As long as a container having the same containerId is added at
some point the widget will be added to that container. If no container having this id is added the widget
will not be recognized. |
|
addWidgetConfig ( WidgetConfig $widget ) |
Adds a new widget to the widget config. Please make sure the widget is enabled before adding a widget as
no such checks will be performed. |
|
addWidgetConfigs ( WidgetConfig[] $widgets ) |
Add multiple widget configs at once. See {@link addWidgetConfig()}. |
|
get ( ) : static |
Get all widgets defined in the Piwik platform. |
|
getWidgetConfigs ( ) : WidgetConfig[] |
Get all added widget configs. |
|
getWidgetUniqueId ( $controllerName, $controllerAction, array $customParameters = [] ) : string |
CAUTION! If you ever change this method, existing updates will fail as they currently use that method!
If you change the output the uniqueId for existing widgets would not be found anymore |
|
isDefined ( string $module, string $action ) : boolean |
Returns true if a widget exists in the widget list, false if otherwise. |
|
remove ( string $widgetCategoryId, string | false $widgetName = false ) |
Removes one or more widgets from the widget list. |
|