Firesphere / silverstripe-elastic

src/Tasks/ElasticConfigureSynonymsTask.php

<?php
/**
 * Class ElasticConfigureSynonymsTask|Firesphere\ElasticSearch\Tasks\ElasticConfigureSynonymsTask Index Elastic cores
 *
 * @package Firesphere\Elastic\Search
 * @author Simon `Firesphere` Erkelens; Marco `Sheepy` Hermo
 * @copyright Copyright (c) 2018 - now() Firesphere & Sheepy
 */

namespace Firesphere\ElasticSearch\Tasks;

use Elastic\Elasticsearch\Exception\ClientResponseException;
use Elastic\Elasticsearch\Exception\MissingParameterException;
use Elastic\Elasticsearch\Exception\ServerResponseException;
use Firesphere\ElasticSearch\Models\SynonymSet;
use Firesphere\ElasticSearch\Services\ElasticCoreService;
use Firesphere\SearchBackend\Helpers\Synonyms as BaseSynonyms;
use Firesphere\SearchBackend\Models\SearchSynonym;
use SilverStripe\Core\Injector\Injector;
use SilverStripe\Dev\BuildTask;

/**
 * Class ElasticConfigureSynonymsTask
 *
 * @description Index synonyms to Elastic through a tasks
 * @package Firesphere\Elastic\Search
 */
class ElasticConfigureSynonymsTask extends BuildTask
{
    /**
     * URLSegment of this task
     *
     * @var string
     */
    private static $segment = 'ElasticSynonymTask';

The private property $segment is not used, and could be removed.

    /**
     * My name
     *
     * @var string
     */
    protected $title = 'Add/update synonyms in Elasticsearch';
    /**
     * What do I do?
     *
     * @var string
     */
    protected $description = 'Add or update synonyms to Elastic.';

    /**
     * @throws ClientResponseException
     * @throws ServerResponseException
     * @throws MissingParameterException
     */
    public function run($request)
    {
        $service = Injector::inst()->get(ElasticCoreService::class);
        $client = $service->getClient();
        $baseSynonyms = BaseSynonyms::getSynonymsFlattened();
        $baseSynonyms = $this->transformBaseSynonyms($baseSynonyms);
        $configuredSynonyms = SearchSynonym::get()->map('getModifiedID', 'getCombinedSynonym')->toArray();
        $configuredSynonyms = $this->transformBaseSynonyms($configuredSynonyms, '');
        // Note, the Elastic synonym class is not suitable for a bulk import
        $client->synonyms()->putSynonym([
            'id'   => SynonymSet::get()->first()->Key,
            'body' => ["synonyms_set" => array_merge($baseSynonyms, $configuredSynonyms)]
        ]);
    }

    private function transformBaseSynonyms(array $synonyms, string $prefix = 'base')
    {
        $return = [];
        foreach ($synonyms as $key => $synonym) {
            if (strlen($prefix) > 0) {
                $key = sprintf("%s-%s", $prefix, $key);
            }
            $return[] = ["id" => $key, "synonyms" => $synonym];
        }

        return $return;
    }
}