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

Interface PropertyInterface.

This interface describes a property information.

 Methods

Return the default value of the property.

getDefaultValue() : mixed

Returns

mixed

Return the description of the property.

getDescription() : string

Returns

string

Return the explanation of the property.

getExplanation() : string

Returns

string

Fetch the extra data of the property.

getExtra() : array

Returns

array

Return the label of the property.

getLabel() : string

Returns

string

Return the name of the property.

getName() : string

Returns

string

Return the valid values of this property.

getOptions() : array | null

Returns

arraynull

Return the widget type name.

getWidgetType() : string
todo this is view related, should be moved there?

Returns

string

Determinator if this property is excluded from access.

isExcluded() : bool

Returns

bool

Determinator if filtering may be performed on this property.

isFilterable() : bool

Returns

bool

Determinator if search is enabled on this property.

isSearchable() : bool

Returns

bool

Determinator if sorting may be performed on this property.

isSortable() : bool
deprecated Deprecated in favor of GroupAndSortingInformationInterface.
see

Returns

bool

Set the default value of the property.

setDefaultValue(mixed $value) : \ContaoCommunityAlliance\DcGeneral\DataDefinition\Definition\Properties\PropertyInterface

Parameters

$value

mixed

The default value.

Returns

\ContaoCommunityAlliance\DcGeneral\DataDefinition\Definition\Properties\PropertyInterface

Set the description language key.

setDescription(string $value) : \ContaoCommunityAlliance\DcGeneral\DataDefinition\Definition\Properties\PropertyInterface

Parameters

$value

string

The description text.

Returns

\ContaoCommunityAlliance\DcGeneral\DataDefinition\Definition\Properties\PropertyInterface

Set if the property is excluded from access.

setExcluded(bool $value) : \ContaoCommunityAlliance\DcGeneral\DataDefinition\Definition\Properties\PropertyInterface

Parameters

$value

bool

The flag.

Returns

\ContaoCommunityAlliance\DcGeneral\DataDefinition\Definition\Properties\PropertyInterface

Set the explanation language string.

setExplanation(string $value) : \ContaoCommunityAlliance\DcGeneral\DataDefinition\Definition\Properties\PropertyInterface

Parameters

$value

string

The explanation text.

Returns

\ContaoCommunityAlliance\DcGeneral\DataDefinition\Definition\Properties\PropertyInterface

Set the extra data of the property.

setExtra(array $value) : \ContaoCommunityAlliance\DcGeneral\DataDefinition\Definition\Properties\PropertyInterface

Parameters

$value

array

The extra data for this property.

Returns

\ContaoCommunityAlliance\DcGeneral\DataDefinition\Definition\Properties\PropertyInterface

Set filtering determinator.

setFilterable(bool $value) : \ContaoCommunityAlliance\DcGeneral\DataDefinition\Definition\Properties\PropertyInterface

Parameters

$value

bool

The flag.

Returns

\ContaoCommunityAlliance\DcGeneral\DataDefinition\Definition\Properties\PropertyInterface

Set the label language key.

setLabel(string $value) : \ContaoCommunityAlliance\DcGeneral\DataDefinition\Definition\Properties\PropertyInterface

Parameters

$value

string

The label value.

Returns

\ContaoCommunityAlliance\DcGeneral\DataDefinition\Definition\Properties\PropertyInterface

Set the valid values of this property.

setOptions(array $value) : \ContaoCommunityAlliance\DcGeneral\DataDefinition\Definition\Properties\PropertyInterface

Parameters

$value

array

The options.

Returns

\ContaoCommunityAlliance\DcGeneral\DataDefinition\Definition\Properties\PropertyInterface

Set the search determinator.

setSearchable(bool $value) : \ContaoCommunityAlliance\DcGeneral\DataDefinition\Definition\Properties\PropertyInterface

Parameters

$value

bool

The flag.

Returns

\ContaoCommunityAlliance\DcGeneral\DataDefinition\Definition\Properties\PropertyInterface

Set the sorting determinator.

setSortable(bool $value) : \ContaoCommunityAlliance\DcGeneral\DataDefinition\Definition\Properties\PropertyInterface
deprecated Deprecated in favor of GroupAndSortingInformationInterface.
see

Parameters

$value

bool

The flag.

Returns

\ContaoCommunityAlliance\DcGeneral\DataDefinition\Definition\Properties\PropertyInterface

Set the widget type name.

setWidgetType(string $value) : \ContaoCommunityAlliance\DcGeneral\DataDefinition\Definition\Properties\PropertyInterface
todo this is view related, should be moved there?

Parameters

$value

string

The type name of the widget.

Returns

\ContaoCommunityAlliance\DcGeneral\DataDefinition\Definition\Properties\PropertyInterface