Common settings form adapter. More...

Inheritance diagram for ilObjectCommonSettingFormAdapter:

Collaboration diagram for ilObjectCommonSettingFormAdapter:

Public Member Functions
	__construct (ilObjectService $service, ilObject $object, ilPropertyFormGUI $legacy_form=null)
	Constructor. More...

	addIcon ()
	Add icon setting to form. Returns null\|ilPropertyFormGUI More...

	saveIcon ()
	Save icon setting from form. More...

	addTileImage ()
	Add tile image setting to form. Returns null\|ilPropertyFormGUI More...

	addTitleIconVisibility ()
	Add title icon visibility setting to form. Returns null\|ilPropertyFormGUI More...

	saveTitleIconVisibility ()
	Save title icon visibility setting from form. More...

	addTopActionsVisibility ()
	Add top actions visibility setting to form. Returns null\|ilPropertyFormGUI More...

	saveTopActionsVisibility ()
	Save top actions visibility setting from form. More...

Public Member Functions inherited from ilObjectCommonSettingFormAdapterInterface
	addIcon ()
	Add icon setting to form. More...

	saveIcon ()
	Save icon setting from form. More...

	addTileImage ()
	Add tile image setting to form. More...

	saveTileImage ()
	Save tile image setting from 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...

Protected Attributes
	$service

	$legacy_form

	$object

Detailed Description

Common settings form adapter.

Helps to add and save common object settings for repository objects.

Author: killi.nosp@m.ng@l.nosp@m.eifos.nosp@m..de

Definition at line 11 of file class.ilObjectCommonSettingsFormAdapter.php.

Constructor & Destructor Documentation

◆ __construct()

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

Constructor.

Definition at line 31 of file class.ilObjectCommonSettingsFormAdapter.php.

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

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

Member Function Documentation

◆ addIcon()

ilObjectCommonSettingFormAdapter::addIcon ( )

Add icon setting to form.

Returns: null|ilPropertyFormGUI

Implements ilObjectCommonSettingFormAdapterInterface.

Definition at line 45 of file class.ilObjectCommonSettingsFormAdapter.php.

                              : ilPropertyFormGUI
    {
        global $DIC;
 
        if ($this->service->settings()->get('custom_icons')) {
            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;
                require_once 'Services/Object/Icon/classes/class.ilObjectCustomIconConfigurationGUI.php';
                $gui = new \ilObjectCustomIconConfigurationGUI($DIC, null, $this->object);
                $gui->addSettingsToForm($this->legacy_form);
            }
        }
        return $this->legacy_form;
    }

References $DIC, and $legacy_form.

◆ addTileImage()

ilObjectCommonSettingFormAdapter::addTileImage ( )

Add tile image setting to form.

Returns: null|ilPropertyFormGUI

Implements ilObjectCommonSettingFormAdapterInterface.

Definition at line 81 of file class.ilObjectCommonSettingsFormAdapter.php.

                                   : 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);
 
            /*
            $file = new ilFileStandardDropzoneInputGUI($lng->txt('obj_tile_image'), 'tile_image');
            $file->setRequired(false);
            $file->setSuffixes($tile_image_fac->getSupportedFileExtensions());
            $this->legacy_form->addItem($file);*/
        }
 
        return $this->legacy_form;
    }

References $legacy_form, and $lng.

◆ addTitleIconVisibility()

ilObjectCommonSettingFormAdapter::addTitleIconVisibility ( )

Add title icon visibility setting to form.

Returns: null|ilPropertyFormGUI

Implements ilObjectCommonSettingFormAdapterInterface.

Definition at line 138 of file class.ilObjectCommonSettingsFormAdapter.php.

                                             : ilPropertyFormGUI
    {
        $lng = $this->service->language();
        $hide = new ilCheckboxInputGUI($lng->txt("obj_show_title_and_icon"), "show_header_icon_and_title");
        $hide->setChecked(!ilContainer::_lookupContainerSetting($this->object->getId(), "hide_header_icon_and_title"));
        $this->legacy_form->addItem($hide);
        return $this->legacy_form;
    }

References $legacy_form, $lng, and ilContainer\_lookupContainerSetting().

Here is the call graph for this function:

◆ addTopActionsVisibility()

ilObjectCommonSettingFormAdapter::addTopActionsVisibility ( )

Add top actions visibility setting to form.

Returns: null|ilPropertyFormGUI

Implements ilObjectCommonSettingFormAdapterInterface.

Definition at line 165 of file class.ilObjectCommonSettingsFormAdapter.php.

                                              : ilPropertyFormGUI
    {
        $lng = $this->service->language();
        $hide = new ilCheckboxInputGUI($lng->txt("obj_show_header_actions"), "show_top_actions");
        $hide->setChecked(!ilContainer::_lookupContainerSetting($this->object->getId(), "hide_top_actions"));
        $this->legacy_form->addItem($hide);
        return $this->legacy_form;
    }

References $legacy_form, $lng, and ilContainer\_lookupContainerSetting().

Here is the call graph for this function:

◆ saveIcon()

ilObjectCommonSettingFormAdapter::saveIcon ( )

Save icon setting from form.

Implements ilObjectCommonSettingFormAdapterInterface.

Definition at line 64 of file class.ilObjectCommonSettingsFormAdapter.php.

    {
        global $DIC;
 
        if ($this->service->settings()->get('custom_icons')) {
            if (!is_null($this->legacy_form)) {
                $this->legacy_form = clone $this->legacy_form;
                require_once 'Services/Object/Icon/classes/class.ilObjectCustomIconConfigurationGUI.php';
                $gui = new \ilObjectCustomIconConfigurationGUI($DIC, null, $this->object);
                $gui->saveIcon($this->legacy_form);
            }
        }
    }

References $DIC, and $legacy_form.

◆ saveTitleIconVisibility()

ilObjectCommonSettingFormAdapter::saveTitleIconVisibility ( )

Save title icon visibility setting from form.

Implements ilObjectCommonSettingFormAdapterInterface.

Definition at line 150 of file class.ilObjectCommonSettingsFormAdapter.php.

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

References ilContainer\_writeContainerSetting().

Here is the call graph for this function:

◆ saveTopActionsVisibility()

ilObjectCommonSettingFormAdapter::saveTopActionsVisibility ( )

Save top actions visibility setting from form.

Implements ilObjectCommonSettingFormAdapterInterface.

Definition at line 177 of file class.ilObjectCommonSettingsFormAdapter.php.

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