SynonymAnalyzer Class Reference

Inheritance diagram for SynonymAnalyzer:

Public Member Functions
	__construct (SynonymReader $synReader)
	getSynonymsForPhrase ($phrase)

Protected Attributes
	$synReaderModel

Detailed Description

SynonymAnalyzer responsible for search of synonyms matching a word or a phrase.

Definition at line 15 of file SynonymAnalyzer.php.

Constructor & Destructor Documentation

__construct()

__construct

(

SynonymReader

$synReader

)

Constructor

Parameters

SynonymReader

$synReader

Definition at line 27 of file SynonymAnalyzer.php.

    {
        $this->synReaderModel = $synReader;
    }

Member Function Documentation

getSynonymsForPhrase()

getSynonymsForPhrase

(

$phrase

)

Returns an array of arrays consisting of the synonyms found for each word in the input phrase

For phrase: "Elizabeth is the English queen" correct output is an array of arrays containing synonyms for each word in the phrase:

[ 0 => [ 0 => "elizabeth" ], 1 => [ 0 => "is" ], 2 => [ 0 => "the" ], 3 => [ 0 => "british", 1 => "english" ], 4 => [ 0 => "queen", 1 => "monarch" ] ]

Parameters

string

$phrase

Returns

array

Exceptions

Implements SynonymAnalyzerInterface.

Definition at line 49 of file SynonymAnalyzer.php.

    {
        $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;
    }

Field Documentation

$synReaderModel

SynonymReader $synReaderModel

protected

Definition at line 20 of file SynonymAnalyzer.php.

---

The documentation for this class was generated from the following file:

• vendor/magento/module-search/Model/SynonymAnalyzer.php