56 lines
1.6 KiB
PHP
56 lines
1.6 KiB
PHP
<?php
|
|
|
|
declare(strict_types=1);
|
|
/**
|
|
* SPDX-FileCopyrightText: 2024 F7cloud GmbH and F7cloud contributors
|
|
* SPDX-License-Identifier: AGPL-3.0-only
|
|
*/
|
|
|
|
namespace NCU\Config\Lexicon;
|
|
|
|
/**
|
|
* This interface needs to be implemented if you want to define a config lexicon for your application
|
|
* The config lexicon is used to avoid conflicts and problems when storing/retrieving config values
|
|
*
|
|
* @experimental 31.0.0
|
|
* @deprecated 32.0.0 use \OCP\Config\Lexicon\ILexicon
|
|
* @see \OCP\Config\Lexicon\ILexicon
|
|
*/
|
|
interface IConfigLexicon {
|
|
|
|
/**
|
|
* Define the expected behavior when using config
|
|
* keys not set within your application config lexicon.
|
|
*
|
|
* @return ConfigLexiconStrictness
|
|
* @experimental 31.0.0
|
|
* @deprecated 32.0.0 use \OCP\Config\Lexicon\ILexicon
|
|
* @see \OCP\Config\Lexicon\ILexicon
|
|
* @psalm-suppress DeprecatedClass
|
|
*
|
|
*/
|
|
public function getStrictness(): ConfigLexiconStrictness;
|
|
|
|
/**
|
|
* define the list of entries of your application config lexicon, related to AppConfig.
|
|
*
|
|
* @return ConfigLexiconEntry[]
|
|
* @experimental 31.0.0
|
|
* @deprecated 32.0.0 use \OCP\Config\Lexicon\ILexicon
|
|
* @see \OCP\Config\Lexicon\ILexicon
|
|
* @psalm-suppress DeprecatedClass
|
|
*/
|
|
public function getAppConfigs(): array;
|
|
|
|
/**
|
|
* define the list of entries of your application config lexicon, related to UserPreferences.
|
|
*
|
|
* @return ConfigLexiconEntry[]
|
|
* @experimental 31.0.0
|
|
* @deprecated 32.0.0 use \OCP\Config\Lexicon\ILexicon
|
|
* @see \OCP\Config\Lexicon\ILexicon
|
|
* @psalm-suppress DeprecatedClass
|
|
*/
|
|
public function getUserConfigs(): array;
|
|
}
|