summaryrefslogtreecommitdiffstats
path: root/lib/public/INavigationManager.php
diff options
context:
space:
mode:
Diffstat (limited to 'lib/public/INavigationManager.php')
-rw-r--r--lib/public/INavigationManager.php59
1 files changed, 59 insertions, 0 deletions
diff --git a/lib/public/INavigationManager.php b/lib/public/INavigationManager.php
new file mode 100644
index 00000000000..243f6ea3eea
--- /dev/null
+++ b/lib/public/INavigationManager.php
@@ -0,0 +1,59 @@
+<?php
+/**
+ * @author Bart Visscher <bartv@thisnet.nl>
+ * @author Joas Schilling <nickvergessen@owncloud.com>
+ * @author Jörn Friedrich Dreyer <jfd@butonic.de>
+ * @author Morris Jobke <hey@morrisjobke.de>
+ * @author Thomas Müller <thomas.mueller@tmit.eu>
+ *
+ * @copyright Copyright (c) 2016, ownCloud, Inc.
+ * @license AGPL-3.0
+ *
+ * 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.
+ *
+ * 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, version 3,
+ * along with this program. If not, see <http://www.gnu.org/licenses/>
+ *
+ */
+
+/**
+ * Public interface of ownCloud for apps to use.
+ * Navigation manager interface
+ *
+ */
+
+// 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
+namespace OCP;
+
+/**
+ * Manages the ownCloud navigation
+ * @since 6.0.0
+ */
+interface INavigationManager {
+ /**
+ * Creates a new navigation entry
+ *
+ * @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.
+ * @return void
+ * @since 6.0.0
+ */
+ public function add($entry);
+
+ /**
+ * Sets the current navigation entry of the currently running app
+ * @param string $appId id of the app entry to activate (from added $entry)
+ * @return void
+ * @since 6.0.0
+ */
+ public function setActiveEntry($appId);
+}