EntityList.php

<?php

namespace DevMakerLab;

use Closure;
use Countable;
use ArrayAccess;
use ArrayIterator;
use IteratorAggregate;

abstract class EntityList implements Countable, ArrayAccess, IteratorAggregate
{
    protected array $entities = [];

    public function __construct(array $entities)
    {
        foreach ($entities as $entity) {
            $this->add($entity);
        }
    }

    public function add(Entity $entity, $offset = null): void
    {
        if (is_null($offset)) {
            $this->entities[] = $entity;
        } else {
            $this->entities[$offset] = $entity;
        }
    }

    public function all(): array
    {
        return $this->entities;
    }

    public function count(): int
    {
        return count($this->entities);
    }

    public function toArray(): array
    {
        return array_map(function (Entity $entity) {
            return $entity->toArray();
        }, $this->entities);
    }

    public function toJson(int $options = 0)
    {
        return json_encode($this->toArray(), $options);
    }

    public function offsetExists($offset): bool
    {
        return array_key_exists($offset, $this->entities);
    }

    public function offsetGet($offset)
    {
        return $this->entities[$offset];
    }

    public function offsetSet($offset, $value)
    {
        $this->add($value, $offset);
    }

    public function offsetUnset($offset)
    {
        unset($this->entities[$offset]);
    }

    public function getIterator(): ArrayIterator
    {
        return new ArrayIterator($this->entities);
    }

    public function sortBy(string $property): self
    {
        usort($this->entities, function($a, $b) use ($property) {
            return $a->{$property} > $b->{$property} ? 1 : -1;
        });

        return $this;
    }

    public function only(...$keys): array
    {
        $items = [];
        foreach ($this->entities as $entity) {
            $result = array_intersect_key((array)$entity, array_flip($keys));
            if (! empty($result)) {
                $items[] = $result;
            }
        }

        return $items;
    }

    /**
     * @param mixed|Closure
     * @param ?mixed $value
     */
    public function filter($key, $value = null): array
    {
        $callable = is_callable($key)
            ? $key
            : function (Entity $entity) use ($key, $value) {
                return $entity->{$key} === $value;
            };

        return array_filter($this->entities, $callable);
    }

    public function pluck(string $key): array
    {
        return array_column($this->entities, $key);
    }

    public function groupBy(string $key): array
    {
        $group = [];
        foreach ($this->entities as $entity) {
            $group[$entity->{$key}][] = $entity;
        }

        return $group;
    }
}