WhereGroup.php

<?php

namespace Aternos\Model\Query;

use Countable;
use Iterator;

/**
 * Class WhereConditionGroup
 *
 * @package Aternos\Model\Query
 * @implements Iterator<WhereCondition|WhereGroup>
 */
class WhereGroup implements Iterator, Countable, Validatable
{
    /** @deprecated */
    const Conjunction AND = Conjunction::AND;
    /** @deprecated */
    const Conjunction OR = Conjunction::OR;

    /**
     * Multiple WhereGroup or WhereCondition objects
     *
     * @var (WhereCondition|WhereGroup)[]
     */
    protected array $group = [];

    /**
     * Group iterator
     *
     * @var int
     */
    protected int $iterator = 0;

    /**
     * WhereGroup constructor.
     *
     * @param (WhereCondition|WhereGroup)[] $conditions
     * @param Conjunction $conjunction
     */
    public function __construct(array $conditions = [], public Conjunction $conjunction = Conjunction::AND)
    {
        $this->group = $conditions;
    }

    /**
     * Add an element to the group
     *
     * @param WhereCondition|WhereGroup $conditionOrGroup
     * @return $this
     */
    public function add(WhereCondition|WhereGroup $conditionOrGroup): static
    {
        $this->group[] = $conditionOrGroup;
        return $this;
    }

    /**
     * Get all group elements as array
     *
     * @return (WhereCondition|WhereGroup)[]
     */
    public function getAll(): array
    {
        return $this->group;
    }

    public function validate(): void
    {
        foreach ($this->group as $element) {
            $element->validate();
        }
    }

    /**
     * Return the current element
     *
     * @return WhereGroup|WhereCondition
     */
    public function current(): WhereGroup|WhereCondition
    {
        return $this->group[$this->iterator];
    }

    /**
     * Move forward to next element
     *
     * @return void
     */
    public function next(): void
    {
        $this->iterator++;
    }

    /**
     * Return the key of the current element
     *
     * @return int
     */
    public function key(): int
    {
        return $this->iterator;
    }

    /**
     * Checks if current position is valid
     *
     * @return boolean
     */
    public function valid(): bool
    {
        return array_key_exists($this->iterator, $this->group);
    }

    /**
     * Rewind the Iterator to the first element
     *
     * @return void
     */
    public function rewind(): void
    {
        $this->iterator = 0;
    }

    /**
     * Count elements of an object
     *
     * @return int
     */
    public function count(): int
    {
        return count($this->group);
    }
}