Mikemirten\Component\JsonApi\Mapper\Handler\Exception\NotIterableAttribute

Complexity

Total Complexity

5

Size/Duplication

Total Lines	55
Duplicated Lines	0 %

Coupling/Cohesion

Components	0
Dependencies	2

Test Coverage

Coverage

75%

Importance

Changes

0

3 Methods

Rating	Name	Duplication	Size	Complexity
A	__construct()	0	10	1
A	getDefinition()	0	4	1
A	resolveTypeDescription()	0	14	3

<?php
declare(strict_types = 1);

namespace Mikemirten\Component\JsonApi\Mapper\Handler\Exception;

use Mikemirten\Component\JsonApi\Mapper\Definition\Attribute;

/**
 * Exception of non-iterable value of attribute declared as "many" (an iterable container).
 *
 * @package Mikemirten\Component\JsonApi\Mapper\Handler\Exception
 */
class NotIterableAttribute extends MappingHandlerException
{
    /**
     * @var Attribute
     */
    protected $definition;

    /**
     * NotIterableAttribute constructor.
     *
     * @param Attribute $attribute
     * @param mixed     $value
     */
    public function __construct(Attribute $attribute, $value)
    {
        $message = sprintf(
            'Attribute "%s" declared as many (an iterable container) contains %s which cannot be iterated.',
            $attribute->getName(),
            $this->resolveTypeDescription($value)
        );

        parent::__construct($message);
    }

    /**
     * Get definition of attribute caused the issue
     *
     * @return Attribute
     */
    public function getDefinition(): Attribute
    {
        return $this->definition;
    }

    /**
     * Resolve description of value's type
     *
     * @param  $value
     * @return string
     */
    protected function resolveTypeDescription($value): string
    {
        $type = gettype($value);

        if ($type === 'object') {
            return 'an instance of ' . get_class($value);
        }

        if ($type === 'integer') {
            return 'an integer';
        }

        return 'a ' . $type;
    }
}