aboutsummaryrefslogtreecommitdiffstats
path: root/lib/public/Settings/IDeclarativeManager.php
diff options
context:
space:
mode:
Diffstat (limited to 'lib/public/Settings/IDeclarativeManager.php')
-rw-r--r--lib/public/Settings/IDeclarativeManager.php75
1 files changed, 75 insertions, 0 deletions
diff --git a/lib/public/Settings/IDeclarativeManager.php b/lib/public/Settings/IDeclarativeManager.php
new file mode 100644
index 00000000000..5c21ee6750b
--- /dev/null
+++ b/lib/public/Settings/IDeclarativeManager.php
@@ -0,0 +1,75 @@
+<?php
+
+declare(strict_types=1);
+
+/**
+ * SPDX-FileCopyrightText: 2023 Nextcloud GmbH and Nextcloud contributors
+ * SPDX-License-Identifier: AGPL-3.0-or-later
+ */
+
+namespace OCP\Settings;
+
+use Exception;
+use OC\AppFramework\Middleware\Security\Exceptions\NotAdminException;
+use OCP\IUser;
+
+/**
+ * @since 29.0.0
+ *
+ * @psalm-import-type DeclarativeSettingsValueTypes from IDeclarativeSettingsForm
+ * @psalm-import-type DeclarativeSettingsSectionType from IDeclarativeSettingsForm
+ * @psalm-import-type DeclarativeSettingsFormSchemaWithValues from IDeclarativeSettingsForm
+ * @psalm-import-type DeclarativeSettingsFormSchemaWithoutValues from IDeclarativeSettingsForm
+ */
+interface IDeclarativeManager {
+ /**
+ * Registers a new declarative settings schema.
+ *
+ * @param DeclarativeSettingsFormSchemaWithoutValues $schema
+ * @since 29.0.0
+ */
+ public function registerSchema(string $app, array $schema): void;
+
+ /**
+ * Load all schemas from the registration context and events.
+ *
+ * @since 29.0.0
+ */
+ public function loadSchemas(): void;
+
+ /**
+ * Gets the IDs of the forms for the given type and section.
+ *
+ * @param DeclarativeSettingsSectionType $type
+ * @param string $section
+ * @return array<string, list<string>>
+ *
+ * @since 29.0.0
+ */
+ public function getFormIDs(IUser $user, string $type, string $section): array;
+
+ /**
+ * Gets the forms including the field values for the given type and section.
+ *
+ * @param IUser $user Used for reading values from the personal section or for authorization for the admin section.
+ * @param ?DeclarativeSettingsSectionType $type If it is null the forms will not be filtered by type.
+ * @param ?string $section If it is null the forms will not be filtered by section.
+ * @return list<DeclarativeSettingsFormSchemaWithValues>
+ *
+ * @since 29.0.0
+ */
+ public function getFormsWithValues(IUser $user, ?string $type, ?string $section): array;
+
+ /**
+ * Sets a value for the given field ID.
+ *
+ * @param IUser $user Used for storing values in the personal section or for authorization for the admin section.
+ * @param DeclarativeSettingsValueTypes $value
+ *
+ * @throws Exception
+ * @throws NotAdminException
+ *
+ * @since 29.0.0
+ */
+ public function setValue(IUser $user, string $app, string $formId, string $fieldId, mixed $value): void;
+}