f7693089a8
In preparation for refactoring SkinTemplate so that SkinMustache extends Skin rather than SkinTemplate, we take the opportunity to reorganize the skin code around the concept of components. Going forward a skin will consist of multiple components, each of which must return template data that can be passed to an associated template. This will result in code that is easier to work with, compared with the existing 3000 line skin class. This is the beginning of that journey. Other components will follow while maintaining backwards compatibility Bug: T263213 Change-Id: Ib62724c24601e04aa13ab09b3242e70d7d6436ca
85 lines
2.3 KiB
PHP
85 lines
2.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.
|
|
* http://www.gnu.org/copyleft/gpl.html
|
|
*/
|
|
|
|
namespace MediaWiki\Skin;
|
|
|
|
use Config;
|
|
use ResourceLoaderSkinModule;
|
|
use Title;
|
|
|
|
/**
|
|
* @internal for use inside Skin and SkinTemplate classes only
|
|
* @unstable
|
|
*/
|
|
class SkinComponentLogo implements SkinComponent {
|
|
/** @var Config */
|
|
private $config;
|
|
/** @var Title */
|
|
private $title;
|
|
|
|
/**
|
|
* @param Config $config
|
|
* @param Title|null $title
|
|
*/
|
|
public function __construct( Config $config, ?Title $title ) {
|
|
$this->config = $config;
|
|
$this->title = $title;
|
|
}
|
|
|
|
/**
|
|
* @return Title|null
|
|
*/
|
|
private function getTitle(): ?Title {
|
|
return $this->title;
|
|
}
|
|
|
|
/**
|
|
* @return Config
|
|
*/
|
|
private function getConfig(): Config {
|
|
return $this->config;
|
|
}
|
|
|
|
/**
|
|
* @inheritDoc
|
|
* Since 1.35 (all fields optional):
|
|
* - string 1x Path to a square icon at 1x resolution
|
|
* - string 2x Path to a square icon at 2x resolution
|
|
* - string icon Path to a square icon
|
|
* - array wordmark with `src`, `width`, `height` and `style` keys.
|
|
* - array tagline with `src`, `width`, `height` and `style` keys.
|
|
*/
|
|
public function getTemplateData(): array {
|
|
$logoData = ResourceLoaderSkinModule::getAvailableLogos( $this->getConfig() );
|
|
// check if the logo supports variants
|
|
$variantsLogos = $logoData['variants'] ?? null;
|
|
$title = $this->getTitle();
|
|
if ( $variantsLogos && $title ) {
|
|
$preferred = $title
|
|
->getPageViewLanguage()->getCode();
|
|
$variantOverrides = $variantsLogos[$preferred] ?? null;
|
|
// Overrides the logo
|
|
if ( $variantOverrides ) {
|
|
foreach ( $variantOverrides as $key => $val ) {
|
|
$logoData[$key] = $val;
|
|
}
|
|
}
|
|
}
|
|
return $logoData;
|
|
}
|
|
}
|