Neomerx\JsonApi\Parser\IdentifierAndResource

Complexity

Total Complexity

65

Size/Duplication

Total Lines	502
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	5

Test Coverage

Coverage

92.43%

Importance

Changes

0

27 Methods

Rating	Name	Duplication	Size	Complexity
A	__construct()	0	14	1
A	getPosition()	0	4	1
A	getId()	0	4	1
A	getType()	0	4	1
A	hasIdentifierMeta()	0	4	1
A	getIdentifierMeta()	0	4	1
A	getAttributes()	0	4	1
B	getRelationships()	0	45	7
A	hasLinks()	0	6	1
A	getLinks()	0	6	1
A	hasResourceMeta()	0	4	1
A	getResourceMeta()	0	4	1
A	setPosition()	0	8	1
A	getFactory()	0	4	1
A	setFactory()	0	6	1
A	getSchemaContainer()	0	4	1
A	setSchemaContainer()	0	6	1
A	getSchema()	0	4	1
A	setSchema()	0	6	1
A	getData()	0	4	1
A	setData()	0	8	1
A	cacheLinks()	0	11	4
B	parseData()	0	30	8
B	parseLinks()	0	38	7
A	assertRelationshipNameAndDescription()	0	13	3
A	parseRelationshipData()	0	31	5
B	parseRelationshipLinks()	0	35	11

<?php declare(strict_types=1);

namespace Neomerx\JsonApi\Parser;

/**
 * Copyright 2015-2019 info@neomerx.com
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 * http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

use IteratorAggregate;
use Neomerx\JsonApi\Contracts\Factories\FactoryInterface;
use Neomerx\JsonApi\Contracts\Parser\ParserInterface;
use Neomerx\JsonApi\Contracts\Parser\PositionInterface;
use Neomerx\JsonApi\Contracts\Parser\RelationshipDataInterface;
use Neomerx\JsonApi\Contracts\Parser\ResourceInterface;
use Neomerx\JsonApi\Contracts\Schema\IdentifierInterface;
use Neomerx\JsonApi\Contracts\Schema\LinkInterface;
use Neomerx\JsonApi\Contracts\Schema\SchemaContainerInterface;
use Neomerx\JsonApi\Contracts\Schema\SchemaInterface;
use Neomerx\JsonApi\Exceptions\InvalidArgumentException;
use Traversable;
use function Neomerx\JsonApi\I18n\format as _;

/**
 * @package Neomerx\JsonApi
 */
class IdentifierAndResource implements ResourceInterface
{
    /** @var string */
    public const MSG_NO_SCHEMA_FOUND = 'No Schema found for resource `%s` at path `%s`.';

    /** @var string */
    public const MSG_INVALID_OPERATION = 'Invalid operation.';

    /**
     * @var PositionInterface
     */
    private $position;

    /**
     * @var FactoryInterface
     */
    private $factory;

    /**
     * @var SchemaContainerInterface
     */
    private $schemaContainer;

    /**
     * @var SchemaInterface
     */
    private $schema;

    /**
     * @var mixed
     */
    private $data;

    /**
     * @var string
     */
    private $index;

    /**
     * @var string
     */
    private $type;

    /**
     * @var null|array
     */
    private $links = null;

    /**
     * @var null|array
     */
    private $relationshipsCache = null;

    /**
     * @param PositionInterface        $position
     * @param FactoryInterface         $factory
     * @param SchemaContainerInterface $container
     * @param mixed                    $data
     */
    public function __construct(
        PositionInterface $position,
        FactoryInterface $factory,
        SchemaContainerInterface $container,
        $data
    ) {
        $schema = $container->getSchema($data);
        $this
            ->setPosition($position)
            ->setFactory($factory)
            ->setSchemaContainer($container)
            ->setSchema($schema)
            ->setData($data);
    }

    /**
     * @inheritdoc
     */
    public function getPosition(): PositionInterface
    {
        return $this->position;
    }

    /**
     * @inheritdoc
     */
    public function getId(): ?string
    {
        return $this->index;
    }

