dachcom-digital/dynamic-search-data-provider-trinity

v3.0.1 2024-04-03 17:56 UTC

Requires

• dachcom-digital/dynamic-search: ^3.0 || ^4.0
• pimcore/pimcore: ^11.0

Requires (Dev)

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

GPL-3.0-or-later

• DACHCOM.DIGITAL Stefan Hagspiel

• assets
• search
• documents
• objects
• pimcore
• trinity
• dynamic-search
• data-provider

README

A data fetch extension for Pimcore Dynamic Search. Fetch pimcore elements by listings: assets, documents and objects.

Release Plan

Installation

"require" : {
    "dachcom-digital/dynamic-search" : "~3.0.0",
    "dachcom-digital/dynamic-search-data-provider-trinity" : "~3.0.0"
}

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 [
    \DsTrinityDataBundle\DsTrinityDataBundle::class => ['all' => true],
];

Publishing State

This Bundle will fetch unpublished elements by default. This is crucial and also a problematic fact. Read more about it here to learn how to handle the publishing state of pimcore elements.

Basic Setup

dynamic_search:
    context:
        default:
            data_provider:
                service: 'trinity_data'
                options:
                    always:
                        index_object: true
                        object_class_names:
                            - TestClass
                        index_document: true
                        index_asset: false
                    full_dispatch:
                        object_limit: 20
                        document_limit: 10
                normalizer:
                    service: 'trinity_localized_resource_normalizer'

Provider Options

always

full_dispatch

Resource Normalizer

trinity_default_resource_normalizer

Scaffold simple documents Options: none

trinity_localized_resource_normalizer

Scaffold localized documents

Options:

Transformer

Scaffolder

TrinityDataScaffolder

Identifier: trinity_data_scaffolder
Simple object scaffolder.
Supported types: Asset, Document, DataObject\Concrete.

Field Transformer

ElementIdExtractor

Identifier: element_id_extractor
Returns id of element

Return Type: string|int|null
Options: none

ElementPropertyExtractor

Identifier: element_property_extractor
Returns element property.

Return Type: string|null
Options:

NormalizerValueCallback

Identifier: normalizer_value_callback
Returns given option value.

Return Type: string|null
Options:

ObjectGetterExtractor

Identifier: object_getter_extractor
Returns value of object getter.

Return Type: bool|int|float|string|array|null
Options:

ObjectRelationsGetterExtractor

Identifier: object_relations_getter_extractor
Returns values of object relations getter.

Return Type: array|null
Options:

ObjectPathGenerator

Identifier: object_path_generator
Returns object path generated by link generator.

Return Type: string|null
Options:

DocumentMetaExtractor

Identifier: document_meta_extractor
Returns documents meta title or description.

Return Type: string|null
Options:

DocumentPathGenerator

Identifier: document_path_generator
Returns real full path of document

Return Type: string|null
Options: none

PdfDataExtractor

Identifier: asset_pdf_extractor
Extracts pdf content with ghostscript

Return Type: string|null
Options: none

AssetPathGenerator

Identifier: asset_path_generator
Returns real full path of document

Return Type: string|null
Options: none

Copyright and License

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

Upgrade Info

Before updating, please check our upgrade notes!