Interface ListingConfigInterface

Interface ListingConfigInterface.

This interface describes a property.

Direct known implementers

DcGeneral\DataDefinition\Definition\View\DefaultListingConfig

Namespace: DcGeneral\DataDefinition\Definition\View
Package: DcGeneral\DataDefinition\Definition\View
Located at DataDefinition/Definition/View/ListingConfigInterface.php

Methods summary
`public DcGeneral\DataDefinition\Definition\View\ListingConfigInterface`	# `setGroupingMode( string $value )` Set the grouping mode. Set the grouping mode. Parameters `$value` `string` $value The new mode. Returns `DcGeneral\DataDefinition\Definition\View\ListingConfigInterface`
`public string`	# `getGroupingMode( )` Return the grouping mode. Return the grouping mode. Returns `string`
`public DcGeneral\DataDefinition\Definition\View\ListingConfigInterface`	# `setGroupingLength( integer $value )` Set the grouping length. Set the grouping length. Parameters `$value` `integer` $value The new value. Returns `DcGeneral\DataDefinition\Definition\View\ListingConfigInterface`
`public integer`	# `getGroupingLength( )` The grouping length is used for char or digit grouping. The grouping length is used for char or digit grouping. It defines how many chars or digits should be respected when group mode is GROUP_CHAR. Returns `integer`
`public DcGeneral\DataDefinition\Definition\View\ListingConfigInterface`	# `setSortingMode( string $value )` Set the list sorting mode. Set the list sorting mode. Parameters `$value` `string` $value The new value. Returns `DcGeneral\DataDefinition\Definition\View\ListingConfigInterface`
`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". Returns `string`
`public DcGeneral\DataDefinition\Definition\View\ListingConfigInterface`	# `setDefaultSortingFields( array $value )` Set the default sorting fields. Set the default sorting fields. Parameters `$value` `array` $value The sorting fields to use. Returns `DcGeneral\DataDefinition\Definition\View\ListingConfigInterface`
`public array`	# `getDefaultSortingFields( )` Get the default sorting fields which are used if the user does not define a sorting. Get the default sorting fields which are used if the user does not define a sorting. Returns `array`
`public DcGeneral\DataDefinition\Definition\View\ListingConfigInterface`	# `setHeaderPropertyNames( array $value )` Set the list of parent's model property names. Set the list of parent's model property names. Parameters `$value` `array` $value The property names to use. Returns `DcGeneral\DataDefinition\Definition\View\ListingConfigInterface`
`public array`	# `getHeaderPropertyNames( )` Return a list of parent's model property names, which are shown above the item list. Return a list of parent's model property names, which are shown above the item list. Returns `array`
`public DcGeneral\DataDefinition\Definition\View\ListingConfigInterface`	# `setRootIcon( string $value )` Set the icon path to the root item's icon. Set the icon path to the root item's icon. Parameters `$value` `string` $value The path to the icon. Returns `DcGeneral\DataDefinition\Definition\View\ListingConfigInterface`
`public string`	# `getRootIcon( )` Return the icon path to the root item's icon. Return the icon path to the root item's icon. Returns `string`
`public DcGeneral\DataDefinition\Definition\View\ListingConfigInterface`	# `setItemCssClass( string $value )` Set the css classes that should be added to the items container. Set the css classes that should be added to the items container. Parameters `$value` `string` $value The CSS class to use. Returns `DcGeneral\DataDefinition\Definition\View\ListingConfigInterface`
`public string`	# `getItemCssClass( )` Return css classes that should be added to the items container. Return css classes that should be added to the items container. Returns `string`
`public DcGeneral\DataDefinition\Definition\View\ListingConfigInterface`	# `setLabelFormatter( string $providerName, DcGeneral\DataDefinition\Definition\View\ModelFormatterConfigInterface $value )` Set the label formatter. Set the label formatter. Parameters `$providerName` `string` $providerName The name of the data provider. `$value` `DcGeneral\DataDefinition\Definition\View\ModelFormatterConfigInterface` $value The model formatter to use. Returns `DcGeneral\DataDefinition\Definition\View\ListingConfigInterface`
`public boolean`	# `hasLabelFormatter( string $providerName )` Determine if the label formatter is present for a certain data provider. Determine if the label formatter is present for a certain data provider. Parameters `$providerName` `string` $providerName The name of the data provider. Returns `boolean`
`public DcGeneral\DataDefinition\Definition\View\ModelFormatterConfigInterface`	# `getLabelFormatter( string $providerName )` Return the label formatter for a certain data provider. Return the label formatter for a certain data provider. Parameters `$providerName` `string` $providerName The name of the data provider. Returns `DcGeneral\DataDefinition\Definition\View\ModelFormatterConfigInterface`
`public DcGeneral\DataDefinition\Definition\View\ListingConfigInterface`	# `setShowColumns( boolean $value )` Set if the listing shall be in table columns. Set if the listing shall be in table columns. Parameters `$value` `boolean` $value The flag. Returns `DcGeneral\DataDefinition\Definition\View\ListingConfigInterface`
`public boolean`	# `getShowColumns( )` Get if the listing shall be in table columns. Get if the listing shall be in table columns. Returns `boolean`

Constants summary
`string`	`GROUP_NONE`	`'none'`	# Do not group. Do not group.
`string`	`GROUP_CHAR`	`'char'`	# Group by characters, the max char count depend on the mode length (which is 1 by default for char grouping). Group by characters, the max char count depend on the mode length (which is 1 by default for char grouping).
`string`	`GROUP_DIGIT`	`'digit'`	# Group by digits, the max digit count depend on the mode length (which is infinity by default for digit grouping).. Group by digits, the max digit count depend on the mode length (which is infinity by default for digit grouping)..
`string`	`GROUP_DAY`	`'day'`	# Sort by day from datetime property. Sort by day from datetime property.
`string`	`GROUP_WEEKDAY`	`'weekday'`	# Sort by week day from datetime property. Sort by week day from datetime property.
`string`	`GROUP_WEEK`	`'week'`	# Sort by week of the year from datetime property. Sort by week of the year from datetime property.
`string`	`GROUP_MONTH`	`'month'`	# Sort by month from datetime property. Sort by month from datetime property.
`string`	`GROUP_YEAR`	`'year'`	# Sort by year from datetime property. Sort by year from datetime property.
`string`	`SORT_ASC`	`'asc'`	# Sort ascending. Sort ascending.
`string`	`SORT_DESC`	`'desc'`	# Sort descending. Sort descending.
`string`	`SORT_RANDOM`	`'random'`	# Shuffle all records instead of sorting. Shuffle all records instead of sorting.

Namespaces

Classes

Interfaces

Interface ListingConfigInterface

Direct known implementers

Parameters

Returns

Returns

Parameters

Returns

Returns

Parameters

Returns

Returns

Parameters

Returns

Returns

Parameters

Returns

Returns

Parameters

Returns

Returns

Parameters

Returns

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Returns