95 lines
2.3 KiB
PHP
95 lines
2.3 KiB
PHP
|
<?php
|
||
|
|
/**
|
||
|
|
* @copyright Copyright (c) 2016 Arthur Schiwon <blizzz@arthur-schiwon.de>
|
||
|
|
*
|
||
|
|
* @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
|
||
|
|
*
|
||
|
|
* 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 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;
|
||
|
|
}
|
||
|
|
|
||
|
|
/**
|
||
|
|
* returns the ID of the section. It is supposed to be a lower case string,
|
||
|
|
* e.g. 'ldap'
|
||
|
|
*
|
||
|
|
* @returns string
|
||
|
|
*/
|
||
|
|
public function getID() {
|
||
|
|
return $this->id;
|
||
|
|
}
|
||
|
|
|
||
|
|
/**
|
||
|
|
* returns the translated name as it should be displayed, e.g. 'LDAP / AD
|
||
|
|
* integration'. Use the L10N service to translate it.
|
||
|
|
*
|
||
|
|
* @return string
|
||
|
|
*/
|
||
|
|
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;
|
||
|
|
}
|
||
|
|
|
||
|
|
/**
|
||
|
|
* returns the relative path to an 16*16 icon describing the section.
|
||
|
|
* e.g. '/core/img/places/files.svg'
|
||
|
|
*
|
||
|
|
* @returns string
|
||
|
|
* @since 12
|
||
|
|
*/
|
||
|
|
public function getIcon() {
|
||
|
|
return $this->icon;
|
||
|
|
}
|
||
|
|
}
|