Search moodle.org's
Developer Documentation
Developer Documentation
- Bug fixes for general core bugs in 4.0.x will end 8 May 2023 (12 months).
- Bug fixes for security issues in 4.0.x will end 13 November 2023 (18 months).
- PHP version: minimum PHP 7.3.0 Note: the minimum PHP version has increased since Moodle 3.10. PHP 7.4.x is also supported.
Default (core) handler for site policies.
| Copyright: | 2018 Marina Glancy |
| License: | http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later |
| File Size: | 96 lines (3 kb) |
| Included or required: | 0 times |
| Referenced: | 0 times |
| Includes or requires: | 0 files |
Defines 1 class
default_handler:: (3 methods):
is_defined()
get_redirect_url()
get_embed_url()
Class: default_handler - X-Ref
Default (core) handler for site policies.| is_defined($forguests = false) X-Ref |
| Checks if the site has site policy defined return: bool param: bool $forguests |
| get_redirect_url($forguests = false) X-Ref |
| Returns URL to redirect user to when user needs to agree to site policy This is a regular interactive page for web users. It should have normal Moodle header/footers, it should allow user to view policies and accept them. return: moodle_url|null (returns null if site policy is not defined) param: bool $forguests |
| get_embed_url($forguests = false) X-Ref |
| Returns URL of the site policy that needs to be displayed to the user (inside iframe or to use in WS such as mobile app) This page should not have any header/footer, it does not also have any buttons/checkboxes. The caller needs to implement the "Accept" button and call {@link self::accept()} on completion. return: moodle_url|null param: bool $forguests |
