Collaboration diagram for ilAssOrderingElement:

Public Member Functions
	__construct (int $id=-1)
	ilAssOrderingElement constructor. More...

	__clone ()
	Cloning. More...

	getClone ()

	getId ()

	setId (int $id)

	getRandomIdentifier ()

	setRandomIdentifier (int $random_identifier)

	getSolutionIdentifier ()

	setSolutionIdentifier (int $solution_identifier)

	setIndentation (int $indentation)

	getIndentation ()

	getPosition ()

	setPosition (int $position)

	getContent ()

	setContent ($content)

	getUploadImageFile ()

	setUploadImageFile ($uploadImageFile)

	getUploadImageName ()

	setUploadImageName ($uploadImageName)

	isImageUploadAvailable ()

	isImageRemovalRequest ()

	setImageRemovalRequest ($imageRemovalRequest)

	getImagePathWeb ()

	setImagePathWeb ($imagePathWeb)

	getImagePathFs ()

	setImagePathFs (string $image_path_fs)

	getImageThumbnailPrefix ()

	setImageThumbnailPrefix ($imageThumbnailPrefix)

	isSameElement (ilAssOrderingElement $element)

	getStorageValue1 (int $ordering_type)

	getStorageValue2 (int $ordering_type)

	__toString ()

	getPresentationImageUrl ()

	getExportIdent ()

	isExportIdent (string $ident)

	setExportIdent ($ident)

	withRandomIdentifier (int $id)

	withSolutionIdentifier (int $id)

	withPosition (int $position)

	withIndentation (int $indentation)

	withContent (string $content)

Data Fields
const	EXPORT_IDENT_PROPERTY_SEPARATOR = '_'

	$objectInstanceId

int	$id

Static Public Attributes
static	$objectInstanceCounter = 0

Protected Member Functions
	thumbnailFileExists ()

	getThumbnailFilePath ()

	getThumbnailFileUrl ()

	imageFileExists ()

	getImageFilePath ()

	getImageFileUrl ()

Protected Attributes
int	$random_identifier = null
	this identifier is generated randomly it is recycled for known elements More...

int	$solution_identifier = null
	this identifier is used to identify elements and is stored together with the set position and indentation More...

int	$indentation = 0
	the correct width of indentation for the element More...

int	$position = null
	the correct position in the ordering sequence More...

string	$content = null

string	$uploadImageName = null

string	$uploadImageFile = null

bool	$imageRemovalRequest = false

string	$imagePathWeb = null

string	$image_path_fs = null

	$imageThumbnailPrefix = null

Detailed Description

Definition at line 28 of file class.ilAssOrderingElement.php.

Constructor & Destructor Documentation

◆ __construct()

ilAssOrderingElement::__construct ( int $id = -1 )

ilAssOrderingElement constructor.

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

    {
        $this->id = $id;
        $this->objectInstanceId = ++self::$objectInstanceCounter;
    }

References $id, and $objectInstanceCounter.

Member Function Documentation

◆ __clone()

ilAssOrderingElement::__clone ( )

Cloning.

Definition at line 91 of file class.ilAssOrderingElement.php.

    {
        $this->objectInstanceId = ++self::$objectInstanceCounter;
    }

References $objectInstanceCounter.

◆ __toString()

ilAssOrderingElement::__toString ( )

Definition at line 315 of file class.ilAssOrderingElement.php.

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

References getContent().

Here is the call graph for this function:

◆ getClone()

ilAssOrderingElement::getClone ( )

Definition at line 96 of file class.ilAssOrderingElement.php.

                              : ilAssOrderingElement
    {
        return clone $this;
    }

◆ getContent()

ilAssOrderingElement::getContent ( )

Returns: string

Definition at line 157 of file class.ilAssOrderingElement.php.

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

References $content.

Referenced by __toString(), assOrderingQuestionGUI\getAnswerStatisticOrderingElementHtml(), assOrderingQuestion\getElementArrayWithIdentationsForTextOutput(), ilAssOrderingFormValuesObjectsConverter\getImageContentValueFromObject(), getImageFilePath(), getImageFileUrl(), ilAssOrderingFormValuesObjectsConverter\getStructValueFromObject(), ilAssOrderingFormValuesObjectsConverter\getTextContentValueFromObject(), getThumbnailFilePath(), getThumbnailFileUrl(), imageFileExists(), ILIAS\TestQuestionPool\Questions\Ordering\OrderingQuestionDatabaseRepository\insertOrderingElement(), assOrderingQuestion\isImageReplaced(), assOrderingQuestionTest\testOrderingElementMutation(), and thumbnailFileExists().

