Search moodle.org's
Developer Documentation

See Release Notes
Long Term Support Release

  • Bug fixes for general core bugs in 4.1.x will end 13 November 2023 (12 months).
  • Bug fixes for security issues in 4.1.x will end 10 November 2025 (36 months).
  • PHP version: minimum PHP 7.4.0 Note: minimum PHP version has increased since Moodle 4.0. PHP 8.0.x is supported too.
/mod/quiz/accessrule/seb/classes/event/ -> access_prevented.php (source)

[Source view]

Differences Between: [Versions 310 and 401] [Versions 311 and 401] [Versions 39 and 401] [Versions 401 and 402] [Versions 401 and 403]

Event for when access to a quiz is prevented by this subplugin.

Author: Andrew Madden <andrewmadden@catalyst-au.net>
Copyright: 2020 Catalyst IT
License: http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
File Size: 127 lines (5 kb)
Included or required:0 times
Referenced: 0 times
Includes or requires: 0 files

Defines 1 class

access_prevented:: (6 methods):
  create_strict()
  init()
  get_name()
  get_description()
  get_objectid_mapping()
  get_other_mapping()


Class: access_prevented  - X-Ref

Event for when access to a quiz is prevented by this subplugin.

create_strict(access_manager $accessmanager, string $reason,?string $configkey = null, ?string $browserexamkey = null)   X-Ref
Create event with strict parameters.

Define strict parameters to create event with instead of relying on internal validation of array. Better code practice.
Easier for consumers of this class to know what data must be supplied and observers can have more trust in event data.

param: access_manager $accessmanager Access manager.
param: string $reason Reason that access was prevented.
param: string|null $configkey A Safe Exam Browser config key.
param: string|null $browserexamkey A Safe Exam Browser browser exam key.
return: base

init()   X-Ref
Initialize the event data.


get_name()   X-Ref
Get the name of the event.

return: string Name of event.

get_description()   X-Ref
Returns non-localised event description with id's for admin use only.

return: string Description.

get_objectid_mapping()   X-Ref
This is used when restoring course logs where it is required that we
map the objectid to it's new value in the new course.

return: array Mapping of object id.

get_other_mapping()   X-Ref
This is used when restoring course logs where it is required that we
map the information in 'other' to it's new value in the new course.

return: array List of mapping of other ids.