https://github.com/pimcore/advanced-object-search
Advanced Object Search community bundle provides advanced object search in Pimcore backend powered by Elasticsearch v8.
https://github.com/pimcore/advanced-object-search
Last synced: about 1 year ago
JSON representation
Advanced Object Search community bundle provides advanced object search in Pimcore backend powered by Elasticsearch v8.
- Host: GitHub
- URL: https://github.com/pimcore/advanced-object-search
- Owner: pimcore
- License: other
- Created: 2017-08-14T12:03:36.000Z (almost 9 years ago)
- Default Branch: 6.x
- Last Pushed: 2024-04-12T07:37:13.000Z (about 2 years ago)
- Last Synced: 2024-04-12T14:30:48.729Z (about 2 years ago)
- Language: PHP
- Homepage:
- Size: 677 KB
- Stars: 39
- Watchers: 16
- Forks: 42
- Open Issues: 18
-
Metadata Files:
- Readme: README.md
- License: LICENSE.md
- Security: SECURITY.md
Awesome Lists containing this project
README
---
title: Advanced Object Search
---
# Pimcore Advanced Object Search via OpenSearch or Elasticsearch
Advanced Object Search bundle provides advanced object search in
Pimcore backend powered by search index technology (OpenSearch or Elasticsearch).
## Integration into Pimcore
### Installation and Configuration
Follow [Installation instructions](./doc/00_Installation.md).
#### Configure Search Client
Setup search client configuration in your Symfony configuration files (e.g. `config.yaml`).
See [OpenSearch Client Setup](./doc/04_Opensearch.md) or [Elasticsearch Client Setup](./doc/05_Elasticsearch.md) for more information.
#### Configure Advanced Object Search
Before starting, setup at least following configuration in symfony configuration tree:
```yml
advanced_object_search:
# Prefix for index names
index_name_prefix: 'advanced_object_search_'
```
For further configuration options follow the docs and the inline description of the configuration tree.
#### Initial Indexing
Call Pimcore command `advanced-object-search:update-mapping` for creating mappings and `advanced-object-search:re-index`
for indexing data for the first time.
### GUI
GUI for creating searches against search index with
- saving functionality
- sharing functionality
### Plugin Hooks
Following event listeners are called automatically
- `pimcore.dataobject.postUpdate` - data object is updated in search index, all child objects are added to update queue.
- `pimcore.dataobject.preDelete` - data object is deleted from search index.
- `pimcore.class.postUpdate` - search index mapping is updated or index recreated if necessary.
### Pimcore Console
Functions in Pimcore console.
- `advanced-object-search:process-update-queue` --> processes whole update queue of search index.
- `advanced-object-search:re-index` --> Reindex all data objects of given class. Does not delete index first or resets update queue.
- `advanced-object-search:update-mapping` --> Deletes and recreates mapping of given classes. Resets update queue for given class.
For details see documentation directly in Pimcore console.
### Pimcore Maintenance & Symfony Messenger
By default, with every Pimcore maintenance call, 500 entries of update queue are processed.
As an alternative, you also can activate symfony messenger to process the update queue. For that,
just activate it as follows.
```yml
advanced_object_search:
messenger_queue_processing:
activated: true
```
If activated, the processing is kicked off automatically with the `advancedobjectsearch_update_queue` maintenance task.
Messages are dispatched via `pimcore_index_queues` transport. So make sure, you have
workers processing this transport when activating the messenger based queue processing.
## API Methods
### Create Mapping for data object classes
Per data object class one index with one document type is created.
```php
get("AdvancedObjectSearchBundle\Service");
$service->updateMapping(ClassDefinition::getByName("Product"));
```
### Update index data
On data object save or via script:
```php
get("AdvancedObjectSearchBundle\Service");
$objects = Product::getList();
foreach($objects as $object) {
$service->doUpdateIndexData($object);
}
```
### Search/Filter for data
```php
get("AdvancedObjectSearchBundle\Service");
//filter for relations via ID
$results = $service->doFilter(3,
[
new FilterEntry(
"objects",
[
"type" => "object",
"id" => 75
],
BoolQuery::SHOULD
)
],
""
);
//filter for relations via sub query
$results = $service->doFilter(3,
[
[
"fieldname" => "objects",
"filterEntryData" => [
"type" => "object",
"className" => "Customer",
"filters" => [
[
"fieldname" => "firstname",
"filterEntryData" => "tom"
]
]
]
],
],
""
);
// full text search query without filters
$results = $service->doFilter(3,
[],
"sony"
);
// filter for several attributes - e.g. number field, input, localized fields
$results = $service->doFilter(3,
[
[
"fieldname" => "price",
"filterEntryData" => 50.77
],
[
"fieldname" => "price2",
"filterEntryData" => [
"gte" => 50.77,
"lte" => 50.77
]
],
[
"fieldname" => "keywords",
"filterEntryData" => "test2",
"operator" => BoolQuery::SHOULD
],
[
"fieldname" => "localizedfields",
"filterEntryData" => [
"en" => [
"fieldname" => "locname",
"filterEntryData" => "englname"
]
]
],
[
"fieldname" => "localizedfields",
"filterEntryData" => [
"de" => [
"fieldname" => "locname",
"filterEntryData" => "deutname"
]
]
],
new FilterEntry("keywords", "testx", BoolQuery::SHOULD)
],
""
);
```
## Not Supported Data Types
Currently following data types are not supported - but can be added if needed in future versions:
- ClassificationStore
- Slider
- Password
- Block
- Table
- StructuredTable
- Geographic data types
- Image data types
## Integrate new Data Type
- Implement Field Definition Adapter by implementing the `IFieldDefinitionAdapter` interface.
- Register new Field Definition Adapter as service
- Add mapping in configuration like
```yml
advanced_object_search:
field_definition_adapters:
newDataTypeName: SERVICE_ID_OF_FIELD_DEFINITION_ADAPTER
```
## Extend Filters in the Result Tab
If you want custom filters in the result tab directly without having to create a new advanced object search every time
read [here on how to extend the result tab with custom filters](./doc/01_Extending_Filters.md).