Basic Usage

To generate a username, you'll need to pass some text to the generate method of a Generator instance.

Generator Instance

Simple Example

$generator = new TaylorNetwork\UsernameGenerator\Generator();

$generator->generate('test user');

Returns

'testuser'

Per-instance Config

You can specify any config on the instance itself to override defaults.

See Config docs.

$generator = new TaylorNetwork\UsernameGenerator\Generator([
	'separator' => '_',
	'case'      => 'upper',
]);

$generator->generate('test user');

Returns

'TEST_USER'

UsernameGenerator Facade

Simple Example

UsernameGenerator::generate('test user');

Returns

'testuser'

Per-instance Config

You can specify any config on the instance itself to override defaults.

See Config docs.

UsernameGenerator::setConfig([
	'separator' => '_',
	'case'      => 'upper',
])->generate('test user');

Returns

'TEST_USER'

---

Next (More Examples)