Here is the caller graph for this function:

◆ getExportIdent()

ilAssOrderingElement::getExportIdent ( )

Definition at line 371 of file class.ilAssOrderingElement.php.

                                    : string
    {
        $ident = [
            $this->getRandomIdentifier(),
            $this->getSolutionIdentifier(),
            $this->getPosition(),
            $this->getIndentation()
        ];
 
        return implode(self::EXPORT_IDENT_PROPERTY_SEPARATOR, $ident);
    }

References getIndentation(), getPosition(), getRandomIdentifier(), and getSolutionIdentifier().

Here is the call graph for this function:

◆ getId()

ilAssOrderingElement::getId ( )

Definition at line 101 of file class.ilAssOrderingElement.php.

                           : int
    {
        return $this->id;
    }

References $id.

Referenced by ilAssOrderingFormValuesObjectsConverter\getStructValueFromObject().

Here is the caller graph for this function:

◆ getImageFilePath()

ilAssOrderingElement::getImageFilePath ( )

protected

Definition at line 348 of file class.ilAssOrderingElement.php.

                                         : string
    {
        return $this->getImagePathFs() . $this->getContent();
    }

References getContent(), and getImagePathFs().

Referenced by imageFileExists().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getImageFileUrl()

ilAssOrderingElement::getImageFileUrl ( )

protected

Definition at line 353 of file class.ilAssOrderingElement.php.

                                        : string
    {
        return $this->getImagePathWeb() . $this->getContent();
    }

References getContent(), and getImagePathWeb().

Referenced by getPresentationImageUrl().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getImagePathFs()

ilAssOrderingElement::getImagePathFs ( )

Returns: string

Definition at line 250 of file class.ilAssOrderingElement.php.

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

References $image_path_fs.

Referenced by getImageFilePath(), and getThumbnailFilePath().

Here is the caller graph for this function:

◆ getImagePathWeb()

ilAssOrderingElement::getImagePathWeb ( )

Returns: string

Definition at line 234 of file class.ilAssOrderingElement.php.

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

References $imagePathWeb.

Referenced by getImageFileUrl(), and getThumbnailFileUrl().

Here is the caller graph for this function:

◆ getImageThumbnailPrefix()

ilAssOrderingElement::getImageThumbnailPrefix ( )

Definition at line 260 of file class.ilAssOrderingElement.php.

    {
        return $this->imageThumbnailPrefix;
    }

References $imageThumbnailPrefix.

Referenced by getThumbnailFilePath(), and getThumbnailFileUrl().

Here is the caller graph for this function:

◆ getIndentation()

ilAssOrderingElement::getIndentation ( )

Definition at line 139 of file class.ilAssOrderingElement.php.

                                    : int
    {
        return $this->indentation;
    }

References $indentation.

Referenced by assOrderingQuestion\getElementArrayWithIdentationsForTextOutput(), getExportIdent(), getStorageValue2(), ilAssOrderingFormValuesObjectsConverter\getStructValueFromObject(), ILIAS\TestQuestionPool\Questions\Ordering\OrderingQuestionDatabaseRepository\insertOrderingElement(), isSameElement(), and assOrderingQuestionTest\testOrderingElementMutation().

Here is the caller graph for this function:

◆ getPosition()

ilAssOrderingElement::getPosition ( )

Definition at line 144 of file class.ilAssOrderingElement.php.

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

References $position.

Referenced by getExportIdent(), getStorageValue1(), getStorageValue2(), ilAssOrderingFormValuesObjectsConverter\getStructValueFromObject(), ILIAS\TestQuestionPool\Questions\Ordering\OrderingQuestionDatabaseRepository\insertOrderingElement(), isSameElement(), and assOrderingQuestionTest\testOrderingElementMutation().

Here is the caller graph for this function:

◆ getPresentationImageUrl()

ilAssOrderingElement::getPresentationImageUrl ( )

Definition at line 358 of file class.ilAssOrderingElement.php.

                                             : string
    {
        if ($this->thumbnailFileExists()) {
            return $this->getThumbnailFileUrl();
        }
 
        if ($this->imageFileExists()) {
            return $this->getImageFileUrl();
        }
 
        return '';
    }

References getImageFileUrl(), getThumbnailFileUrl(), imageFileExists(), and thumbnailFileExists().

