README

错别字生成器工具

安装

使用以下命令安装最新版本：

$ composer require mlequer/typos-generator

>如果您正在寻找命令行生成器，请使用 mlequer/typos-generator-command 代替

用法

// if needed
// require "vendor/autoload.php"; 

use MLequer\Component\Typos\Generator\TypoGenerator;
use MLequer\Component\Typos\Provider\ChainTyposProvider;
use MLequer\Component\Typos\Provider\HomophoneTyposProvider;
use MLequer\Component\Typos\Provider\TyposProviderCollection;


$typos = new HomophoneTyposProvider();
// usage without chain:
$g =  new TypoGenerator($typos);
$res = $g->generateTypos("computer"); // return a Generator
$res = $g->generateTyposAsArray("something"); // return an array

// using multiple typos providers
$typos = new HomophoneTyposProvider();
$collection = new TyposProviderCollection();

$collection->addProvider($typos)
//          ->addProvider(new WrongKeyTyposProvider)
//          ->addProvider( ... )
// ...
;
// use the special chain provider
$chain = new ChainTyposProvider($collection);
$g =  new TypoGenerator($typos);
// return a Generator

$res = $g->generateTypos("computer");
foreach ($res as $t) {
    echo $t . "\n";
}

// return an array
$res = $g->generateTyposAsArray("something");
var_dump($res);

您可以通过扩展 TyposProviderInterface 来创建自己的提供者