Proyectos de Subversion Moodle

Rev

| Ultima modificación | Ver Log |

Rev Autor Línea Nro. Línea
1 efrain 1
<?php
2
// This file is part of Moodle - http://moodle.org/
3
//
4
// Moodle is free software: you can redistribute it and/or modify
5
// it under the terms of the GNU General Public License as published by
6
// the Free Software Foundation, either version 3 of the License, or
7
// (at your option) any later version.
8
//
9
// Moodle is distributed in the hope that it will be useful,
10
// but WITHOUT ANY WARRANTY; without even the implied warranty of
11
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
12
// GNU General Public License for more details.
13
//
14
// You should have received a copy of the GNU General Public License
15
// along with Moodle.  If not, see <http://www.gnu.org/licenses/>.
16
 
17
/**
18
 * The base type interface which encapsulates a set of data held by a component with Moodle.
19
 *
20
 * @package core_privacy
21
 * @copyright 2018 Zig Tan <zig@moodle.com>
22
 * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
23
 */
24
namespace core_privacy\local\metadata\types;
25
 
26
defined('MOODLE_INTERNAL') || die();
27
 
28
/**
29
 * The base type interface which all metadata types must implement.
30
 *
31
 * @copyright 2018 Zig Tan <zig@moodle.com>
32
 * @package core_privacy
33
 */
34
interface type {
35
 
36
    /**
37
     * Get the name describing this type.
38
     *
39
     * @return  string
40
     */
41
    public function get_name();
42
 
43
    /**
44
     * A list of the fields and their usage description.
45
     *
46
     * @return  array
47
     */
48
    public function get_privacy_fields();
49
 
50
    /**
51
     * A summary of what the metalink type is used for.
52
     *
53
     * @return string $summary
54
     */
55
    public function get_summary();
56
}