https://github.com/derekisbusy/yii2-haikunator
Generate Heroku-like random names to use in your Yii2 php applications.
https://github.com/derekisbusy/yii2-haikunator
Last synced: 2 months ago
JSON representation
Generate Heroku-like random names to use in your Yii2 php applications.
- Host: GitHub
- URL: https://github.com/derekisbusy/yii2-haikunator
- Owner: derekisbusy
- License: gpl-3.0
- Created: 2015-10-31T22:15:58.000Z (over 9 years ago)
- Default Branch: master
- Last Pushed: 2016-06-26T22:23:37.000Z (almost 9 years ago)
- Last Synced: 2025-01-20T09:46:21.126Z (4 months ago)
- Language: PHP
- Homepage: https://packagist.org/packages/derekisbusy/yii2-haikunator
- Size: 26.4 KB
- Stars: 0
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# yii2-haikunator
[](https://travis-ci.org/Atrox/haikunatorphp)
[](https://packagist.org/packages/atrox/haikunator)
[](https://coveralls.io/r/Atrox/haikunatorphp)
[](https://packagist.org/packages/derekisbusy/yii2-haikunator)
Generate Heroku-like random names to use in your PHP applications.
*This package has been forked from the original [HaikunatorPHP](https://github.com/Atrox/haikunatorphp) repository and
modified to work with the Yii2 autoloader.*
## Installation
```
composer require derekisbusy/yii2-haikunator
```
## Usage
Haikunator is pretty simple.
```php
use derekisbusy\haikunator\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:
```php
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```*
## Contributing
Everyone is encouraged to help improve this project. Here are a few ways you can help:
- [Report bugs](https://github.com/atrox/haikunatorphp/issues)
- Fix bugs and [submit pull requests](https://github.com/atrox/haikunatorphp/pulls)
- 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
- Dart: https://github.com/Atrox/haikunatordart
- Ruby: https://github.com/usmanbashir/haikunator
- Go: https://github.com/yelinaung/go-haikunator