search_core/Documentation/source/usage.rst
Daniel Siepmann dfed17bb6c
TASK: Update docs
* Cover new features and how to use them.
2017-06-29 08:42:38 +02:00

1.6 KiB

Usage

Manual indexing

You can trigger indexing from CLI:

./typo3/cli_dispatch.phpsh extbase index:index --table 'tt_content'

This will index the table tt_content using the TcaIndexer.

Only one table per call is available, to index multiple tables just make multiple calls. The tables have to be white listed through allowedTables option.

Auto indexing

Indexing is done through hooks every time an record is changed. The tables have to be white listed through allowedTables option.

Note

Not all hook operations are supported yet, see 27.

Searching / Frontend Plugin

To provide a search interface you can insert the frontend Plugin as normal content element of type plugin. The plugin is named Search Core.

Please provide your own template, the extension will not deliver a useful template for now.

The extbase mapping is used, this way you can create a form:

<f:form name="searchRequest" object="{searchRequest}">
    <f:form.textfield property="query" />
    <f:form.submit value="search" />
</f:form>

Filter

Thanks to extbase mapping, filter are added to the form:

<f:form name="searchRequest" object="{searchRequest}">
    <f:form.textfield property="query" />
    <f:form.textfield property="filter.exampleName" value="the value to match" />
    <f:form.submit value="search" />
</f:form>