dachcom-digital/dynamic-search-index-provider-lucene

v3.0.3 2024-02-12 14:54 UTC

README

Software License Latest Release Tests PhpStan

An index storage extension for Pimcore Dynamic Search. Store data with the PHP Lucene index service.

Release Plan

Installation

"require" : {
    "dachcom-digital/dynamic-search" : "~3.0.0",
    "dachcom-digital/dynamic-search-index-provider-lucene" : "~3.0.0"
}

Dependencies

This package will also install a fork of ZendSearch to provide the latest PHP compatibility.

Dynamic Search Bundle

You need to install / enable the Dynamic Search Bundle first. Read more about it here. After that, proceed as followed:

Add Bundle to bundles.php:

<?php

return [
    \DsLuceneBundle\DsLuceneBundle::class => ['all' => true],
];

Basic Setup

dynamic_search:
    context:
        default:
            index_provider:
                service: 'lucene'
                options:
                    database_name: 'my_lucene_storage'

Provider Options

Index Fields

Available Index Fields:

Output Channel Services

Autocomplete

Identifier: lucene_autocomplete
Available Options:

Suggestions

Identifier: lucene_suggestions
Available Options:

Search

Identifier: lucene_search
Available Options:

Multi Search

Identifier: lucene_multi_search
Available Options: none

Filter

RelationsFilter

Identifier: relations
Available Options:

Output Normalizer

A Output Normalizer can be defined for each output channel.

lucene_document_key_value_normalizer

Available Options:

Further Information

Copyright and License

Copyright: DACHCOM.DIGITAL
For licensing details please visit LICENSE.md

Upgrade Info

Before updating, please check our upgrade notes!