Wiki page template gui class. More...

Collaboration diagram for ilWikiPageTemplateGUI:

Public Member Functions
	executeCommand ()

	listTemplates ()

	add ()

	confirmRemove (array $ids=[])

	remove (array $ids=[])

	toggleNewPages (int $id)

	toggleAddToPage (int $id)

	saveTemplateSettings ()

	removePageTemplateFromPageAction ()

	addPageTemplateFromPageAction ()

Protected Member Functions
	getPageTemplateTable ()

	toggleTemplateSetting (int $id, bool $new_pages)

Protected Attributes
WikiGUIRequest	$request

ilObjWiki	$wiki

ilToolbarGUI	$toolbar

ilLanguage	$lng

ilObjWikiGUI	$wiki_gui

ilCtrl	$ctrl

ilGlobalTemplateInterface	$tpl

Detailed Description

Wiki page template gui class.

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

Definition at line 26 of file class.ilWikiPageTemplateGUI.php.

Member Function Documentation

◆ add()

ilWikiPageTemplateGUI::add ( )

Definition at line 114 of file class.ilWikiPageTemplateGUI.php.

                         : void
    {
        $wpt = new ilWikiPageTemplate($this->wiki->getId());
        $wpt->save($this->request->getPageTemplateId());
        $this->tpl->setOnScreenMessage('success', $this->lng->txt("wiki_template_added"), true);
        $this->ctrl->redirect($this, "listTemplates");
    }

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

Here is the call graph for this function:

◆ addPageTemplateFromPageAction()

ilWikiPageTemplateGUI::addPageTemplateFromPageAction ( )

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

                                                   : void
    {
        $page_id = $this->request->getWikiPageId();
        if ($page_id) {
            $wpt = new ilWikiPageTemplate($this->wiki->getId());
            $wpt->save($page_id);
            $this->tpl->setOnScreenMessage('success', $this->lng->txt("wiki_template_added"), true);
        }
 
        $this->ctrl->redirect($this, "listTemplates");
    }

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

Here is the call graph for this function:

◆ confirmRemove()

ilWikiPageTemplateGUI::confirmRemove ( array $ids = [] )

Definition at line 133 of file class.ilWikiPageTemplateGUI.php.

                                                  : void
    {
        if (count($ids) === 0) {
            $this->tpl->setOnScreenMessage('info', $this->lng->txt("no_checkbox"), true);
            $this->ctrl->redirect($this, "listTemplates");
        }
 
        $items = [];
        $templates = new ilWikiPageTemplate($this->wiki->getId());
        foreach ($templates->getAllInfo() as $template) {
            if (in_array((int) $template['wpage_id'], $ids, true)) {
                $items[(int) $template['wpage_id']] = $template['title'];
            }
        }
 
        $this->getPageTemplateTable()->renderDeletionConfirmation(
            $this->lng->txt("wiki_remove_template_status"),
            $this->lng->txt("wiki_remove_template_status"),
            "remove",
            $items
        );
    }

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

Here is the call graph for this function:

◆ executeCommand()

ilWikiPageTemplateGUI::executeCommand ( )

Definition at line 62 of file class.ilWikiPageTemplateGUI.php.

                                    : void
    {
        $nc = $this->ctrl->getNextClass();
 
        switch ($nc) {
            default:
                $cmd = $this->ctrl->getCmd("listTemplates");
                if (in_array($cmd, array("listTemplates", "add", "remove", "confirmRemove", "toggleNewPages", "toggleAddToPage", "saveTemplateSettings", "addPageTemplateFromPageAction", "removePageTemplateFromPageAction"))) {
                    $this->$cmd();
                }
                break;
        }
    }

References ILIAS\Repository\ctrl().

Here is the call graph for this function:

◆ getPageTemplateTable()

ilWikiPageTemplateGUI::getPageTemplateTable ( )

protected

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

                                             : \ILIAS\Repository\Table\TableAdapterGUI
    {
        global $DIC;
 
        return $DIC->wiki()->internal()->gui()->page()->pageTemplateTableBuilder(
            $this->wiki->getId(),
            $this,
            "listTemplates"
        )->getTable();
    }

References $DIC.

Referenced by confirmRemove(), listTemplates(), and remove().

Here is the caller graph for this function:

◆ listTemplates()

ilWikiPageTemplateGUI::listTemplates ( )

