ResourceLoaderImageModule::getPrefix() - Code Metrics - wikimedia/mediawiki - Measure and Improve Code Quality continuously with Scrutinizer

ResourceLoaderImageModule::getPrefix() A
last analyzed 2016-11-13 17:42 UTC

↳ Parent: ResourceLoaderImageModule

Complexity

Conditions	1
Paths	1

Size

Total Lines	4
Code Lines	3

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
cc	1
eloc	3
nc	1
nop	0
dl	0
loc	4
rs	10
c	0
b	0
f	0

<?php
/**
 * ResourceLoader module for generated and embedded images.
 *
 * 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
 *
 * @file
 * @author Trevor Parscal
 */

/**
 * ResourceLoader module for generated and embedded images.
 *
 * @since 1.25
 */
class ResourceLoaderImageModule extends ResourceLoaderModule {

	protected $definition = null;

	/**
	 * Local base path, see __construct()
	 * @var string
	 */
	protected $localBasePath = '';

	protected $origin = self::ORIGIN_CORE_SITEWIDE;

	protected $images = [];
	protected $variants = [];
	protected $prefix = null;
	protected $selectorWithoutVariant = '.{prefix}-{name}';
	protected $selectorWithVariant = '.{prefix}-{name}-{variant}';
	protected $targets = [ 'desktop', 'mobile' ];

	/** @var string Position on the page to load this module at */
	protected $position = 'bottom';

	/**
	 * Constructs a new module from an options array.
	 *
	 * @param array $options List of options; if not given or empty, an empty module will be
	 *     constructed
	 * @param string $localBasePath Base path to prepend to all local paths in $options. Defaults
	 *     to $IP
	 *
	 * Below is a description for the $options array:
	 * @par Construction options:
	 * @code
	 *     [
	 *         // Base path to prepend to all local paths in $options. Defaults to $IP
	 *         'localBasePath' => [base path],
	 *         // Path to JSON file that contains any of the settings below
	 *         'data' => [file path string]
	 *         // CSS class prefix to use in all style rules
	 *         'prefix' => [CSS class prefix],
	 *         // Alternatively: Format of CSS selector to use in all style rules
	 *         'selector' => [CSS selector template, variables: {prefix} {name} {variant}],
	 *         // Alternatively: When using variants
	 *         'selectorWithoutVariant' => [CSS selector template, variables: {prefix} {name}],
	 *         'selectorWithVariant' => [CSS selector template, variables: {prefix} {name} {variant}],
	 *         // List of variants that may be used for the image files
	 *         'variants' => [
	 *             [theme name] => [
	 *                 [variant name] => [
	 *                     'color' => [color string, e.g. '#ffff00'],
	 *                     'global' => [boolean, if true, this variant is available
	 *                                  for all images of this type],
	 *                 ],
	 *                 ...
	 *             ],
	 *             ...
	 *         ],
	 *         // List of image files and their options
	 *         'images' => [
	 *             [theme name] => [
	 *                 [icon name] => [
	 *                     'file' => [file path string or array whose values are file path strings
	 *                                    and whose keys are 'default', 'ltr', 'rtl', a single
	 *                                    language code like 'en', or a list of language codes like
	 *                                    'en,de,ar'],
	 *                     'variants' => [array of variant name strings, variants
	 *                                    available for this image],
	 *                 ],
	 *                 ...
	 *             ],
	 *             ...
	 *         ],
	 *     ]
	 * @endcode
	 * @throws InvalidArgumentException
	 */
	public function __construct( $options = [], $localBasePath = null ) {
		$this->localBasePath = self::extractLocalBasePath( $options, $localBasePath );

		$this->definition = $options;
	}

