Moodle PHP Documentation 4.5
Moodle 4.5dev (Build: 20240606) (d3ae1391abe)
quizaccess_ipaddress Class Reference
Inheritance diagram for quizaccess_ipaddress:
mod_quiz\local\access_rule_base

Public Member Functions

 add_preflight_check_form_fields (preflight_check_form $quizform, MoodleQuickForm $mform, $attemptid)
 Add any field you want to pre-flight check form.
 
 attempt_must_be_in_popup ()
 Does this rule requires the attempt (and review) to be displayed in a pop-up window?
 
 current_attempt_finished ()
 This is called when the current attempt at the quiz is finished.
 
 description ()
 Return a brief summary of this rule, to show to users, if required.
 
 end_time ($attempt)
 Time by which, according to this rule, the user has to finish their attempt.
 
 get_popup_options ()
 Any options required when showing the attempt in a pop-up.
 
 get_superceded_rules ()
 It is possible for one rule to override other rules.
 
 is_finished ($numprevattempts, $lastattempt)
 Is the current user unable to start any more attempts in future, because of this rule?
 
 is_preflight_check_required ($attemptid)
 Does this rule require a UI check with the user before an attempt is started?
 
 notify_preflight_check_passed ($attemptid)
 The pre-flight check has passed.
 
 prevent_access ()
 Whether the user should be blocked from starting a new attempt or continuing an attempt now.
 
 prevent_new_attempt ($numprevattempts, $lastattempt)
 Whether a user should be allowed to start a new attempt at this quiz now.
 
 setup_attempt_page ($page)
 Sets up the attempt (review or summary) page with any special extra properties required by this rule.
 
 time_left_display ($attempt, $timenow)
 If the user should be shown a different amount of time than $timenow - $this->end_time(), then override this method.
 
 validate_preflight_check ($data, $files, $errors, $attemptid)
 Validate the pre-flight check form submission.
 

Static Public Member Functions

static add_settings_form_fields (mod_quiz_mod_form $quizform, MoodleQuickForm $mform)
 Add any fields that this rule requires to the quiz settings form.
 
static delete_settings ($quiz)
 Delete any rule-specific settings when the quiz is deleted.
 
static get_browser_security_choices ()
 Get any options this rule adds to the 'Browser security' quiz setting.
 
static get_extra_settings ($quizid)
 You can use this method to load any extra settings your plugin has that cannot be loaded efficiently with get_settings_sql().
 
static get_settings_sql ($quizid)
 Return the bits of SQL needed to load all the settings from all the access plugins in one DB query.
 
static make (quiz_settings $quizobj, $timenow, $canignoretimelimits)
 Return an appropriately configured instance of this rule, if it is applicable to the given quiz, otherwise return null.
 
static save_settings ($quiz)
 Save any submitted settings when the quiz settings form is submitted.
 