Definition at line 76 of file class.ilWikiPageTemplateGUI.php.

                                   : void
    {
        // list pages
        $pages = ilWikiPage::getAllWikiPages($this->wiki->getId(), "-");
        $options = array("" => $this->lng->txt("please_select"));
        foreach ($pages as $p) {
            //if (!in_array($p["id"], $ipages_ids))
            //{
            $options[$p["id"]] = ilStr::shortenTextExtended($p["title"], 60, true);
            //}
        }
 
        $this->toolbar->setFormAction($this->ctrl->getFormAction($this));
        $this->toolbar->setOpenFormTag(true);
        $this->toolbar->setCloseFormTag(false);
 
        if (count($options) > 0) {
            $si = new ilSelectInputGUI($this->lng->txt("wiki_pages"), "templ_page_id");
            $si->setOptions($options);
            $this->toolbar->addInputItem($si);
            $this->toolbar->addFormButton($this->lng->txt("wiki_add_template"), "add");
            $this->toolbar->addSeparator();
        }
 
        // empty page as template?
        $cb = new ilCheckboxInputGUI($this->lng->txt("wiki_empty_page_template"), "empty_page_templ");
        $cb->setChecked($this->wiki->getEmptyPageTemplate());
        $this->toolbar->addInputItem($cb, true);
        $this->toolbar->addFormButton($this->lng->txt("save"), "saveTemplateSettings");
 
        $table = $this->getPageTemplateTable();
        if ($table->handleCommand()) {
            return;
        }
 
        $this->tpl->setContent($table->render() . "</form>");
    }

References ILIAS\UI\Implementation\Component\Input\Field\$options, ILIAS\Repository\ctrl(), ilWikiPage\getAllWikiPages(), getPageTemplateTable(), ILIAS\Repository\lng(), ilStr\shortenTextExtended(), and ILIAS\Repository\toolbar().

Here is the call graph for this function:

◆ remove()

ilWikiPageTemplateGUI::remove ( array $ids = [] )

Definition at line 156 of file class.ilWikiPageTemplateGUI.php.

                                           : void
    {
        $wpt = new ilWikiPageTemplate($this->wiki->getId());
 
        if (count($ids) === 0) {
            $ids = $this->getPageTemplateTable()->getItemIds();
        }
        if (count($ids) > 0) {
            foreach ($ids as $id) {
                $wpt->remove((int) $id);
            }
            $this->tpl->setOnScreenMessage('success', $this->lng->txt("wiki_template_status_removed"), true);
        }
 
        $this->ctrl->redirect($this, "listTemplates");
    }

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

Here is the call graph for this function:

◆ removePageTemplateFromPageAction()

ilWikiPageTemplateGUI::removePageTemplateFromPageAction ( )

Definition at line 224 of file class.ilWikiPageTemplateGUI.php.

                                                      : void
    {
        $page_id = $this->request->getWikiPageId();
        if ($page_id) {
            $wpt = new ilWikiPageTemplate($this->wiki->getId());
            $wpt->remove($page_id);
            $this->tpl->setOnScreenMessage('success', $this->lng->txt("wiki_template_status_removed"), true);
        }
 
        $this->ctrl->redirect($this, "listTemplates");
    }

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

Here is the call graph for this function:

◆ saveTemplateSettings()

ilWikiPageTemplateGUI::saveTemplateSettings ( )

Definition at line 202 of file class.ilWikiPageTemplateGUI.php.

                                          : void
    {
        $all_ids = $this->request->getAllIds();
        $new_pages = $this->request->getNewPages();
        $add_to_page = $this->request->getAddToPage();
        foreach ($all_ids as $id) {
            $wpt = new ilWikiPageTemplate($this->wiki->getId());
            $wpt->save($id, $new_pages[$id] ?? 0, $add_to_page[$id] ?? 0);
        }
 
        $this->wiki->setEmptyPageTemplate($this->request->getEmptyPageTemplate());
        $this->wiki->update();
 
        $this->tpl->setOnScreenMessage('success', $this->lng->txt("msg_obj_modified"), true);
        $this->ctrl->redirect($this, "listTemplates");
    }

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

Here is the call graph for this function:

◆ toggleAddToPage()

ilWikiPageTemplateGUI::toggleAddToPage ( int $id )

Definition at line 178 of file class.ilWikiPageTemplateGUI.php.

                                            : void
    {
        $this->toggleTemplateSetting($id, false);
    }

References toggleTemplateSetting().

Here is the call graph for this function:

◆ toggleNewPages()

ilWikiPageTemplateGUI::toggleNewPages ( int $id )

Definition at line 173 of file class.ilWikiPageTemplateGUI.php.

                                           : void
    {
        $this->toggleTemplateSetting($id, true);
    }

References toggleTemplateSetting().

Here is the call graph for this function:

◆ toggleTemplateSetting()

ilWikiPageTemplateGUI::toggleTemplateSetting	(	int	$id,
		bool	$new_pages
	)

protected

Definition at line 183 of file class.ilWikiPageTemplateGUI.php.

                                                                      : void
    {
        $templates = new ilWikiPageTemplate($this->wiki->getId());
        foreach ($templates->getAllInfo() as $template) {
            if ((int) $template['wpage_id'] !== $id) {
                continue;
            }
 
            $templates->save(
                $id,
                (int) ($new_pages ? !(bool) $template['new_pages'] : (int) $template['new_pages']),
                (int) ($new_pages ? (int) $template['add_to_page'] : !(bool) $template['add_to_page'])
            );
            break;
        }
 
        $this->ctrl->redirect($this, "listTemplates");
    }