This file is part of ILIAS, a powerful learning management system published by ILIAS open source e-Learning e.V. More...

Inheritance diagram for ilObjectCommonSettingFormAdapter:

Collaboration diagram for ilObjectCommonSettingFormAdapter:

Public Member Functions
	__construct (ilObjectService $service, ilObject $object, 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...

Protected Attributes
ilObjectService	$service

ilObject	$object

ilPropertyFormGUI	$legacy_form

Detailed Description

This file is part of ILIAS, a powerful learning management system published by ILIAS open source e-Learning e.V.

ILIAS is licensed with the GPL-3.0, see https://www.gnu.org/licenses/gpl-3.0.en.html You should have received a copy of said license along with the source code, too.

If this is not the case or you just want to try ILIAS, you'll find us at: https://www.ilias.de https://github.com/ILIAS-eLearning

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

Constructor & Destructor Documentation

◆ __construct()

ilObjectCommonSettingFormAdapter::__construct	(	ilObjectService	$service,
		ilObject	$object,
		ilPropertyFormGUI	$legacy_form = `null`
	)

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

References $legacy_form, $lng, $object, and $service.

     {
         $this->service = $service;
         $this->legacy_form = $legacy_form;
         $this->object = $object;
 
         $lng = $this->service->language();
         $lng->loadLanguageModule('obj');
         $lng->loadLanguageModule('cntr');
     }

Member Function Documentation

◆ addIcon()

ilObjectCommonSettingFormAdapter::addIcon ( )

Add icon setting to form.

Implements ilObjectCommonSettingFormAdapterInterface.

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

References $DIC, and $legacy_form.

                              : ?ilPropertyFormGUI
     {
         global $DIC;
 
         if (!is_null($this->legacy_form) && $this->service->settings()->get('custom_icons')) {
             // we do not clone for legacy forms, since initEditCustomForm relies on 'call by reference' behaviour
             //$this->legacy_form = clone $this->legacy_form;
             $gui = new ilObjectCustomIconConfigurationGUI($DIC, null, $this->object);
             $gui->addSettingsToForm($this->legacy_form);
         }
 
         return $this->legacy_form;
     }

◆ addTileImage()

ilObjectCommonSettingFormAdapter::addTileImage ( )

Add tile image setting to form.

Implements ilObjectCommonSettingFormAdapterInterface.

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

References $legacy_form, $lng, ILIAS\Repository\object(), ilObjectCommonSettingFormAdapterInterface\saveTileImage(), and ilFormPropertyGUI\setInfo().

                                   : ?ilPropertyFormGUI
     {
         $lng = $this->service->language();
         $tile_image_fac = $this->service->commonSettings()->tileImage();
 
         if (!is_null($this->legacy_form)) {
             // we do not clone for legacy forms, since initEditCustomForm relies on 'call by reference' behaviour
             //$this->legacy_form = clone $this->legacy_form;
 
             $tile_image = $tile_image_fac->getByObjId($this->object->getId());
             $timg = new ilImageFileInputGUI($lng->txt('obj_tile_image'), 'tile_image');
             $timg->setInfo($lng->txt('obj_tile_image_info'));
             $timg->setSuffixes($tile_image_fac->getSupportedFileExtensions());
             $timg->setUseCache(false);
             if ($tile_image->exists()) {
                 $timg->setImage($tile_image->getFullPath());
             } else {
                 $timg->setImage('');
             }
             $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 109 of file class.ilObjectCommonSettingFormAdapter.php.

References $legacy_form, ilContainer\_lookupContainerSetting(), ILIAS\Repository\object(), and ilCheckboxInputGUI\setValue().

                                             : ilPropertyFormGUI
     {
         $hide = new ilCheckboxInputGUI(
             $this->service->language()->txt('obj_show_title_and_icon'),
             'show_header_icon_and_title'
         );
         $hide->setValue('1');
         $hide->setChecked(
             !((bool) ilContainer::_lookupContainerSetting($this->object->getId(), 'hide_header_icon_and_title'))
         );
         $this->legacy_form->addItem($hide);
 
         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 136 of file class.ilObjectCommonSettingFormAdapter.php.

References $legacy_form, ilContainer\_lookupContainerSetting(), ILIAS\Repository\object(), and ilCheckboxInputGUI\setValue().

                                              : ilPropertyFormGUI
     {
         $hide = new ilCheckboxInputGUI(
             $this->service->language()->txt('obj_show_header_actions'),
             'show_top_actions'
         );
         $hide->setValue('1');
         $hide->setChecked(
             !((bool) ilContainer::_lookupContainerSetting($this->object->getId(), 'hide_top_actions'))
         );
         $this->legacy_form->addItem($hide);
 
         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 52 of file class.ilObjectCommonSettingFormAdapter.php.

References $DIC, and $legacy_form.

                               : void
     {
         global $DIC;
 
         if (!is_null($this->legacy_form) && $this->service->settings()->get('custom_icons')) {
             $this->legacy_form = clone $this->legacy_form;
             $gui = new ilObjectCustomIconConfigurationGUI($DIC, null, $this->object);
             $gui->saveIcon($this->legacy_form);
         }
     }

◆ saveTitleIconVisibility()

ilObjectCommonSettingFormAdapter::saveTitleIconVisibility ( )

Save title icon visibility setting from form.

Implements ilObjectCommonSettingFormAdapterInterface.

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

References ilContainer\_writeContainerSetting(), and ILIAS\Repository\object().

                                              : void
     {
         if (!is_null($this->legacy_form)) {
             // hide icon/title
             ilContainer::_writeContainerSetting(
                 $this->object->getId(),
                 'hide_header_icon_and_title',
                 (string) !$this->legacy_form->getInput('show_header_icon_and_title')
             );
         }
     }

Here is the call graph for this function:

◆ saveTopActionsVisibility()

ilObjectCommonSettingFormAdapter::saveTopActionsVisibility ( )

Save top actions visibility setting from form.

Implements ilObjectCommonSettingFormAdapterInterface.

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

References ilContainer\_writeContainerSetting(), and ILIAS\Repository\object().

                                               : void
     {
         if (!is_null($this->legacy_form)) {
             // hide icon/title
             ilContainer::_writeContainerSetting(
                 $this->object->getId(),
                 'hide_top_actions',
                 (string) !$this->legacy_form->getInput('show_top_actions')
             );
         }
     }