ilPageLayoutAdministrationGUI Class Reference

Administration for page layouts. More...

Collaboration diagram for ilPageLayoutAdministrationGUI:

Public Member Functions
	__construct ()
	Constructor. More...
	executeCommand ()
	Execute command. More...
	checkPermission ($a_perm, $a_throw_exc=true)
	Check permission. More...
	listLayouts ()
	view list of page layouts More...
	activate ($a_activate=true)
	Activate layout. More...
	deactivate ()
	Deactivate layout. More...
	deletePgl ()
	display deletion confirmation screen More...
	cancelDeletePg ()
	cancel deletion of Page Layout More...
	confirmedDeletePg ()
	conform deletion of Page Layout More...
	addPageLayout ($a_form=null)
	initAddPageLayoutForm ()
	createPg ()
	cancelCreate ()
	Cancel creation. More...
	editPg ()
	Edit page. More...
	savePageLayoutTypes ()
	Save page layout types. More...
	exportLayout ()
	Export page layout template object. More...
	importPageLayoutForm ()
	Import page layout. More...
	initPageLayoutImportForm ()
	Init page layout import form. More...
	importPageLayout ()
	Import page layout. More...

Protected Attributes
	$ctrl
	$rbacsystem
	$toolbar
	$lng
	$tpl
	$DIC
	$ref_id

Detailed Description

Administration for page layouts.

Author

Alex Killing alex..nosp@m.kill.nosp@m.ing@g.nosp@m.mx.d.nosp@m.e

Version

$Id$ ilPageLayoutAdministrationGUI: ilPageLayoutGUI

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

Constructor & Destructor Documentation

__construct()

ilPageLayoutAdministrationGUI::__construct

(

)

Constructor.

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

References $_GET, $DIC, and settings().

    {
        global $DIC;

        $this->dic = $DIC;
        $this->ctrl = $DIC->ctrl();
        $this->rbacsystem = $DIC->rbac()->system();
        $this->toolbar = $DIC->toolbar();
        $this->lng = $DIC->language();
        $this->tpl = $DIC["tpl"];
        $this->ref_id = (int) $_GET["ref_id"];
        $this->tabs = $DIC["ilTabs"];


        include_once("./Services/Style/Content/classes/class.ilContentStyleSettings.php");
        $this->settings = new ilContentStyleSettings();
    }

Here is the call graph for this function:

Member Function Documentation

activate()

ilPageLayoutAdministrationGUI::activate

(

$a_activate = true

)

Activate layout.

Parameters

bool

$a_activate

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

References $_POST, and ilUtil\sendInfo().

Referenced by deactivate().

    {
        if (!isset($_POST["pglayout"])) {
            ilUtil::sendInfo($this->lng->txt("no_checkbox"), true);
        } else {
            ilUtil::sendSuccess($this->lng->txt("sty_opt_saved"), true);
            foreach ($_POST["pglayout"] as $item) {
                $pg_layout = new ilPageLayout($item);
                $pg_layout->activate($a_activate);
            }
        }
        $this->ctrl->redirect($this, "listLayouts");
    }

Here is the call graph for this function:

Here is the caller graph for this function:

addPageLayout()

ilPageLayoutAdministrationGUI::addPageLayout

(

$a_form = null

)

Parameters

null | ilPropertyFormGUI

$a_form

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

References initAddPageLayoutForm().

Referenced by createPg().

    {
        if (!$a_form) {
            $a_form = $this->initAddPageLayoutForm();
        }

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

Here is the call graph for this function:

Here is the caller graph for this function:

cancelCreate()

ilPageLayoutAdministrationGUI::cancelCreate

(

)

Cancel creation.

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

References listLayouts().

    {
        $this->listLayouts();
    }

Here is the call graph for this function:

cancelDeletePg()

ilPageLayoutAdministrationGUI::cancelDeletePg

(

)

cancel deletion of Page Layout

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

References ilUtil\sendInfo().

    {
        ilUtil::sendInfo($this->lng->txt("msg_cancel"), true);
        $this->ctrl->redirect($this, "listLayouts");
    }

Here is the call graph for this function:

checkPermission()

ilPageLayoutAdministrationGUI::checkPermission	(		$a_perm,
			$a_throw_exc = true
	)

Check permission.

Parameters

string

$a_perm

permission(s)

Returns

bool

Exceptions

ilObjectException

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

Referenced by editPg(), executeCommand(), and listLayouts().

    {
        if (!$this->rbacsystem->checkAccess($a_perm, $this->ref_id)) {
            if ($a_throw_exc) {
                include_once "Services/Object/exceptions/class.ilObjectException.php";
                throw new ilObjectException($this->lng->txt("permission_denied"));
            }
            return false;
        }
        return true;
    }

Here is the caller graph for this function:

confirmedDeletePg()

ilPageLayoutAdministrationGUI::confirmedDeletePg

(

)

conform deletion of Page Layout

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

References $_POST, and $id.

    {
        foreach ($_POST["pglayout"] as $id) {
            $pg_obj = new ilPageLayout($id);
            $pg_obj->delete();
        }

        $this->ctrl->redirect($this, "listLayouts");
    }

createPg()

ilPageLayoutAdministrationGUI::createPg

(

)

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

References addPageLayout(), and initAddPageLayoutForm().

    {
        $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->setSpecialPage($form_gui->getInput('special_page'));
        $pg_object->setModules($form_gui->getInput('module'));
        $pg_object->update();

        include_once("./Services/COPage/Layout/classes/class.ilPageLayoutPage.php");

        //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);
        } else {
            $this->pg_content->create(false);
        }

        $this->ctrl->setParameterByClass("ilpagelayoutgui", "obj_id", $pg_object->getId());
        $this->ctrl->redirectByClass("ilpagelayoutgui", "edit");
    }

