Subplugins - Revision history

Mits: ja link

2023-07-11T15:07:27Z

ja link

← Older revision		Revision as of 15:07, 11 July 2023
Line 105:		Line 105:

	[[Category:Plugins]]		[[Category:Plugins]]
			[[ja:サブプラグイン]]

Mudrd8mz: Text replacement - "`" to ""`


2021-07-15T08:08:01Z
Text replacement - "<code (.*)>" to "<syntaxhighlight lang="$1">"

				
				
				
				
				
				← Older revision
				Revision as of 08:08, 15 July 2021
				
Line 14:
Line 14:



Starting with Moodle 3.8, the subplugins should be defined in the <tt>db/subplugins.json</tt> file. For example, from  <tt>mod/workshop/db/subplugins.json</tt>: Starting with Moodle 3.8, the subplugins should be defined in the <tt>db/subplugins.json</tt> file. For example, from  <tt>mod/workshop/db/subplugins.json</tt>:
<code json> <syntaxhighlight lang="json">
{ {
     "plugintypes": {      "plugintypes": {

`Mudrd8mz: Text replacement - "`" to ""

2021-07-14T20:20:03Z

Text replacement - "</code>" to "</syntaxhighlight>"

← Older revision		Revision as of 20:20, 14 July 2021
Line 22:		Line 22:
	}		}
	}		}
	</~~code~~>		</syntaxhighlight>

	If you have a plugin supporting multiple versions, then you should create the <tt>db/subplugins.json</tt> file, as well as a <tt>db/subplugins.php</tt> variant which contains the following:		If you have a plugin supporting multiple versions, then you should create the <tt>db/subplugins.json</tt> file, as well as a <tt>db/subplugins.php</tt> variant which contains the following:
Line 29:		Line 29:

	$subplugins = (array) json_decode(file_get_contents(__DIR__ . "/subplugins.json"))->plugintypes;		$subplugins = (array) json_decode(file_get_contents(__DIR__ . "/subplugins.json"))->plugintypes;
	</~~code~~>		</syntaxhighlight>

	===db/subplugins.php===		===db/subplugins.php===
Line 40:		Line 40:
	'workshopeval' => 'mod/workshop/eval',		'workshopeval' => 'mod/workshop/eval',
	);		);
	</~~code~~>		</syntaxhighlight>

	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.		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.
Line 54:		Line 54:
	$string['subplugintype_workshopform'] = 'Grading strategy';		$string['subplugintype_workshopform'] = 'Grading strategy';
	$string['subplugintype_workshopform_plural'] = 'Grading strategies';		$string['subplugintype_workshopform_plural'] = 'Grading strategies';
	</~~code~~>		</syntaxhighlight>

	===Naming rules and recommendations===		===Naming rules and recommendations===
Line 77:		Line 77:
	class feedview extends \core\plugininfo\base {		class feedview extends \core\plugininfo\base {
	}		}
	</~~code~~>		</syntaxhighlight>

	===Uninstallation support===		===Uninstallation support===

