Style settings of a repository object. More...

Collaboration diagram for ilObjectContentStyleSettingsGUI:

Public Member Functions
	__construct (InternalDomainService $domain_service, InternalGUIService $gui_service, ?int $current_style_id, int $ref_id, int $obj_id)

	executeCommand ()

	initStylePropertiesForm ()
	Init style properties form. More...

	forwardToStyleSheet ()

	createStyle ()

	editStyle ()

	deleteStyle ()

Protected Member Functions
	settings ()

	isContainer ()

	updateStyleId (int $style_id)

	setOwnerId (int $style_id)

	saveStyleSettings ()
	Save style settings. More...

	saveIndividualStyleSettings ()

Protected Attributes
ObjectManager	$object_manager

ContainerManager	$container_manager

InternalDomainService	$domain

InternalGUIService	$gui

int	$current_style_id

int	$ref_id

int	$obj_id

Private Attributes
ilGlobalTemplateInterface	$main_tpl

ilRbacSystem	$rbac_system

Detailed Description

Style settings of a repository object.

Author: Alexander Killing killi.nosp@m.ng@l.nosp@m.eifos.nosp@m..de @ilCtrl_Calls ilObjectContentStyleSettingsGUI: ilObjStyleSheetGUI

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

Constructor & Destructor Documentation

◆ __construct()

ilObjectContentStyleSettingsGUI::__construct	(	InternalDomainService	$domain_service,
		InternalGUIService	$gui_service,
		?int	$current_style_id,
		int	$ref_id,
		int	$obj_id
	)

Definition at line 43 of file class.ilObjectContentStyleSettingsGUI.php.

      {
        global $DIC;
        $this->main_tpl = $DIC->ui()->mainTemplate();
        $this->domain = $domain_service;
        $this->gui = $gui_service;
        $this->ref_id = $ref_id;
        $this->obj_id = ($obj_id > 0)
            ? $obj_id
            : ilObject::_lookupObjId($ref_id);
        $this->container_manager = $domain_service->repositoryContainer($ref_id);
        $this->object_manager = $domain_service->object($ref_id, $this->obj_id);
        $this->current_style_id = $current_style_id ?? $this->object_manager->getStyleId();
        $this->rbac_system = $DIC->rbac()->system();
    }

References $current_style_id, $DIC, $obj_id, $ref_id, ilObject\_lookupObjId(), ILIAS\Style\Content\InternalDomainService\object(), and ILIAS\Style\Content\InternalDomainService\repositoryContainer().

Here is the call graph for this function:

Member Function Documentation

◆ createStyle()

ilObjectContentStyleSettingsGUI::createStyle ( )

Definition at line 248 of file class.ilObjectContentStyleSettingsGUI.php.

                                 : void
    {
        $ctrl = $this->gui->ctrl();
        $ctrl->redirectByClass("ilobjstylesheetgui", "create");
    }

◆ deleteStyle()

ilObjectContentStyleSettingsGUI::deleteStyle ( )

Definition at line 260 of file class.ilObjectContentStyleSettingsGUI.php.

                                 : void
    {
        $ctrl = $this->gui->ctrl();
        $ctrl->redirectByClass("ilobjstylesheetgui", "delete");
    }

◆ editStyle()

ilObjectContentStyleSettingsGUI::editStyle ( )

Definition at line 254 of file class.ilObjectContentStyleSettingsGUI.php.

                               : void
    {
        $ctrl = $this->gui->ctrl();
        $ctrl->redirectByClass("ilobjstylesheetgui", "edit");
    }

◆ executeCommand()

ilObjectContentStyleSettingsGUI::executeCommand ( )

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

                                    : void
    {
        $ctrl = $this->gui->ctrl();
 
        $next_class = $ctrl->getNextClass($this);
        $cmd = $ctrl->getCmd("settings");
 
        switch ($next_class) {
            case "ilobjstylesheetgui":
                $this->gui->tabs()->clearTargets();
                $ctrl->setReturn($this, "settings");
                $this->forwardToStyleSheet();
                break;
 
            default:
                if (in_array($cmd, [
                    "settings",
                    "editStyle",
                    "updateStyle",
                    "createStyle",
                    "deleteStyle",
                    "saveStyleSettings",
                    "saveIndividualStyleSettings"
                ])) {
                    $this->$cmd();
                }
        }
    }

References forwardToStyleSheet().

Here is the call graph for this function:

◆ forwardToStyleSheet()

ilObjectContentStyleSettingsGUI::forwardToStyleSheet ( )

