mirror of
https://github.com/nextcloud/server.git
synced 2024-08-17 02:10:52 +02:00
046d5451b1
Before every setting page had the same title and this is causing issues for screenreaders since they can't differenciate the title of page. Now a new variable is available for apps to declare the page subtitle. This new variable is implemented for the settings app and while at it I added a bit more type hinting to the stuff I touched :) Signed-off-by: Carl Schwan <carl@carlschwan.eu>
67 lines
1.8 KiB
PHP
67 lines
1.8 KiB
PHP
<?php
|
|
/**
|
|
* @copyright Copyright (c) 2017, Joas Schilling <coding@schilljs.com>
|
|
*
|
|
* @author Joas Schilling <coding@schilljs.com>
|
|
* @author Morris Jobke <hey@morrisjobke.de>
|
|
*
|
|
* @license GNU AGPL version 3 or any later version
|
|
*
|
|
* This program is free software: you can redistribute it and/or modify
|
|
* it under the terms of the GNU Affero General Public License as
|
|
* published by the Free Software Foundation, either version 3 of the
|
|
* License, or (at your option) any later version.
|
|
*
|
|
* This program is distributed in the hope that it will be useful,
|
|
* but WITHOUT ANY WARRANTY; without even the implied warranty of
|
|
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
|
* GNU Affero General Public License for more details.
|
|
*
|
|
* You should have received a copy of the GNU Affero General Public License
|
|
* along with this program. If not, see <http://www.gnu.org/licenses/>.
|
|
*
|
|
*/
|
|
namespace OCP\Settings;
|
|
|
|
/**
|
|
* @since 12
|
|
*/
|
|
interface IIconSection {
|
|
/**
|
|
* returns the ID of the section. It is supposed to be a lower case string,
|
|
* e.g. 'ldap'
|
|
*
|
|
* @return 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'
|
|
*
|
|
* @return string
|
|
* @since 12
|
|
*/
|
|
public function getIcon();
|
|
}
|