_initPlugins
private
void
_initPlugins
(
config
)
Initializes static plugins registered on the host (using the
Base.plug static method) and any plugins passed to the
instance through the "plugins" configuration property.
- Parameters:
-
config <Config>The configuration object with property name/value pairs.
_plug
private
void
_plug
(
PluginClass
,
config
)
Private method used to instantiate and attach plugins to the host
- Parameters:
-
PluginClass <Function>The plugin class to instantiate -
config <Object>The configuration object for the plugin
_unplug
private
void
_unplug
(
plugin
)
Unplugs and destroys a plugin already instantiated with the host.
- Parameters:
-
plugin <String | Function>The namespace for the plugin, or a plugin class with the static NS property defined.
hasPlugin
boolean
hasPlugin
(
ns
)
Determines if a plugin has plugged into this host.
- Parameters:
-
ns <String>The plugin's namespace
- Returns:
boolean - returns true, if the plugin has been plugged into this host, false otherwise.
plug
Base
plug
(
p
,
config
)
Adds a plugin to the host object. This will instantiate the
plugin and attach it to the configured namespace on the host object.
- Parameters:
-
p <Function | Object |Array>Accepts the plugin class, or an object with a "fn" property specifying the plugin class and a "cfg" property specifying the configuration for the Plugin.Additionally an Array can also be passed in, with the above function or object values, allowing the user to add multiple plugins in a single call.
-
config <object>(Optional) If the first argument is the plugin class, the second argument can be the configuration for the plugin.
- Returns:
Base - A reference to the host object
Chainable: This method is chainable.
Plugin.Host.plug
static
void
Plugin.Host.plug
(
hostClass
,
plugin
,
config
)
Registers plugins to be instantiated at the class level (plugins
which should be plugged into every instance of the class by default).
- Parameters:
-
hostClass <Function>The host class on which to register the plugins -
plugin <Function | Array>Either the plugin class, an array of plugin classes or an array of objects (with fn and cfg properties defined) -
config <Object>(Optional) If plugin is the plugin class, the configuration for the plugin
Plugin.Host.unplug
static
void
Plugin.Host.unplug
(
hostClass
,
plugin
)
Unregisters any class level plugins which have been registered by the host class, or any
other class in the hierarchy.
- Parameters:
-
hostClass <Function>The host class from which to unregister the plugins -
plugin <Function | Array>The plugin class, or an array of plugin classes
unplug
Base
unplug
(
plugin
)
Removes a plugin from the host object. This will destroy the
plugin instance and delete the namepsace from the host object.
- Parameters:
-
plugin <String | Function>The namespace of the plugin, or the plugin class with the static NS namespace property defined. If not provided, all registered plugins are unplugged.
- Returns:
Base - A reference to the host object
Chainable: This method is chainable.