Source for file popup.php

Documentation is available at popup.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 modal window button
  14.  *
  15.  * @package     Joomla.Libraries
  16.  * @subpackage  Toolbar
  17.  * @since       3.0
  18.  */
  19. class JToolbarButtonPopup extends JToolbarButton
  20. {
  21.     /**
  22.      * Button type
  23.      *
  24.      * @var    string 
  25.      */
  26.     protected $_name = 'Popup';
  27.  
  28.     /**
  29.      * Fetch the HTML for the button
  30.      *
  31.      * @param   string   $type     Unused string, formerly button type.
  32.      * @param   string   $name     Modal name, used to generate element ID
  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   integer  $top      Top attribute.  [@deprecated  Unused, will be removed in 4.0]
  38.      * @param   integer  $left     Left attribute. [@deprecated  Unused, will be removed in 4.0]
  39.      * @param   string   $onClose  JavaScript for the onClose event.
  40.      * @param   string   $title    The title text
  41.      *
  42.      * @return  string  HTML string for the button
  43.      *
  44.      * @since   3.0
  45.      */
  46.     public function fetchButton($type = 'Modal', $name = '', $text = '', $url = '', $width = 640, $height = 480, $top = 0, $left = 0,
  47.         $onClose = '', $title = '')
  48.     {
  49.         // If no $title is set, use the $text element
  50.         if (strlen($title) == 0)
  51.         {
  52.             $title = $text;
  53.         }
  54.  
  55.         // Store all data to the options array for use with JLayout
  56.         $options = array();
  57.         $options['name'] = trim(JText::_($name), '*?');
  58.         $options['text'] = JText::_($text);
  59.         $options['title'] = JText::_($title);
  60.         $options['class'] = $this->fetchIconClass($name);
  61.         $options['doTask'] = $this->_getCommand($url);
  62.  
  63.         // Instantiate a new JLayoutFile instance and render the layout
  64.         $layout = new JLayoutFile('joomla.toolbar.popup');
  65.  
  66.         $html = array();
  67.         $html[] = $layout->render($options);
  68.  
  69.         // Place modal div and scripts in a new div
  70.         $html[] = '<div class="btn-group" style="width: 0; margin: 0">';
  71.  
  72.         // Build the options array for the modal
  73.         $params = array();
  74.         $params['title']  = $options['title'];
  75.         $params['url']    = $options['doTask'];
  76.         $params['height'] = $height;
  77.         $params['width']  = $width;
  78.         $html[] = JHtml::_('bootstrap.renderModal', 'modal-' . $name, $params);
  79.  
  80.         // If an $onClose event is passed, add it to the modal JS object
  81.         if (strlen($onClose) >= 1)
  82.         {
  83.             $html[] = '<script>'
  84.                 . 'jQuery(\'#modal-' . $name . '\').on(\'hide\', function () {' . $onClose . ';});'
  85.                 . '</script>';
  86.         }
  87.  
  88.         $html[] = '</div>';
  89.  
  90.         return implode("\n", $html);
  91.     }
  92.  
  93.     /**
  94.      * Get the button id
  95.      *
  96.      * @param   string  $type  Button type
  97.      * @param   string  $name  Button name
  98.      *
  99.      * @return  string    Button CSS Id
  100.      *
  101.      * @since   3.0
  102.      */
  103.     public function fetchId($type, $name)
  104.     {
  105.         return $this->_parent->getName() . '-popup-' . $name;
  106.     }
  107.  
  108.     /**
  109.      * Get the JavaScript command for the button
  110.      *
  111.      * @param   string  $url  URL for popup
  112.      *
  113.      * @return  string  JavaScript command string
  114.      *
  115.      * @since   3.0
  116.      */
  117.     private function _getCommand($url)
  118.     {
  119.         if (substr($url, 0, 4) !== 'http')
  120.         {
  121.             $url = JUri::base() . $url;
  122.         }
  123.  
  124.         return $url;
  125.     }
  126. }

Documentation generated on Tue, 19 Nov 2013 15:10:54 +0100 by phpDocumentor 1.4.3