Documentation

FindSimilarTerms

Use case for finding similar terms.

Tags
since
3.0.0

Table of Contents

Properties

$calculator  : SimilarityCalculator

Methods

__construct()  : mixed
Constructor.
execute()  : array<string|int, int>
Find similar terms for a given language and term.
formatTerm()  : string
Format a similar term for display.
getFormattedTerms()  : string
Get formatted HTML for similar terms.
getTableRow()  : string
Get HTML for similar terms table row.

Properties

Methods

execute()

Find similar terms for a given language and term.

public execute(int $languageId, string $comparedTerm, int $maxCount, float $minRanking[, float $phoneticWeight = 0.3 ]) : array<string|int, int>
Parameters
$languageId : int

Language ID

$comparedTerm : string

Term to compare with

$maxCount : int

Maximum number of terms to return

$minRanking : float

Minimum similarity ranking (0-1)

$phoneticWeight : float = 0.3

Weight for phonetic similarity (0-1)

Return values
array<string|int, int>

Word IDs sorted by weighted similarity, descending

formatTerm()

Format a similar term for display.

public formatTerm(int $termId, string $compare) : string
Parameters
$termId : int

Term ID

$compare : string

Similar term to compare with

Return values
string

HTML-formatted string

getFormattedTerms()

Get formatted HTML for similar terms.

public getFormattedTerms(int $languageId, string $comparedTerm) : string
Parameters
$languageId : int

Language ID

$comparedTerm : string

Term to compare with

Return values
string

HTML output

getTableRow()

Get HTML for similar terms table row.

public getTableRow() : string
Return values
string

HTML output or empty string


        
On this page

Search results