Tisd\Sdk\PackageTrait

Complexity

Total Complexity

9

Size/Duplication

Total Lines	88
Duplicated Lines	0 %

Test Coverage

Coverage

100%

Importance

Changes

0

5 Methods

Rating	Name	Duplication	Size	Complexity
A	getPackageByUuid()	0	3	1
A	getPackageByKeyValue()	0	23	5
A	getPackageByProductCode()	0	3	1
A	getPackageByProductCodeId()	0	3	1
A	getPackageByPackageId()	0	3	1

<?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;

use RecursiveArrayIterator;
use RecursiveIteratorIterator;

/**
 * Trait PackageTrait
 *
 * @package Tisd\Sdk
 */
trait PackageTrait
{
    /**
     * Get the array of consolidated data
     *
     * @return array
     */
    abstract protected function getConsolidated(): array;

    /**
     * Get array of package data matching uuid
     *
     * @param string $uuid
     *
     * @return array
     */
    public function getPackageByUuid(string $uuid): array
    {
        return $this->getPackageByKeyValue('uuid', $uuid);
    }

    /**
     * Get array of package data matching product code ID
     *
     * @param string $productCodeId
     *
     * @return array
     */
    public function getPackageByProductCodeId(string $productCodeId): array
    {
        return $this->getPackageByKeyValue('product_code_id', $productCodeId);
    }

    /**
     * Get array of package data matching package ID
     *
     * @param string $packageId
     *
     * @return array
     */
    public function getPackageByPackageId(string $packageId): array
    {
        return $this->getPackageByKeyValue('package_id', $packageId);
    }

    /**
     * Get array of package data matching product code
     *
     * @param string $productCode
     *
     * @return array
     */
    public function getPackageByProductCode(string $productCode): array
    {
        return $this->getPackageByKeyValue('product_code', $productCode);
    }

    /**
     * Get array of package data where specified $key equals specified $value
     *
     * @param string $key
     * @param string $value
     *
     * @return array
     */
    private function getPackageByKeyValue(string $key, string $value): array
    {
        $consolidated = $this->getConsolidated();

        $rai = new RecursiveArrayIterator($consolidated['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 ($package[$key] === $value) {
                return $package;
            }
        }

        return [];
    }
}