Serializer - Code Metrics - Inspection of "Merge pull request #7 from zarathustra323/paginati..." - as3io/modlr-api-jsonapiorg - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( f3b184...faf8e5 )

by Jacob

created 2016-04-26 19:37 UTC

Serializer B

↳ Parent: Project

Complexity

Total Complexity

Size/Duplication

Total Lines	330
Duplicated Lines	6.67 %

Coupling/Cohesion

Components	1
Dependencies	10

Importance

Changes	3
Bugs	0	Features	1

Metric	Value
wmc	50
c	3
b	0
f	1
lcom	1
cbo	10
dl	22
loc	330
rs	8.6206

16 Methods

Rating	Name	Duplication	Size	Complexity
A	serialize()	0	8	3
A	serializeCollection()	0	4	1
B	serializeArray()	0	12	5
A	serializeError()	0	8	1
B	appendPaginationLinks()	8	37	4
C	serializeModel()	14	43	8
B	serializeAttribute()	0	14	6
A	serializeEmbed()	0	8	2
B	serializeEmbedOne()	0	15	5
A	serializeEmbedMany()	0	11	3
B	serializeRelationship()	0	20	5
A	serializeHasMany()	0	7	2
A	serializeHasOne()	0	4	1
A	encode()	0	4	1
A	increaseDepth()	0	5	1
A	decreaseDepth()	0	7	2

How to fix Duplicated Code Complexity

Duplicated Code

Duplicate code is one of the most pungent code smells. A rule that is often used is to re-structure code once it is duplicated in three or more places.

Common duplication problems, and corresponding solutions are:

If you have the same expression in different places: Extract expression to a method
If you have the same method in different sub-classes: Extract method, and pull up field to the parent class
If you have the same code in unrelated classes: Consider extracting the code to a new class, and injecting that class

Complex Class

Tip: Before tackling complexity, make sure that you eliminate any duplication first. This often can reduce the size of classes significantly.

Complex classes like Serializer often do a lot of different things. To break such a class down, we need to identify a cohesive component within that class. A common approach to find such a component is to look for fields/methods that share the same prefixes, or suffixes. You can also have a look at the cohesion graph to spot any un-connected, or weakly-connected components.

Once you have determined the fields that belong together, you can apply the Extract Class refactoring. If the component makes sense as a sub-class, Extract Subclass is also a candidate, and is often faster.

While breaking up the class, it is a good idea to analyze how other classes use Serializer, and based on these observations, apply Extract Interface, too.

<?php

namespace As3\Modlr\Api\JsonApiOrg;

use As3\Modlr\Api\AdapterInterface;
use As3\Modlr\Api\SerializerException;
use As3\Modlr\Api\SerializerInterface;
use As3\Modlr\Metadata\AttributeMetadata;
use As3\Modlr\Metadata\EmbeddedPropMetadata;
use As3\Modlr\Metadata\EmbedMetadata;
use As3\Modlr\Metadata\RelationshipMetadata;
use As3\Modlr\Models\Collections\Collection;
use As3\Modlr\Models\Collections\EmbedCollection;
use As3\Modlr\Models\Embed;
use As3\Modlr\Models\Model;

/**
 * Serializes Models into the JSON API spec.
 * www.jsonapi.org
 *
 * @author Jacob Bare <[email protected]>
 */
final class Serializer implements SerializerInterface
{
    /**
     * Denotes the current object depth of the serializer.
     *
     * @var int
     */
    private $depth = 0;

    /**
     * {@inheritDoc}
     */
    public function serialize(Model $model = null, AdapterInterface $adapter)
    {
        $serialized['data'] = null;
foreach ($collection as $item) {
    $myArray['foo'] = $item->getFoo();

    if ($item->hasBar()) {
        $myArray['bar'] = $item->getBar();
    }

    // do something with $myArray
}
        if (null !== $model) {
            $serialized['data'] = $this->serializeModel($model, $adapter);
        }
        return (0 === $this->depth) ? $this->encode($serialized) : $serialized;
    }

    /**
     * {@inheritDoc}
     */
    public function serializeCollection(Collection $collection, AdapterInterface $adapter)
    {
        return $this->serializeArray($collection->allWithoutLoad(), $adapter, $collection->getTotalCount());
    }

