MenuAdmin.php
129 lines
| 1 | <?php |
| 2 | |
| 3 | /** |
| 4 | * Matomo - free/libre analytics platform |
| 5 | * |
| 6 | * @link https://matomo.org |
| 7 | * @license https://www.gnu.org/licenses/gpl-3.0.html GPL v3 or later |
| 8 | */ |
| 9 | namespace Piwik\Menu; |
| 10 | |
| 11 | use Piwik\Development; |
| 12 | /** |
| 13 | * Contains menu entries for the Admin menu. |
| 14 | * Plugins can implement the `configureAdminMenu()` method of the `Menu` plugin class to add, rename of remove |
| 15 | * items. If your plugin does not have a `Menu` class yet you can create one using `./console generate:menu`. |
| 16 | * |
| 17 | * @method static \Piwik\Menu\MenuAdmin getInstance() |
| 18 | */ |
| 19 | class MenuAdmin extends \Piwik\Menu\MenuAbstract |
| 20 | { |
| 21 | /** |
| 22 | * See {@link add()}. Adds a new menu item to the manage section of the user menu. |
| 23 | * @param string $menuName |
| 24 | * @param array $url |
| 25 | * @param int $order |
| 26 | * @param bool|string $tooltip |
| 27 | * @api |
| 28 | * @since 2.5.0 |
| 29 | */ |
| 30 | public function addPersonalItem($menuName, $url, $order = 50, $tooltip = \false) |
| 31 | { |
| 32 | $this->addItem('UsersManager_MenuPersonal', $menuName, $url, $order, $tooltip); |
| 33 | } |
| 34 | /** |
| 35 | * See {@link add()}. Adds a new menu item to the development section of the admin menu. |
| 36 | * @param string $menuName |
| 37 | * @param array $url |
| 38 | * @param int $order |
| 39 | * @param bool|string $tooltip |
| 40 | * @api |
| 41 | * @since 2.5.0 |
| 42 | */ |
| 43 | public function addDevelopmentItem($menuName, $url, $order = 50, $tooltip = \false) |
| 44 | { |
| 45 | if (Development::isEnabled()) { |
| 46 | $this->addItem('CoreAdminHome_MenuDevelopment', $menuName, $url, $order, $tooltip); |
| 47 | } |
| 48 | } |
| 49 | /** |
| 50 | * See {@link add()}. Adds a new menu item to the diagnostic section of the admin menu. |
| 51 | * @param string $menuName |
| 52 | * @param array $url |
| 53 | * @param int $order |
| 54 | * @param bool|string $tooltip |
| 55 | * @api |
| 56 | * @since 2.5.0 |
| 57 | */ |
| 58 | public function addDiagnosticItem($menuName, $url, $order = 50, $tooltip = \false) |
| 59 | { |
| 60 | $this->addItem('CoreAdminHome_MenuDiagnostic', $menuName, $url, $order, $tooltip); |
| 61 | } |
| 62 | /** |
| 63 | * See {@link add()}. Adds a new menu item to the platform section of the admin menu. |
| 64 | * @param string $menuName |
| 65 | * @param array $url |
| 66 | * @param int $order |
| 67 | * @param bool|string $tooltip |
| 68 | * @api |
| 69 | * @since 2.5.0 |
| 70 | */ |
| 71 | public function addPlatformItem($menuName, $url, $order = 50, $tooltip = \false) |
| 72 | { |
| 73 | $this->addItem('CorePluginsAdmin_MenuPlatform', $menuName, $url, $order, $tooltip); |
| 74 | } |
| 75 | /** |
| 76 | * See {@link add()}. Adds a new menu item to the plugins section of the admin menu. |
| 77 | * @param string $menuName |
| 78 | * @param array $url |
| 79 | * @param int $order |
| 80 | * @param bool|string $tooltip |
| 81 | * @api |
| 82 | * @since 5.0.0 |
| 83 | */ |
| 84 | public function addPluginItem(string $menuName, array $url, int $order = 50, $tooltip = \false) |
| 85 | { |
| 86 | $this->addItem('General_Plugins', $menuName, $url, $order, $tooltip); |
| 87 | } |
| 88 | /** |
| 89 | * See {@link add()}. Adds a new menu item to the measurable section of the admin menu. |
| 90 | * @param string $menuName |
| 91 | * @param array $url |
| 92 | * @param int $order |
| 93 | * @param bool|string $tooltip |
| 94 | * @api |
| 95 | * @since 3.0.0 |
| 96 | */ |
| 97 | public function addMeasurableItem($menuName, $url, $order = 50, $tooltip = \false) |
| 98 | { |
| 99 | $this->addItem('CoreAdminHome_MenuMeasurables', $menuName, $url, $order, $tooltip); |
| 100 | } |
| 101 | /** |
| 102 | * See {@link add()}. Adds a new menu item to the manage section of the admin menu. |
| 103 | * @param string $menuName |
| 104 | * @param array $url |
| 105 | * @param int $order |
| 106 | * @param bool|string $tooltip |
| 107 | * @api |
| 108 | * @since 3.0.0 |
| 109 | */ |
| 110 | public function addSystemItem($menuName, $url, $order = 50, $tooltip = \false) |
| 111 | { |
| 112 | $this->addItem('CoreAdminHome_MenuSystem', $menuName, $url, $order, $tooltip); |
| 113 | } |
| 114 | /** |
| 115 | * Triggers the Menu.MenuAdmin.addItems hook and returns the admin menu. |
| 116 | * |
| 117 | * @return array |
| 118 | */ |
| 119 | public function getMenu() |
| 120 | { |
| 121 | if (!$this->menu) { |
| 122 | foreach ($this->getAllMenus() as $menu) { |
| 123 | $menu->configureAdminMenu($this); |
| 124 | } |
| 125 | } |
| 126 | return parent::getMenu(); |
| 127 | } |
| 128 | } |
| 129 |