WidgetConfigurationInterface

Defines API of configuration for a widget.

This is separated by concrete implementation of a widget (WidgetInterface). The configuration is used to generate UX, and other stuff.

Table of Contents

Methods

getAdditionalCssClasses()  : string
This method returns additional CSS classes which should be added to the rendered widget
getDescription()  : string
Returns the description of a widget, this is used for the widget selector
getGroupNames()  : array<string|int, mixed>
Returns array of group names associated to this widget
getHeight()  : string
Returns the height of a widget (small, medium, large)
getIconIdentifier()  : string
Returns the icon identifier of a widget, this is used for the widget selector
getIdentifier()  : string
Returns the unique identifier of a widget
getServiceName()  : string
Returns the service name providing the widget implementation
getTitle()  : string
Returns the title of a widget, this is used for the widget selector
getWidth()  : string
Returns the width of a widget (small, medium, large)

Methods

getAdditionalCssClasses()

This method returns additional CSS classes which should be added to the rendered widget

public getAdditionalCssClasses() : string
Return values
string

getDescription()

Returns the description of a widget, this is used for the widget selector

public getDescription() : string
Return values
string

getGroupNames()

Returns array of group names associated to this widget

public getGroupNames() : array<string|int, mixed>
Return values
array<string|int, mixed>

getHeight()

Returns the height of a widget (small, medium, large)

public getHeight() : string
Return values
string

getIconIdentifier()

Returns the icon identifier of a widget, this is used for the widget selector

public getIconIdentifier() : string
Return values
string

getIdentifier()

Returns the unique identifier of a widget

public getIdentifier() : string
Return values
string

getServiceName()

Returns the service name providing the widget implementation

public getServiceName() : string
Return values
string

getTitle()

Returns the title of a widget, this is used for the widget selector

public getTitle() : string
Return values
string

getWidth()

Returns the width of a widget (small, medium, large)

public getWidth() : string
Return values
string 

        

        
    




    

    

                            

            

                        
    

        On this page

        
    


            

                    

        

    

        

            
Search results