1<?php
2
3/* Copyright (c) 2017 Ralph Dittrich <dittrich@qualitus.de> Extended GPL, see docs/LICENSE */
4
5namespace ILIAS\UI\Component\Chart\ProgressMeter;
6
7/**
8 * Interface Standard
9 * @package ILIAS\UI\Component\Chart\ProgressMeter
10 */
11interface Standard extends ProgressMeter
12{
13
14    /**
15     * Get comparison value
16     *
17     * This value is represented as the second progress meter bar.
18     *
19     * @return int|float|null
20     */
21    public function getComparison();
22
23    /**
24     * Get clone of Progress Meter with main text
25     *
26     * It will be displayed above the main value percentage display.
27     * Example: withMainText('Your Score')
28     *
29     * @param string $text
30     * @return \ILIAS\UI\Component\Chart\ProgressMeter\ProgressMeter
31     */
32    public function withMainText($text);
33
34    /**
35     * Get main text value
36     *
37     * @return string|null
38     */
39    public function getMainText();
40
41    /**
42     * Get clone of Progress Meter with required text
43     *
44     * It will be displayed below the required percentage display.
45     * Example: withRequiredText("Minimum Required")
46     *
47     * @param string $text
48     * @return \ILIAS\UI\Component\Chart\ProgressMeter\ProgressMeter
49     */
50    public function withRequiredText($text);
51
52    /**
53     * Get required text value
54     *
55     * @return string|null
56     */
57    public function getRequiredText();
58}
59