Back to HelpButton class

Method fetchButton

public string
fetchButton
(mixed $type = 'Help', mixed $ref = '', mixed $com = false, mixed $override = null, mixed $component = null)
Fetches the button HTML code.
Parameters
  • string $type Unused string.
  • string $ref The name of the help screen (its key reference).
  • 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
  • string
Since
  • 3.0
Deprecated
  • 5.0
Class: HelpButton
Project: Joomla

Method fetchButton - Source code

/**
 * Fetches the button HTML code.
 *
 * @param   string   $type       Unused string.
 * @param   string   $ref        The name of the help screen (its key reference).
 * @param   boolean  $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  string
 *
 * @since   3.0
 *
 * @deprecated  5.0 Use render() instead.
 */
public function fetchButton($type = 'Help', $ref = '', $com = false, $override = null, $component = null)
{
    $this->name('help')->ref($ref)->useComponent($com)->component($component)->url($override);
    return $this->renderButton($this->options);
}