ILIAS  Release_3_10_x_branch Revision 61812
 All Data Structures Namespaces Files Functions Variables Groups Pages
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)
 Constructor.
 initPageObject ($a_parent_type, $a_id, $a_old_nr)
executeCommand ()
 execute command
 setWikiPage ($a_wikipage)
 Set Wiki Page Object.
 getWikiPage ()
 Get Wiki Page Object.
 setSideBlock ()
 preview ()
 View wiki page.
 showPage ()
 postOutputProcessing ($a_output)
 Finalizing output processing.
 whatLinksHere ()
 All links to a specific page.
 getTabs ($a_activate="")
 adds tabs to tab gui object
 deleteWikiPageConfirmationScreen ()
 Delete wiki page confirmation screen.
 cancelWikiPageDeletion ()
 Cancel wiki page deletion.
 confirmWikiPageDeletion ()
 Delete the wiki page.
- Public Member Functions inherited from ilPageObjectGUI
 ilPageObjectGUI ($a_parent_type, $a_id=0, $a_old_nr=0)
 Constructor public.
 setBibId ($a_id)
 Set Bib Id.
 getBibId ()
 Get Bib Id.
 setPageObject ($a_pg_obj)
 Set Page Object.
 getPageObject ()
 Get Page Object.
 setOutputMode ($a_mode=IL_PAGE_PRESENTATION)
 Set Output Mode.
 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 ()
 setOutputSubmode ($a_mode)
 getOutputSubmode ()
 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 ()
 setIntLinkHelpDefault ($a_type, $a_id)
 setIntLinkReturn ($a_return)
 enableChangeComments ($a_enabled)
 isEnabledChangeComments ()
 setOfflineDirectory ($offdir)
 set offline directory to offdir
 getOfflineDirectory ()
 get offline directory
 setViewPageLink ($a_link, $a_target="")
 set link for "view page" button
 getViewPageLink ()
 get view page link
 getViewPageTarget ()
 get view page target frame
 setActivationListener (&$a_obj, $a_meth)
 setActivated ($a_act)
 getActivated ()
 setEnabledActivation ($a_act)
 getEnabledActivation ()
 setEnabledInternalLinks ($a_enabledinternallinks)
 Set Enable internal links.
 getEnabledInternalLinks ()
 Get Enable internal links.
 setEditPreview ($a_editpreview)
 Set Display first Edit tab, then Preview tab, instead of Page and Edit.
 getEditPreview ()
 Get Display first Edit tab, then Preview tab, instead of Page and Edit.
 setPreventHTMLUnmasking ($a_preventhtmlunmasking)
 Set Prevent HTML Unmasking (true/false).
 getPreventHTMLUnmasking ()
 Get Prevent HTML Unmasking (true/false).
 setEnabledTabs ($a_enabledtabs)
 Set Output tabs.
 getEnabledTabs ()
 Get Output tabs.
 setEnabledRepositoryObjects ($a_enabledrepositoryobjects)
 Set Enable Repository Objects Content Component.
 getEnabledRepositoryObjects ()
 Get Enable Repository Objects Content Component.
 setEnabledMaps ($a_enabledmaps)
 Set Enable Maps Content Component.
 getEnabledMaps ()
 Get Enable Maps Content Component.
 setEnabledPCTabs ($a_enabledpctabs)
 Set Enable Tabs Content Component.
 getEnabledPCTabs ()
 Get Enable Tabs Content Component.
 setEnabledFileLists ($a_enabledfilelists)
 Set Enable File Lists Content Componente (Default is true).
 getEnabledFileLists ()
 Get Enable File Lists Content Componente (Default is true).
 setEnabledPageFocus ($a_enabledpagefocus)
 Set Enable page focus.
 getEnabledPageFocus ()
 Get Enable page focus.
 setExplorerUpdater ($a_exp_frame, $a_exp_id, $a_exp_target_script)
 Set Explorer Updater.
 setPrependingHtml ($a_prependinghtml)
 Set Prepending HTML.
 getPrependingHtml ()
 Get Prepending HTML.
 setEnabledWikiLinks ($a_enablewikilinks)
 Set Enable Wiki Links.
 getEnabledWikiLinks ()
 Get Enable Wiki Links.
 setEnableEditing ($a_enableediting)
 Set Enable Editing.
 getEnableEditing ()
 Get Enable Editing.
 setRawPageContent ($a_rawpagecontent)
 Set Get raw page content only.
 getRawPageContent ()
 Get Get raw page content only.
 activateMetaDataEditor ($a_rep_obj_id, $a_sub_obj_id, $a_type, $a_observer_obj=NULL, $a_observer_func="")
 Activate meda data editor.
 getComponentPluginsXML ()
 Put information about activated plugins into XML.
 deactivatePage ()
 activatePage ()
 setDefaultLinkXml ()
 Set standard link xml.
 downloadFile ()
 Download file of file lists.
 displayMediaFullscreen ()
 Show media in fullscreen mode.
 download_paragraph ()
 download source code paragraph
 insertMaps ($a_html)
 Insert Maps.
 insertHelp ($a_tpl)
 Insert help texts.
 edit ()
 presentation ($a_mode=IL_PAGE_PRESENTATION)
 getHTML ()
 showMediaFullscreen ($a_style_id=0)
 show fullscreen view of media object
 displayValidationError ($a_error)
 display validation error
 history ()
 Get history table as HTML.
 rollbackConfirmation ()
 Rollback confirmation.
 rollback ()
 Rollback to a previous version.
 compareVersion ()
 Compares two revisions of the page.
 replaceDiffTags ($a_html)

