149 lines
2.9 KiB
PHP
149 lines
2.9 KiB
PHP
|
<?php
|
||
|
|
/**
|
||
|
|
* @package Joomla.Libraries
|
||
|
|
* @subpackage Toolbar
|
||
|
|
*
|
||
|
|
* @copyright Copyright (C) 2005 - 2013 Open Source Matters, Inc. All rights reserved.
|
||
|
|
* @license GNU General Public License version 2 or later; see LICENSE
|
||
|
|
*/
|
||
|
|
|
||
|
|
defined('JPATH_PLATFORM') or die;
|
||
|
|
|
||
|
|
/**
|
||
|
|
* Button base class
|
||
|
|
*
|
||
|
|
* The JButton is the base class for all JButton types
|
||
|
|
*
|
||
|
|
* @package Joomla.Libraries
|
||
|
|
* @subpackage Toolbar
|
||
|
|
* @since 3.0
|
||
|
|
*/
|
||
|
|
abstract class JToolbarButton
|
||
|
|
{
|
||
|
|
/**
|
||
|
|
* element name
|
||
|
|
*
|
||
|
|
* This has to be set in the final renderer classes.
|
||
|
|
*
|
||
|
|
* @var string
|
||
|
|
*/
|
||
|
|
protected $_name = null;
|
||
|
|
|
||
|
|
/**
|
||
|
|
* reference to the object that instantiated the element
|
||
|
|
*
|
||
|
|
* @var JButton
|
||
|
|
*/
|
||
|
|
protected $_parent = null;
|
||
|
|
|
||
|
|
/**
|
||
|
|
* Constructor
|
||
|
|
*
|
||
|
|
* @param object $parent The parent
|
||
|
|
*/
|
||
|
|
public function __construct($parent = null)
|
||
|
|
{
|
||
|
|
$this->_parent = $parent;
|
||
|
|
}
|
||
|
|
|
||
|
|
/**
|
||
|
|
* Get the element name
|
||
|
|
*
|
||
|
|
* @return string type of the parameter
|
||
|
|
*
|
||
|
|
* @since 3.0
|
||
|
|
*/
|
||
|
|
public function getName()
|
||
|
|
{
|
||
|
|
return $this->_name;
|
||
|
|
}
|
||
|
|
|
||
|
|
/**
|
||
|
|
* Get the HTML to render the button
|
||
|
|
*
|
||
|
|
* @param array &$definition Parameters to be passed
|
||
|
|
*
|
||
|
|
* @return string
|
||
|
|
*
|
||
|
|
* @since 3.0
|
||
|
|
*/
|
||
|
|
public function render(&$definition)
|
||
|
|
{
|
||
|
|
/*
|
||
|
|
* Initialise some variables
|
||
|
|
*/
|
||
|
|
$id = call_user_func_array(array(&$this, 'fetchId'), $definition);
|
||
|
|
$action = call_user_func_array(array(&$this, 'fetchButton'), $definition);
|
||
|
|
|
||
|
|
// Build id attribute
|
||
|
|
if ($id)
|
||
|
|
{
|
||
|
|
$id = ' id="' . $id . '"';
|
||
|
|
}
|
||
|
|
|
||
|
|
// Build the HTML Button
|
||
|
|
$options = array();
|
||
|
|
$options['id'] = $id;
|
||
|
|
$options['action'] = $action;
|
||
|
|
|
||
|
|
$layout = new JLayoutFile('joomla.toolbar.base');
|
||
|
|
|
||
|
|
return $layout->render($options);
|
||
|
|
}
|
||
|
|
|
||
|
|
/**
|
||
|
|
* Method to get the CSS class name for an icon identifier
|
||
|
|
*
|
||
|
|
* Can be redefined in the final class
|
||
|
|
*
|
||
|
|
* @param string $identifier Icon identification string
|
||
|
|
*
|
||
|
|
* @return string CSS class name
|
||
|
|
*
|
||
|
|
* @since 3.0
|
||
|
|
*/
|
||
|
|
public function fetchIconClass($identifier)
|
||
|
|
{
|
||
|
|
// It's an ugly hack, but this allows templates to define the icon classes for the toolbar
|
||
|
|
$layout = new JLayoutFile('joomla.toolbar.iconclass');
|
||
|
|
|
||
|
|
return $layout->render(array('icon' => $identifier));
|
||
|
|
}
|
||
|
|
|
||
|
|
/**
|
||
|
|
* Get the button
|
||
|
|
*
|
||
|
|
* Defined in the final button class
|
||
|
|
*
|
||
|
|
* @return string
|
||
|
|
*
|
||
|
|
* @since 3.0
|
||
|
|
*/
|
||
|
|
abstract public function fetchButton();
|
||
|
|
}
|
||
|
|
|
||
|
|
/**
|
||
|
|
* Deprecated class placeholder. You should use JToolbarButton instead.
|
||
|
|
*
|
||
|
|
* @package Joomla.Legacy
|
||
|
|
* @subpackage Toolbar
|
||
|
|
* @since 1.5
|
||
|
|
* @deprecated 4.0 Use JToolbarButton instead.
|
||
|
|
* @codeCoverageIgnore
|
||
|
|
*/
|
||
|
|
abstract class JButton extends JToolbarButton
|
||
|
|
{
|
||
|
|
/**
|
||
|
|
* Constructor
|
||
|
|
*
|
||
|
|
* @param object $parent The parent
|
||
|
|
*
|
||
|
|
* @deprecated 4.0 Use JToolbarButton instead.
|
||
|
|
*/
|
||
|
|
public function __construct($parent = null)
|
||
|
|
{
|
||
|
|
JLog::add('JButton is deprecated. Use JToolbarButton instead.', JLog::WARNING, 'deprecated');
|
||
|
|
parent::__construct($parent);
|
||
|
|
}
|
||
|
|
}
|