Skip to main content

Output Channels

Output channels in general control how data is fetched, as well as the output of the retrieved data. The concept of output channels offers high flexibility since there's no limitation regarding the search index provider and how data is queried and output.

Configuration

General

dynamic_search.context.default.output_channels.<output-channel-name>

propertydescriptiondefault
multiplewether this output channel is a composition of multiple search containersfalse
serviceservice for the output channel. must implement OutputChannelInterface or MultiOutputChannelInterface, if multiple is truenull
use_frontend_controllerwether to use the SearchFrontendController for twig output, or the SearchController for json outputfalse
view_namename of the view to use. only effective if use_frontend_controller is trueMultiList if multiple is true, List otherwise.
runtime_query_providerservice for query provider. must implement RuntimeQueryProviderInterfacedefault
runtime_options_builderservice for options builder. must implement RuntimeOptionsBuilderInterfacedefault
internalfor internal usefalse

Options

dynamic_search.context.default.output_channels.<output-channel-name>.options

options for the output channel go here

Paginator

dynamic_search.context.default.output_channels.<output-channel-name>.paginator

propertydescriptiondefault
enabledwether paging is enabledfalse
adapter_classimplementation to use for paging. must implement AdapterInterfaceOpenDxp\Bundle\DynamicSearchBundle\Paginator\Adapter\DynamicSearchAdapter
max_per_pagemax results per page10

Normalizer

propertydescriptiondefault
serviceservice to use as normalizer for each document. Must implement DocumentNormalizerInterfacenull

Further reading

Check out the following implementations of OutputChannelInterface: