ILIAS\TestQuestionPool\ilTestLegacyFormsHelper Class Reference

Collaboration diagram for ILIAS\TestQuestionPool\ilTestLegacyFormsHelper:

Public Member Functions
	__construct ()
	checkPointsInput ($data, bool $required, string $key='points')
	Checks if the provides points of an input are valid. More...
	checkPointsInputEnoughPositive ($data, bool $required, string $key='points')
	Extends the checkPointsInput function by checking if at least one point is greater than 0.0. More...
	transformArray ($data, string $key, Transformation $transformation)
	transformPoints ($data, string $key='points')
	inArray ($array, $key)
	Returns true if the given key is set in the array and the value is not empty. More...

Protected Attributes
Refinery	$refinery

Detailed Description

Deprecated:

This class is no longer needed when using the ks input components.

Definition at line 28 of file ilTestLegacyFormsHelper.php.

Constructor & Destructor Documentation

__construct()

ILIAS\TestQuestionPool\ilTestLegacyFormsHelper::__construct

(

)

Definition at line 32 of file ilTestLegacyFormsHelper.php.

References $DIC, and ILIAS\Repository\refinery().

      {
        global $DIC;
        $this->refinery = $DIC['refinery'];
    }

Here is the call graph for this function:

Member Function Documentation

checkPointsInput()

ILIAS\TestQuestionPool\ilTestLegacyFormsHelper::checkPointsInput	(		$data,
		bool	$required,
		string	$key = 'points'
	)

Checks if the provides points of an input are valid.

The function returns the language key of the error message if either the input is not an array or one of the points are not numeric. If the input is valid, the function returns the points as an array of floats.

Returns

string|float[]

Definition at line 46 of file ilTestLegacyFormsHelper.php.

References $data, Vendor\Package\$e, ILIAS\TestQuestionPool\ilTestLegacyFormsHelper\inArray(), ILIAS\Repository\refinery(), and ILIAS\Refinery\transform().

Referenced by ILIAS\TestQuestionPool\ilTestLegacyFormsHelper\checkPointsInputEnoughPositive().

                                                                                   : string|array
    {
        if (!is_array($data) || !$this->inArray($data, $key)) {
            return $required ? 'msg_input_is_required' : [];
        }

        try {
            $points = $this->refinery->to()->listOf($this->refinery->kindlyTo()->float())->transform($data[$key]);
        } catch (ConstraintViolationException $e) {
            return 'form_msg_numeric_value_required';
        }

        if (count($points) === 0) {
            return $required ? 'msg_input_is_required' : [];
        }

        return $points;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

checkPointsInputEnoughPositive()

ILIAS\TestQuestionPool\ilTestLegacyFormsHelper::checkPointsInputEnoughPositive	(		$data,
		bool	$required,
		string	$key = 'points'
	)

Extends the checkPointsInput function by checking if at least one point is greater than 0.0.

If not, the function returns the language key of the error message.

Returns

string|float[]

Definition at line 71 of file ilTestLegacyFormsHelper.php.

References $data, and ILIAS\TestQuestionPool\ilTestLegacyFormsHelper\checkPointsInput().

                                                                                                 : string|array
    {
        $points = $this->checkPointsInput($data, $required, $key);
        if (!is_array($points)) {
            return $points;
        }

        return max($points) <= 0 ? 'enter_enough_positive_points' : $points;
    }

Here is the call graph for this function:

inArray()

ILIAS\TestQuestionPool\ilTestLegacyFormsHelper::inArray	(		$array,
			$key
	)

Returns true if the given key is set in the array and the value is not empty.

Definition at line 111 of file ilTestLegacyFormsHelper.php.

Referenced by ILIAS\TestQuestionPool\ilTestLegacyFormsHelper\checkPointsInput(), ILIAS\TestQuestionPool\ilTestLegacyFormsHelper\transformArray(), and ILIAS\TestQuestionPool\ilTestLegacyFormsHelper\transformPoints().

                                         : bool
    {
        return is_array($array) && array_key_exists($key, $array) && !empty($array[$key]);
    }

Here is the caller graph for this function:

transformArray()

ILIAS\TestQuestionPool\ilTestLegacyFormsHelper::transformArray	(		$data,
		string	$key,
		Transformation	$transformation
	)

Definition at line 81 of file ilTestLegacyFormsHelper.php.

References $data, ILIAS\TestQuestionPool\ilTestLegacyFormsHelper\inArray(), ILIAS\Repository\refinery(), and ILIAS\Refinery\transform().

                                                                                      : array
    {
        if (!$this->inArray($data, $key)) {
            return [];
        }

        return $this->refinery->byTrying([
            $this->refinery->kindlyTo()->listOf($transformation),
            $this->refinery->always([])
        ])->transform($data[$key]);
    }

Here is the call graph for this function:

transformPoints()

ILIAS\TestQuestionPool\ilTestLegacyFormsHelper::transformPoints	(		$data,
		string	$key = 'points'
	)

Returns

array<float>

Definition at line 96 of file ilTestLegacyFormsHelper.php.

References $data, ILIAS\TestQuestionPool\ilTestLegacyFormsHelper\inArray(), null, ILIAS\Repository\refinery(), and ILIAS\Refinery\transform().

                                                                  : array
    {
        if (!$this->inArray($data, $key)) {
            return [];
        }

        return array_map(
            fn($v): ?float => $this->refinery->byTrying([$this->refinery->kindlyTo()->float(), $this->refinery->always(null)])->transform($v),
            $data[$key]
        );
    }

Here is the call graph for this function:

Field Documentation

$refinery

Refinery ILIAS\TestQuestionPool\ilTestLegacyFormsHelper::$refinery

protected

Definition at line 30 of file ilTestLegacyFormsHelper.php.

---

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

• components/ILIAS/TestQuestionPool/classes/ilTestLegacyFormsHelper.php