Collaboration diagram for ilSystemStyleOverviewGUI:

Public Member Functions
	__construct (ilCtrl $ctrl, Language $lng, ilGlobalTemplateInterface $tpl, Factory $ui_factory, Renderer $renderer, WrapperFactory $request_wrapper, ilToolbarGUI $toolbar, Refinery $refinery, ilSkinFactory $skin_factory, FileUpload $upload, ilTabsGUI $tabs, ilHelpGUI $help, string $skin_id, string $style_id, string $ref_id, bool $read_only, bool $management_enabled)

	executeCommand ()

	getAssignmentCreationModal (string $style_name="")

	edit ()

	saveStyleSettings ()

	moveUserStyles ()

	isReadOnly ()

	setReadOnly (bool $read_only)

	isManagementEnabled ()

	setManagementEnabled (bool $management_enabled)

Protected Member Functions
	view ()

	cancel ()

	checkStyleSettings (ilSystemStyleMessageStack $message_stack, ?array $active_styles)

	export ()

Protected Attributes
ilCtrl	$ctrl

ilToolbarGUI	$toolbar

Language	$lng

ilGlobalTemplateInterface	$tpl

ilSkinFactory	$skin_factory

ilSkinStyleContainer	$style_container

ilSystemStyleMessageStack	$message_stack

Factory	$ui_factory

Renderer	$renderer

WrapperFactory	$request_wrapper

Refinery	$refinery

ilSystemStyleConfig	$config

ilTabsGUI	$tabs

ilHelpGUI	$help

FileUpload	$upload

string	$ref_id

bool	$read_only = true

bool	$management_enabled = false

string	$style_id

Detailed Description

Definition at line 28 of file class.ilSystemStyleOverviewGUI.php.

Constructor & Destructor Documentation

◆ __construct()

ilSystemStyleOverviewGUI::__construct	(	ilCtrl	$ctrl,
		Language	$lng,
		ilGlobalTemplateInterface	$tpl,
		Factory	$ui_factory,
		Renderer	$renderer,
		WrapperFactory	$request_wrapper,
		ilToolbarGUI	$toolbar,
		Refinery	$refinery,
		ilSkinFactory	$skin_factory,
		FileUpload	$upload,
		ilTabsGUI	$tabs,
		ilHelpGUI	$help,
		string	$skin_id,
		string	$style_id,
		string	$ref_id,
		bool	$read_only,
		bool	$management_enabled
	)

Definition at line 51 of file class.ilSystemStyleOverviewGUI.php.

      {
        $this->ctrl = $ctrl;
        $this->lng = $lng;
        $this->tpl = $tpl;
        $this->ui_factory = $ui_factory;
        $this->renderer = $renderer;
        $this->request_wrapper = $request_wrapper;
        $this->toolbar = $toolbar;
        $this->refinery = $refinery;
        $this->tabs = $tabs;
        $this->style_id = $style_id;
        $this->message_stack = new ilSystemStyleMessageStack($this->tpl);
        $this->skin_factory = $skin_factory;
        $this->style_container = $this->skin_factory->skinStyleContainerFromId($skin_id, $this->message_stack);
        $this->help = $help;
        $this->ref_id = $ref_id;
        $this->upload = $upload;
        $this->config = new ilSystemStyleConfig();
        $this->setReadOnly($read_only);
        $this->setManagementEnabled($management_enabled);
    }

References $ctrl, $help, $lng, $ref_id, $refinery, $renderer, $request_wrapper, $skin_factory, $style_id, $tabs, $toolbar, $tpl, $ui_factory, $upload, ILIAS\Repository\ctrl(), ILIAS\Repository\help(), ILIAS\Repository\lng(), ILIAS\Repository\refinery(), renderer(), setManagementEnabled(), setReadOnly(), ilSkinFactory\skinStyleContainerFromId(), ILIAS\Repository\tabs(), ILIAS\Repository\toolbar(), and ILIAS\Repository\upload().

Here is the call graph for this function:

Member Function Documentation

◆ cancel()

ilSystemStyleOverviewGUI::cancel ( )

