Huntie\JsonApi\Support\RelationshipIterator

Complexity

Total Complexity

5

Size/Duplication

Total Lines	50
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	2

Importance

Changes	1
Bugs	0	Features	0

2 Methods

Rating	Name	Duplication	Size	Complexity
A	__construct()	0	9	2
A	resolve()	0	10	3

<?php

namespace Huntie\JsonApi\Support;

use InvalidArgumentException;
use Huntie\JsonApi\Exceptions\InvalidRelationPathException;
use Illuminate\Database\Eloquent\Model;

class RelationshipIterator
{
    /**
     * The primary record.
     */
    private $record;

    /**
     * The path to the relation.
     *
     * @var string
     */
    private $path;

    /**
     * Create a new RelationshipIterator instance.
     *
     * @param Model  $record The primary record
     * @param string $path   The path to the relation
     *
     * @throws InvalidArgumentException
     */
    public function __construct($record, $path)
    {
        if (!preg_match('/^([A-Za-z]+.?)+[A-Za-z]+$/', $path)) {
            throw new InvalidArgumentException('The relationship path must be a valid string');
        }

        $this->record = $record;
        $this->path = $path;
    }

    /**
     * Resolve the relationship from the primary record.
     *
     * @throws InvalidRelationPathException
     *
     * @return Collection|Model|null
     */
    public function resolve()
    {
        return array_reduce(explode('.', $this->path), function ($resolved, $relation) {
            if (!$resolved instanceof Model || in_array($relation, $resolved->getHidden())) {
                throw new InvalidRelationPathException($this->path);
            }

            return $resolved->{$relation};
        }, $this->record);
    }
}