Class DefaultProperty

Class DefaultProperty.

Default implementation of a property definition.

DcGeneral\DataDefinition\Definition\Properties\DefaultProperty implements DcGeneral\DataDefinition\Definition\Properties\PropertyInterface

Namespace: DcGeneral\DataDefinition\Definition\Properties
Package: DcGeneral\DataDefinition\Definition\Properties
Located at DataDefinition/Definition/Properties/DefaultProperty.php

Methods summary
`public`	# `__construct( string $name )` Create an instance. Create an instance. Parameters `$name` `string` $name The name of the property.
`public string`	# `getName( )` Return the name of the property. Return the name of the property. Returns `string` Implementation of `DcGeneral\DataDefinition\Definition\Properties\PropertyInterface::getName()`
`public DcGeneral\DataDefinition\Definition\Properties\PropertyInterface`	# `setLabel( string $value )` Set the label language key. Set the label language key. Parameters `$value` `string` $value The label value. Returns `DcGeneral\DataDefinition\Definition\Properties\PropertyInterface` Implementation of `DcGeneral\DataDefinition\Definition\Properties\PropertyInterface::setLabel()`
`public string`	# `getLabel( )` Return the label of the property. Return the label of the property. Returns `string` Implementation of `DcGeneral\DataDefinition\Definition\Properties\PropertyInterface::getLabel()`
`public DcGeneral\DataDefinition\Definition\Properties\PropertyInterface`	# `setDescription( string $value )` Set the description language key. Set the description language key. Parameters `$value` `string` $value The description text. Returns `DcGeneral\DataDefinition\Definition\Properties\PropertyInterface` Implementation of `DcGeneral\DataDefinition\Definition\Properties\PropertyInterface::setDescription()`
`public string`	# `getDescription( )` Return the description of the property. Return the description of the property. Returns `string` Implementation of `DcGeneral\DataDefinition\Definition\Properties\PropertyInterface::getDescription()`
`public DcGeneral\DataDefinition\Definition\Properties\PropertyInterface`	# `setDefaultValue( mixed $value )` Set the default value of the property. Set the default value of the property. Parameters `$value` `mixed` $value The default value. Returns `DcGeneral\DataDefinition\Definition\Properties\PropertyInterface` Implementation of `DcGeneral\DataDefinition\Definition\Properties\PropertyInterface::setDefaultValue()`
`public mixed`	# `getDefaultValue( )` Return the default value of the property. Return the default value of the property. Returns `mixed` Implementation of `DcGeneral\DataDefinition\Definition\Properties\PropertyInterface::getDefaultValue()`
`public DcGeneral\DataDefinition\Definition\Properties\PropertyInterface`	# `setExcluded( boolean $value )` Set if the property is excluded from access. Set if the property is excluded from access. Parameters `$value` `boolean` $value The flag. Returns `DcGeneral\DataDefinition\Definition\Properties\PropertyInterface` Implementation of `DcGeneral\DataDefinition\Definition\Properties\PropertyInterface::setExcluded()`
`public boolean`	# `isExcluded( )` Determinator if this property is excluded from access. Determinator if this property is excluded from access. Returns `boolean` Implementation of `DcGeneral\DataDefinition\Definition\Properties\PropertyInterface::isExcluded()`
`public DcGeneral\DataDefinition\Definition\Properties\PropertyInterface`	# `setSearchable( boolean $value )` Set the search determinator. Set the search determinator. Parameters `$value` `boolean` $value The flag. Returns `DcGeneral\DataDefinition\Definition\Properties\PropertyInterface` Implementation of `DcGeneral\DataDefinition\Definition\Properties\PropertyInterface::setSearchable()`
`public boolean`	# `isSearchable( )` Determinator if search is enabled on this property. Determinator if search is enabled on this property. Returns `boolean` Implementation of `DcGeneral\DataDefinition\Definition\Properties\PropertyInterface::isSearchable()`
`public DcGeneral\DataDefinition\Definition\Properties\PropertyInterface`	# `setSortable( boolean $value )` Set the sorting determinator. Set the sorting determinator. Parameters `$value` `boolean` $value The flag. Returns `DcGeneral\DataDefinition\Definition\Properties\PropertyInterface` Implementation of `DcGeneral\DataDefinition\Definition\Properties\PropertyInterface::setSortable()`
`public boolean`	# `isSortable( )` Determinator if sorting may be performed on this property. Determinator if sorting may be performed on this property. Returns `boolean` Implementation of `DcGeneral\DataDefinition\Definition\Properties\PropertyInterface::isSortable()`
`public DcGeneral\DataDefinition\Definition\Properties\PropertyInterface`	# `setFilterable( boolean $value )` Set filtering determinator. Set filtering determinator. Parameters `$value` `boolean` $value The flag. Returns `DcGeneral\DataDefinition\Definition\Properties\PropertyInterface` Implementation of `DcGeneral\DataDefinition\Definition\Properties\PropertyInterface::setFilterable()`
`public boolean`	# `isFilterable( )` Determinator if filtering may be performed on this property. Determinator if filtering may be performed on this property. Returns `boolean` Implementation of `DcGeneral\DataDefinition\Definition\Properties\PropertyInterface::isFilterable()`
`public DcGeneral\DataDefinition\Definition\Properties\PropertyInterface`	# `setGroupingMode( string $value )` Set the grouping mode. Set the grouping mode. Parameters `$value` `string` $value The grouping mode to apply. Returns `DcGeneral\DataDefinition\Definition\Properties\PropertyInterface` Implementation of `DcGeneral\DataDefinition\Definition\Properties\PropertyInterface::setGroupingMode()`
`public string`	# `getGroupingMode( )` Return the grouping mode. Return the grouping mode. Returns `string` Implementation of `DcGeneral\DataDefinition\Definition\Properties\PropertyInterface::getGroupingMode()`
`public DcGeneral\DataDefinition\Definition\Properties\PropertyInterface`	# `setGroupingLength( integer $value )` Set the grouping length is used for char or digit grouping. Set the grouping length is used for char or digit grouping. Parameters `$value` `integer` $value The prefix length. Returns `DcGeneral\DataDefinition\Definition\Properties\PropertyInterface` Implementation of `DcGeneral\DataDefinition\Definition\Properties\PropertyInterface::setGroupingLength()`
`public integer`	# `getGroupingLength( )` Get the grouping length is used for char or digit grouping. Get the grouping length is used for char or digit grouping. Returns `integer` Implementation of `DcGeneral\DataDefinition\Definition\Properties\PropertyInterface::getGroupingLength()`
`public DcGeneral\DataDefinition\Definition\Properties\PropertyInterface`	# `setSortingMode( string $value )` Set the the list sorting mode. Set the the list sorting mode. Parameters `$value` `string` $value The sorting mode to apply. Returns `DcGeneral\DataDefinition\Definition\Properties\PropertyInterface` Implementation of `DcGeneral\DataDefinition\Definition\Properties\PropertyInterface::setSortingMode()`
`public string`	# `getSortingMode( )` Return the list sorting mode. Return the list sorting mode. Returns `string` Implementation of `DcGeneral\DataDefinition\Definition\Properties\PropertyInterface::getSortingMode()`
`public DcGeneral\DataDefinition\Definition\Properties\PropertyInterface`	# `setWidgetType( string $value )` Set the widget type name. Set the widget type name. Parameters `$value` `string` $value The type name of the widget. Returns `DcGeneral\DataDefinition\Definition\Properties\PropertyInterface` Implementation of `DcGeneral\DataDefinition\Definition\Properties\PropertyInterface::setWidgetType()`
`public string`	# `getWidgetType( )` Return the widget type name. Return the widget type name. Returns `string` Implementation of `DcGeneral\DataDefinition\Definition\Properties\PropertyInterface::getWidgetType()`
`public DcGeneral\DataDefinition\Definition\Properties\PropertyInterface`	# `setOptions( array $value )` Set the valid values of this property. Set the valid values of this property. Parameters `$value` `array` $value The options. Returns `DcGeneral\DataDefinition\Definition\Properties\PropertyInterface` Implementation of `DcGeneral\DataDefinition\Definition\Properties\PropertyInterface::setOptions()`
`public array\|null`	# `getOptions( )` Return the valid values of this property. Return the valid values of this property. Returns `array\|null` Implementation of `DcGeneral\DataDefinition\Definition\Properties\PropertyInterface::getOptions()`
`public DcGeneral\DataDefinition\Definition\Properties\PropertyInterface`	# `setExplanation( string $value )` Set the explanation language string. Set the explanation language string. Parameters `$value` `string` $value The explanation text. Returns `DcGeneral\DataDefinition\Definition\Properties\PropertyInterface` Implementation of `DcGeneral\DataDefinition\Definition\Properties\PropertyInterface::setExplanation()`
`public string`	# `getExplanation( )` Return the explanation of the property. Return the explanation of the property. Returns `string` Implementation of `DcGeneral\DataDefinition\Definition\Properties\PropertyInterface::getExplanation()`
`public DcGeneral\DataDefinition\Definition\Properties\PropertyInterface`	# `setExtra( array $value )` Set the extra data of the property. Set the extra data of the property. Parameters `$value` `array` $value The extra data for this property. Returns `DcGeneral\DataDefinition\Definition\Properties\PropertyInterface` Implementation of `DcGeneral\DataDefinition\Definition\Properties\PropertyInterface::setExtra()`
`public array`	# `getExtra( )` Fetch the extra data of the property. Fetch the extra data of the property. Returns `array` Implementation of `DcGeneral\DataDefinition\Definition\Properties\PropertyInterface::getExtra()`

