ISettings.php 1.6 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354
  1. <?php
  2. /**
  3. * @copyright Copyright (c) 2016 Arthur Schiwon <blizzz@arthur-schiwon.de>
  4. *
  5. * @author Arthur Schiwon <blizzz@arthur-schiwon.de>
  6. * @author Christoph Wurst <christoph@winzerhof-wurst.at>
  7. * @author Lukas Reschke <lukas@statuscode.ch>
  8. *
  9. * @license GNU AGPL version 3 or any later version
  10. *
  11. * This program is free software: you can redistribute it and/or modify
  12. * it under the terms of the GNU Affero General Public License as
  13. * published by the Free Software Foundation, either version 3 of the
  14. * License, or (at your option) any later version.
  15. *
  16. * This program is distributed in the hope that it will be useful,
  17. * but WITHOUT ANY WARRANTY; without even the implied warranty of
  18. * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
  19. * GNU Affero General Public License for more details.
  20. *
  21. * You should have received a copy of the GNU Affero General Public License
  22. * along with this program. If not, see <http://www.gnu.org/licenses/>.
  23. *
  24. */
  25. namespace OCP\Settings;
  26. use OCP\AppFramework\Http\TemplateResponse;
  27. /**
  28. * @since 9.1
  29. */
  30. interface ISettings {
  31. /**
  32. * @return TemplateResponse returns the instance with all parameters set, ready to be rendered
  33. * @since 9.1
  34. */
  35. public function getForm();
  36. /**
  37. * @return string|null the section ID, e.g. 'sharing' or null to not show the setting
  38. * @since 9.1
  39. */
  40. public function getSection();
  41. /**
  42. * @return int whether the form should be rather on the top or bottom of
  43. * the admin section. The forms are arranged in ascending order of the
  44. * priority values. It is required to return a value between 0 and 100.
  45. *
  46. * E.g.: 70
  47. * @since 9.1
  48. */
  49. public function getPriority();
  50. }