Source for file confirm.php

Documentation is available at confirm.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 standard button with a confirm dialog
  14.  *
  15.  * @package     Joomla.Libraries
  16.  * @subpackage  Toolbar
  17.  * @since       3.0
  18.  */
  19. class JToolbarButtonConfirm extends JToolbarButton
  20. {
  21.     /**
  22.      * Button type
  23.      *
  24.      * @var    string 
  25.      */
  26.     protected $_name = 'Confirm';
  27.  
  28.     /**
  29.      * Fetch the HTML for the button
  30.      *
  31.      * @param   string   $type      Unused string.
  32.      * @param   string   $msg       Message to render
  33.      * @param   string   $name      Name to be used as apart of the id
  34.      * @param   string   $text      Button text
  35.      * @param   string   $task      The task associated with the button
  36.      * @param   boolean  $list      True to allow use of lists
  37.      * @param   boolean  $hideMenu  True to hide the menu on click
  38.      *
  39.      * @return  string   HTML string for the button
  40.      *
  41.      * @since   3.0
  42.      */
  43.     public function fetchButton($type = 'Confirm', $msg = '', $name = '', $text = '', $task = '', $list = true, $hideMenu = false)
  44.     {
  45.         // Store all data to the options array for use with JLayout
  46.         $options = array();
  47.         $options['text'] = JText::_($text);
  48.         $options['msg'] = JText::_($msg, true);
  49.         $options['class'] = $this->fetchIconClass($name);
  50.         $options['doTask'] = $this->_getCommand($options['msg'], $name, $task, $list);
  51.  
  52.         // Instantiate a new JLayoutFile instance and render the layout
  53.         $layout = new JLayoutFile('joomla.toolbar.confirm');
  54.  
  55.         return $layout->render($options);
  56.     }
  57.  
  58.     /**
  59.      * Get the button CSS Id
  60.      *
  61.      * @param   string   $type      Button type
  62.      * @param   string   $name      Name to be used as apart of the id
  63.      * @param   string   $text      Button text
  64.      * @param   string   $task      The task associated with the button
  65.      * @param   boolean  $list      True to allow use of lists
  66.      * @param   boolean  $hideMenu  True to hide the menu on click
  67.      *
  68.      * @return  string  Button CSS Id
  69.      *
  70.      * @since   3.0
  71.      */
  72.     public function fetchId($type = 'Confirm', $name = '', $text = '', $task = '', $list = true, $hideMenu = false)
  73.     {
  74.         return $this->_parent->getName() . '-' . $name;
  75.     }
  76.  
  77.     /**
  78.      * Get the JavaScript command for the button
  79.      *
  80.      * @param   object   $msg   The message to display.
  81.      * @param   string   $name  Not used.
  82.      * @param   string   $task  The task used by the application
  83.      * @param   boolean  $list  True is requires a list confirmation.
  84.      *
  85.      * @return  string  JavaScript command string
  86.      *
  87.      * @since   3.0
  88.      */
  89.     protected function _getCommand($msg, $name, $task, $list)
  90.     {
  91.         JHtml::_('behavior.framework');
  92.         $message = JText::_('JLIB_HTML_PLEASE_MAKE_A_SELECTION_FROM_THE_LIST');
  93.         $message = addslashes($message);
  94.  
  95.         if ($list)
  96.         {
  97.             $cmd = "if (document.adminForm.boxchecked.value==0){alert('$message');}else{if (confirm('$msg')){Joomla.submitbutton('$task');}}";
  98.         }
  99.         else
  100.         {
  101.             $cmd = "if (confirm('$msg')){Joomla.submitbutton('$task');}";
  102.         }
  103.  
  104.         return $cmd;
  105.     }
  106. }

Documentation generated on Tue, 19 Nov 2013 14:56:31 +0100 by phpDocumentor 1.4.3