Neomerx\JsonApi\Encoder\Serialize\ArraySerializerTrait

Complexity

Total Complexity

5

Size/Duplication

Total Lines	54
Duplicated Lines	0 %

Coupling/Cohesion

Components	0
Dependencies	0

Test Coverage

Coverage

100%

Importance

Changes

0

5 Methods

Rating	Name	Duplication	Size	Complexity
A	serializeData()	0	4	1
A	serializeIdentifiers()	0	4	1
A	serializeError()	0	4	1
A	serializeErrors()	0	4	1
A	serializeMeta()	0	4	1

<?php namespace Neomerx\JsonApi\Encoder\Serialize;

/**
 * Copyright 2015-2017 info@neomerx.com
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 * http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

use \Iterator;
use \Neomerx\JsonApi\Exceptions\ErrorCollection;
use \Neomerx\JsonApi\Contracts\Document\ErrorInterface;
use \Neomerx\JsonApi\Contracts\Schema\ContainerInterface as CI;
use \Neomerx\JsonApi\Contracts\Encoder\Parameters\EncodingParametersInterface;

/**
 * @method CI getContainer()
 * @method array encodeDataToArray(CI $container, $data, EncodingParametersInterface $parameters = null)
 * @method array encodeIdentifiersToArray($data, EncodingParametersInterface $parameters = null)
 * @method array encodeErrorToArray(ErrorInterface $error)
 * @method array encodeErrorsToArray($errors)
 * @method array encodeMetaToArray($meta)
 *
 * @package Neomerx\JsonApi
 */
trait ArraySerializerTrait
{
    /**
     * @param object|array|Iterator|null       $data
     * @param EncodingParametersInterface|null $parameters
     *
     * @return array
     */
    public function serializeData($data, EncodingParametersInterface $parameters = null)
    {
        return $this->encodeDataToArray($this->getContainer(), $data, $parameters);

It seems like $parameters defined by parameter $parameters on line 43 can be null; however, Neomerx\JsonApi\Encoder\Serialize\ArraySerializerTrait::encodeDataToArray() does not accept null, maybe add an additional type check?

    }

    /**
     * @param object|array|Iterator|null       $data
     * @param EncodingParametersInterface|null $parameters
     *
     * @return array
     */
    public function serializeIdentifiers($data, EncodingParametersInterface $parameters = null)
    {
        return $this->encodeIdentifiersToArray($data, $parameters);

It seems like $parameters defined by parameter $parameters on line 54 can be null; however, Neomerx\JsonApi\Encoder\Serialize\ArraySerializerTrait::encodeIdentifiersToArray() does not accept null, maybe add an additional type check?

    }

    /**
     * @param ErrorInterface $error
     *
     * @return array
     */
    public function serializeError(ErrorInterface $error)
    {
        return $this->encodeErrorToArray($error);
    }

    /**
     * @param ErrorInterface[]|ErrorCollection $errors
     *
     * @return array
     */
    public function serializeErrors($errors)
    {
        return $this->encodeErrorsToArray($errors);
    }

    /**
     * @param array|object $meta
     *
     * @return array
     */
    public function serializeMeta($meta)
    {
        return $this->encodeMetaToArray($meta);
    }
}