MappingBuilder.php

<?php

/*
 * This file is part of the FOSElasticaBundle package.
 *
 * (c) FriendsOfSymfony <https://friendsofsymfony.github.com/>
 *
 * For the full copyright and license information, please view the LICENSE
 * file that was distributed with this source code.
 */

namespace FOS\ElasticaBundle\Index;

use FOS\ElasticaBundle\Configuration\IndexConfigInterface;
use FOS\ElasticaBundle\Configuration\IndexTemplateConfig;
use FOS\ElasticaBundle\Elastica\ElasticsearchVersionDetector;
use FOS\ElasticaBundle\Event\PostIndexMappingBuildEvent;
use Symfony\Contracts\EventDispatcher\EventDispatcherInterface;

/**
 * @phpstan-import-type TMapping from IndexConfigInterface
 * @phpstan-import-type TSettings from IndexConfigInterface
 */
class MappingBuilder
{
    public function __construct(private readonly EventDispatcherInterface $dispatcher)
    {
    }

    /**
     * Builds mappings for an entire index.
     *
     * @return array{mappings: TMapping, settings: TSettings}
     */
    public function buildIndexMapping(IndexConfigInterface $indexConfig): array
    {
        $mappingIndex = [];
        $mapping = $this->buildMapping($indexConfig->getModel(), $indexConfig);
        $this->dispatcher->dispatch($event = new PostIndexMappingBuildEvent($indexConfig, $mapping));

        $mapping = $event->getMapping();
        $settings = $indexConfig->getSettings();

        if ([] !== $mapping) {
            $mappingIndex['mappings'] = $mapping;
        }

        if ([] !== $settings) {
            $mappingIndex['settings'] = $settings;
        }

        return $mappingIndex;
    }

    /**
     * Builds mappings for an entire index template.
     *
     * @return array{index_patterns: list<non-empty-string>, mappings?: TMapping, settings?: TSettings, template?: array{mappings?: TMapping, settings?: TSettings}, priority: int}
     */
    public function buildIndexTemplateMapping(IndexTemplateConfig $indexTemplateConfig): array
    {
        $mapping = $this->buildIndexMapping($indexTemplateConfig);

        if (ElasticsearchVersionDetector::usesNewIndexTemplateApi()) {
            $template = [];
            if (isset($mapping['mappings'])) {
                $template['mappings'] = $mapping['mappings'];
                unset($mapping['mappings']);
            }
            if (isset($mapping['settings'])) {
                $template['settings'] = $mapping['settings'];
                unset($mapping['settings']);
            }
            if ($template) {
                $mapping['template'] = $template;
            }

            $mapping['priority'] = $indexTemplateConfig->getPriority();
        }

        $mapping['index_patterns'] = $indexTemplateConfig->getIndexPatterns();

        return $mapping;
    }

    /**
     * Builds mappings for a single type.
     *
     * @phpstan-return TMapping
     */
    public function buildMapping(?string $model, IndexConfigInterface $indexConfig): array
    {
        $mapping = $indexConfig->getMapping();

        if (null !== $indexConfig->getDynamicDateFormats()) {
            $mapping['dynamic_date_formats'] = $indexConfig->getDynamicDateFormats();
        }

        if (null !== $indexConfig->getDateDetection()) {
            $mapping['date_detection'] = $indexConfig->getDateDetection();
        }

        if (null !== $indexConfig->getNumericDetection()) {
            $mapping['numeric_detection'] = $indexConfig->getNumericDetection();
        }

        if ($indexConfig->getAnalyzer()) {
            $mapping['analyzer'] = $indexConfig->getAnalyzer();
        }

        if (null !== $indexConfig->getDynamic()) {
            $mapping['dynamic'] = $indexConfig->getDynamic();
        }

        if (isset($mapping['dynamic_templates']) && !$mapping['dynamic_templates']) {
            unset($mapping['dynamic_templates']);
        }

        $this->fixProperties($mapping['properties']);
        if (!$mapping['properties']) {
            unset($mapping['properties']);
        }

        if ($model) {
            $mapping['_meta']['model'] = $model;
        }

        return $mapping;
    }

    /**
     * Fixes any properties and applies basic defaults for any field that does not have
     * required options.
     *
     * @param array<string, mixed> $properties
     */
    private function fixProperties(array &$properties): void
    {
        foreach ($properties as &$property) {
            unset($property['property_path']);
            $property['type'] ??= 'text';

            if (isset($property['fields'])) {
                $this->fixProperties($property['fields']);
            }
            if (isset($property['properties'])) {
                $this->fixProperties($property['properties']);
            }
        }
    }
}