Icon.php

Go to the documentation of this file.

<?php

declare(strict_types=1);

namespace ILIAS\ILIASObject\Properties\AdditionalProperties\Icon;

use ILIAS\ILIASObject\Properties\Property;
use ILIAS\ILIASObject\Properties\ObjectTypeSpecificProperties\ObjectTypeSpecificPropertyProviders;
use ILIAS\UI\Component\Input\Field\Factory as FieldFactory;
use ILIAS\UI\Component\Input\Field\File;
use ILIAS\Refinery\Factory as Refinery;
use ILIAS\UI\Component\Symbol\Icon\Custom as CustomIcon;
use ILIAS\UI\Component\Symbol\Icon\Factory as IconFactory;
use ILIAS\ResourceStorage\Services as StorageService;
use ILIAS\FileUpload\MimeType;

class Icon implements Property
{
    public const SUPPORTED_MIME_TYPES = [MimeType::IMAGE__SVG_XML];
    private const INPUT_LABEL = 'custom_icon';

    private bool $deleted_flag = false;
    private ?string $temp_file_name = null;

    public function __construct(
        private bool $custom_icons_enabled,
        private ?Custom $custom_icon = null,
        private ?ObjectTypeSpecificPropertyProviders $object_type_specific_property_providers = null
    ) {
    }

    public function getObjectTypeSpecificIcon(
        int $object_id,
        IconFactory $factory,
        StorageService $irss
    ): ?CustomIcon {
        if ($this->object_type_specific_property_providers === null) {
            return null;
        }
        return $this->object_type_specific_property_providers->getObjectTypeSpecificIcon($object_id, $factory, $irss);
    }

    public function getCustomIcon(): ?Custom
    {
        return $this->custom_icons_enabled ? $this->custom_icon : null;
    }

    public function getDeletedFlag(): bool
    {
        return $this->deleted_flag;
    }

    public function withDeletedFlag(): self
    {
        $clone = clone $this;
        $clone->deleted_flag = true;
        return $clone;
    }

    public function getTempFileName(): ?string
    {
        return $this->temp_file_name;
    }

    public function withTempFileName(string $name): self
    {
        $clone = $this;
        $clone->temp_file_name = $name;
        return $clone;
    }

    public function toForm(
        \ilLanguage $language,
        FieldFactory $field_factory,
        Refinery $refinery
    ): ?File {
        if (!$this->custom_icons_enabled) {
            return null;
        }
        $trafo = $refinery->custom()->transformation(
            function ($v): ?Property {
                $property_icon = new self(
                    $this->custom_icons_enabled,
                    $this->custom_icon
                );

                if (count($v) > 0 && $v[0] !== 'custom_icon') {
                    return $property_icon
                        ->withTempFileName($v[0]);
                }

                if (count($v) === 0 && $this->custom_icon->exists()) {
                    return $property_icon
                        ->withDeletedFlag();
                }

                return $property_icon;
            }
        );
        $custom_icon = $field_factory
            ->file(new \CustomIconUploadHandlerGUI($this->custom_icon), $language->txt(self::INPUT_LABEL))
            ->withAcceptedMimeTypes(self::SUPPORTED_MIME_TYPES)
            ->withAdditionalTransformation($trafo);

        if (!$this->custom_icon->exists()) {
            return $custom_icon;
        }

        return $custom_icon->withValue(['custom_icon']);
    }

    public function toLegacyForm(
        \ilLanguage $language
    ): ?\ilImageFileInputGUI {
        if (!$this->custom_icons_enabled) {
            return null;
        }
        $custom_icon_input = new \ilImageFileInputGUI($language->txt(self::INPUT_LABEL), 'icon');
        $custom_icon_input->setSuffixes($this->custom_icon->getSupportedFileExtensions());
        $custom_icon_input->setUseCache(false);
        if ($this->custom_icon->exists()) {
            $custom_icon_input->setImage($this->custom_icon->getFullPath());
        } else {
            $custom_icon_input->setImage('');
        }

        return $custom_icon_input;
    }
}