library strgen {🖫 10, ⚐ 11, ★ 6}

phlak/strgen

Generate secure random strings (e.g. passwords / salts)

Sunday, May 27, 2018
by PHLAK
Repository
3 Watchers
6 Stars
10 Installations

PHP
0 Dependents
0 Suggesters
3 Forks
0 Open issues
11 Versions
11 % Grown

The README.md

StrGen , _(*1)

, _(*2)

PHP library for simple secure random string generation (e.g. - passwords / salts)
Created by Chris Kankiewicz (@PHLAK) , _(*3)

Requirements

PHP >= 7.2

Install with Composer

composer require phlak/strgen

Usage

// Import StrGen
use PHLAK\StrGen;

// Initialize the Generator
$generator = new StrGen\Generator();

// Generate a random string of characters
$generator->length(16)->generate(); // Returns something like '8a*Ag@I0*s0v[S3u'

Character Sets

StrGen has a few built-in character sets available for ease of use. You can specify which set(s) to use by passing a character set or an array of sets to the charset() method., _(*4)

Example using built-in sets:, _(*5)

$generator = new StrGen\Generator();

$generator->charset(StrGen\CharSet::ALPHA_NUMERIC)->generate();

// or

$generator->charset([StrGen\CharSet::MIXED_ALPHA, StrGen\CharSet::NUMERIC])->generate();

Available presets:, _(*6)

Key	Character Set
`StrGen\CharSet::LOWER_ALPHA`	`abcdefghijklmnopqrstuvwxyz`
`StrGen\CharSet::UPPER_ALPHA`	`ABCDEFGHIJKLMNOPQRSTUVWXYZ`
`StrGen\CharSet::MIXED_ALPHA`	`abcdefghijklmnopqrstuvwxyz` `ABCDEFGHIJKLMNOPQRSTUVWXYZ`
`StrGen\CharSet::NUMERIC`	`0123456789`
`StrGen\CharSet::ALPHA_NUMERIC`	`abcdefghijklmnopqrstuvwxyz` `ABCDEFGHIJKLMNOPQRSTUVWXYZ` `0123456789`
`StrGen\CharSet::SPECIAL`	`!@#$%^&*()-_=+.?{}[]<>:;/\\\|~`
`StrGen\CharSet::ALL`	`abcdefghijklmnopqrstuvwxyz` `ABCDEFGHIJKLMNOPQRSTUVWXYZ` `0123456789` `!@#$%^&*()-_=+.?{}[]<>:;/\\\|~`

Custom sets:, _(*7)

You can also manually define a character set by passing a string of characters to the charset() method., _(*8)

$generator = new StrGen\Generator();

$generator->charset('0123456789abcdef')->generate();

Convenience Functions

StrGen also has built-in convenience functions for generating strings from the included character sets or a custom character set., _(*9)

$generator->lowerAlpha($length);
$generator->upperAlpha($length);
$generator->mixedAlpha($length);
$generator->numeric($length);
$generator->alphaNumeric($length);
$generator->special($length);
$generator->all($length);
$generator->custom($length, $charset);