ISettings.php 861 B

1234567891011121314151617181920212223242526272829303132333435
  1. <?php
  2. /**
  3. * SPDX-FileCopyrightText: 2016 Nextcloud GmbH and Nextcloud contributors
  4. * SPDX-License-Identifier: AGPL-3.0-or-later
  5. */
  6. namespace OCP\Settings;
  7. use OCP\AppFramework\Http\TemplateResponse;
  8. /**
  9. * @since 9.1
  10. */
  11. interface ISettings {
  12. /**
  13. * @return TemplateResponse returns the instance with all parameters set, ready to be rendered
  14. * @since 9.1
  15. */
  16. public function getForm();
  17. /**
  18. * @return string|null the section ID, e.g. 'sharing' or null to not show the setting
  19. * @since 9.1
  20. */
  21. public function getSection();
  22. /**
  23. * @return int whether the form should be rather on the top or bottom of
  24. * the admin section. The forms are arranged in ascending order of the
  25. * priority values. It is required to return a value between 0 and 100.
  26. *
  27. * E.g.: 70
  28. * @since 9.1
  29. */
  30. public function getPriority();
  31. }