hyungju/readable-url

Generate readable random phrases for URLs

Generate readable random phrases for URLs

---

How To Use

This library is available on packagist. To install,

composer require hyungju/readable-url

Then create ReadableURL Class

$readableURL = new HyungJu\ReadableURL();

You can pass four parameters to the class.

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.

To generate ReadableURL, call the generate() function.

use HyungJu\ReadableURL;

...

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

In addition, the following are simple to:

use HyungJu\ReadableURL;

...

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

This can be used to add to the end of a URL.

Example: https://example.com/photos/ForgetfulHarshEgg

For best results, use an integer value of 3, 4, or 5.

Test

composer test

Adding new language

1. Add wordsets to src/words/[language code]. adjectives.txt and nouns.txt are needed.

2. Create your language class src/Language/[language code].php. the class name must be started with Uppercase.

3. Implement the class based on other languages already implemented (korean and english)

4. Register your language in src/Language/LanguageHelper.php.

5. (optional) Add test for your language.

Versioning

We use SemVer for versioning this project.

License

MIT License

• This library is a PHP port of readable-url

Contributors ✨

Thanks goes to these wonderful people (emoji key):

도다 💻

Yukihyõ 💻

This project follows the all-contributors specification. Contributions of any kind welcome!

readable-url's Issues

한국어 단어 목록 업데이트

더 많은 한국어 단어가 필요합니다

`$wordCount` 를 위한 Exception 처리

https://www.php.net/manual/en/class.unexpectedvalueexception.php

\UnexpectedValueException 쓰면 좋을듯.

$wordCount를 위한 테스트 생성

Multi Language 지원

• 다중 언어 지원을 추가

Non-Latin language support

Currently non-latin language (e.g. Korean(ko) ) is also implementing isVowel()method that only affects latin based languages.

• refactor generate method like sharadbhat/ReadableURL#6
• then implement non-latin language option without vowel glue or other english specific options
• custom rules for languages

I wrote this issue in english because I've mentioned the other PR that is in english, so that they could understand what I am doing!