ISettings.php 1.6 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455
  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 Lukas Reschke <lukas@statuscode.ch>
  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. use OCP\AppFramework\Http\TemplateResponse;
  26. /**
  27. * @since 9.1
  28. */
  29. interface ISettings {
  30. /**
  31. * @return TemplateResponse returns the instance with all parameters set, ready to be rendered
  32. * @since 9.1
  33. */
  34. public function getForm();
  35. /**
  36. * @return string the section ID, e.g. 'sharing'
  37. * @since 9.1
  38. */
  39. public function getSection();
  40. /**
  41. * @return int whether the form should be rather on the top or bottom of
  42. * the admin section. The forms are arranged in ascending order of the
  43. * priority values. It is required to return a value between 0 and 100.
  44. *
  45. * E.g.: 70
  46. * @since 9.1
  47. */
  48. public function getPriority();
  49. }