Source for file menu.php

Documentation is available at menu.php

  1. <?php
  2. /**
  3.  * @package     Joomla.Libraries
  4.  * @subpackage  Form
  5.  *
  6.  * @copyright   Copyright (C) 2005 - 2013 Open Source Matters, Inc. All rights reserved.
  7.  * @license     GNU General Public License version 2 or later; see LICENSE
  8.  */
  9.  
  10. defined('JPATH_PLATFORM') or die;
  11.  
  12. JFormHelper::loadFieldClass('list');
  13.  
  14. // Import the com_menus helper.
  15. require_once realpath(JPATH_ADMINISTRATOR . '/components/com_menus/helpers/menus.php');
  16.  
  17. /**
  18.  * Supports an HTML select list of menus
  19.  *
  20.  * @package     Joomla.Libraries
  21.  * @subpackage  Form
  22.  * @since       1.6
  23.  */
  24. class JFormFieldMenu extends JFormFieldList
  25. {
  26.     /**
  27.      * The form field type.
  28.      *
  29.      * @var    string 
  30.      * @since  1.6
  31.      */
  32.     public $type = 'Menu';
  33.  
  34.     /**
  35.      * Method to get the list of menus for the field options.
  36.      *
  37.      * @return  array  The field option objects.
  38.      *
  39.      * @since   1.6
  40.      */
  41.     protected function getOptions()
  42.     {
  43.         // Merge any additional options in the XML definition.
  44.         $options = array_merge(parent::getOptions(), JHtml::_('menu.menus'));
  45.  
  46.         return $options;
  47.     }
  48. }

Documentation generated on Tue, 19 Nov 2013 15:07:51 +0100 by phpDocumentor 1.4.3