Gears\DTO\PayloadBehaviour

Complexity

Total Complexity

16

Size/Duplication

Total Lines	136
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	2

Importance

Changes

0

7 Methods

Rating	Name	Duplication	Size	Complexity
A	setPayload()	0	8	2
A	setPayloadParameter()	0	4	1
A	has()	0	4	1
A	get()	0	19	3
A	getPayload()	0	10	2
A	getParameterTransformerMethod()	0	4	1
B	__call()	0	23	6

<?php

/*
 * dto (https://github.com/phpgears/dto).
 * General purpose immutable Data Transfer Objects for PHP.
 *
 * @license MIT
 * @link https://github.com/phpgears/dto
 * @author Julián Gutiérrez <juliangut@gmail.com>
 */

declare(strict_types=1);

namespace Gears\DTO;

use Gears\DTO\Exception\InvalidMethodCallException;
use Gears\DTO\Exception\InvalidParameterException;

/**
 * Payload behaviour.
 */
trait PayloadBehaviour
{
    /**
     * @var mixed[]
     */
    protected $payload = [];

    /**
     * Set payload.
     *
     * @param array<string, mixed> $parameters
     */
    final protected function setPayload(array $parameters): void
    {
        $this->payload = [];

        foreach ($parameters as $parameter => $value) {
            $this->setPayloadParameter($parameter, $value);
        }
    }

    /**
     * Set payload attribute.
     *
     * @param string $parameter
     * @param mixed  $value
     */
    final protected function setPayloadParameter(string $parameter, $value): void
    {
        $this->payload[$parameter] = $value;
    }

    /**
     * Check parameter existence.
     *
     * @param string $parameter
     *
     * @return bool
     */
    final public function has(string $parameter): bool
    {
        return \array_key_exists($parameter, $this->payload);
    }

    /**
     * Get parameter.
     *
     * @param string $parameter
     *
     * @throws InvalidParameterException
     *
     * @return mixed
     */
    final public function get(string $parameter)
    {
        if (!\array_key_exists($parameter, $this->payload)) {
            throw new InvalidParameterException(\sprintf(
                'Payload parameter %s on %s does not exist',
                $parameter,
                static::class
            ));
        }

        $value = $this->payload[$parameter];

        $transformer = $this->getParameterTransformerMethod($parameter);
        if (\method_exists($this, $transformer)) {
            $value = $this->$transformer($value);
        }

        return $value;
    }

    /**
     * Export payload.
     *
     * @return array<string, mixed>

The doc-type array<string, could not be parsed: Expected ">" at position 5, but found "end of type". (view supported doc-types)

     */
    final public function getPayload(): array
    {
        $payload = [];

        foreach (\array_keys($this->payload) as $parameter) {
            $payload[$parameter] = $this->get($parameter);
        }

        return $payload;
    }

    /**
     * Get parameter transformer getter method name.
     *
     * @param string $parameter
     *
     * @return string
     */
    protected function getParameterTransformerMethod(string $parameter): string
    {
        return 'output' . \ucfirst($parameter);
    }

    /**
     * Magic getters call.
     *
     * @param string  $methodName
     * @param mixed[] $arguments
     *
     * @throws InvalidMethodCallException
     * @throws InvalidParameterException
     *
     * @return mixed
     */
    final public function __call(string $methodName, array $arguments)
    {
        if (!\preg_match('/^(has|get)([A-Z][a-zA-Z0-9-_]*)$/', $methodName, $matches)) {
            throw new InvalidMethodCallException(\sprintf('Method %s::%s does not exist', static::class, $methodName));
        }

        if (\count($arguments) !== 0) {
            throw new InvalidMethodCallException(\sprintf(
                '%s::%s method should be called with no parameters',
                static::class,
                $methodName
            ));
        }

        $method = $matches[1];
        $parameter = $matches[2];

        if ($this->has($parameter)) {
            return $method === 'has' ? true : $this->get($parameter);
        }

        return $method === 'has' ? $this->has(\lcfirst($parameter)) : $this->get(\lcfirst($parameter));
    }
}