Collaboration diagram for ilAssOrderingElement:

Public Member Functions
	__construct ()
	ilAssOrderingElement constructor. More...

	__clone ()
	Cloning. More...

	getClone ()

	getId ()

	setId ($id)

	getRandomIdentifier ()

	setRandomIdentifier ($randomIdentifier)

	getSolutionIdentifier ()

	setSolutionIdentifier ($solutionIdentifier)

	setIndentation ($indentation)

	getIndentation ()

	getPosition ()

	setPosition ($position)

	getContent ()

	setContent ($content)

	getUploadImageFile ()

	setUploadImageFile ($uploadImageFile)

	getUploadImageName ()

	setUploadImageName ($uploadImageName)

	isImageUploadAvailable ()

	isImageRemovalRequest ()

	setImageRemovalRequest ($imageRemovalRequest)

	getImagePathWeb ()

	setImagePathWeb ($imagePathWeb)

	getImagePathFs ()

	setImagePathFs ($imagePathFs)

	getImageThumbnailPrefix ()

	setImageThumbnailPrefix ($imageThumbnailPrefix)

	isSameElement (ilAssOrderingElement $element)

	getStorageValue1 ($orderingType)

	getStorageValue2 ($orderingType)

	__toString ()

	getPresentationImageUrl ()

	getExportIdent ()

	isExportIdent ($ident)

	setExportIdent ($ident)

Data Fields
const	EXPORT_IDENT_PROPERTY_SEPARATOR = '_'

	$objectInstanceId

	$id = -1

Static Public Attributes
static	$objectInstanceCounter = 0

Protected Member Functions
	thumbnailFileExists ()

	getThumbnailFilePath ()

	getThumbnailFileUrl ()

	imageFileExists ()

	getImageFilePath ()

	getImageFileUrl ()

Protected Attributes
	$randomIdentifier = null

	$solutionIdentifier = null

	$indentation = 0

	$position = null

	$content = null

	$uploadImageName = null

	$uploadImageFile = null

	$imageRemovalRequest = null

	$imagePathWeb = null

	$imagePathFs = null

	$imageThumbnailPrefix = null

Detailed Description

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

Constructor & Destructor Documentation

◆ __construct()

ilAssOrderingElement::__construct ( )

ilAssOrderingElement constructor.

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

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

Member Function Documentation

◆ __clone()

ilAssOrderingElement::__clone ( )

Cloning.

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

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

◆ __toString()

ilAssOrderingElement::__toString ( )

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

References getContent().

     {
         return $this->getContent();
     }

Here is the call graph for this function:

◆ getClone()

ilAssOrderingElement::getClone ( )

Returns: ilAssOrderingElement

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

     {
         return clone $this;
     }

◆ getContent()

ilAssOrderingElement::getContent ( )

Returns: string

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

References $content.

Referenced by __toString(), assOrderingQuestion\createImageThumbnail(), ilAssOrderingFormValuesObjectsConverter\getImageContentValueFromObject(), getImageFilePath(), getImageFileUrl(), ilAssOrderingFormValuesObjectsConverter\getStructValueFromObject(), ilAssOrderingFormValuesObjectsConverter\getTextContentValueFromObject(), getThumbnailFilePath(), getThumbnailFileUrl(), imageFileExists(), assOrderingQuestion\isImageReplaced(), and thumbnailFileExists().

     {
         return $this->content;
     }

Here is the caller graph for this function:

◆ getExportIdent()

ilAssOrderingElement::getExportIdent ( )

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

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

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

Here is the call graph for this function:

◆ getId()

ilAssOrderingElement::getId ( )

Returns: int

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

References $id.

Referenced by ilAssOrderingFormValuesObjectsConverter\getStructValueFromObject().

     {
         return $this->id;
     }

Here is the caller graph for this function:

◆ getImageFilePath()

ilAssOrderingElement::getImageFilePath ( )

protected

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

References getContent(), and getImagePathFs().

Referenced by imageFileExists().

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

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getImageFileUrl()

ilAssOrderingElement::getImageFileUrl ( )

protected

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

References getContent(), and getImagePathWeb().

Referenced by getPresentationImageUrl().

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

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getImagePathFs()

ilAssOrderingElement::getImagePathFs ( )

Returns: string

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

References $imagePathFs.

Referenced by getImageFilePath(), and getThumbnailFilePath().

     {
         return $this->imagePathFs;
     }

Here is the caller graph for this function:

◆ getImagePathWeb()

ilAssOrderingElement::getImagePathWeb ( )

Returns: string

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

References $imagePathWeb.

