blob: 70d76cf81e6a2c51b1add34b152a70c0f46ffdf2 (
plain) (
blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
|
# Random Name Generator
A PHP library to create interesting, sometimes entertaining, random names.
[](https://travis-ci.org/nubs/random-name-generator)
[](https://scrutinizer-ci.com/g/nubs/random-name-generator/)
[](https://coveralls.io/github/nubs/random-name-generator?branch=master)
[](https://packagist.org/packages/nubs/random-name-generator)
[](https://packagist.org/packages/nubs/random-name-generator)
[](https://packagist.org/packages/nubs/random-name-generator)
[](https://www.versioneye.com/user/projects/537d561814c15855aa000019)
## Requirements
This library requires PHP 5.6, or newer.
## Installation
This package uses [composer](https://getcomposer.org) so you can just add
`nubs/random-name-generator` as a dependency to your `composer.json` file or
execute the following command:
```bash
composer require nubs/random-name-generator
```
## Generators
### All
The "all" generator will utilize all other configured generators to generate
random names. It will select from the list of generators randomly and then
use them to generate a random name using their functionality.
#### Usage
```php
$generator = \Nubs\RandomNameGenerator\All::create();
echo $generator->getName();
```
Alternatively, if you want to configure/build the generators to use instead of
using all of the available generators, you can construct them yourself:
```php
$generator = new \Nubs\RandomNameGenerator\All(
[
new \Nubs\RandomNameGenerator\Alliteration(),
new \Nubs\RandomNameGenerator\Vgng()
]
);
```
### Video Game Names
The video game name generator is based off of [prior](http://videogamena.me/)
[art](https://github.com/nullpuppy/vgng). It will generate unique names based
off of "typical" video games.
#### Examples
* *Kamikaze Bubblegum Warrior*
* *Rockin' Valkyrie Gaiden*
* *Neurotic Jackhammer Detective*
* *My Little Mountain Climber Conflict*
* *Small-Time Princess vs. The Space Mutants*
You can also use [this web example](http://sam.sbat.com/) to see more example
video game names generated by this library.
#### Usage
```php
$generator = new \Nubs\RandomNameGenerator\Vgng();
echo $generator->getName();
```
## Alliterative Names
The alliteration name generator is based off of a list of
[adjectives](http://grammar.yourdictionary.com/parts-of-speech/adjectives/list-of-adjective-words.html)
and a list of [animals](https://animalcorner.co.uk/animals/).
#### Examples
* *Agreeable Anaconda*
* *Disturbed Duck*
* *Misty Meerkat*
* *Prickly Pig*
#### Usage
```php
$generator = new \Nubs\RandomNameGenerator\Alliteration();
echo $generator->getName();
```
## License
random-name-generator is licensed under the MIT license. See
[LICENSE](LICENSE) for the full license text.
|