Referenced by assOrderingQuestionGUI\getAnswerStatisticOrderingElementHtml(), and ilAssOrderingFormValuesObjectsConverter\getImageContentValueFromObject().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getRandomIdentifier()

ilAssOrderingElement::getRandomIdentifier ( )

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

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

References $random_identifier.

Referenced by ilAssOrderingElementList\fetchIdentifier(), getExportIdent(), getStorageValue2(), ilAssOrderingFormValuesObjectsConverter\getStructValueFromObject(), ILIAS\TestQuestionPool\Questions\Ordering\OrderingQuestionDatabaseRepository\insertOrderingElement(), isSameElement(), and assOrderingQuestionTest\testOrderingElementMutation().

Here is the caller graph for this function:

◆ getSolutionIdentifier()

ilAssOrderingElement::getSolutionIdentifier ( )

Returns: int

Definition at line 124 of file class.ilAssOrderingElement.php.

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

References $solution_identifier.

Referenced by ilAssOrderingElementList\fetchIdentifier(), getExportIdent(), getStorageValue1(), ILIAS\TestQuestionPool\Questions\Ordering\OrderingQuestionDatabaseRepository\insertOrderingElement(), isSameElement(), and assOrderingQuestionTest\testOrderingElementMutation().

Here is the caller graph for this function:

◆ getStorageValue1()

ilAssOrderingElement::getStorageValue1 ( int $ordering_type )

Definition at line 285 of file class.ilAssOrderingElement.php.

                                                        : int|string
    {
        switch ($ordering_type) {
            case assOrderingQuestion::OQ_NESTED_TERMS:
            case assOrderingQuestion::OQ_NESTED_PICTURES:
 
                return $this->getPosition();
 
            case assOrderingQuestion::OQ_TERMS:
            case assOrderingQuestion::OQ_PICTURES:
            default:
                return $this->getSolutionIdentifier();
        }
    }

References getPosition(), getSolutionIdentifier(), assOrderingQuestion\OQ_NESTED_PICTURES, assOrderingQuestion\OQ_NESTED_TERMS, assOrderingQuestion\OQ_PICTURES, and assOrderingQuestion\OQ_TERMS.

Here is the call graph for this function:

◆ getStorageValue2()

ilAssOrderingElement::getStorageValue2 ( int $ordering_type )

Definition at line 300 of file class.ilAssOrderingElement.php.

                                                        : int|string
    {
        switch ($ordering_type) {
            case assOrderingQuestion::OQ_NESTED_TERMS:
            case assOrderingQuestion::OQ_NESTED_PICTURES:
 
                return $this->getRandomIdentifier() . ':' . $this->getIndentation();
 
            case assOrderingQuestion::OQ_TERMS:
            case assOrderingQuestion::OQ_PICTURES:
            default:
                return $this->getPosition() + 1;
        }
    }

References getIndentation(), getPosition(), getRandomIdentifier(), assOrderingQuestion\OQ_NESTED_PICTURES, assOrderingQuestion\OQ_NESTED_TERMS, assOrderingQuestion\OQ_PICTURES, and assOrderingQuestion\OQ_TERMS.

Here is the call graph for this function:

◆ getThumbnailFilePath()

ilAssOrderingElement::getThumbnailFilePath ( )

protected

Definition at line 329 of file class.ilAssOrderingElement.php.

                                             : string
    {
        return $this->getImagePathFs() . $this->getImageThumbnailPrefix() . $this->getContent();
    }

References getContent(), getImagePathFs(), and getImageThumbnailPrefix().

Referenced by thumbnailFileExists().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getThumbnailFileUrl()

ilAssOrderingElement::getThumbnailFileUrl ( )

protected

Definition at line 334 of file class.ilAssOrderingElement.php.

                                            : string
    {
        return $this->getImagePathWeb() . $this->getImageThumbnailPrefix() . $this->getContent();
    }

References getContent(), getImagePathWeb(), and getImageThumbnailPrefix().

Referenced by getPresentationImageUrl().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getUploadImageFile()

ilAssOrderingElement::getUploadImageFile ( )

Definition at line 171 of file class.ilAssOrderingElement.php.

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

References $uploadImageFile.

Referenced by isImageUploadAvailable().

Here is the caller graph for this function:

◆ getUploadImageName()

ilAssOrderingElement::getUploadImageName ( )

Returns: string

Definition at line 190 of file class.ilAssOrderingElement.php.

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

References $uploadImageName.

◆ imageFileExists()

ilAssOrderingElement::imageFileExists ( )

