Course module - Revision history

Sarjona: This page will not be migrated to new devdocs

2024-05-03T14:23:11Z

This page will not be migrated to new devdocs

← Older revision		Revision as of 14:23, 3 May 2024
Line 1:		Line 1:
			{{Template:WillNotMigrate}}

	==Summary==		==Summary==
	A course module (often abbreviated 'cm') represents each of the activities and resources found in a course. It contains information about which course and section the activity / resource is displayed on, as well as details about the visibility, group and completion status of the activity.		A course module (often abbreviated 'cm') represents each of the activities and resources found in a course. It contains information about which course and section the activity / resource is displayed on, as well as details about the visibility, group and completion status of the activity.

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


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

				
				
				
				
				
				← Older revision
				Revision as of 13:31, 14 July 2021
				
Line 9:
Line 9:



You can quickly gather all of this information, by using the 'get_fast_modinfo($course)' function. The easiest way to understand the data returned is to use the following code: You can quickly gather all of this information, by using the 'get_fast_modinfo($course)' function. The easiest way to understand the data returned is to use the following code:
<code php> <syntaxhighlight lang="php">
global $DB; global $DB;
$course = $DB->get_record('course', array('id' => $courseid)); $course = $DB->get_record('course', array('id' => $courseid));

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

2021-07-14T13:05:06Z

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

← Older revision		Revision as of 13:05, 14 July 2021
Line 14:		Line 14:
	$info = get_fast_modinfo($course);		$info = get_fast_modinfo($course);
	print_object($info);		print_object($info);
	</~~code~~>		</syntaxhighlight>

	==Usage==		==Usage==

Richardnz at 20:44, 24 March 2021

2021-03-24T20:44:42Z

