README

A funny and hopefully non-annoying way to pick random names for unregistered users or anonymize identities. Available at stigwue/naija_pikin.

Basically, it combines an adjective pulled from adjectivesthatstart.com and a noun (a Nigerian name pulled from faker.ng).

I have not gone thorugh the adjectives to remove insultive ones!

Installation

Installation is via composer.

composer require stigwue/naija-pikin

Usage

There are more examples in the example.php file but below is a simple one.

$np = new NaijaPikin('path_to_to/naija_pikin/dictionary.json');

$name = $np->getName();

echo $name;

Functions

getNoun

getNoun takes two optional parameters: randomize, a boolean parameter (default value true) and noun, a string parameter (default value Igwue).

If randomize is true, a random noun is selected from the supplied dictionary. If false, the supplied noun parameter is returned.

getAdjective

getAdjective takes three optional parameters: randomize, a boolean parameter (default value true), letter, a character parameter (default value blank) and adjective, a string parameter (default value Irresistible).

If randomize is true, a random adjective with starting letter same as letter is selected from the supplied dictionary. If false, the supplied adjective parameter is returned.

getName

getName takes a single optional parameter: randomize, a boolean parameter (default value true).

It combines an adjective with a noun.

If randomize is true, a random name is generated. If false, the default, Irresistible Igwue is returned.

To Do

Remove insultive adjectives or put in a flag to exclude them.

stigwue / naija-pikin

Maintainers

Details