Overview

Namespaces

  • DcGeneral
    • Clipboard
    • Contao
      • Callback
      • Compatibility
      • DataDefinition
        • Definition
      • Dca
        • Builder
          • Legacy
        • Definition
        • Palette
        • Populator
      • Event
      • View
        • Contao2BackendView
          • Event
    • Controller
    • Data
    • DataDefinition
      • Builder
      • Definition
        • Properties
        • View
          • Panel
      • ModelRelationship
      • Palette
        • Builder
          • Event
        • Condition
          • Palette
          • Property
    • EnvironmentPopulator
    • Event
    • Exception
    • Factory
      • Event
    • Panel
    • View
      • Event

Classes

  • DefaultProperty

Interfaces

  • PropertyInterface
  • Overview
  • Namespace
  • Class
  • Tree
  • Deprecated
  • Todo

Interface PropertyInterface

Interface PropertyInterface.

This interface describes a property information.

Direct known implementers

DcGeneral\DataDefinition\Definition\Properties\DefaultProperty
Namespace: DcGeneral\DataDefinition\Definition\Properties
Package: DcGeneral\DataDefinition\Definition\Properties
Located at DataDefinition/Definition/Properties/PropertyInterface.php
Methods summary
public string
# getName( )

Return the name of the property.

Return the name of the property.

Returns

string
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
public string
# getLabel( )

Return the label of the property.

Return the label of the property.

Returns

string
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
public string
# getDescription( )

Return the description of the property.

Return the description of the property.

Returns

string
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
public mixed
# getDefaultValue( )

Return the default value of the property.

Return the default value of the property.

Returns

mixed
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
public boolean
# isExcluded( )

Determinator if this property is excluded from access.

Determinator if this property is excluded from access.

Returns

boolean
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
public boolean
# isSearchable( )

Determinator if search is enabled on this property.

Determinator if search is enabled on this property.

Returns

boolean
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
public boolean
# isSortable( )

Determinator if sorting may be performed on this property.

Determinator if sorting may be performed on this property.

Returns

boolean
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
public boolean
# isFilterable( )

Determinator if filtering may be performed on this property.

Determinator if filtering may be performed on this property.

Returns

boolean
public DcGeneral\DataDefinition\Definition\Properties\PropertyInterface
# setGroupingMode( string $value )

Set the grouping mode.

Set the grouping mode.

See ListingConfigInterface::GROUP_* flags.

Parameters

$value
string
$value The grouping mode to apply.

Returns

DcGeneral\DataDefinition\Definition\Properties\PropertyInterface
public string
# getGroupingMode( )

Return the grouping mode.

Return the grouping mode.

Returns

string
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.

This defines how many chars or digits should be respected when grouping.

Parameters

$value
integer
$value The prefix length.

Returns

DcGeneral\DataDefinition\Definition\Properties\PropertyInterface
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.

The grouping length is used for char or digit grouping and define how many chars or digits should be respected when grouping.

Returns

integer
public DcGeneral\DataDefinition\Definition\Properties\PropertyInterface
# setSortingMode( string $value )

Set the the list sorting mode.

Set the the list sorting mode.

See ListingConfigInterface::SORT_* flags.

Parameters

$value
string
$value The sorting mode to apply.

Returns

DcGeneral\DataDefinition\Definition\Properties\PropertyInterface
public string
# getSortingMode( )

Return the list sorting mode.

Return the list sorting mode.

This sorting is applied after grouping and could also be called "in-group sorting".

See ListingConfigInterface::SORT_* flags.

Returns

string
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

Todo

this is view related, should be moved there?
public string
# getWidgetType( )

Return the widget type name.

Return the widget type name.

Returns

string

Todo

this is view related, should be moved there?
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
public array|null
# getOptions( )

Return the valid values of this property.

Return the valid values of this property.

Returns

array|null
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
public string
# getExplanation( )

Return the explanation of the property.

Return the explanation of the property.

Returns

string
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
public array
# getExtra( )

Fetch the extra data of the property.

Fetch the extra data of the property.

Returns

array
contao-community-alliance/dc-general API documentation generated by ApiGen 2.8.0