A metric is something we can measure about the system. More...

Collaboration diagram for ILIAS\Setup\Metrics\Metric:

Public Member Functions
	__construct (string $stability, string $type, $value, string $description=null)

	getStability ()

	getType ()

	getValue ()

	getDescription ()

	toYAML (int $indentation=0)

	toArray (int $indentation=0)

	extractByStability (string $stability)
	The extracted part will be the first entry of the array, the second will be the rest of the metrics. More...

	toUIReport (Factory $f, string $name)

Data Fields
const	STABILITY_CONFIG = "config"
	The stability of a metric tells how often we expect changes in the metric. More...

const	STABILITY_STABLE = "stable"

const	STABILITY_VOLATILE = "volatile"

const	STABILITY_MIXED = "mixed"

const	TYPE_BOOL = "bool"
	The type of the metric tells what to expect of the values. More...

const	TYPE_COUNTER = "counter"

const	TYPE_GAUGE = "gauge"

const	TYPE_TIMESTAMP = "timestamp"

const	TYPE_TEXT = "text"

const	TYPE_COLLECTION = "collection"

Protected Member Functions
	checkStability ($stability, $type)

	checkType ($type)

	checkValue ($type, $value)

	getIndentation (int $indentation=0)

Protected Attributes
	$stability

	$type

	$value

	$description

Detailed Description

A metric is something we can measure about the system.

To make metrics processable and understandable for the setup, we use a closed sum type to represent them. So basically, this class will contain every kind of metric that can exist and the types are not extendable.

Definition at line 17 of file Metric.php.

Constructor & Destructor Documentation

◆ __construct()

ILIAS\Setup\Metrics\Metric::__construct	(	string	$stability,
		string	$type,
			$value,
		string	$description = `null`
	)

Definition at line 70 of file Metric.php.

References ILIAS\Setup\Metrics\Metric\$description, ILIAS\Setup\Metrics\Metric\$stability, ILIAS\Setup\Metrics\Metric\$type, ILIAS\Setup\Metrics\Metric\$value, ILIAS\Setup\Metrics\Metric\checkStability(), ILIAS\Setup\Metrics\Metric\checkType(), and ILIAS\Setup\Metrics\Metric\checkValue().

       {
         $this->checkStability($stability, $type);
         $this->checkType($type);
         $this->checkValue($type, $value);
 
         $this->stability = $stability;
         $this->type = $type;
         $this->value = $value;
         $this->description = $description;
     }

Here is the call graph for this function:

Member Function Documentation

◆ checkStability()

ILIAS\Setup\Metrics\Metric::checkStability	(	$stability,
		$type
	)

protected

Definition at line 86 of file Metric.php.

References ILIAS\Setup\Metrics\Metric\$stability, and ILIAS\Setup\Metrics\Metric\$type.

Referenced by ILIAS\Setup\Metrics\Metric\__construct().

     {
         if (
             $stability !== self::STABILITY_CONFIG
             && $stability !== self::STABILITY_STABLE
             && $stability !== self::STABILITY_VOLATILE
             && !($stability === self::STABILITY_MIXED && $type === self::TYPE_COLLECTION)
         ) {
             throw new \InvalidArgumentException(
                 "Invalid stability for metric: $stability"
             );
         }
     }

Here is the caller graph for this function:

◆ checkType()

ILIAS\Setup\Metrics\Metric::checkType ( $type )

protected

Definition at line 100 of file Metric.php.

References ILIAS\Setup\Metrics\Metric\$type.

Referenced by ILIAS\Setup\Metrics\Metric\__construct().

     {
         if (
             $type !== self::TYPE_BOOL
             && $type !== self::TYPE_COUNTER
             && $type !== self::TYPE_GAUGE
             && $type !== self::TYPE_TIMESTAMP
             && $type !== self::TYPE_TEXT
             && $type !== self::TYPE_COLLECTION
         ) {
             throw new \InvalidArgumentException(
                 "Invalid type for metric: $type"
             );
         }
     }

Here is the caller graph for this function:

◆ checkValue()

ILIAS\Setup\Metrics\Metric::checkValue	(	$type,
		$value
	)

protected

Definition at line 116 of file Metric.php.

References ILIAS\Setup\Metrics\Metric\$type, and ILIAS\Setup\Metrics\Metric\$value.

