aboutsummaryrefslogtreecommitdiffstats
path: root/lib/public/Settings/IDelegatedSettings.php
blob: ae885dee705f7476ad456bc6eb744ca7cbb7aea5 (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
<?php

/**
 * SPDX-FileCopyrightText: 2021 Nextcloud GmbH and Nextcloud contributors
 * SPDX-License-Identifier: AGPL-3.0-or-later
 */
namespace OCP\Settings;

/**
 * Special cases of settings that can be allowed to use by member of special
 * groups.
 * @since 23.0.0
 */
interface IDelegatedSettings extends ISettings {
	/**
	 * Get the name of the settings to differentiate settings inside a section or
	 * null if only the section name should be displayed.
	 * @since 23.0.0
	 */
	public function getName(): ?string;

	/**
	 * Get a list of authorized app config that this setting is allowed to modify.
	 * The format of the array is the following:
	 * ```php
	 * <?php
	 * [
	 * 		'app_name' => [
	 * 			'/simple_key/', # value
	 * 			'/s[a-z]*ldap/', # regex
	 * 		],
	 * 		'another_app_name => [ ... ],
	 * ]
	 * ```
	 * @since 23.0.0
	 */
	public function getAuthorizedAppConfig(): array;
}