PHP-Spellchecker
Check misspellings from any text source with the most popular PHP spellchecker.
About
PHP-Spellchecker is a spellchecker abstraction library for PHP. By providing a unified interface for many different spellcheckers, you’re able to swap out spellcheckers without extensive rewrites.
Using PHP-Spellchecker can eliminate vendor lock-in, reduce technical debt, and improve the testability of your code.
Features
- 🧐 Supports many popular spellcheckers out of the box: Aspell, Hunspell, Ispell, PHP Pspell, LanguageTools, JamSpell and MultiSpellchecker [add yours!]
- 📄 Supports different text sources: file system file/directory, string, and multi-source [add yours!]
- 🛠 Supports text processors: MarkdownRemover [add yours!]
- 🔁 Supports misspelling handlers: EchoHandler [add yours!]
- ➰ Makes use of generators to reduce memory footprint
- ⚖ Flexible and straightforward design
- 💡 Makes it a breeze to implement your own spellcheckers, text processors and misspellings handlers
- 💪 Runs tests against real spellcheckers to ensure full compatibility
PHP-Spellchecker is a welcoming project for new contributors.
Want to make your first open source contribution? Check the roadmap, pick one task, open an issue and we'll help you go through it 🤓🚀
Install
Via Composer
$ composer require tigitz/php-spellchecker
Usage
Check out the documentation and examples
Using the spellchecker directly
You can check misspellings directly from a PhpSpellcheck\Spellchecker class and process them on your own.