ILIAS  Release_3_10_x_branch Revision 61812
 All Data Structures Namespaces Files Functions Variables Groups Pages
Public Member Functions | Static Public Member Functions
ilObjWikiGUI Class Reference

Class ilObjWikiGUI. More...

+ Inheritance diagram for ilObjWikiGUI:
+ Collaboration diagram for ilObjWikiGUI:

Public Member Functions

 ilObjWikiGUI ($a_data, $a_id, $a_call_by_reference, $a_prepare_output=true)
 Constructor public.
& executeCommand ()
 execute command
 viewObject ()
 Start page.
 createObject ()
 create new object form
 saveObject ()
 save object public
 infoScreenObject ()
 this one is called from the info button in the repository not very nice to set cmdClass/Cmd manually, if everything works through ilCtrl in the future this may be changed
 infoScreen ()
 show information screen
 gotoStartPageObject ()
 Go to start page.
 addPageTabs ()
 Add Page Tabs.
 addPagesSubTabs ()
 Add Pages SubTabs.
 getTabs ($tabs_gui)
 get tabs public
 editSettingsObject ()
 Edit settings.
 initSettingsForm ($a_mode="edit")
 Init Settings Form.
 getSettingsFormValues ($a_mode="edit")
 saveSettingsObject ()
 Save Settings.
 listContributorsObject ()
 List all contributors.
 saveGradingObject ()
 Save grading.
 addLocatorItems ()
 should be overwritten to add object specific items (repository items are preloaded)
 _goto ($a_target)
 viewPageObject ()
 view wiki page
 allPagesObject ()
 All pages of wiki.
 popularPagesObject ()
 Popular pages.
 orphanedPagesObject ()
 Orphaned pages.
 gotoPageObject ($a_page="")
 Go to specific page.
 randomPageObject ()
 Go to random page.
 recentChangesObject ()
 Recent Changes.
 setSideBlock ($a_wpg_id=0)
 newPagesObject ()
 Latest pages.
 printViewObject ()
 Show printable view of a wiki page.
 performSearchObject ()
 Search.
