ilWikiPageGUI Class Reference

Class ilWikiPage GUI class. More...

Inheritance diagram for ilWikiPageGUI:

Collaboration diagram for ilWikiPageGUI:

Public Member Functions
	setScreenIdComponent ()
	setWikiRefId (int $a_ref_id)
	getWikiRefId ()
	setWiki (ilObjWiki $a_val)
	getWiki ()
	executeCommand ()
	setWikiPage (ilWikiPage $a_wikipage)
	setSideBlock ()
	addHeaderAction (bool $a_redraw=false)
	redrawHeaderAction ()
	preview ()
	showPage ()
	display content of page More...
	postOutputProcessing (string $a_output)
	Finalizing output processing. More...
	whatLinksHere ()
	getTabs (string $a_activate="")
	deleteWikiPageConfirmationScreen ()
	cancelWikiPageDeletion ()
	confirmWikiPageDeletion ()
	printViewSelection ()
	printViewOrder ()
	blockWikiPage ()
	unblockWikiPage ()
	renameWikiPage ()
	renamePage ()
	activateWikiPageRating ()
	Rating /. More...
	deactivateWikiPageRating ()
	observeNoteAction (int $a_wiki_id, int $a_page_id, string $a_type, string $a_action, int $a_note_id)
	updateStatsRating (int $a_wiki_id, string $a_wiki_type, int $a_page_id, string $a_page_type)
	editAdvancedMetaData (?ilPropertyFormGUI $a_form=null)
	updateAdvancedMetaData ()
	hideAdvancedMetaData ()
	unhideAdvancedMetaData ()
	edit ()
	insertWikiLink ()
	Returns form to insert a wiki link per ajax. More...
	insertWikiLinkAC ()
	Auto complete for insert wiki link. More...
	searchWikiLinkAC ()
	Search wiki link list. More...
	getCommentsHTMLExport ()
	confirmPageTranslationCreation ()
	Confirm page translation creation. More...
Public Member Functions inherited from ilPageObjectGUI
	__construct (string $a_parent_type, int $a_id, int $a_old_nr=0, bool $a_prevent_get_id=false, string $a_lang="", string $concrete_lang="")
	setTemplate (ilGlobalTemplateInterface $main_tpl)
	afterConstructor ()
	setAdvMdRecordObject (int $a_adv_ref_id, string $a_adv_type, string $a_adv_subtype="-")
	Set object, that defines the adv md records being used. More...
	getAdvMdRecordObject ()
	Get adv md record type. More...
	setParentType (string $a_val)
	getParentType ()
	setId (int $a_val)
	getId ()
	setOldNr (int $a_val)
	Set old nr (historic page) More...
	getOldNr ()
	setLanguage (string $a_val)
	getLanguage ()
	setEnablePCType (string $a_pc_type, bool $a_val)
	getEnablePCType (string $a_pc_type)
	setPageConfig (ilPageConfig $a_val)
	getPageConfig ()
	setPageObject (ilPageObject $a_pg_obj)
	getPageObject ()
	setOutputMode (string $a_mode=self::PRESENTATION)
	getOutputMode ()
	setTemplateOutput (bool $a_output=true)
	outputToTemplate ()
	setPresentationTitle (string $a_title="")
	getPresentationTitle ()
	setHeader (string $a_title="")
	getHeader ()
	setLinkParams (string $l_params="")
	getLinkParams ()
	setLinkFrame (string $l_frame="")
	getLinkFrame ()
	setPageLinker (\ILIAS\COPage\PageLinker $page_linker)
	getLinkXML ()
	setQuestionHTML (array $question_html)
	getQuestionHTML ()
	setTemplateTargetVar (string $a_variable)
	getTemplateTargetVar ()
	getTemplateOutputVar ()
	setSourcecodeDownloadScript (string $script_name)
	getSourcecodeDownloadScript ()
	setTabs (ilTabsGUI $a_tabs)
	setPageBackTitle (string $a_title)
	setFileDownloadLink (string $a_download_link)
	getFileDownloadLink ()
	setFullscreenLink (string $a_fullscreen_link)
	getFullscreenLink ()
	setIntLinkReturn (string $a_return)
	enableNotes (bool $a_enabled, int $a_parent_id)
	isEnabledNotes ()
	setOfflineDirectory (string $offdir)
	getOfflineDirectory ()
	setViewPageLink (string $a_link, string $a_target="")
	set link for "view page" button More...
	getViewPageLink ()
	getViewPageTarget ()
	getViewPageText ()
	setActivationListener (object $a_obj, string $a_meth)
	setEnabledNews (bool $a_enabled, int $a_news_obj_id=0, string $a_news_obj_type="")
	getEnabledNews ()
	setTabHook (object $a_object, string $a_function)
	setEditPreview (bool $a_editpreview)
	Set Display first Edit tab, then Preview tab, instead of Page and Edit. More...
	getEditPreview ()
	setEnabledTabs (bool $a_enabledtabs)
	getEnabledTabs ()
	setEnabledPageFocus (bool $a_enabledpagefocus)
	setOpenPlaceHolder (string $a_val)
	getOpenPlaceHolder ()
	getEnabledPageFocus ()
	setPrependingHtml (string $a_prependinghtml)
	getPrependingHtml ()
	setEnableEditing (bool $a_enableediting)
	getEnableEditing ()
	setRawPageContent (bool $a_rawpagecontent)
	Set Get raw page content only. More...
	getRawPageContent ()
	setStyleId (int $a_styleid)
	getStyleId ()
	setCompareMode (bool $a_val)
	getCompareMode ()
	setAbstractOnly (bool $a_val, string $pcid="")
	Get only abstract (first text paragraph) More...
	getAbstractOnly ()
	setRenderPageContainer (bool $a_val)
	getRenderPageContainer ()
	getDisabledText ()
	getEnabledHref ()
	setEnabledHref (bool $enable)
	activateMetaDataEditor (ilObject $a_rep_obj, string $a_type, int $a_sub_obj_id, ?object $a_observer_obj=null, string $a_observer_func="")
	Activate meda data editor. More...
	determineFileDownloadLink ()
	determineFullscreenLink ()
	determineSourcecodeDownloadScript ()
	getComponentPluginsXML ()
	Put information about activated plugins into XML. More...
	executeCommand ()
	execute command More...
	setQEditTabs (string $a_active)
	Set question editing tabs. More...
	onFeedbackEditingForwarding ()
	deactivatePage ()
	activatePage ()
	showPage ()
	display content of page More...
	replaceCurlyBrackets (string $output)
	getActivationCaptions ()
	Get captions for activation action menu entries. More...
	setEditMode ()
	Set edit mode. More...
	setDefaultLinkXml ()
	setLinkXml (string $xml)
	getProfileBackUrl ()
	setProfileBackUrl (string $url)
	downloadFile ()
	displayMediaFullscreen ()
	displayMedia (bool $a_fullscreen=false)
	download_paragraph ()
	download source code paragraph More...
	insertPageToc (string $a_output)
	insertResources (string $a_output)
	insertAdvTrigger (string $a_output)
	Insert adv content trigger. More...
	postOutputProcessing (string $a_output)
	Finalizing output processing. More...
	previewHistory ()
	Preview history. More...
	preview ()
	edit ()
	getBlockingInfoMessage ()
	insertJSAtPlaceholder ()
	presentation (string $a_mode=self::PRESENTATION)
	getHTML ()
	showMediaFullscreen (int $a_style_id=0)
	show fullscreen view of media object More...
	displayValidationError ($a_error)
	display validation error More...
	history ()
	Get history table as HTML. More...
	rollbackConfirmation ()
	Rollback confirmation. More...
	rollback ()
	Rollback to a previous version. More...
	setScreenIdComponent ()
	getMetaDataLink ()
	getTabs (string $a_activate="")
	compareVersion ()
	Compares two revisions of the page. More...
	replaceDiffTags (string $a_html)
	editActivation ()
	Edit activation (only, if scheduled page activation is activated in administration) More...
	initActivationForm ()
	Init activation form. More...
	getActivationFormValues ()
	Get values for activation form. More...
	saveActivation ()
	Save Activation. More...
	getNotesHTML (?object $a_content_object=null, bool $a_enable_private_notes=true, bool $a_enable_public_notes=false, bool $a_enable_notes_deletion=false, ?callable $a_callback=null, bool $export=false)
	Get html for public and/or private notes. More...
	processAnswer ()
	Process answer. More...
	initialOpenedContent ()
	Initially opened content. More...
	initOpenedContentForm ()
	saveInitialOpenedContent ()
	switchToLanguage ()
	Switch to language. More...
	confirmPageTranslationCreation ()
	Confirm page translation creation. More...
	editMasterLanguage ()
	Edit master language. More...
	createPageTranslation ()
	Create page translation. More...
	releasePageLock ()
	Release page lock. More...
	finishEditing ()
	getPagePermaLink ()
	getAdditionalPageActions ()
	Get additional page actions. More...
	afterDeleteContents ()

Static Public Member Functions
static	initEditingJS (ilGlobalTemplateInterface $a_tpl)
Static Public Member Functions inherited from ilPageObjectGUI
static	getTinyMenu (string $a_par_type, bool $a_int_links=false, bool $a_wiki_links=false, bool $a_keywords=false, $a_style_id=0, $a_paragraph_styles=true, $a_save_return=true, $a_anchors=false, $a_save_new=true, $a_user_links=false, ?\ILIAS\COPage\Editor\Server\UIWrapper $ui_wrapper=null)
	Get Tiny Menu. More...

Protected Member Functions
	initToolbar ()
	getCurrentLanguage ()
	addLanguageSelectionToToolbar ()
	getLanguageLabelForCode (string $code)
	getPrintView ()
	increaseViewCount ()
	printViewOrderList ()
	initRenameForm ()
	initAdvancedMetaDataForm ()
	finalizeAssignment ()
	Finalize and submit blog to exercise. More...
	downloadExcSubFile ()
	getTranslatePageFormAdapter ()
	checkLangPageAvailable (int $id, string $lang)
Protected Member Functions inherited from ilPageObjectGUI
	initPageObject ()
	Init page object. More...
	showEditToolbar ()
	Show edit toolbar. More...
	setEditorToolContext ()
	Set editor tool context. More...
	initEditing ()
	showEditLockInfo ()
	setBackToEditTabs ()
	setBackToHistoryTabs ()
	checkLangPageAvailable (int $id, string $lang)
	isPageContainerToBeRendered ()
	addResourcesToTemplate (ilGlobalTemplateInterface $tpl)
	Add resources to template. More...

Protected Attributes
ILIAS Exercise InternalDomainService	$exc_domain
ILIAS Wiki InternalDomainService	$domain
ILIAS Wiki Page PageManager	$wiki_pm
Translations	$ot
ILIAS Wiki InternalGUIService	$wiki_gui
ILIAS Notes Service	$notes
ILIAS HTTP Services	$http
ILIAS Wiki WikiGUIRequest	$wiki_request
ilAdvancedMDRecordGUI	$record_gui = null
bool	$fill_on_load_code = false
int	$wiki_ref_id = 0
ilSetting	$settings
ilObjWiki	$wiki
Protected Attributes inherited from ilPageObjectGUI
ILIAS TestQuestionPool Questions PublicInterface	$questioninfo
ILIAS COPage Page PageManager	$pm
ILIAS COPage Link LinkManager	$link
ILIAS COPage InternalGUIService	$gui
ILIAS COPage PC PCDefinition	$pc_definition
ILIAS COPage Xsl XslManager	$xsl
ILIAS COPage Editor GUIService	$editor_gui
ILIAS Notes Service	$notes
int	$requested_ref_id
int	$requested_pg_id
string	$requested_file_id
string	$requested_transl
int	$requested_old_nr
EditGUIRequest	$request
EditSessionRepository	$edit_repo
string	$exp_target_script = ""
string	$exp_id = ""
string	$exp_frame = ""
string	$act_meth = ""
object	$act_obj
int	$notes_parent_id = 0
ilPropertyFormGUI	$form
int	$styleid = 0
bool	$enabledpagefocus
string	$link_xml
int	$old_nr = 0
int	$id
string	$language
ilGlobalTemplateInterface	$tpl
ilLanguage	$lng
ilCtrl	$ctrl
ilTabsGUI	$tabs_gui
ilAccessHandler	$access
ilLogger	$log
ilObjUser	$user
ilHelpGUI	$help
string	$output_mode = ""
string	$parent_type = ""
string	$file_download_link = ''
string	$fullscreen_link = ''
string	$link_frame = ''
ILIAS GlobalScreen ScreenContext ContextServices	$tool_context
ILIAS DI UIServices	$ui
ILIAS COPage PageLinker	$page_linker
string	$abstract_pcid = ""
ilToolbarGUI	$toolbar
string	$open_place_holder = ""
int	$requested_user_id = 0
int	$requested_q_id = 0
int	$requested_history_mode = 0
bool	$enabled_news = false
int	$news_obj_id = 0
string	$news_obj_type = ""
array	$tab_hook = null
string	$view_page_link = ""
string	$view_page_target = ""
string	$offline_directory = ""
bool	$notes_enabled = false
string	$prependinghtml = ""
string	$header = ""
string	$int_link_return = ""
bool	$enabled_href = true
int	$adv_ref_id = null
string	$adv_type = null
string	$adv_subtype = null
string	$concrete_lang = ""
string	$profile_back_url = ""
ilComponentFactory	$component_factory
ILIAS COPage Compare PageCompare	$compare

Additional Inherited Members
Data Fields inherited from ilPageObjectGUI
const	PRESENTATION = "presentation"
const	EDIT = "edit"
const	PREVIEW = "preview"
const	OFFLINE = "offline"
const	PRINTING = "print"
string	$page_back_title = ""
ilPageObject	$obj
string	$presentation_title = ""
string	$target_script = ""
string	$return_location = ""
string	$target_var = ""
string	$template_output_var = ""
bool	$output2template = false
string	$link_params = ""
string	$sourcecode_download_script = ""
bool	$activation = false
bool	$activated = true
bool	$editpreview = false
bool	$use_meta_data = false
ilObject	$meta_data_rep_obj = null
int	$meta_data_sub_obj_id = 0
string	$meta_data_type = ""
object	$meta_data_observer_obj = null
string	$meta_data_observer_func = ""
bool	$link_xml_set = false
bool	$enableediting = true
bool	$rawpagecontent = false
bool	$enabledcontentincludes = false
bool	$compare_mode = false
ilPageConfig	$page_config = null
bool	$tabs_enabled = true
bool	$render_page_container = false
string	$pl_start = "{{{{{"
string	$pl_end = "}}}}}"

Detailed Description

Class ilWikiPage GUI class.

Author

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

@ilCtrl_Calls ilWikiPageGUI: ilPageEditorGUI, ilEditClipboardGUI, ilMediaPoolTargetSelector @ilCtrl_Calls ilWikiPageGUI: ILIAS\User\Profile\PublicProfileGUI, ilPageObjectGUI, ilNoteGUI, ilCommentGUI @ilCtrl_Calls ilWikiPageGUI: ilCommonActionDispatcherGUI, ilRatingGUI, ilWikiStatGUI @ilCtrl_Calls ilWikiPageGUI: ilObjectMetaDataGUI, ilPropertyFormGUI

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

Member Function Documentation

activateWikiPageRating()

ilWikiPageGUI::activateWikiPageRating

(

)

Rating /.

Definition at line 952 of file class.ilWikiPageGUI.php.

                                            : void
    {
        $lng = $this->lng;
        $ilCtrl = $this->ctrl;
 
        $this->getPageObject()->setRating(true);
        $this->getPageObject()->update();
 
        $this->tpl->setOnScreenMessage('success', $lng->txt("msg_obj_modified"), true);
        $ilCtrl->redirect($this, "preview");
    }

References $lng.

addHeaderAction()

ilWikiPageGUI::addHeaderAction

(

bool

$a_redraw = false

)

