Development:Conditional activities - Revision history

Tsala: see also links

2008-12-10T15:10:33Z

TimHunt: /* Module supported features */

2008-09-08T02:37:39Z

Module supported features

← Older revision		Revision as of 02:37, 8 September 2008
Line 377:		Line 377:
	* If you restore a course with a startdateoffset, it will offset the dates from the new _course_modules date fields.		* If you restore a course with a startdateoffset, it will offset the dates from the new _course_modules date fields.

	= Module supported features =		== Module supported features ==
	As part of the completion system, I needed a way for modules to indicate support of certain features, so I propose a generic one which I have implemented:		As part of the completion system, I needed a way for modules to indicate support of certain features, so I propose a generic one which I have implemented:

TimHunt: /* Conditional availability */

2008-09-08T02:37:22Z

Conditional availability

← Older revision		Revision as of 02:37, 8 September 2008
Line 288:		Line 288:
	* Course and course-modules backup will be modified to include the new fields in those tables.		* Course and course-modules backup will be modified to include the new fields in those tables.

	= Conditional availability =		== Conditional availability ==
	== Conditional options ==		=== Conditional options ===
	There is no specific option to enable this part of the feature (?). The parts which depend on the completion system are enabled using the completion flag.		There is no specific option to enable this part of the feature (?). The parts which depend on the completion system are enabled using the completion flag.

	== Available conditions ==		=== Available conditions ===
	You can place conditions on any activity. Conditions are always combined with Boolean AND, i.e. all conditions must be met before the activity becomes available. Unlike completion, conditions are not module-dependent. There are two types of condition:		You can place conditions on any activity. Conditions are always combined with Boolean AND, i.e. all conditions must be met before the activity becomes available. Unlike completion, conditions are not module-dependent. There are two types of condition:

Line 303:		Line 303:
	#* Activity must be graded at least/at most ''N''.		#* Activity must be graded at least/at most ''N''.

	== Database ==		=== Database ===
	* _course_modules		* _course_modules
	** New field availablefrom, unsigned int (10) not null default 0.0 = Not conditional on date.<nowiki>* = Time (seconds since epoch</nowiki>) after which activity becomes available.		** New field availablefrom, unsigned int (10) not null default 0.0 = Not conditional on date.<nowiki>* = Time (seconds since epoch</nowiki>) after which activity becomes available.
Line 316:		Line 316:
	** requiredgrade, number(10,5 decimals).Grade boundary used together with the above sign. May be null.		** requiredgrade, number(10,5 decimals).Grade boundary used together with the above sign. May be null.

	== API ==		=== API ===
	Two new functions:		Two new functions:

Line 326:		Line 326:
	* For performance reasons we need to cache the conditions in _course_modules_available. Best option is to use existing get_fast_modinfo infrastructure. This should not be hard. The above two functions will use this cache.		* For performance reasons we need to cache the conditions in _course_modules_available. Best option is to use existing get_fast_modinfo infrastructure. This should not be hard. The above two functions will use this cache.

	== Configuration UI (activity settings page) ==		=== Configuration UI (activity settings page) ===
	The configuration UI will be implemented as part of standard_coursemodule_elements in the module forms. The existing ‘visible to students’ option (not changed in database/code) is moved within this UI.		The configuration UI will be implemented as part of standard_coursemodule_elements in the module forms. The existing ‘visible to students’ option (not changed in database/code) is moved within this UI.

Line 345:		Line 345:
	* The grade box is a text-entry field. Users type in the floating-point number version of the required grade.		* The grade box is a text-entry field. Users type in the floating-point number version of the required grade.

	== Activity UI (course page) ==		=== Activity UI (course page) ===
	(This will be accomplished via code changes to print_section. Logic is basically the same as for the current visible flag.)		(This will be accomplished via code changes to print_section. Logic is basically the same as for the current visible flag.)

