1
0

IIconSection.php 1.8 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566
  1. <?php
  2. /**
  3. * @copyright Copyright (c) 2017, Joas Schilling <coding@schilljs.com>
  4. *
  5. * @author Joas Schilling <coding@schilljs.com>
  6. * @author Morris Jobke <hey@morrisjobke.de>
  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 12
  27. */
  28. interface IIconSection {
  29. /**
  30. * returns the ID of the section. It is supposed to be a lower case string,
  31. * e.g. 'ldap'
  32. *
  33. * @return string
  34. * @since 9.1
  35. */
  36. public function getID();
  37. /**
  38. * returns the translated name as it should be displayed, e.g. 'LDAP / AD
  39. * integration'. Use the L10N service to translate it.
  40. *
  41. * @return string
  42. * @since 9.1
  43. */
  44. public function getName();
  45. /**
  46. * @return int whether the form should be rather on the top or bottom of
  47. * the settings navigation. The sections are arranged in ascending order of
  48. * the priority values. It is required to return a value between 0 and 99.
  49. *
  50. * E.g.: 70
  51. * @since 9.1
  52. */
  53. public function getPriority();
  54. /**
  55. * returns the relative path to an 16*16 icon describing the section.
  56. * e.g. '/core/img/places/files.svg'
  57. *
  58. * @return string
  59. * @since 12
  60. */
  61. public function getIcon();
  62. }