Here is the call graph for this function:

deactivate()

ilPageLayoutAdministrationGUI::deactivate

(

)

Deactivate layout.

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

References activate().

    {
        $this->activate(false);
    }

Here is the call graph for this function:

deletePgl()

ilPageLayoutAdministrationGUI::deletePgl

(

)

display deletion confirmation screen

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

References $_POST, $id, data, ilUtil\getImageTagByType(), and ilUtil\sendFailure().

    {
        if (!isset($_POST["pglayout"])) {
            ilUtil::sendFailure($this->lng->txt("no_checkbox"), true);
            $this->ctrl->redirect($this, "listLayouts");
        }

        unset($this->data);

        // display confirmation message
        include_once("./Services/Utilities/classes/class.ilConfirmationGUI.php");
        $cgui = new ilConfirmationGUI();
        $cgui->setFormAction($this->ctrl->getFormAction($this));
        $cgui->setHeaderText($this->lng->txt("info_delete_sure"));
        $cgui->setCancel($this->lng->txt("cancel"), "cancelDeletePg");
        $cgui->setConfirm($this->lng->txt("confirm"), "confirmedDeletePg");

        foreach ($_POST["pglayout"] as $id) {
            $pg_obj = new ilPageLayout($id);
            $pg_obj->readObject();

            $caption = ilUtil::getImageTagByType("stys", $this->tpl->tplPath) .
                " " . $pg_obj->getTitle();

            $cgui->addItem("pglayout[]", $id, $caption);
        }

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

Here is the call graph for this function:

editPg()

ilPageLayoutAdministrationGUI::editPg

(

)

Edit page.

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

References checkPermission(), and executeCommand().

    {
        $this->checkPermission("sty_write_page_layout");

        $this->ctrl->setCmdClass("ilpagelayoutgui");
        $this->ctrl->setCmd("edit");
        $this->executeCommand();
    }

Here is the call graph for this function:

executeCommand()

ilPageLayoutAdministrationGUI::executeCommand

(

)

Execute command.

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

References $_GET, $ret, and checkPermission().

Referenced by editPg().

    {
        $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();
                include_once("./Services/COPage/Layout/classes/class.ilPageLayoutGUI.php");
//                              $this->tpl->getStandardTemplate();

                $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", $_GET["obj_id"]);
                }
                $layout_gui->setTabs();
                $layout_gui->setEditPreview(true);
                $this->ctrl->saveParameter($this, "obj_id");
                $ret = $this->ctrl->forwardCommand($layout_gui);
                $this->tpl->setContent($ret);
                break;

            default:
                if (in_array($cmd, array("listLayouts", "editPg", "addPageLayout", "cancelCreate", "createPg", "exportLayout",
                    "savePageLayoutTypes", "activate", "deactivate", "importPageLayoutForm", "deletePgl", "cancelDeletePg",
                    "confirmedDeletePg", "importPageLayout"))) {
                    $this->$cmd();
                } else {
                    die("Unknown command " . $cmd);
                }
        }
    }

Here is the call graph for this function:

Here is the caller graph for this function:

exportLayout()

ilPageLayoutAdministrationGUI::exportLayout

(

)

Export page layout template object.

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

References $_GET, ilUtil\deliverFile(), ilUtil\ilTempnam(), and ilUtil\makeDir().

    {
        include_once("./Services/Export/classes/class.ilExport.php");
        $exp = new ilExport();

        $tmpdir = ilUtil::ilTempnam();
        ilUtil::makeDir($tmpdir);

        $succ = $exp->exportEntity(
            "pgtp",
            (int) $_GET["layout_id"],
            "4.2.0",
            "Services/COPage",
            "Title",
            $tmpdir
        );

        if ($succ["success"]) {
            ilUtil::deliverFile(
                $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"]);
        }
    }

Here is the call graph for this function:

importPageLayout()

ilPageLayoutAdministrationGUI::importPageLayout

(

)

Import page layout.

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

References $form, ilPageLayout\import(), and initPageLayoutImportForm().

    {
        $form = $this->initPageLayoutImportForm();
        if ($form->checkInput()) {
            include_once("./Services/COPage/Layout/classes/class.ilPageLayout.php");
            $pg = ilPageLayout::import($_FILES["file"]["name"], $_FILES["file"]["tmp_name"]);
            if ($pg > 0) {
                ilUtil::sendSuccess($this->lng->txt("sty_imported_layout"), true);
            }
            $this->ctrl->redirect($this, "listLayouts");
        } else {
            $form->setValuesByPost();
            $this->tpl->setContent($form->getHtml());
        }
    }

Here is the call graph for this function:

importPageLayoutForm()

ilPageLayoutAdministrationGUI::importPageLayoutForm

(

)

Import page layout.

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

References $form, and initPageLayoutImportForm().

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

Here is the call graph for this function:

initAddPageLayoutForm()

ilPageLayoutAdministrationGUI::initAddPageLayoutForm

(

)

Returns

ilPropertyFormGUI

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

References $key, PHPMailer\PHPMailer\$options, $si, ilPageLayout\getAvailableModules(), ilPageLayout\getLayouts(), ilSelectInputGUI\setOptions(), ilTextInputGUI\setSize(), and ilTextAreaInputGUI\setValue().

Referenced by addPageLayout(), and createPg().

    {
        $this->lng->loadLanguageModule("content");

        include_once("Services/Form/classes/class.ilPropertyFormGUI.php");
        $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);

        // special page?
        $options = array(
            "0" => $this->lng->txt("cont_layout_template"),
            "1" => $this->lng->txt("cont_special_page"),
        );
        $si = new ilSelectInputGUI($this->lng->txt("type"), "special_page");
        $si->setOptions($options);

        // modules
        $mods = new ilCheckboxGroupInputGUI($this->lng->txt("modules"), "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($si);
        $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;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

initPageLayoutImportForm()

ilPageLayoutAdministrationGUI::initPageLayoutImportForm

(

)

Init page layout import form.

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

References $form, and ilFileInputGUI\setSuffixes().

Referenced by importPageLayout(), and importPageLayoutForm().

    {
        include_once("Services/Form/classes/class.ilPropertyFormGUI.php");
        $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;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

listLayouts()

ilPageLayoutAdministrationGUI::listLayouts

(

)

view list of page layouts

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

References checkPermission().

Referenced by cancelCreate().

    {
        // 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")
            );
        }

        $oa_tpl = new ilTemplate("tpl.stys_pglayout.html", true, true, "Services/COPage/Layout");

        include_once("./Services/COPage/Layout/classes/class.ilPageLayoutTableGUI.php");
        $pglayout_table = new ilPageLayoutTableGUI($this, "listLayouts");
        $oa_tpl->setVariable("PGLAYOUT_TABLE", $pglayout_table->getHTML());
        $this->tpl->setContent($oa_tpl->get());
    }

Here is the call graph for this function:

Here is the caller graph for this function:

savePageLayoutTypes()

ilPageLayoutAdministrationGUI::savePageLayoutTypes

(

)

Save page layout types.

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

References $_POST, $ctrl, $id, $ilCtrl, $l, $lng, and $t.

    {
        $lng = $this->lng;
        $ilCtrl = $this->ctrl;

        include_once("./Services/COPage/Layout/classes/class.ilPageLayout.php");

        if (is_array($_POST["type"])) {
            foreach ($_POST["type"] as $id => $t) {
                if ($id > 0) {
                    $l = new ilPageLayout($id);
                    $l->readObject();
                    $l->setSpecialPage($t);
                    if (is_array($_POST["module"][$id])) {
                        $l->setModules(array_keys($_POST["module"][$id]));
                    } else {
                        $l->setModules();
                    }
                    $l->update();
                }
            }

            ilUtil::sendSuccess($this->lng->txt("msg_obj_modified"));
        }

        $this->ctrl->redirect($this, "listLayouts");
    }

Field Documentation

$ctrl

ilPageLayoutAdministrationGUI::$ctrl

protected

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

Referenced by savePageLayoutTypes().

$DIC

ilPageLayoutAdministrationGUI::$DIC

protected

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

Referenced by __construct().

$lng

ilPageLayoutAdministrationGUI::$lng

protected

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

Referenced by savePageLayoutTypes().

$rbacsystem

ilPageLayoutAdministrationGUI::$rbacsystem

protected

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

$ref_id

ilPageLayoutAdministrationGUI::$ref_id

protected

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

$toolbar

ilPageLayoutAdministrationGUI::$toolbar

protected

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

$tpl

ilPageLayoutAdministrationGUI::$tpl

protected

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

---

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

• Services/COPage/Layout/classes/class.ilPageLayoutAdministrationGUI.php