    /**
     * @inheritdoc
     */
    public function getType(): string
    {
        return $this->type;
    }

    /**
     * @inheritdoc
     */
    public function hasIdentifierMeta(): bool
    {
        return $this->getSchema()->hasIdentifierMeta($this->getData());
    }

    /**
     * @inheritdoc
     */
    public function getIdentifierMeta()
    {
        return $this->getSchema()->getIdentifierMeta($this->getData());
    }

    /**
     * @inheritdoc
     */
    public function getAttributes(): iterable
    {
        return $this->getSchema()->getAttributes($this->getData());
    }

    /**
     * @inheritdoc
     */
    public function getRelationships(): iterable
    {
        if ($this->relationshipsCache !== null) {
            yield from $this->relationshipsCache;

            return;
        }

        $this->relationshipsCache = [];

        $currentPath    = $this->getPosition()->getPath();
        $nextLevel      = $this->getPosition()->getLevel() + 1;
        $nextPathPrefix = empty($currentPath) === true ? '' : $currentPath . PositionInterface::PATH_SEPARATOR;
        foreach ($this->getSchema()->getRelationships($this->getData()) as $name => $description) {
            assert($this->assertRelationshipNameAndDescription($name, $description) === true);

            [$hasData, $relationshipData, $nextPosition] =

The variable $hasData does not exist. Did you forget to declare it?

The variable $relationshipData does not exist. Did you forget to declare it?

The variable $nextPosition does not exist. Did you forget to declare it?

                $this->parseRelationshipData($name, $description, $nextLevel, $nextPathPrefix);

            [$hasLinks, $links] = $this->parseRelationshipLinks($name, $description);

The variable $hasLinks does not exist. Did you forget to declare it?

The variable $links does not exist. Did you forget to declare it?

            $hasMeta = array_key_exists(SchemaInterface::RELATIONSHIP_META, $description);
            $meta    = $hasMeta === true ? $description[SchemaInterface::RELATIONSHIP_META] : null;

            assert(
                $hasData || $hasMeta || $hasLinks,
                "Relationship `$name` for type `" . $this->getType() .
                '` MUST contain at least one of the following: links, data or meta.'
            );

            $relationship = $this->getFactory()->createRelationship(
                $nextPosition,
                $hasData,
                $relationshipData,
                $hasLinks,
                $links,
                $hasMeta,
                $meta
            );

            $this->relationshipsCache[$name] = $relationship;

            yield $name => $relationship;
        }
    }

    /**
     * @inheritdoc
     */
    public function hasLinks(): bool
    {
        $this->cacheLinks();

        return empty($this->links) === false;
    }

    /**
     * @inheritdoc
     */
    public function getLinks(): iterable
    {
        $this->cacheLinks();

        return $this->links;

The expression $this->links; of type null|array adds the type array to the return on line 226 which is incompatible with the return type declared by the interface Neomerx\JsonApi\Contracts\Parser\ResourceInterface::getLinks of type Neomerx\JsonApi\Contracts\Parser\iterable.

    }

    /**
     * @inheritdoc
     */
    public function hasResourceMeta(): bool
    {
        return $this->getSchema()->hasResourceMeta($this->getData());
    }

    /**
     * @inheritdoc
     */
    public function getResourceMeta()
    {
        return $this->getSchema()->getResourceMeta($this->getData());
    }

    /**
     * @inheritdoc
     */
    protected function setPosition(PositionInterface $position): self
    {
        assert($position->getLevel() >= ParserInterface::ROOT_LEVEL);

        $this->position = $position;

        return $this;
    }

    /**
     * @return FactoryInterface
     */
    protected function getFactory(): FactoryInterface
    {
        return $this->factory;
    }

    /**
     * @param FactoryInterface $factory
     *
     * @return self
     */
    protected function setFactory(FactoryInterface $factory): self
    {
        $this->factory = $factory;

        return $this;
    }

    /**
     * @return SchemaContainerInterface
     */
    protected function getSchemaContainer(): SchemaContainerInterface
    {
        return $this->schemaContainer;
    }

