Moodle PHP Documentation 4.2
Moodle 4.2.8 (Build: 20240610) (2d41ac46f45)
quiz_overview_options Class Reference
Inheritance diagram for quiz_overview_options:
mod_quiz\local\reports\attempts_report_options

Public Member Functions

 get_initial_form_data ()
 Get the current value of the settings to pass to the settings form.
 
 get_url ()
 Get the URL to show the report with these options.
 
 process_settings_from_form ($fromform)
 Process the data we get when the settings form is submitted.
 
 process_settings_from_params ()
 Set up this preferences object using optional_param (using user_preferences to set anything not specified by the params.
 
 resolve_dependencies ()
 Check the settings, and remove any 'impossible' combinations.
 
 setup_from_form_data ($fromform)
 Set the fields of this object from the form data.
 
 setup_from_params ()
 Set the fields of this object from the URL parameters.
 
 setup_from_user_preferences ()
 Set the fields of this object from the user's preferences.
 
 update_user_preferences ()
 Update the user preferences so they match the settings in this object.
 

Public Attributes

string $attempts = attempts_report::ENROLLED_WITH
 attempts_report\ALL_WITH, attempts_report\ENROLLED_WITH, attempts_report\ENROLLED_WITHOUT or attempts_report\ENROLLED_ALL
 
bool $checkboxcolumn = false
 whether the report table should have a column of checkboxes.
 
stdClass $cm
 the course module objects for the quiz being reported on.
 
stdClass $course
 the course settings for the course the quiz is in.
 
string $download = ''
 whether the data should be downloaded in some format, or '' to display it.
 
int $group = 0
 the currently selected group.
 
string $mode
 the report mode.
 
bool $onlygraded = false
 whether to show all finished attmepts, or just the one that gave the final grade for the user.
 
bool $onlyregraded = false
 whether to show only attempt that need regrading.
 
int $pagesize = attempts_report::DEFAULT_PAGE_SIZE
 Number of attempts to show per page.
 
stdClass $quiz
 the settings for the quiz being reported on.
 
bool $slotmarks = true
 whether to show marks for each question (slot).
 
array null $states
 of quiz_attempt\IN_PROGRESS, etc.
 
bool $usercanseegrades
 whether the current user has permission to see grades.
 

Protected Member Functions

 get_url_params ()
 Get the URL parameters required to show the report with these options.
 
 is_showing_finished_attempts ()
 Whether the options are such that finished attempts are being shown.
 

Static Protected Attributes

static array $statefields
 form field name => corresponding quiz_attempt:: state constant.
 

Member Function Documentation

◆ get_initial_form_data()

quiz_overview_options::get_initial_form_data ( )

Get the current value of the settings to pass to the settings form.

Reimplemented from mod_quiz\local\reports\attempts_report_options.

◆ get_url()

mod_quiz\local\reports\attempts_report_options::get_url ( )
inherited

Get the URL to show the report with these options.

Return values
moodle_urlthe URL.

◆ get_url_params()

quiz_overview_options::get_url_params ( )
protected

Get the URL parameters required to show the report with these options.

Return values
arrayURL parameter name => value.

Reimplemented from mod_quiz\local\reports\attempts_report_options.

◆ is_showing_finished_attempts()

mod_quiz\local\reports\attempts_report_options::is_showing_finished_attempts ( )
protectedinherited

Whether the options are such that finished attempts are being shown.

Return values
boolean

◆ process_settings_from_form()

mod_quiz\local\reports\attempts_report_options::process_settings_from_form ( $fromform)
inherited

Process the data we get when the settings form is submitted.

This includes updating the fields of this class, and updating the user preferences where appropriate.

Parameters
stdClass$fromformThe data from $mform->get_data() from the settings form.

◆ resolve_dependencies()

quiz_overview_options::resolve_dependencies ( )

Check the settings, and remove any 'impossible' combinations.

Reimplemented from mod_quiz\local\reports\attempts_report_options.

◆ setup_from_form_data()

quiz_overview_options::setup_from_form_data ( $fromform)

Set the fields of this object from the form data.

Parameters
stdClass$fromformThe data from $mform->get_data() from the settings form.

Reimplemented from mod_quiz\local\reports\attempts_report_options.

◆ setup_from_params()

quiz_overview_options::setup_from_params ( )

Set the fields of this object from the URL parameters.

Reimplemented from mod_quiz\local\reports\attempts_report_options.

◆ setup_from_user_preferences()

quiz_overview_options::setup_from_user_preferences ( )

Set the fields of this object from the user's preferences.

(For those settings that are backed by user-preferences).

Reimplemented from mod_quiz\local\reports\attempts_report_options.

◆ update_user_preferences()

quiz_overview_options::update_user_preferences ( )

Update the user preferences so they match the settings in this object.

(For those settings that are backed by user-preferences).

Reimplemented from mod_quiz\local\reports\attempts_report_options.

Member Data Documentation

◆ $group

int mod_quiz\local\reports\attempts_report_options::$group = 0
inherited

the currently selected group.

0 if no group is selected.

◆ $statefields

array mod_quiz\local\reports\attempts_report_options::$statefields
staticprotectedinherited
Initial value:
= [
'stateinprogress' => quiz_attempt::IN_PROGRESS,
'stateoverdue' => quiz_attempt::OVERDUE,
'statefinished' => quiz_attempt::FINISHED,
'stateabandoned' => quiz_attempt::ABANDONED,
]
string const IN_PROGRESS
to identify the in progress state.
Definition quiz_attempt.php:53
string const FINISHED
to identify the finished state.
Definition quiz_attempt.php:57
string const OVERDUE
to identify the overdue state.
Definition quiz_attempt.php:55
string const ABANDONED
to identify the abandoned state.
Definition quiz_attempt.php:59

form field name => corresponding quiz_attempt:: state constant.

◆ $states

array null mod_quiz\local\reports\attempts_report_options::$states
inherited
Initial value:

of quiz_attempt\IN_PROGRESS, etc.

constants. null means no restriction.


The documentation for this class was generated from the following file: