Collaboration diagram for ILIAS\Data\Chart\Dataset:

Public Member Functions
	__construct (array $dimensions, array $dimension_groups=[])

	getDimensions ()

	getDimensionGroups ()

	withPoint (string $measurement_item_label, array $values)

	getPoints ()

	getPointsPerDimension ()

	withAlternativeInformation (string $measurement_item_label, array $values)

	getAlternativeInformation ()

	getAlternativeInformationPerDimension ()

	withResetDataset ()
	Returns an empty Dataset clone. More...

	isEmpty ()

	getMinValueForDimension (string $dimension_name)

	getMaxValueForDimension (string $dimension_name)

Protected Member Functions
	checkDimensionCongruenceForValues (array $values)

Protected Attributes
array	$dimensions = []

array	$dimension_groups = []

array	$points = []

array	$alternative_information = []

Detailed Description

Author: Thomas Famula famul.nosp@m.a@le.nosp@m.ifos..nosp@m.de

Definition at line 28 of file Dataset.php.

Constructor & Destructor Documentation

◆ __construct()

ILIAS\Data\Chart\Dataset::__construct	(	array	$dimensions,
		array	$dimension_groups = `[]`
	)

Parameters

array<string,Dimension

Definition at line 39 of file Dataset.php.

References ILIAS\Data\Chart\Dataset\$dimension_groups, and ILIAS\Data\Chart\Dataset\$dimensions.

     {
         foreach ($dimensions as $name => $dimension) {
             if (!is_string($name)) {
                 throw new \InvalidArgumentException(
                     "Expected array key to be a string, '$name' is given."
                 );
             }
             if (!$dimension instanceof Dimension\Dimension) {
                 throw new \InvalidArgumentException(
                     "Expected array value to be an instance of Dimension." .
                     (is_object($dimension) ? get_class($dimension) : gettype($dimension)) . " is given."
                 );
             }
         }
         $this->dimensions = $dimensions;
 
         foreach ($dimension_groups as $group_name => $group) {
             if (!is_string($group_name)) {
                 throw new \InvalidArgumentException(
                     "Expected array key to be a string, '$group_name' is given."
                 );
             }
             if (!$group instanceof Dimension\DimensionGroup) {
                 throw new \InvalidArgumentException(
                     "Expected array value to be an instance of DimensionGroup. " .
                     (is_object($group) ? get_class($group) : gettype($group)) . " is given."
                 );
             }
         }
         $this->dimension_groups = $dimension_groups;
     }

Member Function Documentation

◆ checkDimensionCongruenceForValues()

ILIAS\Data\Chart\Dataset::checkDimensionCongruenceForValues ( array $values )

protected

Definition at line 88 of file Dataset.php.

References ILIAS\Data\Chart\Dataset\getDimensions().

