Back to ToolbarHelper class

Method help

public static void
help
(mixed $ref, mixed $com = false, mixed $override = null, mixed $component = null)
Writes a help button for a given option (opens a popup window).
Parameters
  • string $ref The name of the popup file (excluding the file extension for an xml file).
  • bool $com Use the help file in the component directory.
  • string $override Use this URL instead of any other
  • string $component Name of component to get Help (null for current component)
Returns
  • void
Since
  • 1.5
Class: ToolbarHelper
Project: Joomla

Method help - Source code

/**
 * Writes a help button for a given option (opens a popup window).
 *
 * @param   string  $ref        The name of the popup file (excluding the file extension for an xml file).
 * @param   bool    $com        Use the help file in the component directory.
 * @param   string  $override   Use this URL instead of any other
 * @param   string  $component  Name of component to get Help (null for current component)
 *
 * @return  void
 *
 * @since   1.5
 */
public static function help($ref, $com = false, $override = null, $component = null)
{
    // Don't show a help button if neither $ref nor $override is given
    if (!$ref && !$override) {
        return;
    }
    $bar = Toolbar::getInstance('toolbar');
    // Add a help button.
    $bar->appendButton('Help', $ref, $com, $override, $component);
}