Level23\Druid\Aggregations\FilteredAggregator

Complexity

Total Complexity

2

Size/Duplication

Total Lines	29
Duplicated Lines	0 %

Test Coverage

Coverage

100%

Importance

Changes

0

2 Methods

Rating	Name	Duplication	Size	Complexity
A	__construct()	0	4	1
A	toArray()	0	6	1

<?php
declare(strict_types=1);

namespace Level23\Druid\Aggregations;

use Level23\Druid\Filters\FilterInterface;

/**
 * Class FilteredAggregator
 *
 * A filtered aggregator wraps any given aggregator,
 * but only aggregates the values for which the given dimension filter matches.
 *
 * This makes it possible to compute the results of a filtered and an unfiltered
 * aggregation simultaneously, without having to issue multiple queries,
 * and use both results as part of post-aggregations.
 *
 * Note: If only the filtered results are required,
 * consider putting the filter on the query itself, which will be much faster since
 * it does not require scanning all the data.
 *
 * @package Level23\Druid\Aggregations
 */
class FilteredAggregator implements AggregatorInterface
{
    protected AggregatorInterface $aggregator;

    protected FilterInterface $filter;

    /**
     * CountAggregator constructor.
     *
     * @param \Level23\Druid\Filters\FilterInterface          $filter
     * @param \Level23\Druid\Aggregations\AggregatorInterface $aggregator
     */
    public function __construct(FilterInterface $filter, AggregatorInterface $aggregator)
    {
        $this->filter     = $filter;
        $this->aggregator = $aggregator;
    }

    /**
     * Return the aggregator as it can be used in a druid query.
     *
     * @return array<string,string|array<mixed>>
     */
    public function toArray(): array
    {
        return [
            'type'       => 'filtered',
            'filter'     => $this->filter->toArray(),
            'aggregator' => $this->aggregator->toArray(),
        ];
    }
}