*/
class ResourceLoaderImageModule extends ResourceLoaderModule {
- private $definition = null;
+ protected $definition = null;
/**
* Local base path, see __construct()
protected $selectorWithVariant = '.{prefix}-{name}-{variant}';
protected $targets = array( 'desktop', 'mobile' );
+ /** @var string Position on the page to load this module at */
+ protected $position = 'bottom';
+
/**
* Constructs a new module from an options array.
*
* 'selectorWithVariant' => [CSS selector template, variables: {prefix} {name} {variant}],
* // List of variants that may be used for the image files
* 'variants' => array(
+ * [theme name] => array(
* [variant name] => array(
* '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' => array(
- * [file path string],
- * [file path string] => array(
- * 'name' => [image name string, defaults to file name],
+ * [theme name] => array(
+ * [icon name] => array(
+ * '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],
* ),
+ * ...
+ * ),
* ...
* ),
* )
/**
* Parse definition and external JSON data, if referenced.
*/
- private function loadFromDefinition() {
+ protected function loadFromDefinition() {
if ( $this->definition === null ) {
return;
}
$prefix = isset( $options['prefix'] ) && $options['prefix'];
$selector = isset( $options['selector'] ) && $options['selector'];
- $selectorWithoutVariant = isset( $options['selectorWithoutVariant'] ) && $options['selectorWithoutVariant'];
- $selectorWithVariant = isset( $options['selectorWithVariant'] ) && $options['selectorWithVariant'];
+ $selectorWithoutVariant = isset( $options['selectorWithoutVariant'] )
+ && $options['selectorWithoutVariant'];
+ $selectorWithVariant = isset( $options['selectorWithVariant'] )
+ && $options['selectorWithVariant'];
if ( $selectorWithoutVariant && !$selectorWithVariant ) {
- throw new InvalidArgumentException( "Given 'selectorWithoutVariant' but no 'selectorWithVariant'." );
+ throw new InvalidArgumentException(
+ "Given 'selectorWithoutVariant' but no 'selectorWithVariant'."
+ );
}
if ( $selectorWithVariant && !$selectorWithoutVariant ) {
- throw new InvalidArgumentException( "Given 'selectorWithVariant' but no 'selectorWithoutVariant'." );
+ throw new InvalidArgumentException(
+ "Given 'selectorWithVariant' but no 'selectorWithoutVariant'."
+ );
}
if ( $selector && $selectorWithVariant ) {
- throw new InvalidArgumentException( "Incompatible 'selector' and 'selectorWithVariant'+'selectorWithoutVariant' given." );
+ throw new InvalidArgumentException(
+ "Incompatible 'selector' and 'selectorWithVariant'+'selectorWithoutVariant' given."
+ );
}
if ( !$prefix && !$selector && !$selectorWithVariant ) {
- throw new InvalidArgumentException( "None of 'prefix', 'selector' or 'selectorWithVariant'+'selectorWithoutVariant' given." );
+ throw new InvalidArgumentException(
+ "None of 'prefix', 'selector' or 'selectorWithVariant'+'selectorWithoutVariant' given."
+ );
}
foreach ( $options as $member => $option ) {
"Invalid list error. '$option' given, array expected."
);
}
+ if ( !isset( $option['default'] ) ) {
+ // Backwards compatibility
+ $option = array( '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':
+ $this->isPositionDefined = true;
case 'prefix':
case 'selectorWithoutVariant':
case 'selectorWithVariant':
/**
* Get a ResourceLoaderImage object for given image.
* @param string $name Image name
+ * @param ResourceLoaderContext $context
* @return ResourceLoaderImage|null
*/
- public function getImage( $name ) {
+ public function getImage( $name, ResourceLoaderContext $context ) {
$this->loadFromDefinition();
- $images = $this->getImages();
+ $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() {
+ public function getImages( ResourceLoaderContext $context ) {
+ $skin = $context->getSkin();
if ( !isset( $this->imageObjects ) ) {
$this->loadFromDefinition();
$this->imageObjects = array();
-
- foreach ( $this->images as $name => $options ) {
+ }
+ if ( !isset( $this->imageObjects[$skin] ) ) {
+ $this->imageObjects[$skin] = array();
+ if ( !isset( $this->images[$skin] ) ) {
+ $this->images[$skin] = isset( $this->images['default'] ) ?
+ $this->images['default'] :
+ array();
+ }
+ 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'] : array(),
- $this->getGlobalVariants()
+ $this->getGlobalVariants( $context )
);
- if ( isset( $this->variants ) ) {
+ if ( isset( $this->variants[$skin] ) ) {
$variantConfig = array_intersect_key(
- $this->variants,
+ $this->variants[$skin],
array_fill_keys( $allowedVariants, true )
);
} else {
$this->localBasePath,
$variantConfig
);
- $this->imageObjects[ $image->getName() ] = $image;
+ $this->imageObjects[$skin][$image->getName()] = $image;
}
}
- return $this->imageObjects;
+ 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() {
+ public function getGlobalVariants( ResourceLoaderContext $context ) {
+ $skin = $context->getSkin();
if ( !isset( $this->globalVariants ) ) {
$this->loadFromDefinition();
$this->globalVariants = array();
-
- if ( isset( $this->variants ) ) {
- foreach ( $this->variants as $name => $config ) {
- if ( isset( $config['global'] ) && $config['global'] ) {
- $this->globalVariants[] = $name;
- }
+ }
+ if ( !isset( $this->globalVariants[$skin] ) ) {
+ $this->globalVariants[$skin] = array();
+ if ( !isset( $this->variants[$skin] ) ) {
+ $this->variants[$skin] = isset( $this->variants['default'] ) ?
+ $this->variants['default'] :
+ array();
+ }
+ foreach ( $this->variants[$skin] as $name => $config ) {
+ if ( isset( $config['global'] ) && $config['global'] ) {
+ $this->globalVariants[$skin][] = $name;
}
}
}
- return $this->globalVariants;
+ return $this->globalVariants[$skin];
}
/**
$script = $context->getResourceLoader()->getLoadScript( $this->getSource() );
$selectors = $this->getSelectors();
- foreach ( $this->getImages() as $name => $image ) {
+ foreach ( $this->getImages( $context ) as $name => $image ) {
$declarations = $this->getCssDeclarations(
$image->getDataUri( $context, null, 'original' ),
$image->getUrl( $context, $script, null, 'rasterized' )
public function getModifiedTime( ResourceLoaderContext $context ) {
$this->loadFromDefinition();
$files = array();
- foreach ( $this->getImages() as $name => $image ) {
+ foreach ( $this->getImages( $context ) as $name => $image ) {
$files[] = $image->getPath( $context );
}
$files = array_values( array_unique( $files ) );
$filesMtime = max( array_map( array( __CLASS__, 'safeFilemtime' ), $files ) );
- return max(
- $filesMtime,
- $this->getDefinitionMtime( $context )
- );
+ return $filesMtime;
}
/**
return $localBasePath;
}
+
+ /**
+ * @return string
+ */
+ public function getPosition() {
+ $this->loadFromDefinition();
+ return $this->position;
+ }
+
+ public function isPositionDefault() {
+ $this->loadFromDefinition();
+ return parent::isPositionDefault();
+ }
}
dépôts / lhc / web / wiklou.git / blobdiff