README

基于形容词（可选）+ 名称 + 数字（可选）生成随机昵称。

安装

您可以通过composer安装此包

composer require mrbrownnl/random-nickname-generator

基本用法

<?php

use MrBrownNL\RandomNicknameGenerator\RandomNicknameGenerator;

require 'vendor/autoload.php';

$nickNameGenerator = new RandomNicknameGenerator(['useAdjective' => false]);

echo $nickNameGenerator->generate();

// or generate a nickname that has been checked for uniqueness
echo $nickNameGenerator->generateUnique();

使用Laravel外观

如果您使用的是Laravel 5.5及以上版本，服务提供程序将自动注册。

对于Laravel的旧版本（<5.5），您需要添加服务提供程序

####config/app.php

'providers' => [
    ...
    MrBrownNL\RandomNicknameGenerator\RandomNicknameGeneratorServiceProvider::class,
]

要覆盖Laravel中的默认配置参数，可以将配置文件发布到config/nickname-generator.php并指定自己的参数。

php artisan vendor:publish --provider="MrBrownNL\RandomNicknameGenerator\RandomNicknameGeneratorServiceProvider"

使用外观

use MrBrownNL\RandomNicknameGenerator\Facades\NicknameGenerator;

$nickname = NicknameGenerator::generate();

// or generate a nickname that has been checked for uniqueness
$nickname = NicknameGenerator::generateUnique();

或测试它

php artisan generate-nickname

默认配置参数

当在类实例化时未指定或空字典时，将使用默认包字典。

[
    'useAdjective' => true,
    'separator' => '',
    'addNumericPostfix' => true,
    'postfix' => [
        'minimumValue' => 1,
        'maximumValue' => 999,
    ],
    'dictionaries' => [
        'adjectives' => [],
        'names' => [],
    ],
]

函数参考

性能

下表显示了生成唯一名称所需的时间。

在编译自定义形容词或名称字典时，请注意，如果只剩下1%或更少的独特昵称，性能将急剧下降。

下表显示了可能生成150,000个独特昵称时的性能。

变更日志

请参阅CHANGELOG以获取有关最近更改的更多信息。

许可证

MIT许可证（MIT）。请参阅许可证文件以获取更多信息。