Random Class Reference

Public Member Functions
	getRandomString ($length, $chars=null)
	getUniqueHash ($prefix='')

Static Public Member Functions
static	getRandomNumber ($min=0, $max=null)

Data Fields
const	CHARS_LOWERS = 'abcdefghijklmnopqrstuvwxyz'
const	CHARS_UPPERS = 'ABCDEFGHIJKLMNOPQRSTUVWXYZ'
const	CHARS_DIGITS = '0123456789'

Detailed Description

Random data generator

@api

Since

100.0.2

Definition at line 17 of file Random.php.

Member Function Documentation

getRandomNumber()

static getRandomNumber (   $min = 0,   $max = null  )

static

Return a random number in the specified range

Parameters

int	$min
int	$max

Returns

int A random integer value between min (or 0) and max

Exceptions

LocalizedException

Definition at line 62 of file Random.php.

    {
        if (null === $max) {
            $max = mt_getrandmax();
        }

        if ($max < $min) {
            throw new LocalizedException(new Phrase('Invalid range given.'));
        }

        return random_int($min, $max);
    }

getRandomString()

getRandomString	(		$length,
			$chars = null
	)

#- Get random string.

Parameters

int	$length
null | string	$chars

Returns

string

Exceptions

LocalizedException

Definition at line 39 of file Random.php.

    {
        $str = '';
        if (null === $chars) {
            $chars = self::CHARS_LOWERS.self::CHARS_UPPERS.self::CHARS_DIGITS;
        }

        $charsMaxKey = mb_strlen($chars) - 1;
        for ($i = 0; $i < $length; $i++) {
            $str .= $chars[self::getRandomNumber(0, $charsMaxKey)];
        }

        return $str;
    }

getUniqueHash()

getUniqueHash

(

$prefix = ''

)

Generate a hash from unique ID.

Parameters

string

$prefix

Returns

string

Exceptions

LocalizedException

Definition at line 82 of file Random.php.

    {
        return $prefix . $this->getRandomString(32);
    }

Field Documentation

CHARS_DIGITS

const CHARS_DIGITS = '0123456789'

Definition at line 26 of file Random.php.

CHARS_LOWERS

const CHARS_LOWERS = 'abcdefghijklmnopqrstuvwxyz'

#+ Frequently used character classes

Definition at line 22 of file Random.php.

CHARS_UPPERS

const CHARS_UPPERS = 'ABCDEFGHIJKLMNOPQRSTUVWXYZ'

Definition at line 24 of file Random.php.

---

The documentation for this class was generated from the following file:

• vendor/magento/framework/Math/Random.php