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
 1: <?php
 2: /**
 3:  * PHP version 5
 4:  * @package    generalDriver
 5:  * @author     Christian Schiffler <c.schiffler@cyberspectrum.de>
 6:  * @author     Stefan Heimes <stefan_heimes@hotmail.com>
 7:  * @author     Tristan Lins <tristan.lins@bit3.de>
 8:  * @copyright  The MetaModels team.
 9:  * @license    LGPL.
10:  * @filesource
11:  */
12: 
13: namespace DcGeneral\DataDefinition\Palette\Builder\Event;
14: 
15: use DcGeneral\DataDefinition\Palette\Builder\PaletteBuilder;
16: use DcGeneral\DataDefinition\Palette\PaletteCollectionInterface;
17: 
18: /**
19:  * This event gets emitted when a palette collection is being created.
20:  *
21:  * @package DcGeneral\DataDefinition\Palette\Builder\Event
22:  */
23: class CreatePaletteCollectionEvent extends BuilderEvent
24: {
25:     const NAME = 'dc-general.data-definition.palette.builder.create-palette-collection';
26: 
27:     /**
28:      * The palette collection that has been created.
29:      *
30:      * @var PaletteCollectionInterface
31:      */
32:     protected $paletteCollection;
33: 
34:     /**
35:      * Create a new instance.
36:      *
37:      * @param PaletteCollectionInterface $paletteCollection The palette collection that has been created.
38:      *
39:      * @param PaletteBuilder             $paletteBuilder    The palette builder in use.
40:      */
41:     public function __construct(PaletteCollectionInterface $paletteCollection, PaletteBuilder $paletteBuilder)
42:     {
43:         $this->setPaletteCollection($paletteCollection);
44: 
45:         parent::__construct($paletteBuilder);
46:     }
47: 
48:     /**
49:      * Set the palette collection.
50:      *
51:      * @param PaletteCollectionInterface $paletteCollection The palette collection.
52:      *
53:      * @return CreatePaletteCollectionEvent
54:      */
55:     public function setPaletteCollection(PaletteCollectionInterface $paletteCollection)
56:     {
57:         $this->paletteCollection = $paletteCollection;
58: 
59:         return $this;
60:     }
61: 
62:     /**
63:      * Retrieve the palette collection.
64:      *
65:      * @return PaletteCollectionInterface
66:      */
67:     public function getPaletteCollection()
68:     {
69:         return $this->paletteCollection;
70:     }
71: }
72: 
contao-community-alliance/dc-general API documentation generated by ApiGen 2.8.0