Administration for page layouts. More...

Collaboration diagram for ilPageLayoutAdministrationGUI:

Public Member Functions
	__construct ()

	executeCommand ()

	checkPermission (string $a_perm, bool $a_throw_exc=true)
	Check permission. More...

	listLayouts ()

	activate (array $ids, bool $a_activate=true)

	deactivate (array $ids)

	deletePgl (array $ids)
	display deletion confirmation screen More...

	cancelDeletePg ()
	cancel deletion of Page Layout More...

	confirmedDeletePg ()
	conform deletion of Page Layout More...

	addPageLayout (?ilPropertyFormGUI $a_form=null)

	initAddPageLayoutForm ()

	createPg ()

	cancelCreate ()

	editPg (int $id)

	exportLayout (int $id)
	Export page layout template object. More...

	importPageLayoutForm ()
	Import page layout. More...

	initPageLayoutImportForm ()
	Init page layout import form. More...

	importPageLayout ()
	Import page layout. More...

Protected Member Functions
	getTable ()

Protected Attributes
ILIAS COPage Layout GUIService	$gui

AdministrationGUIRequest	$admin_request

int	$pg_id = null

ilContentStyleSettings	$settings

ilTabsGUI	$tabs

ilPageLayoutPage	$pg_content

ilCtrl	$ctrl

ilRbacSystem	$rbacsystem

ilToolbarGUI	$toolbar

ilLanguage	$lng

ilGlobalTemplateInterface	$tpl

ILIAS DI Container	$DIC

int	$ref_id

ilExportHandler	$export_handler

Detailed Description

Administration for page layouts.

Author: Alexander Killing killi.nosp@m.ng@l.nosp@m.eifos.nosp@m..de @ilCtrl_Calls ilPageLayoutAdministrationGUI: ilPageLayoutGUI

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

Constructor & Destructor Documentation

◆ __construct()

ilPageLayoutAdministrationGUI::__construct ( )

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

    {
        global $DIC;
 
        $this->ctrl = $DIC->ctrl();
        $this->rbacsystem = $DIC->rbac()->system();
        $this->toolbar = $DIC->toolbar();
        $this->lng = $DIC->language();
        $this->tpl = $DIC["tpl"];
        $this->tabs = $DIC->tabs();
        $this->lng->loadLanguageModule("style");
        $this->gui = $DIC->copage()->internal()->gui()->layout();
 
        $this->settings = new ilContentStyleSettings();
        $this->admin_request = $DIC
            ->copage()
            ->internal()
            ->gui()
            ->layout()
            ->adminRequest();
        $this->ref_id = $this->admin_request->getRefId();
        $this->export_handler = new ilExportHandler();
    }

References $DIC, ILIAS\Repository\ctrl(), ILIAS\Repository\lng(), ILIAS\Repository\settings(), ILIAS\Repository\tabs(), and ILIAS\Repository\toolbar().

Here is the call graph for this function:

Member Function Documentation

◆ activate()

ilPageLayoutAdministrationGUI::activate	(	array	$ids,
		bool	$a_activate = `true`
	)

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

     : void {
        if (count($ids) == 0) {
            $this->tpl->setOnScreenMessage('info', $this->lng->txt("no_checkbox"), true);
        } else {
            $this->tpl->setOnScreenMessage('success', $this->lng->txt("sty_opt_saved"), true);
            foreach ($ids as $item) {
                $pg_layout = new ilPageLayout($item);
                $pg_layout->activate($a_activate);
            }
        }
        $this->ctrl->redirect($this, "listLayouts");
    }

References ILIAS\Repository\lng().

Here is the call graph for this function:

◆ addPageLayout()

ilPageLayoutAdministrationGUI::addPageLayout ( ?ilPropertyFormGUI $a_form = null )

Definition at line 236 of file class.ilPageLayoutAdministrationGUI.php.

                                                                    : void
    {
        if (!$a_form) {
            $a_form = $this->initAddPageLayoutForm();
        }
        $this->tpl->setContent($a_form->getHTML());
    }

◆ cancelCreate()

ilPageLayoutAdministrationGUI::cancelCreate ( )

Definition at line 346 of file class.ilPageLayoutAdministrationGUI.php.

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

◆ cancelDeletePg()

ilPageLayoutAdministrationGUI::cancelDeletePg ( )

cancel deletion of Page Layout

Definition at line 216 of file class.ilPageLayoutAdministrationGUI.php.

                                    : void
    {
        $this->tpl->setOnScreenMessage('info', $this->lng->txt("msg_cancel"), true);
        $this->ctrl->redirect($this, "listLayouts");
    }

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

