inani / oxfordapi-wrapper
A PHP/Laravel Wrapper for oxford dictionary API
Installs: 1 674
Dependents: 0
Suggesters: 0
Security: 0
Stars: 27
Watchers: 5
Forks: 6
Open Issues: 1
Requires
- guzzlehttp/guzzle: ^6.2
This package is auto-updated.
Last update: 2024-10-07 21:12:25 UTC
README
A PHP/Laravel Wrapper for oxford dictionary API
Installation
First, install the package through Composer.
composer require inani/oxfordapi-wrapper
Then include the service provider inside config/app.php.
'providers' => [ ... Inani\OxfordApiWrapper\OxfordWrapperServiceProvider::class, ... ];
At least set up in the env file
OXFORD_API_BASE_URI = OXFORD_APP_ID = OXFORD_APP_KEY =
make a new instance
// Make it or pass it as argument $oxford = app(Inani\OxfordApiWrapper\OxfordWrapper::class);
How to use
Translation
// look for the translation from a language to an other, returns a parser $parser =$oxford->lookFor('balablabla') ->from('en') ->to('es') ->translate(); // get array of translations $translations = $parser->get(); // get array of [example => [translations]] $examples = $parser->getExamples();
Definitions
// look for the definitions of a word, returns a parser $parser =$oxford->lookFor('balablabla') ->define(); // get array of definitions $definitions = $parser->get();
Examples
// look for the examples of a word, returns a parser $parser =$oxford->lookFor('balablabla') ->examples(); // get array of examples $definitions = $parser->get();
Thesaurus
// You can try all combinations $res = $oxford->lookFor('happy') ->synonym() ->antonym() ->fetch(); // results will be related to (syno or anto) // get synonyms and/or antonyms $res->get(); // get only antonyms or null if not specfied in fetch $res->antonyms(); //get only synonyms or null if not specfied in fetch $res->synonyms();
Phonetics
$res = $oxford->lookFor('ace') ->talk(); // get the array of result $res->get(); // get the link to the audio file of pronunciation $res->speak(); //get the spelling $res->spell(); //get the notation $res->notation();