Formula Question Unit. More...

Inheritance diagram for assFormulaQuestionUnit:

Collaboration diagram for assFormulaQuestionUnit:

Public Member Functions
	initFormArray (array $data)

	setId (int $id)

	getId ()

	setUnit (string $unit)

	getUnit ()

	getSanitizedUnit ()

	setSequence (int $sequence)

	getSequence ()

	setFactor (float $factor)

	getFactor ()

	setBaseUnit (int $baseunit)

	getBaseUnit ()

	setBaseunitTitle (?string $baseunit_title)

	getBaseunitTitle ()

	getSanitizedBaseunitTitle ()

	setCategory (int $category)

	getCategory ()

	getDisplayString ()

	toNormalized (Transformations $transformations, array $context=[])
	Convert the internal state of the implementing object into a language-neutral array structure. More...

	fromNormalized (array $normalized, Transformations $transformations)
	Restore the object from its normalized representation. More...

	toNormalized (Transformations $transformations, array $context=[])
	Convert the internal state of the implementing object into a language-neutral array structure. More...

	fromNormalized (array $normalized, Transformations $transformations)
	Restore the object from its normalized representation. More...

Static Public Member Functions
static	lookupUnitFactor (int $a_unit_id)

Private Member Functions
	sanitizeString (string $string)

Private Attributes
int	$id = 0

string	$unit = ''

float	$factor = 0.0

int	$category = 0

int	$sequence = 0

int	$baseunit = 0

string	$baseunit_title = null

Detailed Description

Formula Question Unit.

Author: Helmut Schottmüller helmu.nosp@m.t.sc.nosp@m.hottm.nosp@m.uell.nosp@m.er@ma.nosp@m.c.co.nosp@m.m \

Definition at line 31 of file class.assFormulaQuestionUnit.php.

Member Function Documentation

◆ fromNormalized()

assFormulaQuestionUnit::fromNormalized	(	array	$normalized,
		Transformations	$transformations
	)

Restore the object from its normalized representation.

Parameters

array<array-key,mixed> $normalized

Implements ILIAS\TestQuestionPool\ExportImport\Foundation\Normalize\FromNormalized.

Definition at line 186 of file class.assFormulaQuestionUnit.php.

     : static
    {
        $clone = clone $this;
        $clone->id = $transformations->denormalize($normalized['id'], Id::class)->getId();
        $clone->unit = $transformations->string($normalized['unit']);
        $clone->factor = $transformations->float($normalized['factor']);
        $clone->category = $transformations->denormalize($normalized['category_id'], Id::class)->getId();
        $clone->sequence = $transformations->int($normalized['sequence']);
        $clone->baseunit = $transformations->denormalize($normalized['baseunit'], Id::class)->getId();
        $clone->baseunit_title = $transformations->string($normalized['baseunit_title']);
 
        return $clone;
    }

References ILIAS\TestQuestionPool\ExportImport\Foundation\Normalize\Transformations\denormalize(), ILIAS\TestQuestionPool\ExportImport\Foundation\Normalize\Transformations\float(), ILIAS\TestQuestionPool\ExportImport\Foundation\Normalize\Transformations\int(), and ILIAS\TestQuestionPool\ExportImport\Foundation\Normalize\Transformations\string().

Here is the call graph for this function:

◆ getBaseUnit()

assFormulaQuestionUnit::getBaseUnit ( )

Definition at line 102 of file class.assFormulaQuestionUnit.php.

                                 : int
    {
        if ($this->baseunit > 0) {
            return $this->baseunit;
        }
 
        return $this->id;
    }

References $baseunit, and $id.

Referenced by ilUnitConfigurationRepository\saveUnit().

Here is the caller graph for this function:

◆ getBaseunitTitle()

assFormulaQuestionUnit::getBaseunitTitle ( )

Definition at line 116 of file class.assFormulaQuestionUnit.php.

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

References $baseunit_title.

Referenced by getSanitizedBaseunitTitle().

Here is the caller graph for this function:

◆ getCategory()

assFormulaQuestionUnit::getCategory ( )

