Source for file helpsite.php

Documentation is available at helpsite.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. /**
  15.  * Form Field class for the Joomla Platform.
  16.  * Provides a select list of help sites.
  17.  *
  18.  * @package     Joomla.Libraries
  19.  * @subpackage  Form
  20.  * @since       1.6
  21.  */
  22. class JFormFieldHelpsite extends JFormFieldList
  23. {
  24.     /**
  25.      * The form field type.
  26.      *
  27.      * @var    string 
  28.      * @since  1.6
  29.      */
  30.     public $type = 'Helpsite';
  31.  
  32.     /**
  33.      * Method to get the help site field options.
  34.      *
  35.      * @return  array  The field option objects.
  36.      *
  37.      * @since   1.6
  38.      */
  39.     protected function getOptions()
  40.     {
  41.         // Merge any additional options in the XML definition.
  42.         $options = array_merge(parent::getOptions(), JHelp::createSiteList(JPATH_ADMINISTRATOR . '/help/helpsites.xml', $this->value));
  43.  
  44.         return $options;
  45.     }
  46.  
  47.     /**
  48.      * Override to add refresh button
  49.      *
  50.      * @return  string  The field input markup.
  51.      *
  52.      * @since   3.2
  53.      */
  54.     protected function getInput()
  55.     {
  56.         JHtml::script('system/helpsite.js', false, true);
  57.         JFactory::getDocument()->addScriptDeclaration(
  58.             'var helpsite_base = "' . addslashes(JUri::root()) . '";'
  59.         );
  60.  
  61.         $html = parent::getInput();
  62.         $button = '<button type="button" class="btn btn-small" id="helpsite-refresh" rel="' . $this->id . '"><span>' . JText::_('JGLOBAL_HELPREFRESH_BUTTON') . '</span></button>';
  63.  
  64.         return $html . $button;
  65.     }
  66. }

Documentation generated on Tue, 19 Nov 2013 15:04:41 +0100 by phpDocumentor 1.4.3