diff options
Diffstat (limited to 'lib/private/Settings/Section.php')
-rw-r--r-- | lib/private/Settings/Section.php | 70 |
1 files changed, 70 insertions, 0 deletions
diff --git a/lib/private/Settings/Section.php b/lib/private/Settings/Section.php new file mode 100644 index 00000000000..6cd8885d2df --- /dev/null +++ b/lib/private/Settings/Section.php @@ -0,0 +1,70 @@ +<?php + +/** + * SPDX-FileCopyrightText: 2016 Nextcloud GmbH and Nextcloud contributors + * SPDX-License-Identifier: AGPL-3.0-or-later + */ +namespace OC\Settings; + +use OCP\Settings\IIconSection; + +class Section implements IIconSection { + /** @var string */ + private $id; + /** @var string */ + private $name; + /** @var int */ + private $priority; + /** @var string */ + private $icon; + + /** + * @param string $id + * @param string $name + * @param int $priority + * @param string $icon + */ + public function __construct($id, $name, $priority, $icon = '') { + $this->id = $id; + $this->name = $name; + $this->priority = $priority; + $this->icon = $icon; + } + + /** + * @return string The ID of the section. It is supposed to be a lower case string, + * e.g. 'ldap' + */ + public function getID() { + return $this->id; + } + + /** + * @return string The translated name as it should be displayed, e.g. 'LDAP / AD + * integration'. Use the L10N service to translate it. + */ + public function getName() { + return $this->name; + } + + /** + * @return int whether the form should be rather on the top or bottom of + * the settings navigation. The sections are arranged in ascending order of + * the priority values. It is required to return a value between 0 and 99. + * + * E.g.: 70 + */ + public function getPriority() { + return $this->priority; + } + + /** + * @return string The relative path to an 16*16 icon describing the section. + * e.g. '/core/img/places/files.svg' + * + * @since 12 + */ + public function getIcon() { + return $this->icon; + } +} |