mediawiki-skins-MinervaNeue/includes/menu/Entries/IMenuEntry.php
Piotr Miazga 4c224d2657 Hygiene: Drop optional parameters from SingleMenuEntry constructor
The SingleMenuEntry constructor has too many optional parameters
which makes it confusing and dificult to use.
Instead system should provide a named constructor `create` that
creates new menu entry instance with Icon and click tracking enabled.
If developer wants to override event tracking/change icon it is
possible via calling `trackClicks` and `setIcon` method calls.

This is a first refactoring step to simplify the SingleMenuEntry,
the next follow-up will remove unnecessary PageActionsDirector.

Bug: T232734
Change-Id: I7a631a635a5c5932845639123c285d1d18df1b5d
2019-11-07 19:04:21 +01:00

49 lines
1.3 KiB
PHP

<?php
/**
* This program is free software; you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
* the Free Software Foundation; either version 2 of the License, or
* (at your option) any later version.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
*
* You should have received a copy of the GNU General Public License along
* with this program; if not, write to the Free Software Foundation, Inc.,
* 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
*/
namespace MediaWiki\Minerva\Menu\Entries;
/**
* Model for a menu entry.
*/
interface IMenuEntry {
/**
* Get the menu entry name/identifier
* @return string
*/
public function getName();
/**
* Get the CSS classes that should be applied to the element
* @return string[]
*/
public function getCSSClasses(): array;
/**
* Returns the list of components of the menu entry
*
* Each component is an array of HTML attributes with at least:
* - text -> text to show
* - href -> href attribute
* - class -> css class applied to it
* @return array
*/
public function getComponents(): array;
}