Moodle APIs  3.8
Moodle 3.8.6 (Build: 20201109)
Public Member Functions | Protected Attributes | List of all members
core_privacy\local\metadata\types\database_table Class Reference

The database_table type. More...

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

Public Member Functions

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

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.

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$nameThe name of the database table being described.
array$privacyfieldsA list of fields with their description.
string$summaryA 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: