ilObjectPropertyTitleAndDescription.php

Go to the documentation of this file.

<?php

declare(strict_types=1);

use ILIAS\UI\Component\Input\Container\Form\FormInput;
use ILIAS\Object\Properties\ObjectTypeSpecificProperties\ilObjectTypeSpecificPropertyModifications;
use ILIAS\UI\Component\Input\Field\Factory as FieldFactory;
use ILIAS\Refinery\Factory as Refinery;

class ilObjectPropertyTitleAndDescription implements ilObjectProperty
{
    private const TITLE_LABEL = 'title';
    private const DESCRIPTION_LABEL = 'description';
    private const GROUP_LABEL = 'title_and_description';

    public function __construct(
        private string $title = '',
        private string $long_description = '',
        private ?ilObjectTypeSpecificPropertyModifications $object_type_specific_property_modifications = null
    ) {
    }

    public function getTitle(): string
    {
        if ($this->object_type_specific_property_modifications !== null) {
            return $this->object_type_specific_property_modifications->modifyTitle($this->title);
        }

        return $this->title;
    }

    public function withTitle(string $title): self
    {
        $clone = clone $this;
        $clone->title = $title;
        return $clone;
    }

    public function getDescription(): string
    {
        return mb_substr($this->getLongDescription(), 0, ilObject::DESC_LENGTH);
    }

    public function withDescription(string $description): self
    {
        $clone = clone $this;
        $clone->long_description = $description;
        return $clone;
    }

    public function getLongDescription(): ?string
    {
        if ($this->object_type_specific_property_modifications !== null) {
            return $this->object_type_specific_property_modifications->modifyDescription($this->long_description);
        }
        return $this->long_description;
    }

    public function toForm(
        \ilLanguage $language,
        FieldFactory $field_factory,
        Refinery $refinery
    ): FormInput {
        $trafo = $refinery->custom()->transformation(
            function ($vs): ilObjectProperty {
                list($title, $long_description) = $vs;
                return new ilObjectPropertyTitleAndDescription(
                    $title,
                    $long_description
                );
            }
        );

        $title_input = $field_factory->text($language->txt(self::TITLE_LABEL))
            ->withMaxLength(ilObject::TITLE_LENGTH)
            ->withRequired(true)
            ->withValue($this->title);
        $description_input = $field_factory->textarea($language->txt(self::DESCRIPTION_LABEL))
            ->withMaxLimit(ilObject::LONG_DESC_LENGTH)
            ->withValue($this->long_description);
        return $field_factory->group([$title_input, $description_input], self::GROUP_LABEL)
            ->withAdditionalTransformation($trafo);
    }
}