mediawiki-extensions-Visual.../modules/ve/ve.Factory.js
Trevor Parscal efafed3231 Remove ve.{inheritClass,mixinClass} and use OO instead
Change-Id: I8df9226a358a76b661eab6e967ff0d63d361f691
2013-10-18 18:58:08 +02:00

92 lines
2.7 KiB
JavaScript

/*!
* VisualEditor Factory class.
*
* @copyright 2011-2013 VisualEditor Team and others; see AUTHORS.txt
* @license The MIT License (MIT); see LICENSE.txt
*/
/**
* Generic object factory.
*
* @abstract
* @extends ve.Registry
* @constructor
*/
ve.Factory = function VeFactory() {
// Parent constructor
ve.Registry.call( this );
// Properties
this.entries = [];
};
/* Inheritance */
OO.inheritClass( ve.Factory, ve.Registry );
/* Methods */
/**
* Register a constructor with the factory.
*
* Classes must have a static `name` property to be registered.
*
* @example
* function MyClass() {};
* // Adds a static property to the class defining a symbolic name
* MyClass.static = { 'name': 'mine' };
* // Registers class with factory, available via symbolic name 'mine'
* factory.register( MyClass );
*
* @method
* @param {Function} constructor Constructor to use when creating object
* @throws {Error} Name must be a string and must not be empty
* @throws {Error} Constructor must be a function
*/
ve.Factory.prototype.register = function ( constructor ) {
var name;
if ( typeof constructor !== 'function' ) {
throw new Error( 'constructor must be a function, cannot be a ' + typeof constructor );
}
name = constructor.static && constructor.static.name;
if ( typeof name !== 'string' || name === '' ) {
throw new Error( 'Name must be a string and must not be empty' );
}
this.entries.push( name );
ve.Registry.prototype.register.call( this, name, constructor );
};
/**
* Create an object based on a name.
*
* Name is used to look up the constructor to use, while all additional arguments are passed to the
* constructor directly, so leaving one out will pass an undefined to the constructor.
*
* @method
* @param {string} name Object name
* @param {Mixed...} [args] Arguments to pass to the constructor
* @returns {Object} The new object
* @throws {Error} Unknown object name
*/
ve.Factory.prototype.create = function ( name ) {
var args, obj, constructor;
constructor = this.registry[name];
if ( constructor === undefined ) {
throw new Error( 'No class registered by that name: ' + name );
}
// Convert arguments to array and shift the first argument (name) off
args = Array.prototype.slice.call( arguments, 1 );
// We can't use the "new" operator with .apply directly because apply needs a
// context. So instead just do what "new" does: create an object that inherits from
// the constructor's prototype (which also makes it an "instanceof" the constructor),
// then invoke the constructor with the object as context, and return it (ignoring
// the constructor's return value).
obj = ve.createObject( constructor.prototype );
constructor.apply( obj, args );
return obj;
};