    /**
     * {@inheritDoc}
     */
    public function serializeArray(array $models, AdapterInterface $adapter, $totalCount = null)
    {
        $serialized = [];
        if (0 === $this->depth && !empty($totalCount)) {
            $serialized = $this->appendPaginationLinks($adapter, $totalCount, $serialized);
        }
        $serialized['data'] = [];
        foreach ($models as $model) {
            $serialized['data'][] = $this->serializeModel($model, $adapter);
        }
        return (0 === $this->depth) ? $this->encode($serialized) : $serialized;
    }

    /**
     * {@inheritDoc}
     */
    public function serializeError($title, $message, $httpCode)
    {
        return $this->encode([
            'errors'    => [
                ['status' => (String) $httpCode, 'title' => $title, 'detail' => $message],
            ],
        ]);
    }

    /**
     * Appends the pagination links to the serialized data.
     *
     * @param   AdapterInterface    $adapter
     * @param   int                 $totalCount
     * @param   array               $serialized
     * @return  array
     */
    protected function appendPaginationLinks(AdapterInterface $adapter, $totalCount, array $serialized)
    {
        $totalCount = (Integer) $totalCount;
        $original = $adapter->getRequest();
        $pagination = $original->getPagination();
        $displayed = ($pagination['offset'] + 1) * $pagination['limit'];

        $request = clone $adapter->getRequest();
        if (false === $request->hasPagination()) {
            return $serialized;
        }

        // first
        $request->setPagination(0, $pagination['limit']);
        $first = $request->getUrl();

        // last
        $lastOffset = floor($totalCount / $pagination['limit']);
        $request->setPagination($lastOffset * $pagination['limit'], $pagination['limit']);
        $last = $request->getUrl();

        // prev
        $prev = null;
        if ($pagination['offset'] > 0) {

            $request->setPagination($pagination['offset'] - $pagination['limit'], $pagination['limit']);
            $prev = $request->getUrl();
        }

        // next
        $next = null;
        if ($displayed < $totalCount) {

            $request->setPagination(($pagination['offset'] + 1) * $pagination['limit'], $pagination['limit']);
            $next = $request->getUrl();
        }
        $serialized['links'] = ['first' => $first, 'last' => $last, 'prev' => $prev, 'next' => $next];
        return $serialized;
    }

    /**
     * Serializes the "interior" of a model.
     * This is the serialization that takes place outside of a "data" container.
     * Can be used for root model and relationship model serialization.
     *
     * @param   Model               $model
     * @param   AdapterInterface    $adapter
     * @return  array
     */
    protected function serializeModel(Model $model, AdapterInterface $adapter)
    {
        $metadata = $model->getMetadata();
        $serialized = [
            'type'  => $model->getType(),
            'id'    => $model->getId(),
        ];
        if ($this->depth > 0) {
            // $this->includeResource($resource);

            return $serialized;
        }

        foreach ($metadata->getAttributes() as $key => $attrMeta) {

            if (false === $attrMeta->shouldSerialize()) {
                continue;
            }
            $value = $model->get($key);
            $serialized['attributes'][$key] = $this->serializeAttribute($value, $attrMeta);
        }

        foreach ($metadata->getEmbeds() as $key => $embeddedPropMeta) {

            if (false === $attrMeta->shouldSerialize()) {
foreach ($a as $b) {
}

// $b is defined here only if $a has elements, for example if $a is array()
// then $b would not be defined here. To avoid that, we recommend to set a
// default value for $b.


// Better
$b = 0; // or whatever default makes sense in your context
foreach ($a as $b) {
}

// $b is now guaranteed to be defined here.
                continue;
            }
            $value = $model->get($key);
            $serialized['attributes'][$key] = $this->serializeEmbed($value, $embeddedPropMeta);
        }

        $serialized['links'] = ['self' => $adapter->buildUrl($metadata, $model->getId())];

        $model->enableCollectionAutoInit(false);
        $this->increaseDepth();
        foreach ($metadata->getRelationships() as $key => $relMeta) {
            if (false === $attrMeta->shouldSerialize()) {
                continue;
            }
            $relationship = $model->get($key);
            $serialized['relationships'][$key] = $this->serializeRelationship($model, $relationship, $relMeta, $adapter);
        }
        $this->decreaseDepth();
        $model->enableCollectionAutoInit(true);
        return $serialized;
    }

