HelpButton implements ButtonInterface, PositionInterface

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);

Table of Contents

Interfaces

ButtonInterface
Interface for buttons
PositionInterface
Interface for buttons

Properties

$fieldName  : string
$moduleName  : string

Methods

__toString()  : string
Renders the button
getFieldName()  : string
Gets the name of the field.
getGroup()  : int
Gets the button group.
getModuleName()  : string
Gets the name of the module.
getPosition()  : string
Gets the button position.
getType()  : string
Gets the type of the button
isValid()  : bool
Determines whether the button shall be rendered.
render()  : string
Renders the button
setFieldName()  : HelpButton
Sets the name of the field.
setModuleName()  : HelpButton
Sets the name of the module.

Properties

$fieldName

protected string $fieldName = ''

Methods

__toString()

Renders the button

public __toString() : string
Return values
string

getFieldName()

Gets the name of the field.

public getFieldName() : string
Return values
string

getGroup()

Gets the button group.

public getGroup() : int
Return values
int

getModuleName()

Gets the name of the module.

public getModuleName() : string
Return values
string

getPosition()

Gets the button position.

public getPosition() : string
Return values
string

getType()

Gets the type of the button

public getType() : string
Return values
string

isValid()

Determines whether the button shall be rendered.

public isValid() : bool

Depends on the defined module and field name.

Return values
bool

render()

Renders the button

public render() : string
Return values
string

setFieldName()

Sets the name of the field.

public setFieldName(string $fieldName) : HelpButton
Parameters
$fieldName : string
Return values
HelpButton

setModuleName()

Sets the name of the module.

public setModuleName(string $moduleName) : HelpButton
Parameters
$moduleName : string
Return values
HelpButton 

        

        
    




    

    

                            

            

                            
    

        On this page

        
    


            

                    

        

    

        

            
Search results