ilObjectCommonSettingFormAdapter Class Reference

Inheritance diagram for ilObjectCommonSettingFormAdapter:

Collaboration diagram for ilObjectCommonSettingFormAdapter:

Public Member Functions
	__construct (private ilLanguage $language, private FileUpload $upload, private ResourceStorageServices $storage, private ilObjectTileImageStakeholder $stakeholder, private ilObjectTileImageFlavourDefinition $flavour, private ilObjectCommonSettings $common_settings, private Services $http, private ?ilPropertyFormGUI $legacy_form=null)
	addIcon ()
	Add icon setting to form. More...
	saveIcon ()
	Save icon setting from form. More...
	addTileImage ()
	Add tile image setting to form. More...
	addTitleIconVisibility ()
	Add title icon visibility setting to form. More...
	saveTitleIconVisibility ()
	Save title icon visibility setting from form. More...
	addTopActionsVisibility ()
	Add top actions visibility setting to form. More...
	saveTopActionsVisibility ()
	Save top actions visibility setting from form. More...
Public Member Functions inherited from ilObjectCommonSettingFormAdapterInterface
	saveTileImage ()
	Save tile image setting from form. More...

Detailed Description

Deprecated:

11: This class will be remove with ILIAS 11.

Please use the corresponding implementation of ilObjectProperty instead.

Definition at line 34 of file class.ilObjectCommonSettingFormAdapter.php.

Constructor & Destructor Documentation

__construct()

ilObjectCommonSettingFormAdapter::__construct	(	private ilLanguage	$language,
		private FileUpload	$upload,
		private ResourceStorageServices	$storage,
		private ilObjectTileImageStakeholder	$stakeholder,
		private ilObjectTileImageFlavourDefinition	$flavour,
		private ilObjectCommonSettings	$common_settings,
		private Services	$http,
		private ?ilPropertyFormGUI	$legacy_form = null
	)

Definition at line 36 of file class.ilObjectCommonSettingFormAdapter.php.

References ILIAS\UI\examples\Symbol\Glyph\Language\language().

      {
        $this->language->loadLanguageModule('obj');
        $this->language->loadLanguageModule('cntr');
    }

Here is the call graph for this function:

Member Function Documentation

addIcon()

ilObjectCommonSettingFormAdapter::addIcon

(

)

Add icon setting to form.

Implements ilObjectCommonSettingFormAdapterInterface.

Definition at line 50 of file class.ilObjectCommonSettingFormAdapter.php.

References ILIAS\UI\examples\Symbol\Glyph\Language\language(), and null.

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

Here is the call graph for this function:

addTileImage()

ilObjectCommonSettingFormAdapter::addTileImage

(

)

Add tile image setting to form.

Implements ilObjectCommonSettingFormAdapterInterface.

Definition at line 89 of file class.ilObjectCommonSettingFormAdapter.php.

References ILIAS\FileDelivery\http(), ILIAS\UI\examples\Symbol\Glyph\Language\language(), null, ilObjectCommonSettingFormAdapterInterface\saveTileImage(), and ILIAS\Repository\upload().

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

        return $this->legacy_form;
    }

Here is the call graph for this function:

addTitleIconVisibility()

ilObjectCommonSettingFormAdapter::addTitleIconVisibility

(

)

Add title icon visibility setting to form.

Implements ilObjectCommonSettingFormAdapterInterface.

Definition at line 155 of file class.ilObjectCommonSettingFormAdapter.php.

References ILIAS\UI\examples\Symbol\Glyph\Language\language().

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

Here is the call graph for this function:

addTopActionsVisibility()

ilObjectCommonSettingFormAdapter::addTopActionsVisibility

(

)

Add top actions visibility setting to form.

Implements ilObjectCommonSettingFormAdapterInterface.

Definition at line 175 of file class.ilObjectCommonSettingFormAdapter.php.

References ILIAS\UI\examples\Symbol\Glyph\Language\language().

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

        return $this->legacy_form;
    }

Here is the call graph for this function:

saveIcon()

ilObjectCommonSettingFormAdapter::saveIcon

(

)

Save icon setting from form.

Implements ilObjectCommonSettingFormAdapterInterface.

Definition at line 60 of file class.ilObjectCommonSettingFormAdapter.php.

References ilFileUtils\ilTempnam(), and ILIAS\Repository\upload().

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

Here is the call graph for this function:

saveTitleIconVisibility()

ilObjectCommonSettingFormAdapter::saveTitleIconVisibility

(

)

Save title icon visibility setting from form.

Implements ilObjectCommonSettingFormAdapterInterface.

Definition at line 164 of file class.ilObjectCommonSettingFormAdapter.php.

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

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

saveTopActionsVisibility()

ilObjectCommonSettingFormAdapter::saveTopActionsVisibility

(

)

Save top actions visibility setting from form.

Implements ilObjectCommonSettingFormAdapterInterface.

Definition at line 184 of file class.ilObjectCommonSettingFormAdapter.php.

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

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

---

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

• components/ILIAS/ILIASObject/classes/CommonSettings/class.ilObjectCommonSettingFormAdapter.php