mediawiki-skins-Citizen/includes/Partials/Header.php

214 lines
5.5 KiB
PHP
Raw Normal View History

<?php
/**
* Citizen - A responsive skin developed for the Star Citizen Wiki
*
* This file is part of Citizen.
*
* Citizen 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 3 of the License, or
* (at your option) any later version.
*
* Citizen 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 Citizen. If not, see <https://www.gnu.org/licenses/>.
*
* @file
* @ingroup Skins
*/
2021-01-28 11:21:58 +00:00
declare( strict_types=1 );
namespace Citizen\Partials;
use MediaWiki\MediaWikiServices;
use MWException;
use Skin;
2021-01-28 11:27:55 +00:00
use SpecialPage;
use User;
/**
* Header partial of Skin Citizen
* Generates the following partials:
* - Personal Menu
* - Extra Tools
* - Search
*/
2021-01-28 19:34:46 +00:00
final class Header extends Partial {
2021-01-28 11:21:58 +00:00
/**
* Build Personal Tools menu
*
* @return array
*/
public function buildPersonalMenu(): array {
$skin = $this->skin;
$personalTools = $skin->getPersonalToolsForMakeListItem(
$skin->buildPersonalUrlsPublic()
2021-01-28 11:21:58 +00:00
);
$header = $this->getPersonalHeaderData( $personalTools );
// We need userpage for personal header
if ( isset( $personalTools['userpage'] ) ) {
unset( $personalTools['userpage'] );
}
// Move the Echo badges out of default list
// TODO: Remove notifications since MW 1.36 from buildPersonalUrls
2021-01-28 11:21:58 +00:00
if ( isset( $personalTools['notifications-alert'] ) ) {
unset( $personalTools['notifications-alert'] );
}
if ( isset( $personalTools['notifications-notice'] ) ) {
unset( $personalTools['notifications-notice'] );
}
return [
'msg-citizen-personalmenu-toggle' => $skin->msg( 'citizen-personalmenu-toggle' )->text(),
'data-personal-menu-header' => $header,
'data-personal-menu-list' => $skin->getPortletData( 'personal', $personalTools ),
2021-01-28 11:21:58 +00:00
];
}
/**
* Echo notification badges button
2021-01-28 11:21:58 +00:00
*
* @return array
*/
public function getNotifications(): array {
$skin = $this->skin;
$personalTools = $skin->getPersonalToolsForMakeListItem(
$skin->buildPersonalUrlsPublic()
2021-01-28 11:21:58 +00:00
);
// Create the Echo badges
$notifications = [];
2021-01-28 11:21:58 +00:00
if ( isset( $personalTools['notifications-alert'] ) ) {
$notifications['notifications-alert'] = $personalTools['notifications-alert'];
2021-01-28 11:21:58 +00:00
}
if ( isset( $personalTools['notifications-notice'] ) ) {
$notifications['notifications-notice'] = $personalTools['notifications-notice'];
2021-01-28 11:21:58 +00:00
}
$html = $skin->getPortletData( 'notifications', $notifications );
2021-01-28 11:21:58 +00:00
return $html;
}
/**
* Render the search box
*
* @return array
* @throws MWException
*/
public function buildSearchProps(): array {
$skin = $this->skin;
$toggleMsg = $skin->msg( 'citizen-search-toggle' )->text();
2021-01-28 11:21:58 +00:00
return [
'msg-citizen-search-toggle' => $toggleMsg,
2021-04-12 19:09:28 +00:00
'msg-citizen-search-toggle-shortcut' => $toggleMsg . ' [/]',
2021-01-28 11:21:58 +00:00
'form-action' => $this->getConfigValue( 'Script' ),
'html-input' => $skin->makeSearchInput( [ 'id' => 'searchInput' ] ),
'msg-search' => $skin->msg( 'search' ),
2021-01-28 11:27:55 +00:00
'page-title' => SpecialPage::getTitleFor( 'Search' )->getPrefixedDBkey(),
2021-01-28 11:21:58 +00:00
'html-random-href' => Skin::makeSpecialUrl( 'Randompage' ),
'msg-random' => $skin->msg( 'Randompage' )->text(),
2021-01-28 11:21:58 +00:00
];
}
/**
* Decorate the personal menu
2021-01-28 11:21:58 +00:00
*
* @param array $personalTools The original personal tools urls
2021-01-28 11:21:58 +00:00
*
* @return array
2021-01-28 11:21:58 +00:00
*/
private function getPersonalHeaderData( $personalTools ): array {
$skin = $this->skin;
$user = $this->user;
$header = [
'userpage' => $personalTools['userpage'] ?? null,
'usergroups' => $this->getUserGroupsData( $personalTools, $user ),
'usercontris' => $this->getUserContributionsData( $user ),
];
return $skin->getPortletData( 'personal-header', array_filter( $header ) );
}
2021-01-28 11:21:58 +00:00
/**
* Build and return user groups data
*
* @param array $personalTools The original personal tools urls
* @param User $user
*
* @return array|null
*/
private function getUserGroupsData( $personalTools, $user ): ?array {
2021-01-28 11:21:58 +00:00
// This does not return implicit groups
$groups = MediaWikiServices::getInstance()->getUserGroupManager()->getUserGroups( $user );
if ( empty( $groups ) ) {
return null;
}
2021-01-28 11:21:58 +00:00
$skin = $this->skin;
$title = $this->title;
// Add user group
$groupLinks = [];
$msgName = 'group-%s';
foreach ( $groups as $group ) {
$groupPage = $title->newFromText(
$skin->msg( sprintf( $msgName, $group ) )->text(),
NS_PROJECT
);
$groupLinks[$group] = [
'msg' => sprintf( $msgName, $group ),
// Nullpointer should not happen
'href' => $groupPage->getLinkURL(),
'tooltiponly' => true,
'id' => sprintf( $msgName, $group ),
// 'exists' => $groupPage->exists() - This will add an additional DB call
2021-01-28 11:21:58 +00:00
];
}
return [
'id' => 'pt-usergroups',
'links' => $groupLinks
];
}
/**
* Build and return user contributions data
*
* @param User $user
*
* @return array|null
*/
private function getUserContributionsData( $user ): ?array {
// Return user edits
$edits = MediaWikiServices::getInstance()->getUserEditTracker()->getUserEditCount( $user );
2021-01-28 11:21:58 +00:00
if ( empty( $edits ) ) {
return null;
2021-01-28 11:21:58 +00:00
}
$skin = $this->skin;
return [
'text' => $skin->msg( 'usereditcount' )
->numParams( sprintf( '%s', number_format( $edits, 0 ) ) ),
'id' => 'pt-usercontris'
];
2021-01-28 11:21:58 +00:00
}
}