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

A property contained within a palette.

 Methods

Create a deep clone of the property.

__clone() : void

Get the editable condition for this property.

getEditableCondition() : \ContaoCommunityAlliance\DcGeneral\DataDefinition\Palette\Condition\Property\PropertyConditionInterface

Returns

\ContaoCommunityAlliance\DcGeneral\DataDefinition\Palette\Condition\Property\PropertyConditionInterface

Return the name of the property.

getName() : string

Returns

string

Get the visible condition for this property.

getVisibleCondition() : \ContaoCommunityAlliance\DcGeneral\DataDefinition\Palette\Condition\Property\PropertyConditionInterface

Returns

\ContaoCommunityAlliance\DcGeneral\DataDefinition\Palette\Condition\Property\PropertyConditionInterface

Check the conditions, if this property is editable.

isEditable(\ContaoCommunityAlliance\DcGeneral\Data\ModelInterface|null $model, \ContaoCommunityAlliance\DcGeneral\Data\PropertyValueBag $input, \ContaoCommunityAlliance\DcGeneral\DataDefinition\Palette\LegendInterface $legend) : bool

Parameters

$model

\ContaoCommunityAlliance\DcGeneral\Data\ModelInterfacenull

If given, sub palettes will be evaluated depending on the model. If no model is given, all properties will be returned, including sub palette properties.

$input

\ContaoCommunityAlliance\DcGeneral\Data\PropertyValueBag

If given, sub palettes will be evaluated depending on the input data. If no model and no input data is given, all properties will be returned, including sub palette properties.

$legend

\ContaoCommunityAlliance\DcGeneral\DataDefinition\Palette\LegendInterface

The legend the property is assigned to.

Returns

bool

Check the conditions, if this property is visible.

isVisible(\ContaoCommunityAlliance\DcGeneral\Data\ModelInterface|null $model, \ContaoCommunityAlliance\DcGeneral\Data\PropertyValueBag $input, \ContaoCommunityAlliance\DcGeneral\DataDefinition\Palette\LegendInterface $legend) : bool

Parameters

$model

\ContaoCommunityAlliance\DcGeneral\Data\ModelInterfacenull

If given, sub palettes will be evaluated depending on the model. If no model is given, all properties will be returned, including sub palette properties.

$input

\ContaoCommunityAlliance\DcGeneral\Data\PropertyValueBag

If given, sub palettes will be evaluated depending on the input data. If no model and no input data is given, all properties will be returned, including sub palette properties.

$legend

\ContaoCommunityAlliance\DcGeneral\DataDefinition\Palette\LegendInterface

The legend the property is assigned to.

Returns

bool

Set the editable condition for this property.

setEditableCondition(\ContaoCommunityAlliance\DcGeneral\DataDefinition\Palette\Condition\Property\PropertyConditionInterface $condition) : \ContaoCommunityAlliance\DcGeneral\DataDefinition\Palette\PropertyInterface

Parameters

$condition

\ContaoCommunityAlliance\DcGeneral\DataDefinition\Palette\Condition\Property\PropertyConditionInterface

The condition.

Returns

\ContaoCommunityAlliance\DcGeneral\DataDefinition\Palette\PropertyInterface

Set the name of the property.

setName(string $name) : \ContaoCommunityAlliance\DcGeneral\DataDefinition\Palette\PropertyInterface

Parameters

$name

string

The name of the property.

Returns

\ContaoCommunityAlliance\DcGeneral\DataDefinition\Palette\PropertyInterface

Set the visible condition for this property.

setVisibleCondition(\ContaoCommunityAlliance\DcGeneral\DataDefinition\Palette\Condition\Property\PropertyConditionInterface $condition) : \ContaoCommunityAlliance\DcGeneral\DataDefinition\Palette\PropertyInterface

Parameters

$condition

\ContaoCommunityAlliance\DcGeneral\DataDefinition\Palette\Condition\Property\PropertyConditionInterface

The condition.

Returns

\ContaoCommunityAlliance\DcGeneral\DataDefinition\Palette\PropertyInterface