diff options
Diffstat (limited to 'lib/public/Settings/IIconSection.php')
-rw-r--r-- | lib/public/Settings/IIconSection.php | 32 |
1 files changed, 31 insertions, 1 deletions
diff --git a/lib/public/Settings/IIconSection.php b/lib/public/Settings/IIconSection.php index 91abe96bc62..1c51b26f27a 100644 --- a/lib/public/Settings/IIconSection.php +++ b/lib/public/Settings/IIconSection.php @@ -2,7 +2,9 @@ /** * @copyright Copyright (c) 2017, Joas Schilling <coding@schilljs.com> * + * @author Arthur Schiwon <blizzz@arthur-schiwon.de> * @author Joas Schilling <coding@schilljs.com> + * @author Lukas Reschke <lukas@statuscode.ch> * * @license GNU AGPL version 3 or any later version * @@ -26,7 +28,35 @@ namespace OCP\Settings; /** * @since 12 */ -interface IIconSection extends ISection { +interface IIconSection { + /** + * returns the ID of the section. It is supposed to be a lower case string, + * e.g. 'ldap' + * + * @returns string + * @since 9.1 + */ + public function getID(); + + /** + * returns the translated name as it should be displayed, e.g. 'LDAP / AD + * integration'. Use the L10N service to translate it. + * + * @return string + * @since 9.1 + */ + public function getName(); + + /** + * @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 + * @since 9.1 + */ + public function getPriority(); + /** * returns the relative path to an 16*16 icon describing the section. * e.g. '/core/img/places/files.svg' |