swapnilsarwe/icndb

This package is abandoned and no longer maintained. The author suggests using the codeat3/icndb package instead.

A fork of PHP Wrapper for The Chuck Norris Db API, created by cyrus david.

v1.0.5 2018-11-01 13:03 UTC

Requires

• php: >=5.3.0

MIT

• Cyrus David
• Swapnil Sarwe

• chuck-norris
• jokes
• icndb

README

A PHP Wrapper for for the Internet Chuck Norris Database (ICNDb).

Install

To ease the process, I recommend you use composer.

{
	"require": {
		"swapnilsarwe/icndb": "1.0.x"
	}
}

Usage

<?php
$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()

Tests

To run the unit test suite:

cd tests
curl -s https://getcomposer.org/installer | php
php composer.phar install
./vendor/bin/phpunit