class.ilObjectCommonSettingFormAdapter.php

Go to the documentation of this file.

<?php

declare(strict_types=1);

use ILIAS\ILIASObject\Properties\AdditionalProperties\Simple\TitleAndIconVisibility;
use ILIAS\ILIASObject\Properties\AdditionalProperties\Simple\HeaderActionVisibility;
use ILIAS\ILIASObject\Properties\CoreProperties\TileImage\Stakeholder;
use ILIAS\ILIASObject\Properties\CoreProperties\TileImage\FlavourDefinition;
use ILIAS\FileUpload\FileUpload;
use ILIAS\FileUpload\DTO\UploadResult;
use ILIAS\ResourceStorage\Services as ResourceStorageServices;
use ILIAS\HTTP\Services;
use GuzzleHttp\Psr7\UploadedFile;

class ilObjectCommonSettingFormAdapter implements ilObjectCommonSettingFormAdapterInterface
{
    public function __construct(
        private ilLanguage $language,
        private FileUpload $upload,
        private ResourceStorageServices $storage,
        private Stakeholder $stakeholder,
        private FlavourDefinition $flavour,
        private ilObjectCommonSettings $common_settings,
        private Services $http,
        private ?ilPropertyFormGUI $legacy_form = null
    ) {
        $this->language->loadLanguageModule('obj');
        $this->language->loadLanguageModule('cntr');
    }

    public function addIcon(): ?ilPropertyFormGUI
    {
        $icon = $this->common_settings->getPropertyIcon()->toLegacyForm($this->language);
        if (!is_null($this->legacy_form) && $icon !== null) {
            $this->legacy_form->addItem($icon);
        }

        return $this->legacy_form;
    }

    public function saveIcon(): void
    {
        if (is_null($this->legacy_form)) {
            return;
        }

        $item = $this->legacy_form->getItemByPostVar('icon');
        if ($item && $item->getDeletionFlag()) {
            $this->common_settings->storePropertyIcon(
                $this->common_settings->getPropertyIcon()->withDeletedFlag()
            );
            return;
        }

        $file_data = (array) $this->legacy_form->getInput('icon');
        if (isset($file_data['tmp_name']) && $file_data['tmp_name']) {
            $tempfile = ilFileUtils::ilTempnam();
            if (!$this->upload->hasBeenProcessed()) {
                $this->upload->process();
            }

            rename($file_data['tmp_name'], $tempfile);

            $this->common_settings->storePropertyIcon(
                $this->common_settings->getPropertyIcon()->withTempFileName(basename($tempfile))
            );
        }
    }

    public function addTileImage(): ?ilPropertyFormGUI
    {
        if (!is_null($this->legacy_form)) {
            $timg = $this->common_settings->getPropertyTileImage()->toLegacyForm($this->language);
            $this->legacy_form->addItem($timg);
        }

        return $this->legacy_form;
    }

    public function saveTileImage(): void
    {
        if (is_null($this->legacy_form)) {
            return;
        }

        $item = $this->legacy_form->getItemByPostVar('tile_image');
        if ($item && $item->getDeletionFlag()) {
            $this->common_settings->storePropertyTileImage(
                $this->common_settings->getPropertyTileImage()->withDeletedFlag()
            );
            return;
        }

        // In case of a parallel oather upload, the uploads may already have been processed. otherwise we have to do it
        if (!$this->upload->hasBeenProcessed()) {
            $this->upload->process();
        }
        $result_array = $this->upload->getResults();

        // Determine Legacy Upload (since there can be more than one in this form). This is not best practice, because
        // on the one hand we should actually use the wrapper, on the other hand with the conversion to the new forms
        // this problem no longer have anyway. But at the moment we have to pick the right one out of all uploadResults,
        // that's only possible with this way

        $file = $this->http->request()->getUploadedFiles()['tile_image']; // Direct Access to the Psr7/UploadedFile
        if ($file->getClientFilename() === '') {
            return;
        }

        $temp_name = $file->getStream()->getMetadata('uri'); // Get the Path of the Temp. File
        $result = $result_array[$temp_name] ?? null;

        if (!($result instanceof UploadResult) || !$result->isOK()) {
            return;
        }

        if ($item->getValue() === null || $item->getValue() === '') {
            $i = $this->storage->manage()->upload($result, $this->stakeholder);
            $this->storage->flavours()->ensure($i, $this->flavour);
            $new_tile_image = $this->common_settings->getPropertyTileImage()
                ->getTileImage()->withRid($i->serialize());
            $this->common_settings->storePropertyTileImage(
                $this->common_settings->getPropertyTileImage()->withTileImage($new_tile_image)
            );
        } else {
            $i = $this->storage->manage()->find($item->getValue());
            $this->storage->manage()->replaceWithUpload(
                $i,
                $result,
                $this->stakeholder
            );
        }
    }

    public function addTitleIconVisibility(): ilPropertyFormGUI
    {
        $title_and_icon_visibility_input = $this->common_settings->getPropertyTitleAndIconVisibility()
            ->toLegacyForm($this->language);
        $this->legacy_form->addItem($title_and_icon_visibility_input);

        return $this->legacy_form;
    }

    public function saveTitleIconVisibility(): void
    {
        if (is_null($this->legacy_form)) {
            return;
        }

        $this->common_settings->storePropertyTitleAndIconVisibility(
            new TitleAndIconVisibility((bool) $this->legacy_form->getInput('show_header_icon_and_title'))
        );
    }

    public function addTopActionsVisibility(): ilPropertyFormGUI
    {
        $top_actions_visibility_input = $this->common_settings->getPropertyHeaderActionVisibility()
            ->toLegacyForm($this->language);
        $this->legacy_form->addItem($top_actions_visibility_input);

        return $this->legacy_form;
    }

    public function saveTopActionsVisibility(): void
    {
        if (is_null($this->legacy_form)) {
            return;
        }

        $this->common_settings->storePropertyHeaderActionVisibility(
            new HeaderActionVisibility((bool) $this->legacy_form->getInput('show_top_actions'))
        );
    }
}