blob: 05bf5967f24d4b6162595aff5adb971714f4a111 (
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
|
<?php
declare(strict_types=1);
/**
* SPDX-FileCopyrightText: 2024 Nextcloud GmbH and Nextcloud contributors
* SPDX-License-Identifier: AGPL-3.0-only
*/
namespace OCP\Config\Lexicon;
use OCP\AppFramework\Attribute\Implementable;
/**
* This interface needs to be implemented if you want to define a config lexicon for your application
* The config lexicon is used to avoid conflicts and problems when storing/retrieving config values
*/
#[Implementable(since: '32.0.0')]
interface ILexicon {
/**
* Define the expected behavior when using config
* keys not set within your application config lexicon.
*
* @return Strictness
* @since 32.0.0
*@see Strictness
*/
public function getStrictness(): Strictness;
/**
* define the list of entries of your application config lexicon, related to AppConfig.
*
* @return Entry[]
* @since 32.0.0
*/
public function getAppConfigs(): array;
/**
* define the list of entries of your application config lexicon, related to UserPreferences.
*
* @return Entry[]
* @since 32.0.0
*/
public function getUserConfigs(): array;
}
|
