Guillermoandrae\Common\Collection

Complexity

Total Complexity

17

Size/Duplication

Total Lines	133
Duplicated Lines	0 %

Test Coverage

Coverage

100%

Importance

Changes	3
Bugs	0	Features	0

15 Methods

Rating	Name	Duplication	Size	Complexity
A	__toString()	0	3	1
A	count()	0	3	1
A	shuffle()	0	5	1
A	limit()	0	3	1
A	make()	0	3	1
A	toJson()	0	3	1
A	first()	0	3	1
A	last()	0	4	1
A	random()	0	4	1
A	filter()	0	3	1
A	toArray()	0	5	2
A	all()	0	3	1
A	sortBy()	0	10	2
A	isEmpty()	0	3	1
A	map()	0	3	1

<?php

namespace Guillermoandrae\Common;

final class Collection extends AbstractAggregate implements CollectionInterface
{
    /**
     * {@inheritDoc}
     */
    public static function make(array $items = []): CollectionInterface
    {
        return new Collection($items);
    }

    /**
     * {@inheritDoc}
     */
    public function all(): array
    {
        return $this->items;
    }

    /**
     * {@inheritDoc}
     */
    public function first(): mixed
    {
        return $this->items[0];
    }

    /**
     * {@inheritDoc}
     */
    public function last(): mixed
    {
        $key = array_key_last($this->items);
        return $this->items[$key];
    }

    /**
     * {@inheritDoc}
     */
    public function random(): mixed
    {
        $key = array_rand($this->items);
        return $this->get($key);
    }

    /**
     * {@inheritDoc}
     */
    public function sortBy(string $fieldName, bool $reverse = false): CollectionInterface
    {
        $results = $this->items;
        usort($results, static function ($item1, $item2) use ($fieldName) {
            return $item1[$fieldName] <=> $item2[$fieldName];
        });
        if ($reverse) {
            $results = array_reverse($results);
        }
        return new Collection($results);
    }

    /**
     * {@inheritDoc}
     */
    public function count(): int
    {
        return count($this->items);
    }

    /**
     * {@inheritDoc}
     */
    public function isEmpty(): bool
    {
        return empty($this->items);
    }

    /**
     * {@inheritDoc}
     */
    public function shuffle(): CollectionInterface
    {
        $items = $this->items;
        shuffle($items);
        return new Collection($items);
    }

    /**
     * {@inheritDoc}
     */
    public function limit(int $offset = 0, ?int $limit = null): CollectionInterface
    {
        return new Collection(array_slice($this->items, $offset, $limit));
    }

    /**
     * {@inheritDoc}
     */
    public function filter(callable $callback): CollectionInterface
    {
        return new Collection(array_filter($this->items, $callback));
    }

    /**
     * {@inheritDoc}
     */
    public function map(callable $callback): CollectionInterface
    {
        return new Collection(array_map($callback, $this->items));
    }

    /**
     * {@inheritDoc}
     */
    public function toArray(): array
    {
        return array_map(static function ($value) {
            return $value instanceof ArrayableInterface ? $value->toArray() : $value;
        }, $this->items);
    }

    /**
     * {@inheritDoc}
     */
    public function toJson(): string
    {
        return json_encode($this->toArray());
    }

    /**
     * {@inheritDoc}
     */
    public function __toString(): string
    {
        return $this->toJson();
    }
}