Mikemirten\Component\JsonApi\Document\LinkObject

Complexity

Total Complexity

3

Size/Duplication

Total Lines	42
Duplicated Lines	0 %

Coupling/Cohesion

Components	0
Dependencies	1

Test Coverage

Coverage

100%

Importance

Changes

0

3 Methods

Rating	Name	Duplication	Size	Complexity
A	__construct()	0	5	1
A	getReference()	0	4	1
A	__toString()	0	4	1

<?php
declare(strict_types = 1);

namespace Mikemirten\Component\JsonApi\Document;

use Mikemirten\Component\JsonApi\Document\Behaviour\MetadataAwareInterface;
use Mikemirten\Component\JsonApi\Document\Behaviour\MetadataContainer;

/**
 * Link Object
 *
 * @see http://jsonapi.org/format/#document-links
 *
 * @package Mikemirten\Component\JsonApi\Document
 */
class LinkObject implements MetadataAwareInterface
{
    use MetadataContainer;

    /**
     * Link's reference
     *
     * @var string
     */
    protected $reference;

    /**
     * LinkObject constructor.
     *
     * @param string $reference
     */
    public function __construct(string $reference, array $metadata = [])
    {
        $this->reference = $reference;
        $this->metadata  = $metadata;
    }

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

    /**
     * Cast to a string
     *
     * @return string
     */
    public function __toString(): string
    {
        return sprintf('Link referenced to "%s"', $this->reference);
    }
}