Devdocsbot: Protected "Activity modules": Developer Docs Migration ([Edit=Allow only administrators] (indefinite))

2022-05-18T02:38:34Z

Protected "Activity modules": Developer Docs Migration ([Edit=Allow only administrators] (indefinite))

← Older revision	Revision as of 02:38, 18 May 2022
(No difference)

Devdocsbot: Update migration status and path

2022-05-18T02:37:59Z

Update migration status and path

← Older revision		Revision as of 02:37, 18 May 2022
Line 1:		Line 1:
			{{Template:Migrated\|newDocId=/docs/apis/plugintypes/mod}}
	== Introduction ==		== Introduction ==

Andrewnicols: Testing - sorry for the noise!

2022-05-18T02:37:25Z

Testing - sorry for the noise!

← Older revision		Revision as of 02:37, 18 May 2022
Line 1:		Line 1:
	~~{{Template:Migrated\|newDocId=/docs/apis/plugintypes/mod}}~~
	== Introduction ==		== Introduction ==

Andrewnicols: Removed protection from "Activity modules": Testing migration process

2022-05-18T02:37:13Z

Removed protection from "Activity modules": Testing migration process

← Older revision	Revision as of 02:37, 18 May 2022
(No difference)

Devdocsbot: Protected "Activity modules": Developer Docs Migration ([Edit=Allow only administrators] (indefinite))

2022-05-06T08:08:13Z

Protected "Activity modules": Developer Docs Migration ([Edit=Allow only administrators] (indefinite))

← Older revision	Revision as of 08:08, 6 May 2022
(No difference)

Andrewnicols: Removed protection from "Activity modules"

2022-05-06T07:59:21Z

Removed protection from "Activity modules"

← Older revision	Revision as of 07:59, 6 May 2022
(No difference)

Devdocsbot: Protected "Activity modules": Developer Docs Migration ([Edit=Allow only administrators] (indefinite))

2022-05-06T07:26:54Z

Protected "Activity modules": Developer Docs Migration ([Edit=Allow only administrators] (indefinite))

← Older revision	Revision as of 07:26, 6 May 2022
(No difference)

Andrewnicols: Note migration to new docs

2022-04-14T03:15:15Z

Note migration to new docs

← Older revision		Revision as of 03:15, 14 April 2022
Line 1:		Line 1:
			{{Template:Migrated\|newDocId=/docs/apis/plugintypes/mod}}
	== Introduction ==		== Introduction ==

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


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

				
				
				
				
				
				← Older revision
				Revision as of 13:29, 14 July 2021
				
Line 47:
Line 47:
We also recommend that every activity module also provides a 'mod/<modname>:view' capability to control visibility.  (See MDL-40854) We also recommend that every activity module also provides a 'mod/<modname>:view' capability to control visibility.  (See MDL-40854)



For consistency and ease of use for the teachers it is advisable to use the following archetypes with the <code php>mod/<modname>:view</syntaxhighlight> capability: For consistency and ease of use for the teachers it is advisable to use the following archetypes with the <syntaxhighlight lang="php">mod/<modname>:view</syntaxhighlight> capability:






