README

使用灵活的配置选项生成用户名。目前名词是动物名称。

安装

您可以通过composer安装此包

composer require grantholle/laravel-username-generator

您可以选择使用以下命令发布配置文件

php artisan vendor:publish --tag="laravel-username-generator-config"

默认情况下，它将生成一个包含1个形容词、1个名词且无数字前缀的大写用户名。您可以通过修改配置文件来更改您喜欢的数字

return [
    'adjectives' => 2,
    'nouns' => 1,
    'digits' => 2,
    // The casing leverages Laravel's string helper functions:
    // "lower", "upper", "studly", "kebab", "camel", "snake", "slug"
    'casing' => 'slug',
];

使用方法

您可以使用配置设置来生成基于这些选项的用户名。以上述配置为例，这将生成一个类似于 adjective-adjective-noun-## 的用户名

use GrantHolle\UsernameGenerator\Username;

$username = Username::make();
// grave-tame-tiger-60

或者，如果您想即时配置用户名，您可以使用流畅的API来构建您的用户名

use GrantHolle\UsernameGenerator\Username;

$username = (new Username)
    ->withAdjectiveCount(2)
    ->withNounCount(2)
    ->withDigitCount(4)
    ->withCasing('snake')
    ->generate();
// gentle_wan_chimpanzee_sandpiper8828

命令

这还附带了一个 make:username 命令，可以从命令行生成用户名

# This will use what's in your configuration file
php artisan make:username
# personal-unrealistic-eland-30

您可以传递多个选项来更改用户名的生成方式

php artisan make:username --count 2 --digits 8 --casing studly
# OrdinaryHerring02683641
# WittyGoat89531555

Options:
  -c, --casing[=CASING]          The casing to use: "lower", "upper", "studly", "kebab", "camel", "snake", or "slug".
  -d, --digits[=DIGITS]          The number of digits to use for a prefix.
  -a, --adjectives[=ADJECTIVES]  The number of adjectives to use.
  -N, --nouns[=NOUNS]            The number of nouns to use.
  -C, --count[=COUNT]            The number of usernames to generate. [default: "1"]

测试

composer test
composer analyse

变更日志

请参阅 CHANGELOG 了解最近更改的详细信息。

贡献

想添加名词或形容词吗？请参阅 CONTRIBUTING 了解详情。

许可证

MIT许可证（MIT）。请参阅 许可证文件 了解更多信息。