2013-09-20 15:34:33 +00:00
|
|
|
<?php
|
|
|
|
/**
|
2015-02-26 10:37:37 +00:00
|
|
|
* ownCloud
|
2013-11-03 12:51:39 +00:00
|
|
|
*
|
2015-02-26 10:37:37 +00:00
|
|
|
* @author Bart Visscher
|
|
|
|
* @copyright 2013 Bart Visscher bartv@thisnet.nl
|
2013-11-03 12:51:39 +00:00
|
|
|
*
|
2015-02-26 10:37:37 +00:00
|
|
|
* This library is free software; you can redistribute it and/or
|
|
|
|
* modify it under the terms of the GNU AFFERO GENERAL PUBLIC LICENSE
|
|
|
|
* License as published by the Free Software Foundation; either
|
|
|
|
* version 3 of the License, or any later version.
|
2013-11-03 12:51:39 +00:00
|
|
|
*
|
2015-02-26 10:37:37 +00:00
|
|
|
* This library is distributed in the hope that it will be useful,
|
2013-11-03 12:51:39 +00:00
|
|
|
* but WITHOUT ANY WARRANTY; without even the implied warranty of
|
2015-02-26 10:37:37 +00:00
|
|
|
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
|
|
|
* GNU AFFERO GENERAL PUBLIC LICENSE for more details.
|
2013-11-03 12:51:39 +00:00
|
|
|
*
|
2015-02-26 10:37:37 +00:00
|
|
|
* You should have received a copy of the GNU Affero General Public
|
|
|
|
* License along with this library. If not, see <http://www.gnu.org/licenses/>.
|
2013-11-03 12:38:25 +00:00
|
|
|
*
|
2013-09-20 15:34:33 +00:00
|
|
|
*/
|
2015-02-26 10:37:37 +00:00
|
|
|
|
|
|
|
/**
|
|
|
|
* Public interface of ownCloud for apps to use.
|
|
|
|
* Navigation manager interface
|
|
|
|
*
|
|
|
|
*/
|
|
|
|
|
2013-11-03 12:38:25 +00: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
|
2013-09-20 15:34:33 +00:00
|
|
|
namespace OCP;
|
|
|
|
|
|
|
|
/**
|
2013-09-20 19:45:27 +00:00
|
|
|
* Manages the ownCloud navigation
|
2013-09-20 15:34:33 +00:00
|
|
|
*/
|
|
|
|
interface INavigationManager {
|
|
|
|
/**
|
|
|
|
* Creates a new navigation entry
|
2015-03-16 15:17:43 +00: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 15:30:58 +00:00
|
|
|
* @return void
|
2013-09-20 15:34:33 +00:00
|
|
|
*/
|
2015-03-16 15:17:43 +00:00
|
|
|
public function add($entry);
|
2013-09-20 15:34:33 +00: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 15:30:58 +00:00
|
|
|
* @return void
|
2013-09-20 15:34:33 +00:00
|
|
|
*/
|
|
|
|
public function setActiveEntry($appId);
|
2013-09-20 19:45:27 +00:00
|
|
|
}
|