class.ilAssOrderingFormValuesObjectsConverter.php

Go to the documentation of this file.

<?php

class ilAssOrderingFormValuesObjectsConverter implements ilFormValuesManipulator
{
    public const INDENTATIONS_POSTVAR_SUFFIX = '_ordering';
    public const INDENTATIONS_POSTVAR_SUFFIX_JS = '__default';

    public const CONTEXT_MAINTAIN_ELEMENT_TEXT = 'maintainItemText';
    public const CONTEXT_MAINTAIN_ELEMENT_IMAGE = 'maintainItemImage';
    public const CONTEXT_MAINTAIN_HIERARCHY = 'maintainHierarchy';

    protected $context = null;

    protected $postVar = null;

    protected $imageRemovalCommand = null;

    protected $imageUrlPath;

    protected $imageFsPath;

    protected $thumbnailPrefix;

    public function getContext(): ?string
    {
        return $this->context;
    }

    public function setContext($context): void
    {
        $this->context = $context;
    }

    public function getPostVar(): ?string
    {
        return $this->postVar;
    }

    public function setPostVar($postVar): void
    {
        $this->postVar = $postVar;
    }

    public function getImageRemovalCommand(): ?string
    {
        return $this->imageRemovalCommand;
    }

    public function setImageRemovalCommand($imageRemovalCommand): void
    {
        $this->imageRemovalCommand = $imageRemovalCommand;
    }

    public function getImageUrlPath(): string
    {
        return $this->imageUrlPath;
    }

    public function setImageUrlPath($imageUrlPath): void
    {
        $this->imageUrlPath = $imageUrlPath;
    }

    public function getImageFsPath(): string
    {
        return $this->imageFsPath;
    }

    public function setImageFsPath($imageFsPath): void
    {
        $this->imageFsPath = $imageFsPath;
    }

    public function getThumbnailPrefix(): string
    {
        return $this->thumbnailPrefix;
    }

    public function setThumbnailPrefix($thumbnailPrefix): void
    {
        $this->thumbnailPrefix = $thumbnailPrefix;
    }

    public function getIndentationsPostVar(): string
    {
        $postVar = $this->getPostVar();
        $postVar .= self::INDENTATIONS_POSTVAR_SUFFIX;
        $postVar .= self::INDENTATIONS_POSTVAR_SUFFIX_JS;

        return $postVar;
    }

    protected function needsConvertToValues($elements_or_values): bool
    {
        if (!count($elements_or_values)) {
            return false;
        }

        return (current($elements_or_values) instanceof ilAssOrderingElement);
    }

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

