Yiisoft\Security\Random

Complexity

Total Complexity

2

Size/Duplication

Total Lines	22
Duplicated Lines	0 %

Test Coverage

Coverage

100%

Importance

Changes	1
Bugs	0	Features	0

1 Method

Rating	Name	Duplication	Size	Complexity
A	string()	0	10	2

<?php

declare(strict_types=1);

namespace Yiisoft\Security;

use Yiisoft\Strings\StringHelper;

/**
 * Random allows generating random values.
 *
 * Currently it has a single method "string".
 * The following extras are available via PHP directly:
 *
 * - `random_bytes()` for bytes. Note that output may not be ASCII.
 * - `random_int()` for integers.
 */
final class Random
{
    /**
     * Generates a random string of specified length.
     * The string generated matches [A-Za-z0-9_-]+ and is transparent to URL-encoding.
     *
     * @param int $length The length of the key in characters.
     *
     * @throws \Exception On failure.
     *
     * @return string The generated random key.
     */
    public static function string(int $length = 32): string
    {
        if ($length < 1) {
            throw new \InvalidArgumentException('First parameter ($length) must be greater than 0.');
        }

        // Optimization: we can generate a quarter fewer bits to completely cover the desired length in base64
        /** @psalm-suppress ArgumentTypeCoercion */
        $bytes = random_bytes((int) ceil($length * 0.75));
        return substr(StringHelper::base64UrlEncode($bytes), 0, $length);
    }
}