Smile-SA/elasticsuite

<?php
/**
 * DISCLAIMER
 *
 * Do not edit or add to this file if you wish to upgrade Smile ElasticSuite to newer
 * versions in the future.
 *
 * @category  Smile
 * @package   Smile\ElasticsuiteCatalog
 * @author    Romain Ruaud <romain.ruaud@smile.fr>
 * @copyright 2021 Smile
 * @license   Open Software License ("OSL") v. 3.0
 */

namespace Smile\ElasticsuiteCatalog\Plugin\Index;

use Smile\ElasticsuiteCore\Api\Index\MappingInterface;

/**
 * Mapping Plugin.
 * Used to add a copy_to for category names.
 *
 * @category Smile
 * @package  Smile\ElasticsuiteCatalog
 * @author   Romain Ruaud <romain.ruaud@smile.fr>
 */
class MappingPlugin
{
    /**
     * Collector field for products category names.
     */
    public const CATEGORY_NAME_FIELD = '_category_name';

    /**
     * Add a copy_to from "category.name" to "_category_name".
     * This is due to the fact that "category.name" being nested cannot be use directly in fulltext queries.
     *
     * @param MappingInterface $subject Index Mapping
     * @param array            $result  Mapping properties
     *
     * @return array
     *
     * @SuppressWarnings(PHPMD.UnusedFormalParameter)
     */
    public function afterGetProperties(MappingInterface $subject, array $result): array
    {
        if (isset($result['category']['properties']['name']['copy_to'])) {
            $result['category']['properties']['name']['copy_to'][] = self::CATEGORY_NAME_FIELD;
        }

        return $result;
    }
}