Class LegacyDcaDataDefinitionBuilder

Build the container config from legacy DCA syntax.

DcGeneral\DataDefinition\Builder\AbstractEventDrivenDataDefinitionBuilder implements DcGeneral\DataDefinition\Builder\DataDefinitionBuilderInterface

DcGeneral\Contao\Dca\Builder\Legacy\DcaReadingDataDefinitionBuilder

DcGeneral\Contao\Dca\Builder\Legacy\LegacyDcaDataDefinitionBuilder

Namespace: DcGeneral\Contao\Dca\Builder\Legacy
Located at Contao/Dca/Builder/Legacy/LegacyDcaDataDefinitionBuilder.php

Methods summary
`public`	# `build( DcGeneral\DataDefinition\ContainerInterface $container, DcGeneral\Factory\Event\BuildDataDefinitionEvent $event )` Build a data definition and store it into the environments container. Build a data definition and store it into the environments container. Parameters `$container` `DcGeneral\DataDefinition\ContainerInterface` $container The data definition container to populate. `$event` `DcGeneral\Factory\Event\BuildDataDefinitionEvent` $event The event that has been triggered.
`protected`	# `loadAdditionalDefinitions( DcGeneral\DataDefinition\ContainerInterface $container, DcGeneral\Factory\Event\BuildDataDefinitionEvent $event )` Load additional definitions, like naming of parent data provider. Load additional definitions, like naming of parent data provider. This method will register an event to the populate environment event in which the parent data provider container will get loaded. Parameters `$container` `DcGeneral\DataDefinition\ContainerInterface` $container The container where the data shall be stored. `$event` `DcGeneral\Factory\Event\BuildDataDefinitionEvent` $event The event being emitted.
`protected`	# `parseCallbacks( DcGeneral\DataDefinition\ContainerInterface $container, Symfony\Component\EventDispatcher\EventDispatcherInterface $dispatcher )` Parse the basic configuration and populate the definition. Parse the basic configuration and populate the definition. Parameters `$container` `DcGeneral\DataDefinition\ContainerInterface` $container The container where the data shall be stored. `$dispatcher` `Symfony\Component\EventDispatcher\EventDispatcherInterface` $dispatcher The event dispatcher in use.
`protected`	# `parseBasicMode( DcGeneral\DataDefinition\Definition\BasicDefinitionInterface $config )` Parse the mode, flat, parented or hierarchical. Parse the mode, flat, parented or hierarchical. Parameters `$config` `DcGeneral\DataDefinition\Definition\BasicDefinitionInterface` $config The basic definition of the data definition.
`protected`	# `parseBasicFlags( DcGeneral\DataDefinition\Definition\BasicDefinitionInterface $config )` Parse the basic flags. Parse the basic flags. Parameters `$config` `DcGeneral\DataDefinition\Definition\BasicDefinitionInterface` $config The basic definition of the data definition.
`protected`	# `parseBasicDefinition( DcGeneral\DataDefinition\ContainerInterface $container )` Parse the basic configuration and populate the definition. Parse the basic configuration and populate the definition. Parameters `$container` `DcGeneral\DataDefinition\ContainerInterface` $container The container where the data shall be stored.
`protected`	# `parseDataProvider( DcGeneral\DataDefinition\ContainerInterface $container )` This method parses all data provider related information from Contao legacy data container arrays. This method parses all data provider related information from Contao legacy data container arrays. Parameters `$container` `DcGeneral\DataDefinition\ContainerInterface` $container The container where the data shall be stored.
`protected`	# `parseRootEntries( DcGeneral\DataDefinition\ContainerInterface $container )` This method parses the root entries definition. This method parses the root entries definition. Parameters `$container` `DcGeneral\DataDefinition\ContainerInterface` $container The container where the data shall be stored.
`protected string`	# `getRootProviderName( DcGeneral\DataDefinition\ContainerInterface $container )` Determine the root provider name from the container. Determine the root provider name from the container. Parameters `$container` `DcGeneral\DataDefinition\ContainerInterface` $container The container from where the name shall be retrieved. Returns `string` Throws `DcGeneral\Exception\DcGeneralRuntimeException` If the root provider can not be determined.
`protected`	# `parseParentChildConditions( DcGeneral\DataDefinition\ContainerInterface $container )` This method parses the parent-child conditions. This method parses the parent-child conditions. Parameters `$container` `DcGeneral\DataDefinition\ContainerInterface` $container The container where the data shall be stored.
`protected`	# `parseBackendView( DcGeneral\DataDefinition\ContainerInterface $container )` Parse and build the backend view definition for the old Contao2 backend view. Parse and build the backend view definition for the old Contao2 backend view. Parameters `$container` `DcGeneral\DataDefinition\ContainerInterface` $container The container where the data shall be stored. Throws `DcGeneral\Exception\DcGeneralInvalidArgumentException` If the stored backend view definition does not implement the correct interface.
`protected`	# `parseListing( DcGeneral\DataDefinition\ContainerInterface $container, DcGeneral\Contao\DataDefinition\Definition\Contao2BackendViewDefinitionInterface $view )` Parse the listing configuration. Parse the listing configuration. Parameters `$container` `DcGeneral\DataDefinition\ContainerInterface` $container The container where the data shall be stored. `$view` `DcGeneral\Contao\DataDefinition\Definition\Contao2BackendViewDefinitionInterface` $view The view information for the backend view.
`protected`	# `parseListSorting( DcGeneral\DataDefinition\Definition\View\ListingConfigInterface $listing, array $listDca )` Parse the sorting part of listing configuration. Parse the sorting part of listing configuration. NOTE: this method currently does NOT support the custom SQL sorting information as supported by DC_Table in Contao. Parameters `$listing` `DcGeneral\DataDefinition\Definition\View\ListingConfigInterface` $listing The listing configuration definition to populate. `$listDca` `array` $listDca The DCA part containing the information to use. Throws `DcGeneral\Exception\DcGeneralRuntimeException` In case unsupported values are encountered.
`protected`	# `parseListLabel( DcGeneral\DataDefinition\ContainerInterface $container, DcGeneral\DataDefinition\Definition\View\ListingConfigInterface $listing, array $listDca )` Parse the sorting part of listing configuration. Parse the sorting part of listing configuration. Parameters `$container` `DcGeneral\DataDefinition\ContainerInterface` $container The container where the data shall be stored. `$listing` `DcGeneral\DataDefinition\Definition\View\ListingConfigInterface` $listing The listing configuration definition to populate. `$listDca` `array` $listDca The DCA part containing the information to use.
`protected`	# `parsePanelFilter( DcGeneral\DataDefinition\Definition\View\PanelRowInterface $row )` Add filter elements to the panel. Add filter elements to the panel. Parameters `$row` `DcGeneral\DataDefinition\Definition\View\PanelRowInterface` $row The row to which the element shall get added to.
`protected`	# `parsePanelSort( DcGeneral\DataDefinition\Definition\View\PanelRowInterface $row )` Add sort element to the panel. Add sort element to the panel. Parameters `$row` `DcGeneral\DataDefinition\Definition\View\PanelRowInterface` $row The row to which the element shall get added to.
`protected`	# `parsePanelSearch( DcGeneral\DataDefinition\Definition\View\PanelRowInterface $row )` Add search element to the panel. Add search element to the panel. Parameters `$row` `DcGeneral\DataDefinition\Definition\View\PanelRowInterface` $row The row to which the element shall get added to.
`protected`	# `parsePanelLimit( DcGeneral\DataDefinition\Definition\View\PanelRowInterface $row )` Add elements to the panel. Add elements to the panel. Parameters `$row` `DcGeneral\DataDefinition\Definition\View\PanelRowInterface` $row The row to which the element shall get added to.
`protected`	# `parsePanelSubmit( DcGeneral\DataDefinition\Definition\View\PanelRowInterface $row )` Add elements to the panel. Add elements to the panel. Parameters `$row` `DcGeneral\DataDefinition\Definition\View\PanelRowInterface` $row The row to which the element shall get added to.
`protected`	# `parsePanelRow( DcGeneral\DataDefinition\Definition\View\PanelRowInterface $row, string $elementList )` Parse a single panel row. Parse a single panel row. Parameters `$row` `DcGeneral\DataDefinition\Definition\View\PanelRowInterface` $row The row to be populated. `$elementList` `string` $elementList A comma separated list of elements to be stored in the row.
`protected`	# `parsePanel( DcGeneral\Contao\DataDefinition\Definition\Contao2BackendViewDefinitionInterface $view )` Parse the defined palettes and populate the definition. Parse the defined palettes and populate the definition. Parameters `$view` `DcGeneral\Contao\DataDefinition\Definition\Contao2BackendViewDefinitionInterface` $view The listing configuration definition to populate.
`protected`	# `parseGlobalOperations( DcGeneral\Contao\DataDefinition\Definition\Contao2BackendViewDefinitionInterface $view )` Parse the defined container scoped operations and populate the definition. Parse the defined container scoped operations and populate the definition. Parameters `$view` `DcGeneral\Contao\DataDefinition\Definition\Contao2BackendViewDefinitionInterface` $view The backend view configuration definition to populate.
`protected`	# `parseModelOperations( DcGeneral\Contao\DataDefinition\Definition\Contao2BackendViewDefinitionInterface $view )` Parse the defined model scoped operations and populate the definition. Parse the defined model scoped operations and populate the definition. Parameters `$view` `DcGeneral\Contao\DataDefinition\Definition\Contao2BackendViewDefinitionInterface` $view The backend view configuration definition to populate.
`protected`	# `parsePalettes( DcGeneral\DataDefinition\ContainerInterface $container )` Parse the defined palettes and populate the definition. Parse the defined palettes and populate the definition. Parameters `$container` `DcGeneral\DataDefinition\ContainerInterface` $container The container where the data shall be stored.
`protected`	# `parseSinglePropertyLabel( DcGeneral\DataDefinition\Definition\Properties\PropertyInterface $property, string\|array $label )` Parse the label of a single property. Parse the label of a single property. Parameters `$property` `DcGeneral\DataDefinition\Definition\Properties\PropertyInterface` $property The property to parse the label for. `$label` `string\|array` $label The label value.
`protected`	# `parseSingleProperty( DcGeneral\DataDefinition\Definition\Properties\PropertyInterface $property, array $propInfo )`
`protected`	# `parseProperties( DcGeneral\DataDefinition\ContainerInterface $container )` Parse the defined properties and populate the definition. Parse the defined properties and populate the definition. Parameters `$container` `DcGeneral\DataDefinition\ContainerInterface` $container The container where the data shall be stored.
`protected DcGeneral\DataDefinition\Definition\View\Command\|DcGeneral\DataDefinition\Definition\View\CutCommand`	# `createCommandInstance( string $commandName, array $commandDca )` Create the correct command instance for the given information. Create the correct command instance for the given information. Parameters `$commandName` `string` $commandName The name of the command to create. `$commandDca` `array` $commandDca The Dca information of the command. Returns `DcGeneral\DataDefinition\Definition\View\Command\|DcGeneral\DataDefinition\Definition\View\CutCommand`
`protected DcGeneral\DataDefinition\Definition\View\CommandInterface`	# `createCommand( string $commandName, array $commandDca )` Create a command from dca. Create a command from dca. Parameters `$commandName` `string` $commandName The name of the command to parse. `$commandDca` `array` $commandDca The chunk from the DCA containing the command specification. Returns `DcGeneral\DataDefinition\Definition\View\CommandInterface`
`protected`	# `evalFlagSorting( DcGeneral\DataDefinition\Definition\View\ListingConfigInterface\|DcGeneral\DataDefinition\Definition\Properties\PropertyInterface $config, integer $flag )` Evaluate the contao 2 sorting flag into sorting mode. Evaluate the contao 2 sorting flag into sorting mode. Parameters `$config` `DcGeneral\DataDefinition\Definition\View\ListingConfigInterface\|DcGeneral\DataDefinition\Definition\Properties\PropertyInterface` $config The property to evaluate the flag for. `$flag` `integer` $flag The flag to be evaluated.
`protected`	# `evalFlagGrouping( DcGeneral\DataDefinition\Definition\View\ListingConfigInterface\|DcGeneral\DataDefinition\Definition\Properties\PropertyInterface $config, integer $flag )` Evaluate the contao 2 sorting flag into grouping mode. Evaluate the contao 2 sorting flag into grouping mode. Parameters `$config` `DcGeneral\DataDefinition\Definition\View\ListingConfigInterface\|DcGeneral\DataDefinition\Definition\Properties\PropertyInterface` $config The property to evaluate the flag for. `$flag` `integer` $flag The flag to be evaluated.
`protected`	# `evalFlagGroupingLength( DcGeneral\DataDefinition\Definition\View\ListingConfigInterface\|DcGeneral\DataDefinition\Definition\Properties\PropertyInterface $config, integer $flag )` Evaluate the contao 2 sorting flag into grouping length. Evaluate the contao 2 sorting flag into grouping length. Parameters `$config` `DcGeneral\DataDefinition\Definition\View\ListingConfigInterface\|DcGeneral\DataDefinition\Definition\Properties\PropertyInterface` $config The property to evaluate the flag for. `$flag` `integer` $flag The flag to be evaluated.
`protected`	# `evalFlag( DcGeneral\DataDefinition\Definition\View\ListingConfigInterface\|DcGeneral\DataDefinition\Definition\Properties\PropertyInterface $config, integer $flag )` Evaluate the contao 2 sorting flag into sorting mode, grouping mode and grouping length. Evaluate the contao 2 sorting flag into sorting mode, grouping mode and grouping length. Parameters `$config` `DcGeneral\DataDefinition\Definition\View\ListingConfigInterface\|DcGeneral\DataDefinition\Definition\Properties\PropertyInterface` $config The property to evaluate the flag for. `$flag` `integer` $flag The flag to be evaluated.

Methods inherited from DcGeneral\Contao\Dca\Builder\Legacy\DcaReadingDataDefinitionBuilder
`getFromDca(), loadDca()`

Methods inherited from DcGeneral\DataDefinition\Builder\AbstractEventDrivenDataDefinitionBuilder
`process()`

Constants inherited from DcGeneral\DataDefinition\Builder\AbstractEventDrivenDataDefinitionBuilder
`PRIORITY`

Properties inherited from DcGeneral\Contao\Dca\Builder\Legacy\DcaReadingDataDefinitionBuilder
`$dca`

Namespaces

Classes

Class LegacyDcaDataDefinitionBuilder

Parameters

Parameters

Parameters

Parameters

Parameters

Parameters

Parameters

Parameters

Parameters

Returns

Throws

Parameters

Parameters

Throws

Parameters

Parameters

Throws

Parameters

Parameters

Parameters

Parameters

Parameters

Parameters

Parameters

Parameters

Parameters

Parameters

Parameters

Parameters

Parameters

Parameters

Returns

Parameters

Returns

Parameters

Parameters

Parameters

Parameters