ProgressMeter.php

Go to the documentation of this file.

<?php

/* Copyright (c) 2017 Ralph Dittrich <dittrich@qualitus.de> Extended GPL, see docs/LICENSE */

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 $maximum;

    private $required;

    protected $main;

    protected $comparison;

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

        if ($required != null) {
            $this->checkIntArg("required", $required);
            $this->required = $this->getSafe($required);
        } else {
            $this->checkIntArg("required", $maximum);
            $this->required = $this->getSafe($maximum);
        }
        if ($comparison != null) {
            $this->checkIntArg("comparison", $comparison);
            $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()
    {
        return $this->getAsPercentage($this->required);
    }

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

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

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

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