        return $input_values;
    }

    protected function collectValuesFromElements(array $elements): array
    {
        $values = array();

        foreach ($elements as $identifier => $orderingElement) {
            switch ($this->getContext()) {
                case self::CONTEXT_MAINTAIN_ELEMENT_TEXT:

                    $values[$identifier] = $this->getTextContentValueFromObject($orderingElement);
                    break;

                case self::CONTEXT_MAINTAIN_ELEMENT_IMAGE:

                    $values[$identifier] = $this->getImageContentValueFromObject($orderingElement);
                    break;

                case self::CONTEXT_MAINTAIN_HIERARCHY:

                    $values[$identifier] = $this->getStructValueFromObject($orderingElement);
                    break;

                default:
                    throw new ilFormException('unsupported context: ' . $this->getContext());
            }
        }

        return $values;
    }

    protected function getTextContentValueFromObject(ilAssOrderingElement $element): ?string
    {
        return $element->getContent();
    }

    protected function getImageContentValueFromObject(ilAssOrderingElement $element): array
    {
        $element->setImagePathWeb($this->getImageUrlPath());
        $element->setImagePathFs($this->getImageFsPath());
        $element->setImageThumbnailPrefix($this->getThumbnailPrefix());

        return array(
            'title' => $element->getContent(),
            'src' => $element->getPresentationImageUrl()
        );
    }

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

    protected function needsConvertToElements($valuesOrElements): bool
    {
        if (!count($valuesOrElements)) {
            return false;
        }

        return !(current($valuesOrElements) instanceof ilAssOrderingElement);
    }

    public function manipulateFormSubmitValues(array $submitValues): array
    {
        if ($this->needsConvertToElements($submitValues)) {
            $submitValues = $this->constructElementsFromValues($submitValues);
        }

        return $submitValues;
    }

    public function constructElementsFromValues(array $values): array
    {
        $elements = array();

        $position = 0;

        if (array_key_exists('content', $values)) {
            $values = $values['content'];
        }
        foreach ($values as $identifier => $value) {
            $element = new ilAssOrderingElement();

            $element->setRandomIdentifier($identifier);

            $element->setPosition($position++);

            if ($this->getContext() == self::CONTEXT_MAINTAIN_HIERARCHY) {
                $element->setIndentation((int)$value);
            } else {
                $element->setContent($value);
            }

            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;
        }

        return $elements;
    }

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

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

    protected function fetchSubmittedFileUploadProperty($fileUpload, $property)
    {
        if (!array_key_exists($property, $fileUpload)) {
            return null;
        }

        return $fileUpload[$property];
    }

    protected function fetchElementFileUpload($identifier)
    {
        $uploadFiles = $this->fetchSubmittedUploadFiles();

        if (!isset($uploadFiles[$identifier])) {
            return array();
        }

        return $uploadFiles[$identifier];
    }

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

    protected function getFileSubmitsHavingActualUpload($submittedUploadFiles)
    {
        foreach ($submittedUploadFiles as $identifier => $uploadProperties) {
            if (!isset($uploadProperties['tmp_name'])) {
                unset($submittedUploadFiles[$identifier]);
                continue;
            }

            if (!strlen($uploadProperties['tmp_name'])) {
                unset($submittedUploadFiles[$identifier]);
                continue;
            }

            if (!is_uploaded_file($uploadProperties['tmp_name'])) {
                unset($submittedUploadFiles[$identifier]);
                continue;
            }
        }

        return $submittedUploadFiles;
    }

    protected function getFileSubmitDataRestructuredByIdentifiers(): array
    {
        $submittedUploadFiles = array();

        foreach ($this->getFileSubmitData() as $uploadProperty => $valueElement) {
            foreach ($valueElement as $elementIdentifier => $uploadValue) {
                if (!isset($submittedUploadFiles[$elementIdentifier])) {
                    $submittedUploadFiles[$elementIdentifier] = array();
                }

                $submittedUploadFiles[$elementIdentifier][$uploadProperty] = $uploadValue;
            }
        }

        return $submittedUploadFiles;
    }

    protected function getFileSubmitData()
    {
        if (!isset($_FILES[$this->getPostVar()])) {
            return array();
        }

        return $_FILES[$this->getPostVar()];
    }

    protected function wasImageRemovalRequested($identifier): bool
    {
        if (!$this->getImageRemovalCommand()) {
            return false;
        }

        if (!isset($_POST['cmd']) || !is_array($_POST['cmd'])) {
            return false;
        }

        $cmdArr = $_POST['cmd'];

        if (!isset($cmdArr[$this->getImageRemovalCommand()])) {
            return false;
        }

        $fieldArr = $cmdArr[$this->getImageRemovalCommand()];

        if (!isset($fieldArr[$this->getPostVar()])) {
            return false;
        }

        $identifierArr = $fieldArr[$this->getPostVar()];

        $requested_identfier = key($identifierArr);

        // The code actually relied on a manipulation of $_POST by ilIdentifiedMultiValuesJsPositionIndexRemover
        return (string) str_replace(
            ilIdentifiedMultiValuesJsPositionIndexRemover::IDENTIFIER_INDICATOR_PREFIX,
            '',
            (string) $requested_identfier
        ) === (string) $identifier;
    }
}