Stratadox\Hydration\Mapping\Property\Type\ScalarValue

Complexity

Total Complexity

7

Size/Duplication

Total Lines	62
Duplicated Lines	0 %

Importance

Changes

0

6 Methods

Rating	Name	Duplication	Size	Complexity
A	my()	0	6	2
A	key()	0	3	1
A	inProperty()	0	3	1
A	name()	0	3	1
A	inPropertyWithDifferentKey()	0	5	1
A	__construct()	0	4	1

<?php
declare(strict_types=1);

namespace Stratadox\Hydration\Mapping\Property\Type;

use function array_key_exists;
use Stratadox\Hydration\Mapping\Property\MissingTheKey;
use Stratadox\HydrationMapping\ExposesDataKey;
use Stratadox\HydrationMapping\UnmappableInput;

/**
 * Maps the data from a single key to a scalar object property.
 *
 * @package Stratadox\Hydrate
 * @author  Stratadox
 */
abstract class ScalarValue implements ExposesDataKey
{
    private $name;
    private $key;

    private function __construct(string $name, string $dataKey)
    {
        $this->name = $name;
        $this->key = $dataKey;
    }

    /**
     * Creates a new mapping for the called-upon scalar type object property.
     *
     * @param string $name    The name of both the key and the property.
     * @return ExposesDataKey The scalar mapping object.
     */
    public static function inProperty(string $name): ExposesDataKey
    {
        return new static($name, $name);
    }

    /**
     * Creates a new mapping for the called-upon scalar type object property,
     * using the data from a specific key.
     *
     * @param string $name    The name of the property.
     * @param string $key     The array key to use.
     * @return ExposesDataKey The scalar mapping object.
     */
    public static function inPropertyWithDifferentKey(
        string $name,
        string $key
    ): ExposesDataKey {
        return new static($name, $key);
    }

    /** @inheritdoc */
    public function name(): string
    {
        return $this->name;
    }

    /** @inheritdoc */
    public function key(): string
    {
        return $this->key;
    }

    /**
     * Retrieves the data that is relevant for this mapping.
     *
     * @param array $data      The input data.
     * @return mixed           The value for our key in the input array.
     * @throws UnmappableInput When the key is missing in the input.
     */
    protected function my(array $data)
    {
        if (!array_key_exists($this->key(), $data)) {
            throw MissingTheKey::inTheInput($data, $this, $this->key());
        }
        return $data[$this->key()];
    }
}