aboutsummaryrefslogtreecommitdiffstats
path: root/phpBB/phpbb/install/helper/navigation/navigation_interface.php
diff options
context:
space:
mode:
authorjaviexin <javiexin@gmail.com>2017-03-09 16:12:25 +0100
committerGitHub <noreply@github.com>2017-03-09 16:12:25 +0100
commitbd12504f6cf03b36821a5cea2bf77a419496dcdb (patch)
treed30cc3506e1bbdc284dc7cca910c5dac6b927ae0 /phpBB/phpbb/install/helper/navigation/navigation_interface.php
parent96a90d3f81c1fcce3834ee72b7d1b9f76aa9354c (diff)
parent3e9f12d12d7dbdd2cee39425e81b5fdf66fcfbc8 (diff)
downloadforums-bd12504f6cf03b36821a5cea2bf77a419496dcdb.tar
forums-bd12504f6cf03b36821a5cea2bf77a419496dcdb.tar.gz
forums-bd12504f6cf03b36821a5cea2bf77a419496dcdb.tar.bz2
forums-bd12504f6cf03b36821a5cea2bf77a419496dcdb.tar.xz
forums-bd12504f6cf03b36821a5cea2bf77a419496dcdb.zip
Merge branch '3.2.x' into ticket/15068
Diffstat (limited to 'phpBB/phpbb/install/helper/navigation/navigation_interface.php')
-rw-r--r--phpBB/phpbb/install/helper/navigation/navigation_interface.php43
1 files changed, 43 insertions, 0 deletions
diff --git a/phpBB/phpbb/install/helper/navigation/navigation_interface.php b/phpBB/phpbb/install/helper/navigation/navigation_interface.php
new file mode 100644
index 0000000000..eebdbe923f
--- /dev/null
+++ b/phpBB/phpbb/install/helper/navigation/navigation_interface.php
@@ -0,0 +1,43 @@
+<?php
+/**
+ *
+ * This file is part of the phpBB Forum Software package.
+ *
+ * @copyright (c) phpBB Limited <https://www.phpbb.com>
+ * @license GNU General Public License, version 2 (GPL-2.0)
+ *
+ * For full copyright and license information, please see
+ * the docs/CREDITS.txt file.
+ *
+ */
+
+namespace phpbb\install\helper\navigation;
+
+/**
+ * Interface for installer's navigation defining services
+ */
+interface navigation_interface
+{
+ /**
+ * Returns an array with the navigation items
+ *
+ * The returned array should have the following format:
+ * <code>
+ * array(
+ * 'parent_nav_name' => array(
+ * 'nav_name' => array(
+ * 'label' => 'MY_MENU',
+ * 'route' => 'phpbb_route_name',
+ * )
+ * )
+ * )
+ * </code>
+ *
+ * Navigation item setting options:
+ * - label: The language variable name
+ * - route: Name of the route which it is belongs to
+ *
+ * @return array
+ */
+ public function get();
+}