PHP Класс Piwik\Plugins\API\WidgetMetadata

Показать файл Открыть проект Примеры использования класса

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

Метод Описание
buildPageMetadata ( Category $category, Subcategory $subcategory, $widgetConfigs )
buildWidgetMetadata ( WidgetConfig $widget, CategoryList | null $categoryList = null ) : array
getPagesMetadata ( CategoryList $categoryList, WidgetsList $widgetsList )
getWidgetMetadata ( CategoryList $categoryList, WidgetsList $widgetsList )

Приватные методы

Метод Описание
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 )

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

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

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

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

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)
Результат array

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

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

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

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