ShuffleTransformation.php

Go to the documentation of this file.

<?php

declare(strict_types=1);

namespace ILIAS\Refinery\Random\Transformation;

use ILIAS\Refinery\Random\Seed\Seed;
use ILIAS\Refinery\Transformation;
use ILIAS\Refinery\ConstraintViolationException;
use ILIAS\Refinery\DeriveInvokeFromTransform;
use ILIAS\Refinery\DeriveApplyToFromTransform;

class ShuffleTransformation implements Transformation
{
    use DeriveInvokeFromTransform;
    use DeriveApplyToFromTransform;

    private Seed $seed;

    public function __construct(Seed $seed)
    {
        $this->seed = $seed;
    }

    public function transform($from): array
    {
        if (!is_array($from)) {
            throw new ConstraintViolationException('not an array', 'no_array');
        }
        $this->seed->seedRandomGenerator();
        shuffle($from);

        return $from;
    }
}