dachcom-digital/dynamic-search

Pimcore Dynamic Search Bundle

v4.0.2 2024-10-17 07:57 UTC

Requires

• pimcore/pimcore: ^11.0
• symfony/form: ^6.2

Requires (Dev)

• codeception/codeception: ^5.0
• codeception/module-symfony: ^3.1
• codeception/module-webdriver: ^4.0
• phpstan/phpstan: ^1.0
• phpstan/phpstan-symfony: ^1.0
• symplify/easy-coding-standard: ^9.0

GPL-3.0-or-later

• DACHCOM.DIGITAL Stefan Hagspiel

• search
• pimcore

README

Release Plan

Introduction

The Dynamic Search Bundle allows you to redefine your search strategy. It's based on several data- and index providers.

Providers

There are several data- and index providers available:

Data Provider

• WebCrawler | Fetch data by crawling urls
• Trinity Data | Fetch pimcore entities: object, asset, document

Index Provider

• Lucene Search | Use the php lucene index. Not superfast but comes without any dependencies but php
• Elasticsearch | Index data with an elasticsearch instance.
• Open Search | Index data with an open search instance.

Installation

"require" : {
    "dachcom-digital/dynamic-search" : "~4.0.0"
}

Add Bundle to bundles.php:

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

• Execute: $ bin/console pimcore:bundle:install DynamicSearchBundle
• Execute optionally: $ bin/console messenger:setup-transports

Upgrading

• Execute: $ bin/console doctrine:migrations:migrate --prefix 'DynamicSearchBundle\Migrations'

Provider Installation

You need at least one data- and one index provider. They have to be installed separately. Please check out install instruction of each provider (see list above).

Add Routes

# config/routes.yaml
dynamic_search_frontend:
    resource: '@DynamicSearchBundle/config/pimcore/routing/frontend_routing.yaml'

Start Queue Worker

$ bin/console messenger:consume dynamic_search_queue

Read more details about the queue worker and the recommended setup here.

Dispatch Dynamic Search

After you've added a definition, you're ready to start the engine. Always use the verbose -v flag, otherwise you won't get any process information about the ongoing data / index providing process.

$ bin/console dynamic-search:run -v

Further Information

• Example Setup
• Dispatch Workflow
• Configuration
  • Context Guard
  • Document Definition
  • Logging
• Data Creation
  • Resource Validation
  • Enable automatic Update / Insert / Delete Service
• Data Fetching
  • Output Channels
    • Create Output Channel
    • Channel Filter / Actions
    • Multi Search Channels
  • Filter (Faceted Search / Aggregation)
    • Create Filter Definition
• Backend UI
• API

Copyright and License

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

Upgrade Info

Before updating, please check our upgrade notes!