contao-community-alliance/dc-general » \ContaoCommunityAlliance\DcGeneral\DataDefinition\Definition\View\DefaultListingConfig

Class DefaultListingConfig.

Default implementation of a listing config.

Methods

Create a new instance.

__construct()

{@inheritdoc}

getDefaultSortingFields()

{@inheritdoc}

getGroupAndSortingDefinition()

{@inheritdoc}

getHeaderPropertyNames()

{@inheritdoc}

getItemCssClass()

{@inheritdoc}

getLabelFormatter($providerName)

Parameters

$providerName

Exceptions

`\ContaoCommunityAlliance\DcGeneral\Exception\DcGeneralInvalidArgumentException`	When no formatter has been defined.

{@inheritdoc}

getRootIcon()

{@inheritdoc}

getRootLabel()

{@inheritdoc}

getShowColumns()

{@inheritdoc}

hasLabelFormatter($providerName)

Parameters

$providerName

{@inheritdoc}

setGroupAndSortingDefinition($definition)

Parameters

$definition

{@inheritdoc}

setHeaderPropertyNames($value)

Parameters

$value

{@inheritdoc}

setItemCssClass($value)

Parameters

$value

{@inheritdoc}

setLabelFormatter($providerName, $value)

Parameters

$providerName

$value

{@inheritdoc}

setRootIcon($value)

Parameters

$value

{@inheritdoc}

setRootLabel($value)

Parameters

$value

{@inheritdoc}

setShowColumns($value)

Parameters

$value

Properties

The grouping and sorting definitions.

$groupAndSorting : \ContaoCommunityAlliance\DcGeneral\DataDefinition\Definition\View\GroupAndSortingDefinitionCollectionInterface

The properties to display in the heder (parented mode only).

$headerProperties : array

The CSS class to apply to each item in the listing.

$itemCssClass : string

The item formatter to use.

$itemFormatter : \ContaoCommunityAlliance\DcGeneral\DataDefinition\Definition\View\DefaultModelFormatterConfig[]

The root icon to use (hierarchical mode only).

$rootIcon : string

The root label.

$rootLabel : string

Flag if the properties displayed shall be shown as table layout.

$showColumns : bool