ilObjectPropertyTitleAndDescription Class Reference

Inheritance diagram for ilObjectPropertyTitleAndDescription:

Collaboration diagram for ilObjectPropertyTitleAndDescription:

Public Member Functions
	__construct (private string $title='', private string $long_description='', private ?ilObjectTypeSpecificPropertyModifications $object_type_specific_property_modifications=null)
	getTitle ()
	withTitle (string $title)
	getDescription ()
	withDescription (string $description)
	getLongDescription ()
	toForm (\ilLanguage $language, FieldFactory $field_factory, Refinery $refinery)
Public Member Functions inherited from ilObjectProperty
	toForm (ilLanguage $language, FieldFactory $field_factory, Refinery $refinery)

Private Attributes
const	TITLE_LABEL = 'title'
const	DESCRIPTION_LABEL = 'description'
const	GROUP_LABEL = 'title_and_description'

Detailed Description

Author

Stephan Kergomard

Definition at line 29 of file ilObjectPropertyTitleAndDescription.php.

Constructor & Destructor Documentation

__construct()

ilObjectPropertyTitleAndDescription::__construct	(	private string	$title = '',
		private string	$long_description = '',
		private ?ilObjectTypeSpecificPropertyModifications	$object_type_specific_property_modifications = null
	)

Definition at line 35 of file ilObjectPropertyTitleAndDescription.php.

      {
    }

Member Function Documentation

getDescription()

ilObjectPropertyTitleAndDescription::getDescription

(

)

Definition at line 58 of file ilObjectPropertyTitleAndDescription.php.

References ilObject\DESC_LENGTH, and getLongDescription().

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

Here is the call graph for this function:

getLongDescription()

ilObjectPropertyTitleAndDescription::getLongDescription

(

)

Definition at line 70 of file ilObjectPropertyTitleAndDescription.php.

References null.

Referenced by getDescription(), and ilObjectProperties\storePropertyTitleAndDescription().

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

Here is the caller graph for this function:

getTitle()

ilObjectPropertyTitleAndDescription::getTitle

(

)

Definition at line 42 of file ilObjectPropertyTitleAndDescription.php.

References null.

Referenced by ilObjectProperties\storePropertyTitleAndDescription().

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

        return $this->title;
    }

Here is the caller graph for this function:

toForm()

ilObjectPropertyTitleAndDescription::toForm	(	\ilLanguage	$language,
		FieldFactory	$field_factory,
		Refinery	$refinery
	)

Definition at line 78 of file ilObjectPropertyTitleAndDescription.php.

References ilObject\LONG_DESC_LENGTH, ilObject\TITLE_LENGTH, ilLanguage\txt(), and ILIAS\UI\Component\Input\Container\Form\FormInput\withRequired().

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

Here is the call graph for this function:

withDescription()

ilObjectPropertyTitleAndDescription::withDescription

(

string

$description

)

Definition at line 63 of file ilObjectPropertyTitleAndDescription.php.

                                                        : self
    {
        $clone = clone $this;
        $clone->long_description = $description;
        return $clone;
    }

withTitle()

ilObjectPropertyTitleAndDescription::withTitle

(

string

$title

)

Definition at line 51 of file ilObjectPropertyTitleAndDescription.php.

                                            : self
    {
        $clone = clone $this;
        $clone->title = $title;
        return $clone;
    }

Field Documentation

DESCRIPTION_LABEL

const ilObjectPropertyTitleAndDescription::DESCRIPTION_LABEL = 'description'

private

Definition at line 32 of file ilObjectPropertyTitleAndDescription.php.

GROUP_LABEL

const ilObjectPropertyTitleAndDescription::GROUP_LABEL = 'title_and_description'

private

Definition at line 33 of file ilObjectPropertyTitleAndDescription.php.

TITLE_LABEL

const ilObjectPropertyTitleAndDescription::TITLE_LABEL = 'title'

private

Definition at line 31 of file ilObjectPropertyTitleAndDescription.php.

---

The documentation for this class was generated from the following file:

• components/ILIAS/ILIASObject/classes/Properties/CoreProperties/ilObjectPropertyTitleAndDescription.php