Line 361:		Line 361:
	Behaviour is the same when editing is turned on except that the ‘availability’ string moves to the line below so as not to clash with all those icons.		Behaviour is the same when editing is turned on except that the ‘availability’ string moves to the line below so as not to clash with all those icons.

	== Performance ==		=== Performance ===
	This adds a single quick database query to the course view page for courses which have enabled conditional activities / completion.		This adds a single quick database query to the course view page for courses which have enabled conditional activities / completion.

Line 368:		Line 368:
	I don’t believe this will pose a massive performance issue as it only applies when modules are used as source for this kind of information. We should review this once it’s developed and, if necessary, optimise performance then. There are various caching approaches we could use.		I don’t believe this will pose a massive performance issue as it only applies when modules are used as source for this kind of information. We should review this once it’s developed and, if necessary, optimise performance then. There are various caching approaches we could use.

	== Module delete ==		=== Module delete ===
	If you try to delete a module, it will check to see if that module is referenced by any other module as a condition. If that’s the case, you will not be allowed to delete it. An error message will include a link to the module edit page for the other module (so you can go there and delete the condition if you like).		If you try to delete a module, it will check to see if that module is referenced by any other module as a condition. If that’s the case, you will not be allowed to delete it. An error message will include a link to the module edit page for the other module (so you can go there and delete the condition if you like).

	== Backup and restore ==		=== Backup and restore ===
	* The new _course_modules_available table will be backed up and restored.		* The new _course_modules_available table will be backed up and restored.
	** Partial restore needs to be handled. If your backup includes module A but not module B, and module A had a condition on B, then that condition will not be restored.		** Partial restore needs to be handled. If your backup includes module A but not module B, and module A had a condition on B, then that condition will not be restored.

Quen: /* Available conditions */

2008-08-01T09:39:17Z

Available conditions

← Older revision		Revision as of 09:39, 1 August 2008
Line 296:		Line 296:

	# Conditional on date. You can have both of these conditions if required.		# Conditional on date. You can have both of these conditions if required.

	#
	#* On or after date – activity becomes available on given date.		#* On or after date – activity becomes available on given date.
	#* Before date – activity becomes unavailable on given date.		#* Before date – activity becomes unavailable on given date.

	# Conditional on other activities. You can have as many of these conditions as desired.		# Conditional on other activities. You can have as many of these conditions as desired.

	#
	#* Activity must be completed – any kind of completion will do.		#* Activity must be completed – any kind of completion will do.
	#* Activity must be completed and passed – completion must have been graded and displayed with a pass mark (tick icon).		#* Activity must be completed and passed – completion must have been graded and displayed with a pass mark (tick icon).

Quen at 10:57, 30 July 2008

2008-07-30T10:57:04Z

← Older revision		Revision as of 10:57, 30 July 2008
Line 1:		Line 1:
	{{Moodle_2.0}}(This is a design document by sam marshall from the Open University. It is based on earlier discussion in this wiki, and then detailed discussion with moodle.com staff who contributed improvements and corrections.)		{{Moodle_2.0}}

			= Documentation =

			[[Development:Conditional activities_Adding module support]]

			= Design document =

			(This is a design document by sam marshall from the Open University. It is based on earlier discussion in this wiki, and then detailed discussion with moodle.com staff who contributed improvements and corrections.)

	See MDL-15497 for tasks and tracking.		See MDL-15497 for tasks and tracking.


	~~= Conditional activities =~~
	sam marshall, 21 May 2008; updated as of 26 June 2008. Exported to MediaWiki format using OpenOffice.org 3.0 beta (i.e. this page doesn't perfectly represent the word-processor version) and manually tweaked a bit to fix it where it was obviously wrong.		sam marshall, 21 May 2008; updated as of 26 June 2008. Exported to MediaWiki format using OpenOffice.org 3.0 beta (i.e. this page doesn't perfectly represent the word-processor version) and manually tweaked a bit to fix it where it was obviously wrong.

Stronk7 at 17:18, 25 July 2008

2008-07-25T17:18:41Z

