contao-community-alliance/dc-general
Back to top  

Default implementation of a palette.

 Methods

{@inheritdoc}

__clone() 

{@inheritdoc}

addLegend(\ContaoCommunityAlliance\DcGeneral\DataDefinition\Palette\LegendInterface $legend, \ContaoCommunityAlliance\DcGeneral\DataDefinition\Palette\LegendInterface $before) 

Parameters

$legend

$before

Exceptions

\ContaoCommunityAlliance\DcGeneral\Exception\DcGeneralInvalidArgumentException when the legend passed as $before can not be found.

{@inheritdoc}

addLegends(array $legends, \ContaoCommunityAlliance\DcGeneral\DataDefinition\Palette\LegendInterface $before) 

Parameters

$legends

$before

{@inheritdoc}

clearLegends() 

{@inheritdoc}

containsLegend(\ContaoCommunityAlliance\DcGeneral\DataDefinition\Palette\LegendInterface $legend) 

Parameters

$legend

{@inheritdoc}

getCondition() 

{@inheritdoc}

getEditableProperties(\ContaoCommunityAlliance\DcGeneral\Data\ModelInterface $model, \ContaoCommunityAlliance\DcGeneral\Data\PropertyValueBag $input) 

Parameters

$model

$input

{@inheritdoc}

getLegend($name) 

Parameters

$name

Exceptions

\ContaoCommunityAlliance\DcGeneral\Exception\DcGeneralRuntimeException When the legend does not exist.

{@inheritdoc}

getLegends() 

{@inheritdoc}

getName() 

{@inheritdoc}

getProperties(\ContaoCommunityAlliance\DcGeneral\Data\ModelInterface $model, \ContaoCommunityAlliance\DcGeneral\Data\PropertyValueBag $input) 

Parameters

$model

$input

{@inheritdoc}

getProperty($propertyName) 

Parameters

$propertyName

Exceptions

\ContaoCommunityAlliance\DcGeneral\Exception\DcGeneralRuntimeException When the palette does not contain the desired property.

{@inheritdoc}

getVisibleProperties(\ContaoCommunityAlliance\DcGeneral\Data\ModelInterface $model, \ContaoCommunityAlliance\DcGeneral\Data\PropertyValueBag $input) 

Parameters

$model

$input

{@inheritdoc}

hasLegend($name) 

Parameters

$name

{@inheritdoc}

removeLegend(\ContaoCommunityAlliance\DcGeneral\DataDefinition\Palette\LegendInterface $legend) 

Parameters

$legend

{@inheritdoc}

setCondition(\ContaoCommunityAlliance\DcGeneral\DataDefinition\Palette\Condition\Palette\PaletteConditionInterface $condition) 

Parameters

$condition

{@inheritdoc}

setLegends(array $legends) 

Parameters

$legends

{@inheritdoc}

setName($name) 

Parameters

$name

 Properties

 

The condition bound to this palette.

$condition : \ContaoCommunityAlliance\DcGeneral\DataDefinition\Palette\Condition\Palette\PaletteConditionInterface | null
 

List of all legends in this palette.

$legends : array | \ContaoCommunityAlliance\DcGeneral\DataDefinition\Palette\LegendInterface[]
 

The name of this palette.

$name : string
deprecated Only for backwards compatibility, we will remove palette names in the future!