Source for file link.php

Documentation is available at link.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 link button
  14.  *
  15.  * @package     Joomla.Libraries
  16.  * @subpackage  Toolbar
  17.  * @since       3.0
  18.  */
  19. class JToolbarButtonLink extends JToolbarButton
  20. {
  21.     /**
  22.      * Button type
  23.      * @var    string 
  24.      */
  25.     protected $_name = 'Link';
  26.  
  27.     /**
  28.      * Fetch the HTML for the button
  29.      *
  30.      * @param   string  $type  Unused string.
  31.      * @param   string  $name  Name to be used as apart of the id
  32.      * @param   string  $text  Button text
  33.      * @param   string  $url   The link url
  34.      *
  35.      * @return  string  HTML string for the button
  36.      *
  37.      * @since   3.0
  38.      */
  39.     public function fetchButton($type = 'Link', $name = 'back', $text = '', $url = null)
  40.     {
  41.         // Store all data to the options array for use with JLayout
  42.         $options = array();
  43.         $options['text'] = JText::_($text);
  44.         $options['class'] = $this->fetchIconClass($name);
  45.         $options['doTask'] = $this->_getCommand($url);
  46.  
  47.         // Instantiate a new JLayoutFile instance and render the layout
  48.         $layout = new JLayoutFile('joomla.toolbar.link');
  49.  
  50.         return $layout->render($options);
  51.     }
  52.  
  53.     /**
  54.      * Get the button CSS Id
  55.      *
  56.      * @param   string  $type  The button type.
  57.      * @param   string  $name  The name of the button.
  58.      *
  59.      * @return  string  Button CSS Id
  60.      *
  61.      * @since   3.0
  62.      */
  63.     public function fetchId($type = 'Link', $name = '')
  64.     {
  65.         return $this->_parent->getName() . '-' . $name;
  66.     }
  67.  
  68.     /**
  69.      * Get the JavaScript command for the button
  70.      *
  71.      * @param   object  $url  Button definition
  72.      *
  73.      * @return  string  JavaScript command string
  74.      *
  75.      * @since   3.0
  76.      */
  77.     protected function _getCommand($url)
  78.     {
  79.         return $url;
  80.     }
  81. }

Documentation generated on Tue, 19 Nov 2013 15:07:06 +0100 by phpDocumentor 1.4.3