Referenced by getImageFileUrl(), and getThumbnailFileUrl().

     {
         return $this->imagePathWeb;
     }

Here is the caller graph for this function:

◆ getImageThumbnailPrefix()

ilAssOrderingElement::getImageThumbnailPrefix ( )

Returns: null

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

References $imageThumbnailPrefix.

Referenced by getThumbnailFilePath(), and getThumbnailFileUrl().

     {
         return $this->imageThumbnailPrefix;
     }

Here is the caller graph for this function:

◆ getIndentation()

ilAssOrderingElement::getIndentation ( )

Returns: int

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

References $indentation.

Referenced by getExportIdent(), getStorageValue2(), ilAssOrderingFormValuesObjectsConverter\getStructValueFromObject(), and isSameElement().

     {
         return $this->indentation;
     }

Here is the caller graph for this function:

◆ getPosition()

ilAssOrderingElement::getPosition ( )

Returns: int

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

References $position.

Referenced by getExportIdent(), getStorageValue1(), getStorageValue2(), ilAssOrderingFormValuesObjectsConverter\getStructValueFromObject(), and isSameElement().

     {
         return $this->position;
     }

Here is the caller graph for this function:

◆ getPresentationImageUrl()

ilAssOrderingElement::getPresentationImageUrl ( )

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

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

Referenced by ilAssOrderingFormValuesObjectsConverter\getImageContentValueFromObject().

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

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getRandomIdentifier()

ilAssOrderingElement::getRandomIdentifier ( )

Returns: integer $randomIdentifier

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

References $randomIdentifier.

Referenced by ilAssOrderingElementList\fetchIdentifier(), getExportIdent(), getStorageValue2(), ilAssOrderingFormValuesObjectsConverter\getStructValueFromObject(), and isSameElement().

     {
         return $this->randomIdentifier;
     }

Here is the caller graph for this function:

◆ getSolutionIdentifier()

ilAssOrderingElement::getSolutionIdentifier ( )

Returns: int

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

References $solutionIdentifier.

Referenced by ilAssOrderingElementList\fetchIdentifier(), getExportIdent(), getStorageValue1(), and isSameElement().

     {
         return $this->solutionIdentifier;
     }

Here is the caller graph for this function:

◆ getStorageValue1()

ilAssOrderingElement::getStorageValue1 ( $orderingType )

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

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

     {
         switch ($orderingType) {
             case OQ_NESTED_TERMS:
             case OQ_NESTED_PICTURES:
                 
                 return $this->getPosition();
             
             case OQ_TERMS:
             case OQ_PICTURES:
                 
                 return $this->getSolutionIdentifier();
         }
     }

Here is the call graph for this function:

◆ getStorageValue2()

ilAssOrderingElement::getStorageValue2 ( $orderingType )

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

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

     {
         switch ($orderingType) {
             case OQ_NESTED_TERMS:
             case OQ_NESTED_PICTURES:
                 
                 return $this->getRandomIdentifier() . ':' . $this->getIndentation();
             
             case OQ_TERMS:
             case OQ_PICTURES:
                 
                 return $this->getPosition() + 1;
         }
     }

Here is the call graph for this function:

◆ getThumbnailFilePath()

ilAssOrderingElement::getThumbnailFilePath ( )

protected

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

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

Referenced by thumbnailFileExists().

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

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getThumbnailFileUrl()

ilAssOrderingElement::getThumbnailFileUrl ( )

protected

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

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

Referenced by getPresentationImageUrl().

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

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getUploadImageFile()

ilAssOrderingElement::getUploadImageFile ( )

Returns: string

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

References $uploadImageFile.

Referenced by isImageUploadAvailable().

     {
         return $this->uploadImageFile;
     }

Here is the caller graph for this function:

◆ getUploadImageName()

ilAssOrderingElement::getUploadImageName ( )

Returns: string

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

References $uploadImageName.

     {
         return $this->uploadImageName;
     }

◆ imageFileExists()

ilAssOrderingElement::imageFileExists ( )

protected

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

References getContent(), and getImageFilePath().

Referenced by getPresentationImageUrl().

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

Here is the call graph for this function:

Here is the caller graph for this function:

◆ isExportIdent()

ilAssOrderingElement::isExportIdent ( $ident )

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

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

Referenced by setExportIdent().

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

Here is the call graph for this function:

Here is the caller graph for this function:

◆ isImageRemovalRequest()

ilAssOrderingElement::isImageRemovalRequest ( )

Returns: bool

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

References $imageRemovalRequest.

     {
         return $this->imageRemovalRequest;
     }

