Mikemirten\Component\JsonApi\Document\Behaviour\IdentifierCollectionContainer

Complexity

Total Complexity

7

Size/Duplication

Total Lines	74
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	1

Test Coverage

Coverage

87.5%

Importance

Changes

0

6 Methods

Rating	Name	Duplication	Size	Complexity
A	addIdentifier()	0	4	1
A	getFirstIdentifier()	0	4	1
A	hasIdentifiers()	0	4	1
A	getIdentifiers()	0	4	1
A	getIterator()	0	4	1
A	identifiersToArray()	0	11	2

<?php
declare(strict_types = 1);

namespace Mikemirten\Component\JsonApi\Document\Behaviour;

use Mikemirten\Component\JsonApi\Document\ResourceIdentifierObject;

/**
 * Collection of resource identifiers container behaviour
 *
 * @see http://jsonapi.org/format/#document-links
 *
 * @package Mikemirten\Component\JsonApi\Document\Behaviour
 */
trait IdentifierCollectionContainer
{
    /**
     * Resource identifiers
     *
     * @var ResourceIdentifierObject[]
     */
    protected $identifiers = [];

    /**
     * Add resource identifier
     *
     * @param ResourceIdentifierObject $identifier
     */
    public function addIdentifier(ResourceIdentifierObject $identifier)
    {
        $this->identifiers[] = $identifier;
    }

    /**
     * Get first identifier from collection
     *
     * @return ResourceIdentifierObject
     */
    public function getFirstIdentifier(): ResourceIdentifierObject
    {
        return reset($this->identifiers);
    }

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

    /**
     * Get resource identifiers
     *
     * @return ResourceIdentifierObject[]
     */
    public function getIdentifiers(): array
    {
        return $this->identifiers;
    }

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

    /**
     * Cast identifiers to an array
     *
     * @return array
     */
    protected function identifiersToArray(): array
    {
        $data = [];

        foreach ($this->getIdentifiers() as $identifier)
        {
            $data[] = $identifier->toArray();
        }

        return $data;
    }
}