assAnswerMatchingTerm Class Reference

Class for matching question terms. More...

Inheritance diagram for assAnswerMatchingTerm:

Collaboration diagram for assAnswerMatchingTerm:

Public Member Functions
	__construct (string $text="", string $picture="", int $identifier=0)
	getText ()
	withText (string $text)
	getPicture ()
	withPicture (string $picture)
	getIdentifier ()
	withIdentifier (int $identifier)
	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...

Protected Member Functions
	createIdentifier ()

Protected Attributes
string	$text
string	$picture
int	$identifier

Detailed Description

Class for matching question terms.

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 32 of file class.assAnswerMatchingTerm.php.

Constructor & Destructor Documentation

__construct()

assAnswerMatchingTerm::__construct	(	string	$text = "",
		string	$picture = "",
		int	$identifier = 0
	)

Definition at line 38 of file class.assAnswerMatchingTerm.php.

    {
        $this->text = $text;
        $this->picture = $picture;
 
        $this->identifier = ($identifier !== 0) ? $identifier : $this->createIdentifier();
    }

References $identifier, $picture, $text, and createIdentifier().

Here is the call graph for this function:

Member Function Documentation

createIdentifier()

assAnswerMatchingTerm::createIdentifier ( )

protected

Definition at line 46 of file class.assAnswerMatchingTerm.php.

                                         : int
    {
        $id = random_int(1, 100000);
        return $id;
    }

References $id.

Referenced by __construct().

Here is the caller graph for this function:

fromNormalized()

assAnswerMatchingTerm::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 101 of file class.assAnswerMatchingTerm.php.

     : self
    {
        return $this->withText($transformations->string($normalized['text']))
            ->withPicture($transformations->denormalize($normalized['picture'], QuestionImage::class)?->getFilename() ?? '')
            ->withIdentifier($transformations->int($normalized['identifier']));
    }

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

Here is the call graph for this function:

getIdentifier()

assAnswerMatchingTerm::getIdentifier

(

)

Definition at line 74 of file class.assAnswerMatchingTerm.php.

                                   : int
    {
        return $this->identifier;
    }

References $identifier.

Referenced by assMatchingQuestionGUI\buildTermHtml(), and assMatchingQuestionGUI\populateDefinition().

Here is the caller graph for this function:

getPicture()

assAnswerMatchingTerm::getPicture

(

)

Definition at line 63 of file class.assAnswerMatchingTerm.php.

                                : string
    {
        return $this->picture;
    }

References $picture.

Referenced by assMatchingQuestionGUI\buildTermHtml(), and assMatchingQuestionGUI\populateDefinition().

Here is the caller graph for this function:

getText()

assAnswerMatchingTerm::getText

(

)

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

                             : string
    {
        return $this->text;
    }

References $text.

Referenced by assMatchingQuestionGUI\buildTermHtml(), and assMatchingQuestionGUI\populateDefinition().

Here is the caller graph for this function:

toNormalized()

assAnswerMatchingTerm::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 86 of file class.assAnswerMatchingTerm.php.

     : array|float|bool|int|string|null
    {
        return [
            'text' => $this->text,
            'picture' => $this->picture
                ? $transformations->normalize(new QuestionImage($this->picture, $context['question_id'] ?? null))
                : null,
            'identifier' => $this->identifier,
        ];
    }

References $identifier, $text, and ILIAS\TestQuestionPool\ExportImport\Foundation\Normalize\Transformations\normalize().

Here is the call graph for this function:

withIdentifier()

assAnswerMatchingTerm::withIdentifier

(

int

$identifier

)

Definition at line 78 of file class.assAnswerMatchingTerm.php.

                                                   : self
    {
        $clone = clone $this;
        $clone->identifier = $identifier;
        return $clone;
    }

References $identifier.

withPicture()

assAnswerMatchingTerm::withPicture

(

string

$picture

)

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

                                                : self
    {
        $clone = clone $this;
        $clone->picture = $picture;
        return $clone;
    }

References $picture.

withText()

assAnswerMatchingTerm::withText

(

string

$text

)

Definition at line 56 of file class.assAnswerMatchingTerm.php.

                                          : self
    {
        $clone = clone $this;
        $clone->text = $text;
        return $clone;
    }

References $text.

Referenced by fromNormalized().

Here is the caller graph for this function:

Field Documentation

$identifier

int assAnswerMatchingTerm::$identifier

protected

Definition at line 36 of file class.assAnswerMatchingTerm.php.

Referenced by __construct(), getIdentifier(), toNormalized(), and withIdentifier().

$picture

string assAnswerMatchingTerm::$picture

protected

Definition at line 35 of file class.assAnswerMatchingTerm.php.

Referenced by __construct(), getPicture(), and withPicture().

$text

string assAnswerMatchingTerm::$text

protected

Definition at line 34 of file class.assAnswerMatchingTerm.php.

Referenced by __construct(), getText(), toNormalized(), and withText().

---

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

• components/ILIAS/TestQuestionPool/classes/class.assAnswerMatchingTerm.php