PHP Class Piwik\Menu\MenuAdmin

Plugins can implement the configureAdminMenu() method of the Menu plugin class to add, rename of remove items. If your plugin does not have a Menu class yet you can create one using ./console generate:menu.
Inheritance: extends MenuAbstract
Show file Open project: piwik/piwik Class Usage Examples

Public Methods

Method Description
addDevelopmentItem ( string $menuName, array $url, integer $order = 50, boolean | string $tooltip = false ) See {@link add()}. Adds a new menu item to the development section of the admin menu.
addDiagnosticItem ( string $menuName, array $url, integer $order = 50, boolean | string $tooltip = false ) See {@link add()}. Adds a new menu item to the diagnostic section of the admin menu.
addMeasurableItem ( string $menuName, array $url, integer $order = 50, boolean | string $tooltip = false ) See {@link add()}. Adds a new menu item to the measurable section of the admin menu.
addPersonalItem ( string $menuName, array $url, integer $order = 50, boolean | string $tooltip = false ) See {@link add()}. Adds a new menu item to the manage section of the user menu.
addPlatformItem ( string $menuName, array $url, integer $order = 50, boolean | string $tooltip = false ) See {@link add()}. Adds a new menu item to the platform section of the admin menu.
addSystemItem ( string $menuName, array $url, integer $order = 50, boolean | string $tooltip = false ) See {@link add()}. Adds a new menu item to the manage section of the admin menu.
getMenu ( ) : Array Triggers the Menu.MenuAdmin.addItems hook and returns the admin menu.

Method Details

addDevelopmentItem() public method

See {@link add()}. Adds a new menu item to the development section of the admin menu.
Since: 2.5.0
public addDevelopmentItem ( string $menuName, array $url, integer $order = 50, boolean | string $tooltip = false )
$menuName string
$url array
$order integer
$tooltip boolean | string

addDiagnosticItem() public method

See {@link add()}. Adds a new menu item to the diagnostic section of the admin menu.
Since: 2.5.0
public addDiagnosticItem ( string $menuName, array $url, integer $order = 50, boolean | string $tooltip = false )
$menuName string
$url array
$order integer
$tooltip boolean | string

addMeasurableItem() public method

See {@link add()}. Adds a new menu item to the measurable section of the admin menu.
Since: 3.0.0
public addMeasurableItem ( string $menuName, array $url, integer $order = 50, boolean | string $tooltip = false )
$menuName string
$url array
$order integer
$tooltip boolean | string

addPersonalItem() public method

See {@link add()}. Adds a new menu item to the manage section of the user menu.
Since: 2.5.0
public addPersonalItem ( string $menuName, array $url, integer $order = 50, boolean | string $tooltip = false )
$menuName string
$url array
$order integer
$tooltip boolean | string

addPlatformItem() public method

See {@link add()}. Adds a new menu item to the platform section of the admin menu.
Since: 2.5.0
public addPlatformItem ( string $menuName, array $url, integer $order = 50, boolean | string $tooltip = false )
$menuName string
$url array
$order integer
$tooltip boolean | string

addSystemItem() public method

See {@link add()}. Adds a new menu item to the manage section of the admin menu.
Since: 3.0.0
public addSystemItem ( string $menuName, array $url, integer $order = 50, boolean | string $tooltip = false )
$menuName string
$url array
$order integer
$tooltip boolean | string

getMenu() public method

Triggers the Menu.MenuAdmin.addItems hook and returns the admin menu.
public getMenu ( ) : Array
return Array