← Older revision		Revision as of 20:44, 24 March 2021
Line 30:		Line 30:
	* [http://phpdocs.moodle.org/HEAD/core/lib/cm_info.html cminfo PHPdocs]		* [http://phpdocs.moodle.org/HEAD/core/lib/cm_info.html cminfo PHPdocs]
	* [https://moodle.org/mod/forum/discuss.php?d=255653#p1108750 mdl_course_modules table forum discussion]		* [https://moodle.org/mod/forum/discuss.php?d=255653#p1108750 mdl_course_modules table forum discussion]
	* [https://moodle.org/mod/forum/discuss.php?d=420028#p1692768 Getting the module id from an instance]		* [https://moodle.org/mod/forum/discuss.php?d=420028#p1692768 Getting the module id from an instance forum discussion]

Richardnz: Added a note about getting module id from instance.

2021-03-24T20:42:23Z

Added a note about getting module id from instance.

← Older revision		Revision as of 20:42, 24 March 2021
Line 21:		Line 21:
	* To get the 'context' for the module (used when checking user capabilities or linking files to an activity), via the function call 'context_module::instance($cmid)' (before Moodle 2.2 this was 'get_context_instance(CONTEXT_MODULE, $cmid)')		* To get the 'context' for the module (used when checking user capabilities or linking files to an activity), via the function call 'context_module::instance($cmid)' (before Moodle 2.2 this was 'get_context_instance(CONTEXT_MODULE, $cmid)')
	* Every log entry in 'mdl_log' that relates to a specific activity has the 'cmid' field set		* Every log entry in 'mdl_log' that relates to a specific activity has the 'cmid' field set

			==Note==
			You can also get the course module id from a module instance, for example see: https://github.com/moodle/moodle/blob/master/mod/page/view.php#L36.

	==More documentation==		==More documentation==
Line 27:		Line 30:
	* [http://phpdocs.moodle.org/HEAD/core/lib/cm_info.html cminfo PHPdocs]		* [http://phpdocs.moodle.org/HEAD/core/lib/cm_info.html cminfo PHPdocs]
	* [https://moodle.org/mod/forum/discuss.php?d=255653#p1108750 mdl_course_modules table forum discussion]		* [https://moodle.org/mod/forum/discuss.php?d=255653#p1108750 mdl_course_modules table forum discussion]
			* [https://moodle.org/mod/forum/discuss.php?d=420028#p1692768 Getting the module id from an instance]

Libertymoodle: /* url */

2020-06-24T06:34:23Z

url

← Older revision		Revision as of 06:34, 24 June 2020
Line 26:		Line 26:
	* [http://phpdocs.moodle.org/HEAD/core/lib/course_modinfo.html course_modinfo PHPdocs]		* [http://phpdocs.moodle.org/HEAD/core/lib/course_modinfo.html course_modinfo PHPdocs]
	* [http://phpdocs.moodle.org/HEAD/core/lib/cm_info.html cminfo PHPdocs]		* [http://phpdocs.moodle.org/HEAD/core/lib/cm_info.html cminfo PHPdocs]
	* [https://moodle.org/mod/forum/discuss.php?d=255653 mdl_course_modules table forum discussion]		* [https://moodle.org/mod/forum/discuss.php?d=255653#p1108750 mdl_course_modules table forum discussion]

Libertymoodle: /* Add mdl_course_modules forum discussion link */

2020-06-23T08:16:44Z

Add mdl_course_modules forum discussion link

← Older revision		Revision as of 08:16, 23 June 2020
Line 26:		Line 26:
	* [http://phpdocs.moodle.org/HEAD/core/lib/course_modinfo.html course_modinfo PHPdocs]		* [http://phpdocs.moodle.org/HEAD/core/lib/course_modinfo.html course_modinfo PHPdocs]
	* [http://phpdocs.moodle.org/HEAD/core/lib/cm_info.html cminfo PHPdocs]		* [http://phpdocs.moodle.org/HEAD/core/lib/cm_info.html cminfo PHPdocs]
			* [https://moodle.org/mod/forum/discuss.php?d=255653 mdl_course_modules table forum discussion]

Davosmith: /* Database tables */

2013-09-26T14:21:13Z

Database tables

← Older revision		Revision as of 14:21, 26 September 2013
Line 3:		Line 3:

	==Database tables==		==Database tables==
	The data for the course module is stored in the database table 'mdl_course_modules' (the 'mdl_' part will be different if you have chosen a non-default prefix for your database tables). ~~This~~ fields in this table link it to a number of other tables in the database. The 'course' field links to the 'mdl_course' table, which contains everything you need to know about a course. The 'module' table links to the 'mdl_modules' table, which gives information about the type of the module (e.g. 'quiz', 'resource') as well as its current version number. After looking up the type of the module, the rest of the details about this module can be found by looking up the 'instance' value (from the 'mdl_course_modules' table) in the 'mdl_{type}' table. Here you can find the name and introductory paragraph for the activity / resource, as well as information that is specific to the type of activity being looked at.		The data for the course module is stored in the database table 'mdl_course_modules' (the 'mdl_' part will be different if you have chosen a non-default prefix for your database tables). The fields in this table link it to a number of other tables in the database.
			* The 'course' field links to the 'mdl_course' table, which contains everything you need to know about a course.
			* The 'module' table links to the 'mdl_modules' table, which gives information about the type of the module (e.g. 'quiz', 'resource') as well as its current version number.
			* After looking up the type of the module, the rest of the details about this module can be found by looking up the 'instance' value (from the 'mdl_course_modules' table) in the 'mdl_{type}' table. Here you can find the name and introductory paragraph for the activity / resource, as well as information that is specific to the type of activity being looked at.

	You can quickly gather all of this information, by using the 'get_fast_modinfo($course)' function. The easiest way to understand the data returned is to use the following code:		You can quickly gather all of this information, by using the 'get_fast_modinfo($course)' function. The easiest way to understand the data returned is to use the following code:

Davosmith: Created page with "==Summary== A course module (often abbreviated 'cm') represents each of the activities and resources found in a course. It contains information about which course and section the..."

2012-03-02T08:00:09Z

Created page with "==Summary== A course module (often abbreviated 'cm') represents each of the activities and resources found in a course. It contains information about which course and section the..."

New page

==Summary==
A course module (often abbreviated 'cm') represents each of the activities and resources found in a course. It contains information about which course and section the activity / resource is displayed on, as well as details about the visibility, group and completion status of the activity.

==Database tables==
The data for the course module is stored in the database table 'mdl_course_modules' (the 'mdl_' part will be different if you have chosen a non-default prefix for your database tables). This fields in this table link it to a number of other tables in the database. The 'course' field links to the 'mdl_course' table, which contains everything you need to know about a course. The 'module' table links to the 'mdl_modules' table, which gives information about the type of the module (e.g. 'quiz', 'resource') as well as its current version number. After looking up the type of the module, the rest of the details about this module can be found by looking up the 'instance' value (from the 'mdl_course_modules' table) in the 'mdl_{type}' table. Here you can find the name and introductory paragraph for the activity / resource, as well as information that is specific to the type of activity being looked at.

You can quickly gather all of this information, by using the 'get_fast_modinfo($course)' function. The easiest way to understand the data returned is to use the following code:
<code php>
global $DB;
$course = $DB->get_record('course', array('id' => $courseid));
$info = get_fast_modinfo($course);
print_object($info);
</code>

==Usage==
The cmid (course module id) is used widely throughout Moodle to identify a specific activity / resource. Some of the most important uses are:
* When linking to a modules 'view.php' script, it is passed as the 'id' parameter
* To get the 'context' for the module (used when checking user capabilities or linking files to an activity), via the function call 'context_module::instance($cmid)' (before Moodle 2.2 this was 'get_context_instance(CONTEXT_MODULE, $cmid)')
* Every log entry in 'mdl_log' that relates to a specific activity has the 'cmid' field set

==More documentation==
* [[Module visibility and display]]
* [http://phpdocs.moodle.org/HEAD/core/lib/course_modinfo.html course_modinfo PHPdocs]
* [http://phpdocs.moodle.org/HEAD/core/lib/cm_info.html cminfo PHPdocs]

← Older revision		Revision as of 13:31, 14 July 2021
Line 9:		Line 9:

	You can quickly gather all of this information, by using the 'get_fast_modinfo($course)' function. The easiest way to understand the data returned is to use the following code:		You can quickly gather all of this information, by using the 'get_fast_modinfo($course)' function. The easiest way to understand the data returned is to use the following code:
	<~~code~~ php>		<syntaxhighlight lang="php">
	global $DB;		global $DB;
	$course = $DB->get_record('course', array('id' => $courseid));		$course = $DB->get_record('course', array('id' => $courseid));