Conditional activities Adding module support - Historial de revisió

Quen: /* How to implement */

2010-10-18T14:17:19Z

How to implement

← Versió més antiga		Revisió del 14:17, 18 oct 2010
Línia 39:		Línia 39:
	In your module's ''modulename''<tt>_supports</tt> function, return true for FEATURE_COMPLETION_TRACKS_VIEWS.		In your module's ''modulename''<tt>_supports</tt> function, return true for FEATURE_COMPLETION_TRACKS_VIEWS.

	Then add this code to run whenever a user successfully views the activity (for example, ~~near~~ the <tt>$OUTPUT->footer()</tt> call in <tt>view.php</tt>):		Then add this code to run whenever a user successfully views the activity (for example, just before the <tt>$OUTPUT->footer()</tt> call in <tt>view.php</tt>):

	$completion=new completion_info($course);		$completion = new completion_info($course);
	$completion->set_module_viewed($cm);		$completion->set_module_viewed($cm);

Quen: /* Example */

2010-10-13T13:40:22Z

Example

← Versió més antiga		Revisió del 13:40, 13 oct 2010
Línia 105:		Línia 105:
	==== Example ====		==== Example ====

	~~I added the~~ following code ~~to forum~~ <tt>~~backuplib~~.php</tt> ~~after a list of similar lines~~:		The following code in <tt>backup_forum_stepslib.php</tt> lists the fields to back up:

	~~fwrite~~ (~~$bf~~,~~full_tag~~(~~"COMPLETIONPOSTS"~~,4,~~false~~,~~$forum->~~completionposts));		$forum = new backup_nested_element('forum', array('id'), array(
			'type', 'name', 'intro', 'introformat',
			'assessed', 'assesstimestart', 'assesstimefinish', 'scale',
			'maxbytes', 'maxattachments', 'forcesubscribe', 'trackingtype',
			'rsstype', 'rssarticles', 'timemodified', 'warnafter',
			'blockafter', 'blockperiod', 'completiondiscussions', 'completionreplies',
			'completionposts'));

	~~And~~ the ~~following to <tt>restorelib.php</tt>:~~		As you can see, I added the '''completionposts''' field (and the others that aren't covered in this example) to the list of fields.

	~~$forum->completionposts = isset($info[~~'~~MOD~~']['~~#'][~~'~~COMPLETIONPOSTS~~']['~~0']['#'])?backup_todb~~(~~$info['MOD']['#']['COMPLETIONPOSTS']['0']['#']):0;~~

	~~(This code followed~~ the ~~existing style set by other lines. I don~~'t ~~necessarily recommend~~ this ~~exact pattern~~.)

	=== Form changes for completion settings ===		=== Form changes for completion settings ===

Danmarsden: /* How to implement */ fix old mention of print_footer()

2010-07-04T23:14:31Z

How to implement: fix old mention of print_footer()

← Versió més antiga		Revisió del 23:14, 4 jul 2010
Línia 39:		Línia 39:
	In your module's ''modulename''<tt>_supports</tt> function, return true for FEATURE_COMPLETION_TRACKS_VIEWS.		In your module's ''modulename''<tt>_supports</tt> function, return true for FEATURE_COMPLETION_TRACKS_VIEWS.

	Then add this code to run whenever a user successfully views the activity (for example, near the <tt>~~print_footer~~()</tt> call in <tt>view.php</tt>):		Then add this code to run whenever a user successfully views the activity (for example, near the <tt>$OUTPUT->footer()</tt> call in <tt>view.php</tt>):

	$completion=new completion_info($course);		$completion=new completion_info($course);

Tsala: category

2009-02-02T14:40:08Z

Quen: /* Backup and restore for completion fields */

2008-07-31T11:03:17Z

Backup and restore for completion fields

← Versió més antiga		Revisió del 11:03, 31 jul 2008
Línia 99:		Línia 99:
	=== Backup and restore for completion fields ===		=== Backup and restore for completion fields ===

	Modules do not need to back up the generic completion options, which are handled by the system, but they do need to back up any custom options. You should add backup and restore logic for the fields mentioned above.		Modules do not need to back up the generic completion options, which are handled by the system, but they do need to back up any custom options. You should add backup and restore logic for the fields mentioned above.

			Remember that your restore code should handle the case when these fields are not present, setting the fields to a suitable default value.

	==== Example ====		==== Example ====
Línia 110:		Línia 112:

	$forum->completionposts = isset($info['MOD']['#']['COMPLETIONPOSTS']['0']['#'])?backup_todb($info['MOD']['#']['COMPLETIONPOSTS']['0']['#']):0;		$forum->completionposts = isset($info['MOD']['#']['COMPLETIONPOSTS']['0']['#'])?backup_todb($info['MOD']['#']['COMPLETIONPOSTS']['0']['#']):0;

			(This code followed the existing style set by other lines. I don't necessarily recommend this exact pattern.)

	=== Form changes for completion settings ===		=== Form changes for completion settings ===

Quen: /* Database fields for completion settings */

2008-07-31T11:02:13Z

Database fields for completion settings

← Versió més antiga		Revisió del 11:02, 31 jul 2008
Línia 96:		Línia 96:

	* '''completionposts''' - this may be 0 or an integer. If it's an integer, say 3, then the user needs to add 3 forum posts (either new discussions or replies) in order for the forum to count as 'completed'.		* '''completionposts''' - this may be 0 or an integer. If it's an integer, say 3, then the user needs to add 3 forum posts (either new discussions or replies) in order for the forum to count as 'completed'.

			=== Backup and restore for completion fields ===

			Modules do not need to back up the generic completion options, which are handled by the system, but they do need to back up any custom options. You should add backup and restore logic for the fields mentioned above.

			==== Example ====

			I added the following code to forum <tt>backuplib.php</tt> after a list of similar lines:

			fwrite ($bf,full_tag("COMPLETIONPOSTS",4,false,$forum->completionposts));

			And the following to <tt>restorelib.php</tt>:

			$forum->completionposts = isset($info['MOD']['#']['COMPLETIONPOSTS']['0']['#'])?backup_todb($info['MOD']['#']['COMPLETIONPOSTS']['0']['#']):0;

	=== Form changes for completion settings ===		=== Form changes for completion settings ===

Quen: /* Implementation overview */

2008-07-31T10:59:48Z

Implementation overview

← Versió més antiga		Revisió del 10:59, 31 jul 2008
Línia 72:		Línia 72:
	# Return true for FEATURE_COMPLETION_HAS_RULES in your module's _supports function.		# Return true for FEATURE_COMPLETION_HAS_RULES in your module's _supports function.
	# Add database fields to your module's main table to store the custom completion settings.		# Add database fields to your module's main table to store the custom completion settings.
			# Add backup and restore code to back up these fields.
	# Add controls to your module's settings form so that users can select the custom rules, altering these database settings.		# Add controls to your module's settings form so that users can select the custom rules, altering these database settings.
	# Add a function that checks the value of these rules (if set).		# Add a function that checks the value of these rules (if set).

Quen: /* Notifying the completion system */

2008-07-30T15:28:17Z

Notifying the completion system

← Versió més antiga		Revisió del 15:28, 30 jul 2008
Línia 236:		Línia 236:
	** '''COMPLETION_INCOMPLETE''' - this change will either have no effect on the user's completion state, or it will make it incomplete. The change cannot make a user's state complete if it was incomplete previously. Deleting a forum post would fall into this category.		** '''COMPLETION_INCOMPLETE''' - this change will either have no effect on the user's completion state, or it will make it incomplete. The change cannot make a user's state complete if it was incomplete previously. Deleting a forum post would fall into this category.
	** '''COMPLETION_UNKNOWN''' - this change might have either effect. Using this option is much slower than the others, so try to avoid using it in anything that might happen frequently.		** '''COMPLETION_UNKNOWN''' - this change might have either effect. Using this option is much slower than the others, so try to avoid using it in anything that might happen frequently.
			* If the user whose completion state would be updated is not the current user, then the optional <tt>$userid</tt> parameter must be included. For example, if a teacher deletes a student's forum post, then it is the student's completion state which may need updating, not the teacher's.

	==== Example ====		==== Example ====

Quen: /* Example */

2008-07-30T12:23:03Z

Example

← Versió més antiga		Revisió del 12:23, 30 jul 2008
Línia 116:		Línia 116:

	$group=array();		$group=array();
	$group[] =& $mform->createElement('checkbox', 'completionpostsenabled', '', get_string('completionposts','forum'));		$group[] =& $mform->createElement('checkbox', 'completionpostsenabled', ' ', get_string('completionposts','forum'));
	$group[] =& $mform->createElement('text', 'completionposts', '', array('size'=>3));		$group[] =& $mform->createElement('text', 'completionposts', ' ', array('size'=>3));
	$mform->setType('completionposts',PARAM_INT);		$mform->setType('completionposts',PARAM_INT);
	$mform->addGroup($group, 'completionpostsgroup', get_string('completionpostsgroup','forum'), array(' '), false);		$mform->addGroup($group, 'completionpostsgroup', get_string('completionpostsgroup','forum'), array(' '), false);

Quen: /* How to implement */

2008-07-30T12:21:21Z

How to implement

← Versió més antiga		Revisió del 12:21, 30 jul 2008
Línia 37:		Línia 37:
	=== How to implement ===		=== How to implement ===

	In your module's _supports function, return true for FEATURE_COMPLETION_TRACKS_VIEWS.		In your module's ''modulename''<tt>_supports</tt> function, return true for FEATURE_COMPLETION_TRACKS_VIEWS.

	Then add this code to run whenever a user successfully views the activity (for example, near the print_footer() call in <tt>view.php</tt>):		Then add this code to run whenever a user successfully views the activity (for example, near the <tt>print_footer()</tt> call in <tt>view.php</tt>):

	$completion=new completion_info($course);		$completion=new completion_info($course);

← Versió més antiga		Revisió del 14:40, 2 feb 2009
Línia 266:		Línia 266:
	$completion->update_state($cm,COMPLETION_COMPLETE);		$completion->update_state($cm,COMPLETION_COMPLETE);
	}		}

			[[Category:Conditional activities]]