aboutsummaryrefslogtreecommitdiffstats
path: root/lib/public/AppFramework/Http/Attribute/AuthorizedAdminSetting.php
blob: e81f195b29893d5514ee9f73e84e50b3cee4e63b (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
<?php

declare(strict_types=1);

/**
 * SPDX-FileCopyrightText: 2023 Nextcloud GmbH and Nextcloud contributors
 * SPDX-License-Identifier: AGPL-3.0-or-later
 */

namespace OCP\AppFramework\Http\Attribute;

use Attribute;
use OCP\Settings\IDelegatedSettings;

/**
 * Attribute for controller methods that should be only accessible with
 * full admin or partial admin permissions.
 *
 * @since 27.0.0
 */
#[Attribute(Attribute::TARGET_METHOD | Attribute::IS_REPEATABLE)]
class AuthorizedAdminSetting {
	/**
	 * @param class-string<IDelegatedSettings> $settings A settings section the user needs to be able to access
	 * @since 27.0.0
	 */
	public function __construct(
		protected string $settings
	) {
	}

	/**
	 *
	 * @return class-string<IDelegatedSettings>
	 * @since 27.0.0
	 */
	public function getSettings(): string {
		return $this->settings;
	}
}