Mudrd8mz: Text replacement - "`" to ""`


2021-07-14T13:38:31Z
Text replacement - "<code php>" to "<syntaxhighlight lang="php">"

				
				
				
				
				
				← Older revision
				Revision as of 13:38, 14 July 2021
				
Line 25:
Line 25:



If you have a plugin supporting multiple versions, then you should create the <tt>db/subplugins.json</tt> file, as well as a <tt>db/subplugins.php</tt> variant which contains the following: If you have a plugin supporting multiple versions, then you should create the <tt>db/subplugins.json</tt> file, as well as a <tt>db/subplugins.php</tt> variant which contains the following:
<code php> <syntaxhighlight lang="php">
<?php <?php



Line 34:
Line 34:



Each activity module can define a set of sub-plugin '''types''' (not to be confused with the subplugins themselves) 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>: Each activity module can define a set of sub-plugin '''types''' (not to be confused with the subplugins themselves) 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>:
<code php> <syntaxhighlight lang="php">
$subplugins = array( $subplugins = array(
     'workshopform'       => 'mod/workshop/form',      'workshopform'       => 'mod/workshop/form',
Line 47:
Line 47:



You also need to add an entry in the module's language strings to identify the subplugin(s). Again, using an example from Workshop in <tt>mod/workshop/lang/en/workshop.php</tt> one can find: You also need to add an entry in the module's language strings to identify the subplugin(s). Again, using an example from Workshop in <tt>mod/workshop/lang/en/workshop.php</tt> one can find:
<code php> <syntaxhighlight lang="php">
$string['subplugintype_workshopallocation'] = 'Submissions allocation method'; $string['subplugintype_workshopallocation'] = 'Submissions allocation method';
$string['subplugintype_workshopallocation_plural'] = 'Submissions allocation methods'; $string['subplugintype_workshopallocation_plural'] = 'Submissions allocation methods';
Line 73:
Line 73:
Here is an example of the class for a plugin called mod_feed and subtype called feedview (doc comments omitted for brevity): Here is an example of the class for a plugin called mod_feed and subtype called feedview (doc comments omitted for brevity):



<code php> <syntaxhighlight lang="php">
namespace mod_feed\plugininfo; namespace mod_feed\plugininfo;
class feedview extends \core\plugininfo\base { class feedview extends \core\plugininfo\base {



Mudrd8mz: /* db/subplugins.json */ Remove the slashes escaping from the example to make it more readable (JSON does not need it, PHP json_encode does it by default for reasons that are not relevant for us)
2020-03-12T12:59:26Z
db/subplugins.json:  Remove the slashes escaping from the example to make it more readable (JSON does not need it, PHP json_encode does it by default for reasons that are not relevant for us)

				
				
				
				
				
				← Older revision
				Revision as of 12:59, 12 March 2020
				
Line 17:
Line 17:
{ {
     "plugintypes": {      "plugintypes": {
         "workshopform": "mod\/workshop\/form",          "workshopform": "mod/workshop/form",
         "workshopallocation": "mod\/workshop\/allocation",          "workshopallocation": "mod/workshop/allocation",
         "workshopeval": "mod\/workshop\/eval"          "workshopeval": "mod/workshop/eval"
     }      }
} }





Andrewnicols: Add notes for subplugins.json b/c for older versions sharing a codebase
2020-03-11T23:25:54Z
Add notes for subplugins.json b/c for older versions sharing a codebase

				
				
				
				
				
				← Older revision
				Revision as of 23:25, 11 March 2020
				
Line 22:
Line 22:
     }      }
} }
</code>

If you have a plugin supporting multiple versions, then you should create the <tt>db/subplugins.json</tt> file, as well as a <tt>db/subplugins.php</tt> variant which contains the following:
<code php>
<?php

$subplugins = (array) json_decode(file_get_contents(__DIR__ . "/subplugins.json"))->plugintypes;
</code> </code>






Mudrd8mz: Add a note about the new JSON format for subplugins definition.
2019-11-14T16:40:53Z
Add a note about the new JSON format for subplugins definition.

				
				
				
				
				
				← Older revision
				Revision as of 16:40, 14 November 2019
				
Line 8:
Line 8:
* local plugins (since 2.6)   * local plugins (since 2.6)  
* admin tools (since 2.6) * admin tools (since 2.6)

===db/subplugins.json===

{{Moodle 3.8}}

Starting with Moodle 3.8, the subplugins should be defined in the <tt>db/subplugins.json</tt> file. For example, from  <tt>mod/workshop/db/subplugins.json</tt>:
<code json>
{
    "plugintypes": {
        "workshopform": "mod\/workshop\/form",
        "workshopallocation": "mod\/workshop\/allocation",
        "workshopeval": "mod\/workshop\/eval"
    }
}
</code>



===db/subplugins.php=== ===db/subplugins.php===



Howardsmiller: /* db/subplugins.php */
2014-03-10T11:20:05Z
db/subplugins.php

				
				
				
				
				
				← Older revision
				Revision as of 11:20, 10 March 2014
				
Line 11:
Line 11:
===db/subplugins.php=== ===db/subplugins.php===



Each activity module can define a set of sub-plugin 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>: Each activity module can define a set of sub-plugin '''types''' (not to be confused with the subplugins themselves) 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>:
<code php> <code php>
$subplugins = array( $subplugins = array(



Howardsmiller: /* Distribution of sub-plugins */
2014-03-10T11:17:42Z
Distribution of sub-plugins

				
				
				
				
				
				← Older revision
				Revision as of 11:17, 10 March 2014
				
Line 80:
Line 80:
===Distribution of sub-plugins=== ===Distribution of sub-plugins===



Basic se of sub-plugins is usually distributed with each add-on. It is also possible to submit add-on sub-plugins separately. Basic set of sub-plugins is usually distributed with each add-on. It is also possible to submit add-on sub-plugins separately.



[[Category:Plugins]] [[Category:Plugins]]



Quen: /* plugininfo class */
2014-01-30T13:55:06Z
plugininfo class

				
				
				
				
				
				← Older revision
				Revision as of 13:55, 30 January 2014
				
Line 53:
Line 53:
<code php> <code php>
namespace mod_feed\plugininfo; namespace mod_feed\plugininfo;
class feedview extends \core\plugininfo\base class feedview extends \core\plugininfo\base {
{ 
} }
</code> </code>

← Older revision		Revision as of 08:08, 15 July 2021
Line 14:		Line 14:

	Starting with Moodle 3.8, the subplugins should be defined in the <tt>db/subplugins.json</tt> file. For example, from <tt>mod/workshop/db/subplugins.json</tt>:		Starting with Moodle 3.8, the subplugins should be defined in the <tt>db/subplugins.json</tt> file. For example, from <tt>mod/workshop/db/subplugins.json</tt>:
	<~~code~~ json>		<syntaxhighlight lang="json">
	{		{
	"plugintypes": {		"plugintypes": {

← Older revision		Revision as of 13:38, 14 July 2021
Line 25:		Line 25:

	If you have a plugin supporting multiple versions, then you should create the <tt>db/subplugins.json</tt> file, as well as a <tt>db/subplugins.php</tt> variant which contains the following:		If you have a plugin supporting multiple versions, then you should create the <tt>db/subplugins.json</tt> file, as well as a <tt>db/subplugins.php</tt> variant which contains the following:
	<~~code~~ php>		<syntaxhighlight lang="php">
	<?php		<?php

Line 34:		Line 34:

	Each activity module can define a set of sub-plugin '''types''' (not to be confused with the subplugins themselves) 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>:		Each activity module can define a set of sub-plugin '''types''' (not to be confused with the subplugins themselves) 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>:
	<~~code~~ php>		<syntaxhighlight lang="php">
	$subplugins = array(		$subplugins = array(
	'workshopform' => 'mod/workshop/form',		'workshopform' => 'mod/workshop/form',
Line 47:		Line 47:

	You also need to add an entry in the module's language strings to identify the subplugin(s). Again, using an example from Workshop in <tt>mod/workshop/lang/en/workshop.php</tt> one can find:		You also need to add an entry in the module's language strings to identify the subplugin(s). Again, using an example from Workshop in <tt>mod/workshop/lang/en/workshop.php</tt> one can find:
	<~~code~~ php>		<syntaxhighlight lang="php">
	$string['subplugintype_workshopallocation'] = 'Submissions allocation method';		$string['subplugintype_workshopallocation'] = 'Submissions allocation method';
	$string['subplugintype_workshopallocation_plural'] = 'Submissions allocation methods';		$string['subplugintype_workshopallocation_plural'] = 'Submissions allocation methods';
Line 73:		Line 73:
	Here is an example of the class for a plugin called mod_feed and subtype called feedview (doc comments omitted for brevity):		Here is an example of the class for a plugin called mod_feed and subtype called feedview (doc comments omitted for brevity):

	<~~code~~ php>		<syntaxhighlight lang="php">
	namespace mod_feed\plugininfo;		namespace mod_feed\plugininfo;
	class feedview extends \core\plugininfo\base {		class feedview extends \core\plugininfo\base {

← Older revision		Revision as of 12:59, 12 March 2020
Line 17:		Line 17:
	{		{
	"plugintypes": {		"plugintypes": {
	"workshopform": "mod\/workshop\/form",		"workshopform": "mod/workshop/form",
	"workshopallocation": "mod\/workshop\/allocation",		"workshopallocation": "mod/workshop/allocation",
	"workshopeval": "mod\/workshop\/eval"		"workshopeval": "mod/workshop/eval"
	}		}
	}		}

← Older revision		Revision as of 23:25, 11 March 2020
Line 22:		Line 22:
	}		}
	}		}
			</code>

			If you have a plugin supporting multiple versions, then you should create the <tt>db/subplugins.json</tt> file, as well as a <tt>db/subplugins.php</tt> variant which contains the following:
			<code php>
			<?php

			$subplugins = (array) json_decode(file_get_contents(__DIR__ . "/subplugins.json"))->plugintypes;
	</code>		</code>

← Older revision		Revision as of 11:20, 10 March 2014
Line 11:		Line 11:
	===db/subplugins.php===		===db/subplugins.php===

	Each activity module can define a set of sub-plugin 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>:		Each activity module can define a set of sub-plugin '''types''' (not to be confused with the subplugins themselves) 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>:
	<code php>		<code php>
	$subplugins = array(		$subplugins = array(

← Older revision		Revision as of 11:17, 10 March 2014
Line 80:		Line 80:
	===Distribution of sub-plugins===		===Distribution of sub-plugins===

	Basic se of sub-plugins is usually distributed with each add-on. It is also possible to submit add-on sub-plugins separately.		Basic set of sub-plugins is usually distributed with each add-on. It is also possible to submit add-on sub-plugins separately.

	[[Category:Plugins]]		[[Category:Plugins]]

← Older revision		Revision as of 13:55, 30 January 2014
Line 53:		Line 53:
	<code php>		<code php>
	namespace mod_feed\plugininfo;		namespace mod_feed\plugininfo;
	class feedview extends \core\plugininfo\base		class feedview extends \core\plugininfo\base {
	{
	}		}
	</code>		</code>

Subplugins - Revision history

Mits: ja link

Mudrd8mz: Text replacement - "" to ""

Mudrd8mz: Text replacement - "" to ""

Mudrd8mz: Text replacement - "" to ""

Mudrd8mz: /* db/subplugins.json */ Remove the slashes escaping from the example to make it more readable (JSON does not need it, PHP json_encode does it by default for reasons that are not relevant for us)

Andrewnicols: Add notes for subplugins.json b/c for older versions sharing a codebase

Mudrd8mz: Add a note about the new JSON format for subplugins definition.

Howardsmiller: /* db/subplugins.php */

Howardsmiller: /* Distribution of sub-plugins */

Quen: /* plugininfo class */

Mudrd8mz: Text replacement - "`" to ""`

`Mudrd8mz: Text replacement - "`" to ""

Mudrd8mz: Text replacement - "`" to ""`