tests/phpunit/mocks/FakeQqxMessageLocalizer.php

   1 <?php
   2
   3 declare( strict_types = 1 );
   4
   5 namespace MediaWiki\Tests\Unit;
   6
   7 use LanguageQqx;
   8 use MediaWiki\Language\Language;
   9 use MediaWiki\Message\Message;
  10 use MessageLocalizer;
  11 use Wikimedia\Message\MessageSpecifier;
  12
  13 /**
  14  * A MessageLocalizer that does not make database/service calls, for use in unit tests
  15  *
  16  * To be used in a phpunit unit test like so:
  17  *
  18  * ```php
  19  * $output = $this->createMock( OutputPage::class );
  20  * $output->method( 'msg' )
  21  *     ->willReturnCallback( [ new FakeQqxMessageLocalizer(), 'msg' ] );
  22  * ```
  23  *
  24  * @since 1.40 (backported in 1.39.4)
  25  * @license GPL-2.0-or-later
  26  */
  27 class FakeQqxMessageLocalizer implements MessageLocalizer {
  28
  29         public function msg( $key, ...$params ): Message {
  30                 $message = new class( $key ) extends Message {
  31
  32                         protected function fetchMessage(): string {
  33                                 return "($this->key$*)";
  34                         }
  35
  36                         public static function newFromSpecifier( $value ) {
  37                                 if ( $value instanceof MessageSpecifier ) {
  38                                         return new self( $value );
  39                                 }
  40                                 return parent::newFromSpecifier( $value );
  41                         }
  42
  43                         public function getLanguage(): Language {
  44                                 return new class() extends LanguageQqx {
  45
  46                                         public function __construct() {
  47                                         }
  48
  49                                         public function getCode(): string {
  50                                                 return 'qqx';
  51                                         }
  52
  53                                         // Support using Message::numParam()
  54                                         public function formatNum( $number ): string {
  55                                                 return (string)$number;
  56                                         }
  57                                 };
  58                         }
  59
  60                         public function inContentLanguage(): Message {
  61                                 return $this;
  62                         }
  63
  64                         protected function transformText( $string ): string {
  65                                 return $string;
  66                         }
  67                 };
  68
  69                 if ( $params ) {
  70                         // we use ->params() instead of the $params constructor parameter
  71                         // because ->params() supports some additional calling conventions,
  72                         // which our callers might also have used
  73                         $message->params( ...$params );
  74                 }
  75
  76                 return $message;
  77         }
  78 }