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

  • AddConditionEvent
  • BuilderEvent
  • CreateConditionEvent
  • CreateDefaultPaletteConditionEvent
  • CreateLegendEvent
  • CreatePaletteCollectionEvent
  • CreatePaletteConditionChainEvent
  • CreatePaletteEvent
  • CreatePropertyConditionChainEvent
  • CreatePropertyEvent
  • CreatePropertyValueConditionEvent
  • FinishConditionEvent
  • FinishLegendEvent
  • FinishPaletteCollectionEvent
  • FinishPaletteEvent
  • FinishPropertyEvent
  • SetDefaultPaletteConditionClassNameEvent
  • SetLegendClassNameEvent
  • SetPaletteClassNameEvent
  • SetPaletteCollectionClassNameEvent
  • SetPaletteConditionChainClassNameEvent
  • SetPalettePropertyValueConditionClassNameEvent
  • SetPropertyClassNameEvent
  • SetPropertyConditionChainClassNameEvent
  • SetPropertyValueConditionClassNameEvent
  • UseLegendEvent
  • UsePaletteCollectionEvent
  • UsePaletteEvent
  • UsePropertyEvent
  • Overview
  • Namespace
  • Class
  • Tree
  • Deprecated
  • Todo

Class AddConditionEvent

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

Symfony\Component\EventDispatcher\Event
Extended by DcGeneral\Event\AbstractContainerAwareEvent implements DcGeneral\ContainerAwareInterface
Extended by DcGeneral\DataDefinition\Palette\Builder\Event\BuilderEvent
Extended by DcGeneral\DataDefinition\Palette\Builder\Event\AddConditionEvent
Namespace: DcGeneral\DataDefinition\Palette\Builder\Event
Package: DcGeneral\DataDefinition\Palette\Builder\Event
Located at DataDefinition/Palette/Builder/Event/AddConditionEvent.php
Methods summary
public
# __construct( DcGeneral\DataDefinition\Palette\Condition\Palette\PaletteConditionInterface|DcGeneral\DataDefinition\Palette\Condition\Property\PropertyConditionInterface $condition, DcGeneral\DataDefinition\Palette\PaletteInterface|DcGeneral\DataDefinition\Palette\PropertyInterface $target, DcGeneral\DataDefinition\Palette\Builder\PaletteBuilder $paletteBuilder )

Create a new instance.

Create a new instance.

Parameters

$condition
DcGeneral\DataDefinition\Palette\Condition\Palette\PaletteConditionInterface|DcGeneral\DataDefinition\Palette\Condition\Property\PropertyConditionInterface
$condition The condition being added.
$target
DcGeneral\DataDefinition\Palette\PaletteInterface|DcGeneral\DataDefinition\Palette\PropertyInterface
$target The target property or palette.
$paletteBuilder
DcGeneral\DataDefinition\Palette\Builder\PaletteBuilder
$paletteBuilder The palette builder in use.

Overrides

DcGeneral\DataDefinition\Palette\Builder\Event\BuilderEvent::__construct()
public DcGeneral\DataDefinition\Palette\Builder\Event\AddConditionEvent
# setCondition( DcGeneral\DataDefinition\Palette\Condition\Palette\PropertyValueCondition|DcGeneral\DataDefinition\Palette\Condition\Property\PropertyValueCondition $condition )

Set the condition.

Set the condition.

Parameters

$condition
DcGeneral\DataDefinition\Palette\Condition\Palette\PropertyValueCondition|DcGeneral\DataDefinition\Palette\Condition\Property\PropertyValueCondition
$condition The condition.

Returns

DcGeneral\DataDefinition\Palette\Builder\Event\AddConditionEvent

Throws

DcGeneral\Exception\DcGeneralInvalidArgumentException
When an invalid condition has been passed.
public DcGeneral\DataDefinition\Palette\Condition\Palette\PropertyValueCondition|DcGeneral\DataDefinition\Palette\Condition\Property\PropertyValueCondition
# getCondition( )

Retrieve the condition.

Retrieve the condition.

Returns

DcGeneral\DataDefinition\Palette\Condition\Palette\PropertyValueCondition|DcGeneral\DataDefinition\Palette\Condition\Property\PropertyValueCondition
public DcGeneral\DataDefinition\Palette\Builder\Event\AddConditionEvent
# setTarget( DcGeneral\DataDefinition\Palette\PaletteInterface|DcGeneral\DataDefinition\Palette\PropertyInterface $target )

Set the target.

Set the target.

Parameters

$target
DcGeneral\DataDefinition\Palette\PaletteInterface|DcGeneral\DataDefinition\Palette\PropertyInterface
$target The target property or palette.

Returns

DcGeneral\DataDefinition\Palette\Builder\Event\AddConditionEvent

Throws

DcGeneral\Exception\DcGeneralInvalidArgumentException
When an invalid target has been passed.
public DcGeneral\DataDefinition\Palette\PaletteInterface|DcGeneral\DataDefinition\Palette\PropertyInterface
# getTarget( )

Retrieve the target.

Retrieve the target.

Returns

DcGeneral\DataDefinition\Palette\PaletteInterface|DcGeneral\DataDefinition\Palette\PropertyInterface
Methods inherited from DcGeneral\DataDefinition\Palette\Builder\Event\BuilderEvent
getPaletteBuilder()
Methods inherited from DcGeneral\Event\AbstractContainerAwareEvent
getContainer()
Constants summary
string NAME 'dc-general.data-definition.palette.builder.add-condition'
#
Properties summary
protected DcGeneral\DataDefinition\Palette\Condition\Palette\PaletteConditionInterface|DcGeneral\DataDefinition\Palette\Condition\Property\PropertyConditionInterface $condition
#

The condition that is being added.

The condition that is being added.

protected DcGeneral\DataDefinition\Palette\PaletteInterface|DcGeneral\DataDefinition\Palette\PropertyInterface $target
#

The target to which the condition is being added.

The target to which the condition is being added.

Properties inherited from DcGeneral\DataDefinition\Palette\Builder\Event\BuilderEvent
$paletteBuilder
Properties inherited from DcGeneral\Event\AbstractContainerAwareEvent
$container
contao-community-alliance/dc-general API documentation generated by ApiGen 2.8.0