Class implementation for a site policy handler.
More...
|
static | accept () |
| Accept site policy for the current user.
|
|
static | get_embed_url ($forguests=false) |
| 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)
|
|
static | get_redirect_url ($forguests=false) |
| Returns URL to redirect user to when user needs to agree to site policy.
|
|
static | is_defined ($forguests=false) |
| Checks if the site has site policy defined.
|
|
static | signup_form ($mform) |
| Adds "Agree to site policy" checkbox to the signup form.
|
|
Class implementation for a site policy handler.
- Copyright
- 2018 Sara Arjona sara@.nosp@m.mood.nosp@m.le.co.nosp@m.m
- License
- http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
◆ accept()
static tool_policy\privacy\local\sitepolicy\handler::accept |
( |
| ) |
|
|
static |
Accept site policy for the current user.
- Return values
-
bool | - false if sitepolicy not defined, user is not logged in or user has already agreed to site policy; true - if we have successfully marked the user as agreed to the site policy |
Reimplemented from core_privacy\local\sitepolicy\handler.
◆ get_embed_url()
static tool_policy\privacy\local\sitepolicy\handler::get_embed_url |
( |
| $forguests = false | ) |
|
|
static |
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 self::accept() on completion.
- Parameters
-
- Return values
-
Reimplemented from core_privacy\local\sitepolicy\handler.
◆ get_redirect_url()
static tool_policy\privacy\local\sitepolicy\handler::get_redirect_url |
( |
| $forguests = false | ) |
|
|
static |
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.
- Parameters
-
- Return values
-
moodle_url|null | (returns null if site policy is not defined) |
Reimplemented from core_privacy\local\sitepolicy\handler.
◆ is_defined()
static core_privacy\local\sitepolicy\handler::is_defined |
( |
| $forguests = false | ) |
|
|
staticinherited |
◆ signup_form()
static tool_policy\privacy\local\sitepolicy\handler::signup_form |
( |
| $mform | ) |
|
|
static |
The documentation for this class was generated from the following file:
- admin/tool/policy/classes/privacy/local/sitepolicy/handler.php