includes/skins/components/SkinComponentLogo.php

   1 <?php
   2 /**
   3  * This program is free software; you can redistribute it and/or modify
   4  * it under the terms of the GNU General Public License as published by
   5  * the Free Software Foundation; either version 2 of the License, or
   6  * (at your option) any later version.
   7  *
   8  * This program is distributed in the hope that it will be useful,
   9  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  10  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
  11  * GNU General Public License for more details.
  12  *
  13  * You should have received a copy of the GNU General Public License along
  14  * with this program; if not, write to the Free Software Foundation, Inc.,
  15  * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
  16  * http://www.gnu.org/copyleft/gpl.html
  17  */
  18
  19 namespace MediaWiki\Skin;
  20
  21 use MediaWiki\Config\Config;
  22 use MediaWiki\Language\Language;
  23 use MediaWiki\ResourceLoader as RL;
  24
  25 /**
  26  * @internal for use inside Skin and SkinTemplate classes only
  27  * @unstable
  28  */
  29 class SkinComponentLogo implements SkinComponent {
  30         /** @var Config */
  31         private $config;
  32         /** @var string|null */
  33         private $language;
  34
  35         public function __construct( Config $config, Language $language ) {
  36                 $this->config = $config;
  37                 $this->language = $language->getCode();
  38         }
  39
  40         private function getLanguage(): ?string {
  41                 return $this->language;
  42         }
  43
  44         private function getConfig(): Config {
  45                 return $this->config;
  46         }
  47
  48         /**
  49          * @inheritDoc
  50          * Since 1.35 (all fields optional):
  51          * - string 1x Path to a square icon at 1x resolution
  52          * - string 2x Path to a square icon at 2x resolution
  53          * - string icon Path to a square icon
  54          * - array wordmark with `src`, `width`, `height` and `style` keys.
  55          * - array tagline with `src`, `width`, `height` and `style` keys.
  56          */
  57         public function getTemplateData(): array {
  58                 return RL\SkinModule::getAvailableLogos( $this->getConfig(), $this->getLanguage() );
  59         }
  60 }