ILIAS  trunk Revision v5.2.0beta1-34115-g3a2438be29
ILIAS\UI\Implementation\Component\Chart\ProgressMeter\Standard Class Reference
+ Inheritance diagram for ILIAS\UI\Implementation\Component\Chart\ProgressMeter\Standard:
+ Collaboration diagram for ILIAS\UI\Implementation\Component\Chart\ProgressMeter\Standard:

Public Member Functions

 getComparison ()
 
 getComparisonAsPercent ()
 Get comparison value as percent. More...
 
 withMainText (string $text)
 
 getMainText ()
 
 withRequiredText (string $text)
 
 getRequiredText ()
 
- Public Member Functions inherited from ILIAS\UI\Implementation\Component\Chart\ProgressMeter\ProgressMeter
 __construct (int $maximum, int $main, int $required=null, int $comparison=null)
 
 getMaximum ()
 
 getRequired ()
 
 getRequiredAsPercent ()
 Get required value as percent. More...
 
 getMainValue ()
 
 getMainValueAsPercent ()
 Get main value as percent. More...
 

Protected Attributes

string $main_text = null
 
string $required_text = null
 
- Protected Attributes inherited from ILIAS\UI\Implementation\Component\Chart\ProgressMeter\ProgressMeter
int $maximum
 
int $main
 
int $comparison
 

Additional Inherited Members

- Protected Member Functions inherited from ILIAS\UI\Implementation\Component\Chart\ProgressMeter\ProgressMeter
 getSafe (int $int)
 Get integer value "1" if a value is negative or "maximum" if value is more than maximum. More...
 
 getAsPercentage (int $int)
 get an integer value as percent value More...
 

Detailed Description

Definition at line 29 of file Standard.php.

Member Function Documentation

◆ getComparison()

ILIAS\UI\Implementation\Component\Chart\ProgressMeter\Standard::getComparison ( )

Definition at line 37 of file Standard.php.

References ILIAS\UI\Implementation\Component\Chart\ProgressMeter\ProgressMeter\getSafe().

38  {
39  return $this->getSafe($this->comparison);
40  }
getSafe(int $int)
Get integer value "1" if a value is negative or "maximum" if value is more than maximum.
+ Here is the call graph for this function:

◆ getComparisonAsPercent()

ILIAS\UI\Implementation\Component\Chart\ProgressMeter\Standard::getComparisonAsPercent ( )

Get comparison value as percent.

Definition at line 45 of file Standard.php.

References ILIAS\UI\Implementation\Component\Chart\ProgressMeter\ProgressMeter\getAsPercentage().

45  : int
46  {
47  return $this->getAsPercentage($this->comparison);
48  }
getAsPercentage(int $int)
get an integer value as percent value
+ Here is the call graph for this function:

◆ getMainText()

ILIAS\UI\Implementation\Component\Chart\ProgressMeter\Standard::getMainText ( )

◆ getRequiredText()

ILIAS\UI\Implementation\Component\Chart\ProgressMeter\Standard::getRequiredText ( )

◆ withMainText()

ILIAS\UI\Implementation\Component\Chart\ProgressMeter\Standard::withMainText ( string  $text)

Definition at line 53 of file Standard.php.

53  : C\Chart\ProgressMeter\ProgressMeter
54  {
55  $this->checkStringArg("main_value_text", $text);
56 
57  $clone = clone $this;
58  $clone->main_text = $text;
59  return $clone;
60  }

◆ withRequiredText()

ILIAS\UI\Implementation\Component\Chart\ProgressMeter\Standard::withRequiredText ( string  $text)

Definition at line 73 of file Standard.php.

73  : C\Chart\ProgressMeter\ProgressMeter
74  {
75  $this->checkStringArg("required_value_text", $text);
76 
77  $clone = clone $this;
78  $clone->required_text = $text;
79  return $clone;
80  }

Field Documentation

◆ $main_text

string ILIAS\UI\Implementation\Component\Chart\ProgressMeter\Standard::$main_text = null
protected

◆ $required_text

string ILIAS\UI\Implementation\Component\Chart\ProgressMeter\Standard::$required_text = null
protected

The documentation for this class was generated from the following file: