README

Install

You can install this package via composer:

composer require chr15k/php-spelling

Usage

• check
• suggestions
• autoSuggestion
• autoCorrection

check()

Determine whether the value is a valid word.

<?php

use \Chr15k\Spelling\Spelling;

$spelling = new Spelling('en'); // default is 'en'

echo $spelling->check('tree'); // true
echo $spelling->check('treezzz'); // false

suggestions()

Returns an array of spelling suggestions for invalid words.

<?php

use \Chr15k\Spelling\Spelling;

$spelling = new Spelling('en'); // default is 'en'

print_r($spelling->suggestions('specifecally'));
/*
    (
        [0] => specifically
        [1] => pacifically
        [2] => soporifically
        [3] => specifiable
        [4] => specifics
        [5] => specific
        [6] => specific's
    )
*/

autoSuggestion()

Returns a 'best guess' correct spelling for an invalid word.

<?php

use \Chr15k\Spelling\Spelling;

$spelling = new Spelling('en'); // default is 'en'

echo $spelling->autoSuggestion('specifecally'); // specifically
echo $spelling->autoSuggestion('specifecally?'); // specifically?
echo $spelling->autoSuggestion('weeird'); // weird
echo $spelling->autoSuggestion('weeird!'); // weird!

autoCorrection()

Returns 'best guess' correct spellings for an any invalid words in a string.

<?php

use \Chr15k\Spelling\Spelling;

$spelling = new Spelling('en'); // default is 'en'

echo $spelling->autoCorrection('He is in his ooffice.'); // He is in his office.
echo $spelling->autoCorrection('He sat underr a tree.'); // He sat under a tree.
echo $spelling->autoCorrection('Thereg is someone at the door.'); // There is someone at the door.

Testing

You can run the tests with:

vendor/bin/phpunit tests

License

The MIT License (MIT). Please see License File for more information.