| 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 |
* Container for structuring data, usually from a database.
|
|
|
19 |
*
|
|
|
20 |
* @package block_dash
|
|
|
21 |
* @copyright 2019 bdecent gmbh <https://bdecent.de>
|
|
|
22 |
* @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
|
|
|
23 |
*/
|
|
|
24 |
|
|
|
25 |
namespace block_dash\local\data_grid\data;
|
|
|
26 |
/**
|
|
|
27 |
* Container for structuring data, usually from a database.
|
|
|
28 |
*
|
|
|
29 |
* @package block_dash
|
|
|
30 |
*/
|
|
|
31 |
interface data_collection_interface {
|
|
|
32 |
/**
|
|
|
33 |
* Get all fields in this data collection.
|
|
|
34 |
*
|
|
|
35 |
* @return field_interface[]
|
|
|
36 |
*/
|
|
|
37 |
public function get_data();
|
|
|
38 |
|
|
|
39 |
/**
|
|
|
40 |
* Add data to data collection.
|
|
|
41 |
*
|
|
|
42 |
* @param field_interface $field
|
|
|
43 |
*/
|
|
|
44 |
public function add_data(field_interface $field);
|
|
|
45 |
|
|
|
46 |
/**
|
|
|
47 |
* Add raw data to collection.
|
|
|
48 |
*
|
|
|
49 |
* @param array $data Associative array of data
|
|
|
50 |
*/
|
|
|
51 |
public function add_data_associative($data);
|
|
|
52 |
|
|
|
53 |
/**
|
|
|
54 |
* Get child data collections.
|
|
|
55 |
*
|
|
|
56 |
* @param string $type Name of collection type to return. Null returns all.
|
|
|
57 |
* @return data_collection_interface[]
|
|
|
58 |
*/
|
|
|
59 |
public function get_child_collections($type = null);
|
|
|
60 |
|
|
|
61 |
/**
|
|
|
62 |
* Add a child data collection.
|
|
|
63 |
*
|
|
|
64 |
* @param string $type Name of collection type.
|
|
|
65 |
* @param data_collection_interface $collection
|
|
|
66 |
*/
|
|
|
67 |
public function add_child_collection($type, data_collection_interface $collection);
|
|
|
68 |
|
|
|
69 |
/**
|
|
|
70 |
* Check if this collection contains any child collection of data.
|
|
|
71 |
*
|
|
|
72 |
* @return bool
|
|
|
73 |
*/
|
|
|
74 |
public function has_child_collections();
|
|
|
75 |
|
|
|
76 |
/**
|
|
|
77 |
* Returns true if data collection has no data or child collections.
|
|
|
78 |
*
|
|
|
79 |
* @return bool
|
|
|
80 |
*/
|
|
|
81 |
public function is_empty();
|
|
|
82 |
}
|