    /**
     * @param SchemaContainerInterface $container
     *
     * @return self
     */
    protected function setSchemaContainer(SchemaContainerInterface $container): self
    {
        $this->schemaContainer = $container;

        return $this;
    }

    /**
     * @return SchemaInterface
     */
    protected function getSchema(): SchemaInterface
    {
        return $this->schema;
    }

    /**
     * @param SchemaInterface $schema
     *
     * @return self
     */
    protected function setSchema(SchemaInterface $schema): self
    {
        $this->schema = $schema;

        return $this;
    }

    /**
     * @return mixed
     */
    protected function getData()
    {
        return $this->data;
    }

    /**
     * @param mixed $data
     *
     * @return self
     */
    protected function setData($data): self
    {
        $this->data  = $data;
        $this->index = $this->getSchema()->getId($data);
        $this->type  = $this->getSchema()->getType();

        return $this;
    }

    /**
     * Read and parse links from schema.
     */
    private function cacheLinks(): void
    {
        if ($this->links === null) {
            $this->links = [];
            foreach ($this->getSchema()->getLinks($this->getData()) as $name => $link) {
                assert(is_string($name) === true && empty($name) === false);
                assert($link instanceof LinkInterface);
                $this->links[$name] = $link;
            }
        }
    }

    /**
     * @param PositionInterface $position
     * @param mixed             $data
     *
     * @return RelationshipDataInterface
     */
    private function parseData(
        PositionInterface $position,
        $data
    ): RelationshipDataInterface {
        // support if data is callable (e.g. a closure used to postpone actual data reading)
        if (is_callable($data) === true) {
            $data = call_user_func($data);
        }

        $factory = $this->getFactory();
        if ($this->getSchemaContainer()->hasSchema($data) === true) {
            return $factory->createRelationshipDataIsResource($this->getSchemaContainer(), $position, $data);
        } elseif ($data instanceof IdentifierInterface) {
            return $factory->createRelationshipDataIsIdentifier($this->getSchemaContainer(), $position, $data);
        } elseif (is_array($data) === true) {
            return $factory->createRelationshipDataIsCollection($this->getSchemaContainer(), $position, $data);

$data is of type array, but the function expects a object<Neomerx\JsonApi\Contracts\Factories\iterable>.

        } elseif ($data instanceof Traversable) {
            return $factory->createRelationshipDataIsCollection(
                $this->getSchemaContainer(),
                $position,
                $data instanceof IteratorAggregate ? $data->getIterator() : $data

$data instanceof \IteratorAggregate ? $data->getIterator() : $data is of type object<Traversable>, but the function expects a object<Neomerx\JsonApi\Contracts\Factories\iterable>.

            );
        } elseif ($data === null) {
            return $factory->createRelationshipDataIsNull();
        }

        throw new InvalidArgumentException(
            _(static::MSG_NO_SCHEMA_FOUND, get_class($data), $position->getPath())
        );
    }

    /**
     * @param string   $relationshipName
     * @param iterable $schemaLinks
     * @param bool     $addSelfLink
     * @param bool     $addRelatedLink
     *
     * @return iterable
     */
    private function parseLinks(
        string $relationshipName,
        iterable $schemaLinks,
        bool $addSelfLink,
        bool $addRelatedLink
    ): iterable {
        $gotSelf    = false;
        $gotRelated = false;

        foreach ($schemaLinks as $name => $link) {
            assert($link instanceof LinkInterface);
            if ($name === LinkInterface::SELF) {
                assert($gotSelf === false);
                $gotSelf     = true;
                $addSelfLink = false;
            } elseif ($name === LinkInterface::RELATED) {
                assert($gotRelated === false);
                $gotRelated     = true;
                $addRelatedLink = false;
            }

            yield $name => $link;
        }

        if ($addSelfLink === true) {
            $link = $this->getSchema()->getRelationshipSelfLink($this->getData(), $relationshipName);
            yield LinkInterface::SELF => $link;
            $gotSelf = true;
        }
        if ($addRelatedLink === true) {
            $link = $this->getSchema()->getRelationshipRelatedLink($this->getData(), $relationshipName);
            yield LinkInterface::RELATED => $link;
            $gotRelated = true;
        }

        // spec: check links has at least one of the following: self or related
        assert($gotSelf || $gotRelated);
    }

