Question behaviours - Revision history

Mudrd8mz: Text replacement - "" to ""

2021-07-14T20:24:57Z

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

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


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



Mudrd8mz: Text replacement - "" to ""

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

				
				
				
				
				
				← Older revision
				Revision as of 13:03, 14 July 2021
				
Line 101:
Line 101:



The <tt>get_expected_data</tt> function should return an array of expected parameters, with the corresponding param type. Note that the array of expected parameters may depend on the current state of the question attempt. For example, from <tt>qbehaviour_deferredcbm</tt> The <tt>get_expected_data</tt> function should return an array of expected parameters, with the corresponding param type. Note that the array of expected parameters may depend on the current state of the question attempt. For example, from <tt>qbehaviour_deferredcbm</tt>
<code> <syntaxhighlight lang="php">
     public function get_expected_data() {      public function get_expected_data() {
         if (question_state::is_active($this->qa->get_state())) {          if (question_state::is_active($this->qa->get_state())) {



TimHunt at 14:41, 27 November 2013
2013-11-27T14:41:37Z


				
				
				
				
				
				← Older revision
				Revision as of 14:41, 27 November 2013
				
Line 15:
Line 15:
A question behaviour plugin lives in a folder in <tt>question/behaviour</tt>. The layout inside that folder follows the typical layout for a Moodle plugin. For example, inside <tt>question/behaviour/mybehaviour/</tt> we would have: A question behaviour plugin lives in a folder in <tt>question/behaviour</tt>. The layout inside that folder follows the typical layout for a Moodle plugin. For example, inside <tt>question/behaviour/mybehaviour/</tt> we would have:



; behaviour.php : This contains the definition of the <tt>qbehaviour_mybehaviour_type</tt> class, which should extend the <tt>question_behaviour_type</tt> base class. 
; behaviour.php : This contains the definition of the <tt>qbehaviour_mybehaviour</tt> class, which should extend the <tt>question_behaviour</tt> base class. ; behaviour.php : This contains the definition of the <tt>qbehaviour_mybehaviour</tt> class, which should extend the <tt>question_behaviour</tt> base class.
; renderer.php : This contains the definition of the <tt>qbehaviour_mybehaviour_renderer</tt> class, which should extend the <tt>qbehaviour_renderer</tt> base class. ; renderer.php : This contains the definition of the <tt>qbehaviour_mybehaviour_renderer</tt> class, which should extend the <tt>qbehaviour_renderer</tt> base class.
; behaviour.php : This contains the definition of the <tt>qbehaviour_mybehaviour</tt> class, which should extend the <tt>question_behaviour</tt> base class. ; behaviourtype.php : This contains the definition of the <tt>qbehaviour_mybehaviour_type</tt> class, which should extend the <tt>question_behaviour_type</tt> base class.
; tests/... : Contains the [[PHPUnit|unit tests]] and [[Acceptance testing|acceptance tests]] for this behaviour. You are strongly encouraged to write thorough unit tests to ensure the correctness of your behaviour. ; tests/... : Contains the [[PHPUnit|unit tests]] and [[Acceptance testing|acceptance tests]] for this behaviour. You are strongly encouraged to write thorough unit tests to ensure the correctness of your behaviour.
; lang/en/qbehaviour_mybehaviour.php : English language strings for this behaviour. The language file must define at least the standard 'pluginname' giving the name of the behaviour, for example <tt>$string['pluginname'] = 'My behaviour';</tt>. ; lang/en/qbehaviour_mybehaviour.php : English language strings for this behaviour. The language file must define at least the standard 'pluginname' giving the name of the behaviour, for example <tt>$string['pluginname'] = 'My behaviour';</tt>.



TimHunt: /* Question behaviour type class */
2013-11-27T14:39:40Z
Question behaviour type class

				
				
				
				
				
				← Older revision
				Revision as of 14:39, 27 November 2013
				
Line 367:
Line 367:



The behaviour type class provides information about the behaviour in general. In contrast the behaviour class handles the behaviour applied to one particular question_attempt. The behaviour type class provides information about the behaviour in general. In contrast the behaviour class handles the behaviour applied to one particular question_attempt.

Note that, before Moodle 2.6, there was not a separate behaviour type class. These methods either did not exist, or were static methods on the behaviour class.






Line 410:
Line 412:



This method is an opportunity for the behaviour to provide some overall summary information about all the <tt>question_attempts</tt> in a <tt>question_usage_by_activity</tt>. An example of where this is done is in <tt>qbehaviour_deferredcbm_type</tt>. To see one place (currently the only place) where that is used, have a look at the quiz review page for a quiz attempt using one of the CBM behaviours. This method is an opportunity for the behaviour to provide some overall summary information about all the <tt>question_attempts</tt> in a <tt>question_usage_by_activity</tt>. An example of where this is done is in <tt>qbehaviour_deferredcbm_type</tt>. To see one place (currently the only place) where that is used, have a look at the quiz review page for a quiz attempt using one of the CBM behaviours.




==Unit tests== ==Unit tests==



TimHunt at 14:38, 27 November 2013
2013-11-27T14:38:34Z

Show changes


Adelamarre: /* process_...() */ Corrected typo where it was stated that the question_attempt::DISCARD is returned when it should be KEEP
2013-02-09T00:02:11Z
process_...():  Corrected typo where it was stated that the question_attempt::DISCARD is returned when it should be KEEP

				
				
				
				
				
				← Older revision
				Revision as of 00:02, 9 February 2013
				
Line 177:
Line 177:
First, if the question attempt has already been finished, there is nothing to do, so <tt>question_attempt::DISCARD</tt> is returned. First, if the question attempt has already been finished, there is nothing to do, so <tt>question_attempt::DISCARD</tt> is returned.



If there is something to do, the response data is extracted from the <tt>$pendingstep</tt>. The question type is asked whether the data there is complete enough to be graded. If not, the state is set to 'gave up'. If there is, the question type is asked to compute the fraction, and that and the state are put into the <tt>$pendingstep</tt>. Finally, the response summary, which is displayed in places like the quiz reports is updated and <tt>question_attempt::DISCARD</tt> is returned. If there is something to do, the response data is extracted from the <tt>$pendingstep</tt>. The question type is asked whether the data there is complete enough to be graded. If not, the state is set to 'gave up'. If there is, the question type is asked to compute the fraction, and that and the state are put into the <tt>$pendingstep</tt>. Finally, the response summary, which is displayed in places like the quiz reports is updated and <tt>question_attempt::KEEP</tt> is returned.
  



====adjust_display_options()==== ====adjust_display_options()====



Emerrill at 12:11, 19 June 2012
2012-06-19T12:11:57Z


				
				
				
				
				
				← Older revision
				Revision as of 12:11, 19 June 2012
				
Line 237:
Line 237:
====get_correct_response()==== ====get_correct_response()====



In fact, this first method is not even used for the reports. It is used in the question preview pop-up window to make the 'Fill in correct response''' button work. It returns the behaviour data that needs to be submitted as part of a correct response. Obviously, this is then combined with data from the question type. In fact, this first method is not even used for the reports. It is used in the question preview pop-up window to make the 'Fill in correct response' button work. It returns the behaviour data that needs to be submitted as part of a correct response. Obviously, this is then combined with data from the question type.



For example, from <tt>qbehaviour_deferredcbm</tt> For example, from <tt>qbehaviour_deferredcbm</tt>



Tmuras at 18:13, 13 May 2012
2012-05-13T18:13:59Z


				
				
				
				
				
				← Older revision
				Revision as of 18:13, 13 May 2012
				
Line 99:
Line 99:
====get_expected_data()==== ====get_expected_data()====



Some behaviours display additional form controls. When the question from is submitted, these submitted values are read using the standard optional_param function. The question engine needs to know what parameters to look for, and with what types. Some behaviours display additional form controls. When the question form is submitted, these submitted values are read using the standard optional_param function. The question engine needs to know what parameters to look for, and with what types.



The <tt>get_expected_data</tt> function should return an array of expected parameters, with the corresponding param type. Note that the array of expected parameters may depend on the current state of the question attempt. For example, from <tt>qbehaviour_deferredcbm</tt> The <tt>get_expected_data</tt> function should return an array of expected parameters, with the corresponding param type. Note that the array of expected parameters may depend on the current state of the question attempt. For example, from <tt>qbehaviour_deferredcbm</tt>



Dougiamas: /* See also */
2012-01-30T06:27:55Z
See also

				
				
				
				
				
				← Older revision
				Revision as of 06:27, 30 January 2012
				
Line 468:
Line 468:
* The PHP documenter comments that explain the purposes of every method in the question engine code. * The PHP documenter comments that explain the purposes of every method in the question engine code.
* Back to [[Question_Engine_2|Question Engine 2]] * Back to [[Question_Engine_2|Question Engine 2]]


[[Category:Plugins]]

← Older revision		Revision as of 13:03, 14 July 2021
Line 101:		Line 101:

	The <tt>get_expected_data</tt> function should return an array of expected parameters, with the corresponding param type. Note that the array of expected parameters may depend on the current state of the question attempt. For example, from <tt>qbehaviour_deferredcbm</tt>		The <tt>get_expected_data</tt> function should return an array of expected parameters, with the corresponding param type. Note that the array of expected parameters may depend on the current state of the question attempt. For example, from <tt>qbehaviour_deferredcbm</tt>
	<~~code~~>		<syntaxhighlight lang="php">
	public function get_expected_data() {		public function get_expected_data() {
	if (question_state::is_active($this->qa->get_state())) {		if (question_state::is_active($this->qa->get_state())) {

← Older revision		Revision as of 14:41, 27 November 2013
Line 15:		Line 15:
	A question behaviour plugin lives in a folder in <tt>question/behaviour</tt>. The layout inside that folder follows the typical layout for a Moodle plugin. For example, inside <tt>question/behaviour/mybehaviour/</tt> we would have:		A question behaviour plugin lives in a folder in <tt>question/behaviour</tt>. The layout inside that folder follows the typical layout for a Moodle plugin. For example, inside <tt>question/behaviour/mybehaviour/</tt> we would have:

	~~; behaviour.php : This contains the definition of the <tt>qbehaviour_mybehaviour_type</tt> class, which should extend the <tt>question_behaviour_type</tt> base class.~~
	; behaviour.php : This contains the definition of the <tt>qbehaviour_mybehaviour</tt> class, which should extend the <tt>question_behaviour</tt> base class.		; behaviour.php : This contains the definition of the <tt>qbehaviour_mybehaviour</tt> class, which should extend the <tt>question_behaviour</tt> base class.
	; renderer.php : This contains the definition of the <tt>qbehaviour_mybehaviour_renderer</tt> class, which should extend the <tt>qbehaviour_renderer</tt> base class.		; renderer.php : This contains the definition of the <tt>qbehaviour_mybehaviour_renderer</tt> class, which should extend the <tt>qbehaviour_renderer</tt> base class.
	; ~~behaviour~~.php : This contains the definition of the <tt>~~qbehaviour_mybehaviour~~</tt> class, which should extend the <tt>~~question_behaviour~~</tt> base class.		; behaviourtype.php : This contains the definition of the <tt>qbehaviour_mybehaviour_type</tt> class, which should extend the <tt>question_behaviour_type</tt> base class.
	; tests/... : Contains the [[PHPUnit\|unit tests]] and [[Acceptance testing\|acceptance tests]] for this behaviour. You are strongly encouraged to write thorough unit tests to ensure the correctness of your behaviour.		; tests/... : Contains the [[PHPUnit\|unit tests]] and [[Acceptance testing\|acceptance tests]] for this behaviour. You are strongly encouraged to write thorough unit tests to ensure the correctness of your behaviour.
	; lang/en/qbehaviour_mybehaviour.php : English language strings for this behaviour. The language file must define at least the standard 'pluginname' giving the name of the behaviour, for example <tt>$string['pluginname'] = 'My behaviour';</tt>.		; lang/en/qbehaviour_mybehaviour.php : English language strings for this behaviour. The language file must define at least the standard 'pluginname' giving the name of the behaviour, for example <tt>$string['pluginname'] = 'My behaviour';</tt>.

← Older revision		Revision as of 14:39, 27 November 2013
Line 367:		Line 367:

	The behaviour type class provides information about the behaviour in general. In contrast the behaviour class handles the behaviour applied to one particular question_attempt.		The behaviour type class provides information about the behaviour in general. In contrast the behaviour class handles the behaviour applied to one particular question_attempt.

			Note that, before Moodle 2.6, there was not a separate behaviour type class. These methods either did not exist, or were static methods on the behaviour class.


Line 410:		Line 412:

	This method is an opportunity for the behaviour to provide some overall summary information about all the <tt>question_attempts</tt> in a <tt>question_usage_by_activity</tt>. An example of where this is done is in <tt>qbehaviour_deferredcbm_type</tt>. To see one place (currently the only place) where that is used, have a look at the quiz review page for a quiz attempt using one of the CBM behaviours.		This method is an opportunity for the behaviour to provide some overall summary information about all the <tt>question_attempts</tt> in a <tt>question_usage_by_activity</tt>. An example of where this is done is in <tt>qbehaviour_deferredcbm_type</tt>. To see one place (currently the only place) where that is used, have a look at the quiz review page for a quiz attempt using one of the CBM behaviours.


	==Unit tests==		==Unit tests==

← Older revision		Revision as of 00:02, 9 February 2013
Line 177:		Line 177:
	First, if the question attempt has already been finished, there is nothing to do, so <tt>question_attempt::DISCARD</tt> is returned.		First, if the question attempt has already been finished, there is nothing to do, so <tt>question_attempt::DISCARD</tt> is returned.

	If there is something to do, the response data is extracted from the <tt>$pendingstep</tt>. The question type is asked whether the data there is complete enough to be graded. If not, the state is set to 'gave up'. If there is, the question type is asked to compute the fraction, and that and the state are put into the <tt>$pendingstep</tt>. Finally, the response summary, which is displayed in places like the quiz reports is updated and <tt>question_attempt::~~DISCARD~~</tt> is returned.		If there is something to do, the response data is extracted from the <tt>$pendingstep</tt>. The question type is asked whether the data there is complete enough to be graded. If not, the state is set to 'gave up'. If there is, the question type is asked to compute the fraction, and that and the state are put into the <tt>$pendingstep</tt>. Finally, the response summary, which is displayed in places like the quiz reports is updated and <tt>question_attempt::KEEP</tt> is returned.


	====adjust_display_options()====		====adjust_display_options()====

← Older revision		Revision as of 12:11, 19 June 2012
Line 237:		Line 237:
	====get_correct_response()====		====get_correct_response()====

	In fact, this first method is not even used for the reports. It is used in the question preview pop-up window to make the 'Fill in correct response''' button work. It returns the behaviour data that needs to be submitted as part of a correct response. Obviously, this is then combined with data from the question type.		In fact, this first method is not even used for the reports. It is used in the question preview pop-up window to make the 'Fill in correct response' button work. It returns the behaviour data that needs to be submitted as part of a correct response. Obviously, this is then combined with data from the question type.

	For example, from <tt>qbehaviour_deferredcbm</tt>		For example, from <tt>qbehaviour_deferredcbm</tt>

← Older revision		Revision as of 18:13, 13 May 2012
Line 99:		Line 99:
	====get_expected_data()====		====get_expected_data()====

	Some behaviours display additional form controls. When the question ~~from~~ is submitted, these submitted values are read using the standard optional_param function. The question engine needs to know what parameters to look for, and with what types.		Some behaviours display additional form controls. When the question form is submitted, these submitted values are read using the standard optional_param function. The question engine needs to know what parameters to look for, and with what types.

	The <tt>get_expected_data</tt> function should return an array of expected parameters, with the corresponding param type. Note that the array of expected parameters may depend on the current state of the question attempt. For example, from <tt>qbehaviour_deferredcbm</tt>		The <tt>get_expected_data</tt> function should return an array of expected parameters, with the corresponding param type. Note that the array of expected parameters may depend on the current state of the question attempt. For example, from <tt>qbehaviour_deferredcbm</tt>

← Older revision		Revision as of 06:27, 30 January 2012
Line 468:		Line 468:
	* The PHP documenter comments that explain the purposes of every method in the question engine code.		* The PHP documenter comments that explain the purposes of every method in the question engine code.
	* Back to [[Question_Engine_2\|Question Engine 2]]		* Back to [[Question_Engine_2\|Question Engine 2]]


			[[Category:Plugins]]