Class DefaultListingConfig

Class DefaultListingConfig.

Default implementation of a listing config.

DcGeneral\DataDefinition\Definition\View\DefaultListingConfig implements DcGeneral\DataDefinition\Definition\View\ListingConfigInterface

Namespace: DcGeneral\DataDefinition\Definition\View
Package: DcGeneral\DataDefinition\Definition\View
Located at DataDefinition/Definition/View/DefaultListingConfig.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` Implementation of `DcGeneral\DataDefinition\Definition\View\ListingConfigInterface::setGroupingMode()`
`public string`	# `getGroupingMode( )` Return the grouping mode. Return the grouping mode. Returns `string` Implementation of `DcGeneral\DataDefinition\Definition\View\ListingConfigInterface::getGroupingMode()`
`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` Implementation of `DcGeneral\DataDefinition\Definition\View\ListingConfigInterface::setGroupingLength()`
`public integer`	# `getGroupingLength( )` The grouping length is used for char or digit grouping. The grouping length is used for char or digit grouping. Returns `integer` Implementation of `DcGeneral\DataDefinition\Definition\View\ListingConfigInterface::getGroupingLength()`
`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` Implementation of `DcGeneral\DataDefinition\Definition\View\ListingConfigInterface::setSortingMode()`
`public string`	# `getSortingMode( )` Return the list sorting mode. Return the list sorting mode. Returns `string` Implementation of `DcGeneral\DataDefinition\Definition\View\ListingConfigInterface::getSortingMode()`
`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` Implementation of `DcGeneral\DataDefinition\Definition\View\ListingConfigInterface::setDefaultSortingFields()`
`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` Implementation of `DcGeneral\DataDefinition\Definition\View\ListingConfigInterface::getDefaultSortingFields()`
`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` Implementation of `DcGeneral\DataDefinition\Definition\View\ListingConfigInterface::setHeaderPropertyNames()`
`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` Implementation of `DcGeneral\DataDefinition\Definition\View\ListingConfigInterface::getHeaderPropertyNames()`
`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` Implementation of `DcGeneral\DataDefinition\Definition\View\ListingConfigInterface::setRootIcon()`
`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` Implementation of `DcGeneral\DataDefinition\Definition\View\ListingConfigInterface::getRootIcon()`
`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` Implementation of `DcGeneral\DataDefinition\Definition\View\ListingConfigInterface::setItemCssClass()`
`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` Implementation of `DcGeneral\DataDefinition\Definition\View\ListingConfigInterface::getItemCssClass()`
`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` Implementation of `DcGeneral\DataDefinition\Definition\View\ListingConfigInterface::setLabelFormatter()`
`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` Implementation of `DcGeneral\DataDefinition\Definition\View\ListingConfigInterface::hasLabelFormatter()`
`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` Throws `DcGeneral\Exception\DcGeneralInvalidArgumentException` When no formatter has been defined. Implementation of `DcGeneral\DataDefinition\Definition\View\ListingConfigInterface::getLabelFormatter()`
`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` Implementation of `DcGeneral\DataDefinition\Definition\View\ListingConfigInterface::setShowColumns()`
`public boolean`	# `getShowColumns( )` Get if the listing shall be in table columns. Get if the listing shall be in table columns. Returns `boolean` Implementation of `DcGeneral\DataDefinition\Definition\View\ListingConfigInterface::getShowColumns()`

Constants inherited from DcGeneral\DataDefinition\Definition\View\ListingConfigInterface
`GROUP_CHAR, GROUP_DAY, GROUP_DIGIT, GROUP_MONTH, GROUP_NONE, GROUP_WEEK, GROUP_WEEKDAY, GROUP_YEAR, SORT_ASC, SORT_DESC, SORT_RANDOM`

Properties summary
`protected string`	`$groupingMode`	# The grouping mode to use. The grouping mode to use.
`protected string`	`$groupingLength`	# The grouing length to use. The grouing length to use.
`protected string`	`$sortingMode`	# The default sorting mode. The default sorting mode.
`protected array`	`$defaultSortingFields`	# The names of the properties that will be used for sorting by default. The names of the properties that will be used for sorting by default.
`protected array`	`$headerProperties`	# The properties to display in the heder (parented mode only). The properties to display in the heder (parented mode only).
`protected string`	`$rootIcon`	# The root icon to use (hierarchical mode only). The root icon to use (hierarchical mode only).
`protected string`	`$itemCssClass`	# The CSS class to apply to each item in the listing. The CSS class to apply to each item in the listing.
`protected DcGeneral\DataDefinition\Definition\View\DefaultModelFormatterConfig[]`	`$itemFormatter`	# The item formatter to use. The item formatter to use.
`protected boolean`	`$showColumns`	# Flag if the properties displayed shall be shown as table layout. Flag if the properties displayed shall be shown as table layout.

Namespaces

Classes

Interfaces

Class DefaultListingConfig

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

Parameters

Returns

Implementation of

Parameters

Returns

Throws

Implementation of

Parameters

Returns

Implementation of

Returns

Implementation of