Inheritance diagram for ilAssOrderingFormValuesObjectsConverter:

Collaboration diagram for ilAssOrderingFormValuesObjectsConverter:

Public Member Functions
	__construct ()

	getContext ()

	setContext ($context)

	getPostVar ()

	setPostVar ($postVar)

	getImageRemovalCommand ()

	setImageRemovalCommand ($imageRemovalCommand)

	getImageUrlPath ()

	setImageUrlPath ($imageUrlPath)

	getImageFsPath ()

	setImageFsPath ($imageFsPath)

	getThumbnailPrefix ()

	setThumbnailPrefix ($thumbnailPrefix)

	getIndentationsPostVar ()

	manipulateFormInputValues (array $input_values)

	manipulateFormSubmitValues (array $submit_values)

	constructElementsFromValues (array $values)

Data Fields
const	INDENTATIONS_POSTVAR_SUFFIX = '_ordering'

const	INDENTATIONS_POSTVAR_SUFFIX_JS = '__default'

const	CONTEXT_MAINTAIN_ELEMENT_TEXT = 'maintainItemText'

const	CONTEXT_MAINTAIN_ELEMENT_IMAGE = 'maintainItemImage'

const	CONTEXT_MAINTAIN_HIERARCHY = 'maintainHierarchy'

Protected Member Functions
	needsConvertToValues ($elements_or_values)

	collectValuesFromElements (array $elements)

	getTextContentValueFromObject (ilAssOrderingElement $element)

	getImageContentValueFromObject (ilAssOrderingElement $element)

	getStructValueFromObject (ilAssOrderingElement $element)

	needsConvertToElements ($values_or_elements)

	fetchSubmittedImageFilename ($identifier)

	fetchSubmittedUploadFilename ($identifier)

	fetchSubmittedFileUploadProperty (mixed $file_upload, string $property)

	fetchElementFileUpload ($identifier)

	fetchSubmittedUploadFiles ()

	getFileSubmitsHavingActualUpload (array $submitted_upload_files)

	getFileSubmitDataRestructuredByIdentifiers ()

	getFileSubmitData ()

	wasImageRemovalRequested ($identifier)
	TODO: Instead of accessing post, the complete ilFormValuesManipulator should be aware of a server request or the corresponding processed input values. More...

Protected Attributes
	$context = null

	$postVar = null

	$imageRemovalCommand = null

	$imageUrlPath

	$imageFsPath

	$thumbnailPrefix

Private Attributes
readonly RequestDataCollector	$request_data_collector

Detailed Description

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

Constructor & Destructor Documentation

◆ __construct()

ilAssOrderingFormValuesObjectsConverter::__construct ( )

Definition at line 69 of file class.ilAssOrderingFormValuesObjectsConverter.php.

     {
         $local_dic = QuestionPoolDIC::dic();
         $this->request_data_collector = $local_dic['request_data_collector'];
     }

Member Function Documentation

◆ collectValuesFromElements()

ilAssOrderingFormValuesObjectsConverter::collectValuesFromElements ( array $elements )

protected

Definition at line 189 of file class.ilAssOrderingFormValuesObjectsConverter.php.

References getContext(), getImageContentValueFromObject(), getStructValueFromObject(), and getTextContentValueFromObject().