Static Public Member Functions

static getGUIForTitle ($a_wiki_id, $a_title, $a_old_nr=0)
 Get wiki page gui for id and title.

Additional Inherited Members

- Data Fields inherited from ilPageObjectGUI
 $ilias
 $tpl
 $lng
 $ctrl
 $obj
 $output_mode
 $output_submode
 $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
 $enabledinternallinks = true
 $editpreview = false
 $use_meta_data = false
 $enabledtabs = true
 $enabledpctabs = false
 $link_xml_set = false
 $enableediting = true
 $rawpagecontent = false

Detailed Description

Constructor & Destructor Documentation

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

Constructor.

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

References ilPageObjectGUI\$tpl, ilObjStyleSheet\getContentStylePath(), ilObjStyleSheet\getSyntaxStylePath(), ilPageObjectGUI\setEnabledInternalLinks(), ilPageObjectGUI\setEnabledMaps(), ilPageObjectGUI\setEnabledWikiLinks(), and ilPageObjectGUI\setPreventHTMLUnmasking().

{
global $tpl;
parent::__construct("wpg", $a_id, $a_old_nr);
// content style
include_once("./Services/Style/classes/class.ilObjStyleSheet.php");
$tpl->setCurrentBlock("ContentStyle");
$tpl->setVariable("LOCATION_CONTENT_STYLESHEET",
$tpl->parseCurrentBlock();
$tpl->setCurrentBlock("SyntaxStyle");
$tpl->setVariable("LOCATION_SYNTAX_STYLESHEET",
$tpl->parseCurrentBlock();
$this->setEnabledMaps(true);
$this->setEnabledInternalLinks(false);
$this->setEnabledWikiLinks(true);
}

+ Here is the call graph for this function:

Member Function Documentation

ilWikiPageGUI::cancelWikiPageDeletion ( )

Cancel wiki page deletion.

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

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

{
global $lng, $ilCtrl;
ilUtil::sendInfo($lng->txt("action_aborted"), true);
$ilCtrl->redirect($this, "preview");
}

+ Here is the call graph for this function:

ilWikiPageGUI::confirmWikiPageDeletion ( )

Delete the wiki page.

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

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

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

+ Here is the call graph for this function:

ilWikiPageGUI::deleteWikiPageConfirmationScreen ( )

Delete wiki page confirmation screen.

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

References $_GET, $ilCtrl, ilPageObjectGUI\$lng, ilPageObjectGUI\$tpl, 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:

& ilWikiPageGUI::executeCommand ( )

execute command

Reimplemented from ilPageObjectGUI.

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

References $cmd, $ilCtrl, ilPageObjectGUI\getPageObject(), getTabs(), ilPageObjectGUI\ilPageObjectGUI(), and preview().

{
global $ilCtrl, $ilTabs;
$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":
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":
$page_gui = new ilPageObjectGUI("wpg",
$this->getPageObject()->getId(), $this->getPageObject()->old_nr);
return $ilCtrl->forwardCommand($page_gui);
default:
}
}

+ Here is the call graph for this function:

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

Get wiki page gui for id and title.

Definition at line 134 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);
return $page_gui;
}

+ Here is the call graph for this function:

+ Here is the caller graph for this function:

ilWikiPageGUI::getTabs (   $a_activate = "")

adds tabs to tab gui object

Parameters
object$tabs_guiilTabsGUI object

Reimplemented from ilPageObjectGUI.

Definition at line 291 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",
$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",
"printView"), "printView");
}

+ Here is the call graph for this function:

+ Here is the caller graph for this function:

ilWikiPageGUI::getWikiPage ( )

Get Wiki Page Object.

Returns
object Wiki Page Object

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

References ilPageObjectGUI\getPageObject().

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

{
return $this->getPageObject();
}

+ Here is the call graph for this function:

+ Here is the caller graph for this function:

ilWikiPageGUI::initPageObject (   $a_parent_type,
  $a_id,
  $a_old_nr 
)

Reimplemented from ilPageObjectGUI.

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

