*/
class ResourceLoaderImageModule extends ResourceLoaderModule {
+ protected $definition = null;
+
/**
* Local base path, see __construct()
* @var string
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.
*
* array(
* // 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
* '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(
+ * [theme name] => array(
* [file path string],
* [file path string] => array(
* 'name' => [image name string, defaults to file name],
* 'variants' => [array of variant name strings, variants
* available for this image],
* ),
+ * ...
+ * ),
* ...
* ),
* )
public function __construct( $options = array(), $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
"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':
* @return string
*/
public function getPrefix() {
+ $this->loadFromDefinition();
return $this->prefix;
}
* @return string
*/
public function getSelectors() {
+ $this->loadFromDefinition();
return array(
'selectorWithoutVariant' => $this->selectorWithoutVariant,
'selectorWithVariant' => $this->selectorWithVariant,
* @param string $name Image name
* @return ResourceLoaderImage|null
*/
- public function getImage( $name ) {
- $images = $this->getImages();
+ 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.
* @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 ];
}
/**
* for every image regardless of image options.
* @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 ];
}
/**
* @return array
*/
public function getStyles( ResourceLoaderContext $context ) {
+ $this->loadFromDefinition();
+
// Build CSS rules
$rules = array();
$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' )
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 );
+ foreach ( array(
+ 'localBasePath',
+ 'images',
+ 'variants',
+ 'prefix',
+ 'selectorWithoutVariant',
+ 'selectorWithVariant',
+ ) as $member ) {
+ $summary[$member] = $this->{$member};
+ };
+ return $summary;
+ }
+
+ /**
+ * Get the last modified timestamp of this module.
+ *
+ * @param ResourceLoaderContext $context Context in which to calculate
+ * the modified time
+ * @return int UNIX timestamp
+ */
+ public function getModifiedTime( ResourceLoaderContext $context ) {
+ $this->loadFromDefinition();
+ $files = array();
+ 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 )
+ );
+ }
+
/**
* Extract a local base path from module definition information.
*
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