Referenced by manipulateFormInputValues().

                                                                  : array
     {
         $values = [];
 
         foreach ($elements as $identifier => $ordering_element) {
             switch ($this->getContext()) {
                 case self::CONTEXT_MAINTAIN_ELEMENT_TEXT:
 
                     $values[$identifier] = $this->getTextContentValueFromObject($ordering_element);
                     break;
 
                 case self::CONTEXT_MAINTAIN_ELEMENT_IMAGE:
 
                     $values[$identifier] = $this->getImageContentValueFromObject($ordering_element);
                     break;
 
                 case self::CONTEXT_MAINTAIN_HIERARCHY:
 
                     $values[$identifier] = $this->getStructValueFromObject($ordering_element);
                     break;
 
                 default:
                     throw new ilFormException('unsupported context: ' . $this->getContext());
             }
         }
 
         return $values;
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ constructElementsFromValues()

ilAssOrderingFormValuesObjectsConverter::constructElementsFromValues ( array $values )

Definition at line 264 of file class.ilAssOrderingFormValuesObjectsConverter.php.

References fetchSubmittedImageFilename(), fetchSubmittedUploadFilename(), getContext(), and wasImageRemovalRequested().

Referenced by manipulateFormSubmitValues().

                                                               : array
     {
         $elements = [];
 
         $content = $values;
         if (array_key_exists('content', $values)) {
             $content = $values['content'];
         }
 
         $position = [];
         if (array_key_exists('position', $values)) {
             $position = $values['position'];
         }
 
         $indentation = [];
         if (array_key_exists('indentation', $values)) {
             $indentation = $values['indentation'];
         }
 
         $counter = 0;
         foreach ($content as $identifier => $value) {
             $element = new ilAssOrderingElement();
 
             $element->setRandomIdentifier((int) $identifier);
             $element->setPosition((int) ($position[$identifier] ?? $counter));
             $element->setContent($value);
             $element->setIndentation((int) ($indentation[$identifier] ?? 0));
 
             if ($this->getContext() === self::CONTEXT_MAINTAIN_ELEMENT_IMAGE) {
                 $element->setUploadImageName($this->fetchSubmittedImageFilename($identifier));
                 $element->setUploadImageFile($this->fetchSubmittedUploadFilename($identifier));
 
                 $element->setImageRemovalRequest($this->wasImageRemovalRequested($identifier));
             }
 
             $elements[$identifier] = $element;
             $counter++;
         }
 
         return $elements;
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ fetchElementFileUpload()

ilAssOrderingFormValuesObjectsConverter::fetchElementFileUpload ( $identifier )

protected

Definition at line 323 of file class.ilAssOrderingFormValuesObjectsConverter.php.

References fetchSubmittedUploadFiles().

Referenced by fetchSubmittedImageFilename(), and fetchSubmittedUploadFilename().

     {
         return $this->fetchSubmittedUploadFiles()[$identifier] ?? [];
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ fetchSubmittedFileUploadProperty()

ilAssOrderingFormValuesObjectsConverter::fetchSubmittedFileUploadProperty	(	mixed	$file_upload,
		string	$property
	)

protected

Definition at line 318 of file class.ilAssOrderingFormValuesObjectsConverter.php.

References null.

Referenced by fetchSubmittedImageFilename(), and fetchSubmittedUploadFilename().

     {
         return $file_upload[$property] ?? null;
     }

Here is the caller graph for this function:

◆ fetchSubmittedImageFilename()

ilAssOrderingFormValuesObjectsConverter::fetchSubmittedImageFilename ( $identifier )

protected

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

References fetchElementFileUpload(), and fetchSubmittedFileUploadProperty().

Referenced by constructElementsFromValues().

     {
         $fileUpload = $this->fetchElementFileUpload($identifier);
         return $this->fetchSubmittedFileUploadProperty($fileUpload, 'name');
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ fetchSubmittedUploadFilename()

ilAssOrderingFormValuesObjectsConverter::fetchSubmittedUploadFilename ( $identifier )

protected

Definition at line 312 of file class.ilAssOrderingFormValuesObjectsConverter.php.

References fetchElementFileUpload(), and fetchSubmittedFileUploadProperty().

Referenced by constructElementsFromValues().

     {
         $fileUpload = $this->fetchElementFileUpload($identifier);
         return $this->fetchSubmittedFileUploadProperty($fileUpload, 'tmp_name');
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ fetchSubmittedUploadFiles()

ilAssOrderingFormValuesObjectsConverter::fetchSubmittedUploadFiles ( )

protected

Definition at line 328 of file class.ilAssOrderingFormValuesObjectsConverter.php.

References getFileSubmitDataRestructuredByIdentifiers().

Referenced by fetchElementFileUpload().

                                                   : array
     {
         $submitted_upload_files = $this->getFileSubmitDataRestructuredByIdentifiers();
         //$submittedUploadFiles = $this->getFileSubmitsHavingActualUpload($submittedUploadFiles);
         return $submitted_upload_files;
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getContext()

ilAssOrderingFormValuesObjectsConverter::getContext ( )

Returns: string

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

References $context.

Referenced by collectValuesFromElements(), and constructElementsFromValues().

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

Here is the caller graph for this function:

◆ getFileSubmitData()

ilAssOrderingFormValuesObjectsConverter::getFileSubmitData ( )

protected

Definition at line 376 of file class.ilAssOrderingFormValuesObjectsConverter.php.

References getPostVar().

Referenced by getFileSubmitDataRestructuredByIdentifiers().

                                           : array
     {
         return $_FILES[$this->getPostVar()] ?? [];
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getFileSubmitDataRestructuredByIdentifiers()

ilAssOrderingFormValuesObjectsConverter::getFileSubmitDataRestructuredByIdentifiers ( )

protected

Returns: array

Definition at line 359 of file class.ilAssOrderingFormValuesObjectsConverter.php.

References getFileSubmitData().

Referenced by fetchSubmittedUploadFiles().

                                                                    : array
     {
         $submitted_upload_files = [];
 
         foreach ($this->getFileSubmitData() as $uploadProperty => $valueElement) {
             foreach ($valueElement as $element_identifier => $uploadValue) {
                 if (!isset($submitted_upload_files[$element_identifier])) {
                     $submitted_upload_files[$element_identifier] = [];
                 }
 
                 $submitted_upload_files[$element_identifier][$uploadProperty] = $uploadValue;
             }
         }
 
         return $submitted_upload_files;
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getFileSubmitsHavingActualUpload()

ilAssOrderingFormValuesObjectsConverter::getFileSubmitsHavingActualUpload ( array $submitted_upload_files )

protected

Definition at line 335 of file class.ilAssOrderingFormValuesObjectsConverter.php.

                                                                                       : array
     {
         foreach ($submitted_upload_files as $identifier => $upload_properties) {
             if (!isset($upload_properties['tmp_name'])) {
                 unset($submitted_upload_files[$identifier]);
                 continue;
             }
 
             if ($upload_properties['tmp_name'] === '') {
                 unset($submitted_upload_files[$identifier]);
                 continue;
             }
 
             if (!is_uploaded_file($upload_properties['tmp_name'])) {
                 unset($submitted_upload_files[$identifier]);
             }
         }
 
         return $submitted_upload_files;
     }

◆ getImageContentValueFromObject()

ilAssOrderingFormValuesObjectsConverter::getImageContentValueFromObject ( ilAssOrderingElement $element )

protected

Definition at line 223 of file class.ilAssOrderingFormValuesObjectsConverter.php.

References ilAssOrderingElement\getContent(), getImageFsPath(), getImageUrlPath(), ilAssOrderingElement\getPresentationImageUrl(), getThumbnailPrefix(), ilAssOrderingElement\setImagePathFs(), ilAssOrderingElement\setImagePathWeb(), and ilAssOrderingElement\setImageThumbnailPrefix().

Referenced by collectValuesFromElements().

                                                                                     : array
     {
         $element->setImagePathWeb($this->getImageUrlPath());
         $element->setImagePathFs($this->getImageFsPath());
         $element->setImageThumbnailPrefix($this->getThumbnailPrefix());
 
         return [
             'title' => $element->getContent(),
             'src' => $element->getPresentationImageUrl()
         ];
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getImageFsPath()

ilAssOrderingFormValuesObjectsConverter::getImageFsPath ( )

Returns: string

Definition at line 133 of file class.ilAssOrderingFormValuesObjectsConverter.php.

References $imageFsPath.

Referenced by getImageContentValueFromObject().

                                     : string
     {
         return $this->imageFsPath;
     }

Here is the caller graph for this function:

◆ getImageRemovalCommand()

ilAssOrderingFormValuesObjectsConverter::getImageRemovalCommand ( )

Definition at line 107 of file class.ilAssOrderingFormValuesObjectsConverter.php.

References $imageRemovalCommand.

Referenced by wasImageRemovalRequested().

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

Here is the caller graph for this function:

◆ getImageUrlPath()

ilAssOrderingFormValuesObjectsConverter::getImageUrlPath ( )

Definition at line 117 of file class.ilAssOrderingFormValuesObjectsConverter.php.

References $imageUrlPath.

Referenced by getImageContentValueFromObject().

                                      : string
     {
         return $this->imageUrlPath;
     }

Here is the caller graph for this function:

◆ getIndentationsPostVar()

ilAssOrderingFormValuesObjectsConverter::getIndentationsPostVar ( )

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

References $postVar, and getPostVar().

                                             : string
     {
         $postVar = $this->getPostVar();
         $postVar .= self::INDENTATIONS_POSTVAR_SUFFIX;
         $postVar .= self::INDENTATIONS_POSTVAR_SUFFIX_JS;
 
         return $postVar;
     }

Here is the call graph for this function:

◆ getPostVar()

ilAssOrderingFormValuesObjectsConverter::getPostVar ( )

Returns: string

Definition at line 94 of file class.ilAssOrderingFormValuesObjectsConverter.php.

References $postVar.

Referenced by getFileSubmitData(), getIndentationsPostVar(), and wasImageRemovalRequested().

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

Here is the caller graph for this function:

◆ getStructValueFromObject()

ilAssOrderingFormValuesObjectsConverter::getStructValueFromObject ( ilAssOrderingElement $element )

protected

Definition at line 235 of file class.ilAssOrderingFormValuesObjectsConverter.php.

References ilAssOrderingElement\getContent(), ilAssOrderingElement\getId(), ilAssOrderingElement\getIndentation(), ilAssOrderingElement\getPosition(), and ilAssOrderingElement\getRandomIdentifier().

Referenced by collectValuesFromElements().

                                                                               : array
     {
         return [
             'answer_id' => $element->getId(),
             'random_id' => $element->getRandomIdentifier(),
             'content' => (string) $element->getContent(),
             'ordering_position' => $element->getPosition(),
             'ordering_indentation' => $element->getIndentation()
         ];
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getTextContentValueFromObject()

ilAssOrderingFormValuesObjectsConverter::getTextContentValueFromObject ( ilAssOrderingElement $element )

protected

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

References ilAssOrderingElement\getContent().

Referenced by collectValuesFromElements().

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

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getThumbnailPrefix()

ilAssOrderingFormValuesObjectsConverter::getThumbnailPrefix ( )

Returns: string

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

References $thumbnailPrefix.

Referenced by getImageContentValueFromObject().

                                         : string
     {
         return $this->thumbnailPrefix;
     }

Here is the caller graph for this function:

◆ manipulateFormInputValues()

ilAssOrderingFormValuesObjectsConverter::manipulateFormInputValues ( array $input_values )

Implements ilFormValuesManipulator.

Definition at line 180 of file class.ilAssOrderingFormValuesObjectsConverter.php.

References collectValuesFromElements(), and needsConvertToValues().

                                                                   : array
     {
         if ($this->needsConvertToValues($input_values)) {
             $input_values = $this->collectValuesFromElements($input_values);
         }
 
         return $input_values;
     }

Here is the call graph for this function:

◆ manipulateFormSubmitValues()

ilAssOrderingFormValuesObjectsConverter::manipulateFormSubmitValues ( array $submit_values )

Implements ilFormValuesManipulator.

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

References constructElementsFromValues(), and needsConvertToElements().

                                                                     : array
     {
         if ($this->needsConvertToElements($submit_values)) {
             $submit_values = $this->constructElementsFromValues($submit_values);
         }
 
         return $submit_values;
     }

Here is the call graph for this function:

◆ needsConvertToElements()

ilAssOrderingFormValuesObjectsConverter::needsConvertToElements ( $values_or_elements )

protected

Definition at line 246 of file class.ilAssOrderingFormValuesObjectsConverter.php.

Referenced by manipulateFormSubmitValues().

                                                                   : bool
     {
         if (!count($values_or_elements)) {
             return false;
         }
 
         return !(current($values_or_elements) instanceof ilAssOrderingElement);
     }

Here is the caller graph for this function:

◆ needsConvertToValues()

ilAssOrderingFormValuesObjectsConverter::needsConvertToValues ( $elements_or_values )

protected

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

Referenced by manipulateFormInputValues().

                                                                 : bool
     {
         if (!count($elements_or_values)) {
             return false;
         }
 
         return (current($elements_or_values) instanceof ilAssOrderingElement);
     }

Here is the caller graph for this function:

◆ setContext()

ilAssOrderingFormValuesObjectsConverter::setContext ( $context )

Parameters

$context

Definition at line 86 of file class.ilAssOrderingFormValuesObjectsConverter.php.

References $context.

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

◆ setImageFsPath()

ilAssOrderingFormValuesObjectsConverter::setImageFsPath ( $imageFsPath )

Parameters

string $imageFsPath

Definition at line 141 of file class.ilAssOrderingFormValuesObjectsConverter.php.

References $imageFsPath.

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

◆ setImageRemovalCommand()

ilAssOrderingFormValuesObjectsConverter::setImageRemovalCommand ( $imageRemovalCommand )

Definition at line 112 of file class.ilAssOrderingFormValuesObjectsConverter.php.

References $imageRemovalCommand.

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

◆ setImageUrlPath()

ilAssOrderingFormValuesObjectsConverter::setImageUrlPath ( $imageUrlPath )

Parameters

string $imageUrlPath

Definition at line 125 of file class.ilAssOrderingFormValuesObjectsConverter.php.

References $imageUrlPath.

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

◆ setPostVar()

ilAssOrderingFormValuesObjectsConverter::setPostVar ( $postVar )

Parameters

$postVar

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

References $postVar.

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

◆ setThumbnailPrefix()

ilAssOrderingFormValuesObjectsConverter::setThumbnailPrefix ( $thumbnailPrefix )

Parameters

string $thumbnailPrefix

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

References $thumbnailPrefix.

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

◆ wasImageRemovalRequested()

ilAssOrderingFormValuesObjectsConverter::wasImageRemovalRequested ( $identifier )

protected

TODO: Instead of accessing post, the complete ilFormValuesManipulator should be aware of a server request or the corresponding processed input values.

Parameters

$identifier

Returns: bool

Definition at line 386 of file class.ilAssOrderingFormValuesObjectsConverter.php.

References getImageRemovalCommand(), getPostVar(), and ilIdentifiedMultiValuesJsPositionIndexRemover\IDENTIFIER_INDICATOR_PREFIX.

Referenced by constructElementsFromValues().

                                                             : bool
     {
         if (!$this->getImageRemovalCommand()) {
             return false;
         }
 
         $cmd = $this->request_data_collector->strArray('cmd', 3);
 
         if (!isset($cmd[$this->getImageRemovalCommand()])) {
             return false;
         }
 
         $field_arr = $cmd[$this->getImageRemovalCommand()];
 
         if (!isset($field_arr[$this->getPostVar()])) {
             return false;
         }
 
         return (string) str_replace(
             ilIdentifiedMultiValuesJsPositionIndexRemover::IDENTIFIER_INDICATOR_PREFIX,
             '',
             (string) key($field_arr[$this->getPostVar()])
         ) === (string) $identifier;
     }