Referenced by ILIAS\Setup\Metrics\Metric\__construct().

     {
         if (
             ($type === self::TYPE_BOOL && !is_bool($value))
             || ($type === self::TYPE_COUNTER && !is_int($value))
             || ($type === self::TYPE_GAUGE && !(is_int($value) || is_float($value)))
             || ($type === self::TYPE_TIMESTAMP && !($value instanceof \DateTimeImmutable))
             || ($type === self::TYPE_TEXT && !is_string($value))
             || ($type === self::TYPE_COLLECTION && !is_array($value))
         ) {
             throw new \InvalidArgumentException(
                 "Invalid type " . gettype($value) . " for metric of type $type"
             );
         }
 
         if ($type === self::TYPE_COLLECTION) {
             foreach ($value as $v) {
                 if (!($v instanceof Metric)) {
                     throw new \InvalidArgumentException(
                         "Every element of a collection needs to be a metric, found " . gettype($v)
                     );
                 }
             }
         }
     }

Here is the caller graph for this function:

◆ extractByStability()

ILIAS\Setup\Metrics\Metric::extractByStability ( string $stability )

The extracted part will be the first entry of the array, the second will be the rest of the metrics.

Returns: (Metric|null)[]

Definition at line 262 of file Metric.php.

References Vendor\Package\$e, $rest, ILIAS\Setup\Metrics\Metric\getDescription(), ILIAS\Setup\Metrics\Metric\getStability(), ILIAS\Setup\Metrics\Metric\getType(), and ILIAS\Setup\Metrics\Metric\getValue().

                                                           : array
     {
         if ($stability === self::STABILITY_MIXED) {
             throw new \LogicException("Can not extract by mixed.");
         }
 
         if ($this->getStability() === $stability) {
             return [$this, null];
         }
         if ($this->getType() !== self::TYPE_COLLECTION) {
             return [null, $this];
         }
 
         // Now, this is a mixed collection. We need to go down.
         $values = $this->getValue();
         $extracted = [];
         $rest = [];
         foreach ($values as $k => $v) {
             list($e, $r) = $v->extractByStability($stability);
             if ($e !== null) {
                 $extracted[$k] = $e;
             }
             if ($r !== null) {
                 $rest[$k] = $r;
             }
         }
 
         if (count($extracted)) {
             $extracted = new Metric(
                 $stability,
                 self::TYPE_COLLECTION,
                 $extracted,
                 $this->getDescription()
             );
         } else {
             $extracted = null;
         }
 
         if (count($rest)) {
             $rest = new Metric(
                 $this->getStability(),
                 self::TYPE_COLLECTION,
                 $rest,
                 $this->getDescription()
             );
         } else {
             $rest = null;
         }
 
         return [$extracted, $rest];
     }

Here is the call graph for this function:

◆ getDescription()

ILIAS\Setup\Metrics\Metric::getDescription ( )

Definition at line 160 of file Metric.php.

References ILIAS\Setup\Metrics\Metric\$description.

Referenced by ILIAS\Setup\Metrics\Metric\extractByStability().

                                      : ?string
     {
         return $this->description;
     }

Here is the caller graph for this function:

◆ getIndentation()

ILIAS\Setup\Metrics\Metric::getIndentation ( int $indentation = 0 )

protected

Definition at line 247 of file Metric.php.

References $res.

Referenced by ILIAS\Setup\Metrics\Metric\toArray(), and ILIAS\Setup\Metrics\Metric\toYAML().

     {
         $res = "";
         while ($indentation--) {
             $res .= "    ";
         }
         return $res;
     }

Here is the caller graph for this function:

◆ getStability()

ILIAS\Setup\Metrics\Metric::getStability ( )

Definition at line 142 of file Metric.php.

References ILIAS\Setup\Metrics\Metric\$stability.

Referenced by ILIAS\Setup\Metrics\Metric\extractByStability().

                                    : string
     {
         return $this->stability;
     }

Here is the caller graph for this function:

◆ getType()

ILIAS\Setup\Metrics\Metric::getType ( )

Definition at line 147 of file Metric.php.

References ILIAS\Setup\Metrics\Metric\$type.

Referenced by ILIAS\Setup\Metrics\Metric\extractByStability(), ILIAS\Setup\Metrics\Metric\toArray(), and ILIAS\Setup\Metrics\Metric\toYAML().

                               : string
     {
         return $this->type;
     }

