Mikemirten\Component\JsonApi\Document\ResourceIdentifierObject

Complexity

Total Complexity

4

Size/Duplication

Total Lines	45
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	2

Test Coverage

Coverage

100%

Importance

Changes

0

3 Methods

Rating	Name	Duplication	Size	Complexity
A	__construct()	0	6	1
A	toArray()	0	10	2
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;
use Mikemirten\Component\JsonApi\Document\Behaviour\ResourceBehaviour;

/**
 * Resource Identifier Object
 *
 * @see http://jsonapi.org/format/#document-resource-identifier-objects
 *
 * @package Mikemirten\Component\JsonApi\Document
 */
class ResourceIdentifierObject implements MetadataAwareInterface
{
    use ResourceBehaviour;
    use MetadataContainer;

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

    /**
     * Cast to an array
     *
     * @return array
     */
    public function toArray(): array
    {
        $data = $this->resourceToArray();

        if ($this->hasMetadata()) {
            $data['meta'] = $this->getMetadata();
        }

        return $data;
    }

    /**
     * Cast to a string
     *
     * @return string
     */
    public function __toString(): string
    {
        return sprintf('Identifier of resource with ID: "%s" and type: "%s"', $this->id, $this->type);
    }
}