Definition at line 131 of file class.assFormulaQuestionUnit.php.

                                 : int
    {
        return $this->category;
    }

References $category.

Referenced by ilUnitConfigurationRepository\createNewUnit(), and ilUnitConfigurationRepository\saveUnit().

Here is the caller graph for this function:

◆ getDisplayString()

assFormulaQuestionUnit::getDisplayString ( )

Definition at line 136 of file class.assFormulaQuestionUnit.php.

                                      : string
    {
        global $DIC;
 
        $unit = $this->getUnit();
        $txt = $DIC->language()->txt("qpl_qst_formulaquestion_{$unit}");
        return strcmp("-qpl_qst_formulaquestion_{$unit}-", $txt) !== 0
            ? $this->sanitizeString($txt)
            : $this->getSanitizedUnit();
    }

References $DIC, $unit, getSanitizedUnit(), getUnit(), and sanitizeString().

Here is the call graph for this function:

◆ getFactor()

assFormulaQuestionUnit::getFactor ( )

Definition at line 92 of file class.assFormulaQuestionUnit.php.

                               : float
    {
        return $this->factor;
    }

References $factor.

Referenced by ilUnitConfigurationRepository\saveUnit().

Here is the caller graph for this function:

◆ getId()

assFormulaQuestionUnit::getId ( )

Definition at line 57 of file class.assFormulaQuestionUnit.php.

                           : int
    {
        return $this->id;
    }

References $id.

Referenced by ilUnitConfigurationRepository\addUnit(), assFormulaQuestionResult\getResultInfo(), and ilUnitConfigurationRepository\saveUnit().

Here is the caller graph for this function:

◆ getSanitizedBaseunitTitle()

assFormulaQuestionUnit::getSanitizedBaseunitTitle ( )

Definition at line 121 of file class.assFormulaQuestionUnit.php.

                                               : ?string
    {
        return $this->sanitizeString($this->getBaseunitTitle() ?? '');
    }

References getBaseunitTitle(), and sanitizeString().

Here is the call graph for this function:

◆ getSanitizedUnit()

assFormulaQuestionUnit::getSanitizedUnit ( )

Definition at line 72 of file class.assFormulaQuestionUnit.php.

                                      : string
    {
        return htmlspecialchars($this->getUnit(), ENT_QUOTES | ENT_SUBSTITUTE, 'utf-8');
    }

References getUnit().

Referenced by getDisplayString().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getSequence()

assFormulaQuestionUnit::getSequence ( )

Definition at line 82 of file class.assFormulaQuestionUnit.php.

                                 : int
    {
        return $this->sequence;
    }

References $sequence.

Referenced by ilUnitConfigurationRepository\saveUnit().

Here is the caller graph for this function:

◆ getUnit()

assFormulaQuestionUnit::getUnit ( )

Definition at line 67 of file class.assFormulaQuestionUnit.php.

                             : string
    {
        return $this->unit;
    }

References $unit.

Referenced by ilUnitConfigurationRepository\createNewUnit(), getDisplayString(), getSanitizedUnit(), and ilUnitConfigurationRepository\saveUnit().

Here is the caller graph for this function:

◆ initFormArray()

assFormulaQuestionUnit::initFormArray ( array $data )

Definition at line 41 of file class.assFormulaQuestionUnit.php.

                                              : void
    {
        $this->id = (int) $data['unit_id'];
        $this->unit = $data['unit'];
        $this->factor = (float) $data['factor'];
        $this->baseunit = (int) $data['baseunit_fi'];
        $this->baseunit_title = $data['baseunit_title'] ?? null;
        $this->category = (int) $data['category_fi'];
        $this->sequence = (int) $data['sequence'];
    }

References $data, and ILIAS\Repository\int().

Here is the call graph for this function:

◆ lookupUnitFactor()

static assFormulaQuestionUnit::lookupUnitFactor ( int $a_unit_id )

static

