Class ContaoWidgetManager

Class ContaoWidgetManager.

This class is responsible for creating widgets and processing data through them.

Namespace: DcGeneral\Contao\View\Contao2BackendView
Package: DcGeneral\Contao\View\Contao2BackendView
Located at Contao/View/Contao2BackendView/ContaoWidgetManager.php

Methods summary
`public`	# `__construct( DcGeneral\EnvironmentInterface $environment, DcGeneral\Data\ModelInterface $model )` Create a new instance. Create a new instance. Parameters `$environment` `DcGeneral\EnvironmentInterface` $environment The environment in use. `$model` `DcGeneral\Data\ModelInterface` $model The model for which widgets shall be generated.
`public mixed`	# `encodeValue( string $property, mixed $value )` Encode a value from the widget to native data of the data provider via event. Encode a value from the widget to native data of the data provider via event. Parameters `$property` `string` $property The property. `$value` `mixed` $value The value of the property. Returns `mixed`
`public mixed`	# `decodeValue( string $property, mixed $value )` Decode a value from native data of the data provider to the widget via event. Decode a value from native data of the data provider to the widget via event. Parameters `$property` `string` $property The property. `$value` `mixed` $value The value of the property. Returns `mixed`
`public`	# `getEnvironment( )`
`public`	# `hasWidget( mixed $property )`
`protected string`	# `getXLabel( DcGeneral\DataDefinition\Definition\Properties\PropertyInterface $propInfo )` Get special labels. Get special labels. Parameters `$propInfo` `DcGeneral\DataDefinition\Definition\Properties\PropertyInterface` $propInfo The property for which the X label shall be generated. Returns `string`
`public`	# `preLoadRichTextEditor( )` Function for pre-loading the tiny mce. Function for pre-loading the tiny mce.
`public Contao\Widget`	# `getWidget( string $property )` Retrieve the instance of a widget for the given property. Retrieve the instance of a widget for the given property. Parameters `$property` `string` $property Name of the property for which the widget shall be retrieved. Returns `Contao\Widget` Throws `DcGeneral\Exception\DcGeneralInvalidArgumentException` If an undefined property name has been passed.
`protected string`	# `buildDatePicker( Contao\Widget $objWidget )` Build the date picker string. Build the date picker string. Parameters `$objWidget` `Contao\Widget` $objWidget The widget instance to generate the date picker string for. Returns `string`
`protected string`	# `generateHelpText( string $property )` Generate the help msg for a property. Generate the help msg for a property. Parameters `$property` `string` $property The name of the property. Returns `string`
`public string`	# `renderWidget( string $property, boolean $ignoreErrors = false )` Render the widget for the named property. Render the widget for the named property. Parameters `$property` `string` $property The name of the property for which the widget shall be rendered. `$ignoreErrors` `boolean` $ignoreErrors Flag if the error property of the widget shall get cleared prior rendering. Returns `string` Throws `DcGeneral\Exception\DcGeneralRuntimeException` For unknown properties.
`public`	# `processInput( DcGeneral\Data\PropertyValueBag $propertyValues )`
`public`	# `processErrors( DcGeneral\Data\PropertyValueBag $propertyValues )`

Properties summary
`protected DcGeneral\EnvironmentInterface`	`$environment`		# The environment in use. The environment in use.
`protected DcGeneral\Data\ModelInterface`	`$model`		# The model for which widgets shall be generated. The model for which widgets shall be generated.

Namespaces

Classes

Interfaces

Class ContaoWidgetManager

Parameters

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Throws

Parameters

Returns

Parameters

Returns

Parameters

Returns

Throws