- md5
- 06b23acbadc799f6023cdad46ee8ca06
- sha1
- 8b709515e106f885b4a25f8d978277db007502d9
- sha256
- f2d4934994ab876ce4fbbad469324381184b4c45e2850d0b81e6c602048c2585
123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113
<?php
/**
* Joomla! Content Management System
*
* @copyright (C) 2006 Open Source Matters, Inc. <https://www.joomla.org>
* @license GNU General Public License version 2 or later; see LICENSE.txt
*/
namespace Joomla\CMS\Toolbar\Button;
use Joomla\CMS\Help\Help;
use Joomla\CMS\Language\Text;
/**
* Renders a help popup window button
*
* @method self ref(string $value)
* @method self component(string $value)
* @method self useComponent(bool $value)
* @method self url(string $value)
* @method string getRef()
* @method string getComponent()
* @method bool getUseComponent()
* @method string getUrl()
*
* @since 3.0
*/
class HelpButton extends BasicButton
{
/**
* Prepare options for this button.
*
* @param array $options The options about this button.
*
* @return void
*
* @since 4.0.0
*/
protected function prepareOptions(array &$options)
{
$options['text'] = $options['text'] ?: 'JTOOLBAR_HELP';
$options['icon'] = $options['icon'] ?? 'icon-question';
$options['button_class'] = $options['button_class'] ?? 'btn btn-info';
$options['onclick'] = $options['onclick'] ?? $this->_getCommand();
parent::prepareOptions($options);
}
/**
* 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);
}
/**
* Get the JavaScript command for the button
*
* @return string JavaScript command string
*
* @since 3.0
*/
protected function _getCommand()
{
// Get Help URL
$url = Help::createUrl($this->getRef(), $this->getUseComponent(), $this->getUrl(), $this->getComponent());
$url = json_encode(htmlspecialchars($url, ENT_QUOTES), JSON_HEX_APOS);
$url = substr($url, 1, -1);
$cmd = "Joomla.popupWindow('$url', '" . Text::_('JHELP', true) . "', 700, 500, 1)";
return $cmd;
}
/**
* Method to configure available option accessors.
*
* @return array
*
* @since 4.0.0
*/
protected static function getAccessors(): array
{
return array_merge(
parent::getAccessors(),
[
'ref',
'useComponent',
'component',
'url'
]
);
}
}
The same content is in 5 releases, Joomla 4.2.0-beta3 to 4.2.1-rc2. See them all, or every version of this file.