contao-community-alliance/dc-general
Back to top  

Widget Builder build Contao backend widgets.

 Methods

Construct.

__construct(\ContaoCommunityAlliance\DcGeneral\EnvironmentInterface $environment) 

Parameters

$environment

\ContaoCommunityAlliance\DcGeneral\EnvironmentInterface

The environment.

Build a widget for a given property.

buildWidget(\ContaoCommunityAlliance\DcGeneral\DataDefinition\Definition\Properties\PropertyInterface $property, \ContaoCommunityAlliance\DcGeneral\Data\ModelInterface $model) : \Widget
SuppressWarnings (PHPMD.Superglobals)
SuppressWarnings (PHPMD.CamelCaseVariableName)

Parameters

$property

\ContaoCommunityAlliance\DcGeneral\DataDefinition\Definition\Properties\PropertyInterface

The property.

$model

\ContaoCommunityAlliance\DcGeneral\Data\ModelInterface

The current model.

Exceptions

\ContaoCommunityAlliance\DcGeneral\Exception\DcGeneralRuntimeException When not running in TL_MODE BE.

Returns

\Widget

Retrieve the environment.

getEnvironment() : \ContaoCommunityAlliance\DcGeneral\EnvironmentInterface

Returns

\ContaoCommunityAlliance\DcGeneral\EnvironmentInterface

Handle the build widget event.

handleEvent(\ContaoCommunityAlliance\DcGeneral\Contao\View\Contao2BackendView\Event\BuildWidgetEvent $event) : void
Static

Parameters

$event

\ContaoCommunityAlliance\DcGeneral\Contao\View\Contao2BackendView\Event\BuildWidgetEvent

The event.

Get the help wizard.

getHelpWizard(\ContaoCommunityAlliance\DcGeneral\DataDefinition\Definition\Properties\PropertyInterface $propInfo) : string

Parameters

$propInfo

\ContaoCommunityAlliance\DcGeneral\DataDefinition\Definition\Properties\PropertyInterface

The property for which the wizard shall be generated.

Returns

string

Get the list import wizard.

getListWizard() : string

Returns

string

Get special labels.

getOptionsForWidget(\ContaoCommunityAlliance\DcGeneral\DataDefinition\Definition\Properties\PropertyInterface $propInfo, \ContaoCommunityAlliance\DcGeneral\Data\ModelInterface $model) : string

Parameters

$propInfo

\ContaoCommunityAlliance\DcGeneral\DataDefinition\Definition\Properties\PropertyInterface

The property for which the X label shall be generated.

$model

\ContaoCommunityAlliance\DcGeneral\Data\ModelInterface

The model.

Returns

string

Get the table import wizard.

getTableWizard() : string

Returns

string

Try to resolve the class name for the widget.

getWidgetClass(\ContaoCommunityAlliance\DcGeneral\DataDefinition\Definition\Properties\PropertyInterface $property) : string
SuppressWarnings (PHPMD.Superglobals)
SuppressWarnings (PHPMD.CamelCaseVariableName)

Parameters

$property

\ContaoCommunityAlliance\DcGeneral\DataDefinition\Definition\Properties\PropertyInterface

The property to get the widget class name for.

Returns

string

Get special labels.

getXLabel(\ContaoCommunityAlliance\DcGeneral\DataDefinition\Definition\Properties\PropertyInterface $propInfo) : string

Parameters

$propInfo

\ContaoCommunityAlliance\DcGeneral\DataDefinition\Definition\Properties\PropertyInterface

The property for which the X label shall be generated.

Returns

string

 Properties

 

Mapping list of widget types where the DC General has it own widgets.

$widgetMapping : array
 

The environment.

$environment : \ContaoCommunityAlliance\DcGeneral\EnvironmentInterface