ISection.php 1.6 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657
  1. <?php
  2. /**
  3. * @copyright Copyright (c) 2016 Arthur Schiwon <blizzz@arthur-schiwon.de>
  4. *
  5. * @author Arthur Schiwon <blizzz@arthur-schiwon.de>
  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. * @since 9.1
  26. */
  27. interface ISection {
  28. /**
  29. * returns the ID of the section. It is supposed to be a lower case string,
  30. * e.g. 'ldap'
  31. *
  32. * @returns string
  33. * @since 9.1
  34. */
  35. public function getID();
  36. /**
  37. * returns the translated name as it should be displayed, e.g. 'LDAP / AD
  38. * integration'. Use the L10N service to translate it.
  39. *
  40. * @return string
  41. * @since 9.1
  42. */
  43. public function getName();
  44. /**
  45. * @return int whether the form should be rather on the top or bottom of
  46. * the settings navigation. The sections are arranged in ascending order of
  47. * the priority values. It is required to return a value between 0 and 99.
  48. *
  49. * E.g.: 70
  50. * @since 9.1
  51. */
  52. public function getPriority();
  53. }