References ilPageObjectGUI\setPageObject().

{
$page = new ilWikiPage($a_id, $a_old_nr);
$this->setPageObject($page);
}

+ Here is the call graph for this function:

ilWikiPageGUI::postOutputProcessing (   $a_output)

Finalizing output processing.

Reimplemented from ilPageObjectGUI.

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

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

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

+ Here is the call graph for this function:

ilWikiPageGUI::preview ( )

View wiki page.

Reimplemented from ilPageObjectGUI.

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

References $_GET, $ilCtrl, ilPageObjectGUI\$lng, ilObjWiki\_lookupRating(), ilObjWiki\_lookupStartPage(), ilPageObjectGUI\getPageObject(), getWikiPage(), ilWikiUtil\makeUrlTitle(), and setSideBlock().

Referenced by executeCommand().

{
global $ilCtrl, $ilAccess, $lng;
$this->getWikiPage()->increaseViewCnt(); // todo: move to page object
$this->setSideBlock();
$wtpl = new ilTemplate("tpl.wiki_page_view_main_column.html",
true, true, "Modules/Wiki");
// wiki page commands
// delete
$page_commands = false;
if ($ilAccess->checkAccess("write", "", $_GET["ref_id"]))
{
$st_page = ilObjWiki::_lookupStartPage($this->getPageObject()->getParentId());
if ($st_page != $this->getPageObject()->getTitle())
{
$wtpl->setCurrentBlock("page_command");
$wtpl->setVariable("HREF_PAGE_CMD",
$ilCtrl->getLinkTarget($this, "deleteWikiPageConfirmationScreen"));
$wtpl->setVariable("TXT_PAGE_CMD", $lng->txt("delete"));
$wtpl->parseCurrentBlock();
}
}
if ($page_commands)
{
$wtpl->setCurrentBlock("page_commands");
$wtpl->parseCurrentBlock();
}
// rating
if (ilObjWiki::_lookupRating($this->getPageObject()->getParentId())
&& $this->getPageObject()->old_nr == 0)
{
include_once("./Services/Rating/classes/class.ilRatingGUI.php");
$rating_gui = new ilRatingGUI();
$rating_gui->setObject($this->getPageObject()->getParentId(), "wiki",
$this->getPageObject()->getId(), "wpg");
$wtpl->setVariable("RATING", $ilCtrl->getHtml($rating_gui));
}
// notes
include_once("Services/Notes/classes/class.ilNoteGUI.php");
$pg_id = $this->getPageObject()->getId();
$notes_gui = new ilNoteGUI($this->getPageObject()->getParentId(),
$pg_id, "wpg");
if ($ilAccess->checkAccess("write", "", $_GET["ref_id"]))
{
$notes_gui->enablePublicNotesDeletion(true);
}
$notes_gui->enablePrivateNotes();
//if ($this->lm->publicNotes())
//{
$notes_gui->enablePublicNotes();
//}
$next_class = $this->ctrl->getNextClass($this);
if ($next_class == "ilnotegui")
{
$html = $this->ctrl->forwardCommand($notes_gui);
}
else
{
$html = $notes_gui->getNotesHTML();
}
$wtpl->setVariable("NOTES", $html);
// permanent link
$append = ($_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());
$wtpl->setVariable("PAGE", parent::preview());
return $wtpl->get();
}

+ Here is the call graph for this function:

+ Here is the caller graph for this function:

ilWikiPageGUI::setSideBlock ( )

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

References ilPageObjectGUI\$tpl, and getWikiPage().

Referenced by preview(), and whatLinksHere().

{
global $tpl;
// side block
include_once("./Modules/Wiki/classes/class.ilWikiSideBlockGUI.php");
$wiki_side_block = new ilWikiSideBlockGUI();
$wiki_side_block->setPageObject($this->getWikiPage());
// search block
include_once("./Modules/Wiki/classes/class.ilWikiSearchBlockGUI.php");
$wiki_search_block = new ilWikiSearchBlockGUI();
$rcontent = $wiki_side_block->getHTML().$wiki_search_block->getHTML();
$tpl->setRightContent($rcontent);
}

+ Here is the call graph for this function:

+ Here is the caller graph for this function:

ilWikiPageGUI::setWikiPage (   $a_wikipage)

Set Wiki Page Object.

Parameters
object$a_wikipageWiki Page Object

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

References ilPageObjectGUI\setPageObject().

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

+ Here is the call graph for this function:

ilWikiPageGUI::showPage ( )

Reimplemented from ilPageObjectGUI.

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

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

{
global $tpl, $ilCtrl;
// content style
/* include_once("./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->getWikiPage()->increaseViewCnt();
$output = parent::showPage();
return $output;
}

+ Here is the call graph for this function:

ilWikiPageGUI::whatLinksHere ( )

All links to a specific page.

Definition at line 278 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: