Sop\X501\ASN1\Attribute

Complexity

Total Complexity

15

Size/Duplication

Total Lines	157
Duplicated Lines	0 %

Test Coverage

Coverage

100%

Importance

Changes

0

9 Methods

Rating	Name	Duplication	Size	Complexity
A	first()	0	6	2
A	castValues()	0	17	3
A	values()	0	3	1
A	toASN1()	0	8	1
A	getIterator()	0	3	1
A	count()	0	3	1
A	fromASN1()	0	8	1
A	__construct()	0	10	3
A	fromAttributeValues()	0	8	2

<?php

declare(strict_types = 1);

namespace Sop\X501\ASN1;

use Sop\ASN1\Type\Constructed\Sequence;
use Sop\ASN1\Type\Constructed\Set;
use Sop\ASN1\Type\UnspecifiedType;
use Sop\X501\ASN1\AttributeValue\AttributeValue;
use Sop\X501\ASN1\Feature\TypedAttribute;

/**
 * Implements *Attribute* ASN.1 type.
 *
 * @see https://www.itu.int/ITU-T/formal-language/itu-t/x/x501/2012/InformationFramework.html#InformationFramework.Attribute
 */
class Attribute implements \Countable, \IteratorAggregate
{
    use TypedAttribute;

    /**
     * Attribute values.
     *
     * @var AttributeValue[]
     */
    protected $_values;

    /**
     * Constructor.
     *
     * @param AttributeType  $type      Attribute type
     * @param AttributeValue ...$values Attribute values
     */
    public function __construct(AttributeType $type, AttributeValue ...$values)
    {
        // check that attribute values have correct oid
        foreach ($values as $value) {
            if ($value->oid() !== $type->oid()) {
                throw new \LogicException('Attribute OID mismatch.');
            }
        }
        $this->_type = $type;
        $this->_values = $values;
    }

    /**
     * Initialize from ASN.1.
     *
     * @param Sequence $seq
     *
     * @return self
     */
    public static function fromASN1(Sequence $seq): self
    {
        $type = AttributeType::fromASN1($seq->at(0)->asObjectIdentifier());
        $values = array_map(
            function (UnspecifiedType $el) use ($type) {
                return AttributeValue::fromASN1ByOID($type->oid(), $el);
            }, $seq->at(1)->asSet()->elements());
        return new self($type, ...$values);
    }

    /**
     * Convenience method to initialize from attribute values.
     *
     * @param AttributeValue ...$values One or more values
     *
     * @throws \LogicException
     *
     * @return self
     */
    public static function fromAttributeValues(AttributeValue ...$values): self
    {
        // we need at least one value to determine OID
        if (!count($values)) {
            throw new \LogicException('No values.');
        }
        $oid = reset($values)->oid();
        return new self(new AttributeType($oid), ...$values);
    }

    /**
     * Get first value of the attribute.
     *
     * @throws \LogicException
     *
     * @return AttributeValue
     */
    public function first(): AttributeValue
    {
        if (!count($this->_values)) {
            throw new \LogicException('Attribute contains no values.');
        }
        return $this->_values[0];
    }

    /**
     * Get all values.
     *
     * @return AttributeValue[]
     */
    public function values(): array
    {
        return $this->_values;
    }

    /**
     * Generate ASN.1 structure.
     *
     * @return Sequence
     */
    public function toASN1(): Sequence
    {
        $values = array_map(
            function (AttributeValue $value) {
                return $value->toASN1();
            }, $this->_values);
        $valueset = new Set(...$values);
        return new Sequence($this->_type->toASN1(), $valueset->sortedSetOf());
    }

    /**
     * Cast attribute values to another AttributeValue class.
     *
     * This method is generally used to cast UnknownAttributeValue values
     * to specific objects when class is declared outside this package.
     *
     * The new class must be derived from AttributeValue and have the same OID
     * as current attribute values.
     *
     * @param string $cls AttributeValue class name
     *
     * @throws \LogicException
     *
     * @return self
     */
    public function castValues(string $cls): self
    {
        // check that target class derives from AttributeValue
        if (!is_subclass_of($cls, AttributeValue::class)) {
            throw new \LogicException(sprintf(
                '%s must be derived from %s.', $cls, AttributeValue::class));
        }
        $values = array_map(
            function (AttributeValue $value) use ($cls) {
                /** @var AttributeValue $cls Class name as a string */
                $value = $cls::fromSelf($value);
                if ($value->oid() !== $this->oid()) {
                    throw new \LogicException('Attribute OID mismatch.');
                }
                return $value;
            }, $this->_values);
        return self::fromAttributeValues(...$values);
    }

    /**
     * @see \Countable::count()
     *
     * @return int
     */
    public function count(): int
    {
        return count($this->_values);
    }

    /**
     * @see \IteratorAggregate::getIterator()
     *
     * @return \ArrayIterator
     */
    public function getIterator(): \ArrayIterator
    {
        return new \ArrayIterator($this->_values);
    }
}