ilWikiPageGUI Class Reference

Class ilWikiPage GUI class. More...

Inheritance diagram for ilWikiPageGUI:

Collaboration diagram for ilWikiPageGUI:

Public Member Functions
	__construct ($a_id=0, $a_old_nr=0, $a_wiki_ref_id=0)
	Constructor. More...
	setScreenIdComponent ()
	Set screen id component. More...
	setWikiRefId ($a_ref_id)
	getWikiRefId ()
&	executeCommand ()
	execute command More...
	setWikiPage ($a_wikipage)
	Set Wiki Page Object. More...
	getWikiPage ()
	Get Wiki Page Object. More...
	setSideBlock ()
	addHeaderAction ($a_redraw=false)
	redrawHeaderAction ()
	preview ()
	View wiki page. More...
	showPage ()
	postOutputProcessing ($a_output)
	Finalizing output processing. More...
	whatLinksHere ()
	All links to a specific page. More...
	getTabs ($a_activate="")
	deleteWikiPageConfirmationScreen ()
	Delete wiki page confirmation screen. More...
	cancelWikiPageDeletion ()
	Cancel wiki page deletion. More...
	confirmWikiPageDeletion ()
	Delete the wiki page. More...
	printViewSelection ()
	Print view selection. More...
	initPrintViewSelectionForm ()
	Init print view selection form. More...
	blockWikiPage ()
	Block. More...
	unblockWikiPage ()
	Unblock. More...
	renameWikiPage ()
	Rename wiki page form. More...
	renamePage ()
	Rename page. More...
	activateWikiPageRating ()
	Rating /. More...
	deactivateWikiPageRating ()
	observeNoteAction ($a_wiki_id, $a_page_id, $a_type, $a_action, $a_note_id)
Public Member Functions inherited from ilPageObjectGUI
	ilPageObjectGUI ($a_parent_type, $a_id, $a_old_nr=0, $a_prevent_get_id=false, $a_lang="")
	Constructor. More...
	afterConstructor ()
	After constructor. More...
	setParentType ($a_val)
	Set parent type. More...
	getParentType ()
	Get parent type. More...
	setId ($a_val)
	Set ID. More...
	getId ()
	Get ID. More...
	setOldNr ($a_val)
	Set old nr (historic page) More...
	getOldNr ()
	Get old nr (historic page) More...
	setLanguage ($a_val)
	Set language. More...
	getLanguage ()
	Get language. More...
	setEnablePCType ($a_pc_type, $a_val)
	Set enable pc type. More...
	getEnablePCType ($a_pc_type)
	Get enable pc type. More...
	setPageConfig ($a_val)
	Set page config object. More...
	getPageConfig ()
	Get page config object. More...
	setBibId ($a_id)
	Set Bib Id. More...
	getBibId ()
	Get Bib Id. More...
	setPageObject ($a_pg_obj)
	Set Page Object. More...
	getPageObject ()
	Get Page Object. More...
	setOutputMode ($a_mode=IL_PAGE_PRESENTATION)
	Set Output Mode. More...
	getOutputMode ()
	setTemplateOutput ($a_output=true)
	outputToTemplate ()
	setPresentationTitle ($a_title="")
	getPresentationTitle ()
	setHeader ($a_title="")
	getHeader ()
	setLinkParams ($l_params="")
	getLinkParams ()
	setLinkFrame ($l_frame="")
	getLinkFrame ()
	setLinkXML ($link_xml)
	getLinkXML ()
	setQuestionXML ($question_xml)
	setQuestionHTML ($question_html)
	getQuestionXML ()
	getQuestionHTML ()
	setTemplateTargetVar ($a_variable)
	getTemplateTargetVar ()
	setTemplateOutputVar ($a_value)
	getTemplateOutputVar ()
	setSourcecodeDownloadScript ($script_name)
	getSourcecodeDownloadScript ()
	enableCitation ($a_enabled)
	isEnabledCitation ()
	setLocator (&$a_locator)
	setTabs ($a_tabs)
	setPageBackTitle ($a_title)
	setFileDownloadLink ($a_download_link)
	getFileDownloadLink ()
	setFullscreenLink ($a_fullscreen_link)
	getFullscreenLink ()
	setIntLinkReturn ($a_return)
	enableChangeComments ($a_enabled)
	isEnabledChangeComments ()
	enableNotes ($a_enabled, $a_parent_id)
	isEnabledNotes ()
	setOfflineDirectory ($offdir)
	set offline directory to offdir More...
	getOfflineDirectory ()
	get offline directory More...
	setViewPageLink ($a_link, $a_target="")
	set link for "view page" button More...
	getViewPageLink ()
	get view page link More...
	getViewPageTarget ()
	get view page target frame More...
	setActivationListener (&$a_obj, $a_meth)
	setEnabledNews ($a_enabled, $a_news_obj_id=0, $a_news_obj_type=0)
	Set enabled news. More...
	getEnabledNews ()
	Get enabled news. More...
	setTabHook ($a_object, $a_function)
	Set tab hook. More...
	setEditPreview ($a_editpreview)
	Set Display first Edit tab, then Preview tab, instead of Page and Edit. More...
	getEditPreview ()
	Get Display first Edit tab, then Preview tab, instead of Page and Edit. More...
	setEnabledTabs ($a_enabledtabs)
	Set Output tabs. More...
	getEnabledTabs ()
	Get Output tabs. More...
	setEnabledPageFocus ($a_enabledpagefocus)
	Set Enable page focus. More...
	getEnabledPageFocus ()
	Get Enable page focus. More...
	setExplorerUpdater ($a_exp_frame, $a_exp_id, $a_exp_target_script)
	Set Explorer Updater. More...
	setPrependingHtml ($a_prependinghtml)
	Set Prepending HTML. More...
	getPrependingHtml ()
	Get Prepending HTML. More...
	setEnableEditing ($a_enableediting)
	Set Enable Editing. More...
	getEnableEditing ()
	Get Enable Editing. More...
	setRawPageContent ($a_rawpagecontent)
	Set Get raw page content only. More...
	getRawPageContent ()
	Get Get raw page content only. More...
	setStyleId ($a_styleid)
	Set Style Id. More...
	getStyleId ()
	Get Style Id. More...
	setCompareMode ($a_val)
	Set compare mode. More...
	getCompareMode ()
	Get compare mode. More...
	setAbstractOnly ($a_val)
	Set abstract only. More...
	getAbstractOnly ()
	Get abstract only. More...
	setRenderPageContainer ($a_val)
	Set render page container. More...
	getRenderPageContainer ()
	Get render page container. More...
	activateMetaDataEditor ($a_rep_obj_id, $a_sub_obj_id, $a_type, $a_observer_obj=NULL, $a_observer_func="")
	Activate meda data editor. More...
	determineFileDownloadLink ()
	Determine file download link. More...
	determineFullscreenLink ()
	Determine fullscreen link. More...
	determineSourcecodeDownloadScript ()
	Determine source code download script. More...
	getComponentPluginsXML ()
	Put information about activated plugins into XML. More...