Here is the caller graph for this function:

◆ getValue()

ILIAS\Setup\Metrics\Metric::getValue ( )

Returns: mixed

Definition at line 155 of file Metric.php.

References ILIAS\Setup\Metrics\Metric\$value.

Referenced by ILIAS\Setup\Metrics\Metric\extractByStability(), ILIAS\Setup\Metrics\Metric\toArray(), and ILIAS\Setup\Metrics\Metric\toYAML().

     {
         return $this->value;
     }

Here is the caller graph for this function:

◆ toArray()

ILIAS\Setup\Metrics\Metric::toArray ( int $indentation = 0 )

Definition at line 211 of file Metric.php.

References $result, ILIAS\Setup\Metrics\Metric\$value, ILIAS\Setup\Metrics\Metric\getIndentation(), ILIAS\Setup\Metrics\Metric\getType(), and ILIAS\Setup\Metrics\Metric\getValue().

     {
         $value = $this->getValue();
 
         switch ($this->getType()) {
             case self::TYPE_BOOL:
                 if ($value) {
                     return "true";
                 }  else {
                     return "false";
                 }
             case self::TYPE_COUNTER:
                 return (string)$value;
             case self::TYPE_GAUGE:
                 if (is_int($value)) {
                     return (string)$value;
                 }
                 return sprintf("%.03f", $value);
             case self::TYPE_TIMESTAMP:
                 return $value->format(\DateTimeInterface::ISO8601);
             case self::TYPE_TEXT:
                     if (substr_count($value, "\n") > 0) {
                         return ">" . str_replace("\n", "\n" . $this->getIndentation($indentation), "\n$value");
                     }
                 return $value;
             case self::TYPE_COLLECTION:
                 $result = [];
                 foreach ($value as $key => $val) {
                     $result[$key] = $val->toArray($indentation + 1);
                 }
                 return $result;
             default:
                 throw new \LogicException("Unknown type: " . $this->getType());
         }
     }

Here is the call graph for this function:

◆ toUIReport()

ILIAS\Setup\Metrics\Metric::toUIReport	(	Factory	$f,
		string	$name
	)

Definition at line 314 of file Metric.php.

References ILIAS\Setup\Metrics\Metric\toYAML().

                                                          : Report
     {
         $yaml = $this->toYAML();
         $sub = $f->panel()->sub("", $f->legacy("<pre>" . $yaml . "</pre>"));
         return $f->panel()->report($name, [$sub]);
     }

Here is the call graph for this function:

◆ toYAML()

ILIAS\Setup\Metrics\Metric::toYAML ( int $indentation = 0 )

Definition at line 165 of file Metric.php.

References ILIAS\Setup\Metrics\Metric\$value, ILIAS\Setup\Metrics\Metric\getIndentation(), ILIAS\Setup\Metrics\Metric\getType(), and ILIAS\Setup\Metrics\Metric\getValue().

Referenced by ILIAS\Setup\Metrics\Metric\toUIReport().

                                                  : string
     {
         $value = $this->getValue();
         switch ($this->getType()) {
             case self::TYPE_BOOL:
                 if ($value) {
                     return "true";
                 } else {
                     return "false";
                 }
                 // no break
             case self::TYPE_COUNTER:
                 return "$value";
             case self::TYPE_GAUGE:
                 if (is_int($value)) {
                     return "$value";
                 }
                 return sprintf("%.03f", $value);
             case self::TYPE_TIMESTAMP:
                 return $value->format(\DateTimeInterface::ISO8601);
             case self::TYPE_TEXT:
                 if (substr_count($value, "\n") > 0) {
                     return ">" . str_replace("\n", "\n" . $this->getIndentation($indentation), "\n$value");
                 }
                 return $value;
             case self::TYPE_COLLECTION:
                 return implode(
                     "\n",
                     array_map(
                         function ($k, $v) use ($indentation) {
                             if ($v->getType() === self::TYPE_COLLECTION) {
                                 $split = "\n";
                             } else {
                                 $split = " ";
                             }
                             return $this->getIndentation($indentation) . "$k:$split" . $v->toYAML($indentation + 1);
                         },
                         array_keys($value),
                         array_values($value)
                     )
                 );
             default:
                 throw new \LogicException("Unknown type: " . $this->getType());
         }
     }