Moodle PHP Documentation 4.3
Moodle 4.3.5 (Build: 20240610) (7dcfaa79f78)
|
A subclass of {. More...
Public Member Functions | |
add_full_user_object (stdClass $user) | |
Update full user information for step. | |
get_all_data () | |
Get all the data. | |
get_behaviour_data () | |
Get all the behaviour variables. | |
get_behaviour_var ($name) | |
get_fraction () | |
get_id () | |
get_metadata_var ($name) | |
Get a metadata variable. | |
get_new_response_summary () | |
Get the new response summary, if there is one. | |
get_new_variant_number () | |
Get the new variant number, if there is one. | |
get_qt_data () | |
Get all the question type variables. | |
get_qt_files ($name, $contextid) | |
Get the latest set of files for a particular question type variable of type question_attempt\PARAM_FILES. | |
get_qt_var ($name) | |
get_state () | |
get_submitted_data () | |
Get all the submitted data, but not the cached data. | |
get_timecreated () | |
get_user () | |
Return the full user object. | |
get_user_fullname () | |
Get full name of user who did action. | |
get_user_id () | |
has_behaviour_var ($name) | |
has_metadata_var ($name) | |
Whether this step has a metadata variable. | |
has_qt_var ($name) | |
prepare_response_files_draft_itemid ($name, $contextid) | |
Prepare a draft file are for the files belonging the a response variable of this step. | |
prepare_response_files_draft_itemid_with_text ($name, $contextid, $text) | |
Prepare a draft file are for the files belonging the a response variable of this step, while rewriting the URLs in some text. | |
response_summary_changed () | |
Whether this processing this step has changed the response summary. | |
rewrite_response_pluginfile_urls ($text, $contextid, $name, $extras) | |
Rewrite the @PLUGINFILE@ tokens in a response variable from this step that contains links to file. | |
set_behaviour_var ($name, $value) | |
Set a cached behaviour variable. | |
set_fraction ($fraction) | |
Set the fraction. | |
set_metadata_var ($name, $value) | |
Set a metadata variable. | |
set_new_response_summary ($responsesummary) | |
If as a result of processing this step, the response summary for the question attempt should changed, you should call this method to set the new summary. | |
set_new_variant_number ($variant) | |
If as a result of processing this step, you identify that this variant of the question is actually identical to the another one, you may change the variant number recorded, in order to give better statistics. | |
set_qt_var ($name, $value) | |
Set a cached question type variable. | |
set_state ($state) | |
Set the state. | |
variant_number_changed () | |
Whether this processing this step has changed the variant number. | |
Static Public Member Functions | |
static | load_from_records ($records, $attemptstepid, $qtype=null) |
Create a question_attempt_step from records loaded from the database. | |
Protected Attributes | |
string | $newresponsesummary = null |
the new response summary, if there is one. | |
int | $newvariant = null |
the new variant number, if there is one. | |
A subclass of {.
When we are processing some new submitted data, which may or may not lead to a new step being added to the {
|
inherited |
Update full user information for step.
stdClass | $user | Full user object. |
coding_exception |
|
inherited |
Get all the data.
behaviour variables have the - at the start of their name. This is only intended for internal use, for example by {
array | name => value pairs. |
Reimplemented in question_attempt_step_subquestion_adapter.
|
inherited |
Get all the behaviour variables.
array | name => value pairs. NOTE! the name has the leading - stripped off. (If you don't understand the note, read the comment at the top of this class :-)) |
Reimplemented in question_attempt_step_subquestion_adapter.
|
inherited |
string | $name | the name of a behaviour variable to look for in the submitted data. |
string | the requested variable, or null if the variable is not set. |
Reimplemented in question_attempt_step_subquestion_adapter.
|
inherited |
null|number | the fraction (grade on a scale of minfraction .. maxfraction, normally 0..1), or null if this step has not been marked. |
Reimplemented in question_attempt_step_subquestion_adapter.
|
inherited |
int|null | The id of this step in the database. null if this step is not stored in the database. |
|
inherited |
Get a metadata variable.
Do not call this method directly from your code. It is for internal use only. You should call {
string | $name | the name of the variable to set. [a-z][a-z0-9]*. |
string | the value to set previously, or null if this variable was never set. |
question_attempt_pending_step::get_new_response_summary | ( | ) |
Get the new response summary, if there is one.
string | the new response summary, or null if it has not changed. |
question_attempt_pending_step::get_new_variant_number | ( | ) |
Get the new variant number, if there is one.
int | the new variant number, or null if it has not changed. |
|
inherited |
Get all the question type variables.
array | name => value pairs. |
Reimplemented in question_attempt_step_subquestion_adapter.
|
inherited |
Get the latest set of files for a particular question type variable of type question_attempt\PARAM_FILES.
string | $name | the name of the associated variable. |
int | $contextid | contextid of the question attempt |
array | of { |
Reimplemented in question_attempt_step_subquestion_adapter.
|
inherited |
string | $name | the name of a question type variable to look for in the submitted data. |
string | the requested variable, or null if the variable is not set. |
Reimplemented in question_attempt_step_subquestion_adapter.
|
inherited |
question_state | The state after this step. |
Reimplemented in question_attempt_step_subquestion_adapter.
|
inherited |
Get all the submitted data, but not the cached data.
behaviour variables have the - at the start of their name. This is only really intended for use by {
array | name => value pairs. |
Reimplemented in question_attempt_step_subquestion_adapter.
|
inherited |
int | the timestamp when this step was created. |
Reimplemented in question_attempt_step_subquestion_adapter.
|
inherited |
Return the full user object.
null|stdClass | Get full user object. |
|
inherited |
Get full name of user who did action.
string | full name of user. |
|
inherited |
int | the id of the user resonsible for creating this step. |
Reimplemented in question_attempt_step_subquestion_adapter.
|
inherited |
string | $name | the name of a behaviour variable to look for in the submitted data. |
bool | whether a variable with this name exists in the question type data. |
Reimplemented in question_attempt_step_subquestion_adapter.
|
inherited |
Whether this step has a metadata variable.
Do not call this method directly from your code. It is for internal use only. You should call {
string | $name | the name of the variable to set. [a-z][a-z0-9]*. |
bool | the value to set previously, or null if this variable was never set. |
|
inherited |
string | $name | the name of a question type variable to look for in the submitted data. |
bool | whether a variable with this name exists in the question type data. |
Reimplemented in question_attempt_step_subquestion_adapter.
|
staticinherited |
Create a question_attempt_step from records loaded from the database.
Iterator | $records | Raw records loaded from the database. |
int | $stepid | The id of the records to extract. |
string | $qtype | The question type of which this is an attempt. If not given, each record must include a qtype field. |
question_attempt_step | The newly constructed question_attempt_step. |
|
inherited |
Prepare a draft file are for the files belonging the a response variable of this step.
string | $name | the variable name the files belong to. |
int | $contextid | the id of the context the quba belongs to. |
int | the draft itemid. |
Reimplemented in question_attempt_step_subquestion_adapter.
|
inherited |
Prepare a draft file are for the files belonging the a response variable of this step, while rewriting the URLs in some text.
string | $name | the variable name the files belong to. |
int | $contextid | the id of the context the quba belongs to. |
string | null | $text | the text to update the URLs in. |
array(int,string) | the draft itemid and the text with URLs rewritten. |
Reimplemented in question_attempt_step_subquestion_adapter.
question_attempt_pending_step::response_summary_changed | ( | ) |
Whether this processing this step has changed the response summary.
bool | true if there is a new response summary. |
|
inherited |
Rewrite the @PLUGINFILE@ tokens in a response variable from this step that contains links to file.
Normally you should probably call {
string | $text | the text to update the URLs in. |
int | $contextid | the id of the context the quba belongs to. |
string | $name | the variable name the files belong to. |
array | $extras | extra file path components. |
string | the rewritten text. |
Reimplemented in question_attempt_step_subquestion_adapter.
|
inherited |
Set a cached behaviour variable.
string | $name | the name of the variable to set. Must match _[a-z][a-z0-9]*. |
string | $value | the value to set. |
Reimplemented in question_attempt_step_read_only, and question_attempt_step_subquestion_adapter.
|
inherited |
Set the fraction.
Normally only called by behaviours.
null | number | $fraction | the fraction to set. |
Reimplemented in question_attempt_step_read_only, and question_attempt_step_subquestion_adapter.
|
inherited |
Set a metadata variable.
Do not call this method directly from your code. It is for internal use only. You should call {
string | $name | the name of the variable to set. [a-z][a-z0-9]*. |
string | $value | the value to set. |
question_attempt_pending_step::set_new_response_summary | ( | $responsesummary | ) |
If as a result of processing this step, the response summary for the question attempt should changed, you should call this method to set the new summary.
string | $responsesummary | the new response summary. |
question_attempt_pending_step::set_new_variant_number | ( | $variant | ) |
If as a result of processing this step, you identify that this variant of the question is actually identical to the another one, you may change the variant number recorded, in order to give better statistics.
For an example see qbehaviour_opaque.
int | $variant | the new variant number. |
|
inherited |
Set a cached question type variable.
string | $name | the name of the variable to set. Must match _[a-z][a-z0-9]*. |
string | $value | the value to set. |
Reimplemented in question_attempt_step_read_only, and question_attempt_step_subquestion_adapter.
|
inherited |
Set the state.
Normally only called by behaviours.
question_state | $state | one of the { |
Reimplemented in question_attempt_step_read_only, and question_attempt_step_subquestion_adapter.
question_attempt_pending_step::variant_number_changed | ( | ) |
Whether this processing this step has changed the variant number.
bool | true if there is a new variant number. |