[Summary view] [Print] [Text view]

   1  <?php
   2  /**
   3   *
   4   * This file is part of the phpBB Forum Software package.
   5   *
   6   * @copyright (c) phpBB Limited <https://www.phpbb.com>
   7   * @license GNU General Public License, version 2 (GPL-2.0)
   8   *
   9   * For full copyright and license information, please see
  10   * the docs/CREDITS.txt file.
  11   *
  12   */
  13  
  14  namespace phpbb\install\helper\navigation;
  15  
  16  /**
  17   * Interface for installer's navigation defining services
  18   */
  19  interface navigation_interface
  20  {
  21      /**
  22       * Returns an array with the navigation items
  23       *
  24       * The returned array should have the following format:
  25       * <code>
  26       * array(
  27       *     'parent_nav_name' => array(
  28       *         'nav_name' => array(
  29       *             'label' => 'MY_MENU',
  30       *             'route' => 'phpbb_route_name',
  31       *         )
  32       *     )
  33       * )
  34       * </code>
  35       *
  36       * Navigation item setting options:
  37       *     - label: The language variable name
  38       *     - route: Name of the route which it is belongs to
  39       *
  40       * @return array
  41       */
  42  	public function get();
  43  }