ilRandom Class Reference

Wrapper for generation of random numbers, strings, bytes. More...

Collaboration diagram for ilRandom:

Public Member Functions
	__construct ()
	ilRandom constructor. More...
	int ($min=null, $max=null)

Private Member Functions
	logIfPossible (callable $c)
	supportsRandomInt ()

Private Attributes
	$logger = null

Detailed Description

Wrapper for generation of random numbers, strings, bytes.

Definition at line 7 of file class.ilRandom.php.

Constructor & Destructor Documentation

__construct()

ilRandom::__construct

(

)

ilRandom constructor.

Definition at line 17 of file class.ilRandom.php.

    {
    }

Member Function Documentation

int()

ilRandom::int	(		$min = null,
			$max = null
	)

Parameters

int	$min
int	$max

Returns

int

Exceptions

Throwable

Definition at line 39 of file class.ilRandom.php.

References $logger, ilLogLevel\ERROR, ilLogger\error(), logIfPossible(), ilLogger\logStack(), and supportsRandomInt().

    {
        if(is_null($min)) {
            $min = 0;
        }
        if(is_null($max)) {
            $max = mt_getrandmax();
        }

        if($this->supportsRandomInt()) {
            try {
                return random_int($min, $max);
            } catch (Exception $e) {
                $this->logIfPossible(static function (ilLogger $logger) {
                    $logger->logStack(\ilLogLevel::ERROR);
                    $logger->error('No suitable random number generator found.');
                });
                throw $e;
            } catch (Throwable $e) {
                $this->logIfPossible(static function (ilLogger $logger) {
                    $logger->logStack(\ilLogLevel::ERROR);
                    $logger->error('max should be greater than min.');
                });
                throw $e;
            }
        }
        // version 5.6 => use mt_rand
        return mt_rand($min, $max);
    }

Here is the call graph for this function:

logIfPossible()

ilRandom::logIfPossible ( callable  $c )

private

Parameters

callable

$c

Definition at line 24 of file class.ilRandom.php.

References $DIC.

Referenced by int().

    {
        global $DIC;

        if (isset($DIC['ilLoggerFactory'])) {
            $c($DIC->logger()->rnd());
        }
    }

Here is the caller graph for this function:

supportsRandomInt()

ilRandom::supportsRandomInt ( )

private

Returns

bool

Definition at line 72 of file class.ilRandom.php.

Referenced by int().

    {
        if(version_compare(PHP_VERSION , '7.0.0', '>=')) {
            return true;
        }
        return false;
    }

Here is the caller graph for this function:

Field Documentation

$logger

ilRandom::$logger = null

private

Definition at line 12 of file class.ilRandom.php.

Referenced by int().

---

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

• Services/Randomization/classes/class.ilRandom.php