thinktomorrow / vine

src/NodeCollection.php

<?php

namespace Vine;

use Vine\Commands\Shake;
use Vine\Commands\Flatten;
use Vine\Commands\Inflate;
use Vine\Commands\Remove;
use Vine\Commands\Slice;
use Vine\Queries\Find;

class NodeCollection implements \ArrayAccess, \Countable, \IteratorAggregate
{
    /**
     * @var Node[]
     */
    protected $nodes;

    public function __construct(Node ...$nodeCollection)
    {
        $this->nodes = $nodeCollection;
    }

    public function all()
    {
        return $this->nodes;
    }

    public function first()
    {
        if($this->isEmpty()) return null;

        return reset($this->nodes);
    }

    public function isEmpty(): bool
    {
        return empty($this->nodes);
    }

    /**
     * Add one / many nodes to this collection
     *
     * @param Node[] ...$nodes
     * @return $this
     */
    public function add(Node ...$nodes)
    {
        $this->nodes = array_merge($this->nodes, $nodes);

It seems like array_merge($this->nodes, $nodes) of type array<integer,object<Vine\Node>|array<integer,object<Vine\Node>>> is incompatible with the declared type array<integer,object<Vine\Node>> of property $nodes.

        return $this;
    }

    /**
     * Merge a collection into current one.
     *
     * @param NodeCollection $nodeCollection
     * @return $this
     */
    public function merge(self $nodeCollection)
    {
        $this->nodes = array_merge($this->nodes, $nodeCollection->all());

        return $this;
    }

    /**
     * Remove the child node
     *
     * Please note that all descendants of this
     * child node will be removed as well.
     *
     * @param Node $child
     * @return $this
     */
    public function remove(Node $child)
    {
        return (new Remove())($this,$child);
    }

    /**
     * Return flattened list of all nodes in this collection
     *
     * @return NodeCollection
     */
    public function flatten()
    {
        return (new Flatten())($this);
    }

    /**
     * Inflate a flattened collection back to its original structure
     *
     * @return NodeCollection
     */
    public function inflate()
    {
        return (new Inflate())($this);
    }

    /**
     * Slice one or more nodes out of the collection
     *
     * @param Node[] ...$nodes
     * @return mixed
     */
    public function slice(Node ...$nodes)
    {
        return (new Slice())($this, ...$nodes);
    }

    /**
     * Find many nodes by attribute value
     *
     * @param $key
     * @param array $values
     * @return NodeCollection
     */
    public function findMany($key, array $values): self
    {
        return (new Find)($this,$key,$values);
    }

    /**
     * Find specific node by attribute value
     *
     * @param $key
     * @param $value
     * @return Node|null
     */
    public function find($key, $value)
    {
        return (new Find)($this,$key,[$value])->first();
    }

    public function offsetExists($offset)
    {
        if(!is_string($offset) && !is_int($offset)) return false;

        return array_key_exists($offset, $this->nodes);
    }

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

    public function offsetSet($offset, $value)
    {
        if(is_null($offset)) $this->nodes[] = $value;

        else $this->nodes[$offset] = $value;
    }

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

    public function count()
    {
        return count($this->nodes);
    }

    public function getIterator()
    {
        return new \ArrayIterator($this->nodes);
    }
}