IIconSection.php 1.0 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748
  1. <?php
  2. /**
  3. * SPDX-FileCopyrightText: 2017 Nextcloud GmbH and Nextcloud contributors
  4. * SPDX-License-Identifier: AGPL-3.0-or-later
  5. */
  6. namespace OCP\Settings;
  7. /**
  8. * @since 12
  9. */
  10. interface IIconSection {
  11. /**
  12. * returns the ID of the section. It is supposed to be a lower case string,
  13. * e.g. 'ldap'
  14. *
  15. * @return string
  16. * @since 9.1
  17. */
  18. public function getID();
  19. /**
  20. * returns the translated name as it should be displayed, e.g. 'LDAP / AD
  21. * integration'. Use the L10N service to translate it.
  22. *
  23. * @return string
  24. * @since 9.1
  25. */
  26. public function getName();
  27. /**
  28. * @return int whether the form should be rather on the top or bottom of
  29. * the settings navigation. The sections are arranged in ascending order of
  30. * the priority values. It is required to return a value between 0 and 99.
  31. *
  32. * E.g.: 70
  33. * @since 9.1
  34. */
  35. public function getPriority();
  36. /**
  37. * returns the relative path to an 16*16 icon describing the section.
  38. * e.g. '/core/img/places/files.svg'
  39. *
  40. * @return string
  41. * @since 12
  42. */
  43. public function getIcon();
  44. }