	/**
	 * Parse definition and external JSON data, if referenced.
	 */
	protected function loadFromDefinition() {
		if ( $this->definition === null ) {
			return;
		}

		$options = $this->definition;
		$this->definition = null;

		if ( isset( $options['data'] ) ) {
			$dataPath = $this->localBasePath . '/' . $options['data'];
			$data = json_decode( file_get_contents( $dataPath ), true );
			$options = array_merge( $data, $options );
		}

		// Accepted combinations:
		// * prefix
		// * selector
		// * selectorWithoutVariant + selectorWithVariant
		// * prefix + selector
		// * prefix + selectorWithoutVariant + selectorWithVariant

		$prefix = isset( $options['prefix'] ) && $options['prefix'];
		$selector = isset( $options['selector'] ) && $options['selector'];
		$selectorWithoutVariant = isset( $options['selectorWithoutVariant'] )
			&& $options['selectorWithoutVariant'];
		$selectorWithVariant = isset( $options['selectorWithVariant'] )
			&& $options['selectorWithVariant'];

		if ( $selectorWithoutVariant && !$selectorWithVariant ) {
			throw new InvalidArgumentException(
				"Given 'selectorWithoutVariant' but no 'selectorWithVariant'."
			);
		}
		if ( $selectorWithVariant && !$selectorWithoutVariant ) {
			throw new InvalidArgumentException(
				"Given 'selectorWithVariant' but no 'selectorWithoutVariant'."
			);
		}
		if ( $selector && $selectorWithVariant ) {
			throw new InvalidArgumentException(
				"Incompatible 'selector' and 'selectorWithVariant'+'selectorWithoutVariant' given."
			);
		}
		if ( !$prefix && !$selector && !$selectorWithVariant ) {
			throw new InvalidArgumentException(
				"None of 'prefix', 'selector' or 'selectorWithVariant'+'selectorWithoutVariant' given."
			);
		}

		foreach ( $options as $member => $option ) {
			switch ( $member ) {
				case 'images':
				case 'variants':
					if ( !is_array( $option ) ) {
						throw new InvalidArgumentException(
							"Invalid list error. '$option' given, array expected."
						);
					}
					if ( !isset( $option['default'] ) ) {
						// Backwards compatibility
						$option = [ 'default' => $option ];
					}
					foreach ( $option as $skin => $data ) {
						if ( !is_array( $option ) ) {
							throw new InvalidArgumentException(
								"Invalid list error. '$option' given, array expected."
							);
						}
					}
					$this->{$member} = $option;
					break;

				case 'position':
				case 'prefix':
				case 'selectorWithoutVariant':
				case 'selectorWithVariant':
					$this->{$member} = (string)$option;
					break;

				case 'selector':
					$this->selectorWithoutVariant = $this->selectorWithVariant = (string)$option;
			}
		}
	}

	/**
	 * Get CSS class prefix used by this module.
	 * @return string
	 */
	public function getPrefix() {
		$this->loadFromDefinition();
		return $this->prefix;
	}

	/**
	 * Get CSS selector templates used by this module.
	 * @return string
	 */
	public function getSelectors() {
		$this->loadFromDefinition();
		return [
			'selectorWithoutVariant' => $this->selectorWithoutVariant,
			'selectorWithVariant' => $this->selectorWithVariant,
		];
	}

	/**
	 * Get a ResourceLoaderImage object for given image.
	 * @param string $name Image name
	 * @param ResourceLoaderContext $context
	 * @return ResourceLoaderImage|null
	 */
	public function getImage( $name, ResourceLoaderContext $context ) {
		$this->loadFromDefinition();
		$images = $this->getImages( $context );
		return isset( $images[$name] ) ? $images[$name] : null;
	}

	/**
	 * Get ResourceLoaderImage objects for all images.
	 * @param ResourceLoaderContext $context
	 * @return ResourceLoaderImage[] Array keyed by image name
	 */
	public function getImages( ResourceLoaderContext $context ) {
		$skin = $context->getSkin();
		if ( !isset( $this->imageObjects ) ) {
			$this->loadFromDefinition();
			$this->imageObjects = [];
class MyClass { }

$x = new MyClass();
$x->foo = true;
		}
		if ( !isset( $this->imageObjects[$skin] ) ) {
			$this->imageObjects[$skin] = [];
			if ( !isset( $this->images[$skin] ) ) {
				$this->images[$skin] = isset( $this->images['default'] ) ?
					$this->images['default'] :
					[];
			}
			foreach ( $this->images[$skin] as $name => $options ) {
				$fileDescriptor = is_string( $options ) ? $options : $options['file'];

				$allowedVariants = array_merge(
					is_array( $options ) && isset( $options['variants'] ) ? $options['variants'] : [],
					$this->getGlobalVariants( $context )
				);
				if ( isset( $this->variants[$skin] ) ) {
					$variantConfig = array_intersect_key(
						$this->variants[$skin],
						array_fill_keys( $allowedVariants, true )
					);
				} else {
					$variantConfig = [];
				}

				$image = new ResourceLoaderImage(
					$name,
					$this->getName(),
					$fileDescriptor,
					$this->localBasePath,
					$variantConfig
				);
				$this->imageObjects[$skin][$image->getName()] = $image;
			}
		}

		return $this->imageObjects[$skin];
	}

