Level23\Druid\PostAggregations\HistogramPostAggregator

Complexity

Total Complexity

4

Size/Duplication

Total Lines	56
Duplicated Lines	0 %

Test Coverage

Coverage

100%

Importance

Changes	3
Bugs	0	Features	0

2 Methods

Rating	Name	Duplication	Size	Complexity
A	__construct()	0	10	1
A	toArray()	0	17	3

<?php
declare(strict_types=1);

namespace Level23\Druid\PostAggregations;

class HistogramPostAggregator implements PostAggregatorInterface
{
    protected string $outputName;

    protected PostAggregatorInterface $dimension;

    /**
     * @var array<float>|null
     */
    protected ?array $splitPoints = null;

    protected ?int $numBins = null;

    /**
     * HistogramPostAggregator constructor.
     *
     * @param PostAggregatorInterface $dimension     Post aggregator that refers to a DoublesSketch (fieldAccess or
     *                                               another post aggregator)
     * @param string                  $outputName
     * @param array<float>|null       $splitPoints   array of split points (optional)
     * @param int|null                $numBins       number of bins (optional, defaults to 10)
     */
    public function __construct(
        PostAggregatorInterface $dimension,
        string $outputName,
        ?array $splitPoints = null,
        ?int $numBins = null
    ) {
        $this->outputName  = $outputName;
        $this->dimension   = $dimension;
        $this->splitPoints = $splitPoints;
        $this->numBins     = $numBins;
    }

    /**
     * Return the aggregator as it can be used in a druid query.
     *
     * @return array<string,string|float[]|array<string,string|array<mixed>>|int>
     */
    public function toArray(): array
    {
        $result = [
            'type'  => 'quantilesDoublesSketchToHistogram',
            'name'  => $this->outputName,
            'field' => $this->dimension->toArray(),
        ];

        if ($this->splitPoints !== null) {
            $result['splitPoints'] = $this->splitPoints;
        }

        if ($this->numBins !== null) {
            $result['numBins'] = $this->numBins;
        }

        return $result;
    }
}