    /**
     * @param string $name
     * @param array  $description
     *
     * @return bool
     */
    private function assertRelationshipNameAndDescription(string $name, array $description): bool
    {
        assert(
            is_string($name) === true && empty($name) === false,
            "Relationship names for type `" . $this->getType() . '` should be non-empty strings.'
        );
        assert(
            is_array($description) === true && empty($description) === false,
            "Relationship `$name` for type `" . $this->getType() . '` should be a non-empty array.'
        );

        return true;
    }

    /**
     * @param string $name
     * @param array  $description
     * @param int    $nextLevel
     * @param string $nextPathPrefix
     *
     * @return array [has data, parsed data]
     */
    private function parseRelationshipData(
        string $name,
        array $description,
        int $nextLevel,
        string $nextPathPrefix
    ): array {
        $hasData = array_key_exists(SchemaInterface::RELATIONSHIP_DATA, $description);
        // either no data or data should be array/object/null
        assert(
            $hasData === false ||
            (
                is_array($data = $description[SchemaInterface::RELATIONSHIP_DATA]) === true ||
                is_object($data) === true ||
                $data === null
            )
        );

        $nextPosition = $this->getFactory()->createPosition(
            $nextLevel,
            $nextPathPrefix . $name,
            $this->getType(),
            $name
        );

        $relationshipData = $hasData === true ? $this->parseData(
            $nextPosition,
            $description[SchemaInterface::RELATIONSHIP_DATA]
        ) : null;

        return [$hasData, $relationshipData, $nextPosition];
    }

    /**
     * @param string $name
     * @param array  $description
     *
     * @return array
     */
    private function parseRelationshipLinks(string $name, array $description): array
    {
        $addSelfLink    = $description[SchemaInterface::RELATIONSHIP_LINKS_SELF] ??
            $this->getSchema()->isAddSelfLinkInRelationshipByDefault();
        $addRelatedLink = $description[SchemaInterface::RELATIONSHIP_LINKS_RELATED] ??
            $this->getSchema()->isAddRelatedLinkInRelationshipByDefault();
        assert(is_bool($addSelfLink) === true || $addSelfLink instanceof LinkInterface);
        assert(is_bool($addRelatedLink) === true || $addRelatedLink instanceof LinkInterface);

        $schemaLinks = array_key_exists(SchemaInterface::RELATIONSHIP_LINKS, $description) === true ?
            $description[SchemaInterface::RELATIONSHIP_LINKS] : [];
        assert(is_array($schemaLinks));

        // if `self` or `related` link was given as LinkInterface merge it with the other links
        if (is_bool($addSelfLink) === false) {
            $extraSchemaLinks[LinkInterface::SELF] = $addSelfLink;

$extraSchemaLinks was never initialized. Although not strictly required by PHP, it is generally a good practice to add $extraSchemaLinks = array(); before regardless.

            $addSelfLink                           = false;
        }
        if (is_bool($addRelatedLink) === false) {
            $extraSchemaLinks[LinkInterface::RELATED] = $addRelatedLink;

The variable $extraSchemaLinks does not seem to be defined for all execution paths leading up to this point.

            $addRelatedLink                           = false;
        }
        if (isset($extraSchemaLinks) === true) {
            // IDE do not understand it's defined without he line below
            assert(isset($extraSchemaLinks));
            $schemaLinks = array_merge($extraSchemaLinks, $schemaLinks);
            unset($extraSchemaLinks);
        }
        assert(is_bool($addSelfLink) === true && is_bool($addRelatedLink) === true);

        $hasLinks = $addSelfLink === true || $addRelatedLink === true || empty($schemaLinks) === false;
        $links    = $hasLinks === true ? $this->parseLinks($name, $schemaLinks, $addSelfLink, $addRelatedLink) : null;

$schemaLinks is of type array, but the function expects a object<Neomerx\JsonApi\Parser\iterable>.

        return [$hasLinks, $links];
    }
}