aboutsummaryrefslogtreecommitdiffstats
path: root/lib/public/Settings/Events/DeclarativeSettingsGetValueEvent.php
blob: 73f3f8b8561ed9317e892a70a138a3f49e9e3369 (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
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
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;
	}
}