HelpButton.php

Go to the documentation of this file.

<?php
namespace ‪TYPO3\CMS\Backend\Template\Components\Buttons\Action;
 
/*
 * This file is part of the TYPO3 CMS project.
 *
 * It is free software; you can redistribute it and/or modify it under
 * the terms of the GNU General Public License, either version 2
 * of the License, or any later version.
 *
 * For the full copyright and license information, please read the
 * LICENSE.txt file that was distributed with this source code.
 *
 * The TYPO3 project - inspiring people to share!
 */
 
use ‪TYPO3\CMS\Backend\Template\Components\ButtonBar;
use ‪TYPO3\CMS\Backend\Template\Components\Buttons\ButtonInterface;
use ‪TYPO3\CMS\Backend\Template\Components\Buttons\PositionInterface;
use ‪TYPO3\CMS\Backend\Utility\BackendUtility;
 
class ‪HelpButton implements ‪ButtonInterface, ‪PositionInterface
{
    protected ‪$moduleName;
 
    protected ‪$fieldName = '';
 
    public function ‪getModuleName()
    {
        return ‪$this->moduleName;
    }
 
    public function ‪setModuleName(‪$moduleName)
    {
        $this->moduleName = ‪$moduleName;
        return $this;
    }
 
    public function ‪getFieldName()
    {
        return ‪$this->fieldName;
    }
 
    public function ‪setFieldName(‪$fieldName)
    {
        $this->fieldName = ‪$fieldName;
        return $this;
    }
 
    public function ‪getPosition()
    {
        return ‪ButtonBar::BUTTON_POSITION_RIGHT;
    }
 
    public function ‪getGroup()
    {
        return 99;
    }
 
    public function ‪getType()
    {
        return static::class;
    }
 
    public function ‪isValid()
    {
        return !empty($this->moduleName);
    }
 
    public function ‪__toString()
    {
        return $this->‪render();
    }
 
    public function ‪render()
    {
        $helpMarkup = ‪BackendUtility::cshItem($this->moduleName, $this->fieldName);
        if ($helpMarkup === '') {
            return '';
        }
        return '<span class="btn btn-sm btn-default">' . $helpMarkup . '</span>';
    }
}