<code php> <syntaxhighlight lang="php">
'mod/MODULENAME:view' => array( 'mod/MODULENAME:view' => array(
     'captype' => 'read',      'captype' => 'read',
Line 73:
Line 73:
Example - mod/quiz/db/events.php Example - mod/quiz/db/events.php



<code php> <syntaxhighlight lang="php">
$observers = [ $observers = [
     [      [
Line 92:
Line 92:
An example of the file generated by the [[XMLDB_editor]] is below - it contains the structure of the table certificate and certificate_issues: An example of the file generated by the [[XMLDB_editor]] is below - it contains the structure of the table certificate and certificate_issues:



<code php> <syntaxhighlight lang="php">
<?xml version="1.0" encoding="UTF-8" ?> <?xml version="1.0" encoding="UTF-8" ?>
<XMLDB PATH="mod/certificate/db" VERSION="20120925" COMMENT="XMLDB file for Moodle mod/certificate" <XMLDB PATH="mod/certificate/db" VERSION="20120925" COMMENT="XMLDB file for Moodle mod/certificate"
Line 185:
Line 185:
An example of the upgrade.php file is as follows - An example of the upgrade.php file is as follows -



<code php> <syntaxhighlight lang="php">
function xmldb_certificate_upgrade($oldversion=0) { function xmldb_certificate_upgrade($oldversion=0) {
     if ($oldversion < 2012091800) {      if ($oldversion < 2012091800) {
Line 242:
Line 242:
This is where you store any strings you are going to use in your plugin. Each language has a specific folder that needs to be created in order for it to be used with your module. In this case we are going to use the English language (since unfortunately it is the only one I know). A folder called en is created in your lang folder that contains a file called <modname>.php that lists the translations of your string. For example, your module may have a setting called 'User preferences', rather than hard coding this term in your form, you use a placeholder that will then retrieve the appropriate string depending on the language being used on your Moodle site. There is one mandatory placeholder for modules called 'pluginname' that Moodle will use when listing this module as an option to add to a course and other various pages. To keep with Moodle standards you should order your strings alphabetically by the placeholder name. This is where you store any strings you are going to use in your plugin. Each language has a specific folder that needs to be created in order for it to be used with your module. In this case we are going to use the English language (since unfortunately it is the only one I know). A folder called en is created in your lang folder that contains a file called <modname>.php that lists the translations of your string. For example, your module may have a setting called 'User preferences', rather than hard coding this term in your form, you use a placeholder that will then retrieve the appropriate string depending on the language being used on your Moodle site. There is one mandatory placeholder for modules called 'pluginname' that Moodle will use when listing this module as an option to add to a course and other various pages. To keep with Moodle standards you should order your strings alphabetically by the placeholder name.



<code php> <syntaxhighlight lang="php">
$string['pluginname'] = 'Certificate'; $string['pluginname'] = 'Certificate';
$string['userpreferences'] = 'User preferences'; $string['userpreferences'] = 'User preferences';
Line 249:
Line 249:
If you wanted to add the French translation you would create a folder called fr and add the file <modname>.php to it. If you wanted to add the French translation you would create a folder called fr and add the file <modname>.php to it.



<code php> <syntaxhighlight lang="php">
$string['pluginname'] = 'Certificat'; $string['pluginname'] = 'Certificat';
$string['userpreferences'] = 'Préférences d\'utilisateur'; $string['userpreferences'] = 'Préférences d\'utilisateur';
Line 256:
Line 256:
Now, when using the string 'User preferences' we will use the Moodle function get_string instead, which will get the appropriate string depending on the language being used. Now, when using the string 'User preferences' we will use the Moodle function get_string instead, which will get the appropriate string depending on the language being used.



<code php> <syntaxhighlight lang="php">
get_string('userpreferences', 'certificate'); get_string('userpreferences', 'certificate');
</syntaxhighlight> </syntaxhighlight>
Line 270:
Line 270:
The list of functions that are possible to override in the lib.php are listed here [[NEWMODULE_Documentation#lib.php]]. The essential ones are listed below The list of functions that are possible to override in the lib.php are listed here [[NEWMODULE_Documentation#lib.php]]. The essential ones are listed below



<code php> <syntaxhighlight lang="php">
function certificate_add_instance($certificate); function certificate_add_instance($certificate);
function certificate_update_instance($certificate); function certificate_update_instance($certificate);
Line 284:
Line 284:
This file is used when adding/editing a module to a course. It contains the elements that will be displayed on the form responsible for creating/installing an instance of your module. The class in the file should be called mod_<modname>_mod_form. This file is used when adding/editing a module to a course. It contains the elements that will be displayed on the form responsible for creating/installing an instance of your module. The class in the file should be called mod_<modname>_mod_form.



<code php> <syntaxhighlight lang="php">
if (!defined('MOODLE_INTERNAL')) { if (!defined('MOODLE_INTERNAL')) {
     die('Direct access to this script is forbidden.');    ///  It must be included from a Moodle page      die('Direct access to this script is forbidden.');    ///  It must be included from a Moodle page
Line 322:
Line 322:
This page is used by Moodle when listing all the instances of your module that are in a particular course with the course id being passed to this script. The beginning of the page should contain the following - This page is used by Moodle when listing all the instances of your module that are in a particular course with the course id being passed to this script. The beginning of the page should contain the following -



<code php> <syntaxhighlight lang="php">
require_once('../../config.php'); require_once('../../config.php');



Line 339:
Line 339:
When a course renders its page layout and activities it generates the links to view them using the view.php script, so the links will look like <wwwrootofyoursite>/mod/<modname>/view.php?id=4, where 4 is the course module id. For the certificate example the beginning of the view.php page looks like the following - When a course renders its page layout and activities it generates the links to view them using the view.php script, so the links will look like <wwwrootofyoursite>/mod/<modname>/view.php?id=4, where 4 is the course module id. For the certificate example the beginning of the view.php page looks like the following -



<code php> <syntaxhighlight lang="php">
require_once('../../config.php'); require_once('../../config.php');
require_once('lib.php'); require_once('lib.php');
Line 360:
Line 360:
If you are using Moodle 2.8 and above, there is a better way to achieve most of this using a new function: If you are using Moodle 2.8 and above, there is a better way to achieve most of this using a new function:



<code php> <syntaxhighlight lang="php">
require('../../config.php'); require('../../config.php');
require_once('lib.php'); require_once('lib.php');

← Older revision		Revision as of 13:22, 14 July 2021
Line 142:		Line 142:
	There are some fields that the Moodle core expects to be present in every activity module's main table (or just became de-facto standard):		There are some fields that the Moodle core expects to be present in every activity module's main table (or just became de-facto standard):

	{\| class="~~nicetable~~"		{\| class="wikitable"
	\|-		\|-
	! Field name		! Field name

Activity modules - Revision history

Devdocsbot: Protected "Activity modules": Developer Docs Migration ([Edit=Allow only administrators] (indefinite))

Devdocsbot: Update migration status and path

Andrewnicols: Testing - sorry for the noise!

Andrewnicols: Removed protection from "Activity modules": Testing migration process

Devdocsbot: Protected "Activity modules": Developer Docs Migration ([Edit=Allow only administrators] (indefinite))

Andrewnicols: Removed protection from "Activity modules"

Devdocsbot: Protected "Activity modules": Developer Docs Migration ([Edit=Allow only administrators] (indefinite))

Andrewnicols: Note migration to new docs

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

Mudrd8mz: Text replacement - "class="nicetable"" to "class="wikitable""

← Older revision		Revision as of 13:29, 14 July 2021
Line 47:		Line 47:
	We also recommend that every activity module also provides a 'mod/<modname>:view' capability to control visibility. (See MDL-40854)		We also recommend that every activity module also provides a 'mod/<modname>:view' capability to control visibility. (See MDL-40854)

	For consistency and ease of use for the teachers it is advisable to use the following archetypes with the <~~code~~ php>mod/<modname>:view</syntaxhighlight> capability:		For consistency and ease of use for the teachers it is advisable to use the following archetypes with the <syntaxhighlight lang="php">mod/<modname>:view</syntaxhighlight> capability:


	<~~code~~ php>		<syntaxhighlight lang="php">
	'mod/MODULENAME:view' => array(		'mod/MODULENAME:view' => array(
	'captype' => 'read',		'captype' => 'read',
Line 73:		Line 73:
	Example - mod/quiz/db/events.php		Example - mod/quiz/db/events.php

	<~~code~~ php>		<syntaxhighlight lang="php">
	$observers = [		$observers = [
	[		[
Line 92:		Line 92:
	An example of the file generated by the [[XMLDB_editor]] is below - it contains the structure of the table certificate and certificate_issues:		An example of the file generated by the [[XMLDB_editor]] is below - it contains the structure of the table certificate and certificate_issues:

	<~~code~~ php>		<syntaxhighlight lang="php">
	<?xml version="1.0" encoding="UTF-8" ?>		<?xml version="1.0" encoding="UTF-8" ?>
	<XMLDB PATH="mod/certificate/db" VERSION="20120925" COMMENT="XMLDB file for Moodle mod/certificate"		<XMLDB PATH="mod/certificate/db" VERSION="20120925" COMMENT="XMLDB file for Moodle mod/certificate"
Line 185:		Line 185:
	An example of the upgrade.php file is as follows -		An example of the upgrade.php file is as follows -

	<~~code~~ php>		<syntaxhighlight lang="php">
	function xmldb_certificate_upgrade($oldversion=0) {		function xmldb_certificate_upgrade($oldversion=0) {
	if ($oldversion < 2012091800) {		if ($oldversion < 2012091800) {
Line 242:		Line 242:
	This is where you store any strings you are going to use in your plugin. Each language has a specific folder that needs to be created in order for it to be used with your module. In this case we are going to use the English language (since unfortunately it is the only one I know). A folder called en is created in your lang folder that contains a file called <modname>.php that lists the translations of your string. For example, your module may have a setting called 'User preferences', rather than hard coding this term in your form, you use a placeholder that will then retrieve the appropriate string depending on the language being used on your Moodle site. There is one mandatory placeholder for modules called 'pluginname' that Moodle will use when listing this module as an option to add to a course and other various pages. To keep with Moodle standards you should order your strings alphabetically by the placeholder name.		This is where you store any strings you are going to use in your plugin. Each language has a specific folder that needs to be created in order for it to be used with your module. In this case we are going to use the English language (since unfortunately it is the only one I know). A folder called en is created in your lang folder that contains a file called <modname>.php that lists the translations of your string. For example, your module may have a setting called 'User preferences', rather than hard coding this term in your form, you use a placeholder that will then retrieve the appropriate string depending on the language being used on your Moodle site. There is one mandatory placeholder for modules called 'pluginname' that Moodle will use when listing this module as an option to add to a course and other various pages. To keep with Moodle standards you should order your strings alphabetically by the placeholder name.

	<~~code~~ php>		<syntaxhighlight lang="php">
	$string['pluginname'] = 'Certificate';		$string['pluginname'] = 'Certificate';
	$string['userpreferences'] = 'User preferences';		$string['userpreferences'] = 'User preferences';
Line 249:		Line 249:
	If you wanted to add the French translation you would create a folder called fr and add the file <modname>.php to it.		If you wanted to add the French translation you would create a folder called fr and add the file <modname>.php to it.

	<~~code~~ php>		<syntaxhighlight lang="php">
	$string['pluginname'] = 'Certificat';		$string['pluginname'] = 'Certificat';
	$string['userpreferences'] = 'Préférences d\'utilisateur';		$string['userpreferences'] = 'Préférences d\'utilisateur';
Line 256:		Line 256:
	Now, when using the string 'User preferences' we will use the Moodle function get_string instead, which will get the appropriate string depending on the language being used.		Now, when using the string 'User preferences' we will use the Moodle function get_string instead, which will get the appropriate string depending on the language being used.

	<~~code~~ php>		<syntaxhighlight lang="php">
	get_string('userpreferences', 'certificate');		get_string('userpreferences', 'certificate');
	</syntaxhighlight>		</syntaxhighlight>
Line 270:		Line 270:
	The list of functions that are possible to override in the lib.php are listed here [[NEWMODULE_Documentation#lib.php]]. The essential ones are listed below		The list of functions that are possible to override in the lib.php are listed here [[NEWMODULE_Documentation#lib.php]]. The essential ones are listed below

	<~~code~~ php>		<syntaxhighlight lang="php">
	function certificate_add_instance($certificate);		function certificate_add_instance($certificate);
	function certificate_update_instance($certificate);		function certificate_update_instance($certificate);
Line 284:		Line 284:
	This file is used when adding/editing a module to a course. It contains the elements that will be displayed on the form responsible for creating/installing an instance of your module. The class in the file should be called mod_<modname>_mod_form.		This file is used when adding/editing a module to a course. It contains the elements that will be displayed on the form responsible for creating/installing an instance of your module. The class in the file should be called mod_<modname>_mod_form.

	<~~code~~ php>		<syntaxhighlight lang="php">
	if (!defined('MOODLE_INTERNAL')) {		if (!defined('MOODLE_INTERNAL')) {
	die('Direct access to this script is forbidden.'); /// It must be included from a Moodle page		die('Direct access to this script is forbidden.'); /// It must be included from a Moodle page
Line 322:		Line 322:
	This page is used by Moodle when listing all the instances of your module that are in a particular course with the course id being passed to this script. The beginning of the page should contain the following -		This page is used by Moodle when listing all the instances of your module that are in a particular course with the course id being passed to this script. The beginning of the page should contain the following -

	<~~code~~ php>		<syntaxhighlight lang="php">
	require_once('../../config.php');		require_once('../../config.php');

Line 339:		Line 339:
	When a course renders its page layout and activities it generates the links to view them using the view.php script, so the links will look like <wwwrootofyoursite>/mod/<modname>/view.php?id=4, where 4 is the course module id. For the certificate example the beginning of the view.php page looks like the following -		When a course renders its page layout and activities it generates the links to view them using the view.php script, so the links will look like <wwwrootofyoursite>/mod/<modname>/view.php?id=4, where 4 is the course module id. For the certificate example the beginning of the view.php page looks like the following -

	<~~code~~ php>		<syntaxhighlight lang="php">
	require_once('../../config.php');		require_once('../../config.php');
	require_once('lib.php');		require_once('lib.php');
Line 360:		Line 360:
	If you are using Moodle 2.8 and above, there is a better way to achieve most of this using a new function:		If you are using Moodle 2.8 and above, there is a better way to achieve most of this using a new function:

	<~~code~~ php>		<syntaxhighlight lang="php">
	require('../../config.php');		require('../../config.php');
	require_once('lib.php');		require_once('lib.php');

Activity modules - Revision history

Devdocsbot: Protected "Activity modules": Developer Docs Migration ([Edit=Allow only administrators] (indefinite))

Devdocsbot: Update migration status and path

Andrewnicols: Testing - sorry for the noise!

Andrewnicols: Removed protection from "Activity modules": Testing migration process

Devdocsbot: Protected "Activity modules": Developer Docs Migration ([Edit=Allow only administrators] (indefinite))

Andrewnicols: Removed protection from "Activity modules"

Devdocsbot: Protected "Activity modules": Developer Docs Migration ([Edit=Allow only administrators] (indefinite))

Andrewnicols: Note migration to new docs

Mudrd8mz: Text replacement - "" to ""

Mudrd8mz: Text replacement - "class="nicetable"" to "class="wikitable""

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