blob: 88a8a297c54685d94086a4730e5c5a9600a36c7b (
plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
|
<?php
/**
* @copyright Copyright (c) 2016 Arthur Schiwon <blizzz@arthur-schiwon.de>
*
* @author Arthur Schiwon <blizzz@arthur-schiwon.de>
* @author Christoph Wurst <christoph@winzerhof-wurst.at>
* @author Joas Schilling <coding@schilljs.com>
* @author Lukas Reschke <lukas@statuscode.ch>
*
* @license GNU AGPL version 3 or any later version
*
* This program is free software: you can redistribute it and/or modify
* it under the terms of the GNU Affero General Public License as
* published by the Free Software Foundation, either version 3 of the
* License, or (at your option) any later version.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU Affero General Public License for more details.
*
* You should have received a copy of the GNU Affero General Public License
* along with this program. If not, see <http://www.gnu.org/licenses/>.
*
*/
namespace OCP\Settings;
/**
* @since 9.1
*/
interface IManager {
/**
* @since 9.1.0
*/
public const KEY_ADMIN_SETTINGS = 'admin';
/**
* @since 9.1.0
*/
public const KEY_ADMIN_SECTION = 'admin-section';
/**
* @since 13.0.0
*/
public const KEY_PERSONAL_SETTINGS = 'personal';
/**
* @since 13.0.0
*/
public const KEY_PERSONAL_SECTION = 'personal-section';
/**
* @param string $type 'admin' or 'personal'
* @param string $section Class must implement OCP\Settings\ISection
* @since 14.0.0
*/
public function registerSection(string $type, string $section);
/**
* @param string $type 'admin' or 'personal'
* @param string $setting Class must implement OCP\Settings\ISetting
* @since 14.0.0
*/
public function registerSetting(string $type, string $setting);
/**
* returns a list of the admin sections
*
* @return array array of ISection[] where key is the priority
* @since 9.1.0
*/
public function getAdminSections(): array;
/**
* returns a list of the personal sections
*
* @return array array of ISection[] where key is the priority
* @since 13.0.0
*/
public function getPersonalSections(): array;
/**
* returns a list of the admin settings
*
* @param string $section the section id for which to load the settings
* @param bool $subAdminOnly only return settings sub admins are supposed to see (since 17.0.0)
* @return array array of IAdmin[] where key is the priority
* @since 9.1.0
*/
public function getAdminSettings($section, bool $subAdminOnly = false): array;
/**
* returns a list of the personal settings
*
* @param string $section the section id for which to load the settings
* @return array array of IPersonal[] where key is the priority
* @since 13.0.0
*/
public function getPersonalSettings($section): array;
}
|
