Sop\JWX\JWE\CompressionAlgorithm\CompressionFactory

Complexity

Total Complexity

4

Size/Duplication

Total Lines	49
Duplicated Lines	0 %

Test Coverage

Coverage

100%

Importance

Changes

0

2 Methods

Rating	Name	Duplication	Size	Complexity
A	algoByHeader()	0	7	2
A	algoByName()	0	8	2

<?php

declare(strict_types = 1);

namespace Sop\JWX\JWE\CompressionAlgorithm;

use Sop\JWX\JWA\JWA;
use Sop\JWX\JWE\CompressionAlgorithm;
use Sop\JWX\JWT\Header\Header;

/**
 * Factory class to construct compression algorithm instances.
 */
abstract class CompressionFactory
{
    /**
     * Mapping from algorithm name to class name.
     *
     * @internal
     *
     * @var array
     */
    const MAP_ALGO_TO_CLASS = [
        JWA::ALGO_DEFLATE => DeflateAlgorithm::class,
    ];

    /**
     * Get the compression algorithm by name.
     *
     * @param string $name
     *
     * @throws \UnexpectedValueException If algorithm is not supported
     *
     * @return CompressionAlgorithm
     */
    public static function algoByName(string $name): CompressionAlgorithm
    {
        if (!array_key_exists($name, self::MAP_ALGO_TO_CLASS)) {
            throw new \UnexpectedValueException(
                "No compression algorithm '{$name}'.");
        }
        $cls = self::MAP_ALGO_TO_CLASS[$name];
        return new $cls();
    }

    /**
     * Get the compression algorithm as specified in the given header.
     *
     * @param Header $header Header
     *
     * @throws \UnexpectedValueException If compression algorithm parameter is
     *                                   not present or algorithm is not supported
     *
     * @return CompressionAlgorithm
     */
    public static function algoByHeader(Header $header): CompressionAlgorithm
    {
        if (!$header->hasCompressionAlgorithm()) {
            throw new \UnexpectedValueException(
                'No compression algorithm parameter.');
        }
        return self::algoByName($header->compressionAlgorithm()->value());
    }
}