"Did you mean ...?" exception sample

README.md

Did you mean ...?

This function takes two main arguments that are $search and $possibleMatches and looks for a the closest word to $search in the $possibleMatches list.

Usage

$search = 'fio';
$possibleMatches = ['foo', 'bar', 'baz'];

if (!in_array($search, $possibleMatches)) {
    throw didYouMean($search, array_keys($possibleMatches));
}

// Output: Unable to find a value matching with "fio". Did you mean "foo"?

didYouMean.php

<?php

/**
 * Throws a "Did you mean ...?" exception.
 *
 * @param string      $search
 * @param array       $possibleMatches
 *
 * @return \LogicException
 */
function didYouMean($search, array $possibleMatches)
{
    $minScore = INF;
    
    foreach ($possibleMatches as $key) {
        $distance = levenshtein($search, $key);
        if ($distance < $minScore) {
            $guess = $key;
            $minScore = $distance;
        }
    }
    
    $notFoundMessage = sprintf('Unable to find a value matching with "%s"', $search);
    if (isset($guess) && $minScore < 3) {
        return new \LogicException(
            sprintf("%s\n\nDid you mean \"%s\"?\n\n", $notFoundMessage, $guess)
        );
    }
    
    return new Exception(
        sprintf(
            "%s\n\nPossible values are:\n%s",
            $notFoundMessage,
            implode(PHP_EOL, array_map(function ($match) { return sprintf('- %s', $match); }, $possibleMatches))
        )
    );
}