gdbots/ncr-php

<?php
declare(strict_types=1);

namespace Gdbots\Ncr;

use Gdbots\Ncr\Enum\IndexQueryFilterOperator;
use Gdbots\Pbj\SchemaQName;

final class IndexQueryBuilder
{
    private SchemaQName $qname;
    private string $alias;
    private string $value;

    /**
     * The number of NodeRefs to fetch in this query.
     *
     * @var int
     */
    private int $count = 25;

    /**
     * When paging/scrolling through results, use this value to
     * determine the next set of data to load.  Assumed to be an
     * exclusive value, as in, load data "after" this cursor.
     *
     * @var string|null
     */
    private ?string $cursor = null;

    /**
     * When true, the index (if it supports it), will be sorted
     * in ascending order.  The sort key is determined by the
     * index itself.
     *
     * @var bool
     */
    private bool $sortAsc = true;

    /**
     * An array of filters to use when running this query.
     * The filters are comparisons against fields in the index
     * which may or may not be fields on the actual nodes
     * because an index may derive its own values (composite keys).
     *
     * @var IndexQueryFilter[]
     */
    private array $filters = [];

    public function __construct(SchemaQName $qname, string $alias, string $value)
    {
        $this->qname = $qname;
        $this->alias = $alias;
        $this->value = $value;
    }

    public static function create(SchemaQName $qname, string $alias, string $value): self
    {
        return new self($qname, $alias, $value);
    }

    public function setQName(SchemaQName $qname): self
    {
        $this->qname = $qname;
        return $this;
    }

    public function setAlias(string $alias): self
    {
        $this->alias = $alias;
        return $this;
    }

    public function setValue(string $value): self
    {
        $this->value = $value;
        return $this;
    }

    public function setCount(int $count = 25): self
    {
        $this->count = $count;
        return $this;
    }

    public function setCursor(?string $cursor = null): self
    {
        $this->cursor = $cursor;
        return $this;
    }

    public function sortAsc(bool $sortAsc = true): self
    {
        $this->sortAsc = $sortAsc;
        return $this;
    }

    public function filterEq(string $field, $value): self
    {
        $this->filters[] = new IndexQueryFilter($field, IndexQueryFilterOperator::EQUAL_TO, $value);
        return $this;
    }

    public function filterNe(string $field, $value): self
    {
        $this->filters[] = new IndexQueryFilter($field, IndexQueryFilterOperator::NOT_EQUAL_TO, $value);
        return $this;
    }

    public function filterGt(string $field, $value): self
    {
        $this->filters[] = new IndexQueryFilter($field, IndexQueryFilterOperator::GREATER_THAN, $value);
        return $this;
    }

    public function filterGte(string $field, $value): self
    {
        $this->filters[] = new IndexQueryFilter($field, IndexQueryFilterOperator::GREATER_THAN_OR_EQUAL_TO, $value);
        return $this;
    }

    public function filterLt(string $field, $value): self
    {
        $this->filters[] = new IndexQueryFilter($field, IndexQueryFilterOperator::LESS_THAN, $value);
        return $this;
    }

    public function filterLte(string $field, $value): self
    {
        $this->filters[] = new IndexQueryFilter($field, IndexQueryFilterOperator::LESS_THAN_OR_EQUAL_TO, $value);
        return $this;
    }

    public function addFilter(IndexQueryFilter $filter): self
    {
        $this->filters[] = $filter;
        return $this;
    }

    public function clearFilters(): self
    {
        $this->filters = [];
        return $this;
    }

    public function build(): IndexQuery
    {
        return new IndexQuery(
            $this->qname,
            $this->alias,
            $this->value,
            $this->count,
            $this->cursor,
            $this->sortAsc,
            $this->filters
        );
    }
}