protected

Definition at line 339 of file class.ilAssOrderingElement.php.

                                        : bool
    {
        if (!$this->getContent()) {
            return false;
        }
 
        return file_exists($this->getImageFilePath());
    }

References getContent(), and getImageFilePath().

Referenced by getPresentationImageUrl().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ isExportIdent()

ilAssOrderingElement::isExportIdent ( string $ident )

Definition at line 383 of file class.ilAssOrderingElement.php.

                                                : bool
    {
        if (!strlen($ident)) {
            return false;
        }
 
        $parts = explode(self::EXPORT_IDENT_PROPERTY_SEPARATOR, $ident);
        return
            count($parts) == 4
            && ilAssOrderingElementList::isValidRandomIdentifier($parts[0])
            && ilAssOrderingElementList::isValidSolutionIdentifier($parts[1])
            && ilAssOrderingElementList::isValidPosition($parts[2])
            && ilAssOrderingElementList::isValidIndentation($parts[3]);
    }

References $parts, ilAssOrderingElementList\isValidIndentation(), ilAssOrderingElementList\isValidPosition(), ilAssOrderingElementList\isValidRandomIdentifier(), and ilAssOrderingElementList\isValidSolutionIdentifier().

Referenced by setExportIdent().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ isImageRemovalRequest()

ilAssOrderingElement::isImageRemovalRequest ( )

Returns: bool

Definition at line 218 of file class.ilAssOrderingElement.php.

                                           : ?bool
    {
        return $this->imageRemovalRequest;
    }

References $imageRemovalRequest.

◆ isImageUploadAvailable()

ilAssOrderingElement::isImageUploadAvailable ( )

Returns: bool

Definition at line 209 of file class.ilAssOrderingElement.php.

                                            : bool
    {
        return $this->getUploadImageFile() !== null
            && $this->getUploadImageFile() !== '';
    }

References getUploadImageFile().

Here is the call graph for this function:

◆ isSameElement()

ilAssOrderingElement::isSameElement ( ilAssOrderingElement $element )

Definition at line 270 of file class.ilAssOrderingElement.php.

                                                                : bool
    {
        return [
            $this->getRandomIdentifier(),
            $this->getSolutionIdentifier(),
            $this->getPosition(),
            $this->getIndentation(),
        ] == [
            $element->getRandomIdentifier(),
            $element->getSolutionIdentifier(),
            $element->getPosition(),
            $element->getIndentation()
        ];
    }

References getIndentation(), getPosition(), getRandomIdentifier(), and getSolutionIdentifier().

Here is the call graph for this function:

◆ setContent()

ilAssOrderingElement::setContent ( $content )

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

                                        : void
    {
        if (is_array($content)) {
            $content = array_shift($content);
        }
        $this->content = $content;
    }

References $content.

◆ setExportIdent()

ilAssOrderingElement::setExportIdent ( $ident )

Definition at line 398 of file class.ilAssOrderingElement.php.

                                          : void
    {
        if ($this->isExportIdent($ident)) {
            list($randomId, $solutionId, $pos, $indent) = explode(
                self::EXPORT_IDENT_PROPERTY_SEPARATOR,
                $ident
            );
            $this->setRandomIdentifier((int) $randomId);
            $this->setSolutionIdentifier((int) $solutionId);
            $this->setPosition((int) $pos);
            $this->setIndentation((int) $indent);
        }
    }

References isExportIdent(), setIndentation(), setPosition(), setRandomIdentifier(), and setSolutionIdentifier().

Here is the call graph for this function:

◆ setId()

ilAssOrderingElement::setId ( int $id )

Definition at line 106 of file class.ilAssOrderingElement.php.

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

References $id.

◆ setImagePathFs()

ilAssOrderingElement::setImagePathFs ( string $image_path_fs )

Definition at line 255 of file class.ilAssOrderingElement.php.

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

References $image_path_fs.

Referenced by assOrderingQuestionGUI\getAnswerStatisticOrderingElementHtml(), and ilAssOrderingFormValuesObjectsConverter\getImageContentValueFromObject().

Here is the caller graph for this function:

◆ setImagePathWeb()

ilAssOrderingElement::setImagePathWeb ( $imagePathWeb )

Parameters

string $imagePathWeb

Definition at line 242 of file class.ilAssOrderingElement.php.

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

References $imagePathWeb.

Referenced by assOrderingQuestionGUI\getAnswerStatisticOrderingElementHtml(), and ilAssOrderingFormValuesObjectsConverter\getImageContentValueFromObject().

