ngiusti/random-string-generator

Generates a random string based on a given pattern

v1.0.0 2017-10-29 16:30 UTC

Requires

• php: ^7.0

Requires (Dev)

• phpunit/phpunit: ^6.2

MIT

• Nathalia Giusti
• Caio Ceccon

• generator
• pattern
• random
• string

README

Generates a random string based on a given string pattern

Installation

The package can be used by adding random-string-generator to your list of dependencies in composer.json as following:

composer require ngiusti/random-string-generator

Usage

Accepted string patterns:

Use l for lower case letter from a to z

Use L for upper case letter from A to Z

Use d for digit from 0 to 9

Use p for punctuation

Punctuation is any character on the following group:

!, ", #, $, %, &, ', (, ), *, +, ,, -, ., /, :, ;, <, =, >, ?, @, [, \, ], ^, _, {, |,}, ~ and `

Generate a string containing 2 lower case letters followed by 2 digits.

use RandomStringGenerator\RandomStringGenerator;

$generator = new RandomStringGenerator();
$generator->generate('lldd'); // "ol68"

Generate a string containing 2 upper case letters.

use RandomStringGenerator\RandomStringGenerator;

$generator = new RandomStringGenerator();
$generator->generate('LL'); // "VR"

Generate a string containing 2 punctuations.

use RandomStringGenerator\RandomStringGenerator;

$generator = new RandomStringGenerator();
$generator->generate('pp'); // "?!"

Delimiters

Apart from l,L,d and p, any other character is considered a delimiter. Therefore, the pattern -dl? is interpreted as : a hyphen followed by a random digit, followed by a random lower case letter, followed by a question mark.

Generate a string containing 2 letters followed by a hyphen.

use RandomStringGenerator\RandomStringGenerator;

$generator = new RandomStringGenerator();
$generator->generate('ll-'); // "yz-"

Scape

In order to generate a string containing the characters l,L,d and p as a delimiter you need to use the backslash twice in order to scape it.

Generate a string containing 2 digits followed by the letters lLdp.

use RandomStringGenerator\RandomStringGenerator;

$generator = new RandomStringGenerator();
$generator->generate('dd\\l\\L\\d\\p'); // "39lLdp"