Trucker\Responses\Collection

Complexity

Total Complexity

16

Size/Duplication

Total Lines	159
Duplicated Lines	0 %

Test Coverage

Coverage

100%

Importance

Changes

0

11 Methods

Rating	Name	Duplication	Size	Complexity
A	last()	0	3	2
A	valid()	0	3	1
A	rewind()	0	3	1
A	next()	0	3	1
A	toArray()	0	18	4
A	first()	0	3	2
A	key()	0	3	1
A	__construct()	0	3	1
A	size()	0	3	1
A	current()	0	3	1
A	toJson()	0	3	1

<?php

namespace Trucker\Responses;

/**
 * Collection class returned from CollectionFinder when
 * a colleciton of results is requested.
 *
 * @author Alessandro Manno <alessandromanno96@gmail.com>
 */
class Collection implements \Iterator
{
    /**
     * Var to hold the actual source array collection.
     *
     * @var array
     */
    private $collection;

    /**
     * Associative array of metadata related to the
     * collection.
     *
     * @var array
     */
    public $metaData = [];

    /**
     * Constructor for the collection.
     *
     * @param array $givenArray array of objects
     */
    public function __construct($givenArray)
    {
        $this->collection = $givenArray;
    }

    /**
     * Function to conform with Iterator interface.
     *
     * @see  Iterator
     *
     * @return \Trucker\Resource\Model
     */
    public function rewind()
    {
        return reset($this->collection);
    }

    /**
     * Function to conform with Iterator interface.
     *
     * @see  Iterator
     *
     * @return \Trucker\Resource\Model
     */
    public function current()
    {
        return current($this->collection);
    }

    /**
     * Function to conform with Iterator interface.
     *
     * @see  Iterator
     *
     * @return \Trucker\Resource\Model
     */
    public function key()
    {
        return key($this->collection);

The expression return key($this->collection) also could return the type integer|string which is incompatible with the documented return type Trucker\Resource\Model.

    }

    /**
     * Function to conform with Iterator interface.
     *
     * @see  Iterator
     *
     * @return \Trucker\Resource\Model
     */
    public function next()
    {
        return next($this->collection);
    }

    /**
     * Function to conform with Iterator interface.
     *
     * @see  Iterator
     *
     * @return bool
     */
    public function valid()
    {
        return null !== key($this->collection);
    }

    /**
     * Function to return the size of the collection.
     *
     * @return int size of collection
     */
    public function size()
    {
        return count($this->collection);
    }

    /**
     * Function to return the first item of the collection.
     *
     * @return \Trucker\Resource\Model
     */
    public function first()
    {
        return empty($this->collection) ? null : $this->collection[0];
    }

    /**
     * Function to return the last item of the collection.
     *
     * @return \Trucker\Resource\Model
     */
    public function last()
    {
        return empty($this->collection) ? null : $this->collection[count($this->collection) - 1];
    }

    /**
     * Function to convert the collection to an array using
     * each collection elements attributes.
     *
     * @param string $collectionKey
     * @param string $metaKey
     *
     * @return array
     */
    public function toArray($collectionKey = null, $metaKey = 'meta')
    {
        $entities = [];
        foreach ($this->collection as $entity) {
            $entities[] = $entity->attributes();
        }

        $col = $entities;
        if ($collectionKey) {

The expression $collectionKey of type null|string is loosely compared to true; this is ambiguous if the string can be empty. You might want to explicitly use !== null instead.

            $col = [$collectionKey => $entities];
        }

        $met = [];
        if ($this->metaData) {

The expression $this->metaData of type array is implicitly converted to a boolean; are you sure this is intended? If so, consider using ! empty($expr) instead to make it clear that you intend to check for an array without elements.

            $met = [$metaKey => $this->metaData];
        }

        return array_merge($col, $met);
    }

    /**
     * Function to convert the collection to json using
     * each collection elements attributes as an array then
     * encoding the array to json.
     *
     * @param string $collectionKey
     * @param string $metaKey
     *
     * @return array
     */
    public function toJson($collectionKey = null, $metaKey = 'meta')
    {
        return json_encode($this->toArray($collectionKey, $metaKey));

The expression return json_encode($this->toArray($collectionKey, $metaKey)) returns the type string which is incompatible with the documented return type array.

    }
}//end class