Source for file slider.php

Documentation is available at slider.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 to render an HTML element in a slider container
  14.  *
  15.  * @package     Joomla.Libraries
  16.  * @subpackage  Toolbar
  17.  * @since       3.0
  18.  */
  19. class JToolbarButtonSlider extends JToolbarButton
  20. {
  21.     /**
  22.      * Button type
  23.      *
  24.      * @var    string 
  25.      */
  26.     protected $_name = 'Slider';
  27.  
  28.     /**
  29.      * Fetch the HTML for the button
  30.      *
  31.      * @param   string   $type     Unused string, formerly button type.
  32.      * @param   string   $name     Button name
  33.      * @param   string   $text     The link text
  34.      * @param   string   $url      URL for popup
  35.      * @param   integer  $width    Width of popup
  36.      * @param   integer  $height   Height of popup
  37.      * @param   string   $onClose  JavaScript for the onClose event.
  38.      *
  39.      * @return  string  HTML string for the button
  40.      *
  41.      * @since   3.0
  42.      */
  43.     public function fetchButton($type = 'Slider', $name = '', $text = '', $url = '', $width = 640, $height = 480, $onClose = '')
  44.     {
  45.         JHtml::_('script', 'jui/cms.js', false, true);
  46.  
  47.         // Store all data to the options array for use with JLayout
  48.         $options = array();
  49.         $options['text'] = JText::_($text);
  50.         $options['name'] = $name;
  51.         $options['class'] = $this->fetchIconClass($name);
  52.         $options['onClose'] = '';
  53.  
  54.         $doTask = $this->_getCommand($url);
  55.         $options['doTask'] = 'Joomla.setcollapse(\'' . $doTask . '\', \'' . $name . '\', \'' . $height . '\');';
  56.  
  57.         if ($onClose)
  58.         {
  59.             $options['onClose'] = ' rel="{onClose: function() {' . $onClose . '}}"';
  60.         }
  61.  
  62.         // Instantiate a new JLayoutFile instance and render the layout
  63.         $layout = new JLayoutFile('joomla.toolbar.slider');
  64.  
  65.         return $layout->render($options);
  66.     }
  67.  
  68.     /**
  69.      * Get the button id
  70.      *
  71.      * @param   string  $type  Button type
  72.      * @param   string  $name  Button name
  73.      *
  74.      * @return  string    Button CSS Id
  75.      *
  76.      * @since   3.0
  77.      */
  78.     public function fetchId($type, $name)
  79.     {
  80.         return $this->_parent->getName() . '-slider-' . $name;
  81.     }
  82.  
  83.     /**
  84.      * Get the JavaScript command for the button
  85.      *
  86.      * @param   string  $url  URL for popup
  87.      *
  88.      * @return  string  JavaScript command string
  89.      *
  90.      * @since   3.0
  91.      */
  92.     private function _getCommand($url)
  93.     {
  94.         if (substr($url, 0, 4) !== 'http')
  95.         {
  96.             $url = JUri::base() . $url;
  97.         }
  98.  
  99.         return $url;
  100.     }
  101. }

Documentation generated on Tue, 19 Nov 2013 15:13:57 +0100 by phpDocumentor 1.4.3