protected

Definition at line 174 of file class.ilSystemStyleOverviewGUI.php.

                               : void
    {
        $this->edit();
    }

References edit().

Here is the call graph for this function:

◆ checkStyleSettings()

ilSystemStyleOverviewGUI::checkStyleSettings	(	ilSystemStyleMessageStack	$message_stack,
		?array	$active_styles
	)

protected

Definition at line 253 of file class.ilSystemStyleOverviewGUI.php.

                                                                                                          : bool
    {
        $passed = true;
 
        if (!$active_styles || count($active_styles) < 1) {
            $passed = false;
            $message_stack->addMessage(new ilSystemStyleMessage(
                $this->lng->txt('at_least_one_style'),
                ilSystemStyleMessage::TYPE_ERROR
            ));
        }
 
        if ($this->request_wrapper->post()->has('default_skin_style')) {
            $default_style = $this->request_wrapper->post()->retrieve(
                'default_skin_style',
                $this->refinery->kindlyTo()->string()
            );
        } else {
            $default_style = $this->config->getDefaultStyleId();
        }
 
 
 
        if (!isset($active_styles[$default_style])) {
            $passed = false;
            $message_stack->addMessage(new ilSystemStyleMessage(
                $this->lng->txt('cant_deactivate_default_style'),
                ilSystemStyleMessage::TYPE_ERROR
            ));
        }
 
        // check if a style should be deactivated, that still has
        // a user assigned to
        $all_styles = ilStyleDefinition::getAllSkinStyles();
 
        foreach ($all_styles as $style) {
            if (!isset($active_styles[$style['id']])) {
                if (ilObjUser::_getNumberOfUsersForStyle($style['template_id'], $style['style_id']) > 0) {
                    $passed = false;
                    $message_stack->addMessage(new ilSystemStyleMessage(
                        $style['style_name'] . ': ' . $this->lng->txt('cant_deactivate_if_users_assigned'),
                        ilSystemStyleMessage::TYPE_ERROR
                    ));
                }
            }
        }
        return $passed;
    }

References $message_stack, ilObjUser\_getNumberOfUsersForStyle(), ilSystemStyleMessageStack\addMessage(), ilStyleDefinition\getAllSkinStyles(), ILIAS\Repository\lng(), ILIAS\Repository\refinery(), and ilSystemStyleMessage\TYPE_ERROR.

Referenced by saveStyleSettings().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ edit()

ilSystemStyleOverviewGUI::edit ( )

Definition at line 179 of file class.ilSystemStyleOverviewGUI.php.

                          : void
    {
        $table = new ilSystemStylesTableGUI($this, 'edit');
        $table->addActions($this->isManagementEnabled());
        $this->tpl->setContent($table->getHTML().$table->getModalsHtml());
    }

References isManagementEnabled().

Referenced by cancel().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ executeCommand()

ilSystemStyleOverviewGUI::executeCommand ( )

Definition at line 91 of file class.ilSystemStyleOverviewGUI.php.

                                    : void
    {
        $cmd = $this->ctrl->getCmd();
 
        if ($cmd == '') {
            $cmd = $this->isReadOnly() ? 'view' : 'edit';
        }
 
        switch ($cmd) {
            case 'addSystemStyle':
            case 'addSubStyle':
            case 'saveNewSystemStyle':
            case 'saveNewSubStyle':
            case 'copyStyle':
            case 'importStyle':
            case 'deleteStyles':
            case 'deleteStyle':
            case 'confirmDelete':
                if (!$this->isManagementEnabled()) {
                    throw new ilObjectException($this->lng->txt('permission_denied'));
                }
                $this->$cmd();
                break;
            case 'cancel':
            case 'edit':
            case 'export':
            case 'moveUserStyles':
            case 'saveStyleSettings':
                if ($this->isReadOnly()) {
                    throw new ilObjectException($this->lng->txt('permission_denied'));
                }
                $this->$cmd();
                break;
            case 'view':
                $this->$cmd();
                break;
        }
        $this->message_stack->sendMessages();
    }

