SynonymAnalyzer.php

Go to the documentation of this file.

<?php
declare(strict_types=1);
namespace Magento\Search\Model;

use Magento\Search\Api\SynonymAnalyzerInterface;

class SynonymAnalyzer implements SynonymAnalyzerInterface
{
    protected $synReaderModel;

    public function __construct(SynonymReader $synReader)
    {
        $this->synReaderModel = $synReader;
    }

    public function getSynonymsForPhrase($phrase)
    {
        $result = [];

        if (empty(trim($phrase))) {
            return $result;
        }

        $synonymGroups = $this->getSynonymGroupsByPhrase($phrase);

        // Replace multiple spaces in a row with the only one space
        $phrase = preg_replace("/ {2,}/", " ", $phrase);

        // Go through every returned record looking for presence of the actual phrase. If there were no matching
        // records found in DB then create a new entry for it in the returned array
        $words = explode(' ', $phrase);

        foreach ($words as $offset => $word) {
            $synonyms = [$word];

            if ($synonymGroups) {
                $pattern = $this->getSearchPattern(\array_slice($words, $offset));
                $position = $this->findInArray($pattern, $synonymGroups);
                if ($position !== null) {
                    $synonyms = explode(',', $synonymGroups[$position]);
                }
            }

            $result[] = $synonyms;
        }

        return $result;
    }

    private function findInArray(string $pattern, array $synonymGroupsToExamine)
    {
        $position = 0;
        foreach ($synonymGroupsToExamine as $synonymGroup) {
            $matchingResultCode = preg_match($pattern, $synonymGroup);
            if ($matchingResultCode === 1) {
                return $position;
            }
            $position++;
        }

        return null;
    }

    private function getSearchPattern(array $words): string
    {
        $patterns = [];
        for ($lastItem = count($words); $lastItem > 0; $lastItem--) {
            $phrase = implode("\s+", \array_slice($words, 0, $lastItem));
            $patterns[] = '^' . $phrase . ',';
            $patterns[] = ',' . $phrase . ',';
            $patterns[] = ',' . $phrase . '$';
        }

        $pattern = '/' . implode('|', $patterns) . '/i';
        return $pattern;
    }

    private function getSynonymGroupsByPhrase(string $phrase): array
    {
        $result = [];

        $synonymGroups = $this->synReaderModel->loadByPhrase($phrase)->getData();
        foreach ($synonymGroups as $row) {
            $result[] = $row['synonyms'];
        }
        return $result;
    }
}