Definition at line 250 of file class.ilWikiPageGUI.php.

     : string {
        $ilUser = $this->user;
        $ilAccess = $this->access;
 
        $wiki_id = $this->getPageObject()->getParentId();
        $page_id = $this->getPageObject()->getId();
 
        $dispatcher = new ilCommonActionDispatcherGUI(
            ilCommonActionDispatcherGUI::TYPE_REPOSITORY,
            $ilAccess,
            "wiki",
            $this->requested_ref_id,
            $wiki_id
        );
 
        // see #33422
        $dispatcher->setSubObject("wpg", $page_id);
 
        ilObjectListGUI::prepareJsLinks(
            $this->ctrl->getLinkTarget($this, "redrawHeaderAction", "", true),
            "",
            $this->ctrl->getLinkTargetByClass(array("ilcommonactiondispatchergui", "iltagginggui"), "", "", true, false)
        );
 
        $lg = $dispatcher->initHeaderAction();
        $lg->enableNotes(true);
        $lg->enableComments(ilObjWiki::_lookupPublicNotes($wiki_id), false);
 
        // rating
        if (ilObjWiki::_lookupRatingOverall($wiki_id)) {
            $lg->enableRating(
                true,
                $this->lng->txt("wiki_rate_overall"),
                false,
                // so ilCtrl does not use the shortcut via ilWikiGUI
                array("ilcommonactiondispatchergui", "ilratinggui"),
                true
            );
        }
 
        // notification
        if ($ilUser->getId() !== ANONYMOUS_USER_ID) {
            if (ilNotification::hasNotification(ilNotification::TYPE_WIKI, $ilUser->getId(), $wiki_id)) {
                $this->ctrl->setParameter($this, "ntf", 1);
                if (ilNotification::hasOptOut($wiki_id)) {
                    $lg->addCustomCommand($this->ctrl->getLinkTarget($this), "wiki_notification_deactivate_wiki");
                }
 
                $lg->addHeaderIcon(
                    "not_icon",
                    ilUtil::getImagePath("object/notification_on.svg"),
                    $this->lng->txt("wiki_notification_activated")
                );
            } else {
                $this->ctrl->setParameter($this, "ntf", 2);
                $lg->addCustomCommand($this->ctrl->getLinkTarget($this), "wiki_notification_activate_wiki");
 
                if (ilNotification::hasNotification(ilNotification::TYPE_WIKI_PAGE, $ilUser->getId(), $page_id)) {
                    $this->ctrl->setParameter($this, "ntf", 3);
                    $lg->addCustomCommand($this->ctrl->getLinkTarget($this), "wiki_notification_deactivate_page");
 
                    $lg->addHeaderIcon(
                        "not_icon",
                        ilUtil::getImagePath("object/notification_on.svg"),
                        $this->lng->txt("wiki_page_notification_activated")
                    );
                } else {
                    $this->ctrl->setParameter($this, "ntf", 4);
                    $lg->addCustomCommand($this->ctrl->getLinkTarget($this), "wiki_notification_activate_page");
 
                    $lg->addHeaderIcon(
                        "not_icon",
                        ilUtil::getImagePath("object/notification_off.svg"),
                        $this->lng->txt("wiki_notification_deactivated")
                    );
                }
            }
            $this->ctrl->setParameter($this, "ntf", "");
        }
 
        if (!$a_redraw) {
            $this->tpl->setHeaderActionMenu($lg->getHeaderAction());
        } else {
            // we need to add onload code manually (rating, comments, etc.)
            return $lg->getHeaderAction() .
                $this->tpl->getOnLoadCodeForAsynch();
        }
        return "";
    }

addLanguageSelectionToToolbar()

ilWikiPageGUI::addLanguageSelectionToToolbar ( )

protected

Definition at line 484 of file class.ilWikiPageGUI.php.

                                                      : void
    {
        $toolbar = $this->toolbar;
        $f = $this->wiki_gui->ui()->factory();
 
        $this->ctrl->setParameterByClass(self::class, "wpg_id", $this->getId());
        $this->ctrl->setParameterByClass(self::class, "page", null);
        if ($this->ot->getContentTranslationActivated()) {
            $actions = [];
            foreach ($this->ot->getLanguages() as $language) {
                $lang_code = ($language->getLanguageCode() === $this->ot->getBaseLanguage())
                    ? "-"
                    : $language->getLanguageCode();
                $exists = $this->wiki_pm->exists($this->getId(), $lang_code);
                $this->ctrl->setParameterByClass(self::class, "transl", $lang_code);
                $action = ($lang_code !== "-" && !$exists)
                    ? "switchToLanguage"
                    : "preview";
                if ($action === "switchToLanguage") {
                    $this->ctrl->setParameterByClass(self::class, "transl", null);
                    $this->ctrl->setParameterByClass(self::class, "totransl", $lang_code);
                }
                $append = $exists
                    ? ""
                    : " (" . $this->lng->txt("wiki_not_existing") . ")";
                if ($lang_code === $this->getCurrentLanguage()) {
                    continue;
                }
                $actions[] = $f->link()->standard(
                    $this->getLanguageLabelForCode($language->getLanguageCode()) . $append,
                    $this->ctrl->getLinkTargetByClass(self::class, $action)
                );
            }
            $this->ctrl->setParameterByClass(self::class, "transl", $this->requested_transl);
            $this->ctrl->setParameterByClass(self::class, "totransl", null);
            if (count($actions) > 0) {
                $dd = $f->dropdown()->standard($actions)
                    ->withLabel($this->getLanguageLabelForCode($this->getCurrentLanguage()));
                $toolbar->addComponent($dd);
            }
        }
    }

References Vendor\Package\$f, ILIAS\Repository\ctrl(), ILIAS\Survey\Mode\getId(), and ILIAS\Repository\lng().

Here is the call graph for this function:

blockWikiPage()

ilWikiPageGUI::blockWikiPage

(

)

Definition at line 836 of file class.ilWikiPageGUI.php.

                                   : void
    {
        $ilCtrl = $this->ctrl;
        $lng = $this->lng;
 
        if (ilWikiPerm::check("activate_wiki_protection", $this->requested_ref_id)) {
            $this->getPageObject()->setBlocked(true);
            $this->getPageObject()->update();
 
            $this->tpl->setOnScreenMessage('success', $lng->txt("wiki_page_blocked"), true);
        }
 
        $ilCtrl->redirect($this, "preview");
    }

References $lng, and ilWikiPerm\check().

Here is the call graph for this function:

cancelWikiPageDeletion()

ilWikiPageGUI::cancelWikiPageDeletion

(

)

Definition at line 727 of file class.ilWikiPageGUI.php.

                                            : void
    {
        $ilCtrl = $this->ctrl;
 
        $ilCtrl->redirect($this, "preview");
    }

checkLangPageAvailable()

ilWikiPageGUI::checkLangPageAvailable ( int  $id, string  $lang  )

protected

Reimplemented from ilPageObjectGUI.

Definition at line 1393 of file class.ilWikiPageGUI.php.

                                                                    : bool
    {
        return $this->wiki_pm->exists($id, $lang);
    }

References $id, and $lang.

confirmPageTranslationCreation()

ilWikiPageGUI::confirmPageTranslationCreation

(

)

Confirm page translation creation.

Reimplemented from ilPageObjectGUI.

Definition at line 1321 of file class.ilWikiPageGUI.php.

                                                    : void
    {
        $this->tabs_gui->clearTargets();
        $this->tabs_gui->setBackTarget(
            $this->lng->txt("back"),
            $this->ctrl->getLinkTarget($this, "edit")
        );
 
        $l = $this->request->getString("totransl");
        $this->ctrl->setParameter($this, "totransl", $l);
        $this->lng->loadLanguageModule("meta");
 
        $r = $this->wiki_gui->ui()->renderer();
        $box = $this->wiki_gui->ui()->factory()->messageBox()->confirmation(
            $this->lng->txt("cont_page_translation_does_not_exist") . ": " .
            $this->lng->txt("meta_l_" . $l)
        );
 
        $form = $this->getTranslatePageFormAdapter();
 
        $content = $r->render($box) . $form->render();
 
        /*
        $cgui = new ilConfirmationGUI();
        $cgui->setFormAction($this->ctrl->getFormAction($this));
        $cgui->setHeaderText($this->lng->txt("cont_page_translation_does_not_exist") . ": " .
            $this->lng->txt("meta_l_" . $l));
        $cgui->setCancel($this->lng->txt("cancel"), "editMasterLanguage");
        $cgui->setConfirm($this->lng->txt("confirm"), "createPageTranslation");*/
        $this->tpl->setContent($content);
    }

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

Here is the call graph for this function:

confirmWikiPageDeletion()

ilWikiPageGUI::confirmWikiPageDeletion

(

)

Definition at line 734 of file class.ilWikiPageGUI.php.

                                             : void
    {
        $ilCtrl = $this->ctrl;
        $lng = $this->lng;
        if (ilWikiPerm::check("delete_wiki_pages", $this->requested_ref_id)) {
            $this->getPageObject()->delete();
 
            $this->tpl->setOnScreenMessage('success', $lng->txt("wiki_page_deleted"), true);
        }
 
        $ilCtrl->redirectByClass("ilobjwikigui", "allPages");
    }

References $lng, and ilWikiPerm\check().

Here is the call graph for this function:

deactivateWikiPageRating()

ilWikiPageGUI::deactivateWikiPageRating

(

)

Definition at line 964 of file class.ilWikiPageGUI.php.

                                              : void
    {
        $lng = $this->lng;
        $ilCtrl = $this->ctrl;
 
        $this->getPageObject()->setRating(false);
        $this->getPageObject()->update();
 
        $this->tpl->setOnScreenMessage('success', $lng->txt("msg_obj_modified"), true);
        $ilCtrl->redirect($this, "preview");
    }

References $lng.

deleteWikiPageConfirmationScreen()

ilWikiPageGUI::deleteWikiPageConfirmationScreen

(

)

Definition at line 657 of file class.ilWikiPageGUI.php.

                                                      : void
    {
        $tpl = $this->tpl;
        $ilCtrl = $this->ctrl;
        $lng = $this->lng;
 
        if (ilWikiPerm::check("delete_wiki_pages", $this->requested_ref_id)) {
            $confirmation_gui = new ilConfirmationGUI();
            $confirmation_gui->setFormAction($ilCtrl->getFormAction($this));
            $confirmation_gui->setHeaderText($lng->txt("wiki_page_deletion_confirmation"));
            $confirmation_gui->setCancel($lng->txt("cancel"), "cancelWikiPageDeletion");
            $confirmation_gui->setConfirm($lng->txt("delete"), "confirmWikiPageDeletion");
 
            $dtpl = new ilTemplate(
                "tpl.wiki_page_deletion_confirmation.html",
                true,
                true,
                "components/ILIAS/Wiki"
            );
 
            $dtpl->setVariable("PAGE_TITLE", $this->getWikiPage()->getTitle());
 
            // other pages that link to this page
            $dtpl->setVariable("TXT_OTHER_PAGES", $lng->txt("wiki_other_pages_linking"));
            $pages = ilWikiPage::getLinksToPage(
                $this->getWikiPage()->getWikiId(),
                $this->getWikiPage()->getId()
            );
            if (count($pages) > 0) {
                foreach ($pages as $page) {
                    $dtpl->setCurrentBlock("lpage");
                    $dtpl->setVariable("TXT_LINKING_PAGE", $page["title"]);
                    $dtpl->parseCurrentBlock();
                }
            } else {
                $dtpl->setCurrentBlock("lpage");
                $dtpl->setVariable("TXT_LINKING_PAGE", "-");
                $dtpl->parseCurrentBlock();
            }
 
            // contributors
            $dtpl->setVariable("TXT_CONTRIBUTORS", $lng->txt("wiki_contributors"));
            $contributors = ilWikiPage::getWikiPageContributors($this->getWikiPage()->getId());
            foreach ($contributors as $contributor) {
                $dtpl->setCurrentBlock("contributor");
                $dtpl->setVariable(
                    "TXT_CONTRIBUTOR",
                    $contributor["lastname"] . ", " . $contributor["firstname"]
                );
                $dtpl->parseCurrentBlock();
            }
 
            // notes/comments
            $cnt_note_users = $this->notes->domain()->getUserCount(
                $this->getPageObject()->getParentId(),
                $this->getPageObject()->getId(),
                "wpg"
            );
            $dtpl->setVariable(
                "TXT_NUMBER_USERS_NOTES_OR_COMMENTS",
                $lng->txt("wiki_number_users_notes_or_comments")
            );
            $dtpl->setVariable("TXT_NR_NOTES_COMMENTS", $cnt_note_users);
 
            $confirmation_gui->addItem("", "", $dtpl->get());
 
            $tpl->setContent($confirmation_gui->getHTML());
        }
    }

References $lng, ilWikiPerm\check(), ILIAS\Survey\Mode\getId(), ilWikiPage\getLinksToPage(), ILIAS\GlobalScreen\Scope\Footer\Factory\getTitle(), and ilWikiPage\getWikiPageContributors().

Here is the call graph for this function:

downloadExcSubFile()

ilWikiPageGUI::downloadExcSubFile ( )

protected

Definition at line 1279 of file class.ilWikiPageGUI.php.

                                           : void
    {
        $ilUser = $this->user;
 
        $ass_id = $this->wiki_request->getAssignmentId();
        $ass = new ilExAssignment($ass_id);
 
        $sub_manager = $this->exc_domain->submission($ass_id);
        $sub = $sub_manager->getSubmissionsOfUser($ilUser->getId())->current();
        $team_id = $this->exc_domain->team()->getTeamForMember(
            $ass->getId(),
            $ilUser->getId()
        );
 
        if ($sub) {
            $user_data = ilObjUser::_lookupName($sub->getUserId());
            $title = ilObject::_lookupTitle($ass->getExerciseId()) . " - " .
                $ass->getTitle() . " (Team " . $team_id . ").zip";
 
            $sub_manager->deliverFile(
                $ilUser->getId(),
                $sub->getRid(),
                $title
            );
        }
    }

References $ass_id, ilObjUser\_lookupName(), and ilObject\_lookupTitle().

Here is the call graph for this function:

edit()

ilWikiPageGUI::edit

(

)

Reimplemented from ilPageObjectGUI.

Definition at line 1125 of file class.ilWikiPageGUI.php.

                          : string
    {
        $tpl = $this->tpl;
        $lng = $this->lng;
        $this->ctrl->setParameterByClass(self::class, "wpg_id", $this->getId());
        self::initEditingJS($tpl);
 
        return parent::edit();
    }

References $lng, ILIAS\Repository\ctrl(), and ILIAS\Survey\Mode\getId().

Here is the call graph for this function:

editAdvancedMetaData()

ilWikiPageGUI::editAdvancedMetaData

(

?ilPropertyFormGUI

$a_form = null

)

Definition at line 1035 of file class.ilWikiPageGUI.php.

     : void {
        $ilTabs = $this->tabs_gui;
        $lng = $this->lng;
        $ilCtrl = $this->ctrl;
        $tpl = $this->tpl;
        $ilAccess = $this->access;
 
        if (!$ilAccess->checkAccess("write", "", $this->wiki_ref_id) &&
            !$ilAccess->checkAccess("edit_page_meta", "", $this->wiki_ref_id)) {
            return;
        }
 
 
        $ilTabs->clearTargets();
        $ilTabs->setBackTarget(
            $lng->txt("back"),
            $ilCtrl->getLinkTarget($this, "preview")
        );
 
        if (!$a_form) {
            $a_form = $this->initAdvancedMetaDataForm();
        }
 
        $tpl->setContent($a_form->getHTML());
    }

executeCommand()

ilWikiPageGUI::executeCommand

(

)

Exceptions

ilCtrlException

Reimplemented from ilPageObjectGUI.

Definition at line 110 of file class.ilWikiPageGUI.php.

                                    : string
    {
        $ilCtrl = $this->ctrl;
        $ilTabs = $this->tabs_gui;
        $ilUser = $this->user;
        $ilAccess = $this->access;
        $lng = $this->lng;
        $tpl = $this->tpl;
 
        $next_class = $this->ctrl->getNextClass($this);
 
        $head_title = ilObject::_lookupTitle(ilObject::_lookupObjId($this->requested_ref_id)) .
            ": " . $this->getWikiPage()->getTitle();
        $tpl->setHeaderPageTitle($head_title);
        // see #13804
        //if ($this->wiki_request->getWikiPageId() > 0) {
        PageContentProvider::setPermaLink($this->wiki_pm->getPermaLink(
            $this->getPageObject()->getId(),
            $this->getPageObject()->getLanguage()
        ));
        //} else {
        //    $tpl->setPermanentLink("wiki", $this->requested_ref_id);
        //}
 
 
        switch ($next_class) {
            case "ilnotegui":
            case "ilcommentgui":
                $this->getTabs();
                $ilTabs->setTabActive("pg");
                return $this->preview();
 
            case "ilratinggui":
                // for rating side block
                $rating_gui = new ilRatingGUI();
                $rating_gui->setObject(
                    $this->getPageObject()->getParentId(),
                    "wiki",
                    $this->getPageObject()->getId(),
                    "wpg"
                );
                $rating_gui->setUpdateCallback(array($this, "updateStatsRating"));
                $this->ctrl->forwardCommand($rating_gui);
                $ilCtrl->redirect($this, "preview");
                break;
 
            case "ilcommonactiondispatchergui":
                $gui = ilCommonActionDispatcherGUI::getInstanceFromAjaxCall();
                if (!is_null($gui)) {
                    $gui->enableCommentsSettings(false);
                    $gui->setRatingCallback(
                        $this,
                        "preview"
                    );
                    $this->ctrl->forwardCommand($gui);
                }
                break;
 
            case "ilwikistatgui":
                if ($ilAccess->checkAccess("statistics_read", "", $this->wiki_ref_id)) {
                    $this->tabs_gui->clearTargets(); // see ilObjWikiGUI::getTabs()
                    $this->getTabs("statistics");
 
                    $gui = new ilWikiStatGUI(
                        $this->getPageObject()->getParentId(),
                        $this->getPageObject()->getId()
                    );
                    $this->ctrl->forwardCommand($gui);
                }
                break;
            case 'ilobjectmetadatagui':
 
                if (!$ilAccess->checkAccess("write", "", $this->wiki_ref_id)) {
                    $this->tpl->setOnScreenMessage('failure', $lng->txt("permission_denied"), true);
                    $ilCtrl->redirect($this, "preview");
                }
                return parent::executeCommand();
 
            case "ilpropertyformgui":
                // only case is currently adv metadata internal link in info settings, see #24497
                $form = $this->initAdvancedMetaDataForm();
                $ilCtrl->forwardCommand($form);
                break;
 
            default:
 
                if (strtolower($ilCtrl->getNextClass()) === "ilpageeditorgui") {
                    self::initEditingJS($this->tpl);
                }
 
                if ($this->wiki_request->getNotification() > 0
                    && $ilUser->getId() !== ANONYMOUS_USER_ID) {
                    switch ($this->wiki_request->getNotification()) {
                        case 1:
                            ilNotification::setNotification(ilNotification::TYPE_WIKI, $ilUser->getId(), $this->getPageObject()->getParentId(), false);
                            break;
 
                        case 2:
                            // remove all page notifications here?
                            ilNotification::setNotification(ilNotification::TYPE_WIKI, $ilUser->getId(), $this->getPageObject()->getParentId(), true);
                            break;
 
                        case 3:
                            ilNotification::setNotification(ilNotification::TYPE_WIKI_PAGE, $ilUser->getId(), $this->getPageObject()->getId(), false);
                            break;
 
                        case 4:
                            ilNotification::setNotification(ilNotification::TYPE_WIKI_PAGE, $ilUser->getId(), $this->getPageObject()->getId(), true);
                            break;
                    }
                    $ilCtrl->redirect($this, "preview");
                }
 
                $this->setPresentationTitle($this->getWikiPage()->getTitle());
                return parent::executeCommand();
        }
        return "";
    }

References ilPageObjectGUI\$access, ilPageObjectGUI\$ctrl, ilPageObjectGUI\$form, ilPageObjectGUI\$gui, ilPageObjectGUI\$lng, ilPageObjectGUI\$tabs_gui, ilPageObjectGUI\$tpl, ilPageObjectGUI\$user, ilObject\_lookupObjId(), ilObject\_lookupTitle(), ANONYMOUS_USER_ID, ILIAS\Repository\ctrl(), ilPageObjectGUI\getId(), ilCommonActionDispatcherGUI\getInstanceFromAjaxCall(), ilPageObjectGUI\getPageObject(), getTabs(), ILIAS\GlobalScreen\Scope\Footer\Factory\getTitle(), initAdvancedMetaDataForm(), initEditingJS(), preview(), ILIAS\UICore\GlobalTemplate\setHeaderPageTitle(), ilNotification\setNotification(), ilPageObjectGUI\setPresentationTitle(), ilLanguage\txt(), ilNotification\TYPE_WIKI, and ilNotification\TYPE_WIKI_PAGE.

Here is the call graph for this function:

finalizeAssignment()

ilWikiPageGUI::finalizeAssignment ( )

protected

Finalize and submit blog to exercise.

Definition at line 1265 of file class.ilWikiPageGUI.php.

                                           : void
    {
        $ilCtrl = $this->ctrl;
        $lng = $this->lng;
 
        $wiki_ass = ilExAssignmentTypes::getInstance()->getById(ilExAssignment::TYPE_WIKI_TEAM);
 
        $ass_id = $this->wiki_request->getAssignmentId();
        $wiki_ass->submitWiki($ass_id, $this->user->getId(), $this->getWikiRefId());
 
        $this->tpl->setOnScreenMessage('success', $lng->txt("wiki_finalized"), true);
        $ilCtrl->redirectByClass("ilObjWikiGUI", "gotoStartPage");
    }

References $ass_id, $lng, ilExAssignmentTypes\getInstance(), ilExAssignment\TYPE_WIKI_TEAM, and ILIAS\Repository\user().

Here is the call graph for this function:

getCommentsHTMLExport()

ilWikiPageGUI::getCommentsHTMLExport

(

)

Definition at line 1306 of file class.ilWikiPageGUI.php.

                                           : string
    {
        return $this->getNotesHTML(
            $this->getPageObject(),
            false,
            ilObjWiki::_lookupPublicNotes($this->getPageObject()->getParentId()),
            false,
            null,
            true
        );
    }

References ilObjWiki\_lookupPublicNotes().

Here is the call graph for this function:

getCurrentLanguage()

ilWikiPageGUI::getCurrentLanguage ( )

protected

Definition at line 479 of file class.ilWikiPageGUI.php.

                                           : string
    {
        return $this->getPageObject()->getLanguage();
    }

getLanguageLabelForCode()

ilWikiPageGUI::getLanguageLabelForCode ( string  $code )

protected

Definition at line 527 of file class.ilWikiPageGUI.php.

                                                            : string
    {
        if ($code === "-") {
            $code = $this->ot->getBaseLanguage();
        }
        return $this->lng->txt("language") . ": " . $this->lng->txt("meta_l_" . $code);
    }

References ILIAS\Repository\lng().

Here is the call graph for this function:

getPrintView()

ilWikiPageGUI::getPrintView ( )

protected

Definition at line 535 of file class.ilWikiPageGUI.php.

                                     : \ILIAS\Export\PrintProcessGUI
    {
        $provider = new \ILIAS\Wiki\WikiPrintViewProviderGUI(
            $this->lng,
            $this->ctrl,
            $this->getWikiPage()->getWikiRefId(),
            []
        );
 
        return new \ILIAS\Export\PrintProcessGUI(
            $provider,
            $this->http,
            $this->ui,
            $this->lng
        );
    }

References $provider, ILIAS\Repository\ctrl(), ILIAS\FileDelivery\http(), ILIAS\Repository\lng(), and ILIAS\Repository\ui().

Here is the call graph for this function:

getTabs()

ilWikiPageGUI::getTabs

(

string

$a_activate = ""

)

Reimplemented from ilPageObjectGUI.

Definition at line 626 of file class.ilWikiPageGUI.php.

     : void {
        $ilTabs = $this->tabs_gui;
        $ilCtrl = $this->ctrl;
        $ilAccess = $this->access;
 
        parent::getTabs($a_activate);
 
        if ($ilAccess->checkAccess("statistics_read", "", $this->requested_ref_id)) {
            $ilTabs->addTarget(
                "statistics",
                $this->ctrl->getLinkTargetByClass(
                    array("ilwikipagegui", "ilwikistatgui"),
                    "initial"
                ),
                "",
                "ilwikistatgui"
            );
        }
 
        $ilTabs->addTarget(
            "wiki_what_links_here",
            $this->ctrl->getLinkTargetByClass(
                "ilwikipagegui",
                "whatLinksHere"
            ),
            "whatLinksHere"
        );
    }

Referenced by executeCommand().

Here is the caller graph for this function:

getTranslatePageFormAdapter()

ilWikiPageGUI::getTranslatePageFormAdapter ( )

protected

Definition at line 1353 of file class.ilWikiPageGUI.php.

                                                    : \ILIAS\Repository\Form\FormAdapterGUI
    {
        $f = $this->wiki_gui->form(self::class, "createPageTranslation")
            ->text("title", $this->lng->txt("title"));
        //->required();
        return $f;
    }

References Vendor\Package\$f, and ILIAS\Repository\lng().

Here is the call graph for this function:

getWiki()

ilWikiPageGUI::getWiki

(

)

Definition at line 102 of file class.ilWikiPageGUI.php.

                             : ilObjWiki
    {
        return $this->wiki;
    }

References $wiki.

getWikiRefId()

ilWikiPageGUI::getWikiRefId

(

)

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

                                  : int
    {
        return $this->wiki_ref_id;
    }

References $wiki_ref_id.

hideAdvancedMetaData()

ilWikiPageGUI::hideAdvancedMetaData

(

)

Definition at line 1089 of file class.ilWikiPageGUI.php.

                                          : void
    {
        $ilCtrl = $this->ctrl;
        $lng = $this->lng;
        $ilAccess = $this->access;
 
        if (!$ilAccess->checkAccess("write", "", $this->wiki_ref_id) &&
            !$ilAccess->checkAccess("edit_page_meta", "", $this->wiki_ref_id)) {
            return;
        }
 
        $this->getPageObject()->hideAdvancedMetadata(true);
        $this->getPageObject()->update();
 
        $this->tpl->setOnScreenMessage('success', $lng->txt("settings_saved"), true);
        $ilCtrl->redirect($this, "preview");
    }

References $lng.

increaseViewCount()

ilWikiPageGUI::increaseViewCount ( )

protected

Definition at line 552 of file class.ilWikiPageGUI.php.

                                          : void
    {
        $ilUser = $this->user;
 
        $this->getWikiPage()->increaseViewCnt();
 
        // enable object statistics
        ilChangeEvent::_recordReadEvent(
            "wiki",
            $this->getWikiPage()->getWikiRefId(),
            $this->getWikiPage()->getWikiId(),
            $ilUser->getId()
        );
 
        ilWikiStat::handleEvent(ilWikiStat::EVENT_PAGE_READ, $this->getWikiPage());
    }

References ilChangeEvent\_recordReadEvent(), ilWikiStat\EVENT_PAGE_READ, and ilWikiStat\handleEvent().

Here is the call graph for this function:

initAdvancedMetaDataForm()

ilWikiPageGUI::initAdvancedMetaDataForm ( )

protected

