MediaWiki  1.33.0
ResourceLoaderImageTest.php
Go to the documentation of this file.
1 <?php
2 
7 
8  protected $imagesPath;
9 
10  protected function setUp() {
11  parent::setUp();
12  $this->imagesPath = __DIR__ . '/../../data/resourceloader';
13  }
14 
15  protected function getTestImage( $name ) {
17  $fileDescriptor = is_string( $options ) ? $options : $options['file'];
18  $allowedVariants = ( is_array( $options ) && isset( $options['variants'] ) ) ?
19  $options['variants'] : [];
20  $variants = array_fill_keys( $allowedVariants, [ 'color' => 'red' ] );
21  return new ResourceLoaderImageTestable(
22  $name,
23  'test',
24  $fileDescriptor,
25  $this->imagesPath,
26  $variants
27  );
28  }
29 
30  public static function provideGetPath() {
31  return [
32  [ 'abc', 'en', 'abc.gif' ],
33  [ 'abc', 'he', 'abc.gif' ],
34  [ 'def', 'en', 'def.svg' ],
35  [ 'def', 'he', 'def.svg' ],
36  [ 'ghi', 'en', 'ghi.svg' ],
37  [ 'ghi', 'he', 'jkl.svg' ],
38  [ 'mno', 'en', 'mno-ltr.svg' ],
39  [ 'mno', 'ar', 'mno-rtl.svg' ],
40  [ 'mno', 'he', 'mno-ltr.svg' ],
41  [ 'pqr', 'en', 'pqr-b.svg' ],
42  [ 'pqr', 'en-gb', 'pqr-b.svg' ],
43  [ 'pqr', 'de', 'pqr-f.svg' ],
44  [ 'pqr', 'de-formal', 'pqr-f.svg' ],
45  [ 'pqr', 'ar', 'pqr-f.svg' ],
46  [ 'pqr', 'fr', 'pqr-a.svg' ],
47  [ 'pqr', 'he', 'pqr-a.svg' ],
48  ];
49  }
50 
55  public function testGetPath( $imageName, $languageCode, $path ) {
56  static $dirMap = [
57  'en' => 'ltr',
58  'en-gb' => 'ltr',
59  'de' => 'ltr',
60  'de-formal' => 'ltr',
61  'fr' => 'ltr',
62  'he' => 'rtl',
63  'ar' => 'rtl',
64  ];
65  static $contexts = [];
66 
67  $image = $this->getTestImage( $imageName );
69  'lang' => $languageCode,
70  'dir' => $dirMap[$languageCode],
71  ] );
72 
73  $this->assertEquals( $image->getPath( $context ), $this->imagesPath . '/' . $path );
74  }
75 
80  public function testGetExtension() {
81  $image = $this->getTestImage( 'def' );
82  $this->assertEquals( $image->getExtension(), 'svg' );
83  $this->assertEquals( $image->getExtension( 'original' ), 'svg' );
84  $this->assertEquals( $image->getExtension( 'rasterized' ), 'png' );
85  $image = $this->getTestImage( 'abc' );
86  $this->assertEquals( $image->getExtension(), 'gif' );
87  $this->assertEquals( $image->getExtension( 'original' ), 'gif' );
88  $this->assertEquals( $image->getExtension( 'rasterized' ), 'gif' );
89  }
90 
96  public function testGetImageData() {
98 
99  $image = $this->getTestImage( 'def' );
100  $data = file_get_contents( $this->imagesPath . '/def.svg' );
101  $dataConstructive = file_get_contents( $this->imagesPath . '/def_variantize.svg' );
102  $this->assertEquals( $image->getImageData( $context, null, 'original' ), $data );
103  $this->assertEquals(
104  $image->getImageData( $context, 'destructive', 'original' ),
105  $dataConstructive
106  );
107  // Stub, since we don't know if we even have a SVG handler, much less what exactly it'll output
108  $this->assertEquals( $image->getImageData( $context, null, 'rasterized' ), 'RASTERIZESTUB' );
109 
110  $image = $this->getTestImage( 'abc' );
111  $data = file_get_contents( $this->imagesPath . '/abc.gif' );
112  $this->assertEquals( $image->getImageData( $context, null, 'original' ), $data );
113  $this->assertEquals( $image->getImageData( $context, null, 'rasterized' ), $data );
114  }
115 
119  public function testMassageSvgPathdata() {
120  $image = $this->getTestImage( 'ghi' );
121  $data = file_get_contents( $this->imagesPath . '/ghi.svg' );
122  $dataMassaged = file_get_contents( $this->imagesPath . '/ghi_massage.svg' );
123  $this->assertEquals( $image->massageSvgPathdata( $data ), $dataMassaged );
124  }
125 }
126 
128  // Make some protected methods public
129  public function massageSvgPathdata( $svg ) {
130  return parent::massageSvgPathdata( $svg );
131  }
132  // Stub, since we don't know if we even have a SVG handler, much less what exactly it'll output
133  public function rasterize( $svg ) {
134  return 'RASTERIZESTUB';
135  }
136 }
ResourceLoaderImageTestable\rasterize
rasterize( $svg)
Convert passed image data, which is assumed to be SVG, to PNG.
Definition: ResourceLoaderImageTest.php:133
$context
do that in ParserLimitReportFormat instead use this to modify the parameters of the image all existing parser cache entries will be invalid To avoid you ll need to handle that somehow(e.g. with the RejectParserCacheValue hook) because MediaWiki won 't do it for you. & $defaults also a ContextSource after deleting those rows but within the same transaction you ll probably need to make sure the header is varied on and they can depend only on the ResourceLoaderContext $context
Definition: hooks.txt:2636
ResourceLoaderImageTest\testMassageSvgPathdata
testMassageSvgPathdata()
ResourceLoaderImage::massageSvgPathdata.
Definition: ResourceLoaderImageTest.php:119
ResourceLoaderImageTest\$imagesPath
$imagesPath
Definition: ResourceLoaderImageTest.php:8
ResourceLoaderImageTest\setUp
setUp()
Definition: ResourceLoaderImageTest.php:10
php
injection txt This is an overview of how MediaWiki makes use of dependency injection The design described here grew from the discussion of RFC T384 The term dependency this means that anything an object needs to operate should be injected from the the object itself should only know narrow no concrete implementation of the logic it relies on The requirement to inject everything typically results in an architecture that based on two main types of and essentially stateless service objects that use other service objects to operate on the value objects As of the beginning MediaWiki is only starting to use the DI approach Much of the code still relies on global state or direct resulting in a highly cyclical dependency which acts as the top level factory for services in MediaWiki which can be used to gain access to default instances of various services MediaWikiServices however also allows new services to be defined and default services to be redefined Services are defined or redefined by providing a callback the instantiator that will return a new instance of the service When it will create an instance of MediaWikiServices and populate it with the services defined in the files listed by thereby bootstrapping the DI framework Per $wgServiceWiringFiles lists includes ServiceWiring php
Definition: injection.txt:35
ResourceLoaderImageTestable
Definition: ResourceLoaderImageTest.php:127
$data
$data
Utility to generate mapping file used in mw.Title (phpCharToUpper.json)
Definition: generatePhpCharToUpperMappings.php:13
ResourceLoaderImageTest\testGetPath
testGetPath( $imageName, $languageCode, $path)
ResourceLoaderImage::getPath provideGetPath.
Definition: ResourceLoaderImageTest.php:55
ResourceLoaderImageTest\testGetImageData
testGetImageData()
ResourceLoaderImage::getImageData ResourceLoaderImage::variantize ResourceLoaderImage::massageSvgPath...
Definition: ResourceLoaderImageTest.php:96
ResourceLoaderImageTestable\massageSvgPathdata
massageSvgPathdata( $svg)
Massage the SVG image data for converters which don't understand some path data syntax.
Definition: ResourceLoaderImageTest.php:129
ResourceLoaderImageTest\getTestImage
getTestImage( $name)
Definition: ResourceLoaderImageTest.php:15
$image
this hook is for auditing only or null if authentication failed before getting that far or null if we can t even determine that When $user is not it can be in the form of< username >< more info > e g for bot passwords intended to be added to log contexts Fields it might only if the login was with a bot password it is not rendered in wiki pages or galleries in category pages allow injecting custom HTML after the section Any uses of the hook need to handle escaping see BaseTemplate::getToolbox and BaseTemplate::makeListItem for details on the format of individual items inside of this array or by returning and letting standard HTTP rendering take place modifiable or by returning false and taking over the output modifiable modifiable after all normalizations have been except for the $wgMaxImageArea check $image
Definition: hooks.txt:780
ResourceLoaderImage
Class encapsulating an image used in a ResourceLoaderImageModule.
Definition: ResourceLoaderImage.php:30
$name
Allows to change the fields on the form that will be generated $name
Definition: hooks.txt:271
ResourceLoaderImageModuleTest\$commonImageData
static $commonImageData
Definition: ResourceLoaderImageModuleTest.php:10
ResourceLoaderImageTest\provideGetPath
static provideGetPath()
Definition: ResourceLoaderImageTest.php:30
ResourceLoaderImageTest
ResourceLoader.
Definition: ResourceLoaderImageTest.php:6
$options
null means default in associative array with keys and values unescaped Should be merged with default with a value of false meaning to suppress the attribute in associative array with keys and values unescaped & $options
Definition: hooks.txt:1985
$path
$path
Definition: NoLocalSettings.php:25
ResourceLoaderTestCase\getResourceLoaderContext
getResourceLoaderContext( $options=[], ResourceLoader $rl=null)
Definition: ResourceLoaderTestCase.php:23
ResourceLoaderImageTest\testGetExtension
testGetExtension()
ResourceLoaderImage::getExtension ResourceLoaderImage::getMimeType.
Definition: ResourceLoaderImageTest.php:80
ResourceLoaderTestCase
Definition: ResourceLoaderTestCase.php:7