◆ isImageUploadAvailable()

ilAssOrderingElement::isImageUploadAvailable ( )

Returns: bool

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

References getUploadImageFile().

     {
         return (bool) strlen($this->getUploadImageFile());
     }

Here is the call graph for this function:

◆ isSameElement()

ilAssOrderingElement::isSameElement ( ilAssOrderingElement $element )

Parameters

ilAssOrderingElement $element

Returns: bool

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

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

     {
         if ($element->getRandomIdentifier() != $this->getRandomIdentifier()) {
             return false;
         }
         
         if ($element->getSolutionIdentifier() != $this->getSolutionIdentifier()) {
             return false;
         }
         
         if ($element->getPosition() != $this->getPosition()) {
             return false;
         }
         
         if ($element->getIndentation() != $this->getIndentation()) {
             return false;
         }
         
         return true;
     }

Here is the call graph for this function:

◆ setContent()

ilAssOrderingElement::setContent ( $content )

Parameters

string $content

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

References $content.

     {
         $this->content = $content;
     }

◆ setExportIdent()

ilAssOrderingElement::setExportIdent ( $ident )

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

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

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

Here is the call graph for this function:

◆ setId()

ilAssOrderingElement::setId ( $id )

Parameters

int $id

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

References $id.

     {
         $this->id = $id;
     }

◆ setImagePathFs()

ilAssOrderingElement::setImagePathFs ( $imagePathFs )

Parameters

string $imagePathFs

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

References $imagePathFs.

Referenced by ilAssOrderingFormValuesObjectsConverter\getImageContentValueFromObject().

     {
         $this->imagePathFs = $imagePathFs;
     }

Here is the caller graph for this function:

◆ setImagePathWeb()

ilAssOrderingElement::setImagePathWeb ( $imagePathWeb )

Parameters

string $imagePathWeb

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

References $imagePathWeb.

Referenced by ilAssOrderingFormValuesObjectsConverter\getImageContentValueFromObject().

     {
         $this->imagePathWeb = $imagePathWeb;
     }

Here is the caller graph for this function:

◆ setImageRemovalRequest()

ilAssOrderingElement::setImageRemovalRequest ( $imageRemovalRequest )

Parameters

bool $imageRemovalRequest

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

References $imageRemovalRequest.

     {
         $this->imageRemovalRequest = $imageRemovalRequest;
     }

◆ setImageThumbnailPrefix()

ilAssOrderingElement::setImageThumbnailPrefix ( $imageThumbnailPrefix )

Parameters

null $imageThumbnailPrefix

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

References $imageThumbnailPrefix.

Referenced by ilAssOrderingFormValuesObjectsConverter\getImageContentValueFromObject().

     {
         $this->imageThumbnailPrefix = $imageThumbnailPrefix;
     }

Here is the caller graph for this function:

◆ setIndentation()

ilAssOrderingElement::setIndentation ( $indentation )

Parameters

int $indentation

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

References $indentation.

Referenced by setExportIdent().

     {
         $this->indentation = $indentation;
     }

Here is the caller graph for this function:

◆ setPosition()

ilAssOrderingElement::setPosition ( $position )

Parameters

int $position

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

References $position.

Referenced by setExportIdent().

     {
         $this->position = $position;
     }

Here is the caller graph for this function:

◆ setRandomIdentifier()

ilAssOrderingElement::setRandomIdentifier ( $randomIdentifier )

Parameters

$randomIdentifier

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

References $randomIdentifier.

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

     {
         $this->randomIdentifier = $randomIdentifier;
     }

Here is the caller graph for this function:

◆ setSolutionIdentifier()

ilAssOrderingElement::setSolutionIdentifier ( $solutionIdentifier )

Parameters

int $solutionIdentifier

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

References $solutionIdentifier.

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

     {
         $this->solutionIdentifier = $solutionIdentifier;
     }

Here is the caller graph for this function:

◆ setUploadImageFile()

ilAssOrderingElement::setUploadImageFile ( $uploadImageFile )

Parameters

string $uploadImageFile

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

References $uploadImageFile.

     {
         $this->uploadImageFile = $uploadImageFile;
     }

◆ setUploadImageName()

ilAssOrderingElement::setUploadImageName ( $uploadImageName )

Parameters

string $uploadImageName

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

References $uploadImageName.

     {
         $this->uploadImageName = $uploadImageName;
     }

◆ thumbnailFileExists()

ilAssOrderingElement::thumbnailFileExists ( )

protected

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

References getContent(), and getThumbnailFilePath().

Referenced by getPresentationImageUrl().

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