Support Joomla!

Joomla! 1.5 Documentation

Packages

Package: Joomla-Framework

Developer Network License

The Joomla! Developer Network content is © copyright 2006 by the individual contributors and can be used in accordance with the Creative Commons License, Attribution- NonCommercial- ShareAlike 2.5
Source code for file /joomla/html/toolbar/button/help.php

Documentation is available at help.php

  1. <?php
  2. /**
  3. * @version        $Id: help.php 6637 2007-02-15 20:44:33Z Jinx $
  4. * @package        Joomla.Framework
  5. * @subpackage    HTML
  6. * @copyright    Copyright (C) 2005 - 2007 Open Source Matters. All rights reserved.
  7. * @license        GNU/GPL, see LICENSE.php
  8. *  Joomla! is free software. This version may have been modified pursuant
  9. *  to the GNU General Public License, and as distributed it includes or
  10. *  is derivative of works licensed under the GNU General Public License or
  11. *  other free or open source software licenses.
  12. *  See COPYRIGHT.php for copyright notices and details.
  13. */
  14.  
  15. // Check to ensure this file is within the rest of the framework
  16. defined('JPATH_BASE') or die();
  17.  
  18. /**
  19.  * Renders a help popup window button
  20.  *
  21.  * @author         Louis Landry <[email protected]>
  22.  * @package     Joomla.Framework
  23.  * @subpackage        HTML
  24.  * @since        1.5
  25.  */
  26. class JButtonHelp extends JButton
  27. {
  28.     /**
  29.      * Button type
  30.      *
  31.      * @access    protected
  32.      * @var        string 
  33.      */
  34.     var $_name = 'Help';
  35.  
  36.     function fetchButton( $type='Help', $ref = '', $com = false )
  37.     {
  38.         $text    = JText::_('Help');
  39.         $class    = $this->fetchIconClass('help');
  40.         $doTask    = $this->_getCommand($ref, $com);
  41.  
  42.         $html    = "<a href=\"#\" onclick=\"$doTask\" class=\"toolbar\">\n";
  43.         $html .= "<span class=\"$class\" title=\"$text\">\n";
  44.         $html .= "</span>\n";
  45.          $html    .= "$text\n";
  46.         $html    .= "</a>\n";
  47.  
  48.         return $html;
  49.     }
  50.  
  51.     /**
  52.      * Get the button id
  53.      *
  54.      * Redefined from JButton class
  55.      *
  56.      * @access        public
  57.      * @param        string    $name    Button name
  58.      * @return        string    Button CSS Id
  59.      * @since        1.5
  60.      */
  61.     function fetchId($name)
  62.     {
  63.         return $this->_parent->_name.'-'."help";
  64.     }
  65.  
  66.     /**
  67.      * Get the JavaScript command for the button
  68.      *
  69.      * @access    private
  70.      * @param    object    $definition    Button definition
  71.      * @return    string    JavaScript command string
  72.      * @since    1.5
  73.      */
  74.     function _getCommand($ref, $com)
  75.     {
  76.         global $mainframe;
  77.  
  78.         // Get Help URL
  79.         jimport('joomla.i18n.help');
  80.         $url = JHelp::createURL($ref, $com);
  81.  
  82.         $cmd = "popupWindow('$url', '".JText::_('Help', true)."', 640, 480, 1)";
  83.  
  84.         return $cmd;
  85.     }
  86. }
  87. ?>
Documentation generated on Mon, 05 Mar 2007 21:05:27 +0000 by phpDocumentor 1.3.1