References ILIAS\Repository\ctrl(), isManagementEnabled(), isReadOnly(), and ILIAS\Repository\lng().

Here is the call graph for this function:

◆ export()

ilSystemStyleOverviewGUI::export ( )

protected

Definition at line 303 of file class.ilSystemStyleOverviewGUI.php.

                               : void
    {
        try {
            $this->style_container->export();
        } catch (Exception $e) {
            $this->message_stack->addMessage(new ilSystemStyleMessage(
                $this->lng->txt('zip_export_failed') . ' ' . $e->getMessage(),
                ilSystemStyleMessage::TYPE_ERROR
            ));
        }
    }

References Vendor\Package\$e, ILIAS\Repository\lng(), and ilSystemStyleMessage\TYPE_ERROR.

Here is the call graph for this function:

◆ getAssignmentCreationModal()

ilSystemStyleOverviewGUI::getAssignmentCreationModal ( string $style_name = "" )

Definition at line 137 of file class.ilSystemStyleOverviewGUI.php.

                                                                       : ?\ILIAS\UI\Component\Modal\RoundTrip
    {
        $options = [];
        foreach (ilStyleDefinition::getAllSkinStyles() as $id => $skin_style) {
            if (!$skin_style['substyle_of'] && $style_name != $skin_style['style_name']) {
                $options[$id] = $skin_style['title'];
            }
        }
 
        $default = "default:delos";
        if ($style_name == "Delos") {
            $default = key($options);
        }
 
        if (count($options) == 0) {
            return null;
        }
 
        $txt = $this->lng->txt('sty_move_user_styles').' '.$this->lng->txt('sty_to');
 
        $byline = $this->lng->txt('sty_move_user_styles') . ' ' .
            $this->lng->txt('sty_from')  . ' ' . $style_name;
 
        $select = $this->ui_factory->input()->field()
                                            ->select($txt, $options, $byline)
                                            ->withValue($default)
                                            ->withAdditionalTransformation($this->refinery->string()->splitString(':'))
                                            ->withRequired(true);
 
        return $this->ui_factory->modal()->roundtrip(
            $this->lng->txt('change_assignment'),
            [],
            ["new_style" => $select],
            $this->ctrl->getLinkTargetByClass(ilSystemStyleOverviewGUI::class, 'moveUserStyles')
        );
    }

References $id, $txt, ilStyleDefinition\getAllSkinStyles(), ILIAS\Repository\lng(), and ILIAS\Repository\refinery().

Referenced by moveUserStyles().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ isManagementEnabled()

ilSystemStyleOverviewGUI::isManagementEnabled ( )

Definition at line 326 of file class.ilSystemStyleOverviewGUI.php.

                                         : bool
    {
        return $this->management_enabled;
    }

References $management_enabled.

Referenced by edit(), and executeCommand().

Here is the caller graph for this function:

◆ isReadOnly()

ilSystemStyleOverviewGUI::isReadOnly ( )

Definition at line 316 of file class.ilSystemStyleOverviewGUI.php.

                                : bool
    {
        return $this->read_only;
    }

References $read_only.

Referenced by executeCommand().

Here is the caller graph for this function:

◆ moveUserStyles()

ilSystemStyleOverviewGUI::moveUserStyles ( )

Definition at line 217 of file class.ilSystemStyleOverviewGUI.php.

                                    : void
    {
        global $DIC;
 
        $request = $DIC->http()->request();
 
        $modal = $this->getAssignmentCreationModal()->withRequest($request);
        [$new_skin, $new_style] = $modal->getData()["new_style"];
 
        $old_skin = $this->request_wrapper->query()->retrieve('old_skin_id', $this->refinery->kindlyTo()->string());
        $old_style = $this->request_wrapper->query()->retrieve('old_style_id', $this->refinery->kindlyTo()->string());
 
 
 
        if ($old_style == 'other') {
            // get all user assigned styles
            $all_user_styles = ilObjUser::_getAllUserAssignedStyles();
 
            // move users that are not assigned to
            // currently existing style
            foreach ($all_user_styles as $style) {
                if (!ilStyleDefinition::styleExists($style)) {
                    [$old_skin, $old_style] = explode(':', $style);
                    ilObjUser::_moveUsersToStyle($old_skin, $old_style, $new_skin, $new_style);
                }
            }
        } else {
            ilObjUser::_moveUsersToStyle($old_skin, $old_style, $new_skin, $new_style);
        }
        $message = sprintf($this->lng->txt('sty_move_user_styles_saved'), $old_skin, $new_skin);
 
        $this->message_stack->addMessage(new ilSystemStyleMessage($message, ilSystemStyleMessage::TYPE_SUCCESS));
        $this->message_stack->sendMessages();
        $this->ctrl->redirect($this, 'edit');
    }