Definition at line 1006 of file class.ilWikiPageGUI.php.

                                                 : ilPropertyFormGUI
    {
        $ilCtrl = $this->ctrl;
        $lng = $this->lng;
 
        $page = $this->getWikiPage();
 
        $form = new ilPropertyFormGUI();
        $form->setFormAction($ilCtrl->getFormAction($this, "updateAdvancedMetaData"));
 
        // :TODO:
        $form->setTitle($lng->txt("wiki_advmd_block_title") . ": " . $page->getTitle());
 
        $this->record_gui = new ilAdvancedMDRecordGUI(
            ilAdvancedMDRecordGUI::MODE_EDITOR,
            'wiki',
            $page->getWikiId(),
            'wpg',
            $page->getId()
        );
        $this->record_gui->setPropertyForm($form);
        $this->record_gui->parse();
 
        $form->addCommandButton("updateAdvancedMetaData", $lng->txt("save"));
        $form->addCommandButton("preview", $lng->txt("cancel"));
 
        return $form;
    }

References $lng, and ilAdvancedMDRecordGUI\MODE_EDITOR.

Referenced by executeCommand().

Here is the caller graph for this function:

initEditingJS()

static ilWikiPageGUI::initEditingJS ( ilGlobalTemplateInterface  $a_tpl )

static

Definition at line 1135 of file class.ilWikiPageGUI.php.

                                                                          : void
    {
        global $DIC;
 
        $lng = $DIC->language();
 
        $a_tpl->addJavaScript("assets/js/WikiEdit.js");
        $a_tpl->addOnLoadCode("il.Wiki.Edit.txt.page_exists = '" . $lng->txt("wiki_page_exists") . "';");
        $a_tpl->addOnLoadCode("il.Wiki.Edit.txt.new_page = '" . $lng->txt("wiki_new_page") . "';");
    }

References $DIC, $lng, ILIAS\UICore\GlobalTemplate\addJavaScript(), and ILIAS\UICore\GlobalTemplate\addOnLoadCode().

Referenced by executeCommand().

Here is the call graph for this function:

Here is the caller graph for this function:

initRenameForm()

ilWikiPageGUI::initRenameForm ( )

protected

Definition at line 888 of file class.ilWikiPageGUI.php.

                                       : void
    {
        $lng = $this->lng;
        $ilCtrl = $this->ctrl;
 
        $this->form = new ilPropertyFormGUI();
 
        // new name
        $ti = new ilTextInputGUI($lng->txt("wiki_new_page_name"), "new_page_name");
        $ti->setMaxLength(200);
        $ti->setSize(50);
        $ti->setValue($this->getPageObject()->getTitle());
        $ti->setRequired(true);
        $this->form->addItem($ti);
 
        $this->form->addCommandButton("renamePage", $lng->txt("wiki_rename"));
        $this->form->addCommandButton("preview", $lng->txt("cancel"));
 
        $this->form->setTitle($lng->txt("wiki_rename_page"));
        $this->form->setFormAction($ilCtrl->getFormAction($this));
    }

References $lng, ILIAS\Repository\form(), and ILIAS\GlobalScreen\Scope\Footer\Factory\getTitle().

Here is the call graph for this function:

initToolbar()

ilWikiPageGUI::initToolbar ( )

protected

Definition at line 464 of file class.ilWikiPageGUI.php.

                                    : void
    {
        $toolbar = $this->toolbar;
 
        $this->addLanguageSelectionToToolbar();
 
        $print_view = $this->getPrintView();
        $modal_elements = $print_view->getModalElements($this->ctrl->getLinkTarget(
            $this,
            "printViewSelection"
        ));
        $toolbar->addComponent($modal_elements->button);
        $toolbar->addComponent($modal_elements->modal);
    }

References ILIAS\Repository\ctrl().

Here is the call graph for this function:

insertWikiLink()

ilWikiPageGUI::insertWikiLink

(

)

Returns form to insert a wiki link per ajax.

Definition at line 1150 of file class.ilWikiPageGUI.php.

                                    : void
    {
        $lng = $this->lng;
        $ilCtrl = $this->ctrl;
 
        $form = new ilPropertyFormGUI();
        $form->addCommandButton("addWikiLink", $lng->txt("wiki_add_link"));
        $form->addCommandButton("searchWikiLink", $lng->txt("search"));
 
        // Target page
        $tp = new ilTextInputGUI($this->lng->txt("wiki_target_page"), "target_page");
        $tp->setSize(18);
        $tp->setRequired(true);
        $tp->setInfo("...");
        $tp->setDataSource($ilCtrl->getLinkTarget($this, "insertWikiLinkAC", "", true));
        $form->addItem($tp);
 
        // Link text
        $lt = new ilTextInputGUI($this->lng->txt("wiki_link_text"), "link_text");
        $lt->setSize(18);
        $form->addItem($lt);
 
        //$form->setTitle($lng->txt("wiki_link"));
 
        echo $form->getHTML();
        exit;
    }

References $lng, exit, and ILIAS\Repository\lng().

Here is the call graph for this function:

insertWikiLinkAC()

ilWikiPageGUI::insertWikiLinkAC

(

)

Auto complete for insert wiki link.

Definition at line 1181 of file class.ilWikiPageGUI.php.

                                      : void
    {
        $result = array();
 
        $term = $this->wiki_request->getTerm();
 
        // if page exists, make it first entry
        if (ilWikiPage::_wikiPageExists($this->getPageObject()->getParentId(), $term)) {
            $entry = new stdClass();
            $entry->value = $term;
            $entry->label = $term;
            $result[] = $entry;
        }
 
        $res = ilWikiPage::getPagesForSearch($this->getPageObject()->getParentId(), $term);
 
        $cnt = 0;
        foreach ($res as $r) {
            if ($result[0]->value == $r) {
                continue;
            }
            if ($cnt++ > 19) {
                continue;
            }
            $entry = new stdClass();
            $entry->value = $r;
            $entry->label = $r;
            $result[] = $entry;
        }
 
        echo json_encode($result, JSON_THROW_ON_ERROR);
        exit;
    }

References $res, ilWikiPage\_wikiPageExists(), exit, and ilWikiPage\getPagesForSearch().

Here is the call graph for this function:

observeNoteAction()

ilWikiPageGUI::observeNoteAction	(	int	$a_wiki_id,
		int	$a_page_id,
		string	$a_type,
		string	$a_action,
		int	$a_note_id
	)

Definition at line 977 of file class.ilWikiPageGUI.php.

     : void {
        // #10040 - get note text
        $note = $this->notes->domain()->getById($a_note_id);
        $text = $note->getText();
 
        $noti = $this->wiki_gui->notification();
        $noti->send("comment", ilNotification::TYPE_WIKI_PAGE, $this->getWikiRefId(), $a_page_id, $text, $this->getLanguage());
    }

postOutputProcessing()

ilWikiPageGUI::postOutputProcessing

(

string

$a_output

)

Finalizing output processing.

Maybe overwritten in derived classes, e.g. in wiki module.

Reimplemented from ilPageObjectGUI.

Definition at line 569 of file class.ilWikiPageGUI.php.

                                                          : string
    {
        $ilCtrl = $this->ctrl;
 
        $title = $this->getPageObject()->getTitle();
        $ilCtrl->setParameterByClass(
            "ilobjwikigui",
            "from_page",
            ilWikiUtil::makeUrlTitle($title)
        );
        if ($this->getEnabledHref() && $this->getOutputMode() !== self::EDIT) {
            $output = ilWikiUtil::replaceInternalLinks(
                $a_output,
                $this->getWikiPage()->getWikiId(),
                ($this->getOutputMode() === "offline"),
                $this->getCurrentLanguage()
            );
        } else {
            $output = $a_output;
        }
        $ilCtrl->setParameterByClass(
            "ilobjwikigui",
            "from_page",
            $this->wiki_request->getFromPage()
        );
 
 
        // metadata in print view
        if ($this->getOutputMode() === "print" && $this->wiki instanceof ilObjWiki) {
            $mdgui = new ilObjectMetaDataGUI($this->wiki, "wpg", $this->getId());
            $md = $mdgui->getKeyValueList();
            if ($md !== "") {
                $output = str_replace("<!--COPage-PageTop-->", "<p>" . $md . "</p>", $output);
            }
        }
 
 
        return $output;
    }

References ILIAS\Survey\Mode\getId(), ilWikiUtil\makeUrlTitle(), and ilWikiUtil\replaceInternalLinks().

Here is the call graph for this function:

preview()

ilWikiPageGUI::preview

(

)

Reimplemented from ilPageObjectGUI.

