2013-09-20 19:34:33 +04:00
|
|
|
<?php
|
|
|
|
/**
|
2016-07-21 18:07:57 +03:00
|
|
|
* @copyright Copyright (c) 2016, ownCloud, Inc.
|
|
|
|
*
|
2015-03-26 13:44:34 +03:00
|
|
|
* @author Bart Visscher <bartv@thisnet.nl>
|
2020-04-29 12:57:22 +03:00
|
|
|
* @author Christoph Wurst <christoph@winzerhof-wurst.at>
|
2016-07-21 18:07:57 +03:00
|
|
|
* @author Joas Schilling <coding@schilljs.com>
|
2015-03-26 13:44:34 +03:00
|
|
|
* @author Jörn Friedrich Dreyer <jfd@butonic.de>
|
2019-12-03 21:57:53 +03:00
|
|
|
* @author Julius Härtl <jus@bitgrid.net>
|
2015-03-26 13:44:34 +03:00
|
|
|
* @author Morris Jobke <hey@morrisjobke.de>
|
2019-12-03 21:57:53 +03:00
|
|
|
* @author Roeland Jago Douma <roeland@famdouma.nl>
|
2015-03-26 13:44:34 +03:00
|
|
|
* @author Thomas Müller <thomas.mueller@tmit.eu>
|
2013-11-03 16:51:39 +04:00
|
|
|
*
|
2015-03-26 13:44:34 +03:00
|
|
|
* @license AGPL-3.0
|
2013-11-03 16:51:39 +04:00
|
|
|
*
|
2015-03-26 13:44:34 +03:00
|
|
|
* This code is free software: you can redistribute it and/or modify
|
|
|
|
* it under the terms of the GNU Affero General Public License, version 3,
|
|
|
|
* as published by the Free Software Foundation.
|
2013-11-03 16:51:39 +04:00
|
|
|
*
|
2015-03-26 13:44:34 +03:00
|
|
|
* This program is distributed in the hope that it will be useful,
|
2013-11-03 16:51:39 +04:00
|
|
|
* but WITHOUT ANY WARRANTY; without even the implied warranty of
|
2015-03-26 13:44:34 +03:00
|
|
|
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
|
|
|
* GNU Affero General Public License for more details.
|
2013-11-03 16:51:39 +04:00
|
|
|
*
|
2015-03-26 13:44:34 +03:00
|
|
|
* You should have received a copy of the GNU Affero General Public License, version 3,
|
2019-12-03 21:57:53 +03:00
|
|
|
* along with this program. If not, see <http://www.gnu.org/licenses/>
|
2013-11-03 16:38:25 +04:00
|
|
|
*
|
2013-09-20 19:34:33 +04:00
|
|
|
*/
|
2015-02-26 13:37:37 +03:00
|
|
|
|
|
|
|
/**
|
|
|
|
* Public interface of ownCloud for apps to use.
|
|
|
|
* Navigation manager interface
|
|
|
|
*
|
|
|
|
*/
|
|
|
|
|
2013-11-03 16:38:25 +04:00
|
|
|
// use OCP namespace for all classes that are considered public.
|
|
|
|
// This means that they should be used by apps instead of the internal ownCloud classes
|
2019-11-22 22:52:10 +03:00
|
|
|
|
2013-09-20 19:34:33 +04:00
|
|
|
namespace OCP;
|
|
|
|
|
|
|
|
/**
|
2013-09-20 23:45:27 +04:00
|
|
|
* Manages the ownCloud navigation
|
2015-04-16 18:00:08 +03:00
|
|
|
* @since 6.0.0
|
2013-09-20 19:34:33 +04:00
|
|
|
*/
|
|
|
|
interface INavigationManager {
|
2019-02-18 11:12:11 +03:00
|
|
|
|
|
|
|
/**
|
|
|
|
* Navigation entries of the app navigation
|
|
|
|
* @since 16.0.0
|
|
|
|
*/
|
2020-04-10 17:54:27 +03:00
|
|
|
public const TYPE_APPS = 'link';
|
2019-02-18 11:12:11 +03:00
|
|
|
|
|
|
|
/**
|
|
|
|
* Navigation entries of the settings navigation
|
|
|
|
* @since 16.0.0
|
|
|
|
*/
|
2020-04-10 17:54:27 +03:00
|
|
|
public const TYPE_SETTINGS = 'settings';
|
2019-02-18 11:12:11 +03:00
|
|
|
|
|
|
|
/**
|
|
|
|
* Navigation entries for public page footer navigation
|
|
|
|
* @since 16.0.0
|
|
|
|
*/
|
2020-04-10 17:54:27 +03:00
|
|
|
public const TYPE_GUEST = 'guest';
|
2019-02-18 11:12:11 +03:00
|
|
|
|
2013-09-20 19:34:33 +04:00
|
|
|
/**
|
|
|
|
* Creates a new navigation entry
|
2015-03-16 18:17:43 +03:00
|
|
|
*
|
|
|
|
* @param array|\Closure $entry Array containing: id, name, order, icon and href key
|
|
|
|
* The use of a closure is preferred, because it will avoid
|
|
|
|
* loading the routing of your app, unless required.
|
2014-02-06 19:30:58 +04:00
|
|
|
* @return void
|
2015-04-16 18:00:08 +03:00
|
|
|
* @since 6.0.0
|
2013-09-20 19:34:33 +04:00
|
|
|
*/
|
2015-03-16 18:17:43 +03:00
|
|
|
public function add($entry);
|
2013-09-20 19:34:33 +04:00
|
|
|
|
|
|
|
/**
|
|
|
|
* Sets the current navigation entry of the currently running app
|
|
|
|
* @param string $appId id of the app entry to activate (from added $entry)
|
2014-02-06 19:30:58 +04:00
|
|
|
* @return void
|
2015-04-16 18:00:08 +03:00
|
|
|
* @since 6.0.0
|
2013-09-20 19:34:33 +04:00
|
|
|
*/
|
|
|
|
public function setActiveEntry($appId);
|
2018-01-29 14:17:47 +03:00
|
|
|
|
2020-08-04 11:00:27 +03:00
|
|
|
/**
|
|
|
|
* Get the current navigation entry of the currently running app
|
|
|
|
* @return string
|
|
|
|
* @since 20.0.0
|
|
|
|
*/
|
|
|
|
public function getActiveEntry();
|
|
|
|
|
2018-01-29 14:17:47 +03:00
|
|
|
/**
|
|
|
|
* Get a list of navigation entries
|
|
|
|
*
|
2018-02-15 12:38:25 +03:00
|
|
|
* @param string $type type of the navigation entries
|
2018-01-29 14:17:47 +03:00
|
|
|
* @return array
|
|
|
|
* @since 14.0.0
|
|
|
|
*/
|
2019-02-18 11:12:11 +03:00
|
|
|
public function getAll(string $type = self::TYPE_APPS): array;
|
2013-09-20 23:45:27 +04:00
|
|
|
}
|