Level23\Druid\Aggregations\AnyAggregator

Complexity

Total Complexity

6

Size/Duplication

Total Lines	58
Duplicated Lines	0 %

Test Coverage

Coverage

100%

Importance

Changes	1
Bugs	0	Features	0

3 Methods

Rating	Name	Duplication	Size	Complexity
A	getMethod()	0	3	1
A	__construct()	0	12	2
A	toArray()	0	13	3

<?php
declare(strict_types=1);

namespace Level23\Druid\Aggregations;

use Level23\Druid\Types\DataType;

class AnyAggregator extends MethodAggregator
{
    /**
     * @var int|null
     */
    protected $maxStringBytes;

    /**
     * constructor.
     *
     * @param string   $metricName
     * @param string   $outputName                          When not given, we will use the same name as the metric.
     * @param string   $type                                The type of field. This can either be "long", "float" or
     *                                                      "double"
     * @param int|null $maxStringBytes                      optional, defaults to 1024
     */
    public function __construct(
        string $metricName,
        string $outputName = '',
        string $type = 'long',
        int $maxStringBytes = null
    ) {
        $type = DataType::validate($type);

        $this->type           = $type;
        $this->metricName     = $metricName;
        $this->outputName     = $outputName ?: $metricName;
        $this->maxStringBytes = $maxStringBytes;
    }

    /**
     * Return the aggregator as it can be used in a druid query.
     *
     * @return array
     */
    public function toArray(): array
    {
        $response = [
            'type'      => $this->type . ucfirst($this->getMethod()),
            'name'      => $this->outputName,
            'fieldName' => $this->metricName,
        ];

        if ($this->type == DataType::STRING && $this->maxStringBytes !== null) {
            $response['maxStringBytes'] = $this->maxStringBytes;
        }

        return $response;
    }

    /**
     * Returns the method for the type aggregation
     *
     * @return string
     */
    protected function getMethod(): string
    {
        return 'any';
    }
}