Definition at line 212 of file class.ilObjectContentStyleSettingsGUI.php.

                                         : void
    {
        $ctrl = $this->gui->ctrl();
        $cmd = $ctrl->getCmd();
 
        $style_gui = new ilObjStyleSheetGUI(
            "",
            $this->current_style_id,
            false
        );
        $style_id = $ctrl->forwardCommand($style_gui);
        if (in_array($cmd, ["save", "copyStyle", "importStyle", "confirmedDelete"])) {
            $style_id = $style_gui->getObject()->getId();
            if ($cmd == "confirmedDelete") {
                $style_id = 0;
            } else {
                $this->setOwnerId($style_id);
            }
            $this->updateStyleId($style_id);
            if (in_array($cmd, ["save", "copyStyle", "importStyle"])) {
                $ctrl->redirect($this, "editStyle");
            }
            $ctrl->redirect($this, "settings");
        }
    }

References setOwnerId(), and updateStyleId().

Referenced by executeCommand().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ initStylePropertiesForm()

ilObjectContentStyleSettingsGUI::initStylePropertiesForm ( )

Init style properties form.

Definition at line 105 of file class.ilObjectContentStyleSettingsGUI.php.

                                             : ilPropertyFormGUI
    {
        $ilCtrl = $this->gui->ctrl();
        $lng = $this->domain->lng();
 
        $style_id = $this->current_style_id;
        $access = $this->rbac_system->checkAccess('write', $this->ref_id);
 
        $lng->loadLanguageModule("style");
 
        $form = new ilPropertyFormGUI();
        if ($this->object_manager->globalFixed()) {
            $st = new ilNonEditableValueGUI($lng->txt("style_current_style"));
            $st->setValue($this->object_manager->getGlobalFixedTitle() . " (" .
                $lng->txt("global_fixed") . ")");
            $form->addItem($st);
        } else {
            $st_styles = $this->object_manager->getSelectableStyles();
 
            $default_title = "";
            if ($this->object_manager->getGlobalDefaultTitle() !== "") {
                $default_title = " (" . $this->object_manager->getGlobalDefaultTitle() . ")";
            }
            $st_styles[0] = $lng->txt("default") . $default_title;
            ksort($st_styles);
 
            // individual style
            if ($this->object_manager->hasEffectiveIndividualStyle($style_id)) {
                $st = new ilNonEditableValueGUI($lng->txt("style_current_style"));
                $st->setValue(ilObject::_lookupTitle($style_id));
                $form->addItem($st);
 
                if ($this->isContainer()) {
                    $cb = new ilCheckboxInputGUI($lng->txt("style_support_reuse"), "support_reuse");
                    $cb->setInfo($lng->txt("style_support_reuse_info"));
                    $cb->setChecked($this->container_manager->getReuse());
                    $form->addItem($cb);
                    if ($access) {
                        $form->addCommandButton(
                            "saveIndividualStyleSettings",
                            $lng->txt("save")
                        );
                    }
                }
 
                if ($access) {
                    $form->addCommandButton(
                        "editStyle",
                        $lng->txt("style_edit_style")
                    );
 
                    $form->addCommandButton(
                        "deleteStyle",
                        $lng->txt("style_delete_style")
                    );
                }
            }
 
            if ($this->object_manager->canSelectStyle($style_id)) {
                $style_sel = new ilSelectInputGUI(
                    $lng->txt("style_current_style"),
                    "style_id"
                );
                $style_sel->setOptions($st_styles);
                $style_sel->setValue($style_id);
                $form->addItem($style_sel);
 
                if ($access) {
                    $form->addCommandButton(
                        "saveStyleSettings",
                        $lng->txt("save")
                    );
 
                    $form->addCommandButton(
                        "createStyle",
                        $lng->txt("sty_create_ind_style")
                    );
                }
            }
        }
        $form->setTitle($lng->txt("obj_sty"));
        $form->setFormAction($ilCtrl->getFormAction($this));
 
        if (!$access) {
            foreach ($form->getItems() as $item) {
                if ($item instanceof ilFormSectionHeaderGUI) {
                    continue;
                }
 
                $item->setDisabled(true);
            }
        }
 
        return $form;
    }

References $current_style_id, $lng, ilObject\_lookupTitle(), and isContainer().

Referenced by saveIndividualStyleSettings(), saveStyleSettings(), and settings().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ isContainer()

ilObjectContentStyleSettingsGUI::isContainer ( )

protected

Definition at line 201 of file class.ilObjectContentStyleSettingsGUI.php.

                                    : bool
    {
        if ($this->ref_id > 0) {
            $type = ilObject::_lookupType($this->ref_id, true);
            if ($this->domain->objectDefinition()->isContainer($type)) {
                return true;
            }
        }
        return false;
    }

References ilObject\_lookupType().

Referenced by initStylePropertiesForm(), and saveIndividualStyleSettings().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ saveIndividualStyleSettings()

ilObjectContentStyleSettingsGUI::saveIndividualStyleSettings ( )

protected

