Source for file custom.php

Documentation is available at custom.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 custom button
  14.  *
  15.  * @package     Joomla.Libraries
  16.  * @subpackage  Toolbar
  17.  * @since       3.0
  18.  */
  19. class JToolbarButtonCustom extends JToolbarButton
  20. {
  21.     /**
  22.      * Button type
  23.      *
  24.      * @var    string 
  25.      */
  26.     protected $_name = 'Custom';
  27.  
  28.     /**
  29.      * Fetch the HTML for the button
  30.      *
  31.      * @param   string  $type  Button type, unused string.
  32.      * @param   string  $html  HTML strng for the button
  33.      * @param   string  $id    CSS id for the button
  34.      *
  35.      * @return  string   HTML string for the button
  36.      *
  37.      * @since   3.0
  38.      */
  39.     public function fetchButton($type = 'Custom', $html = '', $id = 'custom')
  40.     {
  41.         return $html;
  42.     }
  43.  
  44.     /**
  45.      * Get the button CSS Id
  46.      *
  47.      * @param   string  $type  Not used.
  48.      * @param   string  $html  Not used.
  49.      * @param   string  $id    The id prefix for the button.
  50.      *
  51.      * @return  string  Button CSS Id
  52.      *
  53.      * @since   3.0
  54.      */
  55.     public function fetchId($type = 'Custom', $html = '', $id = 'custom')
  56.     {
  57.         return $this->_parent->getName() . '-' . $id;
  58.     }
  59. }

Documentation generated on Tue, 19 Nov 2013 14:57:41 +0100 by phpDocumentor 1.4.3