Collaboration diagram for ILIAS\TestQuestionPool\Questions\GeneralQuestionProperties:

Public Member Functions
	__construct (private readonly \ilComponentFactory $component_factory, private readonly int $question_id, private ?int $original_id=null, private ?string $external_id=null, private int $parent_object_id=0, private ?int $origin_object_id=null, private readonly int $type_id=0, private readonly string $class_name='', private int $owner=0, private string $title='', private string $description='', private string $question_text='', private float $available_points=0.0, private int $number_of_tries=0, private string $lifecycle='draft', private ?string $author=null, private int $updated_timestamp=0, private int $created_timestamp=0, private bool $complete=true, private readonly ?string $additional_content_editing_mode=null)

	getQuestionId ()

	getOriginalId ()

	withOriginalId (int $original_id)

	getExternalId ()

	withExternalId (string $external_id)

	getParentObjectId ()

	withParentObjectId (int $parent_id)

	getOriginObjectId ()

	withOriginObjectId (int $origin_object_id)

	getTypeId ()

	getClassName ()

	getGuiClassName ()

	getTypeName (Language $lng)

	getOwner ()

	withOwner (int $owner)

	getTitle ()

	withTitle (string $title)

	getDescription ()

	withDescription (string $description)

	getQuestionText ()

	withQuestionText (string $question_text)

	getAvailablePoints ()

	withMaximumPoints (float $reachable_points)

	getNumberOfTries ()

	withNumberOfTries (int $number_of_tries)

	getLifecycle ()

	withLifecycle (string $lifecycle)

	getAuthor ()

	withAuthor (string $author)

	getUpdatedTimestamp ()

	withUpdatedTimestamp (int $updated_timestamp)

	getCreatedTimestamp ()

	withCreatedTimestamp (int $created_timestamp)

	isRequiredInformationComplete ()

	withCompletionStatus (bool $complete)

	getAdditionalContentEditingMode ()

	isClone ()
	Checks whether the question is a clone of another question or not. More...

	toStorage ()

Detailed Description

Definition at line 25 of file GeneralQuestionProperties.php.

Constructor & Destructor Documentation

◆ __construct()

ILIAS\TestQuestionPool\Questions\GeneralQuestionProperties::__construct	(	private readonly \ilComponentFactory	$component_factory,
		private readonly int	$question_id,
		private ?int	$original_id = `null`,
		private ?string	$external_id = `null`,
		private int	$parent_object_id = `0`,
		private ?int	$origin_object_id = `null`,
		private readonly int	$type_id = `0`,
		private readonly string	$class_name = `''`,
		private int	$owner = `0`,
		private string	$title = `''`,
		private string	$description = `''`,
		private string	$question_text = `''`,
		private float	$available_points = `0.0`,
		private int	$number_of_tries = `0`,
		private string	$lifecycle = `'draft'`,
		private ?string	$author = `null`,
		private int	$updated_timestamp = `0`,
		private int	$created_timestamp = `0`,
		private bool	$complete = `true`,
		private readonly ?string	$additional_content_editing_mode = `null`
	)

Definition at line 27 of file GeneralQuestionProperties.php.

48 {

49 }

Member Function Documentation

◆ getAdditionalContentEditingMode()

ILIAS\TestQuestionPool\Questions\GeneralQuestionProperties::getAdditionalContentEditingMode ( )

Definition at line 269 of file GeneralQuestionProperties.php.

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

Referenced by ILIAS\TestQuestionPool\Questions\GeneralQuestionProperties\toStorage().

Here is the caller graph for this function:

◆ getAuthor()

ILIAS\TestQuestionPool\Questions\GeneralQuestionProperties::getAuthor ( )

Definition at line 221 of file GeneralQuestionProperties.php.

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

Referenced by ILIAS\TestQuestionPool\Questions\GeneralQuestionProperties\toStorage().

Here is the caller graph for this function:

◆ getAvailablePoints()

ILIAS\TestQuestionPool\Questions\GeneralQuestionProperties::getAvailablePoints ( )

Definition at line 185 of file GeneralQuestionProperties.php.

                                        : float
    {
        return $this->available_points;
    }

Referenced by ILIAS\TestQuestionPool\Questions\GeneralQuestionProperties\toStorage().

Here is the caller graph for this function:

◆ getClassName()

ILIAS\TestQuestionPool\Questions\GeneralQuestionProperties::getClassName ( )

Definition at line 109 of file GeneralQuestionProperties.php.

                                  : string
    {
        return $this->class_name;
    }

