Random::string() - Code Metrics - yiisoft/security - Measure and Improve Code Quality continuously with Scrutinizer

Random::string() A
last analyzed 2024-03-16 14:08 UTC

↳ Parent: Random

Complexity

Conditions	2
Paths	2

Size

Total Lines	10
Code Lines	4

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	5
CRAP Score	2

Importance

Changes	1
Bugs	0	Features	0

Metric	Value
cc	2
eloc	4
c	1
b	0
f	0
nc	2
nop	1
dl	0
loc	10
ccs	5
cts	5
cp	1
crap	2
rs	10

<?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);
    }
}


1		<?php
2
3		declare(strict_types=1);
4
5		namespace Yiisoft\Security;
6
7		use Yiisoft\Strings\StringHelper;
8
9		/**
10		* Random allows generating random values.
11		*
12		* Currently it has a single method "string".
13		* The following extras are available via PHP directly:
14		*
15		* - `random_bytes()` for bytes. Note that output may not be ASCII.
16		* - `random_int()` for integers.
17		*/
18		final class Random
19		{
20		/**
21		* Generates a random string of specified length.
22		* The string generated matches [A-Za-z0-9_-]+ and is transparent to URL-encoding.
23		*
24		* @param int $length The length of the key in characters.
25		*
26		* @throws \Exception On failure.
27		*
28		* @return string The generated random key.
29		*/
30	5	public static function string(int $length = 32): string
31		{
32	5	if ($length < 1) {
33	1	throw new \InvalidArgumentException('First parameter ($length) must be greater than 0.');
34		}
35
36		// Optimization: we can generate a quarter fewer bits to completely cover the desired length in base64
37		/** @psalm-suppress ArgumentTypeCoercion */
38	4	$bytes = random_bytes((int) ceil($length * 0.75));
39	4	return substr(StringHelper::base64UrlEncode($bytes), 0, $length);
40		}
41		}
42

yiisoft / security

Random::string() A last analyzed 2024-03-16 14:08 UTC

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like

Random::string() A
last analyzed 2024-03-16 14:08 UTC