robbiep / afterthedeadline
Afterthedeadline API wrapper
Requires
- php: >=5.5.0
- guzzlehttp/guzzle: ~5.0
- illuminate/support: ^5.0
- rquadling/lalit: 1.*
Requires (Dev)
- mockery/mockery: dev-master@dev
README
This is a PHP wrapper for the After the Deadline API
After the Deadline is a language checker for the web with: Contextual Spell Checking, Advanced Style Checking and Intelligent Grammar Checking
Installation
Install this package through Composer.
Add this to your composer.json
dependencies:
"require": { "robbiep/afterthedeadline": "^0.0" }
Run composer install
to download the required files.
Usage
require_once('vendor/autoload.php'); $atd = new \RobbieP\Afterthedeadline\Afterthedeadline(['key' => md5('<unique string>')]); $atd->checkDocument("I started my schooling as the majority did in my area, at the local primarry school."); # `getResults` will return an array of objects (Spelling, Grammar, Suggestion) or `false` if there were no results $results = $atd->getResults(); # (Optionally) you can get formatted text back where the results have been wrapped with # <span class="atd-{type}" data-suggestions="{suggestions}">word</span> echo $atd->getFormatted();
Results in:
<div id="atd-content">I started my schooling as the <span class="atd-suggestion" data-info="" data-suggestions="['greatest','most']">majority</span> did in my area, at the local <span class="atd-spelling" data-suggestions="['primary','primacy','primarily','remarry']">primarry</span> school.</div>
(Experimental) I've written some basic JavaScript using jQuery and Bootstrap to provide a simple UI to correct/ignore the results
echo $m->getFormatted()->getStylesAndScript(); ?>
Support for other languages
At the moment After the Deadline supports English by default but German de
, French fr
, Spanish es
, Portugese pt
You can either set it in the constructor:
$atd = new \RobbieP\Afterthedeadline\Afterthedeadline(['key' => md5('<unique string>'), 'lang' => 'de']); # You must use 2 letter country code
Or you can set it inline:
$atd = new \RobbieP\Afterthedeadline\Afterthedeadline(['key' => md5('<unique string>')]); $atd->setLanguage(\RobbieP\Afterthedeadline\Language::GERMAN);
If you're using it in Laravel...
I've included a ServiceProvider class and a config if you need to change any options. You need to add the ServiceProvider to config/app.php
'providers' => array( ... RobbieP\Afterthedeadline\AfterthedeadlineServiceProvider::class )
If you want to use the Facade:
'aliases' => array( ... 'Afterthedeadline' => RobbieP\Afterthedeadline\Facades\Afterthedeadline::class, )
You will need to publish the config php artisan vendor:publish
put your self generated API key in there.
Usage (in Laravel)
$results = \Afterthedeadline::checkDocument("some content") ->getResults();
Contributing
- Fork it
- Create your feature branch:
git checkout -b my-new-feature
- Commit your changes:
git commit -am 'Add some feature'
- Push to the branch:
git push origin my-new-feature
- Submit a pull request