Definition at line 348 of file class.ilWikiPageGUI.php.

                             : string
    {
        $ilCtrl = $this->ctrl;
        $ilAccess = $this->access;
        $lng = $this->lng;
        $tpl = $this->tpl;
        $ilUser = $this->user;
        $ilSetting = $this->settings;
        $append = "";
        $message = "";
 
 
        // block/unblock
        if ($this->getPageObject()->getBlocked()) {
            $this->tpl->setOnScreenMessage('info', $lng->txt("wiki_page_status_blocked"));
        }
 
        $this->increaseViewCount();
 
        $this->addHeaderAction();
 
        // content
        if (!in_array($ilCtrl->getNextClass(), ["ilnotegui", "ilcommentgui"])) {
            $this->setSideBlock();
        }
 
        $wtpl = new ilTemplate(
            "tpl.wiki_page_view_main_column.html",
            true,
            true,
            "components/ILIAS/Wiki"
        );
        $callback = array($this, "observeNoteAction");
        // notes
        if (!$ilSetting->get("disable_comments") &&
            ilObjWiki::_lookupPublicNotes($this->getPageObject()->getParentId())) {
            $may_delete = ($ilSetting->get("comments_del_tutor", '1') &&
                $ilAccess->checkAccess("write", "", $this->requested_ref_id));
            $wtpl->setVariable("NOTES", $this->getNotesHTML(
                $this->getPageObject(),
                true,
                ilObjWiki::_lookupPublicNotes($this->getPageObject()->getParentId()),
                $may_delete,
                $callback
            ));
        }
 
 
        // page content
        $this->setOutputMode(ilPageObjectGUI::PRESENTATION);
        $this->showEditToolbar();
        $this->setRenderPageContainer(true);
        $wtpl->setVariable("PAGE", $this->showPage());
 
        $tpl->setLoginTargetPar("wiki_" . $this->requested_ref_id . $append);
 
        // last edited info
        $wtpl->setVariable(
            "LAST_EDITED_INFO",
            $lng->txt("wiki_last_edited") . ": " .
            ilDatePresentation::formatDate(
                new ilDateTime($this->getPageObject()->getLastChange(), IL_CAL_DATETIME)
            ) . ", " .
            ilUserUtil::getNamePresentation(
                $this->getPageObject()->getLastChangeUser(),
                false,
                true,
                $ilCtrl->getLinkTarget($this, "preview")
            )
        );
 
        $tpl->setLoginTargetPar("wiki_" . $this->requested_ref_id . $append);
 
        //highlighting
        if ($this->wiki_request->getSearchString()) {
            $cache = ilUserSearchCache::_getInstance($ilUser->getId());
            $cache->switchSearchType(ilUserSearchCache::LAST_QUERY);
            $search_string = $cache->getQuery();
 
            // advanced search?
            if (is_array($search_string)) {
                $search_string = $search_string["lom_content"];
            }
 
            $p = new ilQueryParser($search_string);
            $p->parse();
 
            $words = $p->getQuotedWords();
            if (is_array($words)) {
                foreach ($words as $w) {
                    ilTextHighlighterGUI::highlight("ilCOPageContent", $w, $tpl);
                }
            }
            $this->fill_on_load_code = true;
        }
 
        return $message . $wtpl->get();
    }

References $ilSetting, $lng, $message, ilUserSearchCache\_getInstance(), ilObjWiki\_lookupPublicNotes(), ilDatePresentation\formatDate(), ilUserUtil\getNamePresentation(), IL_CAL_DATETIME, ilUserSearchCache\LAST_QUERY, and ilPageObjectGUI\PRESENTATION.

Referenced by executeCommand().

Here is the call graph for this function:

Here is the caller graph for this function:

printViewOrder()

ilWikiPageGUI::printViewOrder

(

)

Definition at line 757 of file class.ilWikiPageGUI.php.

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

printViewOrderList()

ilWikiPageGUI::printViewOrderList ( )

protected

Definition at line 762 of file class.ilWikiPageGUI.php.

     : void {
        $ilTabs = $this->tabs_gui;
 
        $pg_ids = $all_pages = array();
 
        // coming from type selection
        $ordering = $this->wiki_request->getPrintOrdering();
        if (count($ordering) === 0) {
            switch ($this->wiki_request->getSelectedPrintType()) {
                case "wiki":
                    foreach ($this->wiki_pm->getWikiPages($this->getLanguage()) as $p) {
                        $pg_ids[] = $p->getId();
                    }
                    break;
 
                case "selection":
                    $pg_ids = $this->wiki_request->getWikiPageIds();
                    if (count($pg_ids) === 0) {
                        $pg_ids = [$this->wiki_request->getWikiPageId()];
                    }
                    if (count($pg_ids) > 1) {
                        break;
                    } else {
                        $wiki_page_id = array_pop($pg_ids);
                    }
                    $this->ctrl->setParameterByClass(
                        "ilObjWikiGUI",
                        "wpg_id",
                        $wiki_page_id
                    );
                    $this->ctrl->redirectByClass("ilObjWikiGUI", "printView");
                    break;
 
                default:
                    $this->ctrl->setParameterByClass(
                        "ilObjWikiGUI",
                        "wpg_id",
                        $this->wiki_request->getWikiPageId()
                    );
                    $this->ctrl->redirectByClass("ilObjWikiGUI", "printView");
                    break;
            }
        }
        // refresh sorting
        else {
            asort($ordering);
            $pg_ids = array_keys($ordering);
        }
 
        $ilTabs->clearTargets();
        $ilTabs->setBackTarget(
            $this->lng->txt("back"),
            $this->ctrl->getLinkTarget($this, "preview")
        );
 
        if (!count($all_pages)) {
            $all_pages = ilWikiPage::getAllWikiPages($this->getPageObject()->getWikiId());
        }
 
        $tbl = new ilWikiExportOrderTableGUI(
            $this,
            "printViewOrderList",
            $all_pages,
            $pg_ids
        );
        $this->tpl->setContent($tbl->getHTML());
    }

printViewSelection()

ilWikiPageGUI::printViewSelection

(

)

Definition at line 751 of file class.ilWikiPageGUI.php.

                                        : void
    {
        $view = $this->getPrintView();
        $view->sendForm();
    }

redrawHeaderAction()

ilWikiPageGUI::redrawHeaderAction

(

)

Definition at line 342 of file class.ilWikiPageGUI.php.

                                        : void
    {
        echo $this->addHeaderAction(true);
        exit;
    }

References exit.

renamePage()

ilWikiPageGUI::renamePage

(

)

Definition at line 910 of file class.ilWikiPageGUI.php.

                                : void
    {
        $tpl = $this->tpl;
        $lng = $this->lng;
        $ilCtrl = $this->ctrl;
        $ilAccess = $this->access;
 
        $this->initRenameForm();
        if ($this->form->checkInput()) {
            if (($ilAccess->checkAccess("edit_content", "", $this->requested_ref_id) && !$this->getPageObject()->getBlocked())
                || $ilAccess->checkAccess("write", "", $this->requested_ref_id)) {
                $new_name = $this->form->getInput("new_page_name");
 
                $page_title = ilWikiUtil::makeDbTitle($new_name);
                $pg_id = ilWikiPage::getPageIdForTitle(
                    $this->getPageObject()->getWikiId(),
                    $page_title,
                    $this->getPageObject()->getLanguage()
                );
 
                // we might get the same page id back here, if the page
                // name only differs in diacritics
                // see bug http://www.ilias.de/mantis/view.php?id=11226
                if ($pg_id > 0 && $pg_id != $this->getPageObject()->getId()) {
                    $this->tpl->setOnScreenMessage('failure', $lng->txt("wiki_page_already_exists"));
                } else {
                    $new_name = $this->getPageObject()->rename($new_name);
                    $ilCtrl->setParameterByClass("ilobjwikigui", "page", ilWikiUtil::makeUrlTitle($new_name));
                    $this->tpl->setOnScreenMessage('success', $lng->txt("msg_obj_modified"), true);
                    $ilCtrl->redirect($this, "preview");
                }
            }
        }
 
        $this->form->setValuesByPost();
        $tpl->setContent($this->form->getHTML());
    }

References $lng, ILIAS\Repository\form(), ILIAS\Survey\Mode\getId(), getLanguage(), ilWikiPage\getPageIdForTitle(), ilWikiUtil\makeDbTitle(), and ilWikiUtil\makeUrlTitle().

Here is the call graph for this function:

renameWikiPage()

ilWikiPageGUI::renameWikiPage

(

)

Definition at line 871 of file class.ilWikiPageGUI.php.

                                    : void
    {
        $ilAccess = $this->access;
        $tpl = $this->tpl;
 
        if (($ilAccess->checkAccess(
            "edit_content",
            "",
            $this->requested_ref_id
        ) && !$this->getPageObject()->getBlocked())
            || $ilAccess->checkAccess("write", "", $this->requested_ref_id)) {
            $this->ctrl->setParameterByClass(ilWikiPageGUI::class, "wpg_id", $this->wiki_request->getWikiPageId());
            $this->initRenameForm();
            $tpl->setContent($this->form->getHTML());
        }
    }

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

Here is the call graph for this function:

searchWikiLinkAC()

ilWikiPageGUI::searchWikiLinkAC

(

)

Search wiki link list.