References $DIC, $message, ilObjUser\_getAllUserAssignedStyles(), ilObjUser\_moveUsersToStyle(), ILIAS\Repository\ctrl(), getAssignmentCreationModal(), ILIAS\Repository\lng(), ILIAS\Repository\refinery(), ilStyleDefinition\styleExists(), and ilSystemStyleMessage\TYPE_SUCCESS.

Here is the call graph for this function:

◆ saveStyleSettings()

ilSystemStyleOverviewGUI::saveStyleSettings ( )

Definition at line 186 of file class.ilSystemStyleOverviewGUI.php.

                                       : void
    {
        $active_styles = $this->request_wrapper->post()->retrieve('st_act', $this->refinery->identity());
 
        if ($this->checkStyleSettings($this->message_stack, $active_styles)) {
            $all_styles = ilStyleDefinition::getAllSkinStyles();
            foreach ($all_styles as $style) {
                if (!isset($active_styles[$style['id']])) {
                    ilSystemStyleSettings::_deactivateStyle($style['template_id'], $style['style_id']);
                } else {
                    ilSystemStyleSettings::_activateStyle($style['template_id'], $style['style_id']);
                }
            }
 
            //set default skin and style
            if ($this->request_wrapper->post()->has('default_skin_style')) {
                $sknst = $this->request_wrapper->post()->retrieve(
                    'default_skin_style',
                    $this->refinery->string()->splitString(':')
                );
                ilSystemStyleSettings::setCurrentDefaultStyle($sknst[0], $sknst[1]);
            }
            $this->message_stack->addMessage(new ilSystemStyleMessage(
                $this->lng->txt('msg_obj_modified'),
                ilSystemStyleMessage::TYPE_SUCCESS
            ));
        }
        $this->message_stack->sendMessages();
        $this->ctrl->redirect($this, 'edit');
    }

References ilSystemStyleSettings\_activateStyle(), ilSystemStyleSettings\_deactivateStyle(), checkStyleSettings(), ILIAS\Repository\ctrl(), ilStyleDefinition\getAllSkinStyles(), ILIAS\Repository\lng(), ILIAS\Repository\refinery(), ilSystemStyleSettings\setCurrentDefaultStyle(), and ilSystemStyleMessage\TYPE_SUCCESS.

Here is the call graph for this function:

◆ setManagementEnabled()

ilSystemStyleOverviewGUI::setManagementEnabled ( bool $management_enabled )

Definition at line 331 of file class.ilSystemStyleOverviewGUI.php.

                                                                  : void
    {
        $this->management_enabled = $management_enabled;
    }

References $management_enabled.

Referenced by __construct().

Here is the caller graph for this function:

◆ setReadOnly()

ilSystemStyleOverviewGUI::setReadOnly ( bool $read_only )

Definition at line 321 of file class.ilSystemStyleOverviewGUI.php.

                                                : void
    {
        $this->read_only = $read_only;
    }

References $read_only.

Referenced by __construct().

Here is the caller graph for this function:

◆ view()

ilSystemStyleOverviewGUI::view ( )

protected

Definition at line 131 of file class.ilSystemStyleOverviewGUI.php.

                             : void
    {
        $table = new ilSystemStylesTableGUI($this, 'edit');
        $this->tpl->setContent($table->getHTML().$table->getModalsHtml());
    }