	/**
	 * Get list of variants in this module that are 'global', i.e., available
	 * for every image regardless of image options.
	 * @param ResourceLoaderContext $context
	 * @return string[]
	 */
	public function getGlobalVariants( ResourceLoaderContext $context ) {
		$skin = $context->getSkin();
		if ( !isset( $this->globalVariants ) ) {
			$this->loadFromDefinition();
			$this->globalVariants = [];

		}
		if ( !isset( $this->globalVariants[$skin] ) ) {

			$this->globalVariants[$skin] = [];

			if ( !isset( $this->variants[$skin] ) ) {
				$this->variants[$skin] = isset( $this->variants['default'] ) ?
					$this->variants['default'] :
					[];
			}
			foreach ( $this->variants[$skin] as $name => $config ) {
				if ( isset( $config['global'] ) && $config['global'] ) {
					$this->globalVariants[$skin][] = $name;

				}
			}
		}

		return $this->globalVariants[$skin];

	}

	/**
	 * @param ResourceLoaderContext $context
	 * @return array
	 */
	public function getStyles( ResourceLoaderContext $context ) {
		$this->loadFromDefinition();

		// Build CSS rules
		$rules = [];
		$script = $context->getResourceLoader()->getLoadScript( $this->getSource() );
		$selectors = $this->getSelectors();

		foreach ( $this->getImages( $context ) as $name => $image ) {
			$declarations = $this->getCssDeclarations(
				$image->getDataUri( $context, null, 'original' ),

				$image->getUrl( $context, $script, null, 'rasterized' )
			);
			$declarations = implode( "\n\t", $declarations );
			$selector = strtr(
				$selectors['selectorWithoutVariant'],
				[
					'{prefix}' => $this->getPrefix(),
					'{name}' => $name,
					'{variant}' => '',
				]
			);
			$rules[] = "$selector {\n\t$declarations\n}";

			foreach ( $image->getVariants() as $variant ) {
				$declarations = $this->getCssDeclarations(
					$image->getDataUri( $context, $variant, 'original' ),

					$image->getUrl( $context, $script, $variant, 'rasterized' )
				);
				$declarations = implode( "\n\t", $declarations );
				$selector = strtr(
					$selectors['selectorWithVariant'],
					[
						'{prefix}' => $this->getPrefix(),
						'{name}' => $name,
						'{variant}' => $variant,
					]
				);
				$rules[] = "$selector {\n\t$declarations\n}";
			}
		}

		$style = implode( "\n", $rules );
		return [ 'all' => $style ];
	}

	/**
	 * SVG support using a transparent gradient to guarantee cross-browser
	 * compatibility (browsers able to understand gradient syntax support also SVG).
	 * http://pauginer.tumblr.com/post/36614680636/invisible-gradient-technique
	 *
	 * Keep synchronized with the .background-image-svg LESS mixin in
	 * /resources/src/mediawiki.less/mediawiki.mixins.less.
	 *
	 * @param string $primary Primary URI
	 * @param string $fallback Fallback URI
	 * @return string[] CSS declarations to use given URIs as background-image
	 */
	protected function getCssDeclarations( $primary, $fallback ) {
		return [
			"background-image: url($fallback);",
			"background-image: linear-gradient(transparent, transparent), url($primary);",
			// Do not serve SVG to Opera 12, bad rendering with border-radius or background-size (T87504)
			"background-image: -o-linear-gradient(transparent, transparent), url($fallback);",
		];
	}

	/**
	 * @return bool
	 */
	public function supportsURLLoading() {
		return false;
	}

