Actuator\Health\OrderedHealthAggregator

Complexity

Total Complexity

9

Size/Duplication

Total Lines	69
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	2

Test Coverage

Coverage

100%

Importance

Changes	2
Bugs	1	Features	0

4 Methods

Rating	Name	Duplication	Size	Complexity
A	setStatusOrder()	0	5	1
A	statusComparator()	0	9	3
A	__construct()	0	6	1
A	aggregateStatus()	0	17	4

<?php

namespace Actuator\Health;

/**
 * Default HealthAggregator implementation that aggregates Health
 * instances and determines the final system state based on a simple ordered list.
 */
class OrderedHealthAggregator extends AbstractHealthAggregator
{
    /**
     * @var string[]
     */
    private $statusOrder;

    /**
     * Create a new OrderedHealthAggregator instance.
     */
    public function __construct()
    {
        $this->setStatusOrder(
            [Status::DOWN, Status::OUT_OF_SERVICE, Status::UP, Status::UNKNOWN]
        );
    }

    /**
     * @param Status[] $candidates
     *
     * @return Status
     */
    protected function aggregateStatus($candidates)
    {
        $filteredCandidates = [];
        foreach ($candidates as $candidate) {
            if (array_search($candidate->getCode(), $this->statusOrder) !== false) {
                $filteredCandidates[] = $candidate;
            }
        }

        if (count($filteredCandidates) === 0) {
            return new Status(Status::UNKNOWN);
        }

        usort($filteredCandidates, [$this, 'statusComparator']);

        return $filteredCandidates[0];
    }

    /**
     * Callable used to order Status.
     *
     * @param Status $s1
     * @param Status $s2
     *
     * @return int
     */
    private function statusComparator($s1, $s2)
    {
        if (array_search($s1->getCode(), $this->statusOrder) === array_search($s2->getCode(), $this->statusOrder)) {
            return 0;
        }

        return (array_search($s1->getCode(), $this->statusOrder)
            < array_search($s2->getCode(), $this->statusOrder)) ? -1 : 1;
    }

    /**
     * Set the ordering of the status.
     *
     * @param array $statusOrder an ordered array of the status
     */
    public function setStatusOrder($statusOrder)
    {
        assert(!is_null($statusOrder), 'StatusOrder must not be null');
        $this->statusOrder = $statusOrder;
    }
}