PHP Class Piwik\Category\Category

This class is for now not exposed as public API until needed. Categories of plugins will be automatically displayed in the menu at the very right after all core categories.
Afficher le fichier Open project: piwik/piwik Class Usage Examples

Protected Properties

Свойство Type Description
$icon integer The icon for this category, eg 'icon-user'
$id The id of the category as specified eg in {@link Piwik\Widget\WidgetConfig::setCategoryId()`} or {@link Piwik\Report\getCategoryId()}. The id is used as the name in the menu and will be visible in the URL.
$order integer The order of the category. The lower the value the further left the category will appear in the menu.
$subcategories Subcategory[]

Méthodes publiques

Méthode Description
addSubcategory ( Subcategory $subcategory )
getIcon ( )
getId ( )
getOrder ( )
getSubcategories ( ) : Subcategory[]
getSubcategory ( $subcategoryId )
hasSubCategories ( )
hasSubcategory ( $subcategoryId )
setIcon ( $icon )
setId ( $id )
setOrder ( integer $order ) : static

Method Details

addSubcategory() public méthode

public addSubcategory ( Subcategory $subcategory )
$subcategory Subcategory

getIcon() public méthode

public getIcon ( )

getId() public méthode

public getId ( )

getOrder() public méthode

public getOrder ( )

getSubcategories() public méthode

public getSubcategories ( ) : Subcategory[]
Résultat Subcategory[]

getSubcategory() public méthode

public getSubcategory ( $subcategoryId )

hasSubCategories() public méthode

public hasSubCategories ( )

hasSubcategory() public méthode

public hasSubcategory ( $subcategoryId )

setIcon() public méthode

public setIcon ( $icon )

setId() public méthode

public setId ( $id )

setOrder() public méthode

public setOrder ( integer $order ) : static
$order integer
Résultat static

Property Details

$icon protected_oe property

The icon for this category, eg 'icon-user'
protected int $icon
Résultat integer

$id protected_oe property

The id of the category as specified eg in {@link Piwik\Widget\WidgetConfig::setCategoryId()`} or {@link Piwik\Report\getCategoryId()}. The id is used as the name in the menu and will be visible in the URL.
protected $id

$order protected_oe property

The order of the category. The lower the value the further left the category will appear in the menu.
protected int $order
Résultat integer

$subcategories protected_oe property

protected Subcategory[],Piwik\Category $subcategories
Résultat Subcategory[]