Swis\JsonApi\Client\Relations\AbstractManyRelation

Complexity

Total Complexity

5

Size/Duplication

Total Lines	43
Duplicated Lines	0 %

Test Coverage

Coverage

100%

Importance

Changes	1
Bugs	0	Features	0

3 Methods

Rating	Name	Duplication	Size	Complexity
A	associate()	0	5	1
A	getIncluded()	0	3	2
A	sortBy()	0	11	2

<?php

namespace Swis\JsonApi\Client\Relations;

use Swis\JsonApi\Client\Collection;
use Swis\JsonApi\Client\Interfaces\ManyRelationInterface;

/**
 * @property \Swis\JsonApi\Client\Collection|false|null $included
 */
abstract class AbstractManyRelation extends AbstractRelation implements ManyRelationInterface
{
    /**
     * @param \Swis\JsonApi\Client\Collection $included
     *
     * @return $this
     */
    public function associate(Collection $included)
    {
        $this->included = $included;

        return $this;
    }

    /**
     * @return \Swis\JsonApi\Client\Collection
     */
    public function getIncluded(): Collection
    {
        return $this->included ?: new Collection();
    }

    /**
     * Sort the included collection by the given key.
     * You can also pass your own callback to determine how to sort the collection values.
     *
     * @param callable $callback
     * @param int      $options
     * @param bool     $descending
     *
     * @return $this
     */
    public function sortBy($callback, $options = SORT_REGULAR, $descending = false)
    {
        // Included may be empty when defining the relation (on the item),
        // but will be filled when using the relation to fetch the data.
        // Checking if we have included items and applying the order is
        // simpler then keeping track of the sorts and applying them later.
        if ($this->hasIncluded()) {
            $this->included = $this->getIncluded()->sortBy($callback, $options, $descending);
        }

        return $this;
    }
}