← Older revision		Revision as of 17:18, 25 July 2008
Line 1:		Line 1:
	(This is a design document by sam marshall from the Open University. It is based on earlier discussion in this wiki, and then detailed discussion with moodle.com staff who contributed improvements and corrections.)		{{Moodle_2.0}}(This is a design document by sam marshall from the Open University. It is based on earlier discussion in this wiki, and then detailed discussion with moodle.com staff who contributed improvements and corrections.)

	See MDL-15497 for tasks and tracking.		See MDL-15497 for tasks and tracking.

Dougiamas at 06:58, 18 July 2008

2008-07-18T06:58:30Z

← Older revision		Revision as of 06:58, 18 July 2008
Line 1:		Line 1:
	(This is a design document by sam marshall from the Open University. It is based on earlier discussion in this wiki, and then detailed discussion with moodle.com staff who contributed improvements and corrections.)		(This is a design document by sam marshall from the Open University. It is based on earlier discussion in this wiki, and then detailed discussion with moodle.com staff who contributed improvements and corrections.)

			See MDL-15497 for tasks and tracking.


	= Conditional activities =		= Conditional activities =

Quen at 16:37, 26 June 2008

2008-06-26T16:37:45Z

Show changes

Ray: /* This activity will be available when ... */

2008-05-15T15:24:23Z

This activity will be available when ...

← Older revision		Revision as of 15:24, 15 May 2008
Line 69:		Line 69:

	[[User:sam marshall\|sam marshall]] Should also include date as a condition. Would be stored in course_modules_avail		[[User:sam marshall\|sam marshall]] Should also include date as a condition. Would be stored in course_modules_avail
			[[User:ray\| Ray Lawrence]] Absolute dates or relative to the course start date?

	[[User:sam marshall\|sam marshall]] Maybe consider also an option for whether the activity is visible before it is available, greyed out with a 'This activity will be available when...' note, or not displayed at all.		[[User:sam marshall\|sam marshall]] Maybe consider also an option for whether the activity is visible before it is available, greyed out with a 'This activity will be available when...' note, or not displayed at all.

Dougiamas: /* course_modules_completion */

2008-04-30T09:06:47Z

course_modules_completion

← Older revision		Revision as of 09:06, 30 April 2008
Line 82:		Line 82:

	===course_modules_completion===		===course_modules_completion===
	This table records the status of each user completing each activity module. It represents current state and is used to make the display of course pages very fast. It is updated whenever grades or modules change etc.		This table records the status of each user completing each activity module. It represents current state and is used to make the display of course pages very fast. It is updated whenever grades or modules change etc. See also [[Development:Course_completion]] for course completion which is a separate system.

	* id		* id
Line 89:		Line 89:
	* userid		* userid
	* status - hide / not done / in progress / done fail / done pass		* status - hide / not done / in progress / done fail / done pass
	* timemodified		* timemodified




	===course_modules_avail===		===course_modules_avail===

@@ Line 1: / Line 1: @@
 {{Moodle_2.0}}
 = Design document =
@@ Line 391: / Line 387: @@
 Note that this implementation would not be appropriate if modules were changed to be fully object-oriented. However I don't expect that to happen in Moodle 2 so this is probably OK.

← Older revision		Revision as of 15:24, 15 May 2008
Line 69:		Line 69:

	[[User:sam marshall\|sam marshall]] Should also include date as a condition. Would be stored in course_modules_avail		[[User:sam marshall\|sam marshall]] Should also include date as a condition. Would be stored in course_modules_avail
			[[User:ray\| Ray Lawrence]] Absolute dates or relative to the course start date?

	[[User:sam marshall\|sam marshall]] Maybe consider also an option for whether the activity is visible before it is available, greyed out with a 'This activity will be available when...' note, or not displayed at all.		[[User:sam marshall\|sam marshall]] Maybe consider also an option for whether the activity is visible before it is available, greyed out with a 'This activity will be available when...' note, or not displayed at all.