CryptoManana\Utilities\ElementPicker

Complexity

Total Complexity

8

Size/Duplication

Total Lines	67
Duplicated Lines	0 %

Test Coverage

Coverage

100%

Importance

Changes	2
Bugs	0	Features	0

2 Methods

Rating	Name	Duplication	Size	Complexity
A	pickCharacterElement()	0	15	3
A	pickArrayElement()	0	33	5

<?php

/**
 * Utility class for random element picking.
 */

namespace CryptoManana\Utilities;

use CryptoManana\Core\Abstractions\Containers\AbstractRandomnessInjectable as RandomnessContainer;
use CryptoManana\Core\Interfaces\Containers\ElementPickingInterface as ElementChoosing;
use CryptoManana\Core\StringBuilder as StringBuilder;

/**
 * Class ElementPicker - Utility class for random element picking.
 *
 * @package CryptoManana\Utilities
 *
 * @property \CryptoManana\Core\Abstractions\Randomness\AbstractGenerator $randomnessSource The randomness generator.
 */
class ElementPicker extends RandomnessContainer implements ElementChoosing
{
    /**
     * Pick a random character from string.
     *
     * @param string $string The string with characters for choosing from.
     *
     * @return string The chosen character string.
     * @throws \Exception Validation errors.
     */
    public function pickCharacterElement($string = '')
    {
        if (!is_string($string)) {
            throw new \InvalidArgumentException('The supplied argument is not of type string.');
        }

        if (empty($string)) {
            return $string;
        }

        // Convert the string to an array
        $array = StringBuilder::stringSplit($string, 1);

        // Reuse the code for array element choosing
        return $this->pickArrayElement($array);
    }

    /**
     * Pick a random element from array.
     *
     * @param array $array The array with elements for choosing from.
     *
     * @return mixed The chosen element from the array.
     */
    public function pickArrayElement(array $array = [])
    {
        if (empty($array)) {
            return $array;
        }

        $count = count($array);

        $iterator = 0;

        // Choose random index
        $elementIndex = ($count === 1) ? 0 : $this->randomnessSource->getInt(0, $count - 1);

        // Reset pointer to begging
        reset($array);

        $tmpElement = null;

        // Iterate through array elements
        foreach ($array as $keyName => $value) {
            // If element is found
            if ($elementIndex == $iterator) {
                $tmpElement = $value;

                break;
            }

            // Update the index
            $iterator++;
        }

        // Return the chosen element
        return $tmpElement;
    }
}