Marxjohnson: Fixed transposed parameters in example.

2011-03-23T13:45:52Z

Fixed transposed parameters in example.

← Older revision		Revision as of 13:45, 23 March 2011
Line 13:		Line 13:

	An important thing to remember when using lang strings is to prefix the component with the plugin type, as you do with all non-activity blocks. So to print the name of the "accumulative" workshopform plugin, you'd do		An important thing to remember when using lang strings is to prefix the component with the plugin type, as you do with all non-activity blocks. So to print the name of the "accumulative" workshopform plugin, you'd do
	print_string('~~workshopform_accumulative~~', '~~pluginname~~');		print_string('pluginname', 'workshopform_accumulative');

Marxjohnson: New page: Sub plugins allow activity modules to be extended without having to change the module's code. Each activity module can define a set of subplugin types in `db/subplugins.php`. The ...

2011-03-23T13:45:07Z

New page: Sub plugins allow activity modules to be extended without having to change the module's code. Each activity module can define a set of subplugin types in <tt>db/subplugins.php</tt>. The ...

New page

Sub plugins allow activity modules to be extended without having to change the module's code.

Each activity module can define a set of subplugin types in <tt>db/subplugins.php</tt>. The file must contain an array called <tt>$subplugins</tt>, with the plugin type as the key for the directory containing the plugins. For example, from <tt>mod/workshop/db/subplugins.php</tt>:
$subplugins = array(
'workshopform' => 'mod/workshop/form',
'workshopallocation' => 'mod/workshop/allocation',
'workshopeval' => 'mod/workshop/eval',
);
This defines 3 plugin types, <tt>workshopform</tt>, <tt>workshopallocation</tt>, and <tt>workshopeval</tt>. The plugins themselves can be found in <tt>mod/workshop/form</tt>, <tt>mod/workshop/allocation</tt> and <tt>mod/workshop/eval</tt>, respectively. Each of these directories can contain a number of plugins, each within it's own subdirectory.

=== Writing a sub-plugin ===
A sub-plugin has the same structure as a regular plugin. It will have a <tt>version.php</tt>, a <tt>lang</tt> directory, and can have a <tt>db</tt> directory with an <tt>install.xml</tt> and all the other hooks you'd expect to see used in any other type of plugin, such as an activity, block, or admin report.

An important thing to remember when using lang strings is to prefix the component with the plugin type, as you do with all non-activity blocks. So to print the name of the "accumulative" workshopform plugin, you'd do
print_string('workshopform_accumulative', 'pluginname');

Development:Subplugins - Revision history

Marxjohnson: Fixed transposed parameters in example.

Marxjohnson: New page: Sub plugins allow activity modules to be extended without having to change the module's code. Each activity module can define a set of subplugin types in db/subplugins.php. The ...

Marxjohnson: New page: Sub plugins allow activity modules to be extended without having to change the module's code. Each activity module can define a set of subplugin types in `db/subplugins.php`. The ...