Section.php 2.0 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778
  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 OC\Settings;
  24. use OCP\Settings\ISection;
  25. class Section implements ISection {
  26. /** @var string */
  27. private $id;
  28. /** @var string */
  29. private $name;
  30. /** @var int */
  31. private $priority;
  32. /**
  33. * @param string $id
  34. * @param string $name
  35. * @param int $priority
  36. */
  37. public function __construct($id, $name, $priority) {
  38. $this->id = $id;
  39. $this->name = $name;
  40. $this->priority = $priority;
  41. }
  42. /**
  43. * returns the ID of the section. It is supposed to be a lower case string,
  44. * e.g. 'ldap'
  45. *
  46. * @returns string
  47. */
  48. public function getID() {
  49. return $this->id;
  50. }
  51. /**
  52. * returns the translated name as it should be displayed, e.g. 'LDAP / AD
  53. * integration'. Use the L10N service to translate it.
  54. *
  55. * @return string
  56. */
  57. public function getName() {
  58. return $this->name;
  59. }
  60. /**
  61. * @return int whether the form should be rather on the top or bottom of
  62. * the settings navigation. The sections are arranged in ascending order of
  63. * the priority values. It is required to return a value between 0 and 99.
  64. *
  65. * E.g.: 70
  66. */
  67. public function getPriority() {
  68. return $this->priority;
  69. }
  70. }