mediawiki-skins-MinervaNeue/includes/menu/Entries/IProfileMenuEntry.php
Stephen Niedzielski ff57ba7cd9 [dev] make interface for overriding menu profile URL
Make an interface for changing the URL of the menu profile item. This
functionality is needed by Growth and a subsequent patch will provide a
second profile implementation that should implement this interface.

Bug: T214540
Change-Id: Ie3647ac52a83b4cc34f3582a41c5d5524343965c
2019-07-23 12:23:45 -06:00

38 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;
interface IProfileMenuEntry extends IMenuEntry {
/**
* Default tracking code for clicks on profile menu link
*/
const DEFAULT_PROFILE_TRACKING_CODE = 'profile';
/**
* Override the href for the profile component for logged in users
* @param string $customURL A new href for profile entry
* @param string|null $customLabel A new label for profile entry. Null if you don't want to
* override it
* @param string|null $trackingCode new tracking code
* @return IProfileMenuEntry
*/
public function overrideProfileURL(
$customURL, $customLabel = null, $trackingCode = null
);
}