Here is the caller graph for this function:

◆ setImageRemovalRequest()

ilAssOrderingElement::setImageRemovalRequest ( $imageRemovalRequest )

Parameters

bool $imageRemovalRequest

Definition at line 226 of file class.ilAssOrderingElement.php.

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

References $imageRemovalRequest.

◆ setImageThumbnailPrefix()

ilAssOrderingElement::setImageThumbnailPrefix ( $imageThumbnailPrefix )

Definition at line 265 of file class.ilAssOrderingElement.php.

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

References $imageThumbnailPrefix.

Referenced by assOrderingQuestionGUI\getAnswerStatisticOrderingElementHtml(), and ilAssOrderingFormValuesObjectsConverter\getImageContentValueFromObject().

Here is the caller graph for this function:

◆ setIndentation()

ilAssOrderingElement::setIndentation ( int $indentation )

Definition at line 134 of file class.ilAssOrderingElement.php.

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

References $indentation.

Referenced by setExportIdent().

Here is the caller graph for this function:

◆ setPosition()

ilAssOrderingElement::setPosition ( int $position )

Definition at line 149 of file class.ilAssOrderingElement.php.

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

References $position.

Referenced by setExportIdent().

Here is the caller graph for this function:

◆ setRandomIdentifier()

ilAssOrderingElement::setRandomIdentifier ( int $random_identifier )

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

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

References $random_identifier.

Referenced by ilAssOrderingElementList\populateIdentifier(), and setExportIdent().

Here is the caller graph for this function:

◆ setSolutionIdentifier()

ilAssOrderingElement::setSolutionIdentifier ( int $solution_identifier )

Definition at line 129 of file class.ilAssOrderingElement.php.

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

References $solution_identifier.

Referenced by ilAssOrderingElementList\populateIdentifier(), and setExportIdent().

Here is the caller graph for this function:

◆ setUploadImageFile()

ilAssOrderingElement::setUploadImageFile ( $uploadImageFile )

Parameters

string $uploadImageFile

Definition at line 179 of file class.ilAssOrderingElement.php.

                                                        : void
    {
        if (is_array($uploadImageFile)) {
            $uploadImageFile = array_shift($uploadImageFile);
        }
        $this->uploadImageFile = $uploadImageFile;
    }

References $uploadImageFile.

◆ setUploadImageName()

ilAssOrderingElement::setUploadImageName ( $uploadImageName )

Parameters

string $uploadImageName

Definition at line 198 of file class.ilAssOrderingElement.php.

                                                        : void
    {
        if (is_array($uploadImageName)) {
            $uploadImageName = array_shift($uploadImageName);
        }
        $this->uploadImageName = $uploadImageName;
    }

References $uploadImageName.

◆ thumbnailFileExists()

ilAssOrderingElement::thumbnailFileExists ( )

protected

Definition at line 320 of file class.ilAssOrderingElement.php.

                                            : bool
    {
        if (!$this->getContent()) {
            return false;
        }
 
        return file_exists($this->getThumbnailFilePath());
    }

References getContent(), and getThumbnailFilePath().

Referenced by getPresentationImageUrl().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ withContent()

ilAssOrderingElement::withContent ( string $content )

Definition at line 437 of file class.ilAssOrderingElement.php.

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

References $content.

Referenced by assOrderingQuestionTest\testOrderingElementMutation().

Here is the caller graph for this function:

◆ withIndentation()

ilAssOrderingElement::withIndentation ( int $indentation )

Definition at line 431 of file class.ilAssOrderingElement.php.

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

References $indentation.

Referenced by assOrderingQuestionTest\testOrderingElementMutation().

Here is the caller graph for this function:

◆ withPosition()

ilAssOrderingElement::withPosition ( int $position )

Definition at line 425 of file class.ilAssOrderingElement.php.

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

References $position.

Referenced by assOrderingQuestionTest\testOrderingElementMutation().

Here is the caller graph for this function:

◆ withRandomIdentifier()

ilAssOrderingElement::withRandomIdentifier ( int $id )

Definition at line 413 of file class.ilAssOrderingElement.php.

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

References $id.

Referenced by assOrderingQuestionTest\testOrderingElementMutation().

Here is the caller graph for this function:

◆ withSolutionIdentifier()

ilAssOrderingElement::withSolutionIdentifier ( int $id )

Definition at line 419 of file class.ilAssOrderingElement.php.

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