Referenced by ILIAS\Data\Chart\Dataset\withAlternativeInformation(), and ILIAS\Data\Chart\Dataset\withPoint().

                                                                        : void
     {
         if (array_diff_key($values, $this->getDimensions())
             || array_diff_key($this->getDimensions(), $values)
         ) {
             throw new \ArgumentCountError(
                 "The number of the passed values does not match with the number of Dimensions."
             );
         }
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getAlternativeInformation()

ILIAS\Data\Chart\Dataset::getAlternativeInformation ( )

Definition at line 159 of file Dataset.php.

References ILIAS\Data\Chart\Dataset\$alternative_information.

Referenced by ILIAS\Data\Chart\Dataset\getAlternativeInformationPerDimension().

                                                : array
     {
         return $this->alternative_information;
     }

Here is the caller graph for this function:

◆ getAlternativeInformationPerDimension()

ILIAS\Data\Chart\Dataset::getAlternativeInformationPerDimension ( )

Definition at line 164 of file Dataset.php.

References ILIAS\Data\Chart\Dataset\getAlternativeInformation().

                                                            : array
     {
         $alternative_information_restructured = [];
         foreach ($this->getAlternativeInformation() as $measurement_item_label => $alternative_information_for_dimensions) {
             foreach ($alternative_information_for_dimensions as $dimension_name => $alternative_info) {
                 $alternative_information_restructured[$dimension_name][$measurement_item_label] = $alternative_info;
             }
         }
 
         return $alternative_information_restructured;
     }

Here is the call graph for this function:

◆ getDimensionGroups()

ILIAS\Data\Chart\Dataset::getDimensionGroups ( )

Returns: Dimension[]

Definition at line 83 of file Dataset.php.

References ILIAS\Data\Chart\Dataset\$dimension_groups.

                                         : array
     {
         return $this->dimension_groups;
     }

◆ getDimensions()

ILIAS\Data\Chart\Dataset::getDimensions ( )

Returns: Dimension[]

Definition at line 75 of file Dataset.php.

References ILIAS\Data\Chart\Dataset\$dimensions.

Referenced by ILIAS\UI\Implementation\Component\Chart\Bar\Bar\__construct(), ILIAS\Data\Chart\Dataset\checkDimensionCongruenceForValues(), and ILIAS\Data\Chart\Dataset\withPoint().

                                    : array
     {
         return $this->dimensions;
     }

Here is the caller graph for this function:

◆ getMaxValueForDimension()

ILIAS\Data\Chart\Dataset::getMaxValueForDimension ( string $dimension_name )

Definition at line 220 of file Dataset.php.

References ILIAS\Data\Chart\Dataset\getPointsPerDimension(), and ILIAS\Data\Chart\Dataset\isEmpty().

                                                                    : float
     {
         if ($this->isEmpty()) {
             throw new \RuntimeException(
                 "Dataset must not be empty."
             );
         }
 
         $max = null;
         $dimension_points = $this->getPointsPerDimension()[$dimension_name];
         foreach ($dimension_points as $point) {
             if (is_array($point)) {
                 foreach ($point as $p) {
                     if (is_null($max) || $p > $max) {
                         $max = $p;
                     }
                 }
             } elseif (is_null($max) || !is_null($point) && $point > $max) {
                 $max = $point;
             }
         }
 
         return (float) $max;
     }

Here is the call graph for this function:

◆ getMinValueForDimension()

ILIAS\Data\Chart\Dataset::getMinValueForDimension ( string $dimension_name )

Definition at line 195 of file Dataset.php.

References ILIAS\Data\Chart\Dataset\getPointsPerDimension(), and ILIAS\Data\Chart\Dataset\isEmpty().

                                                                    : float
     {
         if ($this->isEmpty()) {
             throw new \RuntimeException(
                 "Dataset must not be empty."
             );
         }
 
         $min = null;
         $dimension_points = $this->getPointsPerDimension()[$dimension_name];
         foreach ($dimension_points as $point) {
             if (is_array($point)) {
                 foreach ($point as $p) {
                     if (is_null($min) || $p < $min) {
                         $min = $p;
                     }
                 }
             } elseif (is_null($min) || !is_null($point) && $point < $min) {
                 $min = $point;
             }
         }
 
         return (float) $min;
     }

Here is the call graph for this function:

◆ getPoints()

ILIAS\Data\Chart\Dataset::getPoints ( )

Definition at line 119 of file Dataset.php.

References ILIAS\Data\Chart\Dataset\$points.

Referenced by ILIAS\Data\Chart\Dataset\getPointsPerDimension(), and ILIAS\Data\Chart\Dataset\isEmpty().

                                : array
     {
         return $this->points;
     }

Here is the caller graph for this function:

◆ getPointsPerDimension()

ILIAS\Data\Chart\Dataset::getPointsPerDimension ( )

Definition at line 124 of file Dataset.php.

References ILIAS\Data\Chart\Dataset\getPoints().

Referenced by ILIAS\Data\Chart\Dataset\getMaxValueForDimension(), and ILIAS\Data\Chart\Dataset\getMinValueForDimension().

                                            : array
     {
         $points_restructured = [];
         foreach ($this->getPoints() as $measurement_item_label => $points_for_dimensions) {
             foreach ($points_for_dimensions as $dimension_name => $point) {
                 $points_restructured[$dimension_name][$measurement_item_label] = $point;
             }
         }
 
         return $points_restructured;
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ isEmpty()

ILIAS\Data\Chart\Dataset::isEmpty ( )

Definition at line 187 of file Dataset.php.

References ILIAS\Data\Chart\Dataset\getPoints().

Referenced by ILIAS\UI\Implementation\Component\Chart\Bar\Bar\__construct(), ILIAS\Data\Chart\Dataset\getMaxValueForDimension(), and ILIAS\Data\Chart\Dataset\getMinValueForDimension().

                              : bool
     {
         if (empty($this->getPoints())) {
             return true;
         }
         return false;
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ withAlternativeInformation()

ILIAS\Data\Chart\Dataset::withAlternativeInformation	(	string	$measurement_item_label,
		array	$values
	)

Parameters

string	$measurement_item_label
	array<string,string>	$values key: Dimension name, value: Alternative text as string value or null

Returns: $this

Definition at line 141 of file Dataset.php.

References ILIAS\Data\Chart\Dataset\checkDimensionCongruenceForValues().

                                                                                              : self
     {
         $this->checkDimensionCongruenceForValues($values);
 
         foreach ($values as $dimension_name => $value) {
             if (!is_string($value) && !is_null($value)) {
                 throw new \InvalidArgumentException(
                     "Expected array value to be a string or null, '$value' is given."
                 );
             }
         }
 
         $clone = clone $this;
         $clone->alternative_information[$measurement_item_label] = $values;
 
         return $clone;
     }

Here is the call graph for this function:

◆ withPoint()

ILIAS\Data\Chart\Dataset::withPoint	(	string	$measurement_item_label,
		array	$values
	)

Parameters

string	$measurement_item_label	Using the identical label multiple times will overwrite the values
	array<string,mixed>	$values key: Dimension name, value: mixed (validity depends on the dimension)

Returns: $this

Definition at line 104 of file Dataset.php.

References ILIAS\Data\Chart\Dataset\checkDimensionCongruenceForValues(), and ILIAS\Data\Chart\Dataset\getDimensions().

                                                                             : self
     {
         $this->checkDimensionCongruenceForValues($values);
 
         foreach ($values as $dimension_name => $value) {
             $dimension = $this->getDimensions()[$dimension_name];
             $dimension->checkValue($value);
         }
 
         $clone = clone $this;
         $clone->points[$measurement_item_label] = $values;
 
         return $clone;
     }

Here is the call graph for this function:

◆ withResetDataset()

ILIAS\Data\Chart\Dataset::withResetDataset ( )

Returns an empty Dataset clone.

Definition at line 179 of file Dataset.php.

                                       : self
     {
         $clone = clone $this;
         $clone->points = [];
         $clone->alternative_information = [];
         return $clone;
     }

Field Documentation

◆ $alternative_information

array ILIAS\Data\Chart\Dataset::$alternative_information = []

protected

Definition at line 33 of file Dataset.php.

Referenced by ILIAS\Data\Chart\Dataset\getAlternativeInformation().

◆ $dimension_groups

array ILIAS\Data\Chart\Dataset::$dimension_groups = []

protected

Definition at line 31 of file Dataset.php.

Referenced by ILIAS\Data\Chart\Dataset\__construct(), and ILIAS\Data\Chart\Dataset\getDimensionGroups().

◆ $dimensions

array ILIAS\Data\Chart\Dataset::$dimensions = []

protected

Definition at line 30 of file Dataset.php.

Referenced by ILIAS\Data\Chart\Dataset\__construct(), and ILIAS\Data\Chart\Dataset\getDimensions().

◆ $points

array ILIAS\Data\Chart\Dataset::$points = []

protected

Definition at line 32 of file Dataset.php.

Referenced by ILIAS\Data\Chart\Dataset\getPoints().

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

components/ILIAS/Data/src/Chart/Dataset.php

Public Member Functions

Protected Member Functions

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ checkDimensionCongruenceForValues()

◆ getAlternativeInformation()

◆ getAlternativeInformationPerDimension()

◆ getDimensionGroups()

◆ getDimensions()

◆ getMaxValueForDimension()

◆ getMinValueForDimension()

◆ getPoints()

◆ getPointsPerDimension()

◆ isEmpty()

◆ withAlternativeInformation()

◆ withPoint()

◆ withResetDataset()

Field Documentation

◆ $alternative_information

◆ $dimension_groups

◆ $dimensions

◆ $points