◆ getCreatedTimestamp()

ILIAS\TestQuestionPool\Questions\GeneralQuestionProperties::getCreatedTimestamp ( )

Definition at line 245 of file GeneralQuestionProperties.php.

                                         : int
    {
        return $this->created_timestamp;
    }

Referenced by ILIAS\TestQuestionPool\Questions\GeneralQuestionProperties\toStorage().

Here is the caller graph for this function:

◆ getDescription()

ILIAS\TestQuestionPool\Questions\GeneralQuestionProperties::getDescription ( )

Definition at line 161 of file GeneralQuestionProperties.php.

                                    : string
    {
        return $this->description;
    }

Referenced by ILIAS\TestQuestionPool\Questions\GeneralQuestionProperties\toStorage().

Here is the caller graph for this function:

◆ getExternalId()

ILIAS\TestQuestionPool\Questions\GeneralQuestionProperties::getExternalId ( )

Definition at line 68 of file GeneralQuestionProperties.php.

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

Referenced by ILIAS\TestQuestionPool\Questions\GeneralQuestionProperties\toStorage().

Here is the caller graph for this function:

◆ getGuiClassName()

ILIAS\TestQuestionPool\Questions\GeneralQuestionProperties::getGuiClassName ( )

Definition at line 114 of file GeneralQuestionProperties.php.

                                     : string
    {
        return $this->class_name . 'GUI';
    }

◆ getLifecycle()

ILIAS\TestQuestionPool\Questions\GeneralQuestionProperties::getLifecycle ( )

Definition at line 209 of file GeneralQuestionProperties.php.

                                  : string
    {
        return $this->lifecycle;
    }

References $lifecycle.

Referenced by ILIAS\TestQuestionPool\Questions\GeneralQuestionProperties\toStorage().

Here is the caller graph for this function:

◆ getNumberOfTries()

ILIAS\TestQuestionPool\Questions\GeneralQuestionProperties::getNumberOfTries ( )

Definition at line 197 of file GeneralQuestionProperties.php.

                                      : int
    {
        return $this->number_of_tries;
    }

Referenced by ILIAS\TestQuestionPool\Questions\GeneralQuestionProperties\toStorage().

Here is the caller graph for this function:

◆ getOriginalId()

ILIAS\TestQuestionPool\Questions\GeneralQuestionProperties::getOriginalId ( )

Definition at line 56 of file GeneralQuestionProperties.php.

                                   : ?int
    {
        return $this->original_id;
    }

Referenced by ILIAS\TestQuestionPool\Questions\GeneralQuestionProperties\toStorage().

Here is the caller graph for this function:

◆ getOriginObjectId()

ILIAS\TestQuestionPool\Questions\GeneralQuestionProperties::getOriginObjectId ( )

Definition at line 92 of file GeneralQuestionProperties.php.

                                       : ?int
    {
        return $this->origin_object_id;
    }

◆ getOwner()

ILIAS\TestQuestionPool\Questions\GeneralQuestionProperties::getOwner ( )

Definition at line 137 of file GeneralQuestionProperties.php.

                              : int
    {
        return $this->owner;
    }

Referenced by ILIAS\TestQuestionPool\Questions\GeneralQuestionProperties\toStorage().

Here is the caller graph for this function:

◆ getParentObjectId()

ILIAS\TestQuestionPool\Questions\GeneralQuestionProperties::getParentObjectId ( )

Definition at line 80 of file GeneralQuestionProperties.php.

                                       : int
    {
        return $this->parent_object_id;
    }

Referenced by ILIAS\TestQuestionPool\Questions\GeneralQuestionProperties\toStorage().

Here is the caller graph for this function:

◆ getQuestionId()

ILIAS\TestQuestionPool\Questions\GeneralQuestionProperties::getQuestionId ( )

Definition at line 51 of file GeneralQuestionProperties.php.

                                   : int
    {
        return $this->question_id;
    }

Referenced by ILIAS\Test\Questions\Properties\DatabaseRepository\buildQuestionPropertiesForRandomTest(), and ILIAS\TestQuestionPool\Questions\GeneralQuestionProperties\toStorage().

Here is the caller graph for this function:

◆ getQuestionText()

ILIAS\TestQuestionPool\Questions\GeneralQuestionProperties::getQuestionText ( )

Definition at line 173 of file GeneralQuestionProperties.php.

                                     : string
    {
        return $this->question_text;
    }

Referenced by ILIAS\TestQuestionPool\Questions\GeneralQuestionProperties\toStorage().

Here is the caller graph for this function:

◆ getTitle()

ILIAS\TestQuestionPool\Questions\GeneralQuestionProperties::getTitle ( )

Definition at line 149 of file GeneralQuestionProperties.php.

                              : string
    {
        return $this->title;
    }

Referenced by ILIAS\TestQuestionPool\Questions\GeneralQuestionProperties\toStorage().

Here is the caller graph for this function:

◆ getTypeId()

ILIAS\TestQuestionPool\Questions\GeneralQuestionProperties::getTypeId ( )

Definition at line 104 of file GeneralQuestionProperties.php.

                               : int
    {
        return $this->type_id;
    }

Referenced by ILIAS\TestQuestionPool\Questions\GeneralQuestionProperties\toStorage().

Here is the caller graph for this function:

◆ getTypeName()

ILIAS\TestQuestionPool\Questions\GeneralQuestionProperties::getTypeName ( Language $lng )

Definition at line 119 of file GeneralQuestionProperties.php.

                                              : string
    {
        if ($this->class_name === '') {
            return '';
        }
 
        if (file_exists(ILIAS_ABSOLUTE_PATH . '/components/ILIAS/TestQuestionPool/classes/class.' . $this->class_name . '.php')) {
            return $lng->txt($this->class_name);
        }
 
        foreach ($this->component_factory->getActivePluginsInSlot('qst') as $pl) {
            if ($pl->getQuestionType() === $this->class_name) {
                return $pl->getQuestionTypeTranslation();
            }
        }
        return '';
    }

References $lng.

◆ getUpdatedTimestamp()

ILIAS\TestQuestionPool\Questions\GeneralQuestionProperties::getUpdatedTimestamp ( )

Definition at line 233 of file GeneralQuestionProperties.php.

                                         : int
    {
        return $this->updated_timestamp;
    }

Referenced by ILIAS\TestQuestionPool\Questions\GeneralQuestionProperties\toStorage().

Here is the caller graph for this function:

◆ isClone()

ILIAS\TestQuestionPool\Questions\GeneralQuestionProperties::isClone ( )

Checks whether the question is a clone of another question or not.

Definition at line 277 of file GeneralQuestionProperties.php.

                             : bool
    {
        return $this->original_id !== null;
    }

◆ isRequiredInformationComplete()

ILIAS\TestQuestionPool\Questions\GeneralQuestionProperties::isRequiredInformationComplete ( )

Definition at line 257 of file GeneralQuestionProperties.php.

                                                   : bool
    {
        return $this->complete;
    }

Referenced by ILIAS\TestQuestionPool\Questions\GeneralQuestionProperties\toStorage().

Here is the caller graph for this function:

◆ toStorage()

ILIAS\TestQuestionPool\Questions\GeneralQuestionProperties::toStorage ( )

Returns: array<string, mixed>

Definition at line 285 of file GeneralQuestionProperties.php.

                               : array
    {
        return [
            'question_id' => [\ilDBConstants::T_INTEGER, $this->getQuestionId()],
            'question_type_fi' => [\ilDBConstants::T_INTEGER, $this->getTypeId()],
            'obj_fi' => [\ilDBConstants::T_INTEGER, $this->getParentObjectId()],
            'title' => [\ilDBConstants::T_TEXT, $this->getTitle()],
            'description' => [\ilDBConstants::T_TEXT, $this->getDescription()],
            'author' => [\ilDBConstants::T_TEXT, $this->getAuthor()],
            'owner' => [\ilDBConstants::T_INTEGER, $this->getOwner()],
            'points' => [\ilDBConstants::T_FLOAT, $this->getAvailablePoints()],
            'complete' => [\ilDBConstants::T_TEXT, $this->isRequiredInformationComplete()],
            'original_id' => [\ilDBConstants::T_INTEGER, $this->getOriginalId()],
            'tstamp' => [\ilDBConstants::T_INTEGER, $this->getUpdatedTimestamp()],
            'created' => [\ilDBConstants::T_INTEGER, $this->getCreatedTimestamp()],
            'nr_of_tries' => [\ilDBConstants::T_INTEGER, $this->getNumberOfTries()],
            'question_text' => [\ilDBConstants::T_TEXT, $this->getQuestionText()],
            'add_content_edit_mode' => [\ilDBConstants::T_TEXT, $this->getAdditionalContentEditingMode()],
            'external_id' => [\ilDBConstants::T_TEXT, $this->getExternalId()],
            'lifecycle' => [\ilDBConstants::T_TEXT, $this->getLifecycle()]
        ];
    }

