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

Interface ListingConfigInterface.

This interface describes a property.

 Methods

Get the default sorting fields which are used if the user does not define a sorting.

getDefaultSortingFields() : array
deprecated

Returns

array

Retrieve the grouping and sorting definitions.

getGroupAndSortingDefinition() : \ContaoCommunityAlliance\DcGeneral\DataDefinition\Definition\View\GroupAndSortingDefinitionCollectionInterface

Returns

\ContaoCommunityAlliance\DcGeneral\DataDefinition\Definition\View\GroupAndSortingDefinitionCollectionInterface

Return a list of parent's model property names, which are shown above the item list.

getHeaderPropertyNames() : array

Returns

array

Return css classes that should be added to the items container.

getItemCssClass() : string

Returns

string

Return the label formatter for a certain data provider.

getLabelFormatter(string $providerName) : \ContaoCommunityAlliance\DcGeneral\DataDefinition\Definition\View\ModelFormatterConfigInterface

Parameters

$providerName

string

The name of the data provider.

Returns

\ContaoCommunityAlliance\DcGeneral\DataDefinition\Definition\View\ModelFormatterConfigInterface

Return the icon path to the root item's icon.

getRootIcon() : string

Returns

string

Get the root label.

getRootLabel() : string

Returns

string

Get if the listing shall be in table columns.

getShowColumns() : bool
SuppressWarnings (PHPMD.BooleanGetMethodName)

Returns

bool

Determine if the label formatter is present for a certain data provider.

hasLabelFormatter(string $providerName) : bool

Parameters

$providerName

string

The name of the data provider.

Returns

bool

Set the grouping and sorting definitions.

setGroupAndSortingDefinition(\ContaoCommunityAlliance\DcGeneral\DataDefinition\Definition\View\GroupAndSortingDefinitionCollectionInterface $definition) : \ContaoCommunityAlliance\DcGeneral\DataDefinition\Definition\View\ListingConfigInterface

Parameters

$definition

\ContaoCommunityAlliance\DcGeneral\DataDefinition\Definition\View\GroupAndSortingDefinitionCollectionInterface

The definition to use.

Returns

\ContaoCommunityAlliance\DcGeneral\DataDefinition\Definition\View\ListingConfigInterface

Set the list of parent's model property names.

setHeaderPropertyNames(array $value) : \ContaoCommunityAlliance\DcGeneral\DataDefinition\Definition\View\ListingConfigInterface

Parameters

$value

array

The property names to use.

Returns

\ContaoCommunityAlliance\DcGeneral\DataDefinition\Definition\View\ListingConfigInterface

Set the css classes that should be added to the items container.

setItemCssClass(string $value) : \ContaoCommunityAlliance\DcGeneral\DataDefinition\Definition\View\ListingConfigInterface

Parameters

$value

string

The CSS class to use.

Returns

\ContaoCommunityAlliance\DcGeneral\DataDefinition\Definition\View\ListingConfigInterface

Set the label formatter.

setLabelFormatter(string $providerName, \ContaoCommunityAlliance\DcGeneral\DataDefinition\Definition\View\ModelFormatterConfigInterface $value) : \ContaoCommunityAlliance\DcGeneral\DataDefinition\Definition\View\ListingConfigInterface

Parameters

$providerName

string

The name of the data provider.

$value

\ContaoCommunityAlliance\DcGeneral\DataDefinition\Definition\View\ModelFormatterConfigInterface

The model formatter to use.

Returns

\ContaoCommunityAlliance\DcGeneral\DataDefinition\Definition\View\ListingConfigInterface

Set the icon path to the root item's icon.

setRootIcon(string $value) : \ContaoCommunityAlliance\DcGeneral\DataDefinition\Definition\View\ListingConfigInterface

Parameters

$value

string

The path to the icon.

Returns

\ContaoCommunityAlliance\DcGeneral\DataDefinition\Definition\View\ListingConfigInterface

Set the root label.

setRootLabel(string $value) : \ContaoCommunityAlliance\DcGeneral\DataDefinition\Definition\View\ListingConfigInterface

Parameters

$value

string

The new label.

Returns

\ContaoCommunityAlliance\DcGeneral\DataDefinition\Definition\View\ListingConfigInterface

Set if the listing shall be in table columns.

setShowColumns(bool $value) : \ContaoCommunityAlliance\DcGeneral\DataDefinition\Definition\View\ListingConfigInterface

Parameters

$value

bool

The flag.

Returns

\ContaoCommunityAlliance\DcGeneral\DataDefinition\Definition\View\ListingConfigInterface