Source for file separator.php

Documentation is available at separator.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 button separator
  14.  *
  15.  * @package     Joomla.Libraries
  16.  * @subpackage  Toolbar
  17.  * @since       3.0
  18.  */
  19. class JToolbarButtonSeparator extends JToolbarButton
  20. {
  21.     /**
  22.      * Button type
  23.      *
  24.      * @var   string 
  25.      */
  26.     protected $_name = 'Separator';
  27.  
  28.     /**
  29.      * Get the HTML for a separator in the toolbar
  30.      *
  31.      * @param   array  &$definition  Class name and custom width
  32.      *
  33.      * @return  string  The HTML for the separator
  34.      *
  35.      * @see     JToolbarButton::render()
  36.      * @since   3.0
  37.      */
  38.     public function render(&$definition)
  39.     {
  40.         // Store all data to the options array for use with JLayout
  41.         $options = array();
  42.  
  43.         // Separator class name
  44.         $options['class'] = (empty($definition[1])) ? '' : $definition[1];
  45.  
  46.         // Custom width
  47.         $options['style'] = (empty($definition[2])) ? '' : ' style="width:' . (int) $definition[2] . 'px;"';
  48.  
  49.         // Instantiate a new JLayoutFile instance and render the layout
  50.         $layout = new JLayoutFile('joomla.toolbar.separator');
  51.  
  52.         return $layout->render($options);
  53.     }
  54.  
  55.     /**
  56.      * Empty implementation (not required for separator)
  57.      *
  58.      * @return  void 
  59.      *
  60.      * @since   3.0
  61.      */
  62.     public function fetchButton()
  63.     {
  64.     }
  65. }

Documentation generated on Tue, 19 Nov 2013 15:12:50 +0100 by phpDocumentor 1.4.3