aboutsummaryrefslogtreecommitdiffstats
path: root/lib/public/Settings/Events/DeclarativeSettingsGetValueEvent.php
diff options
context:
space:
mode:
Diffstat (limited to 'lib/public/Settings/Events/DeclarativeSettingsGetValueEvent.php')
-rw-r--r--lib/public/Settings/Events/DeclarativeSettingsGetValueEvent.php88
1 files changed, 88 insertions, 0 deletions
diff --git a/lib/public/Settings/Events/DeclarativeSettingsGetValueEvent.php b/lib/public/Settings/Events/DeclarativeSettingsGetValueEvent.php
new file mode 100644
index 00000000000..73f3f8b8561
--- /dev/null
+++ b/lib/public/Settings/Events/DeclarativeSettingsGetValueEvent.php
@@ -0,0 +1,88 @@
+<?php
+
+declare(strict_types=1);
+
+/**
+ * SPDX-FileCopyrightText: 2023 Nextcloud GmbH and Nextcloud contributors
+ * SPDX-License-Identifier: AGPL-3.0-or-later
+ */
+
+namespace OCP\Settings\Events;
+
+use Exception;
+use OCP\EventDispatcher\Event;
+use OCP\IUser;
+use OCP\Settings\IDeclarativeSettingsForm;
+
+/**
+ * @psalm-import-type DeclarativeSettingsValueTypes from IDeclarativeSettingsForm
+ *
+ * @since 29.0.0
+ */
+class DeclarativeSettingsGetValueEvent extends Event {
+ /**
+ * @var ?DeclarativeSettingsValueTypes
+ */
+ private mixed $value = null;
+
+ /**
+ * @since 29.0.0
+ */
+ public function __construct(
+ private IUser $user,
+ private string $app,
+ private string $formId,
+ private string $fieldId,
+ ) {
+ parent::__construct();
+ }
+
+ /**
+ * @since 29.0.0
+ */
+ public function getUser(): IUser {
+ return $this->user;
+ }
+
+ /**
+ * @since 29.0.0
+ */
+ public function getApp(): string {
+ return $this->app;
+ }
+
+ /**
+ * @since 29.0.0
+ */
+ public function getFormId(): string {
+ return $this->formId;
+ }
+
+ /**
+ * @since 29.0.0
+ */
+ public function getFieldId(): string {
+ return $this->fieldId;
+ }
+
+ /**
+ * @since 29.0.0
+ */
+ public function setValue(mixed $value): void {
+ $this->value = $value;
+ }
+
+ /**
+ * @return DeclarativeSettingsValueTypes
+ * @throws Exception
+ *
+ * @since 29.0.0
+ */
+ public function getValue(): mixed {
+ if ($this->value === null) {
+ throw new Exception('Value not set');
+ }
+
+ return $this->value;
+ }
+}