IDeclarativeSettingsForm.php 2.5 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081
  1. <?php
  2. declare(strict_types=1);
  3. /**
  4. * @copyright Copyright (c) 2023 Kate Döen <kate.doeen@nextcloud.com>
  5. *
  6. * @author Kate Döen <kate.doeen@nextcloud.com>
  7. *
  8. * @license GNU AGPL version 3 or any later version
  9. *
  10. * This program is free software: you can redistribute it and/or modify
  11. * it under the terms of the GNU Affero General Public License as
  12. * published by the Free Software Foundation, either version 3 of the
  13. * License, or (at your option) any later version.
  14. *
  15. * This program is distributed in the hope that it will be useful,
  16. * but WITHOUT ANY WARRANTY; without even the implied warranty of
  17. * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
  18. * GNU Affero General Public License for more details.
  19. *
  20. * You should have received a copy of the GNU Affero General Public License
  21. * along with this program. If not, see <http://www.gnu.org/licenses/>.
  22. *
  23. */
  24. namespace OCP\Settings;
  25. /**
  26. * @since 29.0.0
  27. *
  28. * @psalm-type DeclarativeSettingsSectionType = 'admin'|'personal'
  29. *
  30. * @psalm-type DeclarativeSettingsStorageType = 'internal'|'external'
  31. *
  32. * @psalm-type DeclarativeSettingsValueTypes = string|int|float|bool|list<string>
  33. *
  34. * @psalm-type DeclarativeSettingsFormField = array{
  35. * id: string,
  36. * title: string,
  37. * description?: string,
  38. * type: 'text'|'password'|'email'|'tel'|'url'|'number'|'checkbox'|'multi-checkbox'|'radio'|'select'|'multi-select',
  39. * placeholder?: string,
  40. * label?: string,
  41. * default: mixed,
  42. * options?: list<string|array{name: string, value: mixed}>,
  43. * }
  44. *
  45. * @psalm-type DeclarativeSettingsFormFieldWithValue = DeclarativeSettingsFormField&array{
  46. * value: DeclarativeSettingsValueTypes,
  47. * }
  48. *
  49. * @psalm-type DeclarativeSettingsFormSchema = array{
  50. * id: string,
  51. * priority: int,
  52. * section_type: DeclarativeSettingsSectionType,
  53. * section_id: string,
  54. * storage_type: DeclarativeSettingsStorageType,
  55. * title: string,
  56. * description?: string,
  57. * doc_url?: string,
  58. * }
  59. *
  60. * @psalm-type DeclarativeSettingsFormSchemaWithValues = DeclarativeSettingsFormSchema&array{
  61. * app: string,
  62. * fields: list<DeclarativeSettingsFormFieldWithValue>,
  63. * }
  64. *
  65. * @psalm-type DeclarativeSettingsFormSchemaWithoutValues = DeclarativeSettingsFormSchema&array{
  66. * fields: list<DeclarativeSettingsFormField>,
  67. * }
  68. */
  69. interface IDeclarativeSettingsForm {
  70. /**
  71. * Gets the schema that defines the declarative settings form
  72. *
  73. * @return DeclarativeSettingsFormSchemaWithoutValues
  74. * @since 29.0.0
  75. */
  76. public function getSchema(): array;
  77. }