	/**
	 * Get the definition summary for this module.
	 *
	 * @param ResourceLoaderContext $context
	 * @return array
	 */
	public function getDefinitionSummary( ResourceLoaderContext $context ) {
		$this->loadFromDefinition();
		$summary = parent::getDefinitionSummary( $context );

		$options = [];
		foreach ( [
			'localBasePath',
			'images',
			'variants',
			'prefix',
			'selectorWithoutVariant',
			'selectorWithVariant',
		] as $member ) {
			$options[$member] = $this->{$member};
		};

		$summary[] = [
			'options' => $options,
			'fileHashes' => $this->getFileHashes( $context ),
		];
		return $summary;
	}

	/**
	 * Helper method for getDefinitionSummary.
	 */
	protected function getFileHashes( ResourceLoaderContext $context ) {
		$this->loadFromDefinition();
		$files = [];
		foreach ( $this->getImages( $context ) as $name => $image ) {
			$files[] = $image->getPath( $context );
		}
		$files = array_values( array_unique( $files ) );
		return array_map( [ __CLASS__, 'safeFileHash' ], $files );
	}

	/**
	 * Extract a local base path from module definition information.
	 *
	 * @param array $options Module definition
	 * @param string $localBasePath Path to use if not provided in module definition. Defaults
	 *     to $IP
	 * @return string Local base path
	 */
	public static function extractLocalBasePath( $options, $localBasePath = null ) {
		global $IP;

		if ( $localBasePath === null ) {
			$localBasePath = $IP;
		}

		if ( array_key_exists( 'localBasePath', $options ) ) {
			$localBasePath = (string)$options['localBasePath'];
		}

		return $localBasePath;
	}

	/**
	 * @return string
	 */
	public function getPosition() {
		$this->loadFromDefinition();
		return $this->position;
	}

	/**
	 * @return string
	 */
	public function getType() {
		return self::LOAD_STYLES;
	}
}


