Source for file help.php

Documentation is available at help.php

  1. <?php
  2. /**
  3.  * @package     Joomla.Libraries
  4.  * @subpackage  Toolbar
  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. /**
  13.  * Renders a help popup window button
  14.  *
  15.  * @package     Joomla.Libraries
  16.  * @subpackage  Toolbar
  17.  * @since       3.0
  18.  */
  19. class JToolbarButtonHelp extends JToolbarButton
  20. {
  21.     /**
  22.      * @var    string    Button type
  23.      */
  24.     protected $_name = 'Help';
  25.  
  26.     /**
  27.      * Fetches the button HTML code.
  28.      *
  29.      * @param   string   $type       Unused string.
  30.      * @param   string   $ref        The name of the help screen (its key reference).
  31.      * @param   boolean  $com        Use the help file in the component directory.
  32.      * @param   string   $override   Use this URL instead of any other.
  33.      * @param   string   $component  Name of component to get Help (null for current component)
  34.      *
  35.      * @return  string 
  36.      *
  37.      * @since   3.0
  38.      */
  39.     public function fetchButton($type = 'Help', $ref = '', $com = false, $override = null, $component = null)
  40.     {
  41.         // Store all data to the options array for use with JLayout
  42.         $options = array();
  43.         $options['text']   = JText::_('JTOOLBAR_HELP');
  44.         $options['doTask'] = $this->_getCommand($ref, $com, $override, $component);
  45.  
  46.         // Instantiate a new JLayoutFile instance and render the layout
  47.         $layout = new JLayoutFile('joomla.toolbar.help');
  48.  
  49.         return $layout->render($options);
  50.     }
  51.  
  52.     /**
  53.      * Get the button id
  54.      *
  55.      * Redefined from JButton class
  56.      *
  57.      * @return  string    Button CSS Id
  58.      *
  59.      * @since   3.0
  60.      */
  61.     public function fetchId()
  62.     {
  63.         return $this->_parent->getName() . '-help';
  64.     }
  65.  
  66.     /**
  67.      * Get the JavaScript command for the button
  68.      *
  69.      * @param   string   $ref        The name of the help screen (its key reference).
  70.      * @param   boolean  $com        Use the help file in the component directory.
  71.      * @param   string   $override   Use this URL instead of any other.
  72.      * @param   string   $component  Name of component to get Help (null for current component)
  73.      *
  74.      * @return  string   JavaScript command string
  75.      *
  76.      * @since   3.0
  77.      */
  78.     protected function _getCommand($ref, $com, $override, $component)
  79.     {
  80.         JHtml::_('behavior.framework');
  81.  
  82.         // Get Help URL
  83.         $url = JHelp::createURL($ref, $com, $override, $component);
  84.         $url = htmlspecialchars($url, ENT_QUOTES);
  85.         $cmd = "Joomla.popupWindow('$url', '" . JText::_('JHELP', true) . "', 700, 500, 1)";
  86.  
  87.         return $cmd;
  88.     }
  89. }

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