|
1
|
|
|
<?php |
|
2
|
|
|
|
|
3
|
|
|
/** |
|
4
|
|
|
* Directus – <http://getdirectus.com> |
|
5
|
|
|
* |
|
6
|
|
|
* @link The canonical repository – <https://github.com/directus/directus> |
|
7
|
|
|
* @copyright Copyright 2006-2016 RANGER Studio, LLC – <http://rangerstudio.com> |
|
8
|
|
|
* @license GNU General Public License (v3) – <http://www.gnu.org/copyleft/gpl.html> |
|
9
|
|
|
*/ |
|
10
|
|
|
|
|
11
|
|
|
namespace Directus\SDK; |
|
12
|
|
|
|
|
13
|
|
|
/** |
|
14
|
|
|
* Requests Interface |
|
15
|
|
|
* |
|
16
|
|
|
* @author Welling Guzmán <[email protected]> |
|
17
|
|
|
*/ |
|
18
|
|
|
interface RequestsInterface |
|
19
|
|
|
{ |
|
20
|
|
|
/** |
|
21
|
|
|
* Gets list of all tables |
|
22
|
|
|
* |
|
23
|
|
|
* @param array $params |
|
24
|
|
|
* |
|
25
|
|
|
* @return array |
|
26
|
|
|
*/ |
|
27
|
|
|
public function getTables(array $params = []); |
|
28
|
|
|
|
|
29
|
|
|
/** |
|
30
|
|
|
* Gets list of the all columns |
|
31
|
|
|
* |
|
32
|
|
|
* @param array $params |
|
33
|
|
|
* |
|
34
|
|
|
* @return array |
|
35
|
|
|
*/ |
|
36
|
|
|
public function getColumns(array $params = []); |
|
37
|
|
|
|
|
38
|
|
|
/** |
|
39
|
|
|
* Fetch columns of a given table |
|
40
|
|
|
* |
|
41
|
|
|
* @param $tableName |
|
42
|
|
|
* @param $params |
|
43
|
|
|
* |
|
44
|
|
|
* @return array |
|
45
|
|
|
*/ |
|
46
|
|
|
public function getTableColumns($tableName, array $params = []); |
|
47
|
|
|
|
|
48
|
|
|
/** |
|
49
|
|
|
* Fetch Information of a given table |
|
50
|
|
|
* |
|
51
|
|
|
* @param $tableName |
|
52
|
|
|
* |
|
53
|
|
|
* @return object |
|
54
|
|
|
*/ |
|
55
|
|
|
public function fetchTableInfo($tableName); |
|
56
|
|
|
|
|
57
|
|
|
/** |
|
58
|
|
|
* Fetch details of a given table's column |
|
59
|
|
|
* |
|
60
|
|
|
* @param $tableName |
|
61
|
|
|
* @param $columnName |
|
62
|
|
|
* |
|
63
|
|
|
* @return array |
|
64
|
|
|
*/ |
|
65
|
|
|
public function fetchColumnInfo($tableName, $columnName); |
|
66
|
|
|
|
|
67
|
|
|
/** |
|
68
|
|
|
* Fetch Items from a given table |
|
69
|
|
|
* |
|
70
|
|
|
* @param string $tableName |
|
71
|
|
|
* @param array $options |
|
72
|
|
|
* |
|
73
|
|
|
* @return object |
|
74
|
|
|
*/ |
|
75
|
|
|
public function getEntries($tableName, array $options = []); |
|
76
|
|
|
|
|
77
|
|
|
/** |
|
78
|
|
|
* Get an entry in a given table by the given ID |
|
79
|
|
|
* |
|
80
|
|
|
* @param mixed $id |
|
81
|
|
|
* @param string $tableName |
|
82
|
|
|
* @param array $options |
|
83
|
|
|
* |
|
84
|
|
|
* @return array |
|
85
|
|
|
*/ |
|
86
|
|
|
public function getEntry($tableName, $id, array $options = []); |
|
87
|
|
|
|
|
88
|
|
|
/** |
|
89
|
|
|
* Gets the list of users |
|
90
|
|
|
* |
|
91
|
|
|
* @param array $params |
|
92
|
|
|
* |
|
93
|
|
|
* @return array |
|
94
|
|
|
*/ |
|
95
|
|
|
public function getUsers(array $params = []); |
|
96
|
|
|
|
|
97
|
|
|
/** |
|
98
|
|
|
* Gets a user by the given id |
|
99
|
|
|
* |
|
100
|
|
|
* @param $id |
|
101
|
|
|
* @param array $params |
|
102
|
|
|
* |
|
103
|
|
|
* @return array |
|
104
|
|
|
*/ |
|
105
|
|
|
public function getUser($id, array $params = []); |
|
106
|
|
|
|
|
107
|
|
|
/** |
|
108
|
|
|
* Fetch List of User groups |
|
109
|
|
|
* |
|
110
|
|
|
* @return object |
|
111
|
|
|
*/ |
|
112
|
|
|
public function fetchGroups(); |
|
113
|
|
|
|
|
114
|
|
|
/** |
|
115
|
|
|
* Fetch the information of a given user group |
|
116
|
|
|
* |
|
117
|
|
|
* @param $groupID |
|
118
|
|
|
* |
|
119
|
|
|
* @return object |
|
120
|
|
|
*/ |
|
121
|
|
|
public function fetchGroupInfo($groupID); |
|
122
|
|
|
|
|
123
|
|
|
/** |
|
124
|
|
|
* Fetch a given group privileges |
|
125
|
|
|
* |
|
126
|
|
|
* @param $groupID |
|
127
|
|
|
* |
|
128
|
|
|
* @return object |
|
129
|
|
|
*/ |
|
130
|
|
|
public function fetchGroupPrivileges($groupID); |
|
131
|
|
|
|
|
132
|
|
|
/** |
|
133
|
|
|
* Fetch list of files |
|
134
|
|
|
* |
|
135
|
|
|
* @return object |
|
136
|
|
|
*/ |
|
137
|
|
|
public function fetchFiles(); |
|
138
|
|
|
|
|
139
|
|
|
/** |
|
140
|
|
|
* Fetch the information of a given file |
|
141
|
|
|
* |
|
142
|
|
|
* @param $fileID |
|
143
|
|
|
* |
|
144
|
|
|
* @return mixed |
|
145
|
|
|
*/ |
|
146
|
|
|
public function fetchFileInfo($fileID); |
|
147
|
|
|
|
|
148
|
|
|
/** |
|
149
|
|
|
* Fetch all settings |
|
150
|
|
|
* |
|
151
|
|
|
* @return object |
|
152
|
|
|
*/ |
|
153
|
|
|
public function fetchSettings(); |
|
154
|
|
|
|
|
155
|
|
|
/** |
|
156
|
|
|
* Fetch all settings in a given collection name |
|
157
|
|
|
* |
|
158
|
|
|
* @param $collectionName |
|
159
|
|
|
* |
|
160
|
|
|
* @return object |
|
161
|
|
|
*/ |
|
162
|
|
|
public function fetchSettingCollection($collectionName); |
|
163
|
|
|
} |
|
164
|
|
|
|
directus /
directus-sdk-php
