Interface PaletteCollectionInterface

Contains multiple palettes, organised by its name.

Direct known implementers

DcGeneral\DataDefinition\Definition\PalettesDefinitionInterface, DcGeneral\DataDefinition\Palette\PaletteCollection

Indirect known implementers

DcGeneral\DataDefinition\Definition\DefaultPalettesDefinition

Namespace: DcGeneral\DataDefinition\Palette
Located at DataDefinition/Palette/PaletteCollectionInterface.php

Methods summary
`public DcGeneral\DataDefinition\Palette\PaletteCollectionInterface`	# `clearPalettes( )` Remove all palettes from this collection. Remove all palettes from this collection. Returns `DcGeneral\DataDefinition\Palette\PaletteCollectionInterface`
`public DcGeneral\DataDefinition\Palette\PaletteCollectionInterface`	# `setPalettes( array $palettes )` Set all palettes in this collection. Set all palettes in this collection. Parameters `$palettes` `array\|DcGeneral\DataDefinition\Palette\PaletteInterface[]` $palettes The palettes. Returns `DcGeneral\DataDefinition\Palette\PaletteCollectionInterface`
`public DcGeneral\DataDefinition\Palette\PaletteInterface`	# `addPalettes( array $palettes )` Add multiple palettes to this collection. Add multiple palettes to this collection. Parameters `$palettes` `array\|DcGeneral\DataDefinition\Palette\PaletteInterface[]` $palettes The palettes. Returns `DcGeneral\DataDefinition\Palette\PaletteInterface`
`public DcGeneral\DataDefinition\Palette\PaletteInterface`	# `addPalette( DcGeneral\DataDefinition\Palette\PaletteInterface $palette )` Add a palette to this collection. Add a palette to this collection. Parameters `$palette` `DcGeneral\DataDefinition\Palette\PaletteInterface` $palette The palette. Returns `DcGeneral\DataDefinition\Palette\PaletteInterface`
`public DcGeneral\DataDefinition\Palette\PaletteInterface`	# `removePalette( DcGeneral\DataDefinition\Palette\PaletteInterface $palette )` Remove a palette from this collection. Remove a palette from this collection. Parameters `$palette` `DcGeneral\DataDefinition\Palette\PaletteInterface` $palette The palette. Returns `DcGeneral\DataDefinition\Palette\PaletteInterface`
`public array\|DcGeneral\DataDefinition\Palette\PaletteInterface[]`	# `getPalettes( )` Return all palettes in this collection. Return all palettes in this collection. Returns `array\|DcGeneral\DataDefinition\Palette\PaletteInterface[]`
`public boolean`	# `hasPalette( DcGeneral\DataDefinition\Palette\PaletteInterface $palette )` Check if a palette exists in this collection. Check if a palette exists in this collection. Parameters `$palette` `DcGeneral\DataDefinition\Palette\PaletteInterface` $palette The palette. Returns `boolean`
`public DcGeneral\DataDefinition\Palette\PaletteInterface`	# `findPalette( DcGeneral\Data\ModelInterface $model = null, DcGeneral\Data\PropertyValueBag $input = null )` Find the palette matching model and input parameters. Find the palette matching model and input parameters. Parameters `$model` `DcGeneral\Data\ModelInterface\|null` $model If given, selectors will be evaluated depending on the model. `$input` `DcGeneral\Data\PropertyValueBag` $input If given, selectors will be evaluated depending on the input data. Returns `DcGeneral\DataDefinition\Palette\PaletteInterface`
`public boolean`	# `hasPaletteByName( string $paletteName )` Check if a palette for the given name exists in this collection. Check if a palette for the given name exists in this collection. Deprecated Only for backwards compatibility, we will remove palette names in the future! Parameters `$paletteName` `string` $paletteName The palette name. Returns `boolean`
`public DcGeneral\DataDefinition\Palette\PaletteInterface`	# `getPaletteByName( string $paletteName )` Return the palette for the given name. Return the palette for the given name. Deprecated Only for backwards compatibility, we will remove palette names in the future! Parameters `$paletteName` `string` $paletteName The palette name. Returns `DcGeneral\DataDefinition\Palette\PaletteInterface`
`public`	# `__clone( )` Create a deep clone of the palette collection. Create a deep clone of the palette collection.