core_privacy\local\metadata\types\database_table Class Reference

The database_table type. More...

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

Public Member Functions
	__construct ($name, array $privacyfields=[], $summary='')
	Constructor to create a new database_table type.
	get_name ()
	The name of the database table.
	get_privacy_fields ()
	The list of fields within the table which contain user data, with a description of each field.
	get_summary ()
	A summary of what this table is used for.

Protected Attributes
string	$name
	Database table name.
array	$privacyfields
	Fields which contain user information within the table.
string	$summary
	A description of what this table is used for.

Detailed Description

The database_table type.

Copyright

2018 Zig Tan zig@m.nosp@m.oodl.nosp@m.e.com

License

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

Constructor & Destructor Documentation

__construct()

core_privacy\local\metadata\types\database_table::__construct	(		$name,
		array	$privacyfields = [],
			$summary = '' )

Constructor to create a new database_table type.

Parameters

string	$name	The name of the database table being described.
array	$privacyfields	A list of fields with their description.
string	$summary	A description of what the table is used for.

Member Function Documentation

get_name()

core_privacy\local\metadata\types\database_table::get_name

(

)

The name of the database table.

Return values

string

Implements core_privacy\local\metadata\types\type.

get_privacy_fields()

core_privacy\local\metadata\types\database_table::get_privacy_fields

(

)

The list of fields within the table which contain user data, with a description of each field.

Return values

array

Implements core_privacy\local\metadata\types\type.

get_summary()

core_privacy\local\metadata\types\database_table::get_summary

(

)

A summary of what this table 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/database_table.php