HaikunatorPHP

Generate Heroku-like random names to use in your PHP applications.

Installation

composer require atrox/haikunator

Usage

Haikunator is pretty simple.

use Atrox\Haikunator;

// default usage
Haikunator::haikunate() // => "wispy-dust-1337"

// custom length (default=4)
Haikunator::haikunate(["tokenLength" => 6]) // => "patient-king-887265"

// use hex instead of numbers
Haikunator::haikunate(["tokenHex" => true]) // => "purple-breeze-98e1"

// use custom chars instead of numbers/hex
Haikunator::haikunate(["tokenChars" => "HAIKUNATE"]) // => "summer-atom-IHEA"

// don't include a token
Haikunator::haikunate(["tokenLength" => 0]) // => "cold-wildflower"

// use a different delimiter
Haikunator::haikunate(["delimiter" => "."]) // => "restless.sea.7976"

// no token, space delimiter
Haikunator::haikunate(["tokenLength" => 0, "delimiter" => " "]) // => "delicate haze"

// no token, empty delimiter
Haikunator::haikunate(["tokenLength" => 0, "delimiter" => ""]) // => "billowingleaf"

// custom nouns and/or adjectives
Haikunator::$ADJECTIVES = ["red", "green", "blue"];
Haikunator::$NOUNS = ["reindeer"];
Haikunator::haikunate(); // => "blue-reindeer-4252"

Options

The following options are available:

Haikunator::haikunate([
  "delimiter" => "-",
  "tokenLength" => 4,
  "tokenHex" => false,
  "tokenChars" => "0123456789"
]);

// get/set nouns or adjectives
Haikunator::$ADJECTIVES
Haikunator::$NOUNS

If tokenHex is true, it overrides any tokens specified in tokenChars

Command Line Interface

A small CLI application is also delivered in /bin/haikunator.

Use as follows:

$: ./bin/haikunator help generate
Haikunator, version dev-master

Usage:
 generate [--token-length=] [--token-chars=] [--token-hex|-x] [--delimiter=] [--nouns=] [--adjectives=]

Arguments:
 --token-length        An integer representing the length of the token; defaults to 4
 --token-chars         The characters to use for the token; defaults to numbers
 --token-hex|-x        Same as --token-chars=0123456789abcdef
 --delimiter           The delimiter for all the part of the result; defaults to '-'
 --nouns|--adjectives  A list of words separated by commas, or a text filename
                       containing words separated by commas, spaces or new lines

Help:

Generate Heroku-like random names

To execute it simply via the haikunator command in you system, you can install it globally via Composer with composer global require atrox/haikunator and then ensure your ~/.composer/vendor/bin is present in your env's $PATH.

Contributing

Everyone is encouraged to help improve this project. Here are a few ways you can help:

• Report bugs
• Fix bugs and submit pull requests
• Write, clarify, or fix documentation
• Suggest or add new features

Other Languages

Haikunator is also available in other languages. Check them out:

• Node: https://github.com/Atrox/haikunatorjs
• .NET: https://github.com/Atrox/haikunator.net
• Python: https://github.com/Atrox/haikunatorpy
• Java: https://github.com/Atrox/haikunatorjava
• Go: https://github.com/Atrox/haikunatorgo
• Dart: https://github.com/Atrox/haikunatordart
• Ruby: https://github.com/usmanbashir/haikunator
• Rust: https://github.com/nishanths/rust-haikunator