Properties summary
`protected string`	`$name`	# The property name. The property name.
`protected string`	`$label`	# The label of the property. The label of the property.
`protected string`	`$description`	# The description of the property. The description of the property.
`protected mixed`	`$defaultValue`	# The default value of the property. The default value of the property.
`protected boolean`	`$excluded`	# Define if this property shall be excluded by default. Define if this property shall be excluded by default.
`protected boolean`	`$searchable`	# Flag if this property shall be searchable. Flag if this property shall be searchable.
`protected boolean`	`$sortable`	# Flag if this property shall be sortable. Flag if this property shall be sortable.
`protected boolean`	`$filterable`	# Flag if this property shall be filterable. Flag if this property shall be filterable.
`protected string`	`$groupingMode`	# The grouping mode for this property. The grouping mode for this property. See ListingConfigInterface::GROUP_* flags.
`protected string`	`$groupingLength`	# The grouing length of this property. See grouping mode. The grouing length of this property. See grouping mode.
`protected string`	`$sortingMode`	# The sorting mode for this property. The sorting mode for this property. See ListingConfigInterface::SORT_* flags.
`protected string`	`$widgetType`	# The input widget type to use. The input widget type to use.
`protected array\|null`	`$options`	# The value options for this property. The value options for this property.
`protected string`	`$explanation`	# The explanation string for this property. The explanation string for this property.
`protected array`	`$extra`	# The extra information for this property. The extra information for this property.

Namespaces

Classes

Interfaces

Class DefaultProperty

Parameters

Returns

Implementation of

Parameters

Returns

Implementation of

Returns

Implementation of

Parameters

Returns

Implementation of

Returns

Implementation of

Parameters

Returns

Implementation of

Returns

Implementation of

Parameters

Returns

Implementation of

Returns

Implementation of

Parameters

Returns

Implementation of

Returns

Implementation of

Parameters

Returns

Implementation of

Returns

Implementation of

Parameters

Returns

Implementation of

Returns

Implementation of

Parameters

Returns

Implementation of

Returns

Implementation of

Parameters

Returns

Implementation of

Returns

Implementation of

Parameters

Returns

Implementation of

Returns

Implementation of

Parameters

Returns

Implementation of

Returns

Implementation of

Parameters

Returns

Implementation of

Returns

Implementation of

Parameters

Returns

Implementation of

Returns

Implementation of

Parameters

Returns

Implementation of

Returns

Implementation of