Mikemirten\Component\JsonApi\Document\ResourceCollectionDocument

Complexity

Total Complexity

8

Size/Duplication

Total Lines	88
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	2

Test Coverage

Coverage

100%

Importance

Changes

0

7 Methods

Rating	Name	Duplication	Size	Complexity
A	__construct()	0	4	1
A	addResource()	0	4	1
A	getFirstResource()	0	4	1
A	getResources()	0	4	1
A	getIterator()	0	4	1
A	toArray()	0	15	2
A	__toString()	0	4	1

<?php
declare(strict_types = 1);

namespace Mikemirten\Component\JsonApi\Document;

/**
 * Resource Collection Document
 *
 * @see http://jsonapi.org/format/#document-structure
 *
 * @package Mikemirten\Component\JsonApi\Document
 */
class ResourceCollectionDocument extends AbstractDocument implements \IteratorAggregate
{
    /**
     * Resources
     *
     * @var ResourceObject[]
     */
    protected $resources = [];

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

    /**
     * Add resource
     *
     * @param ResourceObject $resource
     */
    public function addResource(ResourceObject $resource)
    {
        $this->resources[] = $resource;
    }

    /**
     * Get first resource from collection
     *
     * @return ResourceObject
     */
    public function getFirstResource(): ResourceObject
    {
        return reset($this->resources);
    }

    /**
     * Get all resources
     *
     * @return ResourceObject[]
     */
    public function getResources(): array
    {
        return $this->resources;
    }

    /**
     * {@inheritdoc}
     */
    public function getIterator(): \Traversable
    {
        return new \ArrayIterator($this->getResources());
    }

    /**
     * Cast to an array
     *
     * @return array
     */
    public function toArray(): array
    {
        $resources = [];

        foreach ($this->getResources() as $resource)
        {
            $resources[] = $resource->toArray();
        }

        $data = parent::toArray();

        $data['data'] = $resources;

        return $data;
    }

    /**
     * Cast to a string
     *
     * @return string
     */
    public function __toString(): string
    {
        return 'Document with collection of resources';
    }
}