contao-community-alliance/dc-general » \ContaoCommunityAlliance\DcGeneral\DataDefinition\Palette\Legend

Default implementation of a legend.

Methods

{@inheritdoc}

__clone()

Create a new instance.

__construct(string $name)

Parameters

$name

string

The name of the legend.

{@inheritdoc}

addProperties(array $properties, \ContaoCommunityAlliance\DcGeneral\DataDefinition\Palette\PropertyInterface $before)

Parameters

$properties

$before

{@inheritdoc}

addProperty(\ContaoCommunityAlliance\DcGeneral\DataDefinition\Palette\PropertyInterface $property, \ContaoCommunityAlliance\DcGeneral\DataDefinition\Palette\PropertyInterface $before)

Parameters

$property

$before

Exceptions

`\ContaoCommunityAlliance\DcGeneral\Exception\DcGeneralInvalidArgumentException`	When the property passed as $before can not be found.

{@inheritdoc}

clearProperties()

{@inheritdoc}

getName()

{@inheritdoc}

getPalette()

{@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 legend does not contain the desired property.

{@inheritdoc}

hasProperty($propertyName)

Parameters

$propertyName

{@inheritdoc}

isInitialVisible()

{@inheritdoc}

removeProperty(\ContaoCommunityAlliance\DcGeneral\DataDefinition\Palette\PropertyInterface $property)

Parameters

$property

{@inheritdoc}

setInitialVisibility($value)

Parameters

$value

{@inheritdoc}

setName($name)

Parameters

$name

{@inheritdoc}

setPalette(\ContaoCommunityAlliance\DcGeneral\DataDefinition\Palette\PaletteInterface $palette)

Parameters

$palette

{@inheritdoc}

setProperties(array $properties)

Parameters

$properties

Properties

Determinator if this legend is initially expanded.

$initiallyVisible : bool

The name of this legend.

$name : string

The palette this legend belongs to.

$palette : \ContaoCommunityAlliance\DcGeneral\DataDefinition\Palette\PaletteInterface | null

The properties in this legend.

$properties : \ContaoCommunityAlliance\DcGeneral\DataDefinition\Palette\PropertyInterface[] | array