Back to ToolbarHelper class

Method preferences

public static void
preferences
(mixed $component, mixed $height = 550, mixed $width = 875, mixed $alt = 'JTOOLBAR_OPTIONS', mixed $path = '')
Writes a configuration button and invokes a cancel operation (eg a checkin).
Parameters
  • string $component The name of the component, eg, com_content.
  • int $height The height of the popup. [UNUSED]
  • int $width The width of the popup. [UNUSED]
  • string $alt The name of the button.
  • string $path An alternative path for the configuration xml relative to JPATH_SITE.
Returns
  • void
Since
  • 1.5
Class: ToolbarHelper
Project: Joomla

Method preferences - Source code

/**
 * Writes a configuration button and invokes a cancel operation (eg a checkin).
 *
 * @param   string   $component  The name of the component, eg, com_content.
 * @param   integer  $height     The height of the popup. [UNUSED]
 * @param   integer  $width      The width of the popup. [UNUSED]
 * @param   string   $alt        The name of the button.
 * @param   string   $path       An alternative path for the configuration xml relative to JPATH_SITE.
 *
 * @return  void
 *
 * @since   1.5
 */
public static function preferences($component, $height = 550, $width = 875, $alt = 'JTOOLBAR_OPTIONS', $path = '')
{
    $component = urlencode($component);
    $path = urlencode($path);
    $bar = Toolbar::getInstance('toolbar');
    $uri = (string) Uri::getInstance();
    $return = urlencode(base64_encode($uri));
    // Add a button linking to config for component.
    $bar->appendButton('Link', 'options', $alt, 'index.php?option=com_config&view=component&component=' . $component . '&path=' . $path . '&return=' . $return);
}