Mock handler for site policies
Copyright: | 2018 Marina Glancy |
License: | http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later |
File Size: | 77 lines (3 kb) |
Included or required: | 0 times |
Referenced: | 0 times |
Includes or requires: | 0 files |
mock_sitepolicy_handler:: (3 methods):
get_redirect_url()
get_embed_url()
accept()
Class: mock_sitepolicy_handler - X-Ref
Mock handler for site policiesget_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 |
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; |