ilSystemStyleOverviewGUI Class Reference

Collaboration diagram for ilSystemStyleOverviewGUI:

Public Member Functions
	__construct (ilCtrl $ctrl, ilLanguage $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 ()
	moveUserStyles ()
	saveStyleSettings ()
	isReadOnly ()
	setReadOnly (bool $read_only)
	isManagementEnabled ()
	setManagementEnabled (bool $management_enabled)

Protected Member Functions
	view ()
	cancel ()
	checkStyleSettings (ilSystemStyleMessageStack $message_stack, array $active_styles)
	addSystemStyle ()
	saveNewSystemStyle ()
	addSystemStyleForms ()
	createSystemStyleForm ()
	importSystemStyleForm ()
	cloneSystemStyleForm ()
	copyStyle ()
	deleteStyle ()
	deleteStyles ()
	checkDeletable (string $skin_id, string $style_id, ilSystemStyleMessageStack $message_stack)
	confirmDelete ()
	export ()
	addSubStyle ()
	addSubStyleForms ()
	saveNewSubStyle ()

Protected Attributes
ilCtrl	$ctrl
ilToolbarGUI	$toolbar
ilLanguage	$lng
ilGlobalTemplateInterface	$tpl
ilSkinFactory	$skin_factory
ilFileSystemHelper	$file_system
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 27 of file class.ilSystemStyleOverviewGUI.php.

Constructor & Destructor Documentation

__construct()

ilSystemStyleOverviewGUI::__construct	(	ilCtrl	$ctrl,
		ilLanguage	$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.

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(), setManagementEnabled(), setReadOnly(), ilSkinFactory\skinStyleContainerFromId(), ILIAS\Repository\tabs(), ILIAS\Repository\toolbar(), and ILIAS\Repository\upload().

      {
        $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->file_system = new ilFileSystemHelper($this->lng, $this->message_stack);
        $this->upload = $upload;
        $this->config = new ilSystemStyleConfig();
        $this->setReadOnly($read_only);
        $this->setManagementEnabled($management_enabled);
    }

Here is the call graph for this function:

Member Function Documentation

addSubStyle()

ilSystemStyleOverviewGUI::addSubStyle ( )

protected

Since clearTargets also clears the help screen ids

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

References addSubStyleForms(), ILIAS\Repository\help(), and ILIAS\Repository\tabs().

                                    : void
    {
        $this->tabs->clearTargets();
        $this->help->setScreenIdComponent('sty');
        $this->help->setScreenId('system_styles');
        $this->help->setSubScreenId('create_sub');

        $form = $this->addSubStyleForms();

        $this->tpl->setContent($form->getHTML());
    }

Here is the call graph for this function:

addSubStyleForms()

ilSystemStyleOverviewGUI::addSubStyleForms ( )

protected

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

References $id, ILIAS\Repository\ctrl(), ilStyleDefinition\getAllSkinStyles(), ILIAS\Repository\lng(), and ilFormPropertyGUI\setRequired().

Referenced by addSubStyle(), and saveNewSubStyle().

                                         : ilPropertyFormGUI
    {
        $form = new ilPropertyFormGUI();
        $form->setFormAction($this->ctrl->getFormAction($this));
        $form->setTitle($this->lng->txt('sty_create_new_system_sub_style'));

        $ti = new ilTextInputGUI($this->lng->txt('sub_style_id'), 'sub_style_id');
        $ti->setInfo($this->lng->txt('sub_style_id_description'));
        $ti->setMaxLength(128);
        $ti->setSize(40);
        $ti->setRequired(true);
        $form->addItem($ti);

        $ti = new ilTextInputGUI($this->lng->txt('sub_style_name'), 'sub_style_name');
        $ti->setInfo($this->lng->txt('sub_style_name_description'));
        $ti->setMaxLength(128);
        $ti->setSize(40);
        $ti->setRequired(true);
        $form->addItem($ti);

        // source
        $ti = new ilSelectInputGUI($this->lng->txt('parent'), 'parent_style');
        $ti->setRequired(true);
        $ti->setInfo($this->lng->txt('sub_style_parent_style_description'));
        $styles = ilStyleDefinition::getAllSkinStyles();
        $options = [];
        foreach ($styles as $id => $style) {
            $system_style_conf = new ilSystemStyleConfig();
            if ($style['skin_id'] != $system_style_conf->getDefaultSkinId() && !$style['substyle_of']) {
                $options[$id] = $style['title'];
            }
        }
        $ti->setOptions($options);

        $form->addItem($ti);
        $form->addCommandButton('saveNewSubStyle', $this->lng->txt('save'));
        $form->addCommandButton('cancel', $this->lng->txt('cancel'));

        return $form;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

addSystemStyle()

ilSystemStyleOverviewGUI::addSystemStyle ( )

protected

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

References addSystemStyleForms().

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

Here is the call graph for this function:

addSystemStyleForms()

ilSystemStyleOverviewGUI::addSystemStyleForms ( )

protected

Since clearTargets also clears the help screen ids

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

References cloneSystemStyleForm(), createSystemStyleForm(), ILIAS\Repository\help(), importSystemStyleForm(), and ILIAS\Repository\tabs().

Referenced by addSystemStyle().

                                            : void
    {
        $this->tabs->clearTargets();
        $this->help->setScreenIdComponent('sty');
        $this->help->setScreenId('system_styles');
        $this->help->setSubScreenId('create');

        $forms = [];

        $forms[] = $this->createSystemStyleForm();
        $forms[] = $this->importSystemStyleForm();
        $forms[] = $this->cloneSystemStyleForm();

        $this->tpl->setContent($this->getCreationFormsHTML($forms));
    }

Here is the call graph for this function:

Here is the caller graph for this function:

cancel()

ilSystemStyleOverviewGUI::cancel ( )

protected

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

References edit().

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

Here is the call graph for this function:

checkDeletable()

ilSystemStyleOverviewGUI::checkDeletable ( string  $skin_id, string  $style_id, ilSystemStyleMessageStack  $message_stack  )

protected

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

References $style_id, ilObjUser\_getNumberOfUsersForStyle(), ilSystemStyleSettings\_lookupActivatedStyle(), ilSystemStyleMessageStack\addMessage(), ilSystemStyleSettings\getCurrentDefaultSkin(), ILIAS\Repository\lng(), and ilSystemStyleMessage\TYPE_ERROR.

Referenced by deleteStyle(), and deleteStyles().

     : bool {
        $passed = true;
        if (ilObjUser::_getNumberOfUsersForStyle($skin_id, $style_id) > 0) {
            $message_stack->addMessage(new ilSystemStyleMessage(
                $style_id . ': ' . $this->lng->txt('cant_delete_if_users_assigned'),
                ilSystemStyleMessage::TYPE_ERROR
            ));
            $passed = false;
        }
        if (ilSystemStyleSettings::_lookupActivatedStyle($skin_id, $style_id) > 0) {
            $message_stack->addMessage(new ilSystemStyleMessage(
                $style_id . ': ' . $this->lng->txt('cant_delete_activated_style'),
                ilSystemStyleMessage::TYPE_ERROR
            ));
            $passed = false;
        }
        if (ilSystemStyleSettings::getCurrentDefaultSkin() == $skin_id && ilSystemStyleSettings::getCurrentDefaultSkin() == $style_id) {
            $message_stack->addMessage(new ilSystemStyleMessage(
                $style_id . ': ' . $this->lng->txt('cant_delete_default_style'),
                ilSystemStyleMessage::TYPE_ERROR
            ));
            $passed = false;
        }

        if ($this->skin_factory->skinStyleContainerFromId($skin_id, $this->message_stack)->getSkin()->getSubstylesOfStyle($style_id)) {
            $message_stack->addMessage(new ilSystemStyleMessage(
                $style_id . ': ' . $this->lng->txt('cant_delete_style_with_substyles'),
                ilSystemStyleMessage::TYPE_ERROR
            ));
            $passed = false;
        }
        return $passed;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

checkStyleSettings()

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

protected

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

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

Referenced by saveStyleSettings().

                                                                                                         : bool
    {
        $passed = true;

        if (count($active_styles) < 1) {
            $passed = false;
            $message_stack->addMessage(new ilSystemStyleMessage(
                $this->lng->txt('at_least_one_style'),
                ilSystemStyleMessage::TYPE_ERROR
            ));
        }

        $default_style = $this->request_wrapper->post()->retrieve(
            'default_skin_style',
            $this->refinery->kindlyTo()->string()
        );

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

Here is the call graph for this function:

Here is the caller graph for this function:

cloneSystemStyleForm()

ilSystemStyleOverviewGUI::cloneSystemStyleForm ( )

protected

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

References $id, ILIAS\Repository\ctrl(), ilAccordionGUI\FIRST_OPEN, ilStyleDefinition\getAllSkinStyles(), ILIAS\Repository\lng(), and ilFormPropertyGUI\setRequired().

Referenced by addSystemStyleForms().

                                             : ilPropertyFormGUI
    {
        $form = new ilPropertyFormGUI();
        $form->setFormAction($this->ctrl->getFormAction($this));
        $form->setTitle($this->lng->txt('sty_copy_other_system_style'));

        // source
        $ti = new ilSelectInputGUI($this->lng->txt('sty_source'), 'source_style');
        $ti->setRequired(true);
        $styles = ilStyleDefinition::getAllSkinStyles();
        $options = [];
        foreach ($styles as $id => $style) {
            $system_style_conf = new ilSystemStyleConfig();
            if ($style['skin_id'] != $system_style_conf->getDefaultSkinId()) {
                $options[$id] = $style['title'];
            }
        }
        $ti->setOptions($options);

        $form->addItem($ti);

        $form->addCommandButton('copyStyle', $this->lng->txt('copy'));
        $form->addCommandButton('cancel', $this->lng->txt('cancel'));

        return $form;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

confirmDelete()

ilSystemStyleOverviewGUI::confirmDelete ( )

protected

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

References $container, Vendor\Package\$e, $message_stack, ILIAS\Repository\ctrl(), importSystemStyleForm(), ILIAS\Repository\lng(), ILIAS\Repository\refinery(), ilSystemStyleMessage\TYPE_ERROR, ilSystemStyleMessage\TYPE_SUCCESS, and ILIAS\Repository\upload().

                                      : void
    {
        $i = 0;
        while ($this->request_wrapper->post()->has('style_' . $i)) {
            try {
                $skin_style_id = $this->request_wrapper->post()->retrieve(
                    'style_' . $i,
                    $this->refinery->string()->splitString(':')
                );
                $container = $this->skin_factory->skinStyleContainerFromId($skin_style_id[0], $this->message_stack);
                $syle = $container->getSkin()->getStyle($skin_style_id[1]);
                $container->deleteStyle($syle);
                if (!$container->getSkin()->hasStyles()) {
                    $container->delete();
                }
            } catch (Exception $e) {
                $this->message_stack->addMessage(new ilSystemStyleMessage(
                    $e->getMessage(),
                    ilSystemStyleMessage::TYPE_ERROR
                ));
            }
            $i++;
        }
        $this->message_stack->sendMessages();
        $this->ctrl->redirect($this);
    }

Here is the call graph for this function:

copyStyle()

ilSystemStyleOverviewGUI::copyStyle ( )

protected

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

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

                                  : void
    {
        $imploded_skin_style_id = $this->request_wrapper->post()->retrieve(
            'source_style',
            $this->refinery->string()->splitString(':')
        );
        $skin_id = $imploded_skin_style_id[0];
        $style_id = $imploded_skin_style_id[1];

        try {
            $container = $this->skin_factory->skinStyleContainerFromId($skin_id, $this->message_stack);
            $new_container = $this->skin_factory->copyFromSkinStyleContainer(
                $container,
                $this->file_system,
                $this->message_stack,
                $this->lng->txt('sty_acopy')
            );
            $this->message_stack->prependMessage(new ilSystemStyleMessage(
                $this->lng->txt('style_copied'),
                ilSystemStyleMessage::TYPE_SUCCESS
            ));
            $this->ctrl->setParameterByClass('ilsystemstyleconfiggui', 'skin_id', $new_container->getSkin()->getId());
            $this->ctrl->setParameterByClass(
                'ilsystemstyleconfiggui',
                'style_id',
                $new_container->getSkin()->getStyle($style_id)->getId()
            );
            $this->message_stack->addMessage(new ilSystemStyleMessage(
                $this->lng->txt('directory_created') . ' ' . $new_container->getSkinDirectory(),
                ilSystemStyleMessage::TYPE_SUCCESS
            ));
        } catch (Exception $e) {
            $this->message_stack->addMessage(new ilSystemStyleMessage(
                $e->getMessage(),
                ilSystemStyleMessage::TYPE_ERROR
            ));
        }
        $this->message_stack->sendMessages();
        $this->ctrl->redirectByClass('ilsystemstyleconfiggui');
    }

Here is the call graph for this function:

createSystemStyleForm()

ilSystemStyleOverviewGUI::createSystemStyleForm ( )

protected

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

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

Referenced by addSystemStyleForms(), and saveNewSystemStyle().

                                              : ilPropertyFormGUI
    {
        $form = new ilPropertyFormGUI();
        $form->setFormAction($this->ctrl->getFormAction($this));
        $form->setTitle($this->lng->txt('sty_create_new_system_style'));

        $ti = new ilTextInputGUI($this->lng->txt('skin_id'), 'skin_id');
        $ti->setInfo($this->lng->txt('skin_id_description'));
        $ti->setMaxLength(128);
        $ti->setSize(40);
        $ti->setRequired(true);
        $form->addItem($ti);

        $ti = new ilTextInputGUI($this->lng->txt('skin_name'), 'skin_name');
        $ti->setInfo($this->lng->txt('skin_name_description'));
        $ti->setMaxLength(128);
        $ti->setSize(40);
        $ti->setRequired(true);
        $form->addItem($ti);

        $ti = new ilTextInputGUI($this->lng->txt('style_id'), 'style_id');
        $ti->setInfo($this->lng->txt('style_id_description'));
        $ti->setMaxLength(128);
        $ti->setSize(40);
        $ti->setRequired(true);
        $form->addItem($ti);

        $ti = new ilTextInputGUI($this->lng->txt('style_name'), 'style_name');
        $ti->setInfo($this->lng->txt('style_name_description'));
        $ti->setMaxLength(128);
        $ti->setSize(40);
        $ti->setRequired(true);
        $form->addItem($ti);

        $form->addCommandButton('saveNewSystemStyle', $this->lng->txt('save'));
        $form->addCommandButton('cancel', $this->lng->txt('cancel'));

        return $form;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

deleteStyle()

ilSystemStyleOverviewGUI::deleteStyle ( )

protected

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

References $container, $style_id, checkDeletable(), ILIAS\Repository\ctrl(), edit(), ILIAS\Repository\lng(), and ilSystemStyleMessage\TYPE_ERROR.

                                    : void
    {
        $skin_id = $this->style_container->getSkin()->getId();
        $style_id = $this->style_id;

        if ($this->checkDeletable($skin_id, $style_id, $this->message_stack)) {
            $delete_form_table = new ilSystemStyleDeleteGUI($this->lng, $this->ctrl);
            $container = $this->skin_factory->skinStyleContainerFromId($skin_id, $this->message_stack);
            $delete_form_table->addStyle(
                $container->getSkin(),
                $container->getSkin()->getStyle($style_id),
                $container->getImagesStylePath($style_id) . '/standard/icon_stys.svg'
            );
            $this->tpl->setContent($delete_form_table->getDeleteStyleFormHTML());
        } else {
            $this->message_stack->prependMessage(new ilSystemStyleMessage(
                $this->lng->txt('style_not_deleted'),
                ilSystemStyleMessage::TYPE_ERROR
            ));
            $this->edit();
        }
    }

Here is the call graph for this function:

deleteStyles()

ilSystemStyleOverviewGUI::deleteStyles ( )

protected

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

References $container, checkDeletable(), ILIAS\Repository\ctrl(), edit(), ILIAS\Repository\lng(), ILIAS\Repository\refinery(), and ilSystemStyleMessage\TYPE_ERROR.

                                     : void
    {
        $delete_form_table = new ilSystemStyleDeleteGUI($this->lng, $this->ctrl);

        $all_deletable = true;

        $skin_ids = $this->request_wrapper->post()->retrieve('id', $this->refinery->identity());
        foreach ($skin_ids as $skin_style_id) {
            $imploded_skin_style_id = explode(':', $skin_style_id);
            $skin_id = $imploded_skin_style_id[0];
            $style_id = $imploded_skin_style_id[1];
            if (!$this->checkDeletable($skin_id, $style_id, $this->message_stack)) {
                $all_deletable = false;
            }
        }
        if ($all_deletable) {
            foreach ($skin_ids as $skin_style_id) {
                $imploded_skin_style_id = explode(':', $skin_style_id);
                $skin_id = $imploded_skin_style_id[0];
                $style_id = $imploded_skin_style_id[1];
                $container = $this->skin_factory->skinStyleContainerFromId($skin_id, $this->message_stack);
                $delete_form_table->addStyle(
                    $container->getSkin(),
                    $container->getSkin()->getStyle($style_id),
                    $container->getImagesStylePath($style_id) . '/standard/icon_stys.svg'
                );
            }
            $this->tpl->setContent($delete_form_table->getDeleteStyleFormHTML());
        } else {
            $this->message_stack->prependMessage(new ilSystemStyleMessage(
                $this->lng->txt('styles_not_deleted'),
                ilSystemStyleMessage::TYPE_ERROR
            ));
            $this->edit();
        }
    }

Here is the call graph for this function:

edit()

ilSystemStyleOverviewGUI::edit

(

)

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

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

Referenced by cancel(), deleteStyle(), and deleteStyles().

                          : void
    {
        if ($this->isManagementEnabled()) {
            // Add Button for adding skins
            $this->toolbar->addComponent($this->ui_factory->button()->standard(
                $this->lng->txt('add_system_style'),
                $this->ctrl->getLinkTarget($this, 'addSystemStyle')
            ));

            // Add Button for adding sub styles
            $add_sub = $this->ui_factory->button()->standard(
                $this->lng->txt('add_substyle'),
                $this->ctrl->getLinkTarget($this, 'addSubStyle')
            );
            if (count(ilStyleDefinition::getAllSkins()) == 1) {
                $add_sub = $add_sub->withUnavailableAction();
            }
            $this->toolbar->addComponent($add_sub);
        }

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

Here is the call graph for this function:

Here is the caller graph for this function:

executeCommand()

ilSystemStyleOverviewGUI::executeCommand

(

)

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

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

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

Here is the call graph for this function:

export()

ilSystemStyleOverviewGUI::export ( )

protected

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

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

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

Here is the call graph for this function:

getAssignmentCreationModal()

ilSystemStyleOverviewGUI::getAssignmentCreationModal

(

string

$style_name = ""

)

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

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

Referenced by moveUserStyles().

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

Here is the call graph for this function:

Here is the caller graph for this function:

importSystemStyleForm()

ilSystemStyleOverviewGUI::importSystemStyleForm ( )

protected

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

References ILIAS\Repository\ctrl(), ILIAS\Repository\lng(), and ilFormPropertyGUI\setRequired().

Referenced by addSystemStyleForms(), and confirmDelete().

                                              : ilPropertyFormGUI
    {
        $form = new ilPropertyFormGUI();
        $form->setFormAction($this->ctrl->getFormAction($this, 'importStyle'));
        $form->setTitle($this->lng->txt('sty_import_system_style'));

        // title
        $file_input = new ilFileInputGUI($this->lng->txt('import_file'), 'importfile');
        $file_input->setRequired(true);
        $file_input->setSuffixes(['zip']);
        $form->addItem($file_input);

        $form->addCommandButton('importStyle', $this->lng->txt('import'));
        $form->addCommandButton('cancel', $this->lng->txt('cancel'));

        return $form;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

isManagementEnabled()

ilSystemStyleOverviewGUI::isManagementEnabled

(

)

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

References $management_enabled.

Referenced by edit(), and executeCommand().

                                         : bool
    {
        return $this->management_enabled;
    }

Here is the caller graph for this function:

isReadOnly()

ilSystemStyleOverviewGUI::isReadOnly

(

)

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

References $read_only.

Referenced by executeCommand().

                                : bool
    {
        return $this->read_only;
    }

Here is the caller graph for this function:

moveUserStyles()

ilSystemStyleOverviewGUI::moveUserStyles

(

)

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

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

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

        $this->message_stack->addMessage(new ilSystemStyleMessage($this->lng->txt('msg_obj_modified')));
        $this->ctrl->redirect($this, 'edit');
    }

Here is the call graph for this function:

saveNewSubStyle()

ilSystemStyleOverviewGUI::saveNewSubStyle ( )

protected

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

References $container, Vendor\Package\$e, addSubStyleForms(), ILIAS\Repository\ctrl(), ILIAS\Repository\lng(), ILIAS\Repository\refinery(), ilSystemStyleException\SUBSTYLE_ASSIGNMENT_EXISTS, and ilSystemStyleMessage\TYPE_ERROR.

                                        : void
    {
        $form = $this->addSubStyleForms();

        if ($form->checkInput()) {
            try {
                $skin_style_ids = $this->request_wrapper->post()->retrieve(
                    'parent_style',
                    $this->refinery->string()->splitString(':')
                );

                $parent_skin_id = $skin_style_ids[0];
                $parent_style_id = $skin_style_ids[1];

                $container = $this->skin_factory->skinStyleContainerFromId($parent_skin_id, $this->message_stack);

                $sub_style_id = $this->request_wrapper->post()->retrieve(
                    'sub_style_id',
                    $this->refinery->kindlyTo()->string()
                );

                if (array_key_exists(
                    $sub_style_id,
                    $container->getSkin()->getSubstylesOfStyle($parent_style_id)
                )) {
                    throw new ilSystemStyleException(
                        ilSystemStyleException::SUBSTYLE_ASSIGNMENT_EXISTS,
                        $sub_style_id
                    );
                }

                $sub_style_name = $this->request_wrapper->post()->retrieve(
                    'sub_style_name',
                    $this->refinery->kindlyTo()->string()
                );

                $style = new ilSkinStyle($sub_style_id, $sub_style_name);
                $style->setSubstyleOf($parent_style_id);
                $container->addStyle($style);
                $this->ctrl->setParameterByClass('ilsystemstyleconfiggui', 'skin_id', $parent_skin_id);
                $this->ctrl->setParameterByClass('ilsystemstyleconfiggui', 'style_id', $sub_style_id);
                $this->message_stack->addMessage(new ilSystemStyleMessage($this->lng->txt('msg_sub_style_created')));
                $this->message_stack->sendMessages();
                $this->ctrl->redirectByClass('ilsystemstyleconfiggui');
            } catch (ilSystemStyleException $e) {
                $this->message_stack->addMessage(new ilSystemStyleMessage(
                    $e->getMessage(),
                    ilSystemStyleMessage::TYPE_ERROR
                ));
            }
        }

        // display only this form to correct input
        $form->setValuesByPost();
        $this->tpl->setContent($form->getHTML());
    }

Here is the call graph for this function:

saveNewSystemStyle()

ilSystemStyleOverviewGUI::saveNewSystemStyle ( )

protected

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

References $container, Vendor\Package\$e, createSystemStyleForm(), ILIAS\Repository\ctrl(), ILIAS\Repository\lng(), ILIAS\Repository\refinery(), ilStyleDefinition\skinExists(), and ilSystemStyleMessage\TYPE_ERROR.

                                           : void
    {
        $form = $this->createSystemStyleForm();

        if ($form->checkInput()) {
            $skin_id = $this->request_wrapper->post()->retrieve('skin_id', $this->refinery->kindlyTo()->string());
            $style_id = $this->request_wrapper->post()->retrieve('style_id', $this->refinery->kindlyTo()->string());

            $skin_name = $this->request_wrapper->post()->retrieve('skin_name', $this->refinery->kindlyTo()->string());
            $style_name = $this->request_wrapper->post()->retrieve('style_name', $this->refinery->kindlyTo()->string());

            if (ilStyleDefinition::skinExists($skin_id)) {
                $this->message_stack->addMessage(new ilSystemStyleMessage(
                    $this->lng->txt('skin_id_exists'),
                    ilSystemStyleMessage::TYPE_ERROR
                ));
            } else {
                try {
                    $skin = new ilSkin($skin_id, $skin_name);
                    $style = new ilSkinStyle($style_id, $style_name);
                    $skin->addStyle($style);
                    $container = new ilSkinStyleContainer($this->lng, $skin, $this->message_stack);
                    $container->create($this->message_stack);
                    $this->ctrl->setParameterByClass(ilSystemStyleConfigGUI::class, 'skin_id', $skin->getId());
                    $this->ctrl->setParameterByClass(ilSystemStyleConfigGUI::class, 'style_id', $style->getId());
                    $this->message_stack->addMessage(new ilSystemStyleMessage($this->lng->txt('msg_sys_style_created')));
                    $this->message_stack->sendMessages();
                    $this->ctrl->redirectByClass(ilSystemStyleConfigGUI::class);
                } catch (ilSystemStyleException $e) {
                    $this->message_stack->addMessage(new ilSystemStyleMessage(
                        $e->getMessage(),
                        ilSystemStyleMessage::TYPE_ERROR
                    ));
                }
            }
        }

        // display only this form to correct input
        $form->setValuesByPost();
        $this->tpl->setContent($form->getHTML());
    }

Here is the call graph for this function:

saveStyleSettings()

ilSystemStyleOverviewGUI::saveStyleSettings

(

)

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

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

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

Here is the call graph for this function:

setManagementEnabled()

ilSystemStyleOverviewGUI::setManagementEnabled

(

bool

$management_enabled

)

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

References $management_enabled.

Referenced by __construct().

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

Here is the caller graph for this function:

setReadOnly()

ilSystemStyleOverviewGUI::setReadOnly

(

bool

$read_only

)

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

References $read_only.

Referenced by __construct().

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

Here is the caller graph for this function:

view()

ilSystemStyleOverviewGUI::view ( )

protected

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

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

Field Documentation

$config

ilSystemStyleConfig ilSystemStyleOverviewGUI::$config

protected

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

$ctrl

ilCtrl ilSystemStyleOverviewGUI::$ctrl

protected

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

Referenced by __construct().

$file_system

ilFileSystemHelper ilSystemStyleOverviewGUI::$file_system

protected

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

$help

ilHelpGUI ilSystemStyleOverviewGUI::$help

protected

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

Referenced by __construct().

$lng

ilLanguage ilSystemStyleOverviewGUI::$lng

protected

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

Referenced by __construct().

$management_enabled

bool ilSystemStyleOverviewGUI::$management_enabled = false

protected

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

Referenced by isManagementEnabled(), and setManagementEnabled().

$message_stack

ilSystemStyleMessageStack ilSystemStyleOverviewGUI::$message_stack

protected

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

Referenced by confirmDelete().

$read_only

bool ilSystemStyleOverviewGUI::$read_only = true

protected

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

Referenced by isReadOnly(), and setReadOnly().

$ref_id

string ilSystemStyleOverviewGUI::$ref_id

protected

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

Referenced by __construct().

$refinery

Refinery ilSystemStyleOverviewGUI::$refinery

protected

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

Referenced by __construct().

$renderer

Renderer ilSystemStyleOverviewGUI::$renderer

protected

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

Referenced by __construct().

$request_wrapper

WrapperFactory ilSystemStyleOverviewGUI::$request_wrapper

protected

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

Referenced by __construct().

$skin_factory

ilSkinFactory ilSystemStyleOverviewGUI::$skin_factory

protected

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

Referenced by __construct().

$style_container

ilSkinStyleContainer ilSystemStyleOverviewGUI::$style_container

protected

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

$style_id

string ilSystemStyleOverviewGUI::$style_id

protected

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

Referenced by __construct(), checkDeletable(), and deleteStyle().

$tabs

ilTabsGUI ilSystemStyleOverviewGUI::$tabs

protected

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

Referenced by __construct().

$toolbar

ilToolbarGUI ilSystemStyleOverviewGUI::$toolbar

protected

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

Referenced by __construct().

$tpl

ilGlobalTemplateInterface ilSystemStyleOverviewGUI::$tpl

protected

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

Referenced by __construct().

$ui_factory

Factory ilSystemStyleOverviewGUI::$ui_factory

protected

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

Referenced by __construct().

$upload

FileUpload ilSystemStyleOverviewGUI::$upload

protected

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

Referenced by __construct().

---

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

• Services/Style/System/classes/Overview/class.ilSystemStyleOverviewGUI.php