0
0
Fork 0
mirror of https://github.com/nextcloud/server.git synced 2025-01-31 06:43:12 +00:00
nextcloud_server/lib/public/Settings/IDeclarativeSettingsFormWithHandlers.php
Ferdinand Thiessen 9a7e1bb227
feat(DeclarativeSettings): Allow to implement value getter and setter directly in Form
Instead of implementing the form class, a setter event listener and a getter event listener,
this allows to simply write a basic class that provides `getSchema`, `setValue` and `getValue` functions.

Signed-off-by: Ferdinand Thiessen <opensource@fthiessen.de>
2024-10-15 20:33:45 +02:00

31 lines
677 B
PHP

<?php
declare(strict_types=1);
/**
* SPDX-FileCopyrightText: 2024 Nextcloud GmbH and Nextcloud contributors
* SPDX-License-Identifier: AGPL-3.0-or-later
*/
namespace OCP\Settings;
use OCP\IUser;
/**
* @since 31.0.0
*/
interface IDeclarativeSettingsFormWithHandlers extends IDeclarativeSettingsForm {
/**
* This function is called to get the current value of a specific forms field.
* @since 31.0.0
*/
public function getValue(string $fieldId, IUser $user): mixed;
/**
* This function is called when a user updated a form field to persist the setting.
* @since 31.0.0
*/
public function setValue(string $fieldId, mixed $value, IUser $user): void;
}