Tisd\Sdk\Lut\AbstractLut

Complexity

Total Complexity

13

Size/Duplication

Total Lines	135
Duplicated Lines	0 %

Test Coverage

Coverage

92.11%

Importance

Changes

0

7 Methods

Rating	Name	Duplication	Size	Complexity
A	getKeys()	0	3	1
A	setSdk()	0	5	1
A	getSdk()	0	3	1
A	getValues()	0	3	1
B	buildLut()	0	38	6
A	__construct()	0	5	1
A	getValue()	0	9	2

<?php
declare(strict_types=1);

/**
 * The Imaging Source Download System PHP Wrapper
 *
 * PHP wrapper for The Imaging Source Download System Web API. Authored and supported by The Imaging Source Europe GmbH.
 *
 * @link      http://dl-gui.theimagingsource.com to learn more about The Imaging Source Download System
 * @link      https://github.com/jonathanmaron/theimagingsource-tisd-sdk for the canonical source repository
 * @license   https://github.com/jonathanmaron/theimagingsource-tisd-sdk/blob/master/LICENSE.md
 * @copyright © 2022 The Imaging Source Europe GmbH
 */

namespace Tisd\Sdk\Lut;

use RecursiveArrayIterator;
use RecursiveIteratorIterator;
use Tisd\Sdk\Exception\RuntimeException;
use Tisd\Sdk\Sdk;

/**
 * Class AbstractLut
 *
 * @package Tisd\Sdk\Lut
 */
class AbstractLut
{
    /**
     * Instance of Sdk
     *
     * @var Sdk
     */
    protected Sdk $sdk;

    /**
     * Look-up-table
     *
     * @var array
     */
    protected array $lut;

    /**
     * AbstractLut constructor
     *
     * @param array $options
     */
    public function __construct(array $options = [])
    {
        $sdk = new Sdk($options);

        $this->setSdk($sdk);
    }

    /**
     * Get all keys in the LUT
     *
     * @return array
     */
    public function getKeys(): array
    {
        return array_keys($this->getValues());
    }

    /**
     * Get all data in the LUT
     *
     * @return array
     */
    public function getValues(): array
    {
        return $this->lut;
    }

    /**
     * Get the value for key in the LUT
     *
     * @param string $key
     *
     * @return array|string
     */
    public function getValue(string $key): array|string
    {
        $ret = '';

        if (isset($this->lut[$key])) {
            $ret = $this->lut[$key];
        }

        return $ret;
    }

    /**
     * Get an instance of the Sdk
     *
     * @return Sdk
     */
    public function getSdk(): Sdk
    {
        return $this->sdk;
    }

    /**
     * Set an instance of the Sdk
     *
     * @param Sdk $sdk
     *
     * @return $this
     */
    public function setSdk(Sdk $sdk): self
    {
        $this->sdk = $sdk;

        return $this;
    }

    /**
     * Build the LUT
     *
     * @param string $keyName
     *
     * @return array
     */
    protected function buildLut(string $keyName): array
    {
        $ret = [];

        $packages = $this->getSdk()->getPackages();

        $rai = new RecursiveArrayIterator($packages);
        $rii = new RecursiveIteratorIterator($rai, RecursiveIteratorIterator::SELF_FIRST);

        foreach ($rii as $package) {

            if (!is_array($package)) {
                continue;
            }

            if (!array_key_exists('package_id', $package)) {
                continue;
            }

            if (!array_key_exists($keyName, $package)) {
                $format  = "The '%s' does not exist in the package.";
                $message = sprintf($format, $keyName);
                throw new RuntimeException($message);
            }

            $key = $package[$keyName];

            if (array_key_exists($key, $ret)) {
                $format  = "The '%s' is not unique in the LUT. The offending key is '%s'.";
                $message = sprintf($format, $keyName, $key);
                //@todo: Fix this by updating repository.
                throw new RuntimeException($message);
            }

            $ret[$key] = $package;
        }

        return $ret;
    }
}