Source for file standard.php

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

Documentation generated on Tue, 19 Nov 2013 15:14:18 +0100 by phpDocumentor 1.4.3