lib/internal/Magento/Framework/Math/Random.php - 2.4-develop - githubmirror/magento2

lib/internal/Magento/Framework/Math/Random.php

99 строк2 KB

Alexandra Zota

ACP2E-4019: CE copyright updates for 2.4.9-beta1

22 окт 2025, 17:47

22 окт 2025, 17:471b769b7

<?php
/**
 * Copyright 2014 Adobe
 * All Rights Reserved.
 */
namespace Magento\Framework\Math;

use \Exception;
use Magento\Framework\Exception\LocalizedException;
use Magento\Framework\Phrase;

/**
 * Random data generator
 *
 * @api
 * @since 100.0.2
 */
class Random
{
    /**#@+
     * Frequently used character classes
     */
    public const CHARS_LOWERS = 'abcdefghijklmnopqrstuvwxyz';

    public const CHARS_UPPERS = 'ABCDEFGHIJKLMNOPQRSTUVWXYZ';

    public const CHARS_DIGITS = '0123456789';

    /**#@-*/

    /**
     * Get random string.
     *
     * @param int $length
     * @param null|string $chars
     *
     * @return string
     * @throws LocalizedException
     */
    public function getRandomString($length, $chars = null)
    {
        $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;
    }

    /**
     * Return a random number in the specified range
     *
     * @param int $min
     * @param int $max
     * @return int  A random integer value between min (or 0) and max
     * @throws LocalizedException
     */
    public static function getRandomNumber($min = 0, $max = null)
    {
        if (null === $max) {
            $max = mt_getrandmax();
        }

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

        return random_int($min, $max);
    }

    /**
     * Generate a hash from unique ID.
     *
     * @param string $prefix
     * @return string
     * @throws LocalizedException
     */
    public function getUniqueHash($prefix = '')
    {
        return $prefix . $this->getRandomString(32);
    }

    /**
     * Generate a base64 encoded binary string.
     *
     * @param int $length
     * @return string
     * @throws Exception
     */
    public function getRandomBytes(int $length) : string
    {
        return base64_encode(random_bytes($length));
    }
}