Mikemirten\Component\JsonApi\Document\Behaviour\RelationshipsContainer

Complexity

Total Complexity

10

Size/Duplication

Total Lines	97
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	2

Test Coverage

Coverage

91.3%

Importance

Changes

0

7 Methods

Rating	Name	Duplication	Size	Complexity
A	setRelationship()	0	8	2
A	hasRelationship()	0	4	1
A	getRelationship()	0	8	2
A	hasRelationships()	0	4	1
A	getRelationships()	0	4	1
A	removeRelationship()	0	4	1
A	relationshipsToArray()	0	11	2

<?php
declare(strict_types = 1);

namespace Mikemirten\Component\JsonApi\Document\Behaviour;

use Mikemirten\Component\JsonApi\Document\AbstractRelationship;
use Mikemirten\Component\JsonApi\Document\Exception\RelationshipNotFoundException;
use Mikemirten\Component\JsonApi\Document\Exception\RelationshipOverrideException;

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

    /**
     * Set relationship
     *
     * @param string               $name
     * @param AbstractRelationship $relationship
     */
    public function setRelationship(string $name, AbstractRelationship $relationship)
    {
        if (isset($this->relationships[$name])) {
            throw new RelationshipOverrideException($this, $name);
        }

        $this->relationships[$name] = $relationship;
    }

    /**
     * Has relationship
     *
     * @param  string $name
     * @return bool
     */
    public function hasRelationship(string $name): bool
    {
        return isset($this->relationships[$name]);
    }

    /**
     * Get relationship
     *
     * @param  string $name
     * @return AbstractRelationship
     */
    public function getRelationship(string $name): AbstractRelationship
    {
        if (isset($this->relationships[$name])) {
            return $this->relationships[$name];
        }

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

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

    /**
     * Get relationships
     *
     * @return AbstractRelationship[]
     */
    public function getRelationships(): array
    {
        return $this->relationships;
    }

    /**
     * Remove relationship
     *
     * @param string $name
     */
    public function removeRelationship(string $name)
    {
        unset($this->relationships[$name]);
    }

    /**
     * Cast relationships to an array
     *
     * @return array
     */
    protected function relationshipsToArray(): array
    {
        $relationships = [];

        foreach ($this->relationships as $name => $relationship)
        {
            $relationships[$name] = $relationship->toArray();
        }

        return $relationships;
    }
}