IDelegatedSettings.php 1.6 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354
  1. <?php
  2. /**
  3. * @copyright Copyright (c) Nextcloud GmbH
  4. *
  5. * @author Carl Schwan <carl@carlschwan.eu>
  6. *
  7. * @license GNU AGPL version 3 or any later version
  8. *
  9. * This program is free software: you can redistribute it and/or modify
  10. * it under the terms of the GNU Affero General Public License as
  11. * published by the Free Software Foundation, either version 3 of the
  12. * License, or (at your option) any later version.
  13. *
  14. * This program is distributed in the hope that it will be useful,
  15. * but WITHOUT ANY WARRANTY; without even the implied warranty of
  16. * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
  17. * GNU Affero General Public License for more details.
  18. *
  19. * You should have received a copy of the GNU Affero General Public License
  20. * along with this program. If not, see <http://www.gnu.org/licenses/>.
  21. *
  22. */
  23. namespace OCP\Settings;
  24. /**
  25. * Special cases of settings that can be allowed to use by member of special
  26. * groups.
  27. * @since 23.0.0
  28. */
  29. interface IDelegatedSettings extends ISettings {
  30. /**
  31. * Get the name of the settings to differentiate settings inside a section or
  32. * null if only the section name should be displayed.
  33. * @since 23.0.0
  34. */
  35. public function getName(): ?string;
  36. /**
  37. * Get a list of authorized app config that this setting is allowed to modify.
  38. * The format of the array is the following:
  39. * ```php
  40. * <?php
  41. * [
  42. * 'app_name' => [
  43. * '/simple_key/', # value
  44. * '/s[a-z]*ldap/', # regex
  45. * ],
  46. * 'another_app_name => [ ... ],
  47. * ]
  48. * ```
  49. * @since 23.0.0
  50. */
  51. public function getAuthorizedAppConfig(): array;
  52. }