    /**
     * Serializes an attribute value.
     *
     * @param   mixed               $value
     * @param   AttributeMetadata   $attrMeta
     * @return  mixed
     */
    protected function serializeAttribute($value, AttributeMetadata $attrMeta)
    {
        if ('date' === $attrMeta->dataType && $value instanceof \DateTime) {
            $milliseconds = sprintf('%03d', round($value->format('u') / 1000, 0));
            return gmdate(sprintf('Y-m-d\TH:i:s.%s\Z', $milliseconds), $value->getTimestamp());
        }
        if ('array' === $attrMeta->dataType && empty($value)) {
            return [];
        }
        if ('object' === $attrMeta->dataType) {
            return (array) $value;
        }
        return $value;
    }

    /**
     * Serializes an embed value.
     *
     * @param   Embed|EmbedCollection|null  $value
     * @param   EmbeddedPropMetadata        $embeddedPropMeta
     * @return  array|null
     */
    protected function serializeEmbed($value, EmbeddedPropMetadata $embeddedPropMeta)
    {
        $embedMeta = $embeddedPropMeta->embedMeta;
        if (true === $embeddedPropMeta->isOne()) {
            return $this->serializeEmbedOne($embedMeta, $value);
        }
        return $this->serializeEmbedMany($embedMeta, $value);
    }

    /**
     * Serializes an embed one value.
     *
     * @param   EmbedMetadata   $embedMeta
     * @param   Embed|null      $embed
     * @return  array|null
     */
    protected function serializeEmbedOne(EmbedMetadata $embedMeta, Embed $embed = null)
    {
        if (null === $embed) {
            return;
        }
        $serialized = [];
        foreach ($embedMeta->getAttributes() as $key => $attrMeta) {
            $serialized[$key] = $this->serializeAttribute($embed->get($key), $attrMeta);
        }
        foreach ($embedMeta->getEmbeds() as $key => $embeddedPropMeta) {
            $serialized[$key] = $this->serializeEmbed($embed->get($key), $embeddedPropMeta);
        }

        return empty($serialized) ? null : $serialized;
    }

    /**
     * Serializes an embed many value.
     *
     * @param   EmbedMetadata   $embedMeta
     * @param   EmbedCollection $embed
/**
 * @param array $germany
 * @param array $island
 * @param array $italy
 */
function finale($germany, $island) {
    return "2:1";
}
     * @return  array
     */
    protected function serializeEmbedMany(EmbedMetadata $embedMeta, EmbedCollection $collection)
    {
        $serialized = [];
        foreach ($collection as $embed) {
            if (!$embed instanceof Embed) {
                continue;
            }
            $serialized[] = $this->serializeEmbedOne($embedMeta, $embed);
        }
        return $serialized;
    }

    /**
     * Serializes a relationship value
     *
     * @param   Model                       $owner
     * @param   Model|Model[]|null          $relationship
     * @param   RelationshipMetadata        $relMeta
     * @param   AdapterInterface            $adapter
     * @return  array
     */
    protected function serializeRelationship(Model $owner, $relationship = null, RelationshipMetadata $relMeta, AdapterInterface $adapter)
    {
        if ($relMeta->isOne()) {
            if (is_array($relationship)) {
                throw SerializerException::badRequest('Invalid relationship value.');
            }
            $serialized = $this->serializeHasOne($owner, $relationship, $adapter);
        } elseif (is_array($relationship) || null === $relationship) {
            $serialized = $this->serializeHasMany($owner, $relationship, $adapter);

        } else {
            throw SerializerException::badRequest('Invalid relationship value.');
        }

        $ownerMeta = $owner->getMetadata();
        $serialized['links'] = [
            'self'      => $adapter->buildUrl($ownerMeta, $owner->getId(), $relMeta->getKey()),
            'related'   => $adapter->buildUrl($ownerMeta, $owner->getId(), $relMeta->getKey(), true),
        ];
        return $serialized;
    }

    /**
     * Serializes a has-many relationship value
     *
     * @param   Model                   $owner
     * @param   Model[]|null            $models
     * @param   AdapterInterface        $adapter
     * @return  array
     */
    protected function serializeHasMany(Model $owner, array $models = null, AdapterInterface $adapter)

    {
        if (empty($models)) {
            return $this->serialize(null, $adapter);
        }
        return $this->serializeArray($models, $adapter);
    }

