Piwik\Menu\

MenuReporting

Contains menu entries for the Reporting menu (the menu displayed under the Piwik logo).

Plugins can implement the configureReportingMenu() 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.

Example

public function configureReportingMenu(MenuReporting $menu)
{
    $menu->add(
        'MyPlugin_MyTranslatedMenuCategory',
        'MyPlugin_MyTranslatedMenuName',
        array('module' => 'MyPlugin', 'action' => 'index'),
        Piwik::isUserHasSomeAdminAccess(),
        $order = 2
    );
}

Methods

The class defines the following methods:

addItem()

Since Piwik 2.7.0

Adds a new entry to the menu.

Signature

  • It accepts the following parameter(s):
    • $menuName (string) — The menu's category name. Can be a translation token.
    • $subMenuName (string) — The menu item's name. Can be a translation token.
    • $url (string|array) — The URL the admin menu entry should link to, or an array of query parameters that can be used to build the URL.
    • $order (int) — The order hint.
    • $tooltip (bool|string) — An optional tooltip to display or false to display the tooltip.
  • It does not return anything.

remove()

Removes an existing entry from the menu.

Signature

  • It accepts the following parameter(s):
    • $menuName (string) — The menu's category name. Can be a translation token.
    • $subMenuName (bool|string) — The menu item's name. Can be a translation token.
  • It does not return anything.

rename()

Renames a single menu entry.

Signature

  • It accepts the following parameter(s):

    • $mainMenuOriginal (Piwik\Menu\$mainMenuOriginal) —

    • $subMenuOriginal (Piwik\Menu\$subMenuOriginal) —

    • $mainMenuRenamed (Piwik\Menu\$mainMenuRenamed) —

    • $subMenuRenamed (Piwik\Menu\$subMenuRenamed) —

  • It does not return anything.

editUrl()

Edits a URL of an existing menu entry.

Signature

  • It accepts the following parameter(s):

    • $mainMenuToEdit (Piwik\Menu\$mainMenuToEdit) —

    • $subMenuToEdit (Piwik\Menu\$subMenuToEdit) —

    • $newUrl (Piwik\Menu\$newUrl) —

  • It does not return anything.

addVisitorsItem()

Since Piwik 2.5.0

See add().

Adds a new menu item to the visitors section of the reporting menu.

Signature

  • It accepts the following parameter(s):

    • $menuName (string) —

    • $url (array) —

    • $order (int) —

    • $tooltip (bool|string) —

  • It does not return anything.

addActionsItem()

Since Piwik 2.5.0

See add().

Adds a new menu item to the actions section of the reporting menu.

Signature

  • It accepts the following parameter(s):

    • $menuName (string) —

    • $url (array) —

    • $order (int) —

    • $tooltip (bool|string) —

  • It does not return anything.

addReferrersItem()

Since Piwik 2.5.0

See add().

Adds a new menu item to the referrers section of the reporting menu.

Signature

  • It accepts the following parameter(s):

    • $menuName (string) —

    • $url (array) —

    • $order (int) —

    • $tooltip (bool|string) —

  • It does not return anything.

isUrlFound()

Returns if the URL was found in the menu.

Signature

  • It accepts the following parameter(s):

    • $url (string) —
  • It returns a boolean value.

getMenu()

Triggers the Menu.Reporting.addItems hook and returns the menu.

Signature

  • It returns a Array value.