Overview

Namespaces

  • DcGeneral
    • Clipboard
    • Contao
      • Callback
      • Compatibility
      • DataDefinition
        • Definition
      • Dca
        • Builder
          • Legacy
        • Definition
        • Palette
        • Populator
      • Event
      • View
        • Contao2BackendView
          • Event
    • Controller
    • Data
    • DataDefinition
      • Builder
      • Definition
        • Properties
        • View
          • Panel
      • ModelRelationship
      • Palette
        • Builder
          • Event
        • Condition
          • Palette
          • Property
    • EnvironmentPopulator
    • Event
    • Exception
    • Factory
      • Event
    • Panel
    • View
      • Event

Classes

  • DcaReadingDataDefinitionBuilder
  • ExtendedLegacyDcaDataDefinitionBuilder
  • LegacyDcaDataDefinitionBuilder
  • Overview
  • Namespace
  • Class
  • Tree
  • Deprecated
  • Todo

Class ExtendedLegacyDcaDataDefinitionBuilder

Build the container config from legacy DCA syntax.

DcGeneral\DataDefinition\Builder\AbstractEventDrivenDataDefinitionBuilder implements DcGeneral\DataDefinition\Builder\DataDefinitionBuilderInterface
Extended by DcGeneral\Contao\Dca\Builder\Legacy\DcaReadingDataDefinitionBuilder
Extended by DcGeneral\Contao\Dca\Builder\Legacy\ExtendedLegacyDcaDataDefinitionBuilder
Namespace: DcGeneral\Contao\Dca\Builder\Legacy
Located at Contao/Dca/Builder/Legacy/ExtendedLegacyDcaDataDefinitionBuilder.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
# parseBasicDefinition( DcGeneral\DataDefinition\ContainerInterface $container )

Ensure that the basic configuration is set in the definition.

Ensure that the basic configuration is set in the definition.

Parameters

$container
DcGeneral\DataDefinition\ContainerInterface
$container The container where the data shall be stored.
protected
# loadAdditionalDefinitions( DcGeneral\DataDefinition\ContainerInterface $container, DcGeneral\Factory\Event\BuildDataDefinitionEvent $event )

Load all additional definitions, like naming of parent data provider etc.

Load all additional definitions, like naming of parent data provider etc.

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
# parseClassNames( DcGeneral\DataDefinition\ContainerInterface $container )

Parse all class names for view, controller and callback class.

Parse all class names for view, controller and callback class.

Parameters

$container
DcGeneral\DataDefinition\ContainerInterface
$container The container where the data shall be stored.

Throws

DcGeneral\Exception\DcGeneralInvalidArgumentException
When the container is of invalid type.
protected DcGeneral\Contao\Dca\ContaoDataProviderInformation|null
# parseSingleDataProvider( DcGeneral\DataDefinition\ContainerInterface $container, DcGeneral\DataDefinition\Definition\DataProviderDefinitionInterface $providers, array $information )

Parse a single data provider information and prepare the definition object for it.

Parse a single data provider information and prepare the definition object for it.

Parameters

$container
DcGeneral\DataDefinition\ContainerInterface
$container The container where the data shall be stored.
$providers
DcGeneral\DataDefinition\Definition\DataProviderDefinitionInterface
$providers The data provider container.
$information
array
$information The information for the data provider to be parsed.

Returns

DcGeneral\Contao\Dca\ContaoDataProviderInformation|null
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
# parsePalettes( DcGeneral\DataDefinition\ContainerInterface $container )

Parse the palette information.

Parse the palette information.

Parameters

$container
DcGeneral\DataDefinition\ContainerInterface
$container The container where the data shall be stored.
protected
# parseConditions( DcGeneral\DataDefinition\ContainerInterface $container )

Parse the conditions for model relationships from the definition.

Parse the conditions for model relationships from the definition.

This includes root entry filters, parent child relationship.

Parameters

$container
DcGeneral\DataDefinition\ContainerInterface
$container The container where the data shall be stored.

Throws

DcGeneral\Exception\DcGeneralRuntimeException
If any information is missing or invalid.
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.

This method expects to find an instance of Contao2BackendViewDefinitionInterface in the container.

Parameters

$container
DcGeneral\DataDefinition\ContainerInterface
$container The container where the data shall be stored.

Throws

DcGeneral\Exception\DcGeneralInvalidArgumentException
If the stored definition in the container is of invalid type.
protected
# parseListing( DcGeneral\Contao\DataDefinition\Definition\Contao2BackendViewDefinitionInterface $view )

Parse the listing configuration.

Parse the listing configuration.

Parameters

$view
DcGeneral\Contao\DataDefinition\Definition\Contao2BackendViewDefinitionInterface
$view The backend view definition.
protected
# parseListLabel( DcGeneral\DataDefinition\Definition\View\ListingConfigInterface $listing )

Parse the sorting part of listing configuration.

Parse the sorting part of listing configuration.

Parameters

$listing
DcGeneral\DataDefinition\Definition\View\ListingConfigInterface
$listing The listing configuration to be populated.
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
contao-community-alliance/dc-general API documentation generated by ApiGen 2.8.0