Relationship::jsonSerialize() - Code Metrics - Inspection of "New resource-based API" - tobscure/json-api - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Pull Request — master (#119)

by Toby

created 2017-03-29 10:40 UTC

Relationship::jsonSerialize() A

↳ Parent: Relationship

Complexity

Conditions	3
Paths	3

Size

Total Lines	15
Code Lines	9

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	11
CRAP Score	3

Importance

Changes

Metric	Value
dl	0
loc	15
ccs	11
cts	11
cp	1
rs	9.4285
c	0
b	0
f	0
cc	3
eloc	9
nc	3
nop	0
crap	3

<?php

/*
 * This file is part of JSON-API.
 *
 * (c) Toby Zerner <[email protected]>
 *
 * For the full copyright and license information, please view the LICENSE
 * file that was distributed with this source code.
 */

namespace Tobscure\JsonApi;

use JsonSerializable;

class Relationship implements JsonSerializable
{
    use LinksTrait, SelfLinkTrait, RelatedLinkTrait, PaginationLinksTrait, MetaTrait;

    private $data;

    private function __construct()
    {
    }

    public static function fromMeta($meta)
    {
        $r = new self;
        $r->replaceMeta($meta);


        return $r;
    }

    public static function fromSelfLink($link)
    {
        $r = new self;
        $r->setSelfLink($link);

        return $r;
    }

    public static function fromRelatedLink($link)
    {
        $r = new self;
        $r->setRelatedLink($link);

        return $r;
    }

    public static function fromData($data)
    {
        $r = new self;
        $r->data = $data;

        return $r;
    }

    public function getData()

    {
        return $this->data;
    }

    public function setData($data)
    {
        $this->data = $data;
    }

    public function jsonSerialize()
    {
        $relationship = [];

        if ($this->data) {
            $relationship['data'] = is_array($this->data)
                ? array_map([$this, 'buildIdentifier'], $this->data)
                : $this->buildIdentifier($this->data);
        }

        return array_filter($relationship + [
            'meta' => $this->meta,
            'links' => $this->links
        ]);
    }

    private function buildIdentifier(ResourceInterface $resource)
    {
        $id = new ResourceIdentifier($resource->getType(), $resource->getId());
        $id->setMeta($resource->getMeta());


        return $id;
    }
}


1		<?php
2
3		/*
4		* This file is part of JSON-API.
5		*
6		* (c) Toby Zerner <[email protected]>
7		*
8		* For the full copyright and license information, please view the LICENSE
9		* file that was distributed with this source code.
10		*/
11
12		namespace Tobscure\JsonApi;
13
14		use JsonSerializable;
15
16		class Relationship implements JsonSerializable
17		{
18		use LinksTrait, SelfLinkTrait, RelatedLinkTrait, PaginationLinksTrait, MetaTrait;
19
20		private $data;
21
22	6	private function __construct()
23		{
24	6	}
25
26		public static function fromMeta($meta)
27		{
28		$r = new self;
29		$r->replaceMeta($meta);
		0 ignored issues – show Bug introduced 2017-03-29 10:41 UTC by Report Bug Copy Issue Report The method `replaceMeta()` does not seem to exist on `object<Tobscure\JsonApi\Relationship>`. This check looks for calls to methods that do not seem to exist on a given type. It looks for the method on the type itself as well as in inherited classes or implemented interfaces. This is most likely a typographical error or the method has been renamed. Loading history...
30
31		return $r;
32		}
33
34		public static function fromSelfLink($link)
35		{
36		$r = new self;
37		$r->setSelfLink($link);
38
39		return $r;
40		}
41
42		public static function fromRelatedLink($link)
43		{
44		$r = new self;
45		$r->setRelatedLink($link);
46
47		return $r;
48		}
49
50	6	public static function fromData($data)
51		{
52	6	$r = new self;
53	6	$r->data = $data;
54
55	6	return $r;
56		}
57
58		public function getData()
		0 ignored issues – show Documentation introduced 2017-03-29 10:41 UTC by Report Bug Copy Issue Report The return type could not be reliably inferred; please add a `@return` annotation. Our type inference engine in quite powerful, but sometimes the code does not provide enough clues to go by. In these cases we request you to add a `@return` annotation as described here. Loading history...
59		{
60		return $this->data;
61		}
62
63		public function setData($data)
64		{
65		$this->data = $data;
66		}
67
68	3	public function jsonSerialize()
69		{
70	3	$relationship = [];
71
72	3	if ($this->data) {
73	3	$relationship['data'] = is_array($this->data)
74	3	? array_map([$this, 'buildIdentifier'], $this->data)
75	3	: $this->buildIdentifier($this->data);
76	3	}
77
78	3	return array_filter($relationship + [
79	3	'meta' => $this->meta,
80	3	'links' => $this->links
81	3	]);
82		}
83
84	3	private function buildIdentifier(ResourceInterface $resource)
85		{
86	3	$id = new ResourceIdentifier($resource->getType(), $resource->getId());
87	3	$id->setMeta($resource->getMeta());
		0 ignored issues – show Bug introduced 2017-03-29 10:41 UTC by Report Bug Copy Issue Report It seems like `$resource->getMeta()` targeting `Tobscure\JsonApi\ResourceInterface::getMeta()` can also be of type `null`; however, `Tobscure\JsonApi\MetaTrait::setMeta()` does only seem to accept `array`, maybe add an additional type check? This check looks at variables that are passed out again to other methods. If the outgoing method call has stricter type requirements than the method itself, an issue is raised. An additional type check may prevent trouble. Loading history...
88
89	3	return $id;
90		}
91		}
92

tobscure / json-api

Pull Request — master (#119)

Relationship::jsonSerialize() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like