AbstractManyRelation::sortBy() - Code Metrics - Inspection of "Properly handle relations without data" - swisnl/json-api-client - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Pull Request — master (#78)

by Jasper

created 2020-08-05 08:59 UTC

AbstractManyRelation::sortBy() A

↳ Parent: AbstractManyRelation

Complexity

Conditions	2
Paths	2

Size

Total Lines	11
Code Lines	3

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	4
CRAP Score	2

Importance

Changes	1
Bugs	0	Features	0

Metric	Value
cc	2
eloc	3
nc	2
nop	3
dl	0
loc	11
ccs	4
cts	4
cp	1
crap	2
rs	10
c	1
b	0
f	0

<?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;
    }
}


1		<?php
2
3		namespace Swis\JsonApi\Client\Relations;
4
5		use Swis\JsonApi\Client\Collection;
6		use Swis\JsonApi\Client\Interfaces\ManyRelationInterface;
7
8		/**
9		* @property \Swis\JsonApi\Client\Collection\|false\|null $included
10		*/
11		abstract class AbstractManyRelation extends AbstractRelation implements ManyRelationInterface
12		{
13		/**
14		* @param \Swis\JsonApi\Client\Collection $included
15		*
16		* @return $this
17		*/
18	230	public function associate(Collection $included)
19		{
20	230	$this->included = $included;
21
22	230	return $this;
23		}
24
25		/**
26		* @return \Swis\JsonApi\Client\Collection
27		*/
28	185	public function getIncluded(): Collection
29		{
30	185	return $this->included ?: new Collection();
31		}
32
33		/**
34		* Sort the included collection by the given key.
35		* You can also pass your own callback to determine how to sort the collection values.
36		*
37		* @param callable $callback
38		* @param int $options
39		* @param bool $descending
40		*
41		* @return $this
42		*/
43	5	public function sortBy($callback, $options = SORT_REGULAR, $descending = false)
44		{
45		// Included may be empty when defining the relation (on the item),
46		// but will be filled when using the relation to fetch the data.
47		// Checking if we have included items and applying the order is
48		// simpler then keeping track of the sorts and applying them later.
49	5	if ($this->hasIncluded()) {
50	5	$this->included = $this->getIncluded()->sortBy($callback, $options, $descending);
51		}
52
53	5	return $this;
54		}
55		}
56

swisnl / json-api-client

Pull Request — master (#78)

AbstractManyRelation::sortBy() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like