PHP Class Piwik\Plugins\API\WidgetMetadata

Show file Open project: piwik/piwik Class Usage Examples

Public Methods

Method	Description
buildPageMetadata ( Category $category, Subcategory $subcategory, $widgetConfigs )
buildWidgetMetadata ( WidgetConfig $widget, CategoryList \| null $categoryList = null ) : array
getPagesMetadata ( CategoryList $categoryList, WidgetsList $widgetsList )
getWidgetMetadata ( CategoryList $categoryList, WidgetsList $widgetsList )

Private Methods

Method	Description
buildCategoryMetadata ( Category \| null $category ) : array
buildPageId ( $categoryId, $subcategoryId )
buildPagesMetadata ( CategoryList $categoryList, WidgetsList $widgetsList ) : array
buildSubcategoryMetadata ( Subcategory \| null $subcategory ) : array
createCategory ( $categoryId )
createMissingCategoriesAndSubcategories ( CategoryList $categoryList, WidgetConfig[] $widgetConfigs )
createSubcategory ( $categoryId, $subcategoryId )
sortWidgets ( $widgetA, $widgetB )

Method Details

buildPageMetadata() public method

public buildPageMetadata ( Category $category, Subcategory $subcategory, $widgetConfigs )
$category	Piwik\Category\Category
$subcategory	Piwik\Category\Subcategory

buildWidgetMetadata() public method

public buildWidgetMetadata ( WidgetConfig $widget, CategoryList \| null $categoryList = null ) : array
$widget	Piwik\Widget\WidgetConfig
$categoryList	Piwik\Category\CategoryList \| null	If null, no category information will be added to the widgets in first level (they will be added to nested widgets as potentially needed eg for widgets in ByDimensionView where they are needed to build the left menu)
return	array

getPagesMetadata() public method

public getPagesMetadata ( CategoryList $categoryList, WidgetsList $widgetsList )
$categoryList	Piwik\Category\CategoryList
$widgetsList	Piwik\Widget\WidgetsList

getWidgetMetadata() public method

public getWidgetMetadata ( CategoryList $categoryList, WidgetsList $widgetsList )
$categoryList	Piwik\Category\CategoryList
$widgetsList	Piwik\Widget\WidgetsList