Module visibility and display - Revision history

Devdocsbot: Protected "Module visibility and display": Developer Docs Migration ([Edit=Allow only administrators] (indefinite))

2023-07-10T14:48:30Z

Protected "Module visibility and display": Developer Docs Migration ([Edit=Allow only administrators] (indefinite))

← Older revision	Revision as of 14:48, 10 July 2023
(No difference)

Devdocsbot: Update migration status and path

2023-07-10T14:46:18Z

Update migration status and path

Show changes

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


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

				
				
				
				
				
				← Older revision
				Revision as of 13:28, 14 July 2021
				
Line 35:
Line 35:
The function should return a value of class <tt>cached_cm_info</tt>. For example: The function should return a value of class <tt>cached_cm_info</tt>. For example:



<code php> <syntaxhighlight lang="php">
function mod_frog_get_coursemodule_info($cm) { function mod_frog_get_coursemodule_info($cm) {
     $info = new cached_cm_info();      $info = new cached_cm_info();
Line 60:
Line 60:
You can customise module display dynamically (when the page loads). For example you might want to alter it based on the permissions of the current user. You can customise module display dynamically (when the page loads). For example you might want to alter it based on the permissions of the current user.



<code php> <syntaxhighlight lang="php">
function mod_frog_cm_info_dynamic(cm_info $cm) { function mod_frog_cm_info_dynamic(cm_info $cm) {
     $context = get_context_instance(CONTEXT_MODULE, $cm->id);      $context = get_context_instance(CONTEXT_MODULE, $cm->id);
Line 79:
Line 79:
Sometimes you need to display custom information for the current user that appears only on the course view page. For example, the forum module displays unread information on the view page. This information doesn't show on other pages (it isn't included in the navigation, for instance). Sometimes you need to display custom information for the current user that appears only on the course view page. For example, the forum module displays unread information on the view page. This information doesn't show on other pages (it isn't included in the navigation, for instance).



<code php> <syntaxhighlight lang="php">
function mod_frog_cm_info_view(cm_info $cm) { function mod_frog_cm_info_view(cm_info $cm) {
     $cm->set_after_link('Last tadpole: 22:17');      $cm->set_after_link('Last tadpole: 22:17');
Line 97:
Line 97:
In addition to the old methods for obtaining data from $modinfo, there are some new functions. For example, here is how to get a single cm_info from $modinfo: In addition to the old methods for obtaining data from $modinfo, there are some new functions. For example, here is how to get a single cm_info from $modinfo:



<code php> <syntaxhighlight lang="php">
$modinfo = get_fast_modinfo($course); $modinfo = get_fast_modinfo($course);
$cm = $modinfo->get_cm($cmid); $cm = $modinfo->get_cm($cmid);
Line 104:
Line 104:
The cm_info objects contain additional information that is not present in the course_modules database row, such as the module's name, and the icon and associated content mentioned above. In order to distinguish these from the plain database objects, you can specify the cm_info class in a function definition: The cm_info objects contain additional information that is not present in the course_modules database row, such as the module's name, and the icon and associated content mentioned above. In order to distinguish these from the plain database objects, you can specify the cm_info class in a function definition:



<code php> <syntaxhighlight lang="php">
function my_clever_function(cm_info $cm) { function my_clever_function(cm_info $cm) {
     if (!$cm->uservisible) {      if (!$cm->uservisible) {

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

2021-07-14T13:06:04Z

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

← Older revision		Revision as of 13:06, 14 July 2021
Line 41:		Line 41:
	return $info;		return $info;
	}		}
	</~~code~~>		</syntaxhighlight>

	You can change several properties which are documented in that class definition. If you don't change a property, its value remains default.		You can change several properties which are documented in that class definition. If you don't change a property, its value remains default.
Line 67:		Line 67:
	}		}
	}		}
	</~~code~~>		</syntaxhighlight>

	This code can affect the navigation, and whether users are permitted to access the module (as above). It runs on all pages within the course, so it's very important that you do not put slow code in this function: it should not make any database queries.		This code can affect the navigation, and whether users are permitted to access the module (as above). It runs on all pages within the course, so it's very important that you do not put slow code in this function: it should not make any database queries.
Line 83:		Line 83:
	$cm->set_after_link('Last tadpole: 22:17');		$cm->set_after_link('Last tadpole: 22:17');
	}		}
	</~~code~~>		</syntaxhighlight>

	Because this function only runs when looking at the course page:		Because this function only runs when looking at the course page:
