Mikemirten\Component\JsonApi\Document\Behaviour\AttributesContainer

Complexity

Total Complexity

8

Size/Duplication

Total Lines	82
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	2

Test Coverage

Coverage

88.89%

Importance

Changes

0

6 Methods

Rating	Name	Duplication	Size	Complexity
A	setAttribute()	0	8	2
A	hasAttribute()	0	4	1
A	getAttribute()	0	8	2
A	hasAttributes()	0	4	1
A	removeAttribute()	0	4	1
A	getAttributes()	0	4	1

<?php
declare(strict_types = 1);

namespace Mikemirten\Component\JsonApi\Document\Behaviour;

use Mikemirten\Component\JsonApi\Document\Exception\AttributeNotFoundException;
use Mikemirten\Component\JsonApi\Document\Exception\AttributeOverrideException;

/**
 * Attributes-container behaviour
 *
 * @see http://jsonapi.org/format/#document-resource-object-attributes
 *
 * @package Mikemirten\Component\JsonApi\Document\Behaviour
 */
trait AttributesContainer
{
    /**
     * Attributes
     *
     * @var array
     */
    protected $attributes = [];

    /**
     * Set attribute
     *
     * @param  string $name
     * @param  mixed  $value
     * @throws AttributeOverrideException
     */
    public function setAttribute(string $name, $value)
    {
        if (array_key_exists($name, $this->attributes)) {
            throw new AttributeOverrideException($this, $name);
        }

        $this->attributes[$name] = $value;
    }

    /**
     * Has attribute
     *
     * @param  string $name
     * @return bool
     */
    public function hasAttribute(string $name): bool
    {
        return array_key_exists($name, $this->attributes);
    }

    /**
     * Get attribute
     *
     * @param  string $name
     * @return mixed
     * @throws AttributeNotFoundException
     */
    public function getAttribute(string $name)
    {
        if (array_key_exists($name, $this->attributes)) {
            return $this->attributes[$name];
        }

        throw new AttributeNotFoundException($this, $name);
    }

    /**
     * Contains any attributes ?
     *
     * @return bool
     */
    public function hasAttributes(): bool
    {
        return count($this->attributes) > 0;
    }

    /**
     * Remove attribute
     *
     * @param string $name
     */
    public function removeAttribute(string $name)
    {
        unset($this->attributes[$name]);
    }

    /**
     * Get all attributes
     *
     * @return array
     */
    public function getAttributes(): array
    {
        return $this->attributes;
    }
}