- Public Member Functions inherited from ilObjectGUI
 ilObjectGUI ($a_data, $a_id=0, $a_call_by_reference=true, $a_prepare_output=true)
 Constructor public.
 withReferences ()
 determines wether objects are referenced or not (got ref ids or not)
 setCreationMode ($a_mode=true)
 if true, a creation screen is displayed the current $_GET[ref_id] don't belong to the current class! the mode is determined in ilrepositorygui
 getCreationMode ()
 get creation mode
 assignObject ()
 prepareOutput ()
 prepare output
 setTitleAndDescription ()
 called by prepare output
 showUpperIcon ()
 showMountWebfolderIcon ()
 setTabs ()
 set admin tabs public
 setAdminTabs ()
 set admin tabs public
 getAdminTabs (&$tabs_gui)
 administration tabs show only permissions and trash folder
 getHTML ()
 setActions ($a_actions="")
 set possible actions for objects in list.
 setSubObjects ($a_sub_objects="")
 set possible subobjects for this object.
 setLocator ()
 set Locator
 omitLocator ($a_omit=true)
 addAdminLocatorItems ()
 should be overwritten to add object specific items (repository items are preloaded)
 undeleteObject ()
 get object back from trash
 insertSavedNodes ($a_source_id, $a_dest_id, $a_tree_id, &$a_affected_ids)
 recursive method to insert all saved nodes of the clipboard (maybe this function could be moved to a rbac class ?)
 confirmedDeleteObject ()
 confirmed deletion if object -> objects are moved to trash
 cancelDeleteObject ()
 cancel deletion of object
 removeFromSystemObject ()
 remove objects from trash bin and all entries therefore every object needs a specific deleteObject() method
 removeDeletedNodes ($a_node_id, $a_checked, $a_delete_objects, &$a_affected_ids)
 remove already deleted objects within the objects in trash recursive function
 cancelObject ($in_rep=false)
 cancel action and go back to previous page public
 importObject ()
 import new object form
 editObject ()
 edit object
 displayEditForm ($fields)
 display edit form (usually called by editObject)
 updateObject ()
 updates object entry in object_data
 afterUpdate ()
 permObject ()
 show permissions of current node
 getFormAction ($a_cmd, $a_formaction="")
 get form action for command (command is method name without "Object", e.g.
 setFormAction ($a_cmd, $a_formaction)
 set specific form action for command
 getReturnLocation ($a_cmd, $a_location="")
 get return location for command (command is method name without "Object", e.g.
 setReturnLocation ($a_cmd, $a_location)
 set specific return location for command
 getTargetFrame ($a_cmd, $a_target_frame="")
 get target frame for command (command is method name without "Object", e.g.
 setTargetFrame ($a_cmd, $a_target_frame)
 set specific target frame for command
 permSaveObject ()
 save permissions
 isVisible ($a_ref_id, $a_type)
 displayList ()
 display object list
 deleteObject ($a_error=false)
 display deletion confirmation screen only for referenced objects.
 trashObject ()
 show trash content of object
 addRoleObject ()
 adds a local role This method is only called when choose the option 'you may add local roles'.
 showActions ($with_subobjects=false)
 show possible action (form buttons)
 getActions ()
 Get Actions.
 showPossibleSubObjects ()
 show possible subobjects (pulldown menu)
 getTemplateFile ($a_cmd, $a_type="")
 get a template blockfile format: tpl.
 getTitlesByRefId ($a_ref_ids)
 get Titles of objects this method is used for error messages in methods cut/copy/paste
 getTabs (&$tabs_gui)
 get tabs abstract method.
 __showButton ($a_cmd, $a_text, $a_target= '')
 hitsperpageObject ()
& __initTableGUI ()
 __setTableGUIBasicData (&$tbl, &$result_set, $a_from="")
 standard implementation for tables use 'from' variable use different initial setting of table
 __showClipboardTable ($a_result_set, $a_from="")
 infoObject ()
 __buildRoleFilterSelect ()
 __filterRoles ($a_roles, $a_filter)
 ownerObject ()
 changeOwnerObject ()
 redirectToRefId ($a_ref_id, $a_cmd="")
 redirects to (repository) view per ref id usually to a container and usually used at the end of a save/import method where the object gui type (of the new object) doesn't match with the type of the current $_GET["ref_id"] value
 fillCloneTemplate ($a_tpl_varname, $a_type)
 Fill object clone template This method can be called from any object GUI class that wants to offer object cloning.
 fillCloneSearchTemplate ($a_tpl_varname, $a_type)
 Add an object search in case the number of existing objects is too big to offer a selection list.
 cloneAllObject ()
 Clone single (not container object) Method is overwritten in ilContainerGUI.
 copyWizardHasOptions ($a_mode)
 Check if there is any modules specific option.
 getCenterColumnHTML ()
 Get center column.
 getRightColumnHTML ()
 Display right column.
 setColumnSettings ($column_gui)
 May be overwritten in subclasses.
 checkPermission ($a_perm, $a_cmd="")

Static Public Member Functions

static getGotoLink ($a_ref_id, $a_page="")
 Get goto link.

Additional Inherited Members

- Data Fields inherited from ilObjectGUI
const COPY_WIZARD_NEEDS_PAGE = 1
 $ilias
 $objDefinition
 $tpl
 $tree
 $lng
 $data
 $object
 $ref_id
 $obj_id
 $maxcount
 $formaction
 $return_location
 $target_frame
 $tab_target_script
 $actions
 $sub_objects
 $omit_locator = false
- Protected Member Functions inherited from ilObjectGUI
 searchCloneSourceObject ()
 Search clone source by title.
 buildCloneSelect ($existing_objs)
 Build a select box for clonable objects (permission write)

Detailed Description

Class ilObjWikiGUI.

Author
Alex Killing alex..nosp@m.kill.nosp@m.ing@g.nosp@m.mx.d.nosp@m.e
Version
$Id$

ilObjWikiGUI: ilPermissionGUI, ilInfoScreenGUI, ilWikiPageGUI ilObjWikiGUI: ilRepositoryGUI, ilAdministrationGUI ilObjWikiGUI: ilPublicUserProfileGUI

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

Member Function Documentation

ilObjWikiGUI::_goto (   $a_target)

Definition at line 653 of file class.ilObjWikiGUI.php.

References $_GET, $ilErr, ilObjectGUI\$lng, ilObject\_lookupObjId(), ilObject\_lookupTitle(), exit, and ilUtil\sendInfo().

{
global $ilAccess, $ilErr, $lng, $ilNavigationHistory;
$i = strpos($a_target, "_");
if ($i > 0)
{
$a_page = substr($a_target, $i+1);
$a_target = substr($a_target, 0, $i);
}
if ($ilAccess->checkAccess("read", "", $a_target))
{
$_GET["cmd"] = "viewPage";
$_GET["ref_id"] = $a_target;
$_GET["page"] = $a_page;
$_GET["baseClass"] = "ilwikihandlergui";
$_GET["cmdClass"] = "ilobjwikigui";
/* if ($a_page != "")
{
$add = "&page=".rawurlencode($_GET["page"]);
$ilNavigationHistory->addItem($_GET["ref_id"],
"./goto.php?target=wiki_".$_GET["ref_id"].$add, "wiki");
}*/
include("ilias.php");
exit;
}
else if ($ilAccess->checkAccess("visible", "", $a_target))
{
$_GET["cmd"] = "infoScreen";
$_GET["ref_id"] = $tarr[0];
include("repository.php");
exit;
}
else if ($ilAccess->checkAccess("read", "", ROOT_FOLDER_ID))
{
$_GET["cmd"] = "frameset";
$_GET["target"] = "";
$_GET["ref_id"] = ROOT_FOLDER_ID;
ilUtil::sendInfo(sprintf($lng->txt("msg_no_perm_read_item"),
ilObject::_lookupTitle(ilObject::_lookupObjId($tarr[0]))), true);
include("repository.php");
exit;
}
$ilErr->raiseError($lng->txt("msg_no_perm_read"), $ilErr->FATAL);
}

+ Here is the call graph for this function:

ilObjWikiGUI::addLocatorItems ( )

should be overwritten to add object specific items (repository items are preloaded)

Reimplemented from ilObjectGUI.

Definition at line 642 of file class.ilObjWikiGUI.php.

References $_GET, and getGotoLink().

{
global $ilLocator;
if (is_object($this->object))
{
$ilLocator->addItem($this->object->getTitle(),
$this->getGotoLink($this->object->getRefId()), "", $_GET["ref_id"]);
}
}

+ Here is the call graph for this function:

ilObjWikiGUI::addPagesSubTabs ( )

Add Pages SubTabs.

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

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

Referenced by allPagesObject(), newPagesObject(), orphanedPagesObject(), popularPagesObject(), and recentChangesObject().

{
global $ilTabs, $ilCtrl;
include_once("./Modules/Wiki/classes/class.ilWikiPage.php");
$ilCtrl->setParameter($this, "wpg_id",
ilWikiPage::getPageIdForTitle($this->object->getId(),
ilWikiUtil::makeDbTitle($_GET["page"])));
$ilCtrl->setParameter($this, "page", ilWikiUtil::makeUrlTitle($_GET["page"]));
$ilTabs->addSubTabTarget("wiki_all_pages",
$this->ctrl->getLinkTarget($this, "allPages"), "allPages");
$ilTabs->addSubTabTarget("wiki_recent_changes",
$this->ctrl->getLinkTarget($this, "recentChanges"), "recentChanges");
$ilTabs->addSubTabTarget("wiki_new_pages",
$this->ctrl->getLinkTarget($this, "newPages"), "newPages");
$ilTabs->addSubTabTarget("wiki_popular_pages",
$this->ctrl->getLinkTarget($this, "popularPages"), "popularPages");
$ilTabs->addSubTabTarget("wiki_orphaned_pages",
$this->ctrl->getLinkTarget($this, "orphanedPages"), "orphanedPages");
}

+ Here is the call graph for this function:

+ Here is the caller graph for this function:

ilObjWikiGUI::addPageTabs ( )

Add Page Tabs.

Definition at line 329 of file class.ilObjWikiGUI.php.

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

{
global $ilTabs, $ilCtrl;
include_once("./Modules/Wiki/classes/class.ilWikiPage.php");
$ilCtrl->setParameter($this, "wpg_id",
ilWikiPage::getPageIdForTitle($this->object->getId(), ilWikiUtil::makeDbTitle($_GET["page"])));
$ilCtrl->setParameter($this, "page", ilWikiUtil::makeUrlTitle($_GET["page"]));
$ilTabs->addTarget("wiki_what_links_here",
$this->ctrl->getLinkTargetByClass("ilwikipagegui",
"whatLinksHere"), "whatLinksHere");
$ilTabs->addTarget("wiki_print_view",
$this->ctrl->getLinkTarget($this,
"printView"), "printView");
}

+ Here is the call graph for this function:

ilObjWikiGUI::allPagesObject ( )

All pages of wiki.

Definition at line 772 of file class.ilObjWikiGUI.php.

References ilObjectGUI\$tpl, addPagesSubTabs(), ilObjectGUI\checkPermission(), IL_WIKI_ALL_PAGES, and setSideBlock().

{
global $tpl;
$this->checkPermission("read");
include_once("./Modules/Wiki/classes/class.ilWikiPagesTableGUI.php");
$this->addPagesSubTabs();
$table_gui = new ilWikiPagesTableGUI($this, "allPages",
$this->object->getId(), IL_WIKI_ALL_PAGES);
$this->setSideBlock();
$tpl->setContent($table_gui->getHTML());
}

+ Here is the call graph for this function:

ilObjWikiGUI::createObject ( )

create new object form

public

Reimplemented from ilObjectGUI.

Definition at line 139 of file class.ilObjWikiGUI.php.

References $_GET, ilObjectGUI\$tpl, getSettingsFormValues(), and initSettingsForm().

{
global $rbacsystem;
$new_type = $_POST["new_type"] ? $_POST["new_type"] : $_GET["new_type"];
if (!$rbacsystem->checkAccess("create", $_GET["ref_id"], $new_type))
{
$this->ilias->raiseError($this->lng->txt("permission_denied"),$this->ilias->error_obj->MESSAGE);
}
else
{
global $tpl;
$this->initSettingsForm("create");
$this->getSettingsFormValues("create");
$tpl->setContent($this->form_gui->getHtml());
}
}

+ Here is the call graph for this function:

ilObjWikiGUI::editSettingsObject ( )

Edit settings.

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

References ilObjectGUI\$tpl, ilObjectGUI\checkPermission(), getSettingsFormValues(), initSettingsForm(), and setSideBlock().

{
global $tpl;
$this->checkPermission("write");
$this->initSettingsForm();
$this->getSettingsFormValues();
$tpl->setContent($this->form_gui->getHtml());
$this->setSideBlock();
}

+ Here is the call graph for this function:

& ilObjWikiGUI::executeCommand ( )

execute command

Reimplemented from ilObjectGUI.

Definition at line 58 of file class.ilObjWikiGUI.php.

References $_GET, $cmd, $ilCtrl, $ret, ilObjectGUI\$tpl, ilObjectGUI\checkPermission(), ilWikiPageGUI\getGUIForTitle(), infoScreen(), ilWikiUtil\makeDbTitle(), and ilObjectGUI\prepareOutput().

{
global $ilUser, $ilCtrl, $tpl, $ilTabs, $ilAccess;
$next_class = $this->ctrl->getNextClass($this);
$cmd = $this->ctrl->getCmd();
$this->prepareOutput();
switch($next_class)
{
case "ilinfoscreengui":
$this->checkPermission("visible");
$this->infoScreen(); // forwards command
break;
case 'ilpermissiongui':
include_once("./classes/class.ilPermissionGUI.php");
$perm_gui =& new ilPermissionGUI($this);
$ret =& $this->ctrl->forwardCommand($perm_gui);
break;
case 'ilwikipagegui':
include_once("./Modules/Wiki/classes/class.ilWikiPageGUI.php");
$wpage_gui = ilWikiPageGUI::getGUIForTitle($this->object->getId(),
ilWikiUtil::makeDbTitle($_GET["page"]), $_GET["old_nr"]);
if (!$ilAccess->checkAccess("write", "", $this->object->getRefId()) &&
!$ilAccess->checkAccess("edit_content", "", $this->object->getRefId()))
{
$wpage_gui->setEnableEditing(false);
}
$ret = $this->ctrl->forwardCommand($wpage_gui);
if ($ret != "")
{
$tpl->setContent($ret);
}
break;
case 'ilpublicuserprofilegui':
require_once './Services/User/classes/class.ilPublicUserProfileGUI.php';
$profile_gui = new ilPublicUserProfileGUI($_GET["user"]);
$ret = $this->ctrl->forwardCommand($profile_gui);
$tpl->setContent($ret);
break;
default:
if(!$cmd)
{
$cmd = "infoScreen";
}
$cmd .= "Object";
if ($cmd != "infoScreenObject")
{
$this->checkPermission("read");
}
else
{
$this->checkPermission("visible");
}
$this->$cmd();
break;
}
return $ret;
}

+ Here is the call graph for this function:

static ilObjWikiGUI::getGotoLink (   $a_ref_id,
  $a_page = "" 
)
static

Get goto link.

Definition at line 704 of file class.ilObjWikiGUI.php.

References ilObject\_lookupObjId(), ilObjWiki\_lookupStartPage(), and ilWikiUtil\makeUrlTitle().

Referenced by addLocatorItems(), ilWikiPagesTableGUI\fillRow(), getTabs(), gotoPageObject(), gotoStartPageObject(), infoScreen(), and saveObject().

{
if ($a_page == "")
{
$a_page = ilObjWiki::_lookupStartPage(ilObject::_lookupObjId($a_ref_id));
}
$goto = "./goto.php?target=wiki_".$a_ref_id."_".
ilWikiUtil::makeUrlTitle($a_page);
return $goto;
}

+ Here is the call graph for this function:

+ Here is the caller graph for this function:

ilObjWikiGUI::getSettingsFormValues (   $a_mode = "edit")

Definition at line 529 of file class.ilObjWikiGUI.php.

References ilObjectGUI\$lng.

Referenced by createObject(), and editSettingsObject().

{
global $lng;
// set values
if ($a_mode == "create")
{
$values["startpage"] = $lng->txt("wiki_main_page");
$this->form_gui->setValuesByArray($values);
}
else
{
$values["online"] = $this->object->getOnline();
$values["title"] = $this->object->getTitle();
$values["startpage"] = $this->object->getStartPage();
$values["shorttitle"] = $this->object->getShortTitle();
$values["description"] = $this->object->getDescription();
$values["rating"] = $this->object->getRating();
$values["intro"] = $this->object->getIntroduction();
$this->form_gui->setValuesByArray($values);
}
}

+ Here is the caller graph for this function:

ilObjWikiGUI::getTabs (   $tabs_gui)

get tabs public

Parameters
objecttabs gui object

Definition at line 374 of file class.ilObjWikiGUI.php.

References $_GET, $ilCtrl, ilObjectGUI\$lng, getGotoLink(), and ilWikiUtil\makeDbTitle().

{
global $ilCtrl, $ilAccess, $lng;
// wiki tabs
if (in_array($ilCtrl->getCmdClass(), array("", "ilobjwikigui",
"ilinfoscreengui", "ilpermissiongui")))
{
if ($_GET["page"] != "")
{
$tabs_gui->setBackTarget($lng->txt("wiki_last_visited_page"),
$this->getGotoLink($_GET["ref_id"],
ilWikiUtil::makeDbTitle($_GET["page"])));
}
// info screen
if ($ilAccess->checkAccess('visible', "", $this->object->getRefId()))
{
$force_active = ($ilCtrl->getNextClass() == "ilinfoscreengui"
|| $_GET["cmd"] == "infoScreen")
? true
: false;
$tabs_gui->addTarget("info_short",
$this->ctrl->getLinkTargetByClass(
"ilinfoscreengui", "showSummary"),
"showSummary",
"", "", $force_active);
}
// settings
if ($ilAccess->checkAccess('write', "", $this->object->getRefId()))
{
$tabs_gui->addTarget("settings",
$this->ctrl->getLinkTarget($this, "editSettings"), array("editSettings"),
array(strtolower(get_class($this)), ""));
}
// pages
if ($ilAccess->checkAccess('read', "", $this->object->getRefId()))
{
$tabs_gui->addTarget("wiki_pages",
$this->ctrl->getLinkTarget($this, "allPages"),
"allPages");
}
// contributors
if ($ilAccess->checkAccess('write', "", $this->object->getRefId()))
{
$tabs_gui->addTarget("wiki_contributors",
$this->ctrl->getLinkTarget($this, "listContributors"), array("listContributors"),
array(strtolower(get_class($this)), ""));
}
// edit permissions
if ($ilAccess->checkAccess('edit_permission', "", $this->object->getRefId()))
{
$tabs_gui->addTarget("perm_settings",
$this->ctrl->getLinkTargetByClass("ilpermissiongui", "perm"), array("perm","info","owner"), 'ilpermissiongui');
}
}
}

+ Here is the call graph for this function:

ilObjWikiGUI::gotoPageObject (   $a_page = "")

Go to specific page.

Parameters
string$a_pagepage title

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

References $_GET, $ilCtrl, ilWikiPage\_wikiPageExists(), getGotoLink(), ilWikiUtil\makeDbTitle(), ilWikiUtil\makeUrlTitle(), and ilUtil\redirect().

Referenced by randomPageObject().

{
global $ilCtrl;
if ($a_page == "")
{
$a_page = $_GET["page"];
}
include_once("./Modules/Wiki/classes/class.ilWikiPage.php");
if (ilWikiPage::_wikiPageExists($this->object->getId(),
ilWikiUtil::makeDbTitle($a_page)))
{
// to do: get rid of this redirect
ilUtil::redirect(ilObjWikiGUI::getGotoLink($this->object->getRefId(), $a_page));
}
else
{
// create the page
$page = new ilWikiPage();
$page->setWikiId($this->object->getId());
$page->setTitle(ilWikiUtil::makeDbTitle($_GET["page"]));
$page->create();
// redirect to newly created page
$ilCtrl->setParameterByClass("ilwikipagegui", "page", ilWikiUtil::makeUrlTitle(($a_page)));
$ilCtrl->redirectByClass("ilwikipagegui", "edit");
}
}

+ Here is the call graph for this function:

+ Here is the caller graph for this function:

ilObjWikiGUI::gotoStartPageObject ( )

Go to start page.

Definition at line 319 of file class.ilObjWikiGUI.php.

References $ilCtrl, getGotoLink(), and ilUtil\redirect().

Referenced by viewObject().

{
global $ilCtrl;
ilUtil::redirect(ilObjWikiGUI::getGotoLink($this->object->getRefId()));
}

+ Here is the call graph for this function:

+ Here is the caller graph for this function:

ilObjWikiGUI::ilObjWikiGUI (   $a_data,
  $a_id,
  $a_call_by_reference,
  $a_prepare_output = true 
)

Constructor public.

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

References $_GET, $ilCtrl, ilObjectGUI\$lng, ilObjectGUI\ilObjectGUI(), and ilWikiUtil\makeUrlTitle().

{
global $ilCtrl, $lng;
$this->type = "wiki";
$this->ilObjectGUI($a_data,$a_id,$a_call_by_reference,$a_prepare_output);
$lng->loadLanguageModule("wiki");
if ($_GET["page"] != "")
{
$ilCtrl->setParameter($this, "page", ilWikiUtil::makeUrlTitle($_GET["page"]));
}
}

+ Here is the call graph for this function:

ilObjWikiGUI::infoScreen ( )

show information screen

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

References ilObjectGUI\$lng, ilLPMarks\_lookupComment(), ilLPMarks\_lookupMark(), ilWikiContributor\_lookupStatus(), getGotoLink(), setSideBlock(), ilWikiContributor\STATUS_FAILED, ilWikiContributor\STATUS_NOT_GRADED, and ilWikiContributor\STATUS_PASSED.

Referenced by executeCommand(), and infoScreenObject().

{
global $ilAccess, $ilUser, $lng;
if (!$ilAccess->checkAccess("visible", "", $this->object->getRefId()))
{
$this->ilias->raiseError($this->lng->txt("msg_no_perm_read"),$this->ilias->error_obj->MESSAGE);
}
include_once("./Services/InfoScreen/classes/class.ilInfoScreenGUI.php");
$info = new ilInfoScreenGUI($this);
$info->enablePrivateNotes();
if (trim($this->object->getIntroduction()) != "")
{
$info->addSection($lng->txt("wiki_introduction"));
$info->addProperty("", nl2br($this->object->getIntroduction()));
}
// feedback from tutor; mark, status, comment
include_once("./Modules/Wiki/classes/class.ilWikiContributor.php");
include_once("./Services/Tracking/classes/class.ilLPMarks.php");
$lpcomment = ilLPMarks::_lookupComment($ilUser->getId(), $this->object->getId());
$mark = ilLPMarks::_lookupMark($ilUser->getId(), $this->object->getId());
$status = ilWikiContributor::_lookupStatus($this->object->getId(), $ilUser->getId());
if ($lpcomment != "" || $mark != "" || $status != ilWikiContributor::STATUS_NOT_GRADED)
{
$info->addSection($this->lng->txt("wiki_feedback_from_tutor"));
if ($lpcomment != "")
{
$info->addProperty($this->lng->txt("wiki_comment"),
$lpcomment);
}
if ($mark != "")
{
$info->addProperty($this->lng->txt("wiki_mark"),
$mark);
}
if ($status == ilWikiContributor::STATUS_PASSED)
{
$info->addProperty($this->lng->txt("status"),
$this->lng->txt("wiki_passed"));
}
if ($status == ilWikiContributor::STATUS_FAILED)
{
$info->addProperty($this->lng->txt("status"),
$this->lng->txt("wiki_failed"));
}
}
/*
$info->enableNews();
if ($ilAccess->checkAccess("write", "", $_GET["ref_id"]))
{
//$info->enableNewsEditing();
$info->setBlockProperty("news", "settings", true);
}*/
if ($ilAccess->checkAccess("read", "", $this->object->getRefId()))
{
$info->addButton($lng->txt("wiki_start_page"), ilObjWikiGUI::getGotoLink($this->object->getRefId()));
}
// general information
$this->lng->loadLanguageModule("meta");
$this->lng->loadLanguageModule("wiki");
//$info->addSection($this->lng->txt("meta_general"));
//$info->addProperty($this->lng->txt("mcst_nr_items"),
// (int) count($med_items));
// forward the command
$this->ctrl->forwardCommand($info);
if ($ilAccess->checkAccess("read", "", $this->object->getRefId()))
{
$this->setSideBlock();
}
}

+ Here is the call graph for this function:

+ Here is the caller graph for this function:

ilObjWikiGUI::infoScreenObject ( )

this one is called from the info button in the repository not very nice to set cmdClass/Cmd manually, if everything works through ilCtrl in the future this may be changed

Definition at line 225 of file class.ilObjWikiGUI.php.

References ilObjectGUI\checkPermission(), and infoScreen().

{
$this->checkPermission("visible");
$this->ctrl->setCmd("showSummary");
$this->ctrl->setCmdClass("ilinfoscreengui");
$this->infoScreen();
}

+ Here is the call graph for this function:

ilObjWikiGUI::initSettingsForm (   $a_mode = "edit")

Init Settings Form.

Definition at line 455 of file class.ilObjWikiGUI.php.

References $ilCtrl, ilObjectGUI\$lng, ilObjectGUI\$tpl, ilUtil\getImagePath(), ilTextAreaInputGUI\setCols(), ilTextInputGUI\setMaxLength(), ilFormPropertyGUI\setRequired(), and ilFormPropertyGUI\setTitle().

Referenced by createObject(), editSettingsObject(), saveObject(), and saveSettingsObject().

{
global $tpl, $lng, $ilCtrl;
$lng->loadLanguageModule("wiki");
include("Services/Form/classes/class.ilPropertyFormGUI.php");
$this->form_gui = new ilPropertyFormGUI();
// Title
$tit = new ilTextInputGUI($lng->txt("title"), "title");
$tit->setRequired(true);
$this->form_gui->addItem($tit);
// Short Title
// The problem with the short title is, that it is per object
// and can't be a substitute for a ref id in the permanent link
/*
$stit = new ilRegExpInputGUI($lng->txt("wiki_short_title"), "shorttitle");
$stit->setPattern("/^[^0-9][^ _\&]+$/");
$stit->setRequired(false);
$stit->setNoMatchMessage($lng->txt("wiki_msg_short_name_regexp")." & _");
$stit->setSize(20);
$stit->setMaxLength(20);
$stit->setInfo($lng->txt("wiki_short_title_desc2"));
$this->form_gui->addItem($stit);
*/
// Description
$des = new ilTextAreaInputGUI($lng->txt("description"), "description");
$this->form_gui->addItem($des);
// Introduction
$intro = new ilTextAreaInputGUI($lng->txt("wiki_introduction"), "intro");
$intro->setCols(40);
$intro->setRows(4);
$this->form_gui->addItem($intro);
// Start Page
$sp = new ilTextInputGUI($lng->txt("wiki_start_page"), "startpage");
$sp->setMaxLength(200);
$sp->setRequired(true);
$this->form_gui->addItem($sp);
// Online
$online = new ilCheckboxInputGUI($lng->txt("online"), "online");
$this->form_gui->addItem($online);
$rating = new ilCheckboxInputGUI($lng->txt("wiki_activate_rating"), "rating");
$this->form_gui->addItem($rating);
// Form action and save button
$this->form_gui->setTitleIcon(ilUtil::getImagePath("icon_wiki.gif"));
if ($a_mode != "create")
{
$this->form_gui->setTitle($lng->txt("wiki_settings"));
$this->form_gui->addCommandButton("saveSettings", $lng->txt("save"));
}
else
{
$this->form_gui->setTitle($lng->txt("wiki_new"));
$this->form_gui->addCommandButton("save", $lng->txt("wiki_add"));
$this->form_gui->addCommandButton("cancel", $lng->txt("cancel"));
}
// set values
if ($a_mode == "create")
{
$ilCtrl->setParameter($this, "new_type", "wiki");
}
$this->form_gui->setFormAction($ilCtrl->getFormAction($this, "saveSettings"));
}

+ Here is the call graph for this function:

+ Here is the caller graph for this function:

ilObjWikiGUI::listContributorsObject ( )

List all contributors.

Definition at line 595 of file class.ilObjWikiGUI.php.

References ilObjectGUI\$tpl, ilObjectGUI\checkPermission(), and setSideBlock().

{
global $tpl;
$this->checkPermission("write");
include_once("./Modules/Wiki/classes/class.ilWikiContributorsTableGUI.php");
$table_gui = new ilWikiContributorsTableGUI($this, "listContributors",
$this->object->getId());
$tpl->setContent($table_gui->getHTML());
$this->setSideBlock();
}

+ Here is the call graph for this function:

ilObjWikiGUI::newPagesObject ( )

Latest pages.

Definition at line 924 of file class.ilObjWikiGUI.php.

References ilObjectGUI\$tpl, addPagesSubTabs(), ilObjectGUI\checkPermission(), IL_WIKI_NEW_PAGES, and setSideBlock().

{
global $tpl, $ilTabs;
$this->checkPermission("read");
include_once("./Modules/Wiki/classes/class.ilWikiPagesTableGUI.php");
$this->addPagesSubTabs();
$ilTabs->setTabActive("wiki_pages");
$table_gui = new ilWikiPagesTableGUI($this, "newPages",
$this->object->getId(), IL_WIKI_NEW_PAGES);
$this->setSideBlock();
$tpl->setContent($table_gui->getHTML());
}

+ Here is the call graph for this function:

ilObjWikiGUI::orphanedPagesObject ( )

Orphaned pages.

Definition at line 813 of file class.ilObjWikiGUI.php.

References ilObjectGUI\$tpl, addPagesSubTabs(), ilObjectGUI\checkPermission(), IL_WIKI_ORPHANED_PAGES, and setSideBlock().

{
global $tpl, $ilTabs;
$this->checkPermission("read");
include_once("./Modules/Wiki/classes/class.ilWikiPagesTableGUI.php");
$this->addPagesSubTabs();
$ilTabs->setTabActive("wiki_pages");
$table_gui = new ilWikiPagesTableGUI($this, "orphanedPages",
$this->object->getId(), IL_WIKI_ORPHANED_PAGES);
$this->setSideBlock();
$tpl->setContent($table_gui->getHTML());
}

+ Here is the call graph for this function:

ilObjWikiGUI::performSearchObject ( )

Search.

Definition at line 975 of file class.ilObjWikiGUI.php.

References ilObjectGUI\$tpl, ilObjWiki\_performSearch(), ilObjectGUI\checkPermission(), setSideBlock(), and ilUtil\stripSlashes().

{
global $tpl, $ilTabs;
$this->checkPermission("read");
include_once("./Modules/Wiki/classes/class.ilWikiSearchResultsTableGUI.php");
$ilTabs->setTabActive("wiki_search_results");
$search_results = ilObjWiki::_performSearch($this->object->getId(),
ilUtil::stripSlashes($_POST["search_term"]));
$table_gui = new ilWikiSearchResultsTableGUI($this, "performSearch",
$this->object->getId(), $search_results);
$this->setSideBlock();
$tpl->setContent($table_gui->getHTML());
}

+ Here is the call graph for this function:

ilObjWikiGUI::popularPagesObject ( )

Popular pages.

Definition at line 792 of file class.ilObjWikiGUI.php.

References ilObjectGUI\$tpl, addPagesSubTabs(), ilObjectGUI\checkPermission(), IL_WIKI_POPULAR_PAGES, and setSideBlock().

{
global $tpl, $ilTabs;
$this->checkPermission("read");
include_once("./Modules/Wiki/classes/class.ilWikiPagesTableGUI.php");
$this->addPagesSubTabs();
$ilTabs->setTabActive("wiki_pages");
$table_gui = new ilWikiPagesTableGUI($this, "popularPages",
$this->object->getId(), IL_WIKI_POPULAR_PAGES);
$this->setSideBlock();
$tpl->setContent($table_gui->getHTML());
}

+ Here is the call graph for this function:

ilObjWikiGUI::printViewObject ( )

Show printable view of a wiki page.

Definition at line 945 of file class.ilObjWikiGUI.php.

References $_GET, ilObjectGUI\$tpl, ilObjectGUI\checkPermission(), exit, ilObjStyleSheet\getContentPrintStyle(), ilObjStyleSheet\getContentStylePath(), and ilObjStyleSheet\getSyntaxStylePath().

{
$this->checkPermission("read");
include_once("./Modules/Wiki/classes/class.ilWikiPageGUI.php");
$page_gui = new ilWikiPageGUI($_GET["wpg_id"]);
$tpl = new ilTemplate("tpl.main.html", true, true);
$tpl->setVariable("LOCATION_STYLESHEET", ilObjStyleSheet::getContentPrintStyle());
$tpl->setVariable("LOCATION_CONTENT_STYLESHEET",
ilObjStyleSheet::getContentStylePath(0));
// syntax style
$this->tpl->setCurrentBlock("SyntaxStyle");
$this->tpl->setVariable("LOCATION_SYNTAX_STYLESHEET",
ilObjStyleSheet::getSyntaxStylePath());
$this->tpl->parseCurrentBlock();
// determine target frames for internal links
$page_gui->setOutputMode("print");
$page_content = $page_gui->showPage();
$tpl->setVariable("CONTENT",
'<div class="ilInvisibleBorder">'.$page_content.'</div>');
$tpl->show(false);
exit;
}

+ Here is the call graph for this function:

ilObjWikiGUI::randomPageObject ( )

Go to random page.

Parameters
string$a_pagepage title

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

References ilObjectGUI\checkPermission(), ilWikiPage\getRandomPage(), and gotoPageObject().

{
$this->checkPermission("read");
include_once("./Modules/Wiki/classes/class.ilWikiPage.php");
$page = ilWikiPage::getRandomPage($this->object->getId());
$this->gotoPageObject($page);
}

+ Here is the call graph for this function:

ilObjWikiGUI::recentChangesObject ( )

Recent Changes.

Definition at line 883 of file class.ilObjWikiGUI.php.

References ilObjectGUI\$tpl, addPagesSubTabs(), ilObjectGUI\checkPermission(), and setSideBlock().

{
global $tpl, $ilTabs;
$this->checkPermission("read");
include_once("./Modules/Wiki/classes/class.ilWikiRecentChangesTableGUI.php");
$this->addPagesSubTabs();
$ilTabs->setTabActive("wiki_pages");
$table_gui = new ilWikiRecentChangesTableGUI($this, "recentChanges",
$this->object->getId());
$this->setSideBlock();
$tpl->setContent($table_gui->getHTML());
}

+ Here is the call graph for this function:

ilObjWikiGUI::saveGradingObject ( )

Save grading.

Definition at line 614 of file class.ilObjWikiGUI.php.

References $ilCtrl, ilWikiContributor\_writeStatus(), ilObjectGUI\checkPermission(), ilLPMarks\setMark(), and ilUtil\stripSlashes().

{
global $ilCtrl;
$this->checkPermission("write");
$users = (is_array($_POST["sel_user_id"]))
? $_POST["sel_user_id"]
: (is_array($_POST["user_id"])
? $_POST["user_id"]
: array());
include_once("./Modules/Wiki/classes/class.ilWikiContributor.php");
include_once("./Services/Tracking/classes/class.ilLPMarks.php");
foreach($users as $user_id)
{
ilWikiContributor::_writeStatus($this->object->getId(), $user_id,
ilUtil::stripSlashes($_POST["status"][$user_id]));
$marks_obj = new ilLPMarks($this->object->getId(),$user_id);
$marks_obj->setMark(ilUtil::stripSlashes($_POST['mark'][$user_id]));
$marks_obj->setComment(ilUtil::stripSlashes($_POST['lcomment'][$user_id]));
$marks_obj->update();
}
$ilCtrl->redirect($this, "listContributors");
}

+ Here is the call graph for this function:

ilObjWikiGUI::saveObject ( )

save object public

Reimplemented from ilObjectGUI.

Definition at line 164 of file class.ilObjWikiGUI.php.

References $_GET, ilObjectGUI\$lng, ilObjectGUI\$tpl, ilObjWiki\checkShortTitleAvailability(), getGotoLink(), initSettingsForm(), ilUtil\redirect(), and ilUtil\sendInfo().

{
global $rbacadmin, $tpl, $lng, $rbacsystem;
if (!$rbacsystem->checkAccess("create", $_GET["ref_id"], "wiki"))
{
$this->ilias->raiseError($this->lng->txt("permission_denied"),$this->ilias->error_obj->MESSAGE);
}
$this->initSettingsForm("create");
if ($this->form_gui->checkInput())
{
if (!ilObjWiki::checkShortTitleAvailability($this->form_gui->getInput("shorttitle")))
{
$short_item = $this->form_gui->getItemByPostVar("shorttitle");
$short_item->setAlert($lng->txt("wiki_short_title_already_in_use"));
}
else
{
//
$_POST["Fobject"]["title"] = $this->form_gui->getInput("title");
$_POST["Fobject"]["desc"] = $this->form_gui->getInput("description");
// create and insert forum in objecttree
$newObj = parent::saveObject();
$newObj->setTitle($this->form_gui->getInput("title"));
$newObj->setDescription($this->form_gui->getInput("description"));
$newObj->setIntroduction($this->form_gui->getInput("intro"));
$newObj->setStartPage($this->form_gui->getInput("startpage"));
$newObj->setShortTitle($this->form_gui->getInput("shorttitle"));
$newObj->setRating($this->form_gui->getInput("rating"));
$newObj->setOnline($this->form_gui->getInput("online"));
$newObj->update();
// setup rolefolder & default local roles
//$roles = $newObj->initDefaultRoles();
// ...finally assign role to creator of object
//$rbacadmin->assignUser($roles[0], $newObj->getOwner(), "y");
// add first page
// always send a message
ilUtil::sendInfo($this->lng->txt("object_added"),true);
//ilUtil::redirect("ilias.php?baseClass=ilWikiHandlerGUI&ref_id=".$newObj->getRefId()."&cmd=editSettings");
ilUtil::redirect(ilObjWikiGUI::getGotoLink($newObj->getRefId()));
}
}
$this->form_gui->setValuesByPost();
$tpl->setContent($this->form_gui->getHtml());
}

+ Here is the call graph for this function:

ilObjWikiGUI::saveSettingsObject ( )

Save Settings.

Definition at line 556 of file class.ilObjWikiGUI.php.

References $ilCtrl, ilObjectGUI\$lng, ilObjectGUI\checkPermission(), ilObjWiki\checkShortTitleAvailability(), initSettingsForm(), and ilUtil\sendInfo().

{
global $ilCtrl, $lng;
$this->checkPermission("write");
$this->initSettingsForm();
if ($this->form_gui->checkInput())
{
if (!ilObjWiki::checkShortTitleAvailability($this->form_gui->getInput("shorttitle")) &&
$this->form_gui->getInput("shorttitle") != $this->object->getShortTitle())
{
$short_item = $this->form_gui->getItemByPostVar("shorttitle");
$short_item->setAlert($lng->txt("wiki_short_title_already_in_use"));
}
else
{
$this->object->setTitle($this->form_gui->getInput("title"));
$this->object->setDescription($this->form_gui->getInput("description"));
$this->object->setOnline($this->form_gui->getInput("online"));
$this->object->setStartPage($this->form_gui->getInput("startpage"));
$this->object->setShortTitle($this->form_gui->getInput("shorttitle"));
$this->object->setRating($this->form_gui->getInput("rating"));
$this->object->setIntroduction($this->form_gui->getInput("intro"));
$this->object->update();
ilUtil::sendInfo($this->lng->txt("msg_obj_modified"),true);
$ilCtrl->redirect($this, "editSettings");
}
}
$this->form_gui->setValuesByPost();
$this->tpl->setContent($this->form_gui->getHTML());
}

+ Here is the call graph for this function:

ilObjWikiGUI::setSideBlock (   $a_wpg_id = 0)

Definition at line 901 of file class.ilObjWikiGUI.php.

References ilObjectGUI\$tpl.

Referenced by allPagesObject(), editSettingsObject(), infoScreen(), listContributorsObject(), newPagesObject(), orphanedPagesObject(), performSearchObject(), popularPagesObject(), and recentChangesObject().

{
global $tpl;
// side block
include_once("./Modules/Wiki/classes/class.ilWikiSideBlockGUI.php");
$wiki_side_block = new ilWikiSideBlockGUI();
if ($a_wpg_id > 0)
{
include_once("./Modules/Wiki/classes/class.ilWikiPage.php");
$wiki_side_block->setPageObject(new ilWikiPage($a_wpg_id));
}
// 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 caller graph for this function:

ilObjWikiGUI::viewObject ( )

Start page.

Reimplemented from ilObjectGUI.

Definition at line 128 of file class.ilObjWikiGUI.php.

References ilObjectGUI\checkPermission(), and gotoStartPageObject().

{
$this->checkPermission("read");
$this->gotoStartPageObject();
}

+ Here is the call graph for this function:

ilObjWikiGUI::viewPageObject ( )

view wiki page

Definition at line 720 of file class.ilObjWikiGUI.php.

References $_GET, $ilCtrl, ilObjectGUI\$lng, ilObjectGUI\$tpl, ilObjectGUI\checkPermission(), ilWikiPage\exists(), ilWikiPageGUI\getGUIForTitle(), ilWikiUtil\makeDbTitle(), ilWikiUtil\makeUrlTitle(), and ilUtil\sendInfo().

{
global $lng, $ilCtrl, $tpl, $ilTabs, $ilAccess;
$this->checkPermission("read");
$ilTabs->clearTargets();
$page = ($_GET["page"] != "")
? $_GET["page"]
: $this->object->getStartPage();
$_GET["page"] = $page;
include_once("./Modules/Wiki/classes/class.ilWikiPage.php");
if (!ilWikiPage::exists($this->object->getId(), $page))
{
$page = $this->object->getStartPage();
}
if (!ilWikiPage::exists($this->object->getId(), $page))
{
ilUtil::sendInfo($lng->txt("wiki_no_start_page"), true);
$ilCtrl->redirect($this, "infoScreen");
return;
}
// page exists, show it !
$ilCtrl->setParameter($this, "page", ilWikiUtil::makeUrlTitle($page));
include_once("./Modules/Wiki/classes/class.ilWikiPageGUI.php");
$wpage_gui = ilWikiPageGUI::getGUIForTitle($this->object->getId(),
ilWikiUtil::makeDbTitle($page));
//$wpage_gui->setOutputMode(IL_PAGE_PREVIEW);
//$wpage_gui->setSideBlock();
$ilCtrl->setCmdClass("ilwikipagegui");
$ilCtrl->setCmd("preview");
if (!$ilAccess->checkAccess("write", "", $this->object->getRefId()) &&
!$ilAccess->checkAccess("edit_content", "", $this->object->getRefId()))
{
$wpage_gui->setEnableEditing(false);
}
$html = $ilCtrl->forwardCommand($wpage_gui);
//$this->addPageTabs();
$tpl->setContent($html);
}

+ Here is the call graph for this function:

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