static validate_settings_form_fields (array $errors, array $data, $files, mod_quiz_mod_form $quizform)
 Validate the data from any form fields added using {.
 

Protected Attributes

stdClass $quiz
 the quiz settings.
 
quiz_settings $quizobj
 the quiz object.
 
int $timenow
 the time to use as 'now'.
 

Member Function Documentation

◆ add_preflight_check_form_fields()

mod_quiz\local\access_rule_base::add_preflight_check_form_fields ( preflight_check_form $quizform,
MoodleQuickForm $mform,
$attemptid )
inherited

Add any field you want to pre-flight check form.

You should only do something here if {

See also
is_preflight_check_required()} returned true.
Parameters
preflight_check_form$quizformthe form being built.
MoodleQuickForm$mformThe wrapped MoodleQuickForm.
int | null$attemptidthe id of the current attempt, if there is one, otherwise null.

Reimplemented in quizaccess_offlineattempts, quizaccess_password, and quizaccess_timelimit.

◆ add_settings_form_fields()

static mod_quiz\local\access_rule_base::add_settings_form_fields ( mod_quiz_mod_form $quizform,
MoodleQuickForm $mform )
staticinherited

Add any fields that this rule requires to the quiz settings form.

This method is called from {

See also
mod_quiz_mod_form\definition()}, while the security seciton is being built.
Parameters
mod_quiz_mod_form$quizformthe quiz settings form that is being built.
MoodleQuickForm$mformthe wrapped MoodleQuickForm.

Reimplemented in quizaccess_offlineattempts, and quizaccess_seb.

◆ attempt_must_be_in_popup()

mod_quiz\local\access_rule_base::attempt_must_be_in_popup ( )
inherited

Does this rule requires the attempt (and review) to be displayed in a pop-up window?

Return values
booltrue if it does.

Reimplemented in quizaccess_securewindow.

◆ current_attempt_finished()

mod_quiz\local\access_rule_base::current_attempt_finished ( )
inherited

This is called when the current attempt at the quiz is finished.

This is used, for example by the password rule, to clear the flag in the session.

Reimplemented in quizaccess_offlineattempts, quizaccess_password, and quizaccess_seb.

◆ delete_settings()

static mod_quiz\local\access_rule_base::delete_settings ( $quiz)
staticinherited

Delete any rule-specific settings when the quiz is deleted.

This is called from {

See also
quiz_delete_instance()} in lib.php.
Parameters
stdClass$quizthe data from the database, including $quiz->id which is the id of the quiz being deleted.
Since
Moodle 2.7.1, 2.6.4, 2.5.7

Reimplemented in quizaccess_seb.

◆ description()

mod_quiz\local\access_rule_base::description ( )
inherited

Return a brief summary of this rule, to show to users, if required.

This information is show shown, for example, on the quiz view page, to explain this restriction. There is no obligation to return anything. If it is not appropriate to tell students about this rule, then just return ''.

Return values
stringa message, or array of messages, explaining the restriction (may be '' if no message is appropriate).

Reimplemented in quizaccess_numattempts, quizaccess_password, quizaccess_seb, and quizaccess_timelimit.

◆ end_time()

mod_quiz\local\access_rule_base::end_time ( $attempt)
inherited

Time by which, according to this rule, the user has to finish their attempt.

Parameters
stdClass$attemptthe current attempt
Return values
int|falsethe attempt close time, or false if there is no close time.

Reimplemented in quizaccess_openclosedate, and quizaccess_timelimit.

◆ get_browser_security_choices()

static mod_quiz\local\access_rule_base::get_browser_security_choices ( )
staticinherited

Get any options this rule adds to the 'Browser security' quiz setting.

Return values
arraykey => lang string any choices to add to the quiz Browser security settings menu.

Reimplemented in quizaccess_securewindow.

◆ get_extra_settings()

static mod_quiz\local\access_rule_base::get_extra_settings ( $quizid)
staticinherited

You can use this method to load any extra settings your plugin has that cannot be loaded efficiently with get_settings_sql().

Parameters
int$quizidthe quiz id.
Return values
arraysetting value name => value. The value names should all start with the name of your plugin to avoid collisions.

◆ get_popup_options()

mod_quiz\local\access_rule_base::get_popup_options ( )
inherited

Any options required when showing the attempt in a pop-up.

Return values
arrayany options that are required for showing the attempt page in a popup window.

Reimplemented in quizaccess_securewindow.

◆ get_settings_sql()

static mod_quiz\local\access_rule_base::get_settings_sql ( $quizid)
staticinherited

Return the bits of SQL needed to load all the settings from all the access plugins in one DB query.

The easiest way to understand what you need to do here is probably to read the code of {

See also
access_manager\load_settings()}.

If you have some settings that cannot be loaded in this way, then you can use the {

See also
get_extra_settings()} method instead, but that has performance implications.
Parameters
int$quizidthe id of the quiz we are loading settings for. This can also be accessed as quiz.id in the SQL. (quiz is a table alisas for {quiz}.)
Return values
arraywith three elements:
  1. fields: any fields to add to the select list. These should be alised if neccessary so that the field name starts the name of the plugin.
  2. joins: any joins (should probably be LEFT JOINS) with other tables that are needed.
  3. params: array of placeholder values that are needed by the SQL. You must used named placeholders, and the placeholder names should start with the plugin name, to avoid collisions.

Reimplemented in quizaccess_seb.

◆ get_superceded_rules()

mod_quiz\local\access_rule_base::get_superceded_rules ( )
inherited

It is possible for one rule to override other rules.

The aim is that third-party rules should be able to replace sandard rules if they want. See, for example MDL-13592.

Return values
arrayplugin names of other rules that this one replaces. For example ['ipaddress', 'password'].

◆ is_finished()

mod_quiz\local\access_rule_base::is_finished ( $numprevattempts,
$lastattempt )
inherited

Is the current user unable to start any more attempts in future, because of this rule?

If this rule can determine that this user will never be allowed another attempt at this quiz, for example because the last possible start time is past, or all attempts have been used up, then return true. This is used to know whether to display a final grade on the view page. This will only be called if there is not a currently active attempt for this user.

Parameters
int$numprevattemptsthe number of previous attempts this user has made.
stdClass$lastattemptinformation about the user's last completed attempt.
Return values
booltrue if this rule means that this user will never be allowed another attempt at this quiz.

Reimplemented in quizaccess_delaybetweenattempts, quizaccess_numattempts, and quizaccess_openclosedate.

◆ is_preflight_check_required()

mod_quiz\local\access_rule_base::is_preflight_check_required ( $attemptid)
inherited

Does this rule require a UI check with the user before an attempt is started?

Parameters
int | null$attemptidthe id of the current attempt, if there is one, otherwise null.
Return values
boolwhether a check is required before the user starts/continues their attempt.

Reimplemented in quizaccess_offlineattempts, quizaccess_password, and quizaccess_timelimit.

◆ make()

static quizaccess_ipaddress::make ( quiz_settings $quizobj,
$timenow,
$canignoretimelimits )
static

Return an appropriately configured instance of this rule, if it is applicable to the given quiz, otherwise return null.

Parameters
quiz_settings$quizobjinformation about the quiz in question.
int$timenowthe time that should be considered as 'now'.
bool$canignoretimelimitswhether the current user is exempt from time limits by the mod/quiz:ignoretimelimits capability.
Return values
self|nullthe rule, if applicable, else null.

Reimplemented from mod_quiz\local\access_rule_base.

◆ notify_preflight_check_passed()

mod_quiz\local\access_rule_base::notify_preflight_check_passed ( $attemptid)
inherited

The pre-flight check has passed.

This is a chance to record that fact in some way.

Parameters
int | null$attemptidthe id of the current attempt, if there is one, otherwise null.

Reimplemented in quizaccess_offlineattempts, and quizaccess_password.

◆ prevent_access()

quizaccess_ipaddress::prevent_access ( )

Whether the user should be blocked from starting a new attempt or continuing an attempt now.

Return values
stringfalse if access should be allowed, a message explaining the reason if access should be prevented.

Reimplemented from mod_quiz\local\access_rule_base.

◆ prevent_new_attempt()

mod_quiz\local\access_rule_base::prevent_new_attempt ( $numprevattempts,
$lastattempt )
inherited

Whether a user should be allowed to start a new attempt at this quiz now.

Parameters
int$numprevattemptsthe number of previous attempts this user has made.
stdClass$lastattemptinformation about the user's last completed attempt.
Return values
stringfalse if access should be allowed, a message explaining the reason if access should be prevented.

Reimplemented in quizaccess_delaybetweenattempts, and quizaccess_numattempts.

◆ save_settings()

static mod_quiz\local\access_rule_base::save_settings ( $quiz)
staticinherited

Save any submitted settings when the quiz settings form is submitted.

This is called from {

See also
quiz_after_add_or_update()} in lib.php.
Parameters
stdClass$quizthe data from the quiz form, including $quiz->id which is the id of the quiz being saved.

Reimplemented in quizaccess_seb.

◆ setup_attempt_page()

mod_quiz\local\access_rule_base::setup_attempt_page ( $page)
inherited

Sets up the attempt (review or summary) page with any special extra properties required by this rule.

securewindow rule is an example of where this is used.

Parameters
moodle_page$pagethe page object to initialise.

Reimplemented in quizaccess_seb, and quizaccess_securewindow.

◆ time_left_display()

mod_quiz\local\access_rule_base::time_left_display ( $attempt,
$timenow )
inherited

If the user should be shown a different amount of time than $timenow - $this->end_time(), then override this method.

This is useful if the time remaining is large enough to be omitted.

Parameters
stdClass$attemptthe current attempt
int$timenowthe time now. We don't use $this->timenow, so we can give the user a more accurate indication of how much time is left.
Return values
mixedthe time left in seconds (can be negative) or false if there is no limit.

Reimplemented in quizaccess_openclosedate, and quizaccess_timelimit.

◆ validate_preflight_check()

mod_quiz\local\access_rule_base::validate_preflight_check ( $data,
$files,
$errors,
$attemptid )
inherited

Validate the pre-flight check form submission.

You should only do something here if {

See also
is_preflight_check_required()} returned true.

If the form validates, the user will be allowed to continue.

Parameters
array$datathe submitted form data.
array$filesany files in the submission.
array$errorsthe list of validation errors that is being built up.
int | null$attemptidthe id of the current attempt, if there is one, otherwise null.
Return values
arraythe update $errors array;

Reimplemented in quizaccess_offlineattempts, and quizaccess_password.

◆ validate_settings_form_fields()

static mod_quiz\local\access_rule_base::validate_settings_form_fields ( array $errors,
array $data,
$files,
mod_quiz_mod_form $quizform )
staticinherited

Validate the data from any form fields added using {.

See also
add_settings_form_fields()}.
Parameters
array$errorsthe errors found so far.
array$datathe submitted form data.
array$filesinformation about any uploaded files.
mod_quiz_mod_form$quizformthe quiz form object.
Return values
array\$errorsthe updated $errors array.

Reimplemented in quizaccess_offlineattempts, and quizaccess_seb.


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