Development:Implementing Reset course functionality in a module - Revision history

Dlnsk at 20:26, 9 November 2008

2008-11-09T20:26:06Z

← Older revision		Revision as of 20:26, 9 November 2008
Line 57:		Line 57:
	</nowiki></pre>		</nowiki></pre>

	==''mymodule''~~reset_course_form_defaults~~($course)==		==''mymodule''_reset_course_form_defaults($course)==

	Used for set default values to form's elements displayed by ''mymodule''_reset_course_form_definition. The forum implementation:		Used for set default values to form's elements displayed by ''mymodule''_reset_course_form_definition. The forum implementation:

Dlnsk: Metods renamed, using Form API

2008-11-07T19:08:46Z

Metods renamed, using Form API

← Older revision		Revision as of 19:08, 7 November 2008
Line 1:		Line 1:
	The course reset code is triggered from /course/reset.php. To have your module included, you need to implement the ~~two~~ fuctions described below. To work out how to do this, a good example is to look at the implementations in /mod/fourm/lib.php		The course reset code is triggered from /course/reset.php. To have your module included, you need to implement the three fuctions described below. To work out how to do this, a good example is to look at the implementations in /mod/fourm/lib.php

	==''mymodule''~~_reset_course_form~~($~~course~~)==		==''mymodule''_reset_course_form_definition(&$mform)==

	This is called directly by /course/reset.php. It needs to output some form controls to control different options for resetting your module.		This is called directly by /course/reset.php. It needs to output some form controls to control different options for resetting your module. You should use Form API for create form.

	The convention is to call settings relating your your module reset_''mymodule''_''something''.		The convention is to call settings relating your your module reset_''mymodule''_''something''.
Line 13:		Line 13:
	* Called by course/reset.php		* Called by course/reset.php
	*/		*/
	function ~~forum_reset_course_form~~($~~course~~) {		function forum_reset_course_form_definition(&$mform) {
	~~echo~~ get_string('~~resetforums~~', 'forum'); ~~echo ':<br />';~~		$mform->addElement('header', 'forumheader', get_string('modulenameplural', 'forum'));
	~~print_checkbox~~('~~reset_forum_news~~', ~~1, true~~, get_string('~~namenews~~','forum')~~, '', ''~~); ~~echo '<br />';~~
	~~print_checkbox~~('~~reset_forum_single~~', ~~1, true~~, get_string('~~singleforum~~','forum'), '', ''); ~~echo~~ '~~<br />~~';		$mform->addElement('checkbox', 'reset_forum_all', get_string('resetforumsall','forum'));
	~~print_checkbox~~('~~reset_forum_eachuser~~', 1, ~~true, get_string~~('~~eachuserforum~~','~~forum~~'), '', ''); ~~echo~~ '~~<br />~~';
	~~print_checkbox~~('~~reset_forum_general~~', ~~1, true~~, get_string('~~generalforum~~','forum')~~, '', ''~~)~~; echo '<br />'~~;		$mform->addElement('select', 'reset_forum_types', get_string('resetforums', 'forum'), forum_get_forum_types_all(), array('multiple' => 'multiple'));
	~~echo~~ '~~<p>~~';		$mform->setAdvanced('reset_forum_types');
	~~print_checkbox~~('~~reset_forum_subscriptions~~', ~~1, true, get_string(~~'~~resetsubscriptions~~','~~forum~~'), '', '');		$mform->disabledIf('reset_forum_types', 'reset_forum_all', 'checked');
	~~echo~~ '~~</p>~~';
			$mform->addElement('checkbox', 'reset_forum_subscriptions', get_string('resetsubscriptions','forum'));
			$mform->setAdvanced('reset_forum_subscriptions');

			$mform->addElement('checkbox', 'reset_forum_track_prefs', get_string('resettrackprefs','forum'));
			$mform->setAdvanced('reset_forum_track_prefs');
			$mform->disabledIf('reset_forum_track_prefs', 'reset_forum_all', 'checked');

			$mform->addElement('checkbox', 'reset_forum_ratings', get_string('deleteallratings'));
			$mform->disabledIf('reset_forum_ratings', 'reset_forum_all', 'checked');
	}		}
	</nowiki></pre>		</nowiki></pre>

	==''mymodule''~~_delete_userdata~~($data~~, $showfeedback~~)==		==''mymodule''_reset_userdata($data)==

	This actually does the resetting. It is called indirectly, /course/reset.php calls reset_course_userdata() in /lib/moodlelib.php, which then calls the functions for each module.		This actually does the resetting. It is called indirectly, /course/reset.php calls reset_course_userdata() in /lib/moodlelib.php, which then calls the functions for each module.

	The $data parameter is what came back from the form printed by forum_reset_course. In particular, $data->courseid is the id of the coures we are cleaning up.		The $data parameter is what came back from the form printed by forum_reset_course. In particular, $data->courseid is the id of the coures we are cleaning up.

	~~The $showfeedback parameter determines whether we should output progress information as we go along.~~

	The forum implementation is again a good one to study, here is a very simple example:		The forum implementation is again a good one to study, here is a very simple example:

	<pre><nowiki>		<pre><nowiki>
	function ~~example_delete_userdata~~($data~~, $showfeedback=true~~) {		function example_reset_userdata($data) {
	if (!empty($data->reset_example_frogs)) {		if (!empty($data->reset_example_frogs)) {
	if (delete_records('example_frogs', 'couresid', $data->courseid) and $showfeedback) {		if (delete_records('example_frogs', 'couresid', $data->courseid) and $showfeedback) {
Line 47:		Line 54:
	}		}
	}		}
			}
			</nowiki></pre>

			==''mymodule''reset_course_form_defaults($course)==

			Used for set default values to form's elements displayed by ''mymodule''_reset_course_form_definition. The forum implementation:

			<pre><nowiki>
			function forum_reset_course_form_defaults($course) {
			return array('reset_forum_all'=>1, 'reset_forum_subscriptions'=>0, 'reset_forum_track_prefs'=>0, 'reset_forum_ratings'=>1);
	}		}
	</nowiki></pre>		</nowiki></pre>

	[[ja:開発:コースのリセット機能をモジュールに実装する]]		[[ja:開発:コースのリセット機能をモジュールに実装する]]

Topstone: link to Japanese

2008-09-12T18:28:14Z

link to Japanese

← Older revision		Revision as of 18:28, 12 September 2008
Line 49:		Line 49:
	}		}
	</nowiki></pre>		</nowiki></pre>

			[[ja:開発:コースのリセット機能をモジュールに実装する]]

TimHunt at 21:31, 19 June 2007

2007-06-19T21:31:24Z

New page

The course reset code is triggered from /course/reset.php. To have your module included, you need to implement the two fuctions described below. To work out how to do this, a good example is to look at the implementations in /mod/fourm/lib.php

==''mymodule''_reset_course_form($course)==

This is called directly by /course/reset.php. It needs to output some form controls to control different options for resetting your module.

The convention is to call settings relating your your module reset_''mymodule''_''something''.

The forum implementation is a good model:

<pre><nowiki>
/**
* Called by course/reset.php
*/
function forum_reset_course_form($course) {
echo get_string('resetforums', 'forum'); echo ': ';
print_checkbox('reset_forum_news', 1, true, get_string('namenews','forum'), '', ''); echo ' ';
print_checkbox('reset_forum_single', 1, true, get_string('singleforum','forum'), '', ''); echo ' ';
print_checkbox('reset_forum_eachuser', 1, true, get_string('eachuserforum','forum'), '', ''); echo ' ';
print_checkbox('reset_forum_general', 1, true, get_string('generalforum','forum'), '', ''); echo ' ';
echo '';
print_checkbox('reset_forum_subscriptions', 1, true, get_string('resetsubscriptions','forum'), '', '');
echo '';
}
</nowiki></pre>

==''mymodule''_delete_userdata($data, $showfeedback)==

This actually does the resetting. It is called indirectly, /course/reset.php calls reset_course_userdata() in /lib/moodlelib.php, which then calls the functions for each module.

The $data parameter is what came back from the form printed by forum_reset_course. In particular, $data->courseid is the id of the coures we are cleaning up.

The $showfeedback parameter determines whether we should output progress information as we go along.

The forum implementation is again a good one to study, here is a very simple example:

<pre><nowiki>
function example_delete_userdata($data, $showfeedback=true) {
if (!empty($data->reset_example_frogs)) {
if (delete_records('example_frogs', 'couresid', $data->courseid) and $showfeedback) {
notify(get_string('frogsdeleted', 'example'), 'notifysuccess');
}
}
if (!empty($data->reset_example_newts)) {
if (delete_records('example_newts', 'couresid', $data->courseid) and $showfeedback) {
notify(get_string('newtsdeleted', 'example'), 'notifysuccess');
}
}
}
</nowiki></pre>