Inheritance diagram for ilArrayElementShuffler:

Collaboration diagram for ilArrayElementShuffler:

Public Member Functions
	__construct ()

	getSeed ()

	setSeed ($seed)

	buildRandomSeed ()

	buildSeedFromString ($string)

	shuffle ($array)

Protected Attributes
	$seed

Private Member Functions
	initSeed ($seed)

	shuffleArray ($array)

	mtShuffle ($orderedArray)

	isMtRandomizerAvailable ()

Detailed Description

Definition at line 11 of file class.ilArrayElementShuffler.php.

Constructor & Destructor Documentation

◆ __construct()

ilArrayElementShuffler::__construct ( )

Definition at line 20 of file class.ilArrayElementShuffler.php.

    {
        $this->setSeed($this->buildRandomSeed());
    }

References buildRandomSeed(), and setSeed().

Here is the call graph for this function:

Member Function Documentation

◆ buildRandomSeed()

ilArrayElementShuffler::buildRandomSeed ( )

Returns: integer

Definition at line 44 of file class.ilArrayElementShuffler.php.

    {
        list($usec, $sec) = explode(' ', microtime());
        return (int) ($sec + ($usec * 100000));
    }

Referenced by __construct(), and shuffle().

Here is the caller graph for this function:

◆ buildSeedFromString()

ilArrayElementShuffler::buildSeedFromString ( $string )

Parameters

string $string

Returns: integer

Definition at line 54 of file class.ilArrayElementShuffler.php.

    {
        return hexdec(substr(md5($string), 0, 10));
    }

◆ getSeed()

ilArrayElementShuffler::getSeed ( )

Returns: integer

Definition at line 28 of file class.ilArrayElementShuffler.php.

    {
        return $this->seed;
    }

References $seed.

Referenced by shuffle().

Here is the caller graph for this function:

◆ initSeed()

ilArrayElementShuffler::initSeed ( $seed )

private

Parameters

integer $seed

Definition at line 74 of file class.ilArrayElementShuffler.php.

    {
        $seed = (int) $seed; // (mt_)srand seems to not cast to integer itself (string seeds avoid randomizing) !!
 
        if ($this->isMtRandomizerAvailable()) {
            mt_srand($seed);
        } else {
            srand($seed);
        }
    }

References $seed, and isMtRandomizerAvailable().

Referenced by shuffle().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ isMtRandomizerAvailable()

ilArrayElementShuffler::isMtRandomizerAvailable ( )

private

Returns: bool

Definition at line 119 of file class.ilArrayElementShuffler.php.

    {
        return function_exists('mt_srand') && function_exists('mt_rand');
    }

Referenced by initSeed(), and shuffleArray().

Here is the caller graph for this function:

◆ mtShuffle()

ilArrayElementShuffler::mtShuffle ( $orderedArray )

private

Parameters

array $orderedArray

Returns: array

Definition at line 103 of file class.ilArrayElementShuffler.php.

    {
        $shuffledArray = array();
        
        while (count($orderedArray) > 0) {
            $key = mt_rand(0, (count($orderedArray) - 1));
            $splice = array_splice($orderedArray, $key, 1);
            $shuffledArray[] = current($splice);
        }
        
        return $shuffledArray;
    }

Referenced by shuffleArray().

Here is the caller graph for this function:

◆ setSeed()

ilArrayElementShuffler::setSeed ( $seed )

Parameters

integer $seed

Definition at line 36 of file class.ilArrayElementShuffler.php.

    {
        $this->seed = $seed;
    }

References $seed.

Referenced by __construct().

Here is the caller graph for this function:

◆ shuffle()

ilArrayElementShuffler::shuffle ( $array )

Parameters

array $array

Returns: array

Reimplemented in ilArrayElementOrderKeeper.

Definition at line 63 of file class.ilArrayElementShuffler.php.

    {
        $this->initSeed($this->getSeed());
        $array = $this->shuffleArray($array);
        $this->initSeed($this->buildRandomSeed());
        return $array;
    }

References buildRandomSeed(), getSeed(), initSeed(), and shuffleArray().

Referenced by assClozeGap\getItems(), and shuffleArray().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ shuffleArray()

ilArrayElementShuffler::shuffleArray ( $array )

private

Parameters

array $array

Returns: array

Definition at line 89 of file class.ilArrayElementShuffler.php.

    {
        if ($this->isMtRandomizerAvailable()) {
            return $this->mtShuffle($array);
        }
 
        shuffle($array);
        return $array;
    }