Action¶

This class is the base foundation for a command event.

BaseConfigRegistry¶

Registry for default data provider configurations to only resolve them once.

Clipboard¶

Class Clipboard.

Filter¶

Class Filter.

Item¶

{@inheritdoc}

AbstractCallbackListener¶

Class AbstractCallbackListener.

AbstractReturningCallbackListener¶

Class AbstractReturningCallbackListener.

AbstractReturningPropertyCallbackListener¶

Class AbstractReturningPropertyCallbackListener.

Callbacks¶

Class Callbacks.

ContainerGetBreadcrumbCallbackListener¶

Class ContainerGetBreadcrumbCallbackListener.

ContainerGlobalButtonCallbackListener¶

Class ContainerGlobalButtonCallbackListener.

ContainerHeaderCallbackListener¶

Class ContainerHeaderCallbackListener.

ContainerOnCopyCallbackListener¶

Class ContainerOnCopyCallbackListener.

ContainerOnCutCallbackListener¶

Class ContainerOnCutCallbackListener.

ContainerOnDeleteCallbackListener¶

Class ContainerOnDeleteCallbackListener.

ContainerOnLoadCallbackListener¶

Class ContainerOnLoadCallbackListener.

ContainerOnSubmitCallbackListener¶

Class ContainerOnSubmitCallbackListener.

ContainerPasteButtonCallbackListener¶

Class ContainerPasteButtonCallbackListener.

ContainerPasteRootButtonCallbackListener¶

Class ContainerPasteRootButtonCallbackListener.

ModelChildRecordCallbackListener¶

Class ModelChildRecordCallbackListener.

ModelGroupCallbackListener¶

Class ModelGroupCallbackListener.

ModelLabelCallbackListener¶

Class ModelLabelCallbackListener.

ModelOperationButtonCallbackListener¶

Class ModelOperationButtonCallbackListener.

ModelOptionsCallbackListener¶

Class ModelOptionsCallbackListener.

PropertyInputFieldCallbackListener¶

Class PropertyInputFieldCallbackListener.

PropertyInputFieldGetWizardCallbackListener¶

Class PropertyInputFieldGetWizardCallbackListener.

PropertyInputFieldGetXLabelCallbackListener¶

Class PropertyInputFieldGetXLabelCallbackListener.

PropertyOnLoadCallbackListener¶

Class PropertyOnLoadCallbackListener.

PropertyOnSaveCallbackListener¶

Class PropertyOnSaveCallbackListener.

ActiveRecord¶

Small compatibility layer for the $dc->activeRecord property.

DcCompat¶

Small compatibility layer for callbacks, that expect a "full featured" DC instance.

Contao2BackendViewDefinition¶

Reference implementation for BasicDefinitionInterface.

DcaReadingDataDefinitionBuilder¶

Build the container config from legacy DCA syntax.

ExtendedLegacyDcaDataDefinitionBuilder¶

Build the container config from legacy DCA syntax.

LegacyDcaDataDefinitionBuilder¶

Build the container config from legacy DCA syntax.

ContaoDataProviderInformation¶

Class ContaoDataProviderInformation.

ExtendedDca¶

Class ExtendedDca.

LegacyPalettesParser¶

Class LegacyPalettesParser.

BackendViewPopulator¶

This class is the default fallback populator in the Contao Backend to instantiate a BackendView.

DataProviderPopulator¶

Class DataProviderPopulator.

ExtendedLegacyDcaPopulator¶

Class ExtendedLegacyDcaPopulator.

HardCodedPopulator¶

Class HardCodedPopulator.

PickerCompatPopulator¶

