aboutsummaryrefslogtreecommitdiffstats
path: root/lib/unstable/Config/Lexicon/IConfigLexicon.php
diff options
context:
space:
mode:
Diffstat (limited to 'lib/unstable/Config/Lexicon/IConfigLexicon.php')
-rw-r--r--lib/unstable/Config/Lexicon/IConfigLexicon.php55
1 files changed, 55 insertions, 0 deletions
diff --git a/lib/unstable/Config/Lexicon/IConfigLexicon.php b/lib/unstable/Config/Lexicon/IConfigLexicon.php
new file mode 100644
index 00000000000..74dc19e7728
--- /dev/null
+++ b/lib/unstable/Config/Lexicon/IConfigLexicon.php
@@ -0,0 +1,55 @@
+<?php
+
+declare(strict_types=1);
+/**
+ * SPDX-FileCopyrightText: 2024 Nextcloud GmbH and Nextcloud contributors
+ * SPDX-License-Identifier: AGPL-3.0-only
+ */
+
+namespace NCU\Config\Lexicon;
+
+/**
+ * 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
+ *
+ * @experimental 31.0.0
+ * @deprecated 32.0.0 use \OCP\Config\Lexicon\ILexicon
+ * @see \OCP\Config\Lexicon\ILexicon
+ */
+interface IConfigLexicon {
+
+ /**
+ * Define the expected behavior when using config
+ * keys not set within your application config lexicon.
+ *
+ * @return ConfigLexiconStrictness
+ * @experimental 31.0.0
+ * @deprecated 32.0.0 use \OCP\Config\Lexicon\ILexicon
+ * @see \OCP\Config\Lexicon\ILexicon
+ * @psalm-suppress DeprecatedClass
+ *
+ */
+ public function getStrictness(): ConfigLexiconStrictness;
+
+ /**
+ * define the list of entries of your application config lexicon, related to AppConfig.
+ *
+ * @return ConfigLexiconEntry[]
+ * @experimental 31.0.0
+ * @deprecated 32.0.0 use \OCP\Config\Lexicon\ILexicon
+ * @see \OCP\Config\Lexicon\ILexicon
+ * @psalm-suppress DeprecatedClass
+ */
+ public function getAppConfigs(): array;
+
+ /**
+ * define the list of entries of your application config lexicon, related to UserPreferences.
+ *
+ * @return ConfigLexiconEntry[]
+ * @experimental 31.0.0
+ * @deprecated 32.0.0 use \OCP\Config\Lexicon\ILexicon
+ * @see \OCP\Config\Lexicon\ILexicon
+ * @psalm-suppress DeprecatedClass
+ */
+ public function getUserConfigs(): array;
+}