1		<?php
2		/**
3		* ResourceLoader module for generated and embedded images.
4		*
5		* This program is free software; you can redistribute it and/or modify
6		* it under the terms of the GNU General Public License as published by
7		* the Free Software Foundation; either version 2 of the License, or
8		* (at your option) any later version.
9		*
10		* This program is distributed in the hope that it will be useful,
11		* but WITHOUT ANY WARRANTY; without even the implied warranty of
12		* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
13		* GNU General Public License for more details.
14		*
15		* You should have received a copy of the GNU General Public License along
16		* with this program; if not, write to the Free Software Foundation, Inc.,
17		* 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
18		* http://www.gnu.org/copyleft/gpl.html
19		*
20		* @file
21		* @author Trevor Parscal
22		*/
23
24		/**
25		* ResourceLoader module for generated and embedded images.
26		*
27		* @since 1.25
28		*/
29		class ResourceLoaderImageModule extends ResourceLoaderModule {
30
31		protected $definition = null;
32
33		/**
34		* Local base path, see __construct()
35		* @var string
36		*/
37		protected $localBasePath = '';
38
39		protected $origin = self::ORIGIN_CORE_SITEWIDE;
40
41		protected $images = [];
42		protected $variants = [];
43		protected $prefix = null;
44		protected $selectorWithoutVariant = '.{prefix}-{name}';
45		protected $selectorWithVariant = '.{prefix}-{name}-{variant}';
46		protected $targets = [ 'desktop', 'mobile' ];
47
48		/** @var string Position on the page to load this module at */
49		protected $position = 'bottom';
50
51		/**
52		* Constructs a new module from an options array.
53		*
54		* @param array $options List of options; if not given or empty, an empty module will be
55		* constructed
56		* @param string $localBasePath Base path to prepend to all local paths in $options. Defaults
57		* to $IP
58		*
59		* Below is a description for the $options array:
60		* @par Construction options:
61		* @code
62		* [
63		* // Base path to prepend to all local paths in $options. Defaults to $IP
64		* 'localBasePath' => [base path],
65		* // Path to JSON file that contains any of the settings below
66		* 'data' => [file path string]
67		* // CSS class prefix to use in all style rules
68		* 'prefix' => [CSS class prefix],
69		* // Alternatively: Format of CSS selector to use in all style rules
70		* 'selector' => [CSS selector template, variables: {prefix} {name} {variant}],
71		* // Alternatively: When using variants
72		* 'selectorWithoutVariant' => [CSS selector template, variables: {prefix} {name}],
73		* 'selectorWithVariant' => [CSS selector template, variables: {prefix} {name} {variant}],
74		* // List of variants that may be used for the image files
75		* 'variants' => [
76		* [theme name] => [
77		* [variant name] => [
78		* 'color' => [color string, e.g. '#ffff00'],
79		* 'global' => [boolean, if true, this variant is available
80		* for all images of this type],
81		* ],
82		* ...
83		* ],
84		* ...
85		* ],
86		* // List of image files and their options
87		* 'images' => [
88		* [theme name] => [
89		* [icon name] => [
90		* 'file' => [file path string or array whose values are file path strings
91		* and whose keys are 'default', 'ltr', 'rtl', a single
92		* language code like 'en', or a list of language codes like
93		* 'en,de,ar'],
94		* 'variants' => [array of variant name strings, variants
95		* available for this image],
96		* ],
97		* ...
98		* ],
99		* ...
100		* ],
101		* ]
102		* @endcode
103		* @throws InvalidArgumentException
104		*/
105		public function __construct( $options = [], $localBasePath = null ) {
106		$this->localBasePath = self::extractLocalBasePath( $options, $localBasePath );
107
108		$this->definition = $options;
109		}
110
111		/**
112		* Parse definition and external JSON data, if referenced.
113		*/
114		protected function loadFromDefinition() {
115		if ( $this->definition === null ) {
116		return;
117		}
118
119		$options = $this->definition;
120		$this->definition = null;
121
122		if ( isset( $options['data'] ) ) {
123		$dataPath = $this->localBasePath . '/' . $options['data'];
124		$data = json_decode( file_get_contents( $dataPath ), true );
125		$options = array_merge( $data, $options );
126		}
127
128		// Accepted combinations:
129		// * prefix
130		// * selector
131		// * selectorWithoutVariant + selectorWithVariant
132		// * prefix + selector
133		// * prefix + selectorWithoutVariant + selectorWithVariant
134
135		$prefix = isset( $options['prefix'] ) && $options['prefix'];
136		$selector = isset( $options['selector'] ) && $options['selector'];
137		$selectorWithoutVariant = isset( $options['selectorWithoutVariant'] )
138		&& $options['selectorWithoutVariant'];
139		$selectorWithVariant = isset( $options['selectorWithVariant'] )
140		&& $options['selectorWithVariant'];
141
142		if ( $selectorWithoutVariant && !$selectorWithVariant ) {
143		throw new InvalidArgumentException(
144		"Given 'selectorWithoutVariant' but no 'selectorWithVariant'."
145		);
146		}
147		if ( $selectorWithVariant && !$selectorWithoutVariant ) {
148		throw new InvalidArgumentException(
149		"Given 'selectorWithVariant' but no 'selectorWithoutVariant'."
150		);
151		}
152		if ( $selector && $selectorWithVariant ) {
153		throw new InvalidArgumentException(
154		"Incompatible 'selector' and 'selectorWithVariant'+'selectorWithoutVariant' given."
155		);
156		}
157		if ( !$prefix && !$selector && !$selectorWithVariant ) {
158		throw new InvalidArgumentException(
159		"None of 'prefix', 'selector' or 'selectorWithVariant'+'selectorWithoutVariant' given."
160		);
161		}
162
163		foreach ( $options as $member => $option ) {
164		switch ( $member ) {
165		case 'images':
166		case 'variants':
167		if ( !is_array( $option ) ) {
168		throw new InvalidArgumentException(
169		"Invalid list error. '$option' given, array expected."
170		);
171		}
172		if ( !isset( $option['default'] ) ) {
173		// Backwards compatibility
174		$option = [ 'default' => $option ];
175		}
176		foreach ( $option as $skin => $data ) {
177		if ( !is_array( $option ) ) {
178		throw new InvalidArgumentException(
179		"Invalid list error. '$option' given, array expected."
180		);
181		}
182		}
183		$this->{$member} = $option;
184		break;
185
186		case 'position':
187		case 'prefix':
188		case 'selectorWithoutVariant':
189		case 'selectorWithVariant':
190		$this->{$member} = (string)$option;
191		break;
192
193		case 'selector':
194		$this->selectorWithoutVariant = $this->selectorWithVariant = (string)$option;
195		}
196		}
197		}
198
199		/**
200		* Get CSS class prefix used by this module.
201		* @return string
202		*/
203		public function getPrefix() {
204		$this->loadFromDefinition();
205		return $this->prefix;
206		}
207
208		/**
209		* Get CSS selector templates used by this module.
210		* @return string
211		*/
212		public function getSelectors() {
213		$this->loadFromDefinition();
214		return [
215		'selectorWithoutVariant' => $this->selectorWithoutVariant,
216		'selectorWithVariant' => $this->selectorWithVariant,
217		];
218		}
219
220		/**
221		* Get a ResourceLoaderImage object for given image.
222		* @param string $name Image name
223		* @param ResourceLoaderContext $context
224		* @return ResourceLoaderImage\|null
225		*/
226		public function getImage( $name, ResourceLoaderContext $context ) {
227		$this->loadFromDefinition();
228		$images = $this->getImages( $context );
229		return isset( $images[$name] ) ? $images[$name] : null;
230		}
231
232		/**
233		* Get ResourceLoaderImage objects for all images.
234		* @param ResourceLoaderContext $context
235		* @return ResourceLoaderImage[] Array keyed by image name
236		*/
237		public function getImages( ResourceLoaderContext $context ) {
238		$skin = $context->getSkin();
239		if ( !isset( $this->imageObjects ) ) {
240		$this->loadFromDefinition();
241		$this->imageObjects = [];
		0 ignored issues – show Bug introduced 2016-01-16 18:00 UTC by Report Bug Copy Issue Report The property `imageObjects` does not exist. Did you maybe forget to declare it? In PHP it is possible to write to properties without declaring them. For example, the following is perfectly valid PHP code: class MyClass { } $x = new MyClass(); $x->foo = true; Generally, it is a good practice to explictly declare properties to avoid accidental typos and provide IDE auto-completion: class MyClass { public $foo; } $x = new MyClass(); $x->foo = true; Loading history...
242		}
243		if ( !isset( $this->imageObjects[$skin] ) ) {
244		$this->imageObjects[$skin] = [];
245	View Code Duplication	if ( !isset( $this->images[$skin] ) ) {
246		$this->images[$skin] = isset( $this->images['default'] ) ?
247		$this->images['default'] :
248		[];
249		}
250		foreach ( $this->images[$skin] as $name => $options ) {
251		$fileDescriptor = is_string( $options ) ? $options : $options['file'];
252
253		$allowedVariants = array_merge(
254		is_array( $options ) && isset( $options['variants'] ) ? $options['variants'] : [],
255		$this->getGlobalVariants( $context )
256		);
257		if ( isset( $this->variants[$skin] ) ) {
258		$variantConfig = array_intersect_key(
259		$this->variants[$skin],
260		array_fill_keys( $allowedVariants, true )
261		);
262		} else {
263		$variantConfig = [];
264		}
265
266		$image = new ResourceLoaderImage(
267		$name,
268		$this->getName(),
269		$fileDescriptor,
270		$this->localBasePath,
271		$variantConfig
272		);
273		$this->imageObjects[$skin][$image->getName()] = $image;
274		}
275		}
276
277		return $this->imageObjects[$skin];
278		}
279
280		/**
281		* Get list of variants in this module that are 'global', i.e., available
282		* for every image regardless of image options.
283		* @param ResourceLoaderContext $context
284		* @return string[]
285		*/
286		public function getGlobalVariants( ResourceLoaderContext $context ) {
287		$skin = $context->getSkin();
288		if ( !isset( $this->globalVariants ) ) {
289		$this->loadFromDefinition();
290		$this->globalVariants = [];
		0 ignored issues – show Bug introduced 2016-01-16 18:00 UTC by Report Bug Copy Issue Report The property `globalVariants` does not seem to exist. Did you mean `variants`? An attempt at access to an undefined property has been detected. This may either be a typographical error or the property has been renamed but there are still references to its old name. If you really want to allow access to undefined properties, you can define magic methods to allow access. See the php core documentation on Overloading. Loading history...
291		}
292		if ( !isset( $this->globalVariants[$skin] ) ) {
		0 ignored issues – show Bug introduced 2016-01-16 18:00 UTC by Report Bug Copy Issue Report The property `globalVariants` does not seem to exist. Did you mean `variants`? An attempt at access to an undefined property has been detected. This may either be a typographical error or the property has been renamed but there are still references to its old name. If you really want to allow access to undefined properties, you can define magic methods to allow access. See the php core documentation on Overloading. Loading history...
293		$this->globalVariants[$skin] = [];
		0 ignored issues – show Bug introduced 2016-01-16 18:00 UTC by Report Bug Copy Issue Report The property `globalVariants` does not seem to exist. Did you mean `variants`? An attempt at access to an undefined property has been detected. This may either be a typographical error or the property has been renamed but there are still references to its old name. If you really want to allow access to undefined properties, you can define magic methods to allow access. See the php core documentation on Overloading. Loading history...
294	View Code Duplication	if ( !isset( $this->variants[$skin] ) ) {
295		$this->variants[$skin] = isset( $this->variants['default'] ) ?
296		$this->variants['default'] :
297		[];
298		}
299		foreach ( $this->variants[$skin] as $name => $config ) {
300		if ( isset( $config['global'] ) && $config['global'] ) {
301		$this->globalVariants[$skin][] = $name;
		0 ignored issues – show Bug introduced 2016-01-16 18:00 UTC by Report Bug Copy Issue Report The property `globalVariants` does not seem to exist. Did you mean `variants`? An attempt at access to an undefined property has been detected. This may either be a typographical error or the property has been renamed but there are still references to its old name. If you really want to allow access to undefined properties, you can define magic methods to allow access. See the php core documentation on Overloading. Loading history...
302		}
303		}
304		}
305
306		return $this->globalVariants[$skin];
		0 ignored issues – show Bug introduced 2016-01-16 18:00 UTC by Report Bug Copy Issue Report The property `globalVariants` does not seem to exist. Did you mean `variants`? An attempt at access to an undefined property has been detected. This may either be a typographical error or the property has been renamed but there are still references to its old name. If you really want to allow access to undefined properties, you can define magic methods to allow access. See the php core documentation on Overloading. Loading history...
307		}
308
309		/**
310		* @param ResourceLoaderContext $context
311		* @return array
312		*/
313		public function getStyles( ResourceLoaderContext $context ) {
314		$this->loadFromDefinition();
315
316		// Build CSS rules
317		$rules = [];
318		$script = $context->getResourceLoader()->getLoadScript( $this->getSource() );
319		$selectors = $this->getSelectors();
320
321		foreach ( $this->getImages( $context ) as $name => $image ) {
322		$declarations = $this->getCssDeclarations(
323		$image->getDataUri( $context, null, 'original' ),
		0 ignored issues – show Security Bug introduced 2016-01-16 18:00 UTC by Report Bug Copy Issue Report It seems like `$image->getDataUri($context, null, 'original')` targeting `ResourceLoaderImage::getDataUri()` can also be of type `false`; however, `ResourceLoaderImageModule::getCssDeclarations()` does only seem to accept `string`, did you maybe forget to handle an error condition? Loading history...
324		$image->getUrl( $context, $script, null, 'rasterized' )
325		);
326		$declarations = implode( "\n\t", $declarations );
327		$selector = strtr(
328		$selectors['selectorWithoutVariant'],
329		[
330		'{prefix}' => $this->getPrefix(),
331		'{name}' => $name,
332		'{variant}' => '',
333		]
334		);
335		$rules[] = "$selector {\n\t$declarations\n}";
336
337		foreach ( $image->getVariants() as $variant ) {
338		$declarations = $this->getCssDeclarations(
339		$image->getDataUri( $context, $variant, 'original' ),
		0 ignored issues – show Security Bug introduced 2016-01-16 18:00 UTC by Report Bug Copy Issue Report It seems like `$image->getDataUri($cont..., $variant, 'original')` targeting `ResourceLoaderImage::getDataUri()` can also be of type `false`; however, `ResourceLoaderImageModule::getCssDeclarations()` does only seem to accept `string`, did you maybe forget to handle an error condition? Loading history...
340		$image->getUrl( $context, $script, $variant, 'rasterized' )
341		);
342		$declarations = implode( "\n\t", $declarations );
343		$selector = strtr(
344		$selectors['selectorWithVariant'],
345		[
346		'{prefix}' => $this->getPrefix(),
347		'{name}' => $name,
348		'{variant}' => $variant,
349		]
350		);
351		$rules[] = "$selector {\n\t$declarations\n}";
352		}
353		}
354
355		$style = implode( "\n", $rules );
356		return [ 'all' => $style ];
357		}
358
359		/**
360		* SVG support using a transparent gradient to guarantee cross-browser
361		* compatibility (browsers able to understand gradient syntax support also SVG).
362		* http://pauginer.tumblr.com/post/36614680636/invisible-gradient-technique
363		*
364		* Keep synchronized with the .background-image-svg LESS mixin in
365		* /resources/src/mediawiki.less/mediawiki.mixins.less.
366		*
367		* @param string $primary Primary URI
368		* @param string $fallback Fallback URI
369		* @return string[] CSS declarations to use given URIs as background-image
370		*/
371		protected function getCssDeclarations( $primary, $fallback ) {
372		return [
373		"background-image: url($fallback);",
374		"background-image: linear-gradient(transparent, transparent), url($primary);",
375		// Do not serve SVG to Opera 12, bad rendering with border-radius or background-size (T87504)
376		"background-image: -o-linear-gradient(transparent, transparent), url($fallback);",
377		];
378		}
379
380		/**
381		* @return bool
382		*/
383		public function supportsURLLoading() {
384		return false;
385		}
386
387		/**
388		* Get the definition summary for this module.
389		*
390		* @param ResourceLoaderContext $context
391		* @return array
392		*/
393		public function getDefinitionSummary( ResourceLoaderContext $context ) {
394		$this->loadFromDefinition();
395		$summary = parent::getDefinitionSummary( $context );
396
397		$options = [];
398		foreach ( [
399		'localBasePath',
400		'images',
401		'variants',
402		'prefix',
403		'selectorWithoutVariant',
404		'selectorWithVariant',
405		] as $member ) {
406		$options[$member] = $this->{$member};
407		};
408
409		$summary[] = [
410		'options' => $options,
411		'fileHashes' => $this->getFileHashes( $context ),
412		];
413		return $summary;
414		}
415
416		/**
417		* Helper method for getDefinitionSummary.
418		*/
419		protected function getFileHashes( ResourceLoaderContext $context ) {
420		$this->loadFromDefinition();
421		$files = [];
422		foreach ( $this->getImages( $context ) as $name => $image ) {
423		$files[] = $image->getPath( $context );
424		}
425		$files = array_values( array_unique( $files ) );
426		return array_map( [ __CLASS__, 'safeFileHash' ], $files );
427		}
428
429		/**
430		* Extract a local base path from module definition information.
431		*
432		* @param array $options Module definition
433		* @param string $localBasePath Path to use if not provided in module definition. Defaults
434		* to $IP
435		* @return string Local base path
436		*/
437		public static function extractLocalBasePath( $options, $localBasePath = null ) {
438		global $IP;
439
440		if ( $localBasePath === null ) {
441		$localBasePath = $IP;
442		}
443
444		if ( array_key_exists( 'localBasePath', $options ) ) {
445		$localBasePath = (string)$options['localBasePath'];
446		}
447
448		return $localBasePath;
449		}
450
451		/**
452		* @return string
453		*/
454		public function getPosition() {
455		$this->loadFromDefinition();
456		return $this->position;
457		}
458
459		/**
460		* @return string
461		*/
462		public function getType() {
463		return self::LOAD_STYLES;
464		}
465		}
466

wikimedia / mediawiki

ResourceLoaderImageModule::getPrefix() A last analyzed 2016-11-13 17:42 UTC

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like

ResourceLoaderImageModule::getPrefix() A
last analyzed 2016-11-13 17:42 UTC