Here is the call graph for this function:

◆ checkPermission()

ilPageLayoutAdministrationGUI::checkPermission	(	string	$a_perm,
		bool	$a_throw_exc = `true`
	)

Check permission.

Exceptions

ilObjectException

Definition at line 122 of file class.ilPageLayoutAdministrationGUI.php.

     : bool {
        if (!$this->rbacsystem->checkAccess($a_perm, $this->ref_id)) {
            if ($a_throw_exc) {
                throw new ilObjectException($this->lng->txt("permission_denied"));
            }
            return false;
        }
        return true;
    }

References ILIAS\Repository\lng().

Referenced by executeCommand().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ confirmedDeletePg()

ilPageLayoutAdministrationGUI::confirmedDeletePg ( )

conform deletion of Page Layout

Definition at line 225 of file class.ilPageLayoutAdministrationGUI.php.

                                       : void
    {
        $ids = $this->getTable()->getItemIds();
        foreach ($ids as $id) {
            $pg_obj = new ilPageLayout($id);
            $pg_obj->delete();
        }
 
        $this->ctrl->redirect($this, "listLayouts");
    }

References $id, and ILIAS\Repository\ctrl().

Here is the call graph for this function:

◆ createPg()

ilPageLayoutAdministrationGUI::createPg ( )

Definition at line 312 of file class.ilPageLayoutAdministrationGUI.php.

                              : void
    {
        $form_gui = $this->initAddPageLayoutForm();
        if (!$form_gui->checkInput()) {
            $form_gui->setValuesByPost();
            $this->addPageLayout($form_gui);
            return;
        }
 
        //create Page-Layout-Object first
        $pg_object = new ilPageLayout();
        $pg_object->setTitle($form_gui->getInput('pgl_title'));
        $pg_object->setDescription($form_gui->getInput('pgl_desc'));
        $pg_object->setModules($form_gui->getInput('module'));
        $pg_object->update();
 
        //create Page
        //if (!is_object($pg_content)) {
        $this->pg_content = new ilPageLayoutPage();
        //}
 
        $this->pg_content->setId($pg_object->getId());
 
        $tmpl = $form_gui->getInput('pgl_template');
        if ($tmpl != "-1") {
            $layout_obj = new ilPageLayout($tmpl);
            $this->pg_content->setXMLContent($layout_obj->getXMLContent());
        }
        $this->pg_content->create(false);
 
        $this->ctrl->setParameterByClass("ilpagelayoutgui", "obj_id", $pg_object->getId());
        $this->ctrl->redirectByClass("ilpagelayoutgui", "edit");
    }

References ILIAS\Repository\ctrl().

Here is the call graph for this function:

◆ deactivate()

ilPageLayoutAdministrationGUI::deactivate ( array $ids )

Definition at line 181 of file class.ilPageLayoutAdministrationGUI.php.

                                          : void
    {
        $this->activate($ids, false);
    }

◆ deletePgl()

ilPageLayoutAdministrationGUI::deletePgl ( array $ids )

display deletion confirmation screen

Definition at line 189 of file class.ilPageLayoutAdministrationGUI.php.

                                         : void
    {
        if (count($ids) == 0) {
            $this->tpl->setOnScreenMessage('failure', $this->lng->txt("no_checkbox"), true);
            $this->ctrl->redirect($this, "listLayouts");
        }
 
        $table = $this->getTable();
 
        $items = [];
        foreach ($ids as $id) {
            $pg_obj = new ilPageLayout($id);
            $pg_obj->readObject();
            $items[$id] = $pg_obj->getTitle();
        }
 
        $table->renderDeletionConfirmation(
            $this->lng->txt("info_delete_sure"),
            $this->lng->txt("info_delete_sure"),
            "confirmedDeletePg",
            $items
        );
    }

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

Here is the call graph for this function:

◆ editPg()

ilPageLayoutAdministrationGUI::editPg ( int $id )

Definition at line 351 of file class.ilPageLayoutAdministrationGUI.php.

                                   : void
    {
        $this->checkPermission("sty_write_page_layout");
 
        $this->ctrl->setParameterByClass(ilPageLayoutGUI::class, "obj_id", $id);
        $this->ctrl->redirectByClass(ilPageLayoutGUI::class, "edit");
        $this->executeCommand();
    }

References $id, and ILIAS\Repository\ctrl().

Here is the call graph for this function:

◆ executeCommand()

ilPageLayoutAdministrationGUI::executeCommand ( )