Compatibility class for Contao to have the $GLOBALS['TL_DCA'] populated for pickers as those are hardcoded within the handler files TL_ROOT/contao/*.php.

Subscriber¶

Class Subscriber - gateway to the legacy Contao HOOK style callbacks.

InputProvider¶

Class InputProvider.

SessionStorage¶

{@inheritdoc}

FormatModelLabelSubscriber¶

This class is the base foundation for a command event.

DcGeneralExtension¶

Extension for twig template engine.

AbstractEnvironmentAwareHandler¶

The AbstractEnvironmentAwareHandler is designed for action handlers which can also be used in a non event context.

AbstractHandler¶

Handler class for handling the show events.

CopyHandler¶

Class CopyModelController handles copy action on a model.

DeleteHandler¶

Class DeleteHandler handles the delete action.

SelectHandler¶

Class SelectController.

ShowHandler¶

Handler class for handling the "show" action.

ToggleHandler¶

This class handles toggle commands.

BaseView¶

Class BaseView.

ContaoBackendViewTemplate¶

This class is used for the contao backend view as template.

ContaoWidgetManager¶

Class ContaoWidgetManager.

ClipboardController¶

Class ClipboardController.

EditMask¶

This class manages the displaying of the edit/create mask containing the widgets.

BaseButtonEvent¶

Class BaseButtonEvent.

BaseGetButtonsEvent¶

Class BaseGetButtonsEvent.

BuildWidgetEvent¶

Class BuildWidgetEvent.

DecodePropertyValueForWidgetEvent¶

Class DecodePropertyValueForWidgetEvent.

EncodePropertyValueFromWidgetEvent¶

Class EncodePropertyValueFromWidgetEvent.

GetBreadcrumbEvent¶

Class GetBreadcrumbEvent.

GetEditModeButtonsEvent¶

Class GetEditModeButtonsEvent.

GetGlobalButtonEvent¶

Class GetGlobalButtonEvent.

GetGlobalButtonsEvent¶

Class GetGlobalButtonsEvent.

GetGroupHeaderEvent¶

Class GetGroupHeaderEvent.

GetOperationButtonEvent¶

Class GetOperationButtonEvent.

GetPanelElementTemplateEvent¶

This event is fired when a template instance for a panel element shall be created.

GetParentHeaderEvent¶

Class GetParentHeaderEvent.

GetPasteButtonEvent¶

Class GetPasteButtonEvent.

GetPasteRootButtonEvent¶

Class GetPasteRootButtonEvent.

GetPropertyOptionsEvent¶

Class GetPropertyOptionsEvent.

GetSelectModeButtonsEvent¶

Class GetSelectModeButtonsEvent.

ManipulateWidgetEvent¶

Class ManipulateWidgetEvent.

ModelToLabelEvent¶

Class ModelToLabelEvent.

ParentViewChildRecordEvent¶

Class ParentViewChildRecordEvent.

PrepareMultipleModelsActionEvent¶

Class PrepareMultipleModelsActionEvent.

ResolveWidgetErrorMessageEvent¶

Class ResolveWidgetErrorMessageEvent.

DefinitionException¶

Class DefinitionException.

EditOnlyModeException¶

Exception is thrown if an data definition is in edit only mode.

NotCreatableException¶

Class NotDeletableException.

NotDeletableException¶

Class NotDeletableException.

LanguageFilter¶

Handler class for handling the show events.

IdSerializer¶

The class IdSerializer provides handy methods to serialize and un-serialize model ids including the data provider name into a string.

ListView¶

Class ListView.

PanelRenderer¶

This class renders a backend view panel including all elements.

ParentView¶

Class ParentView.

GetGroupHeaderSubscriber¶

Handles the group header formatting.

WidgetBuilder¶

Widget Builder build Contao backend widgets.

TreePicker¶

Provide methods to handle input field "tableTree".

TreeSelect¶

Class TreeSelect.

TreeView¶

Class TreeView.

ViewHelpers¶

Helper class that provides static methods used in views.

AbstractWidget¶

Abstract widget class as base for dc general backend widgets.

FileTree¶

File tree widget being compatible with the dc general.

FileTreeOrder¶

This widget is a supporting widget to store the file tree orderings.

Ajax¶

Class Ajax - General purpose Ajax handler for "executePostActions" as we can not use the default Contao handling.

Ajax3X¶

Class GeneralAjax - General purpose Ajax handler for "executePostActions" in Contao 3.X as we can not use the default Contao handling.

DefaultController¶

This class serves as main controller class in dc general.

SortingManager¶

Handy helper class to keep manually sorted lists more manageable.

TreeCollector¶

Generic class to retrieve a tree collection for tree views.

TreeNodeStates¶

Wrapper class for tree node states.

DC_General¶

DataDefinitionContainer¶

Default implementation of the data definition container.

AbstractConditionChain¶

An abstract condition chain.

AbstractEventDrivenDataDefinitionBuilder¶

Class AbstractEventDrivenDataDefinitionBuilder.

DataProviderInformation¶

A generic data provider information.

DefaultContainer¶

Default implementation of a data definition container.

DefaultBasicDefinition¶

Default implementation of the basic information about the data definition.

DefaultDataProviderDefinition¶

This is the default implementation of a collection of data provider information.

DefaultModelRelationshipDefinition¶

Default implementation of a model relationship definition.

DefaultPalettesDefinition¶

This is the reference implementation for PalettesDefinitionInterface.

DefaultPropertiesDefinition¶

This is the reference implementation for PropertiesDefinitionInterface.

DefaultProperty¶

Class DefaultProperty.

Command¶

Class Command.

CommandCollection¶

Class CommandCollection.

CopyCommand¶

Copy command - special implementation for coping an entry.

CutCommand¶

Cut command - special implementation for cutting an entry.

DefaultGroupAndSortingDefinition¶

This class defines a collection of grouping and sorting information for the view.

DefaultGroupAndSortingDefinitionCollection¶

This class defines a collection of grouping and sorting information for the view.

DefaultGroupAndSortingInformation¶

This class defines a grouping and sorting information for the view.

DefaultListingConfig¶

Class DefaultListingConfig.

DefaultModelFormatterConfig¶

Format a model and create a listing child record.

DefaultPanelLayout¶

Default implementation of a panel layout definition.

DefaultPanelRow¶

Default implementation of a panel row.

DefaultPanelRowCollection¶

Default implementation for a panel row collection.

DefaultFilterElementInformation¶

Class DefaultFilterElementInformation.

DefaultLimitElementInformation¶

Class DefaultLimitElementInformation.

DefaultSearchElementInformation¶

Class DefaultSearchElementInformation.

DefaultSortElementInformation¶

Class DefaultSortElementInformation.

DefaultSubmitElementInformation¶

Class DefaultSubmitElementInformation.

SelectCommand¶

Select command - special implementation for selecting models for multiple actions.

ToggleCommand¶

Toggle command - special command for toggling a boolean property between '1' and '' (empty string).

TranslatedToggleCommand¶

Translated toggle command - language aware command for toggling a boolean property between '1' and '' (empty string).

AbstractCondition¶

This class is an abstract base for defining model relationship conditions.

FilterBuilder¶

Handy helper class to generate and manipulate filter arrays.

AndFilterBuilder¶

Handy helper class to generate and manipulate AND filter arrays.

BaseComparingFilterBuilder¶

Handy helper class to generate and manipulate AND filter arrays.

BaseFilterBuilder¶

Handy helper class to generate and manipulate filter arrays.

FilterBuilderWithChildren¶

Handy helper class to generate and manipulate filter arrays containing children.

OrFilterBuilder¶

Handy helper class to generate and manipulate OR filter arrays.

PropertyEqualsFilterBuilder¶

Handy helper class to generate and manipulate equality filter arrays.

PropertyGreaterThanFilterBuilder¶

Handy helper class to generate and manipulate greater than filter arrays.

PropertyLessThanFilterBuilder¶

Handy helper class to generate and manipulate less than filter arrays.

PropertyValueInFilterBuilder¶

Handy helper class to generate and manipulate AND filter arrays.

PropertyValueLikeFilterBuilder¶

Handy helper class to generate and manipulate AND filter arrays.

ParentChildCondition¶

Default implementation of a parent child relationship.

RootCondition¶

Default implementation of a root condition.

AddConditionEvent¶

This event is emitted when an condition is added by the palette builder.

BuilderEvent¶

This event is the base class for all palette builder events.

CreateConditionEvent¶

This event gets emitted when a condition is created.

CreateDefaultPaletteConditionEvent¶

This event gets emitted when a condition for the default palette is created.

CreateLegendEvent¶

This event gets emitted when a legend is created.

CreatePaletteCollectionEvent¶

This event gets emitted when a palette collection is being created.

CreatePaletteConditionChainEvent¶

This event gets emitted when a palette condition chain is created.

CreatePaletteEvent¶

This event is emitted when a new palette has been created.

CreatePropertyConditionChainEvent¶

This event gets emitted when a property condition chain is created.

CreatePropertyEvent¶

This event gets emitted when a property gets created.

CreatePropertyValueConditionEvent¶

This event gets emitted when a property value condition gets created.

FinishConditionEvent¶

This event gets emitted when a condition has been finished.

FinishLegendEvent¶

This event gets emitted when a legend is finished.

FinishPaletteCollectionEvent¶

This event gets emitted when a palette collection is finished.

FinishPaletteEvent¶

This event gets emitted when a palette gets finished.

FinishPropertyEvent¶

This event gets emitted when a property is finished.

SetDefaultPaletteConditionClassNameEvent¶

This event gets emitted when the class name of the default palette condition is set.

SetLegendClassNameEvent¶

This event gets emitted when a legend class name is set.

SetPaletteClassNameEvent¶

This event gets emitted when a palette class name is set.

SetPaletteCollectionClassNameEvent¶

This event gets emitted when a palette collection class name is set.

SetPaletteConditionChainClassNameEvent¶

This event gets emitted when a palette condition chain class name is set.

SetPalettePropertyValueConditionClassNameEvent¶

This event gets emitted when a palette property value condition class name is set.

SetPropertyClassNameEvent¶

This event gets emitted when a property class name is set.

SetPropertyConditionChainClassNameEvent¶

This event gets emitted when a property condition chain class name is set.

SetPropertyValueConditionClassNameEvent¶

This event gets emitted when a property value condition class name is set.

UseLegendEvent¶

This event gets emitted when a legend is used.

UsePaletteCollectionEvent¶

This event gets emitted when a palette collection gets used.

UsePaletteEvent¶

This event gets emitted when a palette is used.

UsePropertyEvent¶

This event is emitted when a property is used.

PaletteBuilder¶

The palette builder is used to build palette collections, palettes, legends, properties and conditions.

AbstractWeightAwarePaletteCondition¶

This is the abstract base class for weight aware palette conditions.

DefaultPaletteCondition¶

Condition for the default palette.

PaletteConditionChain¶

A chain of palette conditions.

PropertyFalseCondition¶

Condition checking that the value of a property is false.

PropertyTrueCondition¶

Condition checking that the value of a property is true.

PropertyValueCondition¶

Condition checking that the value of a property is the same as a passed value.

BooleanCondition¶

Condition for specifying an explicit boolean value (Useful for determining if a property shall be editable i.e.).

DumpingPropertyCondition¶

Only for debugging purpose. Call the match() method on the wrapped condition and dump the result with a backtrace.

NotCondition¶

Negate a condition.

PropertyCallbackCondition¶

Condition using a custom callback function for flexible custom conditions.

PropertyConditionChain¶

A chain of property conditions.

PropertyFalseCondition¶

Condition checking that the value of a property is false.

PropertyTrueCondition¶

Condition checking that the value of a property is true.

PropertyValueCondition¶

Condition checking that the value of a property is the same as a passed value.

PropertyVisibleCondition¶

Condition checking that a property is visible.

Legend¶

Default implementation of a legend.

Palette¶

Default implementation of a palette.

PaletteCollection¶

Default implementation of PaletteCollectionInterface.

PaletteFactory¶

The palette factory.

Property¶

A property contained within a palette.

AbstractModel¶

Class AbstractModel.

DCGE¶

This class is a holder for all const vars.

DatabaseUuidIdGenerator¶

Uuid generating by querying it from the Contao database class.

DefaultCollection¶

Class DefaultCollection.

DefaultConfig¶

Class DefaultConfig.

DefaultDataProvider¶

Class DefaultDataProvider.

DefaultFilterOptionCollection¶

This class is the base implementation for LanguageInformationCollectionInterface.

DefaultLanguageInformation¶

This class is the base implementation for LanguageInformationInterface.

DefaultLanguageInformationCollection¶

This class is the base implementation for LanguageInformationCollectionInterface.

DefaultModel¶

Class DefaultModel.

ModelId¶

The class ModelId implements the ModelIdInterface.

MultiLanguageDataProvider¶

Class MultiLanguageDataProvider.

NoOpDataProvider¶

Class NoOpDataProvider.

PropertyValueBag¶

A generic bag containing properties and their values.

TableRowsAsRecordsDataProvider¶

Class TableRowsAsRecordsDataProvider.

DcGeneral¶

This class holds everything together.

DcGeneralEvents¶

This class holds everything together.

DcGeneralViews¶

This class holds all build-in view names.

DefaultEnvironment¶

Default implementation of an environment.

AbstractEventDrivenEnvironmentPopulator¶

Abstract base implementation for an event driven environment populator.

AbstractActionAwareEvent¶

This class is the base foundation for an action event.

AbstractCommandEvent¶

This class is the base foundation for a command event.

AbstractContainerAwareEvent¶

Abstract base class for container aware events.

AbstractEnvironmentAwareEvent¶

Abstract base class for environment aware events.

AbstractModelAwareEvent¶

Abstract base class for an event that need an environment and a model.

AbstractModelCommandEvent¶

Abstract base class for a command event referencing a model.

AbstractViewAwareEvent¶

Abstract event class referencing an environment and a view.

ActionEvent¶

This event occurs when an action should handled.

FormatModelLabelEvent¶

This event is emitted when the model label must be formatted.

PostCreateModelEvent¶

This event is emitted after a model has been created.

PostDeleteModelEvent¶

This event is emitted after a model has been deleted.

PostDuplicateModelEvent¶

This event is emitted after a model has been duplicated.

PostPasteModelEvent¶

This event is emitted after a model has been pasted.

PostPersistModelEvent¶

This event is emitted after a model has been saved to the data provider.

PreCreateModelEvent¶

This event is emitted before a model is created.

PreDeleteModelEvent¶

This event is emitted just before a model is deleted.

PreDuplicateModelEvent¶

This event is emitted just before a model is duplicated.

PreEditModelEvent¶

This event is emitted before the edit view will be generated.

PrePasteModelEvent¶

This event is emitted just before a model is pasted.

PrePersistModelEvent¶

This event is emitted just before a model is saved to the data provider.

ViewEvent¶

This event occurs when a view should rendered.

DcGeneralException¶

General exception originating from the DcGeneral.

DcGeneralInvalidArgumentException¶

This exception is thrown whenever any argument or parameter is invalid.

DcGeneralInvalidPropertyValueException¶

This exception is thrown whenever any property value is invalid.

DcGeneralRuntimeException¶

Exception thrown if an error which can only be found on runtime occurs in DcGeneral.

DcGeneralFactory¶

Factory to create a DcGeneral instance.

BuildDataDefinitionEvent¶

This event is emitted when a data definition is being built.

CreateDcGeneralEvent¶

This event is emitted when a DcGeneral instance has been created.

PopulateEnvironmentEvent¶

This event is emitted when an environment gets populated.

PreCreateDcGeneralEvent¶

This event is emitted when a DcGeneral instance has been created.

AbstractElement¶

Abstract base implementation for panel elements.

DefaultFilterElement¶

Default implementation of a filter panel element.

DefaultLimitElement¶

Default implementation of a limit panel element.

DefaultPanel¶

Default implementation of a panel row.

DefaultPanelContainer¶

Default implementation of a panel container.

DefaultSearchElement¶

Default implementation of a search panel element.

DefaultSortElement¶

Default implementation of a sort element.

DefaultSubmitElement¶

Default implementation of a submit panel element.

RenderReadablePropertyValueEvent¶

This event is emitted when a property value of a model shall be transformed into a readable string representation.

DC_General¶

This is the only entry point for Contao to load the DC class.