Definition at line 285 of file class.ilObjectContentStyleSettingsGUI.php.

                                                    : void
    {
        $lng = $this->domain->lng();
        $ctrl = $this->gui->ctrl();
 
        $form = $this->initStylePropertiesForm();
        $form->checkInput();
        if ($this->isContainer()) {
            $this->container_manager->saveReuse((bool) $form->getInput("support_reuse"));
            $this->main_tpl->setOnScreenMessage('success', $lng->txt("msg_obj_modified"), true);
        }
        $ctrl->redirect($this, "settings");
    }

References $lng, initStylePropertiesForm(), and isContainer().

Here is the call graph for this function:

◆ saveStyleSettings()

ilObjectContentStyleSettingsGUI::saveStyleSettings ( )

protected

Save style settings.

Definition at line 269 of file class.ilObjectContentStyleSettingsGUI.php.

                                          : void
    {
        $settings = $this->domain->settings();
        $lng = $this->domain->lng();
        $ctrl = $this->gui->ctrl();
 
        $form = $this->initStylePropertiesForm();
        $form->checkInput();
        if ($this->object_manager->canSelectStyle($this->current_style_id)) {
            $style_id = (int) $form->getInput("style_id");
            $this->updateStyleId($style_id);
            $this->main_tpl->setOnScreenMessage('success', $lng->txt("msg_obj_modified"), true);
        }
        $ctrl->redirect($this, "settings");
    }

References $lng, initStylePropertiesForm(), ILIAS\Repository\int(), and updateStyleId().

Here is the call graph for this function:

◆ setOwnerId()

ilObjectContentStyleSettingsGUI::setOwnerId ( int $style_id )

protected

Definition at line 243 of file class.ilObjectContentStyleSettingsGUI.php.

                                                : void
    {
        $this->object_manager->setOwnerOfStyle($style_id);
    }

Referenced by forwardToStyleSheet().

Here is the caller graph for this function:

◆ settings()

ilObjectContentStyleSettingsGUI::settings ( )

protected

Definition at line 93 of file class.ilObjectContentStyleSettingsGUI.php.

                                 : void
    {
        $mt = $this->gui->mainTemplate();
        $form = $this->initStylePropertiesForm();
        $mt->setContent(
            $form->getHTML()
        );
    }

References initStylePropertiesForm().

Here is the call graph for this function:

◆ updateStyleId()

ilObjectContentStyleSettingsGUI::updateStyleId ( int $style_id )

protected

Definition at line 238 of file class.ilObjectContentStyleSettingsGUI.php.

                                                   : void
    {
        $this->object_manager->updateStyleId($style_id);
    }

Referenced by forwardToStyleSheet(), and saveStyleSettings().

Here is the caller graph for this function:

Field Documentation

◆ $container_manager

ContainerManager ilObjectContentStyleSettingsGUI::$container_manager

protected

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

◆ $current_style_id

int ilObjectContentStyleSettingsGUI::$current_style_id

protected

Definition at line 37 of file class.ilObjectContentStyleSettingsGUI.php.

Referenced by __construct(), and initStylePropertiesForm().

◆ $domain

InternalDomainService ilObjectContentStyleSettingsGUI::$domain

protected

Definition at line 35 of file class.ilObjectContentStyleSettingsGUI.php.

◆ $gui

InternalGUIService ilObjectContentStyleSettingsGUI::$gui

protected

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

◆ $main_tpl

ilGlobalTemplateInterface ilObjectContentStyleSettingsGUI::$main_tpl

private

Definition at line 40 of file class.ilObjectContentStyleSettingsGUI.php.

◆ $obj_id

int ilObjectContentStyleSettingsGUI::$obj_id

protected

Definition at line 39 of file class.ilObjectContentStyleSettingsGUI.php.

Referenced by __construct().

◆ $object_manager

ObjectManager ilObjectContentStyleSettingsGUI::$object_manager

protected

Definition at line 33 of file class.ilObjectContentStyleSettingsGUI.php.

◆ $rbac_system

ilRbacSystem ilObjectContentStyleSettingsGUI::$rbac_system

private

Definition at line 41 of file class.ilObjectContentStyleSettingsGUI.php.

◆ $ref_id

int ilObjectContentStyleSettingsGUI::$ref_id

protected

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

Referenced by __construct().

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

components/ILIAS/Style/Content/Object/class.ilObjectContentStyleSettingsGUI.php

Public Member Functions

Protected Member Functions

Protected Attributes

Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ createStyle()

◆ deleteStyle()

◆ editStyle()

◆ executeCommand()

◆ forwardToStyleSheet()

◆ initStylePropertiesForm()

◆ isContainer()

◆ saveIndividualStyleSettings()

◆ saveStyleSettings()

◆ setOwnerId()

◆ settings()

◆ updateStyleId()

Field Documentation

◆ $container_manager

◆ $current_style_id

◆ $domain

◆ $gui

◆ $main_tpl

◆ $obj_id

◆ $object_manager

◆ $rbac_system

◆ $ref_id