README

生成可读的随机URL短语

如何使用

此库在packagist上可用。要安装，

composer require hyungju/readable-url

然后创建 ReadableURL 类

$readableURL = new HyungJu\ReadableURL();

您可以向类传递四个参数。

use HyungJu\ReadableURL;
// Takes 4 parameters.
// 1. A boolean value - If true, returns string in CamelCase, else lowercase.
// 2. An integer value - The number of words to be generated in the string. (Between 2 and 10).
// 3. A string - The seperator between the words.
// 4. Language Class - Currently Supported : HyungJu\Language\En, HyungJu\Language\Ko. pass language instance! the default is HyungJu\Language\En
$readableURL = new ReadableURL();
//$readableURL = new HyungJu\ReadableURL(false, 5, '-', new HyungJu\Language\Ko()); // Other options.

要生成 ReadableURL，请调用 generate() 函数。

use HyungJu\ReadableURL;

...

$readableURL = new ReadableURL();
$readableURL->generate();
// > QuickScrawnyCamp

此外，以下内容非常简单

use HyungJu\ReadableURL;

...

$str = ReadableURL::gen();
// > FierceSaltyComparison

这可以用于添加到URL的末尾。

示例： https://example.com/photos/ForgetfulHarshEgg

为了获得最佳结果，请使用3、4或5的整数值。

测试

composer test

添加新语言

将词汇集添加到 src/words/[language code]。需要 adjectives.txt 和 nouns.txt。
创建您的语言类 src/Language/[language code].php。类名必须以大写字母开头。
根据已实现的其他语言（韩语和英语）实现类
在 src/Language/LanguageHelper.php 中注册您的语言。
（可选）为您的语言添加测试。

版本控制

我们使用 SemVer 对此项目进行版本控制。

许可证

MIT 许可证

此库是 readable-url 的 PHP 版本

贡献者 ✨

感谢这些出色的人们 (emoji key)

此项目遵循 all-contributors 规范。欢迎任何类型的贡献！

hyungju / readable-url

维护者

详细信息

README

如何使用

测试

添加新语言

版本控制

许可证

贡献者 ✨