    /**
     * Serializes a has-one relationship value
     *
     * @param   Model                   $owner
     * @param   Model|null              $model
     * @param   AdapterInterface        $adapter
     * @return  array
     */
    protected function serializeHasOne(Model $owner, Model $model = null, AdapterInterface $adapter)

    {
        return $this->serialize($model, $adapter);
    }

    /**
     * Encodes the formatted payload array.
     *
     * @param   array   $payload
     * @return  string
     */
    private function encode(array $payload)
    {
        return json_encode($payload);
    }

    /**
     * Increases the serializer depth.
     *
     * @return  self
     */
    protected function increaseDepth()
    {
        $this->depth++;
        return $this;
    }

    /**
     * Decreases the serializer depth.
     *
     * @return  self
     */
    protected function decreaseDepth()
    {
        if ($this->depth > 0) {
            $this->depth--;
        }
        return $this;
    }
}


1		<?php
2
3		namespace As3\Modlr\Api\JsonApiOrg;
4
5		use As3\Modlr\Api\AdapterInterface;
6		use As3\Modlr\Api\SerializerException;
7		use As3\Modlr\Api\SerializerInterface;
8		use As3\Modlr\Metadata\AttributeMetadata;
9		use As3\Modlr\Metadata\EmbeddedPropMetadata;
10		use As3\Modlr\Metadata\EmbedMetadata;
11		use As3\Modlr\Metadata\RelationshipMetadata;
12		use As3\Modlr\Models\Collections\Collection;
13		use As3\Modlr\Models\Collections\EmbedCollection;
14		use As3\Modlr\Models\Embed;
15		use As3\Modlr\Models\Model;
16
17		/**
18		* Serializes Models into the JSON API spec.
19		* www.jsonapi.org
20		*
21		* @author Jacob Bare <[email protected]>
22		*/
23		final class Serializer implements SerializerInterface
24		{
25		/**
26		* Denotes the current object depth of the serializer.
27		*
28		* @var int
29		*/
30		private $depth = 0;
31
32		/**
33		* {@inheritDoc}
34		*/
35		public function serialize(Model $model = null, AdapterInterface $adapter)
36		{
37		$serialized['data'] = null;
		0 ignored issues – show Coding Style Comprehensibility introduced 2016-03-14 15:49 UTC by Report Bug Copy Issue Report `$serialized` was never initialized. Although not strictly required by PHP, it is generally a good practice to add `$serialized = array();` before regardless. Adding an explicit array definition is generally preferable to implicit array definition as it guarantees a stable state of the code. Let’s take a look at an example: foreach ($collection as $item) { $myArray['foo'] = $item->getFoo(); if ($item->hasBar()) { $myArray['bar'] = $item->getBar(); } // do something with $myArray } As you can see in this example, the array `$myArray` is initialized the first time when the foreach loop is entered. You can also see that the value of the `bar` key is only written conditionally; thus, its value might result from a previous iteration. This might or might not be intended. To make your intention clear, your code more readible and to avoid accidental bugs, we recommend to add an explicit initialization `$myArray = array()` either outside or inside the foreach loop. Loading history...
38		if (null !== $model) {
39		$serialized['data'] = $this->serializeModel($model, $adapter);
40		}
41		return (0 === $this->depth) ? $this->encode($serialized) : $serialized;
42		}
43
44		/**
45		* {@inheritDoc}
46		*/
47		public function serializeCollection(Collection $collection, AdapterInterface $adapter)
48		{
49		return $this->serializeArray($collection->allWithoutLoad(), $adapter, $collection->getTotalCount());
50		}
51
52		/**
53		* {@inheritDoc}
54		*/
55		public function serializeArray(array $models, AdapterInterface $adapter, $totalCount = null)
56		{
57		$serialized = [];
58		if (0 === $this->depth && !empty($totalCount)) {
59		$serialized = $this->appendPaginationLinks($adapter, $totalCount, $serialized);
60		}
61		$serialized['data'] = [];
62		foreach ($models as $model) {
63		$serialized['data'][] = $this->serializeModel($model, $adapter);
64		}
65		return (0 === $this->depth) ? $this->encode($serialized) : $serialized;
66		}
67
68		/**
69		* {@inheritDoc}
70		*/
71		public function serializeError($title, $message, $httpCode)
72		{
73		return $this->encode([
74		'errors' => [
75		['status' => (String) $httpCode, 'title' => $title, 'detail' => $message],
76		],
77		]);
78		}
79
80		/**
81		* Appends the pagination links to the serialized data.
82		*
83		* @param AdapterInterface $adapter
84		* @param int $totalCount
85		* @param array $serialized
86		* @return array
87		*/
88		protected function appendPaginationLinks(AdapterInterface $adapter, $totalCount, array $serialized)
89		{
90		$totalCount = (Integer) $totalCount;
91		$original = $adapter->getRequest();
92		$pagination = $original->getPagination();
93		$displayed = ($pagination['offset'] + 1) * $pagination['limit'];
94
95		$request = clone $adapter->getRequest();
96		if (false === $request->hasPagination()) {
97		return $serialized;
98		}
99
100		// first
101		$request->setPagination(0, $pagination['limit']);
102		$first = $request->getUrl();
103
104		// last
105		$lastOffset = floor($totalCount / $pagination['limit']);
106		$request->setPagination($lastOffset * $pagination['limit'], $pagination['limit']);
107		$last = $request->getUrl();
108
109		// prev
110		$prev = null;
111	View Code Duplication	if ($pagination['offset'] > 0) {
		0 ignored issues – show Duplication introduced 2016-04-26 19:36 UTC by Report Bug Copy Issue Report This code seems to be duplicated across your project. Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation. You can also find more detailed suggestions in the “Code” section of your repository. Loading history...
112		$request->setPagination($pagination['offset'] - $pagination['limit'], $pagination['limit']);
113		$prev = $request->getUrl();
114		}
115
116		// next
117		$next = null;
118	View Code Duplication	if ($displayed < $totalCount) {
		0 ignored issues – show Duplication introduced 2016-04-26 19:36 UTC by Report Bug Copy Issue Report This code seems to be duplicated across your project. Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation. You can also find more detailed suggestions in the “Code” section of your repository. Loading history...
119		$request->setPagination(($pagination['offset'] + 1) * $pagination['limit'], $pagination['limit']);
120		$next = $request->getUrl();
121		}
122		$serialized['links'] = ['first' => $first, 'last' => $last, 'prev' => $prev, 'next' => $next];
123		return $serialized;
124		}
125
126		/**
127		* Serializes the "interior" of a model.
128		* This is the serialization that takes place outside of a "data" container.
129		* Can be used for root model and relationship model serialization.
130		*
131		* @param Model $model
132		* @param AdapterInterface $adapter
133		* @return array
134		*/
135		protected function serializeModel(Model $model, AdapterInterface $adapter)
136		{
137		$metadata = $model->getMetadata();
138		$serialized = [
139		'type' => $model->getType(),
140		'id' => $model->getId(),
141		];
142		if ($this->depth > 0) {
143		// $this->includeResource($resource);
		0 ignored issues – show Unused Code Comprehensibility introduced 2016-03-14 15:49 UTC by Report Bug Copy Issue Report `75%` of this comment could be valid code. Did you maybe forget this after debugging? Sometimes obsolete code just ends up commented out instead of removed. In this case it is better to remove the code once you have checked you do not need it. The code might also have been commented out for debugging purposes. In this case it is vital that someone uncomments it again or your project may behave in very unexpected ways in production. This check looks for comments that seem to be mostly valid code and reports them. Loading history...
144		return $serialized;
145		}
146
147	View Code Duplication	foreach ($metadata->getAttributes() as $key => $attrMeta) {
		0 ignored issues – show Duplication introduced 2016-04-26 19:36 UTC by Report Bug Copy Issue Report This code seems to be duplicated across your project. Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation. You can also find more detailed suggestions in the “Code” section of your repository. Loading history...
148		if (false === $attrMeta->shouldSerialize()) {
149		continue;
150		}
151		$value = $model->get($key);
152		$serialized['attributes'][$key] = $this->serializeAttribute($value, $attrMeta);
153		}
154
155	View Code Duplication	foreach ($metadata->getEmbeds() as $key => $embeddedPropMeta) {
		0 ignored issues – show Duplication introduced 2016-04-26 19:36 UTC by Report Bug Copy Issue Report This code seems to be duplicated across your project. Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation. You can also find more detailed suggestions in the “Code” section of your repository. Loading history...
156		if (false === $attrMeta->shouldSerialize()) {
		0 ignored issues – show Bug introduced 2016-04-26 19:36 UTC by Report Bug Copy Issue Report The variable `$attrMeta` seems to be defined by a `foreach` iteration on line `147`. Are you sure the iterator is never empty, otherwise this variable is not defined? It seems like you are relying on a variable being defined by an iteration: foreach ($a as $b) { } // $b is defined here only if $a has elements, for example if $a is array() // then $b would not be defined here. To avoid that, we recommend to set a // default value for $b. // Better $b = 0; // or whatever default makes sense in your context foreach ($a as $b) { } // $b is now guaranteed to be defined here. Loading history...
157		continue;
158		}
159		$value = $model->get($key);
160		$serialized['attributes'][$key] = $this->serializeEmbed($value, $embeddedPropMeta);
161		}
162
163		$serialized['links'] = ['self' => $adapter->buildUrl($metadata, $model->getId())];
164
165		$model->enableCollectionAutoInit(false);
166		$this->increaseDepth();
167		foreach ($metadata->getRelationships() as $key => $relMeta) {
168		if (false === $attrMeta->shouldSerialize()) {
169		continue;
170		}
171		$relationship = $model->get($key);
172		$serialized['relationships'][$key] = $this->serializeRelationship($model, $relationship, $relMeta, $adapter);
173		}
174		$this->decreaseDepth();
175		$model->enableCollectionAutoInit(true);
176		return $serialized;
177		}
178
179		/**
180		* Serializes an attribute value.
181		*
182		* @param mixed $value
183		* @param AttributeMetadata $attrMeta
184		* @return mixed
185		*/
186		protected function serializeAttribute($value, AttributeMetadata $attrMeta)
187		{
188		if ('date' === $attrMeta->dataType && $value instanceof \DateTime) {
189		$milliseconds = sprintf('%03d', round($value->format('u') / 1000, 0));
190		return gmdate(sprintf('Y-m-d\TH:i:s.%s\Z', $milliseconds), $value->getTimestamp());
191		}
192		if ('array' === $attrMeta->dataType && empty($value)) {
193		return [];
194		}
195		if ('object' === $attrMeta->dataType) {
196		return (array) $value;
197		}
198		return $value;
199		}
200
201		/**
202		* Serializes an embed value.
203		*
204		* @param Embed\|EmbedCollection\|null $value
205		* @param EmbeddedPropMetadata $embeddedPropMeta
206		* @return array\|null
207		*/
208		protected function serializeEmbed($value, EmbeddedPropMetadata $embeddedPropMeta)
209		{
210		$embedMeta = $embeddedPropMeta->embedMeta;
211		if (true === $embeddedPropMeta->isOne()) {
212		return $this->serializeEmbedOne($embedMeta, $value);
213		}
214		return $this->serializeEmbedMany($embedMeta, $value);
215		}
216
217		/**
218		* Serializes an embed one value.
219		*
220		* @param EmbedMetadata $embedMeta
221		* @param Embed\|null $embed
222		* @return array\|null
223		*/
224		protected function serializeEmbedOne(EmbedMetadata $embedMeta, Embed $embed = null)
225		{
226		if (null === $embed) {
227		return;
228		}
229		$serialized = [];
230		foreach ($embedMeta->getAttributes() as $key => $attrMeta) {
231		$serialized[$key] = $this->serializeAttribute($embed->get($key), $attrMeta);
232		}
233		foreach ($embedMeta->getEmbeds() as $key => $embeddedPropMeta) {
234		$serialized[$key] = $this->serializeEmbed($embed->get($key), $embeddedPropMeta);
235		}
236
237		return empty($serialized) ? null : $serialized;
238		}
239
240		/**
241		* Serializes an embed many value.
242		*
243		* @param EmbedMetadata $embedMeta
244		* @param EmbedCollection $embed
		0 ignored issues – show Bug introduced 2016-04-19 14:29 UTC by Report Bug Copy Issue Report There is no parameter named `$embed`. Was it maybe removed? This check looks for PHPDoc comments describing methods or function parameters that do not exist on the corresponding method or function. Consider the following example. The parameter `$italy` is not defined by the method `finale(...)`. /** * @param array $germany * @param array $island * @param array $italy */ function finale($germany, $island) { return "2:1"; } The most likely cause is that the parameter was removed, but the annotation was not. Loading history...
245		* @return array
246		*/
247		protected function serializeEmbedMany(EmbedMetadata $embedMeta, EmbedCollection $collection)
248		{
249		$serialized = [];
250		foreach ($collection as $embed) {
251		if (!$embed instanceof Embed) {
252		continue;
253		}
254		$serialized[] = $this->serializeEmbedOne($embedMeta, $embed);
255		}
256		return $serialized;
257		}
258
259		/**
260		* Serializes a relationship value
261		*
262		* @param Model $owner
263		* @param Model\|Model[]\|null $relationship
264		* @param RelationshipMetadata $relMeta
265		* @param AdapterInterface $adapter
266		* @return array
267		*/
268		protected function serializeRelationship(Model $owner, $relationship = null, RelationshipMetadata $relMeta, AdapterInterface $adapter)
269		{
270		if ($relMeta->isOne()) {
271		if (is_array($relationship)) {
272		throw SerializerException::badRequest('Invalid relationship value.');
273		}
274		$serialized = $this->serializeHasOne($owner, $relationship, $adapter);
275		} elseif (is_array($relationship) \|\| null === $relationship) {
276		$serialized = $this->serializeHasMany($owner, $relationship, $adapter);
		0 ignored issues – show Bug introduced 2016-03-14 15:49 UTC by Report Bug Copy Issue Report It seems like `$relationship` defined by parameter `$relationship` on line 268 can also be of type `array`; however, `As3\Modlr\Api\JsonApiOrg...zer::serializeHasMany()` does only seem to accept `null\|array<integer,objec...s3\Modlr\Models\Model>>`, maybe add an additional type check? This check looks at variables that have been passed in as parameters and 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...
277		} else {
278		throw SerializerException::badRequest('Invalid relationship value.');
279		}
280
281		$ownerMeta = $owner->getMetadata();
282		$serialized['links'] = [
283		'self' => $adapter->buildUrl($ownerMeta, $owner->getId(), $relMeta->getKey()),
284		'related' => $adapter->buildUrl($ownerMeta, $owner->getId(), $relMeta->getKey(), true),
285		];
286		return $serialized;
287		}
288
289		/**
290		* Serializes a has-many relationship value
291		*
292		* @param Model $owner
293		* @param Model[]\|null $models
294		* @param AdapterInterface $adapter
295		* @return array
296		*/
297		protected function serializeHasMany(Model $owner, array $models = null, AdapterInterface $adapter)
		0 ignored issues – show Unused Code introduced 2016-03-14 15:49 UTC by Report Bug Copy Issue Report The parameter `$owner` is not used and could be removed. This check looks from parameters that have been defined for a function or method, but which are not used in the method body. Loading history...
298		{
299		if (empty($models)) {
300		return $this->serialize(null, $adapter);
301		}
302		return $this->serializeArray($models, $adapter);
303		}
304
305		/**
306		* Serializes a has-one relationship value
307		*
308		* @param Model $owner
309		* @param Model\|null $model
310		* @param AdapterInterface $adapter
311		* @return array
312		*/
313		protected function serializeHasOne(Model $owner, Model $model = null, AdapterInterface $adapter)
		0 ignored issues – show Unused Code introduced 2016-03-14 15:49 UTC by Report Bug Copy Issue Report The parameter `$owner` is not used and could be removed. This check looks from parameters that have been defined for a function or method, but which are not used in the method body. Loading history...
314		{
315		return $this->serialize($model, $adapter);
316		}
317
318		/**
319		* Encodes the formatted payload array.
320		*
321		* @param array $payload
322		* @return string
323		*/
324		private function encode(array $payload)
325		{
326		return json_encode($payload);
327		}
328
329		/**
330		* Increases the serializer depth.
331		*
332		* @return self
333		*/
334		protected function increaseDepth()
335		{
336		$this->depth++;
337		return $this;
338		}
339
340		/**
341		* Decreases the serializer depth.
342		*
343		* @return self
344		*/
345		protected function decreaseDepth()
346		{
347		if ($this->depth > 0) {
348		$this->depth--;
349		}
350		return $this;
351		}
352		}
353

as3io / modlr-api-jsonapiorg