search_core/Documentation/source/dataprocessors.rst
Daniel Siepmann 4756da5c5d
TASK: Update / cleanup documentation
Code and docs have diverged a bit. We therefore need to update them.
2018-03-08 11:35:50 +01:00

3.1 KiB

DataProcessors

See Concept of concepts_dataprocessing for further background information.

For information about implementing a new DataProcessor, take a look at development_dataprocessor.

Same as provided by TYPO3 for t3tsref:cobj-fluidtemplate through t3tsref:cobj-fluidtemplate-properties-dataprocessing.

Usage

All processors are applied in configured order. Allowing to work with already processed data. They can be applied during indexing and for search results.

Example for indexing:

plugin.tx_searchcore.settings.indexing.pages.dataProcessing {
    1 = Codappix\SearchCore\DataProcessing\CopyToProcessor
    1 {
        to = search_spellcheck
    }

    2 = Codappix\SearchCore\DataProcessing\CopyToProcessor
    2 {
        to = search_all
    }
}

The above example will copy all existing fields to the field search_spellcheck. Afterwards all fields, including search_spellcheck will be copied to search_all.

Example for search results:

plugin.tx_searchcore.settings.searching.dataProcessing {
    1 = Codappix\SearchCore\DataProcessing\CopyToProcessor
    1 {
        to = search_spellcheck
    }

    2 = Codappix\SearchCore\DataProcessing\CopyToProcessor
    2 {
        to = search_all
    }
}

The above example will copy all existing fields to the field search_spellcheck. Afterwards all fields, including search_spellcheck will be copied to search_all.

Available DataProcessors

/configuration/dataProcessing/ContentObjectDataProcessorAdapterProcessor /configuration/dataProcessing/CopyToProcessor /configuration/dataProcessing/GeoPointProcessor /configuration/dataProcessing/RemoveProcessor

Planned DataProcessors

Codappix\SearchCore\DataProcessing\ReplaceProcessor

Will execute a search and replace on configured fields.

Codappix\SearchCore\DataProcessing\RootLevelProcessor

Will attach the root level to the record.

Codappix\SearchCore\DataProcessing\ChannelProcessor

Will add a configurable channel to the record, e.g. if you have different areas in your website like "products" and "infos".

Codappix\SearchCore\DataProcessing\RelationResolverProcessor

Resolves all relations using the TCA. This is currently done through indexer.