DaveLiddament\StaticAnalysisResultsBaseliner\Domain\Utils\ArrayUtils

Complexity

Total Complexity

19

Size/Duplication

Total Lines	136
Duplicated Lines	0 %

Importance

Changes	1
Bugs	0	Features	0

8 Methods

Rating	Name	Duplication	Size	Complexity
A	getIntValue()	0	7	2
A	getStringValue()	0	7	2
A	getIntOrNullValue()	0	10	3
A	getIntAsStringValue()	0	12	3
A	getArrayValue()	0	7	2
A	assertArrayKeyExists()	0	4	2
A	assertArray()	0	4	2
A	getOptionalStringValue()	0	10	3

<?php

/**
 * Static Analysis Results Baseliner (sarb).
 *
 * (c) Dave Liddament
 *
 * For the full copyright and licence information please view the LICENSE file distributed with this source code.
 */

declare(strict_types=1);

namespace DaveLiddament\StaticAnalysisResultsBaseliner\Domain\Utils;

class ArrayUtils
{
    /**
     * Gets string value for given key in the array.
     *
     * @throws ArrayParseException
     * @psalm-param array<mixed> $array
     */
    public static function getStringValue(array $array, string $key): string
    {
        self::assertArrayKeyExists($array, $key);
        if (is_string($array[$key])) {
            return $array[$key];
        }
        throw ArrayParseException::invalidType($key, 'string');
    }

    /**
     * Gets int value for given key in the array.
     *
     * @throws ArrayParseException
     * @psalm-param array<mixed> $array
     */
    public static function getIntValue(array $array, string $key): int
    {
        self::assertArrayKeyExists($array, $key);
        if (is_int($array[$key])) {
            return $array[$key];
        }
        throw ArrayParseException::invalidType($key, 'int');
    }

    /**
     * Gets int value for given key in the array.
     *
     * @throws ArrayParseException
     *
     * @psalm-param array<mixed> $array
     */
    public static function getIntOrNullValue(array $array, string $key): ?int
    {
        self::assertArrayKeyExists($array, $key);
        if (null === $array[$key]) {
            return null;
        }
        if (is_int($array[$key])) {
            return $array[$key];
        }
        throw ArrayParseException::invalidType($key, 'int');
    }

    /**
     * Gets optional value. Note: if key exists, then the value must be a string.
     *
     * @throws ArrayParseException
     *
     * @psalm-param array<mixed> $array
     */
    public static function getOptionalStringValue(array $array, string $key): ?string
    {
        if (!array_key_exists($key, $array)) {
            return null;
        }

        if (is_string($array[$key])) {
            return $array[$key];
        }
        throw ArrayParseException::invalidType($key, 'string');
    }

    /**
     * Gets array value for given key in the array.
     *
     * @throws ArrayParseException
     * @psalm-param array<mixed> $array
     * @psalm-return array<mixed> $array
     */
    public static function getArrayValue(array $array, string $key): array
    {
        self::assertArrayKeyExists($array, $key);
        if (is_array($array[$key])) {
            return $array[$key];
        }
        throw ArrayParseException::invalidType($key, 'array');
    }

    /**
     * @throws ArrayParseException
     * @psalm-param array<mixed> $array
     */
    private static function assertArrayKeyExists(array $array, string $key): void
    {
        if (!array_key_exists($key, $array)) {
            throw ArrayParseException::missingKey($key);
        }
    }

    /**
     * @param mixed $entity
     * @psalm-assert array $entity
     *
     * @throws ArrayParseException
     */
    public static function assertArray($entity): void
    {
        if (!is_array($entity)) {
            throw ArrayParseException::invalidType('base level', 'array');
        }
    }

    /**
     * Extracts a integer value from an array, however the integer is in string format.
     *
     * e.g. Assume the following code:
     *
     *   $array = ['age' => '21'];
     *   $age = ArrayUtils::getIntAsStringValue($array, 'age');
     *
     * $age would be the integer value 21.
     *
     * @psalm-param array<mixed> $array
     *
     * @throws ArrayParseException
     */
    public static function getIntAsStringValue(array $array, string $key): int
    {
        self::assertArrayKeyExists($array, $key);
        if (is_string($array[$key])) {
            $valueAsString = $array[$key];
            $valueAsInt = (int) $valueAsString;
            $intValueAsString = (string) $valueAsInt;
            if ($intValueAsString === $valueAsString) {
                return $valueAsInt;
            }
        }
        throw ArrayParseException::invalidType($key, 'int as string');
    }
}