Line 100:		Line 100:
	$modinfo = get_fast_modinfo($course);		$modinfo = get_fast_modinfo($course);
	$cm = $modinfo->get_cm($cmid);		$cm = $modinfo->get_cm($cmid);
	</~~code~~>		</syntaxhighlight>

	The cm_info objects contain additional information that is not present in the course_modules database row, such as the module's name, and the icon and associated content mentioned above. In order to distinguish these from the plain database objects, you can specify the cm_info class in a function definition:		The cm_info objects contain additional information that is not present in the course_modules database row, such as the module's name, and the icon and associated content mentioned above. In order to distinguish these from the plain database objects, you can specify the cm_info class in a function definition:
Line 111:		Line 111:
	}		}
	}		}
	</~~code~~>		</syntaxhighlight>

	By specifying cm_info in the parameter list, you'll cause PHP to give an error if anyone tries to call that function with a $cm object that just came from the database row, instead of from <tt>get_fast_modinfo</tt>. (It is good practice to always get $cm from get_fast_modinfo, but there might be exceptions.)		By specifying cm_info in the parameter list, you'll cause PHP to give an error if anyone tries to call that function with a $cm object that just came from the database row, instead of from <tt>get_fast_modinfo</tt>. (It is good practice to always get $cm from get_fast_modinfo, but there might be exceptions.)

Maherne at 08:59, 9 August 2013

2013-08-09T08:59:13Z

← Older revision		Revision as of 08:59, 9 August 2013
Line 54:		Line 54:
	If you don't need the information to be cached (it can be retrieved very quickly without making any database queries) then you might consider using one of the functions below instead, in order to avoid unnecessarily increasing the size of the course cache. Although the headings mention the current user, you can of course use those functions in a way that doesn't depend on the current user.		If you don't need the information to be cached (it can be retrieved very quickly without making any database queries) then you might consider using one of the functions below instead, in order to avoid unnecessarily increasing the size of the course cache. Although the headings mention the current user, you can of course use those functions in a way that doesn't depend on the current user.

	Don't use renderers in this function (see MDL-41074). If you have data you would like to render onto the course page, put it into the custom data property and render it in the MODNAME_cm_info_view() function (see below).		Don't use renderers in this function (see MDL-41074). If you have data you would like to render onto the course page, put it into the custom data property and render it in the MODNAME_cm_info_view() function (see below). For an example, see mod_folder (version > 2013012100).

	== Customising module display, for current user ==		== Customising module display, for current user ==

Maherne at 08:12, 9 August 2013

2013-08-09T08:12:24Z

← Older revision		Revision as of 08:12, 9 August 2013
Line 53:		Line 53:

	If you don't need the information to be cached (it can be retrieved very quickly without making any database queries) then you might consider using one of the functions below instead, in order to avoid unnecessarily increasing the size of the course cache. Although the headings mention the current user, you can of course use those functions in a way that doesn't depend on the current user.		If you don't need the information to be cached (it can be retrieved very quickly without making any database queries) then you might consider using one of the functions below instead, in order to avoid unnecessarily increasing the size of the course cache. Although the headings mention the current user, you can of course use those functions in a way that doesn't depend on the current user.

			Don't use renderers in this function (see MDL-41074). If you have data you would like to render onto the course page, put it into the custom data property and render it in the MODNAME_cm_info_view() function (see below).

	== Customising module display, for current user ==		== Customising module display, for current user ==

Marina.glancy: /* Customising module display, in cache */

2013-08-09T00:06:20Z

Customising module display, in cache

← Older revision		Revision as of 00:06, 9 August 2013
Line 48:		Line 48:
	* <tt>icon</tt>, <tt>iconcomponent</tt> - name and component name of icon to display by the link.		* <tt>icon</tt>, <tt>iconcomponent</tt> - name and component name of icon to display by the link.
	* <tt>content</tt> - extra HTML content to display below the module link on course page (not shown in navigation etc).		* <tt>content</tt> - extra HTML content to display below the module link on course page (not shown in navigation etc).
	* <tt>customdata</tt> - arbitrary extra PHP data to store in modinfo cache; useful if, for performance reasons, your module needs to store data that should be accessible very quickly from other parts of the course.		* <tt>customdata</tt> - arbitrary extra PHP data to store in modinfo cache; useful if, for performance reasons, your module needs to store data that should be accessible very quickly from other parts of the course. Warning: Do not store complex objects here because when they are serialized (together with all other data) they may contain \0 byte and it causes fatal error on Postgres.
	* <tt>extraclasses</tt> - extra CSS class or classes that will be added to the activity on the main page, so that you can alter the styling.		* <tt>extraclasses</tt> - extra CSS class or classes that will be added to the activity on the main page, so that you can alter the styling.
	* <tt>onclick</tt> - already-escaped HTML that will be inserted as the value of the onclick attribute.		* <tt>onclick</tt> - already-escaped HTML that will be inserted as the value of the onclick attribute.

TimHunt: /* Customising module display, in cache */

2011-02-17T11:08:00Z

Customising module display, in cache