Definition at line 147 of file class.assFormulaQuestionUnit.php.

                                                           : float
    {
        global $DIC;
        $ilDB = $DIC['ilDB'];
 
        $res = $ilDB->queryF(
            'SELECT factor FROM il_qpl_qst_fq_unit WHERE unit_id = %s',
            ['integer'],
            [$a_unit_id]
        );
 
        $row = $ilDB->fetchAssoc($res);
 
        return (float) $row['factor'];
    }

References $DIC, $ilDB, and $res.

Referenced by assFormulaQuestion\getBestSolution().

Here is the caller graph for this function:

◆ sanitizeString()

assFormulaQuestionUnit::sanitizeString ( string $string )

private

Definition at line 163 of file class.assFormulaQuestionUnit.php.

                                                   : string
    {
        return htmlspecialchars($string, ENT_QUOTES | ENT_SUBSTITUTE, 'utf-8');
    }

Referenced by getDisplayString(), and getSanitizedBaseunitTitle().

Here is the caller graph for this function:

◆ setBaseUnit()

assFormulaQuestionUnit::setBaseUnit ( int $baseunit )

Definition at line 97 of file class.assFormulaQuestionUnit.php.

                                              : void
    {
        $this->baseunit = $baseunit;
    }

References $baseunit.

Referenced by ilUnitConfigurationRepository\createNewUnit().

Here is the caller graph for this function:

◆ setBaseunitTitle()

assFormulaQuestionUnit::setBaseunitTitle ( ?string $baseunit_title )

Definition at line 111 of file class.assFormulaQuestionUnit.php.

                                                             : void
    {
        $this->baseunit_title = $baseunit_title;
    }

References $baseunit_title.

◆ setCategory()

assFormulaQuestionUnit::setCategory ( int $category )

Definition at line 126 of file class.assFormulaQuestionUnit.php.

                                              : void
    {
        $this->category = $category;
    }

References $category.

◆ setFactor()

assFormulaQuestionUnit::setFactor ( float $factor )

Definition at line 87 of file class.assFormulaQuestionUnit.php.

                                            : void
    {
        $this->factor = $factor;
    }

References $factor.

Referenced by ilUnitConfigurationRepository\createNewUnit(), and ilUnitConfigurationRepository\saveUnit().

Here is the caller graph for this function:

◆ setId()

assFormulaQuestionUnit::setId ( int $id )

Definition at line 52 of file class.assFormulaQuestionUnit.php.

                                  : void
    {
        $this->id = $id;
    }

References $id.

Referenced by ilUnitConfigurationRepository\createNewUnit().

Here is the caller graph for this function:

◆ setSequence()

assFormulaQuestionUnit::setSequence ( int $sequence )

Definition at line 77 of file class.assFormulaQuestionUnit.php.

                                              : void
    {
        $this->sequence = $sequence;
    }

References $sequence.

Referenced by ilUnitConfigurationRepository\createNewUnit().

Here is the caller graph for this function:

◆ setUnit()

assFormulaQuestionUnit::setUnit ( string $unit )

Definition at line 62 of file class.assFormulaQuestionUnit.php.

                                         : void
    {
        $this->unit = $unit;
    }

References $unit.

◆ toNormalized()

assFormulaQuestionUnit::toNormalized	(	Transformations	$transformations,
		array	$context = `[]`
	)

Convert the internal state of the implementing object into a language-neutral array structure.

The resulting array must contain only null, scalar values (string, int, float, bool) and nested arrays following the same rules.

Parameters

array<string,mixed> $context

Returns: array<array-key, mixed>|float|bool|int|string|null

Implements ILIAS\TestQuestionPool\ExportImport\Foundation\Normalize\ToNormalized.

Definition at line 169 of file class.assFormulaQuestionUnit.php.

     : array|float|bool|int|string|null
    {
        return [
            'id' => $transformations->normalize(new Id($this->id, 'unit')),
            'unit' => $this->unit,
            'factor' => $this->factor,
            'category_id' => $transformations->normalize(new Id($this->category, 'unit_category')),
            'sequence' => $this->sequence,
            'baseunit' => $transformations->normalize(new Id($this->baseunit, 'unit')),
            'baseunit_title' => $this->baseunit_title,
        ];
    }