thejawker/super-random

Allows for easy unique code generation, is database aware for Laravel Applications.

v1.0.2 2018-02-19 12:48 UTC

Requires

• php: >=7.0.0
• illuminate/support: ~5.4.0|~5.5.0|~5.6.0

Requires (Dev)

• mockery/mockery: ^0.9.5
• orchestra/database: ~3.5.0
• orchestra/testbench: ~3.5.0
• phpunit/phpunit: ^6.0|^7.0

MIT

• Bram Veerman

• random
• unique
• code-generator
• thejawker
• database-aware-unique-code-generator
• token-generator

README

Nice and fluent way to create truly unique codes or tokens.

Installation

Require the package from Composer:

composer require thejawker/super-random

As of Laravel 5.5 it will magically register the package.

Usage

Just simple call the generate method on SuperRandom Facade or the handy shortcut helper function.

$code = SuperRandom::generate();
echo $code; // 

$code = superRandom();

Examples:

Database Aware

Often you don't want more than one of the same codes or tokens to be present in your database. Although it's easy to compare to the database it is annoying having to re-implement this all over the place. By specifying the table.column in the for method you can easily make it entry aware.

ConcertTicket::create([
    'band' => 'DYSSEBIA',
    'code' => SuperRandom::for(ConcertTicket::class)->generate()
]);

// Or more explicit:
ConcertTicket::create([
    'band' => 'DYSSEBIA',
    'code' => SuperRandom::for('concerts.code')->generate()
]);

Length

You can specify the length as follows:

ConcertTicket::create([
    'band' => 'DYSSEBIA',
    'code' => SuperRandom::length(12)->generate()
]);

Allowed Chars

You can specify the allowed chars as follows:

ConcertTicket::create([
    'band' => 'DYSSEBIA',
    'code' => SuperRandom::chars('abc123')->generate()
]);

By default we only include numbers and UPPERCASE characters with the exclusion of: 1, I, O, 0 since they look a lot alike and you don't want your users to guess.

Full Config

You can alternatively set the config right on the generate() method.

ConcertTicket::create([
    'band' => 'DYSSEBIA',
    'code' => SuperRandom::generate([
        'table' => 'concerts',
        'column' => 'code',
        'length' => 15,
        'chars' => 'abc123'
    ])
]);

Test

composer test

License

The MIT License (MIT). Please see License File for more information.