‪TYPO3CMS  10.4
Public Member Functions | Protected Attributes | List of all members
TYPO3\CMS\Backend\Template\Components\Buttons\Action\HelpButton Class Reference
Inheritance diagram for TYPO3\CMS\Backend\Template\Components\Buttons\Action\HelpButton:
TYPO3\CMS\Backend\Template\Components\Buttons\ButtonInterface TYPO3\CMS\Backend\Template\Components\Buttons\PositionInterface

Public Member Functions

string getModuleName ()
 
HelpButton setModuleName ($moduleName)
 
string getFieldName ()
 
HelpButton setFieldName ($fieldName)
 
string getPosition ()
 
int getGroup ()
 
string getType ()
 
bool isValid ()
 
string __toString ()
 
string render ()
 

Protected Attributes

string $moduleName
 
string $fieldName = ''
 

Detailed Description

HelpButton

Renders a help button in the DocHeader which will be rendered to the right position using button group "99".

EXAMPLE USAGE TO ADD A HELP BUTTON:

$buttonBar = $this->moduleTemplate->getDocHeaderComponent()->getButtonBar(); $myButton = $buttonBar->makeHelpButton() ->setModuleName('xMOD_csh_corebe') ->setFieldName('list_module'); $buttonBar->addButton($myButton);

Definition at line 37 of file HelpButton.php.

Member Function Documentation

◆ __toString()

string TYPO3\CMS\Backend\Template\Components\Buttons\Action\HelpButton::__toString ( )

Renders the button

Returns
‪string

Implements TYPO3\CMS\Backend\Template\Components\Buttons\ButtonInterface.

Definition at line 137 of file HelpButton.php.

References TYPO3\CMS\Backend\Template\Components\Buttons\Action\HelpButton\render().

◆ getFieldName()

string TYPO3\CMS\Backend\Template\Components\Buttons\Action\HelpButton::getFieldName ( )

Gets the name of the field.

Returns
‪string

Definition at line 74 of file HelpButton.php.

References TYPO3\CMS\Backend\Template\Components\Buttons\Action\HelpButton\$fieldName.

◆ getGroup()

int TYPO3\CMS\Backend\Template\Components\Buttons\Action\HelpButton::getGroup ( )

Gets the button group.

Returns
‪int

Implements TYPO3\CMS\Backend\Template\Components\Buttons\PositionInterface.

Definition at line 106 of file HelpButton.php.

◆ getModuleName()

string TYPO3\CMS\Backend\Template\Components\Buttons\Action\HelpButton::getModuleName ( )

Gets the name of the module.

Returns
‪string

Definition at line 52 of file HelpButton.php.

References TYPO3\CMS\Backend\Template\Components\Buttons\Action\HelpButton\$moduleName.

◆ getPosition()

string TYPO3\CMS\Backend\Template\Components\Buttons\Action\HelpButton::getPosition ( )

Gets the button position.

Returns
‪string

Implements TYPO3\CMS\Backend\Template\Components\Buttons\PositionInterface.

Definition at line 96 of file HelpButton.php.

References TYPO3\CMS\Backend\Template\Components\ButtonBar\BUTTON_POSITION_RIGHT.

◆ getType()

string TYPO3\CMS\Backend\Template\Components\Buttons\Action\HelpButton::getType ( )

Gets the type of the button

Returns
‪string

Implements TYPO3\CMS\Backend\Template\Components\Buttons\ButtonInterface.

Definition at line 116 of file HelpButton.php.

◆ isValid()

bool TYPO3\CMS\Backend\Template\Components\Buttons\Action\HelpButton::isValid ( )

Determines whether the button shall be rendered. Depends on the defined module and field name.

Returns
‪bool

Implements TYPO3\CMS\Backend\Template\Components\Buttons\ButtonInterface.

Definition at line 127 of file HelpButton.php.

◆ render()

string TYPO3\CMS\Backend\Template\Components\Buttons\Action\HelpButton::render ( )

Renders the button

Returns
‪string

Implements TYPO3\CMS\Backend\Template\Components\Buttons\ButtonInterface.

Definition at line 147 of file HelpButton.php.

References TYPO3\CMS\Backend\Utility\BackendUtility\cshItem().

Referenced by TYPO3\CMS\Backend\Template\Components\Buttons\Action\HelpButton\__toString().

◆ setFieldName()

HelpButton TYPO3\CMS\Backend\Template\Components\Buttons\Action\HelpButton::setFieldName (   $fieldName)

Sets the name of the field.

Parameters
string$fieldName
Returns
‪HelpButton

Definition at line 85 of file HelpButton.php.

References TYPO3\CMS\Backend\Template\Components\Buttons\Action\HelpButton\$fieldName.

Referenced by TYPO3\CMS\Backend\Controller\EditDocumentController\registerCshButtonToButtonBar().

◆ setModuleName()

HelpButton TYPO3\CMS\Backend\Template\Components\Buttons\Action\HelpButton::setModuleName (   $moduleName)

Sets the name of the module.

Parameters
string$moduleName
Returns
‪HelpButton

Definition at line 63 of file HelpButton.php.

References TYPO3\CMS\Backend\Template\Components\Buttons\Action\HelpButton\$moduleName.

Referenced by TYPO3\CMS\Backend\Controller\EditDocumentController\registerCshButtonToButtonBar().

Member Data Documentation

◆ $fieldName

string TYPO3\CMS\Backend\Template\Components\Buttons\Action\HelpButton::$fieldName = ''
protected

Definition at line 45 of file HelpButton.php.

Referenced by TYPO3\CMS\Backend\Template\Components\Buttons\Action\HelpButton\getFieldName(), and TYPO3\CMS\Backend\Template\Components\Buttons\Action\HelpButton\setFieldName().

◆ $moduleName

string TYPO3\CMS\Backend\Template\Components\Buttons\Action\HelpButton::$moduleName
protected

Definition at line 41 of file HelpButton.php.

Referenced by TYPO3\CMS\Backend\Template\Components\Buttons\Action\HelpButton\getModuleName(), and TYPO3\CMS\Backend\Template\Components\Buttons\Action\HelpButton\setModuleName().