Mikemirten\Component\JsonApi\Document\Behaviour\LinksContainer

Complexity

Total Complexity

11

Size/Duplication

Total Lines	108
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	2

Test Coverage

Coverage

100%

Importance

Changes

0

7 Methods

Rating	Name	Duplication	Size	Complexity
A	setLink()	0	8	2
A	hasLink()	0	4	1
A	getLink()	0	8	2
A	getLinks()	0	4	1
A	hasLinks()	0	4	1
A	linksToArray()	0	19	3
A	removeLink()	0	4	1

<?php
declare(strict_types = 1);

namespace Mikemirten\Component\JsonApi\Document\Behaviour;

use Mikemirten\Component\JsonApi\Document\Exception\LinkNotFoundException;
use Mikemirten\Component\JsonApi\Document\Exception\LinkOverrideException;
use Mikemirten\Component\JsonApi\Document\LinkObject;

/**
 * Links-container behaviour
 *
 * @see http://jsonapi.org/format/#document-links
 *
 * @package Mikemirten\Component\JsonApi\Document\Behaviour
 */
trait LinksContainer
{
    /**
     * Links
     *
     * @var LinkObject[]
     */
    protected $links = [];

    /**
     * Set link
     *
     * @param string     $name
     * @param LinkObject $link
     * @param LinkOverrideException
     */
    public function setLink(string $name, LinkObject $link)
    {
        if (isset($this->links[$name])) {
            throw new LinkOverrideException($this, $name);
        }

        $this->links[$name] = $link;
    }

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

    /**
     * Get link
     *
     * @param  string $name
     * @return LinkObject
     * @throws LinkNotFoundException
     */
    public function getLink(string $name): LinkObject
    {
        if (isset($this->links[$name])) {
            return $this->links[$name];
        }

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

    /**
     * Get all links
     *
     * @return LinkObject[]
     */
    public function getLinks(): array
    {
        return $this->links;
    }

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

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

        foreach ($this->links as $name => $link)
        {
            if (! $link->hasMetadata()) {
                $links[$name] = $link->getReference();
                continue;
            }

            $links[$name] = [
                'href' => $link->getReference(),
                'meta' => $link->getMetadata()
            ];
        }

        return $links;
    }

    /**
     * Remove link
     *
     * @param  string $name
     * @return mixed
     */
    public function removeLink(string $name)
    {
        unset($this->links[$name]);
    }
}