wikimedia/mediawiki-extensions-Gadgets
1
0
Fork 0
mirror of https://gerrit.wikimedia.org/r/mediawiki/extensions/Gadgets synced 2024-11-15 03:23:51 +00:00
Code Issues Packages Projects Releases Wiki Activity

Refactor Gadget construction process

Browse source 
The current method of setting private properties prevents the Gadget
object from being constructed by another class (like a GadgetRepo).

Instead, lets pass in arguments in an array.

Change-Id: I86853c72dfb323fb3e54be9ecff85973e30fe781
This commit is contained in:
Kunal Mehta 2015-07-18 02:26:25 -05:00
parent 7388765190
commit d537e50256
1 changed files with 47 additions and 14 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

61
Gadgets_body.php
View file

@ -39,6 +39,39 @@ class Gadget {
/** @var array|bool Result of loadStructuredList() */
private static $definitionCache;
public function __construct( array $options ) {
foreach ( $options as $member => $option ) {
switch ( $member ) {
case 'scripts':
case 'styles':
case 'dependencies':
case 'name':
case 'definition':
case 'resourceLoaded':
case 'requiredRights':
case 'requiredSkins':
case 'targets':
case 'onByDefault':
case 'position':
case 'category':
$this->{$member} = $option;
break;
default:
throw new InvalidArgumentException( "Unrecognized '$member' parameter" );
}
}
}
/**
* Whether the provided gadget id is valid
*
* @param string $id
* @return bool
*/
public static function isValidGadgetID( $id ) {
return strlen( $id ) > 0 && ResourceLoader::isValidModuleName( "ext.gadget.$id" );
}
/**
* Creates an instance of this class from definition in MediaWiki:Gadgets-definition
* @param $definition String: Gadget definition
@ -52,14 +85,14 @@ class Gadget {
// NOTE: the gadget name is used as part of the name of a form field,
// and must follow the rules defined in http://www.w3.org/TR/html4/types.html#type-cdata
// Also, title-normalization applies.
$gadget = new Gadget();
$gadget->name = trim( str_replace( ' ', '_', $m[1] ) );
$info = array();
$info['name'] = trim( str_replace( ' ', '_', $m[1] ) );
// If the name is too long, then RL will throw an MWException when
// we try to register the module
if ( !ResourceLoader::isValidModuleName( $gadget->getModuleName() ) ) {
if ( !self::isValidGadgetID( $info['name'] ) ) {
return false;
}
$gadget->definition = $definition;
$info['definition'] = $definition;
$options = trim( $m[2], ' []' );
foreach ( preg_split( '/\s*\|\s*/', $options, -1, PREG_SPLIT_NO_EMPTY ) as $option ) {
@ -74,25 +107,25 @@ class Gadget {
switch ( $option ) {
case 'ResourceLoader':
$gadget->resourceLoaded = true;
$info['resourceLoaded'] = true;
break;
case 'dependencies':
$gadget->dependencies = $params;
$info['dependencies'] = $params;
break;
case 'rights':
$gadget->requiredRights = $params;
$info['requiredRights'] = $params;
break;
case 'skins':
$gadget->requiredSkins = $params;
$info['requiredSkins'] = $params;
break;
case 'default':
$gadget->onByDefault = true;
$info['onByDefault'] = true;
break;
case 'targets':
$gadget->targets = $params;
$info['targets'] = $params;
break;
case 'top':
$gadget->position = 'top';
$info['position'] = 'top';
break;
}
}
@ -101,13 +134,13 @@ class Gadget {
$page = "Gadget-$page";
if ( preg_match( '/\.js/', $page ) ) {
$gadget->scripts[] = $page;
$info['scripts'][] = $page;
} elseif ( preg_match( '/\.css/', $page ) ) {
$gadget->styles[] = $page;
$info['styles'][] = $page;
}
}
return $gadget;
return new Gadget( $info );
}
/**