Definition at line 70 of file class.ilPageLayoutAdministrationGUI.php.

                                    : void
    {
        $next_class = $this->ctrl->getNextClass($this);
        $cmd = $this->ctrl->getCmd("listLayouts");
 
        if ($cmd == "listLayouts") {
            $this->checkPermission("read");
        } else {
            $this->checkPermission("sty_write_page_layout");
        }
 
        switch ($next_class) {
            case 'ilpagelayoutgui':
                $this->tabs->clearTargets();
                $this->tabs->setBackTarget(
                    $this->lng->txt("page_layouts"),
                    $this->ctrl->getLinkTarget($this, "listLayouts")
                );
 
                $this->ctrl->setReturn($this, "listLayouts");
                if ($this->pg_id != null) {
                    $layout_gui = new ilPageLayoutGUI("stys", $this->pg_id);
                } else {
                    $layout_gui = new ilPageLayoutGUI(
                        "stys",
                        $this->admin_request->getObjId()
                    );
                }
                $layout_gui->setTabs();
                $layout_gui->setEditPreview(true);
                $this->ctrl->saveParameter($this, "obj_id");
                $ret = $this->ctrl->forwardCommand($layout_gui);
                if ($ret != "") {
                    $this->tpl->setContent($ret);
                }
                break;
 
            default:
                if (in_array($cmd, array("listLayouts", "editPg", "addPageLayout", "cancelCreate", "createPg", "exportLayout",
                    "activate", "deactivate", "importPageLayoutForm", "deletePgl", "cancelDeletePg",
                    "confirmedDeletePg", "importPageLayout"))) {
                    $this->$cmd();
                } else {
                    die("Unknown command " . $cmd);
                }
        }
    }

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

Here is the call graph for this function:

◆ exportLayout()

ilPageLayoutAdministrationGUI::exportLayout ( int $id )

Export page layout template object.

Definition at line 364 of file class.ilPageLayoutAdministrationGUI.php.

                                         : void
    {
        $exp = new ilExport();
 
        $tmpdir = ilFileUtils::ilTempnam();
        ilFileUtils::makeDir($tmpdir);
        $exp->setExportConfigs($this->export_handler->consumer()->exportConfig()->allExportConfigs());
        $succ = $exp->exportEntity(
            "pgtp",
            $id,
            "4.2.0",
            "components/ILIAS/COPage",
            "Title",
            $tmpdir
        );
 
        if (is_file($succ["directory"] . "/" . $succ["file"])) {
            ilFileDelivery::deliverFileLegacy(
                $succ["directory"] . "/" . $succ["file"],
                $succ["file"],
                "",
                false,
                false,
                false
            );
        }
        if (is_file($succ["directory"] . "/" . $succ["file"])) {
            unlink($succ["directory"] . "/" . $succ["file"]);
        }
        if (is_dir($succ["directory"])) {
            //unlink($succ["directory"]);
        }
    }

References $id, ilFileDelivery\deliverFileLegacy(), ilFileUtils\ilTempnam(), and ilFileUtils\makeDir().

Here is the call graph for this function:

◆ getTable()

ilPageLayoutAdministrationGUI::getTable ( )

protected

Definition at line 135 of file class.ilPageLayoutAdministrationGUI.php.

                                 : \ILIAS\Repository\Table\TableAdapterGUI
    {
        return $this->gui->pageLayoutTableBuilder(
            $this,
            "listLayouts"
        )->getTable();
    }

◆ importPageLayout()

ilPageLayoutAdministrationGUI::importPageLayout ( )

Import page layout.

Definition at line 432 of file class.ilPageLayoutAdministrationGUI.php.

                                      : void
    {
        $form = $this->initPageLayoutImportForm();
        if ($form->checkInput()) {
            ilPageLayout::import($_FILES["file"]["name"], $_FILES["file"]["tmp_name"]);
            $this->tpl->setOnScreenMessage('success', $this->lng->txt("sty_imported_layout"), true);
            $this->ctrl->redirect($this, "listLayouts");
        } else {
            $form->setValuesByPost();
            $this->tpl->setContent($form->getHTML());
        }
    }

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

Here is the call graph for this function:

◆ importPageLayoutForm()

ilPageLayoutAdministrationGUI::importPageLayoutForm ( )

Import page layout.

Definition at line 401 of file class.ilPageLayoutAdministrationGUI.php.

                                          : void
    {
        $form = $this->initPageLayoutImportForm();
        $this->tpl->setContent($form->getHTML());
    }

◆ initAddPageLayoutForm()

ilPageLayoutAdministrationGUI::initAddPageLayoutForm ( )

Definition at line 244 of file class.ilPageLayoutAdministrationGUI.php.

                                           : ilPropertyFormGUI
    {
        $this->lng->loadLanguageModule("content");
        $this->lng->loadLanguageModule("copg");
 
        $form_gui = new ilPropertyFormGUI();
        $form_gui->setFormAction($this->ctrl->getFormAction($this));
        $form_gui->setTitle($this->lng->txt("sty_create_pgl"));
 
        $title_input = new ilTextInputGUI($this->lng->txt("title"), "pgl_title");
        $title_input->setSize(50);
        $title_input->setMaxLength(128);
        //$title_input->setValue($this->layout_object->title);
        $title_input->setTitle($this->lng->txt("title"));
        $title_input->setRequired(true);
 
        $desc_input = new ilTextAreaInputGUI($this->lng->txt("description"), "pgl_desc");
        //$desc_input->setValue($this->layout_object->description);
        $desc_input->setRows(3);
        $desc_input->setCols(37);
 
 
        // modules
        $mods = new ilCheckboxGroupInputGUI($this->lng->txt("copg_obj_types"), "module");
        // $mods->setRequired(true);
        foreach (ilPageLayout::getAvailableModules() as $mod_id => $mod_caption) {
            $mod = new ilCheckboxOption($mod_caption, $mod_id);
            $mods->addOption($mod);
        }
 
        $ttype_input = new ilSelectInputGUI($this->lng->txt("sty_based_on"), "pgl_template");
 
        $arr_templates = ilPageLayout::getLayouts();
        $arr_templates1 = ilPageLayout::getLayouts(false, true);
        foreach ($arr_templates1 as $v) {
            $arr_templates[] = $v;
        }
 
        $options = array();
        $options['-1'] = $this->lng->txt("none");
 
        foreach ($arr_templates as $templ) {
            $templ->readObject();
            $key = $templ->getId();
            $value = $templ->getTitle();
            $options[$key] = $value;
        }
 
        $ttype_input->setOptions($options);
        $ttype_input->setValue(-1);
        $ttype_input->setRequired(true);
 
        $desc_input->setTitle($this->lng->txt("description"));
        $desc_input->setRequired(false);
 
        $form_gui->addItem($title_input);
        $form_gui->addItem($desc_input);
        $form_gui->addItem($mods);
        $form_gui->addItem($ttype_input);
 
 
        $form_gui->addCommandButton("createPg", $this->lng->txt("save"));
        $form_gui->addCommandButton("cancelCreate", $this->lng->txt("cancel"));
 
        return $form_gui;
    }

References ILIAS\UI\Implementation\Component\Input\Field\$options, ILIAS\Repository\ctrl(), ilPageLayout\getAvailableModules(), ilPageLayout\getLayouts(), and ILIAS\Repository\lng().

Here is the call graph for this function:

◆ initPageLayoutImportForm()

ilPageLayoutAdministrationGUI::initPageLayoutImportForm ( )

Init page layout import form.

Definition at line 410 of file class.ilPageLayoutAdministrationGUI.php.

                                              : ilPropertyFormGUI
    {
        $form = new ilPropertyFormGUI();
 
        // template file
        $fi = new ilFileInputGUI($this->lng->txt("file"), "file");
        $fi->setSuffixes(array("zip"));
        $fi->setRequired(true);
        $form->addItem($fi);
 
        $form->addCommandButton("importPageLayout", $this->lng->txt("import"));
        $form->addCommandButton("listLayouts", $this->lng->txt("cancel"));
 
        $form->setTitle($this->lng->txt("sty_import_page_layout"));
        $form->setFormAction($this->ctrl->getFormAction($this));
 
        return $form;
    }

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

Here is the call graph for this function:

◆ listLayouts()

ilPageLayoutAdministrationGUI::listLayouts ( )

Definition at line 143 of file class.ilPageLayoutAdministrationGUI.php.

                                 : void
    {
        // show toolbar, if write permission is given
        if ($this->checkPermission("sty_write_page_layout", false)) {
            $this->toolbar->addButton(
                $this->lng->txt("sty_add_pgl"),
                $this->ctrl->getLinkTarget($this, "addPageLayout")
            );
            $this->toolbar->addButton(
                $this->lng->txt("sty_import_page_layout"),
                $this->ctrl->getLinkTarget($this, "importPageLayoutForm")
            );
        }
 
        $table = $this->getTable();
        if ($table->handleCommand()) {
            return;
        }
 
        $this->tpl->setContent($table->render());
    }