← Older revision		Revision as of 11:08, 17 February 2011
Line 37:		Line 37:
	<code php>		<code php>
	function mod_frog_get_coursemodule_info($cm) {		function mod_frog_get_coursemodule_info($cm) {
	$info = new cached_cm_info;		$info = new cached_cm_info();
	$info->content = '<p>This will display below the module.</p>';		$info->content = '<p>This will display below the module.</p>';
	return $info;		return $info;

TimHunt: /* More documentation */

2011-02-17T11:07:31Z

Quen: /* get_fast_modinfo data */

2011-02-16T18:17:24Z

get_fast_modinfo data

← Older revision		Revision as of 18:17, 16 February 2011
Line 93:		Line 93:
	The function <tt>get_fast_modinfo</tt> now returns an object of class course_modinfo, which itself contains cm_info objects about each activity. (These are entirely backward-compatible with the previous return value.)		The function <tt>get_fast_modinfo</tt> now returns an object of class course_modinfo, which itself contains cm_info objects about each activity. (These are entirely backward-compatible with the previous return value.)

	~~Please see~~ the ~~documentation~~ for ~~more information about these classes. All fields are now documented and~~ there are some new functions. For example, here is how to get a single cm_info from $modinfo:		In addition to the old methods for obtaining data from $modinfo, there are some new functions. For example, here is how to get a single cm_info from $modinfo:

	<code php>		<code php>

← Older revision		Revision as of 11:07, 17 February 2011
Line 118:		Line 118:

	All three classes for this API are in the core file <tt>lib/modinfolib.php</tt> and contain complete PHPdoc information for all fields and functions.		All three classes for this API are in the core file <tt>lib/modinfolib.php</tt> and contain complete PHPdoc information for all fields and functions.

			* [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/cached_cm_info.html cached_cm_info PHPdocs]

← Older revision		Revision as of 13:28, 14 July 2021
Line 35:		Line 35:
	The function should return a value of class <tt>cached_cm_info</tt>. For example:		The function should return a value of class <tt>cached_cm_info</tt>. For example:

	<~~code~~ php>		<syntaxhighlight lang="php">
	function mod_frog_get_coursemodule_info($cm) {		function mod_frog_get_coursemodule_info($cm) {
	$info = new cached_cm_info();		$info = new cached_cm_info();
Line 60:		Line 60:
	You can customise module display dynamically (when the page loads). For example you might want to alter it based on the permissions of the current user.		You can customise module display dynamically (when the page loads). For example you might want to alter it based on the permissions of the current user.

	<~~code~~ php>		<syntaxhighlight lang="php">
	function mod_frog_cm_info_dynamic(cm_info $cm) {		function mod_frog_cm_info_dynamic(cm_info $cm) {
	$context = get_context_instance(CONTEXT_MODULE, $cm->id);		$context = get_context_instance(CONTEXT_MODULE, $cm->id);
Line 79:		Line 79:
	Sometimes you need to display custom information for the current user that appears only on the course view page. For example, the forum module displays unread information on the view page. This information doesn't show on other pages (it isn't included in the navigation, for instance).		Sometimes you need to display custom information for the current user that appears only on the course view page. For example, the forum module displays unread information on the view page. This information doesn't show on other pages (it isn't included in the navigation, for instance).

	<~~code~~ php>		<syntaxhighlight lang="php">
	function mod_frog_cm_info_view(cm_info $cm) {		function mod_frog_cm_info_view(cm_info $cm) {
	$cm->set_after_link('Last tadpole: 22:17');		$cm->set_after_link('Last tadpole: 22:17');
Line 97:		Line 97:
	In addition to the old methods for obtaining data from $modinfo, there are some new functions. For example, here is how to get a single cm_info from $modinfo:		In addition to the old methods for obtaining data from $modinfo, there are some new functions. For example, here is how to get a single cm_info from $modinfo:

	<~~code~~ php>		<syntaxhighlight lang="php">
	$modinfo = get_fast_modinfo($course);		$modinfo = get_fast_modinfo($course);
	$cm = $modinfo->get_cm($cmid);		$cm = $modinfo->get_cm($cmid);
Line 104:		Line 104:
	The cm_info objects contain additional information that is not present in the course_modules database row, such as the module's name, and the icon and associated content mentioned above. In order to distinguish these from the plain database objects, you can specify the cm_info class in a function definition:		The cm_info objects contain additional information that is not present in the course_modules database row, such as the module's name, and the icon and associated content mentioned above. In order to distinguish these from the plain database objects, you can specify the cm_info class in a function definition:

	<~~code~~ php>		<syntaxhighlight lang="php">
	function my_clever_function(cm_info $cm) {		function my_clever_function(cm_info $cm) {
	if (!$cm->uservisible) {		if (!$cm->uservisible) {