tests/phpunit/includes/language/LocalizationUpdateSpyTrait.php

   1 <?php
   2
   3 namespace MediaWiki\Tests\Language;
   4
   5 use MessageCache;
   6
   7 /**
   8  * Trait for asserting that the localization component is getting notified
   9  * about changes as expected.
  10  */
  11 trait LocalizationUpdateSpyTrait {
  12
  13         /**
  14          * Register expectations about updates that should get triggered.
  15          * The parameters of this method represent known kinds of updates.
  16          * If a parameter is added, tests calling this method should be forced
  17          * to specify their expectations with respect to that kind of update.
  18          * For this reason, this method should not be split, and all parameters
  19          * should be required.
  20          */
  21         private function expectLocalizationUpdate( int $messageOverrides ) {
  22                 // Make sure LanguageEventIngress is triggered and updates the message
  23                 $messageCache = $this->createNoOpMock(
  24                         MessageCache::class,
  25                         [
  26                                 'updateMessageOverride',
  27                                 'figureMessage',
  28                                 'get',
  29                                 'transform',
  30                                 'getMsgFromNamespace',
  31                         ]
  32                 );
  33
  34                 // this is the relevant assertion:
  35                 $messageCache->expects( $this->exactly( $messageOverrides ) )
  36                         ->method( 'updateMessageOverride' );
  37
  38                 $messageCache->method( 'figureMessage' )
  39                         ->willReturn( [ 'xxx', 'en' ] );
  40
  41                 $messageCache->method( 'get' )
  42                         ->willReturn( 'dummy test' );
  43
  44                 $messageCache->method( 'transform' )
  45                         ->willReturn( 'dummy test' );
  46
  47                 $messageCache->method( 'getMsgFromNamespace' )
  48                         ->willReturn( false );
  49
  50                 $this->setService( 'MessageCache', $messageCache );
  51         }
  52
  53 }