Inheritance diagram for qbehaviour_informationitem:

Collaboration diagram for qbehaviour_informationitem:

Public Member Functions
	is_compatible_question (question_definition $question)
	get_expected_data ()
	get_correct_response ()
	adjust_display_options (question_display_options $options)
	get_state_string ($showcorrectness)
	process_action (question_attempt_pending_step $pendingstep)
	summarise_action (question_attempt_step $step)
	process_comment (question_attempt_pending_step $pendingstep)
	process_finish (question_attempt_pending_step $pendingstep)
	process_seen (question_attempt_pending_step $pendingstep)

Detailed Description

Question behaviour informaiton items.

For example for the 'Description' 'Question type'. There is no grade, and the question type is marked complete the first time the user navigates away from a page that contains that question.

Copyright:: 2009 The Open University http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later

Definition at line 40 of file behaviour.php.

Member Function Documentation

adjust_display_options ( question_display_options $ options )

Make any changes to the display options before a question is rendered, so that it can be displayed in a way that is appropriate for the statue it is currently in. For example, by default, if the question is finished, we ensure that it is only ever displayed read-only.

Parameters:

question_display_options $options the options to adjust. Just change the properties of this object - objects are passed by referece.

Reimplemented from question_behaviour.

Definition at line 60 of file behaviour.php.

get_correct_response ( )

Return an array of any im variables, and the value required to get full marks.

Returns:: array variable name => value.

Reimplemented from question_behaviour.

Definition at line 53 of file behaviour.php.

get_expected_data ( )

Return an array of the behaviour variables that could be submitted as part of a question of this type, with their types, so they can be properly cleaned.

Returns:: array variable name => PARAM_... constant.

Reimplemented from question_behaviour.

Definition at line 46 of file behaviour.php.

get_state_string ( $ showcorrectness )

Generate a brief textual description of the current state of the question, normally displayed under the question number.

Parameters:

bool $showcorrectness Whether right/partial/wrong states should be distinguised.

Returns:: string a brief summary of the current state of the qestion attempt.

Reimplemented from question_behaviour.

Definition at line 73 of file behaviour.php.

is_compatible_question ( question_definition $ question )

Some behaviours can only work with certing types of question. This method allows the behaviour to verify that a question is compatible.

This implementation is only provided for backwards-compatibility. You should override this method if you are implementing a behaviour.

Parameters:

question_definition $question the question.

Reimplemented from question_behaviour.

Definition at line 42 of file behaviour.php.

process_action ( question_attempt_pending_step $ pendingstep )

The main entry point for processing an action.

All the various operations that can be performed on a question_attempt get channeled through this function, except for question_attempt::start() which goes to init_first_step(). question_attempt::finish() becomes an action with im vars finish => 1, and manual comment/grade becomes an action with im vars comment => comment text, and mark => ..., max_mark => ... if the question is graded.

This method should first determine whether the action is significant. For example, if no actual action is being performed, but instead the current responses are being saved, and there has been no change since the last set of responses that were saved, this the action is not significatn. In this case, this method should return question_attempt::DISCARD. Otherwise it should return question_attempt::KEEP.

If the action is significant, this method should also perform any necessary updates to $pendingstep. For example, it should call question_attempt_step::set_state() to set the state that results from this action, and if this is a grading action, it should call question_attempt_step::set_fraction().

This method can also call question_attempt_step::set_behaviour_var() to store additional infomation. There are two main uses for this. This can be used to store the result of any randomisation done. It is important to store the result of randomisation once, and then in future use the same outcome if the actions are ever replayed. This is how regrading works. The other use is to cache the result of expensive computations performed on the raw response data, so that subsequent display and review of the question does not have to repeat the same expensive computations.

Often this method is implemented as a dispatching method that examines the pending step to determine the kind of action being performed, and then calls a more specific method like process_save() or process_comment(). Look at some of the standard behaviours for examples.

Parameters:

question_attempt_pending_step $pendingstep a partially initialised step containing all the information about the action that is being peformed. This information can be accessed using question_attempt_step::get_behaviour_var().