Definition at line 1218 of file class.ilWikiPageGUI.php.

                                      : void
    {
        $lng = $this->lng;
 
        $lng->loadLanguageModule("wiki");
 
        $tpl = new ilTemplate("tpl.wiki_ac_search_result.html", true, true, "components/ILIAS/Wiki");
        $term = $this->wiki_request->getTerm();
 
        $pages = ilObjWiki::_performSearch($this->getPageObject()->getParentId(), $term);
 
        $found = array();
        foreach ($pages as $page) {
            $found[] = array("page_id" => $page["page_id"], "title" => ilWikiPage::lookupTitle($page["page_id"]));
        }
 
        // sort if all pages are listed
        if ($term === "") {
            $found = ilArrayUtil::sortArray($found, "title", "asc");
        }
 
        foreach ($found as $f) {
            $tpl->setCurrentBlock("item");
            $tpl->setVariable("WIKI_TITLE", $f["title"]);
            $tpl->parseCurrentBlock();
        }
 
        if (count($pages) === 0) {
            $tpl->setVariable("INFOTEXT", str_replace("$1", $term, $lng->txt("wiki_no_page_found")));
        } elseif ($term === '') {
            $tpl->setVariable("INFOTEXT", $lng->txt("wiki_no_search_term"));
        } else {
            $tpl->setVariable("INFOTEXT", str_replace("$1", $term, $lng->txt("wiki_pages_found")));
        }
 
        $tpl->setVariable("TXT_BACK", $lng->txt("back"));
        echo $tpl->get();
        exit;
    }

References Vendor\Package\$f, $lng, ilObjWiki\_performSearch(), exit, ilWikiPage\lookupTitle(), and ilArrayUtil\sortArray().

Here is the call graph for this function:

setScreenIdComponent()

ilWikiPageGUI::setScreenIdComponent

(

)

Reimplemented from ilPageObjectGUI.

Definition at line 81 of file class.ilWikiPageGUI.php.

                                          : void
    {
        $ilHelp = $this->help;
        $ilHelp->setScreenIdComponent("copgwpg");
    }

References ilPageObjectGUI\$help, and ilHelpGUI\setScreenIdComponent().

Here is the call graph for this function:

setSideBlock()

ilWikiPageGUI::setSideBlock

(

)

Definition at line 241 of file class.ilWikiPageGUI.php.

                                  : void
    {
        ilObjWikiGUI::renderSideBlock(
            $this->getWikiPage()->getId(),
            $this->wiki_ref_id,
            $this->getWikiPage()
        );
    }

References ilPageObjectGUI\getId(), and ilObjWikiGUI\renderSideBlock().

Here is the call graph for this function:

setWiki()

ilWikiPageGUI::setWiki

(

ilObjWiki

$a_val

)

Definition at line 97 of file class.ilWikiPageGUI.php.

                                             : void
    {
        $this->wiki = $a_val;
    }

setWikiPage()

ilWikiPageGUI::setWikiPage

(

ilWikiPage

$a_wikipage

)

Definition at line 229 of file class.ilWikiPageGUI.php.

                                                       : void
    {
        $this->setPageObject($a_wikipage);
    }

References ilPageObjectGUI\setPageObject().

Here is the call graph for this function:

setWikiRefId()

ilWikiPageGUI::setWikiRefId

(

int

$a_ref_id

)

Definition at line 87 of file class.ilWikiPageGUI.php.

                                               : void
    {
        $this->wiki_ref_id = $a_ref_id;
    }

showPage()

ilWikiPageGUI::showPage

(

)

display content of page

Reimplemented from ilPageObjectGUI.

Definition at line 447 of file class.ilWikiPageGUI.php.

                              : string
    {
        if ($this->getOutputMode() === ilPageObjectGUI::PRESENTATION && !$this->getAbstractOnly()) {
            $this->initToolbar();
        }
        $this->setTemplateOutput(false);
 
        if (!$this->getAbstractOnly()) {
            $this->setPresentationTitle($this->getWikiPage()->getTitle());
 
            // wiki stats clean up
            // $this->increaseViewCount();
        }
 
        return parent::showPage();
    }

References ILIAS\GlobalScreen\Scope\Footer\Factory\getTitle(), and ilPageObjectGUI\PRESENTATION.

Here is the call graph for this function:

unblockWikiPage()

ilWikiPageGUI::unblockWikiPage

(

)

Definition at line 851 of file class.ilWikiPageGUI.php.

                                     : void
    {
        $ilCtrl = $this->ctrl;
        $lng = $this->lng;
 
        if (ilWikiPerm::check("activate_wiki_protection", $this->requested_ref_id)) {
            $this->getPageObject()->setBlocked(false);
            $this->getPageObject()->update();
 
            $this->tpl->setOnScreenMessage('success', $lng->txt("wiki_page_unblocked"), true);
        }
 
        $ilCtrl->redirect($this, "preview");
    }

References $lng, and ilWikiPerm\check().

Here is the call graph for this function:

unhideAdvancedMetaData()

ilWikiPageGUI::unhideAdvancedMetaData

(

)

Definition at line 1107 of file class.ilWikiPageGUI.php.

                                            : void
    {
        $ilCtrl = $this->ctrl;
        $lng = $this->lng;
        $ilAccess = $this->access;
 
        if (!$ilAccess->checkAccess("write", "", $this->wiki_ref_id) &&
            !$ilAccess->checkAccess("edit_page_meta", "", $this->wiki_ref_id)) {
            return;
        }
 
        $this->getPageObject()->hideAdvancedMetadata(false);
        $this->getPageObject()->update();
 
        $this->tpl->setOnScreenMessage('success', $lng->txt("settings_saved"), true);
        $ilCtrl->redirect($this, "preview");
    }

References $lng.

updateAdvancedMetaData()

ilWikiPageGUI::updateAdvancedMetaData

(

)

Definition at line 1063 of file class.ilWikiPageGUI.php.

                                            : void
    {
        $ilCtrl = $this->ctrl;
        $lng = $this->lng;
        $ilAccess = $this->access;
 
        if (!$ilAccess->checkAccess("write", "", $this->wiki_ref_id) &&
            !$ilAccess->checkAccess("edit_page_meta", "", $this->wiki_ref_id)) {
            return;
        }
 
        $form = $this->initAdvancedMetaDataForm();
 
        // needed for proper advanced MD validation
        $form->checkInput();
        if (!$this->record_gui->importEditFormPostValues()) {
            $this->editAdvancedMetaData($form); // #16470
            return;
        }
 
        if ($this->record_gui->writeEditForm()) {
            $this->tpl->setOnScreenMessage('success', $lng->txt("settings_saved"), true);
        }
        $ilCtrl->redirect($this, "preview");
    }

References $lng.

updateStatsRating()

ilWikiPageGUI::updateStatsRating	(	int	$a_wiki_id,
		string	$a_wiki_type,
		int	$a_page_id,
		string	$a_page_type
	)

Definition at line 992 of file class.ilWikiPageGUI.php.

     : void {
        ilWikiStat::handleEvent(ilWikiStat::EVENT_PAGE_RATING, $this->getWikiPage());
    }

whatLinksHere()

ilWikiPageGUI::whatLinksHere

(

)

Definition at line 609 of file class.ilWikiPageGUI.php.

                                   : void
    {
        $tpl = $this->tpl;
 
        //$this->setSideBlock();
        $table_gui = new ilWikiPagesTableGUI(
            $this,
            "whatLinksHere",
            $this->getWikiPage()->getWikiId(),
            IL_WIKI_WHAT_LINKS_HERE,
            $this->getId(),
            $this->wiki_request->getTranslation()
        );
 
        $tpl->setContent($table_gui->getHTML());
    }

References ILIAS\Survey\Mode\getId(), and IL_WIKI_WHAT_LINKS_HERE.

Here is the call graph for this function:

Field Documentation

$domain

ILIAS Wiki InternalDomainService ilWikiPageGUI::$domain

protected

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

$exc_domain

ILIAS Exercise InternalDomainService ilWikiPageGUI::$exc_domain

protected

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

$fill_on_load_code

bool ilWikiPageGUI::$fill_on_load_code = false

protected

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

$http

ILIAS HTTP Services ilWikiPageGUI::$http

protected

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

$notes

ILIAS Notes Service ilWikiPageGUI::$notes

protected

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

$ot

Translations ilWikiPageGUI::$ot

protected

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

$record_gui

ilAdvancedMDRecordGUI ilWikiPageGUI::$record_gui = null

protected

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

$settings

ilSetting ilWikiPageGUI::$settings

protected

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

$wiki

ilObjWiki ilWikiPageGUI::$wiki

protected

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

Referenced by getWiki().

$wiki_gui

ILIAS Wiki InternalGUIService ilWikiPageGUI::$wiki_gui

protected

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

$wiki_pm

ILIAS Wiki Page PageManager ilWikiPageGUI::$wiki_pm

protected

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

$wiki_ref_id

int ilWikiPageGUI::$wiki_ref_id = 0

protected

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

Referenced by getWikiRefId().

$wiki_request

ILIAS Wiki WikiGUIRequest ilWikiPageGUI::$wiki_request

protected

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

---

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

• components/ILIAS/Wiki/classes/class.ilWikiPageGUI.php