stigwue/naija-pikin

A funny and hopefully non-annoying way to pick random names for unregistered users or anonymize identities.

Naija Pikin

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

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

I have not gone thorugh the adjectives to remove insultive ones!, _(*3)

Installation

Installation is via composer., _(*4)

composer require stigwue/naija-pikin

Usage

There are more examples in the example.php file but below is a simple one., _(*5)

$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)., _(*6)

If randomize is true, a random noun is selected from the supplied dictionary. If false, the supplied noun parameter is returned., _(*7)

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)., _(*8)

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., _(*9)

getName

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

It combines an adjective with a noun., _(*11)

If randomize is true, a random name is generated. If false, the default, Irresistible Igwue is returned., _(*12)

To Do

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