| <?php
/**
* @package Joomla.Platform
* @subpackage HTML
*
* @copyright Copyright (C) 2005 - 2011 Open Source Matters, Inc. All rights reserved.
* @license GNU General Public License version 2 or later; see LICENSE
*/
defined('JPATH_PLATFORM') or die;
//Register the session storage class with the loader
JLoader::register('JButton', dirname(__FILE__).DS.'toolbar'.DS.'button.php');
/**
* ToolBar handler
*
* @package Joomla.Platform
* @subpackage HTML
* @since 11.1
*/
class JToolBar extends JObject
{
/**
* Toolbar name
*
* @var string
*/
protected $_name = array ();
/**
* Toolbar array
*
* @var array
*/
protected $_bar = array ();
/**
* Loaded buttons
*
* @var array
*/
protected $_buttons = array ();
/**
* Directories, where button types can be stored.
*
* @var array
*/
protected $_buttonPath = array ();
/**
* Constructor
*
* @param string The toolbar name.
*/
public function __construct($name = 'toolbar')
{
$this->_name = $name;
// Set base path to find buttons.
$this->_buttonPath[] = dirname(__FILE__).DS.'toolbar'.DS.'button';
}
/**
* Returns the global JToolBar object, only creating it if it
* doesn't already exist.
*
* @param string $name The name of the toolbar.
*
* @return JToolBar The JToolBar object.
*/
public static function getInstance($name = 'toolbar')
{
static $instances;
if (!isset($instances)) {
$instances = array ();
}
if (empty($instances[$name])) {
$instances[$name] = new JToolBar($name);
}
return $instances[$name];
}
/**
* Set a value
*
* @param string The name of the parameter.
* @param string The value of the parameter.
*
* @return string The set value.
*/
public function appendButton()
{
// Push button onto the end of the toolbar array.
$btn = func_get_args();
array_push($this->_bar, $btn);
return true;
}
/**
* Get the list of toolbar links.
*
* @return array
* @since 11.1
*/
public function getItems()
{
return $this->_bar;
}
/**
* Get the name of the toolbar.
*
* @return string
* @since 11.1
*/
public function getName()
{
return $this->_name;
}
/**
* Get a value.
*
* @param string The name of the parameter.
* @param mixed The default value if not found.
*
* @return string
*/
public function prependButton()
{
// Insert button into the front of the toolbar array.
$btn = func_get_args();
array_unshift($this->_bar, $btn);
return true;
}
/**
* Render.
*
* @param string The name of the control, or the default text area if a setup file is not found.
*
* @return string HTML
*/
public function render()
{
$html = array ();
// Start toolbar div.
$html[] = '<div class="toolbar-list" id="'.$this->_name.'">';
$html[] = '<ul>';
// Render each button in the toolbar.
foreach ($this->_bar as $button) {
$html[] = $this->renderButton($button);
}
// End toolbar div.
$html[] = '</ul>';
$html[] = '<div class="clr"></div>';
$html[] = '</div>';
return implode("\n", $html);
}
/**
* Render a parameter type.
*
* @param object A param tag node.
* @param string The control name.
*
* @return array Any array of the label, the form element and the tooltip.
*/
public function renderButton(&$node)
{
// Get the button type.
$type = $node[0];
$button = $this->loadButtonType($type);
// Check for error.
if ($button === false) {
return JText::sprintf('JLIB_HTML_BUTTON_NOT_DEFINED', $type);
}
return $button->render($node);
}
/**
* Loads a button type.
*
* @param string buttonType
*
* @return object
* @since 11.1
*/
public function loadButtonType($type, $new = false)
{
$signature = md5($type);
if (isset ($this->_buttons[$signature]) && $new === false) {
return $this->_buttons[$signature];
}
if (!class_exists('JButton'))
{
JError::raiseWarning('SOME_ERROR_CODE', JText::_('JLIB_HTML_BUTTON_BASE_CLASS'));
return false;
}
$buttonClass = 'JButton'.$type;
if (!class_exists($buttonClass))
{
if (isset ($this->_buttonPath)) {
$dirs = $this->_buttonPath;
} else {
$dirs = array ();
}
$file = JFilterInput::getInstance()->clean(str_replace('_', DS, strtolower($type)).'.php', 'path');
jimport('joomla.filesystem.path');
if ($buttonFile = JPath::find($dirs, $file)) {
include_once $buttonFile;
} else {
JError::raiseWarning('SOME_ERROR_CODE', JText::sprintf('JLIB_HTML_BUTTON_NO_LOAD', $buttonClass, $buttonFile));
return false;
}
}
if (!class_exists($buttonClass))
{
//return JError::raiseError('SOME_ERROR_CODE', "Module file $buttonFile does not contain class $buttonClass.");
return false;
}
$this->_buttons[$signature] = new $buttonClass($this);
return $this->_buttons[$signature];
}
/**
* Add a directory where JToolBar should search for button types in LIFO order.
*
* You may either pass a string or an array of directories.
*
* {@link JToolbar} will be searching for an element type in the same order you
* added them. If the parameter type cannot be found in the custom folders,
* it will look in libraries/joomla/html/toolbar/button.
*
* @param string|array directory or directories to search.
* @since 11.1
*/
public function addButtonPath($path)
{
// Just force path to array.
settype($path, 'array');
// Loop through the path directories.
foreach ($path as $dir) {
// No surrounding spaces allowed!
$dir = trim($dir);
// Add trailing separators as needed.
if (substr($dir, -1) != DIRECTORY_SEPARATOR) {
// Directory
$dir .= DIRECTORY_SEPARATOR;
}
// Add to the top of the search dirs.
array_unshift($this->_buttonPath, $dir);
}
}
}
|