Here is the call graph for this function:

◆ withAuthor()

ILIAS\TestQuestionPool\Questions\GeneralQuestionProperties::withAuthor ( string $author )

Definition at line 226 of file GeneralQuestionProperties.php.

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

◆ withCompletionStatus()

ILIAS\TestQuestionPool\Questions\GeneralQuestionProperties::withCompletionStatus ( bool $complete )

Definition at line 262 of file GeneralQuestionProperties.php.

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

◆ withCreatedTimestamp()

ILIAS\TestQuestionPool\Questions\GeneralQuestionProperties::withCreatedTimestamp ( int $created_timestamp )

Definition at line 250 of file GeneralQuestionProperties.php.

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

◆ withDescription()

ILIAS\TestQuestionPool\Questions\GeneralQuestionProperties::withDescription ( string $description )

Definition at line 166 of file GeneralQuestionProperties.php.

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

◆ withExternalId()

ILIAS\TestQuestionPool\Questions\GeneralQuestionProperties::withExternalId ( string $external_id )

Definition at line 73 of file GeneralQuestionProperties.php.

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

◆ withLifecycle()

ILIAS\TestQuestionPool\Questions\GeneralQuestionProperties::withLifecycle ( string $lifecycle )

Definition at line 214 of file GeneralQuestionProperties.php.

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

References $lifecycle.

◆ withMaximumPoints()

ILIAS\TestQuestionPool\Questions\GeneralQuestionProperties::withMaximumPoints ( float $reachable_points )

Definition at line 190 of file GeneralQuestionProperties.php.

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

◆ withNumberOfTries()

ILIAS\TestQuestionPool\Questions\GeneralQuestionProperties::withNumberOfTries ( int $number_of_tries )

Definition at line 202 of file GeneralQuestionProperties.php.

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

◆ withOriginalId()

ILIAS\TestQuestionPool\Questions\GeneralQuestionProperties::withOriginalId ( int $original_id )

Definition at line 61 of file GeneralQuestionProperties.php.

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

◆ withOriginObjectId()

ILIAS\TestQuestionPool\Questions\GeneralQuestionProperties::withOriginObjectId ( int $origin_object_id )

Definition at line 97 of file GeneralQuestionProperties.php.

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

◆ withOwner()

ILIAS\TestQuestionPool\Questions\GeneralQuestionProperties::withOwner ( int $owner )

Definition at line 142 of file GeneralQuestionProperties.php.

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

◆ withParentObjectId()

ILIAS\TestQuestionPool\Questions\GeneralQuestionProperties::withParentObjectId ( int $parent_id )

Definition at line 85 of file GeneralQuestionProperties.php.

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

◆ withQuestionText()

ILIAS\TestQuestionPool\Questions\GeneralQuestionProperties::withQuestionText ( string $question_text )

Definition at line 178 of file GeneralQuestionProperties.php.

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

◆ withTitle()

ILIAS\TestQuestionPool\Questions\GeneralQuestionProperties::withTitle ( string $title )

Definition at line 154 of file GeneralQuestionProperties.php.

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

◆ withUpdatedTimestamp()

ILIAS\TestQuestionPool\Questions\GeneralQuestionProperties::withUpdatedTimestamp ( int $updated_timestamp )

Definition at line 238 of file GeneralQuestionProperties.php.

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

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

components/ILIAS/TestQuestionPool/src/Questions/GeneralQuestionProperties.php

Public Member Functions

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ getAdditionalContentEditingMode()

◆ getAuthor()

◆ getAvailablePoints()

◆ getClassName()

◆ getCreatedTimestamp()

◆ getDescription()

◆ getExternalId()

◆ getGuiClassName()

◆ getLifecycle()

◆ getNumberOfTries()

◆ getOriginalId()

◆ getOriginObjectId()

◆ getOwner()

◆ getParentObjectId()

◆ getQuestionId()

◆ getQuestionText()

◆ getTitle()

◆ getTypeId()

◆ getTypeName()

◆ getUpdatedTimestamp()

◆ isClone()

◆ isRequiredInformationComplete()

◆ toStorage()

◆ withAuthor()

◆ withCompletionStatus()

◆ withCreatedTimestamp()

◆ withDescription()

◆ withExternalId()

◆ withLifecycle()

◆ withMaximumPoints()

◆ withNumberOfTries()

◆ withOriginalId()

◆ withOriginObjectId()

◆ withOwner()

◆ withParentObjectId()

◆ withQuestionText()

◆ withTitle()

◆ withUpdatedTimestamp()