&	executeCommand ()
	execute command More...
	setQEditTabs ($a_active)
	Set question editing tabs. More...
	onFeedbackEditingForwarding ()
	On feedback editing forwarding. More...
	deactivatePage ()
	activatePage ()
	showPage ()
	replaceCurlyBrackets ($output)
	Replace curly brackets. More...
	addActionsMenu ($a_tpl, $sel_media_mode, $sel_html_mode, $sel_js_mode)
	Add actions menu. More...
	addMultiLangActionsAndInfo ($a_list, $a_tpl)
	Add multi-language actions to menu. More...
	setEditMode ()
	Set edit mode. More...
	setDefaultLinkXml ()
	Set standard link xml. More...
	downloadFile ()
	Download file of file lists. More...
	displayMediaFullscreen ()
	Show media in fullscreen mode. More...
	displayMedia ($a_fullscreen=false)
	Display media. More...
	download_paragraph ()
	download source code paragraph More...
	insertContentIncludes ($a_html)
	Insert content includes. More...
	insertPageToc ($a_output)
	Insert page toc. More...
	insertResources ($a_output)
	Insert resources. More...
	insertAdvTrigger ($a_output)
	Insert adv content trigger. More...
	postOutputProcessing ($a_output)
	Finalizing output processing. More...
	insertHelp ($a_tpl)
	Insert help texts. More...
	preview ()
	preview More...
	edit ()
	edit ("view" before) More...
	insertJSAtPlaceholder ()
	InsertJS at placeholder. More...
	presentation ($a_mode=IL_PAGE_PRESENTATION)
	getHTML ()
	showMediaFullscreen ($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 ()
	Set screen id component. More...
	getTabs ($a_activate="")
	adds tabs to tab gui object More...
	compareVersion ()
	Compares two revisions of the page. More...
	replaceDiffTags ($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 ($a_content_object=null, $a_enable_private_notes=true, $a_enable_public_notes=false, $a_enable_notes_deletion=false, $a_callback=null)
	Get html for public and/or private notes. More...
	getQuestionJsOfPage ($a_no_interaction=false)
	Get question js. More...
	initSelfAssessmentRendering ($a_force_no_form=false)
	Init question handling. More...
	processAnswer ()
	Process answer. More...
	selfAssessmentRendering ($a_output)
	Self assessment question rendering. More...
	initialOpenedContent ()
	Initially opened content. More...
	initOpenedContentForm ()
	Init form for initially opened content. More...
	saveInitialOpenedContent ()
	Save initial opened content. More...
	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...

Static Public Member Functions
static	getGUIForTitle ($a_wiki_id, $a_title, $a_old_nr=0, $a_wiki_ref_id=0)
	Get wiki page gui for id and title. More...
Static Public Member Functions inherited from ilPageObjectGUI
static	getTinyMenu ($a_par_type, $a_int_links=false, $a_wiki_links=false, $a_keywords=false, $a_style_id=0, $a_paragraph_styles=true, $a_save_return=true, $a_anchors=false, $a_save_new=true)
	Get Tiny Menu. More...
static	addPreparationJavascript ($a_tpl, $a_lang)
	Add standard texts. More...
static	getJSTextInitCode ($a_lang)
	Get js txt init code. More...

Protected Member Functions
	increaseViewCount ()
	initRenameForm ()
	Init renaming form. More...
Protected Member Functions inherited from ilPageObjectGUI
	initPageObject ()
	Init page object. More...
	getActivationCaptions ()
	Get captions for activation action menu entries. More...

Additional Inherited Members
Data Fields inherited from ilPageObjectGUI
	$tpl
	$lng
	$ctrl
	$obj
	$output_mode
	$presentation_title
	$target_script
	$return_location
	$target_var
	$template_output_var
	$output2template
	$link_params
	$bib_id
	$citation
	$sourcecode_download_script
	$change_comments
	$question_html
	$activation = false
	$activated = true
	$editpreview = false
	$use_meta_data = false
	$link_xml_set = false
	$enableediting = true
	$rawpagecontent = false
	$enabledcontentincludes = false
	$compare_mode = false
	$page_config = null
	$tabs_enabled = true
	$render_page_container = false
	$pl_start = "{{{{{"
	$pl_end = "}}}}}"
Protected Attributes inherited from ilPageObjectGUI
	$parent_type = ""

Detailed Description

Class ilWikiPage GUI class.

Author

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

Version

$Id$

ilWikiPageGUI: ilPageEditorGUI, ilEditClipboardGUI, ilMediaPoolTargetSelector ilWikiPageGUI: ilPublicUserProfileGUI, ilPageObjectGUI, ilNoteGUI ilWikiPageGUI: ilCommonActionDispatcherGUI, ilRatingGUI

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

Constructor & Destructor Documentation

__construct()

ilWikiPageGUI::__construct	(		$a_id = 0,
			$a_old_nr = 0,
			$a_wiki_ref_id = 0
	)

Constructor.

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

References ilPageObjectGUI\$tpl, ilPageObjectGUI\getPageObject(), ilObjStyleSheet\getSyntaxStylePath(), getWikiRefId(), and setWikiRefId().

        {
                global $tpl;

                // needed for notifications
                $this->setWikiRefId($a_wiki_ref_id);
                
                parent::__construct("wpg", $a_id, $a_old_nr);
                $this->getPageObject()->setWikiRefId($this->getWikiRefId());
                
                // content style
                include_once("./Services/Style/classes/class.ilObjStyleSheet.php");
                
                $tpl->setCurrentBlock("SyntaxStyle");
                $tpl->setVariable("LOCATION_SYNTAX_STYLESHEET",
                        ilObjStyleSheet::getSyntaxStylePath());
                $tpl->parseCurrentBlock();
        }

Here is the call graph for this function:

Member Function Documentation

activateWikiPageRating()

ilWikiPageGUI::activateWikiPageRating

(

)

Rating /.

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

References $ilCtrl, ilPageObjectGUI\$lng, ilPageObjectGUI\getPageObject(), and ilUtil\sendSuccess().

        {
                global $lng, $ilCtrl;
                
                $this->getPageObject()->setRating(true);
                $this->getPageObject()->update();
                
                ilUtil::sendSuccess($lng->txt("msg_obj_modified"), true);
                $ilCtrl->redirect($this, "preview");
        }

Here is the call graph for this function:

addHeaderAction()

ilWikiPageGUI::addHeaderAction

(

$a_redraw = false

)

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

References $_GET, $ilUser, ilObjWiki\_lookupPublicNotes(), ilObjWiki\_lookupRatingOverall(), ilUtil\getImagePath(), ilPageObjectGUI\getPageObject(), ilNotification\hasNotification(), ilCommonActionDispatcherGUI\TYPE_REPOSITORY, ilNotification\TYPE_WIKI, and ilNotification\TYPE_WIKI_PAGE.

Referenced by preview(), and redrawHeaderAction().

        {                       
                global $ilUser, $ilAccess;
                
                $wiki_id = $this->getPageObject()->getParentId();
                $page_id = $this->getPageObject()->getId();
                
                include_once "Services/Object/classes/class.ilCommonActionDispatcherGUI.php";
                $dispatcher = new ilCommonActionDispatcherGUI(ilCommonActionDispatcherGUI::TYPE_REPOSITORY, 
                        $ilAccess, "wiki", $_GET["ref_id"], $wiki_id);
                $dispatcher->setSubObject("wpg", $page_id);

                include_once "Services/Object/classes/class.ilObjectListGUI.php";
                ilObjectListGUI::prepareJSLinks($this->ctrl->getLinkTarget($this, "redrawHeaderAction", "", true),                      
                        $this->ctrl->getLinkTargetByClass(array("ilcommonactiondispatchergui", "ilnotegui"), "", "", true, false), 
                        $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"));
                }

                // notification
                if ($ilUser->getId() != ANONYMOUS_USER_ID)
                {
                        include_once "./Services/Notification/classes/class.ilNotification.php";
                        if(ilNotification::hasNotification(ilNotification::TYPE_WIKI, $ilUser->getId(), $wiki_id))
                        {
                                $this->ctrl->setParameter($this, "ntf", 1);
                                $lg->addCustomCommand($this->ctrl->getLinkTarget($this), "wiki_notification_deactivate_wiki");

                                $lg->addHeaderIcon("not_icon",
                                        ilUtil::getImagePath("notification_on.png"),
                                        $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("notification_on.png"),
                                                $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("notification_off.png"),
                                                $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();
                }
        }

Here is the call graph for this function:

Here is the caller graph for this function:

blockWikiPage()

ilWikiPageGUI::blockWikiPage

(

)

Block.

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

References $_GET, $ilCtrl, ilPageObjectGUI\$lng, ilPageObjectGUI\$tpl, ilPageObjectGUI\getPageObject(), and ilUtil\sendSuccess().

        {
                global $ilAccess, $tpl, $ilCtrl, $lng;

                if ($ilAccess->checkAccess("write", "", $_GET["ref_id"]))
                {
                        $this->getPageObject()->setBlocked(true);
                        $this->getPageObject()->update();

                        ilUtil::sendSuccess($lng->txt("wiki_page_blocked"), true);
                }

                $ilCtrl->redirect($this, "preview");
        }

Here is the call graph for this function:

cancelWikiPageDeletion()

ilWikiPageGUI::cancelWikiPageDeletion

(

)

Cancel wiki page deletion.

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

References $ilCtrl, and ilPageObjectGUI\$lng.

        {
                global $lng, $ilCtrl;
                
                $ilCtrl->redirect($this, "preview");
                
        }

confirmWikiPageDeletion()

ilWikiPageGUI::confirmWikiPageDeletion

(

)

Delete the wiki page.

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

References $_GET, $ilCtrl, ilPageObjectGUI\$lng, ilPageObjectGUI\$tpl, ilPageObjectGUI\getPageObject(), and ilUtil\sendSuccess().

        {
                global $ilAccess, $tpl, $ilCtrl, $lng;
                
                if ($ilAccess->checkAccess("write", "", $_GET["ref_id"]))
                {
                        $this->getPageObject()->delete();
                        
                        ilUtil::sendSuccess($lng->txt("wiki_page_deleted"), true);
                }
                
                $ilCtrl->redirectByClass("ilobjwikigui", "allPages");
        }

Here is the call graph for this function:

deactivateWikiPageRating()

ilWikiPageGUI::deactivateWikiPageRating

(

)

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

References $ilCtrl, ilPageObjectGUI\$lng, ilPageObjectGUI\getPageObject(), and ilUtil\sendSuccess().

        {
                global $lng, $ilCtrl;
                
                $this->getPageObject()->setRating(false);
                $this->getPageObject()->update();
                
                ilUtil::sendSuccess($lng->txt("msg_obj_modified"), true);
                $ilCtrl->redirect($this, "preview");
        }

Here is the call graph for this function:

deleteWikiPageConfirmationScreen()

ilWikiPageGUI::deleteWikiPageConfirmationScreen

(

)

Delete wiki page confirmation screen.

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

References $_GET, $ilCtrl, ilPageObjectGUI\$lng, ilPageObjectGUI\$tpl, ilPageObjectGUI\getId(), ilWikiPage\getLinksToPage(), ilWikiPage\getPageContributors(), ilPageObjectGUI\getPageObject(), ilNote\getUserCount(), and getWikiPage().

        {
                global $ilAccess, $tpl, $ilCtrl, $lng;
                
                if ($ilAccess->checkAccess("write", "", $_GET["ref_id"]))
                {
                        include_once("./Services/Utilities/classes/class.ilConfirmationGUI.php");
                        $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, "Modules/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::getPageContributors($this->getWikiPage()->getId());
                        foreach($contributors as $contributor)
                        {
                                $dtpl->setCurrentBlock("contributor");
                                $dtpl->setVariable("TXT_CONTRIBUTOR",
                                        $contributor["lastname"].", ".$contributor["firstname"]);
                                $dtpl->parseCurrentBlock();
                        }
                        
                        // notes/comments
                        include_once("./Services/Notes/classes/class.ilNote.php");
                        $cnt_note_users = ilNote::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());
                }
        }

Here is the call graph for this function:

executeCommand()

& ilWikiPageGUI::executeCommand

(

)

execute command

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

References $_GET, $cmd, $ilCtrl, $ilUser, ilPageObjectGUI\getId(), ilCommonActionDispatcherGUI\getInstanceFromAjaxCall(), ilPageObjectGUI\getPageObject(), getTabs(), getWikiPage(), preview(), ilNotification\setNotification(), ilPageObjectGUI\setPresentationTitle(), ilNotification\TYPE_WIKI, and ilNotification\TYPE_WIKI_PAGE.

        {
                global $ilCtrl, $ilTabs, $ilUser;
                
                $next_class = $this->ctrl->getNextClass($this);
                $cmd = $this->ctrl->getCmd();

                switch($next_class)
                {
                        case "ilnotegui":
                                $this->getTabs();
                                $ilTabs->setTabActive("pg");
                                return $this->preview();
                                break;
                                                
                        case "ilratinggui":                             
                                // for rating side block
                                include_once("./Services/Rating/classes/class.ilRatingGUI.php");
                                $rating_gui = new ilRatingGUI();
                                $rating_gui->setObject($this->getPageObject()->getParentId(), "wiki",
                                        $this->getPageObject()->getId(), "wpg");
                                $this->ctrl->forwardCommand($rating_gui);
                                $ilCtrl->redirect($this, "preview");
                                break;

                        case "ilpageobjectgui":
        die("Deprecated. Wikipage gui forwarding to ilpageobject");
                                return;
                                
                        case "ilcommonactiondispatchergui":
                                include_once("Services/Object/classes/class.ilCommonActionDispatcherGUI.php");
                                $gui = ilCommonActionDispatcherGUI::getInstanceFromAjaxCall();
                                $gui->enableCommentsSettings(false);
                                $gui->setRatingCallback($this, "preview");
                                $this->ctrl->forwardCommand($gui);
                                break;
                                
                        default:

                                if($_GET["ntf"])
                                {
                                        include_once "./Services/Notification/classes/class.ilNotification.php";
                    switch($_GET["ntf"])
                                    {
                                                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();
                }
        }

Here is the call graph for this function:

getGUIForTitle()

static ilWikiPageGUI::getGUIForTitle (   $a_wiki_id,   $a_title,   $a_old_nr = 0,   $a_wiki_ref_id = 0  )

static

Get wiki page gui for id and title.

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

References ilWikiPage\getPageIdForTitle().

Referenced by ilObjWikiGUI\executeCommand(), and ilObjWikiGUI\viewPageObject().

        {
                global $ilDB;

                include_once("./Modules/Wiki/classes/class.ilWikiPage.php");
                $id = ilWikiPage::getPageIdForTitle($a_wiki_id, $a_title);
                $page_gui = new ilWikiPageGUI($id, $a_old_nr, $a_wiki_ref_id);
                
                return $page_gui;
        }

Here is the call graph for this function:

Here is the caller graph for this function:

getTabs()

ilWikiPageGUI::getTabs

(

$a_activate = ""

)

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

References $_GET, $ilCtrl, ilWikiPage\getPageIdForTitle(), ilPageObjectGUI\getPageObject(), ilWikiUtil\makeDbTitle(), and ilWikiUtil\makeUrlTitle().

Referenced by executeCommand().

        {
                global $ilTabs, $ilCtrl;

                parent::getTabs($a_activate);
                
                $ilCtrl->setParameterByClass("ilobjwikigui", "wpg_id",
                        ilWikiPage::getPageIdForTitle($this->getPageObject()->getParentId(),
                        ilWikiUtil::makeDbTitle($_GET["page"])));
                $ilCtrl->setParameterByClass("ilobjwikigui", "page", ilWikiUtil::makeUrlTitle($_GET["page"]));

                $ilTabs->addTarget("wiki_what_links_here",
                        $this->ctrl->getLinkTargetByClass("ilwikipagegui",
                        "whatLinksHere"), "whatLinksHere");
                //$ilTabs->addTarget("wiki_print_view",
                //      $this->ctrl->getLinkTargetByClass("ilobjwikigui",
                //      "printViewSelection"), "printViewSelection");
                $ilTabs->addTarget("wiki_print_view",
                        $this->ctrl->getLinkTargetByClass("ilwikipagegui",
                        "printViewSelection"), "printViewSelection");

        }

Here is the call graph for this function:

Here is the caller graph for this function:

getWikiPage()

ilWikiPageGUI::getWikiPage

(

)

Get Wiki Page Object.

Returns

object Wiki Page Object

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

References ilPageObjectGUI\getPageObject().

Referenced by deleteWikiPageConfirmationScreen(), executeCommand(), increaseViewCount(), postOutputProcessing(), setSideBlock(), showPage(), and whatLinksHere().

        {
                return $this->getPageObject();
        }

Here is the call graph for this function:

Here is the caller graph for this function:

getWikiRefId()

ilWikiPageGUI::getWikiRefId

(

)

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

Referenced by __construct(), increaseViewCount(), initPrintViewSelectionForm(), and observeNoteAction().

    {
                return $this->wiki_ref_id;
        }

Here is the caller graph for this function:

increaseViewCount()

ilWikiPageGUI::increaseViewCount ( )

protected

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

References $ilUser, ilChangeEvent\_recordReadEvent(), getWikiPage(), and getWikiRefId().

Referenced by preview(), and showPage().

        {
                global $ilUser;
                
                $this->getWikiPage()->increaseViewCnt();
                
                // enable object statistics
                require_once('Services/Tracking/classes/class.ilChangeEvent.php');
                ilChangeEvent::_recordReadEvent("wiki", $this->getWikiPage()->getWikiRefId(),
                        $this->getWikiPage()->getWikiId(), $ilUser->getId());                   
        }

Here is the call graph for this function:

Here is the caller graph for this function:

initPrintViewSelectionForm()

ilWikiPageGUI::initPrintViewSelectionForm

(

)

Init print view selection form.

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

References $ilCtrl, ilPageObjectGUI\$lng, ilObject\_lookupObjId(), ilWikiPage\getAllPages(), ilUtil\getImagePath(), getWikiRefId(), and ilRadioGroupInputGUI\setValue().

Referenced by printViewSelection().

        {
                global $lng, $ilCtrl;

                $pages = ilWikiPage::getAllPages(ilObject::_lookupObjId($this->getWikiRefId()));

                include_once("Services/Form/classes/class.ilPropertyFormGUI.php");
                $this->form = new ilPropertyFormGUI();
//var_dump($pages);
                // selection type
                $radg = new ilRadioGroupInputGUI($lng->txt("cont_selection"), "sel_type");
                $radg->setValue("page");
                        $op1 = new ilRadioOption($lng->txt("cont_current_page"), "page");
                        $radg->addOption($op1);
                        $op2 = new ilRadioOption($lng->txt("wiki_whole_wiki")
                                ." (".$lng->txt("wiki_pages").": ".count($pages).")", "wiki");
                        $radg->addOption($op2);
                        $op3= new ilRadioOption($lng->txt("wiki_selected_pages"), "selection");
                        $radg->addOption($op3);

                        include_once("./Services/Form/classes/class.ilNestedListInputGUI.php");
                        $nl = new ilNestedListInputGUI("", "obj_id");
                        $op3->addSubItem($nl);

                        foreach ($pages as $p)
                        {
                                $nl->addListNode($p["id"], $p["title"], 0, false, false,
                                                ilUtil::getImagePath("icon_pg_s.png"), $lng->txt("wiki_page"));
                        }

                $this->form->addItem($radg);

                $this->form->addCommandButton("printView", $lng->txt("cont_show_print_view"));
                //$this->form->setOpenTag(false);
                //$this->form->setCloseTag(false);

                $this->form->setTitle($lng->txt("cont_print_selection"));
                $this->form->setFormAction($ilCtrl->getFormActionByClass("ilobjwikigui", "printView"),
                        false, "print_view");
        }

Here is the call graph for this function:

Here is the caller graph for this function:

initRenameForm()

ilWikiPageGUI::initRenameForm ( )

protected

Init renaming form.

Parameters

int

$a_mode

Edit Mode

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

References $ilCtrl, ilPageObjectGUI\$lng, ilPageObjectGUI\getPageObject(), and ilTextInputGUI\setMaxLength().

Referenced by renamePage(), and renameWikiPage().

        {
                global $lng, $ilCtrl;

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

Here is the call graph for this function:

Here is the caller graph for this function:

observeNoteAction()

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

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

References getWikiRefId(), ilWikiUtil\sendNotification(), and ilNotification\TYPE_WIKI_PAGE.

        {                       
                // #10040 - get note text
                include_once "Services/Notes/classes/class.ilNote.php";
                $note = new ilNote($a_note_id);
                $note = $note->getText();
                
                include_once "./Services/Notification/classes/class.ilNotification.php";
                ilWikiUtil::sendNotification("comment", ilNotification::TYPE_WIKI_PAGE, $this->getWikiRefId(), $a_page_id, $note);
        }

Here is the call graph for this function:

postOutputProcessing()

ilWikiPageGUI::postOutputProcessing

(

$a_output

)

Finalizing output processing.

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

References ilPageObjectGUI\getOutputMode(), getWikiPage(), and ilWikiUtil\replaceInternalLinks().

        {
//echo htmlentities($a_output);
                include_once("./Modules/Wiki/classes/class.ilWikiUtil.php");
                $output = ilWikiUtil::replaceInternalLinks($a_output,
                        $this->getWikiPage()->getWikiId(),
                        ($this->getOutputMode() == "offline"));
                return $output;
        }

Here is the call graph for this function:

preview()

ilWikiPageGUI::preview

(

)

View wiki page.

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

References $_GET, $ilCtrl, $ilSetting, $ilUser, ilPageObjectGUI\$lng, ilPageObjectGUI\$tpl, ilUserSearchCache\_getInstance(), ilObjWiki\_lookupPublicNotes(), addHeaderAction(), ilDatePresentation\formatDate(), ilUserUtil\getNamePresentation(), ilPageObjectGUI\getNotesHTML(), ilPageObjectGUI\getPageObject(), ilTextHighlighterGUI\highlight(), IL_CAL_DATETIME, IL_PAGE_PRESENTATION, increaseViewCount(), ilUserSearchCache\LAST_QUERY, ilWikiUtil\makeUrlTitle(), ilUtil\sendInfo(), ilPageObjectGUI\setOutputMode(), ilPageObjectGUI\setRenderPageContainer(), setSideBlock(), and showPage().

Referenced by executeCommand().

        {
                global $ilCtrl, $ilAccess, $lng, $tpl, $ilUser, $ilSetting, $ilToolbar;

                // block/unblock
                if ($this->getPageObject()->getBlocked())
                {
                        ilUtil::sendInfo($lng->txt("wiki_page_status_blocked"));
                }

                $this->increaseViewCount();
                                
                $this->addHeaderAction();
                
                // content
                $this->setSideBlock();
                
                $wtpl = new ilTemplate("tpl.wiki_page_view_main_column.html",
                        true, true, "Modules/Wiki");
                
                $callback = array($this, "observeNoteAction");
                
                // notes
                if (!$ilSetting->get("disable_comments") &&
                        ilObjWiki::_lookupPublicNotes($this->getPageObject()->getParentId()))
                {
                        $wtpl->setVariable("NOTES", $this->getNotesHTML($this->getPageObject(),
                                true, ilObjWiki::_lookupPublicNotes($this->getPageObject()->getParentId()),
                                $ilAccess->checkAccess("write", "", $_GET["ref_id"]), $callback));
                }
                
                // permanent link
                $append = ($_GET["page"] != "")
                        ? "_".ilWikiUtil::makeUrlTitle($_GET["page"])
                        : "";
                include_once("./Services/PermanentLink/classes/class.ilPermanentLinkGUI.php");
                $perma_link = new ilPermanentLinkGUI("wiki", $_GET["ref_id"], $append);
                $wtpl->setVariable("PERMA_LINK", $perma_link->getHTML());

                // page content
                $this->setOutputMode(IL_PAGE_PRESENTATION);
                $this->setRenderPageContainer(true);
                $wtpl->setVariable("PAGE", $this->showPage());

                $tpl->setLoginTargetPar("wiki_".$_GET["ref_id"].$append);

                // last edited info
                include_once("./Services/User/classes/class.ilUserUtil.php");
                $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_".$_GET["ref_id"].$append);
                
                //highlighting
                if ($_GET["srcstring"] != "")
                {
                        include_once './Services/Search/classes/class.ilUserSearchCache.php';
                        $cache =  ilUserSearchCache::_getInstance($ilUser->getId());
                        $cache->switchSearchType(ilUserSearchCache::LAST_QUERY);
                        $search_string = $cache->getQuery();

                        include_once("./Services/UIComponent/TextHighlighter/classes/class.ilTextHighlighterGUI.php");
                        include_once("./Services/Search/classes/class.ilQueryParser.php");
                        $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 $wtpl->get();
        }

Here is the call graph for this function:

Here is the caller graph for this function:

printViewSelection()

ilWikiPageGUI::printViewSelection

(

)

Print view selection.

Parameters

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

References $ilCtrl, $ilUser, ilPageObjectGUI\$lng, ilPageObjectGUI\$tpl, and initPrintViewSelectionForm().

        {
                global $ilUser, $lng, $ilToolbar, $ilCtrl, $tpl;

                /*$ilToolbar->setFormAction($ilCtrl->getFormActionByClass("ilobjwikigui", "printView"),
                        false, "print_view");
                $ilToolbar->addFormButton($lng->txt("cont_show_print_view"), "printView");
                $ilToolbar->setCloseFormTag(false);*/

                $this->initPrintViewSelectionForm();

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

Here is the call graph for this function:

redrawHeaderAction()

ilWikiPageGUI::redrawHeaderAction

(

)

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

References addHeaderAction(), and exit.

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

Here is the call graph for this function:

renamePage()

ilWikiPageGUI::renamePage

(

)

Rename page.

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

References $_GET, $ilCtrl, ilPageObjectGUI\$lng, ilPageObjectGUI\$tpl, ilWikiPage\_getPageIdForWikiTitle(), ilPageObjectGUI\getId(), ilPageObjectGUI\getPageObject(), initRenameForm(), ilWikiUtil\makeDbTitle(), ilWikiUtil\makeUrlTitle(), ilUtil\sendFailure(), and ilUtil\sendSuccess().

        {
                global $tpl, $lng, $ilCtrl, $ilAccess;

                $this->initRenameForm();
                if ($this->form->checkInput())
                {
                        if ($ilAccess->checkAccess("edit_content", "", $_GET["ref_id"]))
                        {
                                $new_name = $this->form->getInput("new_page_name");
                                
                                $page_title = ilWikiUtil::makeDbTitle($new_name);
                                $pg_id = ilWikiPage::_getPageIdForWikiTitle($this->getPageObject()->getWikiId(), $page_title);

                                // 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())
                                {
                                        ilUtil::sendFailure($lng->txt("wiki_page_already_exists"));
                                }
                                else
                                {
                                        $new_name = $this->getPageObject()->rename($new_name);
                                        $ilCtrl->setParameterByClass("ilobjwikigui", "page", ilWikiUtil::makeUrlTitle($new_name));
                                        ilUtil::sendSuccess($lng->txt("msg_obj_modified"), true);
                                        $ilCtrl->redirect($this, "preview");
                                }
                        }
                }

                $this->form->setValuesByPost();
                $tpl->setContent($this->form->getHtml());
        }

Here is the call graph for this function:

renameWikiPage()

ilWikiPageGUI::renameWikiPage

(

)

Rename wiki page form.

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

References $_GET, $ilCtrl, ilPageObjectGUI\$lng, ilPageObjectGUI\$tpl, and initRenameForm().

        {
                global $ilAccess, $tpl, $ilCtrl, $lng;

                if ($ilAccess->checkAccess("edit_content", "", $_GET["ref_id"]))
                {
                        $this->initRenameForm();
                        $tpl->setContent($this->form->getHTML());
                }
        }

Here is the call graph for this function:

setScreenIdComponent()

ilWikiPageGUI::setScreenIdComponent

(

)

Set screen id component.

Parameters

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

        {
                global $ilHelp;
                
                $ilHelp->setScreenIdComponent("copgwpg");
        }

setSideBlock()

ilWikiPageGUI::setSideBlock

(

)

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

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

Referenced by preview(), and whatLinksHere().

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

Here is the call graph for this function:

Here is the caller graph for this function:

setWikiPage()

ilWikiPageGUI::setWikiPage

(

$a_wikipage

)

Set Wiki Page Object.

Parameters

object

$a_wikipage

Wiki Page Object

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

References ilPageObjectGUI\setPageObject().

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

Here is the call graph for this function:

setWikiRefId()

ilWikiPageGUI::setWikiRefId

(

$a_ref_id

)

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

Referenced by __construct().

    {
                $this->wiki_ref_id = $a_ref_id;
        }

Here is the caller graph for this function:

showPage()

ilWikiPageGUI::showPage

(

)

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

References $ilCtrl, ilPageObjectGUI\$tpl, getWikiPage(), increaseViewCount(), ilPageObjectGUI\setPresentationTitle(), and ilPageObjectGUI\setTemplateOutput().

Referenced by preview().

        {
                global $tpl, $ilCtrl;
                
                // content style
/*              include_once("./Services/Style/classes/class.ilObjStyleSheet.php");
                $tpl->setCurrentBlock("ContentStyle");
                $tpl->setVariable("LOCATION_CONTENT_STYLESHEET",
                        ilObjStyleSheet::getContentStylePath(0));
                $tpl->parseCurrentBlock();
*/
                $this->setTemplateOutput(false);
                $this->setPresentationTitle($this->getWikiPage()->getTitle());
                $this->increaseViewCount();                     
                $output = parent::showPage();
                
                return $output;
        }

Here is the call graph for this function:

Here is the caller graph for this function:

unblockWikiPage()

ilWikiPageGUI::unblockWikiPage

(

)

Unblock.

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

References $_GET, $ilCtrl, ilPageObjectGUI\$lng, ilPageObjectGUI\$tpl, ilPageObjectGUI\getPageObject(), and ilUtil\sendSuccess().

        {
                global $ilAccess, $tpl, $ilCtrl, $lng;

                if ($ilAccess->checkAccess("write", "", $_GET["ref_id"]))
                {
                        $this->getPageObject()->setBlocked(false);
                        $this->getPageObject()->update();

                        ilUtil::sendSuccess($lng->txt("wiki_page_unblocked"), true);
                }

                $ilCtrl->redirect($this, "preview");
        }

Here is the call graph for this function:

whatLinksHere()

ilWikiPageGUI::whatLinksHere

(

)

All links to a specific page.

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

References $_GET, ilPageObjectGUI\$tpl, getWikiPage(), IL_WIKI_WHAT_LINKS_HERE, and setSideBlock().

        {
                global $tpl;
                
                include_once("./Modules/Wiki/classes/class.ilWikiPagesTableGUI.php");
                
                $this->setSideBlock($_GET["wpg_id"]);
                $table_gui = new ilWikiPagesTableGUI($this, "whatLinksHere",
                        $this->getWikiPage()->getWikiId(), IL_WIKI_WHAT_LINKS_HERE, $_GET["wpg_id"]);
                        
                $tpl->setContent($table_gui->getHTML());
        }

Here is the call graph for this function:

---

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

• Modules/Wiki/classes/class.ilWikiPageGUI.php