Mikemirten\Component\JsonApi\Mapper\Definition\Attribute

Complexity

Total Complexity

17

Size/Duplication

Total Lines	169
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	0

Test Coverage

Coverage

100%

Importance

Changes

0

12 Methods

Rating	Name	Duplication	Size	Complexity
A	__construct()	0	5	1
A	getName()	0	4	1
A	getGetter()	0	4	1
A	setType()	0	4	1
A	hasType()	0	4	1
A	getType()	0	4	1
A	setTypeParameters()	0	4	1
A	getTypeParameters()	0	4	1
A	setPropertyName()	0	4	1
A	hasPropertyName()	0	4	1
A	getPropertyName()	0	4	1
B	merge()	0	14	6

<?php
declare(strict_types = 1);

namespace Mikemirten\Component\JsonApi\Mapper\Definition;

/**
 * Definition of attribute
 *
 * @package Mikemirten\Component\JsonApi\Mapper\Definition
 */
class Attribute
{
    /**
     * Name of property contains related object.
     * Value is optional. Can be set only for real properties.
     *
     * @var string
     */
    protected $propertyName;

    /**
     * Unique name of serialized attribute
     *
     * @var string
     */
    protected $name;

    /**
     * Data-type
     *
     * @var string
     */
    protected $type;

    /**
     * Parameters for data-type handler
     *
     * @var array
     */
    protected $typeParameters = [];

    /**
     * Getter-method to access value
     *
     * @var string
     */
    protected $getter;

    /**
     * Attribute constructor.
     *
     * @param string $name
     */
    public function __construct(string $name, string $getter)
    {
        $this->name   = $name;
        $this->getter = $getter;
    }

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

    /**
     * Get name of getter-method to access value of attribute
     *
     * @return string
     */
    public function getGetter(): string
    {
        return $this->getter;
    }

    /**
     * Set name of data-type
     *
     * @param string $type
     */
    public function setType(string $type)
    {
        $this->type = $type;
    }

    /**
     * Has data-type defined ?
     *
     * @return bool
     */
    public function hasType(): bool
    {
        return $this->type !== null;
    }

    /**
     * Get name of data-type
     *
     * @return string
     */
    public function getType(): string
    {
        return $this->type;
    }

    /**
     * Set parameters of data-type handling
     *
     * @param array $parameters
     */
    public function setTypeParameters(array $parameters)
    {
        $this->typeParameters = $parameters;
    }

    /**
     * Get parameters of data-type handling
     *
     * @return array
     */
    public function getTypeParameters(): array
    {
        return $this->typeParameters;
    }

    /**
     * Set name of property contains related object
     *
     * @param string $name
     */
    public function setPropertyName(string $name)
    {
        $this->propertyName = $name;
    }

    /**
     * Has name of property ?
     *
     * @return bool
     */
    public function hasPropertyName(): bool
    {
        return $this->propertyName !== null;
    }

    /**
     * Get name of property contains related object
     *
     * @return string
     */
    public function getPropertyName(): string
    {
        return $this->propertyName;
    }

    /**
     * Merge a attribute into this one
     *
     * @param self $attribute
     */
    public function merge(self $attribute)
    {
        if ($this->propertyName === null && $attribute->hasPropertyName()) {
            $this->propertyName = $attribute->getPropertyName();
        }

        if ($this->type === null && $attribute->hasType()) {
            $this->type = $attribute->getType();
        }

        if (empty($this->typeParameters)) {
            $this->typeParameters = $attribute->getTypeParameters();
        }
    }
}