Search moodle.org's
Developer Documentation

See Release Notes

  • Bug fixes for general core bugs in 3.11.x will end 14 Nov 2022 (12 months plus 6 months extension).
  • Bug fixes for security issues in 3.11.x will end 13 Nov 2023 (18 months plus 12 months extension).
  • PHP version: minimum PHP 7.3.0 Note: minimum PHP version has increased since Moodle 3.10. PHP 7.4.x is supported too.

Base class for site policy handlers.

Copyright: 2018 Marina Glancy
License: http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
File Size: 113 lines (4 kb)
Included or required:0 times
Referenced: 0 times
Includes or requires: 0 files

Defines 1 class

handler:: (3 methods):
  is_defined()
  accept()
  signup_form()


Class: handler  - X-Ref

Base class for site policy handlers.

If a plugin wants to act as a site policy handler it has to define class
PLUGINNAME\privacy\sitepolicy\handler that extends \core_privacy\sitepolicy\handler

is_defined($forguests = false)   X-Ref
Checks if the site has site policy defined

param: bool $forguests
return: bool

accept()   X-Ref
Accept site policy for the current user

return: bool - false if sitepolicy not defined, user is not logged in or user has already agreed to site policy;

signup_form($mform)   X-Ref
Adds "Agree to site policy" checkbox to the signup form.

Sitepolicy handlers can override the simple checkbox with their own controls.

param: \MoodleQuickForm $mform