core_privacy\local\sitepolicy\handler Class Reference

Base class for site policy handlers. More...

Inheritance diagram for core_privacy\local\sitepolicy\handler:

Static Public Member Functions
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.

Detailed Description

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

Copyright

2018 Marina Glancy

License

http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later

Member Function Documentation

accept()

static core_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 in tool_policy\privacy\local\sitepolicy\handler.

get_embed_url()

static core_privacy\local\sitepolicy\handler::get_embed_url ( $forguests = false )

staticabstract

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

bool

$forguests

Return values

moodle_url|null

Reimplemented in core_privacy\local\sitepolicy\default_handler, and tool_policy\privacy\local\sitepolicy\handler.

get_redirect_url()

static core_privacy\local\sitepolicy\handler::get_redirect_url ( $forguests = false )

staticabstract

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

bool

$forguests

Return values

moodle_url|null

(returns null if site policy is not defined)

Reimplemented in core_privacy\local\sitepolicy\default_handler, and tool_policy\privacy\local\sitepolicy\handler.

is_defined()

static core_privacy\local\sitepolicy\handler::is_defined ( $forguests = false )

static

Checks if the site has site policy defined.

Parameters

bool

$forguests

Return values

bool

Reimplemented in core_privacy\local\sitepolicy\default_handler.

signup_form()

static core_privacy\local\sitepolicy\handler::signup_form ( $mform )

static

Adds "Agree to site policy" checkbox to the signup form.

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

Parameters

MoodleQuickForm

$mform

Reimplemented in tool_policy\privacy\local\sitepolicy\handler.

---

The documentation for this class was generated from the following file:

• privacy/classes/local/sitepolicy/handler.php