TYPO3\CMS\Backend\Template\Components\Buttons\Action\HelpButton Class Reference

Inheritance diagram for TYPO3\CMS\Backend\Template\Components\Buttons\Action\HelpButton:

Public Member Functions
	getModuleName ()
	setModuleName ($moduleName)
	getFieldName ()
	setFieldName ($fieldName)
	getPosition ()
	getGroup ()
	getType ()
	isValid ()
	__toString ()
	render ()

Protected Attributes
	$moduleName
	$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 36 of file HelpButton.php.

Member Function Documentation

__toString()

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 138 of file HelpButton.php.

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

getFieldName()

TYPO3\CMS\Backend\Template\Components\Buttons\Action\HelpButton::getFieldName

(

)

Gets the name of the field.

Returns

string

Definition at line 75 of file HelpButton.php.

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

getGroup()

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 107 of file HelpButton.php.

getModuleName()

TYPO3\CMS\Backend\Template\Components\Buttons\Action\HelpButton::getModuleName

(

)

Gets the name of the module.

Returns

string

Definition at line 53 of file HelpButton.php.

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

getPosition()

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 97 of file HelpButton.php.

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

getType()

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 117 of file HelpButton.php.

isValid()

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 128 of file HelpButton.php.

render()

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 148 of file HelpButton.php.

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

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

setFieldName()

TYPO3\CMS\Backend\Template\Components\Buttons\Action\HelpButton::setFieldName

(

$fieldName

)

Sets the name of the field.

Parameters

string

$fieldName

Returns

HelpButton

Definition at line 86 of file HelpButton.php.

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

setModuleName()

TYPO3\CMS\Backend\Template\Components\Buttons\Action\HelpButton::setModuleName

(

$moduleName

)

Sets the name of the module.

Parameters

string

$moduleName

Returns

HelpButton

Definition at line 64 of file HelpButton.php.

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

Member Data Documentation

$fieldName

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

protected

Definition at line 46 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

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().