ProgressMeter.php

Go to the documentation of this file.

<?php

declare(strict_types=1);

namespace ILIAS\UI\Implementation\Component\Chart\ProgressMeter;

use ILIAS\UI\Component as C;
use ILIAS\UI\Implementation\Component\ComponentHelper;

class ProgressMeter implements C\Chart\ProgressMeter\ProgressMeter
{
    use ComponentHelper;

    protected int $maximum;
    private int $required;
    protected int $main;
    protected int $comparison;

    public function __construct(int $maximum, int $main, ?int $required = null, ?int $comparison = null)
    {
        $this->maximum = $maximum;
        $this->main = $this->getSafe($main);

        if ($required != null) {
            $this->required = $this->getSafe($required);
        } else {
            $this->required = $this->getSafe($maximum);
        }
        if ($comparison != null) {
            $this->comparison = $this->getSafe($comparison);
        } else {
            $this->comparison = 0;
        }
    }

    public function getMaximum()
    {
        return $this->maximum;
    }

    public function getRequired()
    {
        return $this->getSafe($this->required);
    }

    public function getRequiredAsPercent(): int
    {
        return $this->getAsPercentage($this->required);
    }

    public function getMainValue()
    {
        return $this->getSafe($this->main);
    }

    public function getMainValueAsPercent(): int
    {
        return $this->getAsPercentage($this->main);
    }

    protected function getSafe(int $int): int
    {
        return (($int < 0) ? 0 : ($int > $this->getMaximum() ? $this->getMaximum() : $int));
    }

    protected function getAsPercentage(int $int): int
    {
        return (int) round(100 / $this->getMaximum() * $this->getSafe($int), 0, PHP_ROUND_HALF_UP);
    }
}