codeat3 / icndb
0.1.4
2021-03-12 13:34 UTC
Requires
- php: ^7.1|^7.3|^8.0
Requires (Dev)
- phpunit/phpunit: ^9.3.3
README
This PHP package is a fork of jcldavid/ICNDb by Cyrus David.
Installation
You can install the package via composer:
composer require codeat3/icndb
Usage
$config = array( 'firstName' => 'Cyrus', 'lastName' => 'David' ); // Pass an optional parameter to change the firstName and lastName // Default is Chuck Norris $chuck = new Swapnilsarwe\ICNDbClient($config); // Get the total Chuck Norris jokes stored in ICNDb $total = $chuck->count()->get(); // Get all categories $categories = $chuck->categories()->get(); // Get a specific joke by it's ID $specific = $chuck->specific(18)->get(); //Get a random joke $random = $chuck->random()->get(); // Get multiple random jokes $random2 = $chuck->random(3)->get(); // use exclude() to get jokes not belong to that category $exclude = $chuck->random()->exclude('nerdy')->get(); // you can also supply an array $exclude2 = $chuck->random()->exclude(array('nerdy', 'explicit'))->get(); // or chain them $exclude3 = $chuck->random(2)->exclude('explicit')->exclude('nerdy')->get(); // use limitTo() to get jokes only from that category // you may supply an array or chain them like exclude() $limit = $chuck->random()->limitTo('nerdy')->get();
Exceptions
APIUnavailableException - API is either unreachable/unavailable
ChainNotAllowedException - When these methods are chained together random()
, specific($id)
, categories()
, count()
Testing
composer test
Changelog
Please see CHANGELOG for more information what has changed recently.
Contributing
Please see CONTRIBUTING for details.
Security
If you discover any security related issues, please email swapnilsarwe@gmail.com instead of using the issue tracker.
Credits
License
The MIT License (MIT). Please see License File for more information.
PHP Package Boilerplate
This package was generated using the PHP Package Boilerplate.