core_privacy\local\metadata\types\user_preference Class Reference

The user_preference type. More...

Inheritance diagram for core_privacy\local\metadata\types\user_preference:

Public Member Functions
	__construct ($name, $summary='')
	Constructor to create a new user_preference types. More...
	get_name ()
	The name of the user preference. More...
	get_privacy_fields ()
	A user preference encapsulates a single field and has no sub-fields. More...
	get_summary ()
	A summary of what this user preference is used for. More...

Protected Attributes
The	$name
	name of this user preference.
A	$summary
	description of what this user preference means.

Detailed Description

The user_preference type.

Copyright

2018 Andrew Nicols andre.nosp@m.w@ni.nosp@m.cols..nosp@m.co.u.nosp@m.k

License

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

Constructor & Destructor Documentation

__construct()

core_privacy\local\metadata\types\user_preference::__construct	(		$name,
			$summary = ''
	)

Constructor to create a new user_preference types.

Parameters

string	$name	The name of the user preference.
string	$summary	A description of what the preference is used for.

Member Function Documentation

get_name()

core_privacy\local\metadata\types\user_preference::get_name

(

)

The name of the user preference.

Return values

string

Implements core_privacy\local\metadata\types\type.

get_privacy_fields()

core_privacy\local\metadata\types\user_preference::get_privacy_fields

(

)

A user preference encapsulates a single field and has no sub-fields.

Return values

array

Implements core_privacy\local\metadata\types\type.

get_summary()

core_privacy\local\metadata\types\user_preference::get_summary

(

)

A summary of what this user preference is used for.

Return values

string

Implements core_privacy\local\metadata\types\type.

---

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

• privacy/classes/local/metadata/types/user_preference.php