ilObjWikiGUI Class Reference

Class ilObjWikiGUI. More...

Inheritance diagram for ilObjWikiGUI:

Collaboration diagram for ilObjWikiGUI:

Public Member Functions
	__construct ($a_data, $a_id, $a_call_by_reference, $a_prepare_output=true)
	Constructor public. More...
	executeCommand ()
	isOnlineHelpWiki ()
	Is wiki an online help wiki? More...
	viewObject ()
	Start page. More...
	saveObject ()
	save object public More...
	afterSave (ilObject $newObj)
	save object public More...
	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 More...
	infoScreen ()
	show information screen More...
	gotoStartPageObject ()
	Go to start page. More...
	addPageTabs ()
	Add Page Tabs. More...
	addPagesSubTabs ()
	Add Pages SubTabs. More...
	getTabs ()
	get tabs public More...
	setSettingsSubTabs ($a_active)
	Set sub tabs. More...
	editSettingsObject ()
	Edit settings. More...
	initSettingsForm ($a_mode="edit")
	Init Settings Form. More...
	getSettingsFormValues ($a_mode="edit")
	saveSettingsObject ()
	Save Settings. More...
	listContributorsObject ()
	List all contributors. More...
	saveGradingObject ()
	Save grading. More...
	addLocatorItems ()
	viewPageObject ()
	view wiki page More...
	allPagesObject ()
	All pages of wiki. More...
	popularPagesObject ()
	Popular pages. More...
	orphanedPagesObject ()
	Orphaned pages. More...
	gotoPageObject ($a_page="")
	Go to specific page. More...
	randomPageObject ()
	Go to random page. More...
	recentChangesObject ()
	Recent Changes. More...
	setSideBlock ($a_wpg_id=0)
	Side column. More...
	newPagesObject ()
	Latest pages. More...
	printViewObject ($a_pdf_export=false)
	pdfExportObject ()
	performSearchObject ()
	Search. More...
	setContentStyleSheet ($tpl=null)
	Set content style sheet. More...
	editStylePropertiesObject ()
	Edit style properties. More...
	initStylePropertiesForm ()
	Init style properties form. More...
	createStyleObject ()
	Create Style. More...
	editStyleObject ()
	Edit Style. More...
	deleteStyleObject ()
	Delete Style. More...
	saveStyleSettingsObject ()
	Save style settings. More...
	editImportantPagesObject ()
	List important pages. More...
	addImportantPageObject ()
	Add important pages. More...
	confirmRemoveImportantPagesObject ()
	Confirm important pages deletion. More...
	removeImportantPagesObject ()
	Remove important pages. More...
	saveOrderingAndIndentObject ()
	Save important pages ordering and indentation. More...
	setAsStartPageObject ()
	Confirm important pages deletion. More...
	exportHTML ()
	Create html package. More...
	getSubObjectTitle ($a_id, $a_type)
	Used for rating export. More...
	showTemplateSelectionObject ()
	Show template selection. More...
	initTemplateSelectionForm ()
	Init template selection form. More...
	createPageUsingTemplateObject ()
	Save creation with template form. More...
	cancelCreationPageUsingTemplateObject ()
	Cancel page creation using a template. More...
	initUserHTMLExportObject ()
	Export html (as user) More...
	startUserHTMLExportObject ()
	Export html (as user) More...
	getUserHTMLExportProgressObject ()
	Get user html export progress. More...
	downloadUserHTMLExportObject ()
	Download user html export file. More...
	downloadUserHTMLExportWithCommentsObject ()
	Download user html export file. More...
Public Member Functions inherited from ilObjectGUI
	executeCommand ()
	execute command More...
	withReferences ()
	determines wether objects are referenced or not (got ref ids or not) More...
	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 More...
	getCreationMode ()
	get creation mode More...
	prepareOutput ($a_show_subobjects=true)
	prepare output More...
	getAdminTabs ()
	administration tabs show only permissions and trash folder More...
	getHTML ()
	confirmedDeleteObject ()
	confirmed deletion of object -> objects are moved to trash or deleted immediately, if trash is disabled More...
	cancelDeleteObject ()
	cancel deletion of object More...
	cancelObject ()
	cancel action and go back to previous page public More...
	createObject ()
	create new object form More...
	cancelCreation ()
	cancel create action and go back to repository parent More...
	saveObject ()
	save object More...
	getDidacticTemplateVar ($a_type)
	Get didactic template setting from creation screen. More...
	putObjectInTree (ilObject $a_obj, $a_parent_node_id=null)
	Add object to tree at given position. More...
	editObject ()
	edit object More...
	addExternalEditFormCustom (ilPropertyFormGUI $a_form)
	updateObject ()
	updates object entry in object_data More...
	getFormAction ($a_cmd, $a_formaction="")
	get form action for command (command is method name without "Object", e.g. More...
	isVisible ($a_ref_id, $a_type)
	viewObject ()
	viewObject container presentation for "administration -> repository, trash, permissions" More...
	deleteObject ($a_error=false)
	Display deletion confirmation screen. More...
	cloneAllObject ()
	Clone single (not container object) Method is overwritten in ilContainerGUI. More...
	redirectAfterCreation ()
	Redirect after creation, see https://docu.ilias.de/goto_docu_wiki_wpage_5035_1357.html. More...
	addToDeskObject ()
	removeFromDeskObject ()
Public Member Functions inherited from ILIAS\Object\ImplementsCreationCallback
	callCreationCallback (\ilObject $object, \ilObjectDefinition $obj_definition, int $requested_crtcb)

Static Public Member Functions
static	_goto ($a_target)
static	getGotoLink ($a_ref_id, $a_page="")
	Get goto link. More...
static	renderSideBlock ($a_wpg_id, $a_wiki_ref_id, $a_wp=null)
	Side column. More...
static	lookupSubObjectTitle ($a_wiki_id, $a_page_id)
	Get title for wiki page (used in ilNotesGUI) More...
Static Public Member Functions inherited from ilObjectGUI
static	_gotoRepositoryRoot ($a_raise_error=false)
	Goto repository root. More...
static	_gotoRepositoryNode ($a_ref_id, $a_cmd="frameset")
	Goto repository root. More...

Protected Member Functions
	initCreationForms ($a_new_type)
	getPrintPageIds ()
	checkPermissionBool ($a_perm, $a_cmd="", $a_type="", $a_ref_id=null)
	Check permission. More...
	triggerAssignmentTool ()
	Trigger assignment tool. More...
	getAssignmentButtons ()
	Get assignment buttons. More...
Protected Member Functions inherited from ilObjectGUI
	getObjectService ()
	Get object service. More...
	assignObject ()
	setTitleAndDescription ()
	called by prepare output More...
	initHeaderAction ($a_sub_type=null, $a_sub_id=null)
	Add header action menu. More...
	insertHeaderAction ($a_list_gui)
	Insert header action into main template. More...
	addHeaderAction ()
	Add header action menu. More...
	redrawHeaderActionObject ()
	Ajax call: redraw action header only. More...
	setTabs ()
	set admin tabs public More...
	setAdminTabs ()
	set admin tabs public More...
	setLocator ()
	set Locator More...
	addLocatorItems ()
	should be overwritten to add object specific items (repository items are preloaded) More...
	omitLocator ($a_omit=true)
	addAdminLocatorItems ($a_do_not_add_object=false)
	should be overwritten to add object specific items (repository items are preloaded) More...
	initCreationForms ($a_new_type)
	Init creation froms. More...
	getCreationFormsHTML (array $a_forms)
	Get HTML for creation forms (accordion) More...
	initCreateForm ($a_new_type)
	Init object creation form. More...
	initDidacticTemplate (ilPropertyFormGUI $form)
	Show didactic template types. More...
	addDidacticTemplateOptions (array &$a_options)
	Add custom templates. More...
	afterSave (ilObject $a_new_object)
	Post (successful) object creation hook. More...
	initEditForm ()
	Init object edit form. More...
	initEditCustomForm (ilPropertyFormGUI $a_form)
	Add custom fields to update form. More...
	getEditFormValues ()
	Get values for edit form. More...
	getEditFormCustomValues (array &$a_values)
	Add values to custom edit fields. More...
	validateCustom (ilPropertyFormGUI $a_form)
	Validate custom values (if not possible with checkInput()) More...
	updateCustom (ilPropertyFormGUI $a_form)
	Insert custom update form values into object. More...
	afterUpdate ()
	Post (successful) object update hook. More...
	initImportForm ($a_new_type)
	Init object import form. More...
	importFileObject ($parent_id=null, $a_catch_errors=true)
	Import. More...
	afterImport (ilObject $a_new_object)
	Post (successful) object import hook. More...
	setFormAction ($a_cmd, $a_formaction)
	set specific form action for command More...
	getReturnLocation ($a_cmd, $a_location="")
	get return location for command (command is method name without "Object", e.g. More...
	setReturnLocation ($a_cmd, $a_location)
	set specific return location for command More...
	getTargetFrame ($a_cmd, $a_target_frame="")
	get target frame for command (command is method name without "Object", e.g. More...
	setTargetFrame ($a_cmd, $a_target_frame)
	set specific target frame for command More...
	showPossibleSubObjects ()
	show possible subobjects (pulldown menu) More...
	getTemplateFile ($a_cmd, $a_type="")
	get a template blockfile format: tpl. More...
	getTabs ()
	get tabs abstract method. More...
	__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 More...
	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 More...
	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. More...
	getCenterColumnHTML ()
	Get center column. More...
	getRightColumnHTML ()
	Display right column. More...
	setColumnSettings (ilColumnGUI $column_gui)
	May be overwritten in subclasses. More...
	checkPermission ($a_perm, $a_cmd="", $a_type="", $a_ref_id=null)
	Check permission and redirect on error. More...
	checkPermissionBool ($a_perm, $a_cmd="", $a_type="", $a_ref_id=null)
	Check permission. More...
	enableDragDropFileUpload ()
	Enables the file upload into this object by dropping files. More...
	handleAutoRating (ilObject $a_new_obj)
	Activate rating automatically if parent container setting. More...

Protected Attributes
	$tabs
	$error
	$help
	$log
	$tool_context
	$ui
	$req_with_comments = false
Protected Attributes inherited from ilObjectGUI
const	UPLOAD_TYPE_LOCAL = 1
const	UPLOAD_TYPE_UPLOAD_DIRECTORY = 2
	$ilErr
	$locator
	$user
	$access
	$rbacsystem
	$settings
	$rbacreview
	$toolbar
	$tmp_import_dir
	$tabs_gui = null
	$ctrl
	$object_service
	$favourites
	$request

Additional Inherited Members
Data Fields inherited from ilObjectGUI
const	ALLOWED_TAGS_IN_TITLE_AND_DESCRIPTION
const	COPY_WIZARD_NEEDS_PAGE = 1
	$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
const	CFORM_NEW = 1
const	CFORM_IMPORT = 2
const	CFORM_CLONE = 3

Detailed Description

Class ilObjWikiGUI.

Author

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

ilObjWikiGUI: ilPermissionGUI, ilInfoScreenGUI, ilWikiPageGUI ilObjWikiGUI: ilRepositoryGUI, ilAdministrationGUI ilObjWikiGUI: ilPublicUserProfileGUI, ilObjStyleSheetGUI ilObjWikiGUI: ilExportGUI, ilCommonActionDispatcherGUI ilObjWikiGUI: ilRatingGUI, ilWikiPageTemplateGUI, ilWikiStatGUI ilObjWikiGUI: ilObjectMetaDataGUI ilObjWikiGUI: ilSettingsPermissionGUI ilObjWikiGUI: ilRepositoryObjectSearchGUI, ilObjectCopyGUI, ilObjNotificationSettingsGUI

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

Constructor & Destructor Documentation

__construct()

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

Constructor public.

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

References $_GET, $DIC, ilObjectGUI\$lng, ILIAS\GlobalScreen\Provider\__construct(), ilLoggerFactory\getLogger(), help(), ilWikiUtil\makeUrlTitle(), settings(), ui(), and user().

    {
        global $DIC;

        $this->ctrl = $DIC->ctrl();
        $this->lng = $DIC->language();
        $this->user = $DIC->user();
        $this->tpl = $DIC["tpl"];
        $this->tabs = $DIC->tabs();
        $this->access = $DIC->access();
        $this->error = $DIC["ilErr"];
        $this->settings = $DIC->settings();
        $this->help = $DIC["ilHelp"];
        $this->locator = $DIC["ilLocator"];
        $this->toolbar = $DIC->toolbar();
        $ilCtrl = $DIC->ctrl();
        $lng = $DIC->language();
        
        $this->type = "wiki";

        $this->log = ilLoggerFactory::getLogger('wiki');

        $this->tool_context = $DIC->globalScreen()->tool()->context();
        $this->ui = $DIC->ui();

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

        $this->req_with_comments = (bool) $_GET["with_comments"];
    }

Here is the call graph for this function:

Member Function Documentation

_goto()

static ilObjWikiGUI::_goto (   $a_target )

static

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

References $_GET, $DIC, $i, ilObjectGUI\$ilErr, ilObjectGUI\$lng, ilObjectGUI\$ref_id, ilObject\_getAllReferences(), ilObjectGUI\_gotoRepositoryNode(), ilObjectGUI\_gotoRepositoryRoot(), ilObject\_lookupObjId(), ilObject\_lookupTitle(), exit, ilWikiPage\lookupTitle(), ilWikiPage\lookupWikiId(), ROOT_FOLDER_ID, and ilUtil\sendFailure().

    {
        global $DIC;

        $ilAccess = $DIC->access();
        $ilErr = $DIC["ilErr"];
        $lng = $DIC->language();
        $ilNavigationHistory = $DIC["ilNavigationHistory"];
        
        $i = strpos($a_target, "_");
        if ($i > 0) {
            $a_page = substr($a_target, $i + 1);
            $a_target = substr($a_target, 0, $i);
        }
        
        if ($a_target == "wpage") {
            $a_page_arr = explode("_", $a_page);
            $wpg_id = (int) $a_page_arr[0];
            $ref_id = (int) $a_page_arr[1];
            include_once("./Modules/Wiki/classes/class.ilWikiPage.php");
            $w_id = ilWikiPage::lookupWikiId($wpg_id);
            if ($ref_id > 0) {
                $refs = array($ref_id);
            } else {
                $refs = ilObject::_getAllReferences($w_id);
            }
            foreach ($refs as $r) {
                if ($ilAccess->checkAccess("read", "", $r)) {
                    $a_target = $r;
                    $a_page = ilWikiPage::lookupTitle($wpg_id);
                }
            }
        }
            
        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;
        } elseif ($ilAccess->checkAccess("visible", "", $a_target)) {
            ilObjectGUI::_gotoRepositoryNode($a_target, "infoScreen");
        } elseif ($ilAccess->checkAccess("read", "", ROOT_FOLDER_ID)) {
            ilUtil::sendFailure(sprintf(
                $lng->txt("msg_no_perm_read_item"),
                ilObject::_lookupTitle(ilObject::_lookupObjId($a_target))
            ), true);
            ilObjectGUI::_gotoRepositoryRoot();
        }

        $ilErr->raiseError($lng->txt("msg_no_perm_read"), $ilErr->FATAL);
    }

Here is the call graph for this function:

addImportantPageObject()

ilObjWikiGUI::addImportantPageObject

(

)

Add important pages.

Parameters

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

References $_POST, ilObjectGUI\$ctrl, ilObjectGUI\$lng, and ilObjectGUI\checkPermission().

    {
        $ilCtrl = $this->ctrl;
        $lng = $this->lng;

        $this->checkPermission("edit_wiki_navigation");

        if ($_POST["imp_page_id"] > 0) {
            $this->object->addImportantPage((int) $_POST["imp_page_id"]);
            ilUtil::sendSuccess($lng->txt("wiki_imp_page_added"), true);
        }
        $ilCtrl->redirect($this, "editImportantPages");
    }

Here is the call graph for this function:

addLocatorItems()

ilObjWikiGUI::addLocatorItems

(

)

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

References $_GET, ilObjectGUI\$locator, and getGotoLink().

    {
        $ilLocator = $this->locator;
        
        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:

addPagesSubTabs()

ilObjWikiGUI::addPagesSubTabs

(

)

Add Pages SubTabs.

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

References $_GET, ilObjectGUI\$ctrl, $tabs, ilWikiPage\getPageIdForTitle(), ilWikiUtil\makeDbTitle(), and ilWikiUtil\makeUrlTitle().

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

    {
        $ilTabs = $this->tabs;
        $ilCtrl = $this->ctrl;
        
        $ilTabs->activateTab("wiki_pages");
        
        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:

addPageTabs()

ilObjWikiGUI::addPageTabs

(

)

Add Page Tabs.

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

References $_GET, ilObjectGUI\$ctrl, $tabs, ilWikiPage\getPageIdForTitle(), ilWikiUtil\makeDbTitle(), and ilWikiUtil\makeUrlTitle().

    {
        $ilTabs = $this->tabs;
        $ilCtrl = $this->ctrl;
        
        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->getLinkTargetByClass(
                "ilwikipagegui",
                "printViewSelection"
            ),
            "printViewSelection"
        );
    }

Here is the call graph for this function:

afterSave()

ilObjWikiGUI::afterSave

(

ilObject

$newObj

)

save object public

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

References $ilSetting, ilObjectGUI\$settings, getGotoLink(), ilObject\getRefId(), ilUtil\redirect(), ilObject\setDescription(), ilObject\setTitle(), and ilObject\update().

    {
        $ilSetting = $this->settings;
        
        $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->setRatingAsBlock($this->form_gui->getInput("rating_side"));
        $newObj->setRatingForNewPages($this->form_gui->getInput("rating_new"));
        $newObj->setRatingCategories($this->form_gui->getInput("rating_ext"));

        $newObj->setRatingOverall($this->form_gui->getInput("rating_overall"));
        $newObj->setPageToc($this->form_gui->getInput("page_toc"));



        if (!$ilSetting->get("disable_comments")) {
            $newObj->setPublicNotes($this->form_gui->getInput("public_notes"));
        }
        $newObj->setOnline($this->form_gui->getInput("online"));
        $newObj->update();

        // always send a message
        ilUtil::sendSuccess($this->lng->txt("object_added"), true);
        ilUtil::redirect(ilObjWikiGUI::getGotoLink($newObj->getRefId()));
    }

Here is the call graph for this function:

allPagesObject()

ilObjWikiGUI::allPagesObject

(

)

All pages of wiki.

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

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

    {
        $tpl = $this->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:

cancelCreationPageUsingTemplateObject()

ilObjWikiGUI::cancelCreationPageUsingTemplateObject

(

)

Cancel page creation using a template.

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

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

    {
        $ilCtrl = $this->ctrl;

        // redirect to newly created page
        $ilCtrl->setParameterByClass("ilwikipagegui", "page", ilWikiUtil::makeUrlTitle(($_GET["from_page"])));
        $ilCtrl->redirectByClass("ilwikipagegui", "preview");
    }

Here is the call graph for this function:

checkPermissionBool()

ilObjWikiGUI::checkPermissionBool (   $a_perm,   $a_cmd = "",   $a_type = "",   $a_ref_id = null  )

protected

Check permission.

Parameters

string	$a_perm
string	$a_cmd
string	$a_type
int	$a_ref_id

Returns

bool

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

References ilWikiPerm\check().

Referenced by saveObject().

    {
        if ($a_perm == "create") {
            return parent::checkPermissionBool($a_perm, $a_cmd, $a_type, $a_ref_id);
        } else {
            if (!$a_ref_id) {
                $a_ref_id = $this->object->getRefId();
            }
            include_once("./Modules/Wiki/classes/class.ilWikiPerm.php");
            return ilWikiPerm::check($a_perm, $a_ref_id, $a_cmd);
        }
    }

Here is the call graph for this function:

Here is the caller graph for this function:

confirmRemoveImportantPagesObject()

ilObjWikiGUI::confirmRemoveImportantPagesObject

(

)

Confirm important pages deletion.

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

References $_POST, ilObjectGUI\$ctrl, $i, ilObjectGUI\$lng, ilObjectGUI\$tpl, ilWikiPage\lookupTitle(), and ilUtil\sendInfo().

    {
        $ilCtrl = $this->ctrl;
        $tpl = $this->tpl;
        $lng = $this->lng;

        if (!is_array($_POST["imp_page_id"]) || count($_POST["imp_page_id"]) == 0) {
            ilUtil::sendInfo($lng->txt("no_checkbox"), true);
            $ilCtrl->redirect($this, "editImportantPages");
        } else {
            include_once("./Services/Utilities/classes/class.ilConfirmationGUI.php");
            $cgui = new ilConfirmationGUI();
            $cgui->setFormAction($ilCtrl->getFormAction($this));
            $cgui->setHeaderText($lng->txt("wiki_sure_remove_imp_pages"));
            $cgui->setCancel($lng->txt("cancel"), "editImportantPages");
            $cgui->setConfirm($lng->txt("remove"), "removeImportantPages");

            foreach ($_POST["imp_page_id"] as $i) {
                $cgui->addItem("imp_page_id[]", $i, ilWikiPage::lookupTitle((int) $i));
            }

            $tpl->setContent($cgui->getHTML());
        }
    }

Here is the call graph for this function:

createPageUsingTemplateObject()

ilObjWikiGUI::createPageUsingTemplateObject

(

)

Save creation with template form.

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

References $_POST, ilObjectGUI\$ctrl, ilObjectGUI\$lng, ilObjectGUI\$tpl, initTemplateSelectionForm(), and ilWikiUtil\makeUrlTitle().

    {
        $tpl = $this->tpl;
        $lng = $this->lng;
        $ilCtrl = $this->ctrl;

        $form = $this->initTemplateSelectionForm();
        if ($form->checkInput()) {
            $a_page = $_POST["page"];
            $this->object->createWikiPage($a_page, (int) $_POST["page_templ"]);

            // redirect to newly created page
            $ilCtrl->setParameterByClass("ilwikipagegui", "page", ilWikiUtil::makeUrlTitle(($a_page)));
            $ilCtrl->redirectByClass("ilwikipagegui", "edit");

            ilUtil::sendSuccess($lng->txt("msg_obj_modified"), true);
            $ilCtrl->redirect($this, "");
        } else {
            $form->setValuesByPost();
            $tpl->setContent($form->getHtml());
        }
    }

Here is the call graph for this function:

createStyleObject()

ilObjWikiGUI::createStyleObject

(

)

Create Style.

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

References ilObjectGUI\$ctrl.

    {
        $ilCtrl = $this->ctrl;

        $ilCtrl->redirectByClass("ilobjstylesheetgui", "create");
    }

deleteStyleObject()

ilObjWikiGUI::deleteStyleObject

(

)

Delete Style.

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

References ilObjectGUI\$ctrl.

    {
        $ilCtrl = $this->ctrl;

        $ilCtrl->redirectByClass("ilobjstylesheetgui", "delete");
    }

downloadUserHTMLExportObject()

ilObjWikiGUI::downloadUserHTMLExportObject

(

)

Download user html export file.

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

References ilObjectGUI\checkPermission().

    {
        $this->log->debug("download");
        $this->checkPermission("wiki_html_export");
        $this->object->deliverUserHTMLExport();
    }

Here is the call graph for this function:

downloadUserHTMLExportWithCommentsObject()

ilObjWikiGUI::downloadUserHTMLExportWithCommentsObject

(

)

Download user html export file.

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

References ilObjectGUI\checkPermission().

    {
        $this->log->debug("download");
        $this->checkPermission("wiki_html_export");
        $this->object->deliverUserHTMLExport(true);
    }

Here is the call graph for this function:

editImportantPagesObject()

ilObjWikiGUI::editImportantPagesObject

(

)

List important pages.

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

References ilObjectGUI\$ctrl, $i, ilObjectGUI\$lng, $si, $tabs, ilObjectGUI\$toolbar, ilObjectGUI\$tpl, ilObjWiki\_lookupImportantPagesList(), ilObjectGUI\checkPermission(), ilWikiPage\getAllWikiPages(), ilUtil\sendInfo(), setSettingsSubTabs(), and ilUtil\shortenText().

    {
        $tpl = $this->tpl;
        $ilToolbar = $this->toolbar;
        $ilTabs = $this->tabs;
        $lng = $this->lng;
        $ilCtrl = $this->ctrl;

        $this->checkPermission("edit_wiki_navigation");

        ilUtil::sendInfo($lng->txt("wiki_navigation_info"));
        
        $ipages = ilObjWiki::_lookupImportantPagesList($this->object->getId());
        $ipages_ids = array();
        foreach ($ipages as $i) {
            $ipages_ids[] = $i["page_id"];
        }

        // list pages
        include_once("./Modules/Wiki/classes/class.ilWikiPage.php");
        $pages = ilWikiPage::getAllWikiPages($this->object->getId());
        $options = array("" => $lng->txt("please_select"));
        foreach ($pages as $p) {
            if (!in_array($p["id"], $ipages_ids)) {
                $options[$p["id"]] = ilUtil::shortenText($p["title"], 60, true);
            }
        }
        if (count($options) > 0) {
            include_once("./Services/Form/classes/class.ilSelectInputGUI.php");
            $si = new ilSelectInputGUI($lng->txt("wiki_pages"), "imp_page_id");
            $si->setOptions($options);
            $si->setInfo($lng->txt(""));
            $ilToolbar->addInputItem($si);
            $ilToolbar->setFormAction($ilCtrl->getFormAction($this));
            $ilToolbar->addFormButton($lng->txt("add"), "addImportantPage");
        }


        $ilTabs->activateTab("settings");
        $this->setSettingsSubTabs("imp_pages");

        include_once("./Modules/Wiki/classes/class.ilImportantPagesTableGUI.php");
        $imp_table = new ilImportantPagesTableGUI($this, "editImportantPages");

        $tpl->setContent($imp_table->getHTML());
    }

Here is the call graph for this function:

editSettingsObject()

ilObjWikiGUI::editSettingsObject

(

)

Edit settings.

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

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

    {
        $tpl = $this->tpl;
        
        $this->checkPermission("write");
        
        $this->setSettingsSubTabs("general_settings");
        
        $this->initSettingsForm();
        $this->getSettingsFormValues();
        
        // Edit ecs export settings
        include_once 'Modules/Wiki/classes/class.ilECSWikiSettings.php';
        $ecs = new ilECSWikiSettings($this->object);
        $ecs->addSettingsToForm($this->form_gui, 'wiki');
        
        $tpl->setContent($this->form_gui->getHtml());
        $this->setSideBlock();
    }

Here is the call graph for this function:

editStyleObject()

ilObjWikiGUI::editStyleObject

(

)

Edit Style.

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

References ilObjectGUI\$ctrl.

    {
        $ilCtrl = $this->ctrl;

        $ilCtrl->redirectByClass("ilobjstylesheetgui", "edit");
    }

editStylePropertiesObject()

ilObjWikiGUI::editStylePropertiesObject

(

)

Edit style properties.

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

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

    {
        $ilTabs = $this->tabs;
        $tpl = $this->tpl;
        
        $this->checkPermission("write");
        
        $this->initStylePropertiesForm();
        $tpl->setContent($this->form->getHTML());
        
        $ilTabs->activateTab("settings");
        $this->setSettingsSubTabs("style");
        
        $this->setSideBlock();
    }

Here is the call graph for this function:

executeCommand()

ilObjWikiGUI::executeCommand

(

)

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

References $_GET, ilObjectGUI\$access, ilObjectGUI\$ctrl, $ilUser, $ret, $tabs, ilObjectGUI\$tpl, ilObjectGUI\$user, ilObjectGUI\addHeaderAction(), ilObjectGUI\checkPermission(), ilObjStyleSheet\getEffectiveContentStyleId(), ilWikiPageGUI\getGUIForTitle(), ilCommonActionDispatcherGUI\getInstanceFromAjaxCall(), infoScreen(), ilWikiUtil\makeDbTitle(), ilObjectGUI\omitLocator(), ilObjectGUI\prepareOutput(), setContentStyleSheet(), setSettingsSubTabs(), setSideBlock(), and triggerAssignmentTool().

    {
        $ilUser = $this->user;
        $ilCtrl = $this->ctrl;
        $tpl = $this->tpl;
        $ilTabs = $this->tabs;
        $ilAccess = $this->access;
  
        $next_class = $this->ctrl->getNextClass($this);
        $cmd = $this->ctrl->getCmd();

        $this->triggerAssignmentTool();

        $this->prepareOutput();
        
        // see ilWikiPageGUI::printViewOrderList()
        // printView() and pdfExport() cannot be in ilWikiPageGUI because of stylesheet confusion
        if ($cmd == "printView" || $cmd == "pdfExport") {
            $next_class = null;
        }
    
        switch ($next_class) {
            case "ilinfoscreengui":
                $this->checkPermission("visible");
                $this->addHeaderAction();
                $this->infoScreen();    // forwards command
                break;

            case 'ilpermissiongui':
                $this->addHeaderAction();
                $ilTabs->activateTab("perm_settings");
                include_once("Services/AccessControl/classes/class.ilPermissionGUI.php");
                $perm_gui = new ilPermissionGUI($this);
                $ret = $this->ctrl->forwardCommand($perm_gui);
                break;

            case 'ilsettingspermissiongui':
                $this->checkPermission("write");
                $this->addHeaderAction();
                $ilTabs->activateTab("settings");
                $this->setSettingsSubTabs("permission_settings");
                include_once("Services/AccessControl/classes/class.ilSettingsPermissionGUI.php");
                $perm_gui = new ilSettingsPermissionGUI($this);
                $perm_gui->setPermissions(array("edit_wiki_navigation", "delete_wiki_pages", "activate_wiki_protection",
                    "wiki_html_export"));
                $perm_gui->setRoleRequiredPermissions(array("edit_content"));
                $perm_gui->setRoleProhibitedPermissions(array("write"));
                $ret = $this->ctrl->forwardCommand($perm_gui);
                break;

            case 'ilwikipagegui':
                $this->checkPermission("read");
                include_once("./Modules/Wiki/classes/class.ilWikiPageGUI.php");
                $wpage_gui = ilWikiPageGUI::getGUIForTitle(
                    $this->object->getId(),
                    ilWikiUtil::makeDbTitle($_GET["page"]),
                    $_GET["old_nr"],
                    $this->object->getRefId()
                );
                include_once("./Services/Style/Content/classes/class.ilObjStyleSheet.php");
                $wpage_gui->setStyleId(ilObjStyleSheet::getEffectiveContentStyleId(
                    $this->object->getStyleSheetId(),
                    "wiki"
                ));
                $this->setContentStyleSheet();
                if (!$ilAccess->checkAccess("write", "", $this->object->getRefId()) &&
                    (
                        !$ilAccess->checkAccess("edit_content", "", $this->object->getRefId()) ||
                        $wpage_gui->getPageObject()->getBlocked()
                    )) {
                    $wpage_gui->setEnableEditing(false);
                }
                
                // alter title and description
//                              $tpl->setTitle($wpage_gui->getPageObject()->getTitle());
//                              $tpl->setDescription($this->object->getTitle());
                if ($ilAccess->checkAccess("write", "", $this->object->getRefId())) {
                    $wpage_gui->activateMetaDataEditor($this->object, "wpg", $wpage_gui->getId());
                }
                
                $ret = $this->ctrl->forwardCommand($wpage_gui);
                if ($ret != "") {
                    $tpl->setContent($ret);
                }
                break;

            case 'ilobjectcopygui':
                include_once './Services/Object/classes/class.ilObjectCopyGUI.php';
                $cp = new ilObjectCopyGUI($this);
                $cp->setType('wiki');
                $this->ctrl->forwardCommand($cp);
                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;
                
            case "ilobjstylesheetgui":
                include_once("./Services/Style/Content/classes/class.ilObjStyleSheetGUI.php");
                $this->ctrl->setReturn($this, "editStyleProperties");
                $style_gui = new ilObjStyleSheetGUI("", $this->object->getStyleSheetId(), false, false);
                $style_gui->omitLocator();
                if ($cmd == "create" || $_GET["new_type"] == "sty") {
                    $style_gui->setCreationMode(true);
                }

                if ($cmd == "confirmedDelete") {
                    $this->object->setStyleSheetId(0);
                    $this->object->update();
                }

                $ret = $this->ctrl->forwardCommand($style_gui);

                if ($cmd == "save" || $cmd == "copyStyle" || $cmd == "importStyle") {
                    $style_id = $ret;
                    $this->object->setStyleSheetId($style_id);
                    $this->object->update();
                    $this->ctrl->redirectByClass("ilobjstylesheetgui", "edit");
                }
                break;
                
            case "ilexportgui":
//                              $this->prepareOutput();
                $this->addHeaderAction();
                $ilTabs->activateTab("export");
                include_once("./Services/Export/classes/class.ilExportGUI.php");
                $exp_gui = new ilExportGUI($this);
                $exp_gui->addFormat("xml");
                $exp_gui->addFormat("html", "", $this, "exportHTML");
                if ($this->object->isCommentsExportPossible()) {
                    $exp_gui->addFormat("html_comments", "HTML (" . $this->lng->txt("wiki_incl_comments") . ")", $this, "exportHTML");
                }
                $ret = $this->ctrl->forwardCommand($exp_gui);
//                              $this->tpl->show();
                break;
            
            case "ilcommonactiondispatchergui":
                include_once("Services/Object/classes/class.ilCommonActionDispatcherGUI.php");
                $gui = ilCommonActionDispatcherGUI::getInstanceFromAjaxCall();
                $this->ctrl->forwardCommand($gui);
                break;
            
            case "ilratinggui":
                // for rating category editing
                $this->checkPermission("write");
                $this->addHeaderAction();
                $ilTabs->activateTab("settings");
                $this->setSettingsSubTabs("rating_categories");
                include_once("Services/Rating/classes/class.ilRatingGUI.php");
                $gui = new ilRatingGUI();
                $gui->setObject($this->object->getId(), $this->object->getType());
                $gui->setExportCallback(array($this, "getSubObjectTitle"), $this->lng->txt("page"));
                $this->ctrl->forwardCommand($gui);
                break;
            
            case "ilwikistatgui":
                $this->checkPermission("statistics_read");
                
                $this->addHeaderAction();
                $ilTabs->activateTab("statistics");
                
                include_once "Modules/Wiki/classes/class.ilWikiStatGUI.php";
                $gui = new ilWikiStatGUI($this->object->getId());
                $this->ctrl->forwardCommand($gui);
                break;

            case "ilwikipagetemplategui":
                $this->checkPermission("write");
                $this->addHeaderAction();
                $ilTabs->activateTab("settings");
                $this->setSettingsSubTabs("page_templates");
                include_once("./Modules/Wiki/classes/class.ilWikiPageTemplateGUI.php");
                $wptgui = new ilWikiPageTemplateGUI($this);
                $this->ctrl->forwardCommand($wptgui);
                break;
            
            case 'ilobjectmetadatagui':
                $this->checkPermission("write");
                $this->addHeaderAction();
                $ilTabs->activateTab("advmd");
                include_once 'Services/Object/classes/class.ilObjectMetaDataGUI.php';
                $md_gui = new ilObjectMetaDataGUI($this->object, "wpg");
                $this->ctrl->forwardCommand($md_gui);
                break;

            case 'ilrepositoryobjectsearchgui':
                $this->addHeaderAction();
                $this->setSideBlock();
                $ilTabs->setTabActive("wiki_search_results");
                $ilCtrl->setReturn($this, 'view');
                include_once './Services/Search/classes/class.ilRepositoryObjectSearchGUI.php';
                $search_gui = new ilRepositoryObjectSearchGUI(
                    $this->object->getRefId(),
                    $this,
                    'view'
                );
                $ilCtrl->forwardCommand($search_gui);
                break;

            case 'ilobjnotificationsettingsgui':
                $this->addHeaderAction();
                $ilTabs->activateTab("settings");
                $this->setSettingsSubTabs("notifications");
                include_once("./Services/Notification/classes/class.ilObjNotificationSettingsGUI.php");
                $gui = new ilObjNotificationSettingsGUI($this->object->getRefId());
                $this->ctrl->forwardCommand($gui);
                break;

            default:
                $this->addHeaderAction();
                if (!$cmd) {
                    $cmd = "infoScreen";
                }
                $cmd .= "Object";
                if ($cmd != "cancelObject") {
                    if ($cmd != "infoScreenObject") {
                        if (!in_array($cmd, array("createObject", "saveObject", "importFileObject"))) {
                            $this->checkPermission("read");
                        }
                    } else {
                        $this->checkPermission("visible");
                    }
                }
                $this->$cmd();
                break;
        }
  
        return $ret;
    }

Here is the call graph for this function:

exportHTML()

ilObjWikiGUI::exportHTML

(

)

Create html package.

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

References $_POST, and $format.

    {
        $cont_exp = new Export\WikiHtmlExport($this->object);

        $format = explode("_", $_POST["format"]);
        if ($format[1] == "comments") {
            $cont_exp->setMode(Export\WikiHtmlExport::MODE_COMMENTS);
        }

        $cont_exp->buildExportFile();
    }

getAssignmentButtons()

ilObjWikiGUI::getAssignmentButtons ( )

protected

Get assignment buttons.

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

References ilObjectGUI\$ctrl, $i, ilObjectGUI\$lng, $ui, ilExAssignment\afterDeadlineStrict(), ilExcRepoObjAssignment\getInstance(), ilExSubmission\getSelectedObject(), and user().

Referenced by triggerAssignmentTool().

    {
        $ilCtrl = $this->ctrl;
        $ui = $this->ui;
        $lng = $this->lng;

        $ass_info = ilExcRepoObjAssignment::getInstance()->getAssignmentInfoOfObj(
            $this->object->getRefId(),
            $this->user->getId()
        );
        $buttons = [];
        foreach ($ass_info as $i) {     // should be only one
            $ass = new ilExAssignment($i->getId());
            $times_up = $ass->afterDeadlineStrict();

            // submit button
            if (!$times_up) {
                $ilCtrl->setParameterByClass("ilwikipagegui", "ass", $ass->getId());
                $submit_link = $ilCtrl->getLinkTargetByClass("ilwikipagegui", "finalizeAssignment");
                $ilCtrl->setParameterByClass("ilwikipagegui", "ass", "");

                $buttons[$i->getId()][] = $ui->factory()->button()->primary($lng->txt("wiki_finalize_wiki"), $submit_link);
            }

            // submitted files
            include_once "Modules/Exercise/classes/class.ilExSubmission.php";
            $submission = new ilExSubmission($ass, $this->user->getId());
            if ($submission->hasSubmitted()) {
                $submitted = $submission->getSelectedObject();
                if ($submitted["ts"] != "") {
                    $ilCtrl->setParameterByClass("ilwikipagegui", "ass", $ass->getId());
                }
                $dl_link = $ilCtrl->getLinkTargetByClass("ilwikipagegui", "downloadExcSubFile");
                $ilCtrl->setParameterByClass("ilwikipagegui", "ass", "");
                $buttons[$i->getId()][] = $ui->factory()->button()->standard($lng->txt("wiki_download_submission"), $dl_link);
            }
        }
        return $buttons;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

getGotoLink()

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

static

Get goto link.

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

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

Referenced by addLocatorItems(), afterSave(), ilObjWiki\decorateAdvMDValue(), ilWikiPagesTableGUI\fillRow(), ilObjWikiSubItemListGUI\getHTML(), ilWikiImportantPagesBlockGUI\getLegacyContent(), getTabs(), gotoPageObject(), gotoStartPageObject(), and infoScreen().

    {
        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:

getPrintPageIds()

ilObjWikiGUI::getPrintPageIds ( )

protected

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

References $_GET, and $_POST.

Referenced by printViewObject().

    {
        // multiple ordered page ids
        if (is_array($_POST["wordr"])) {
            asort($_POST["wordr"]);
            $page_ids = array_keys($_POST["wordr"]);
        }
        // single page
        elseif ((int) $_GET["wpg_id"]) {
            $page_ids = array((int) $_GET["wpg_id"]);
        }
        
        return $page_ids;
    }

Here is the caller graph for this function:

getSettingsFormValues()

ilObjWikiGUI::getSettingsFormValues

(

$a_mode = "edit"

)

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

References $_GET, $ilUser, ilObjectGUI\$lng, ilObjectGUI\$user, ilWikiPage\_getPageIdForWikiTitle(), and ilObject\hasAutoRating().

Referenced by editSettingsObject(), and initCreationForms().

    {
        $lng = $this->lng;
        $ilUser = $this->user;
        
        // set values
        if ($a_mode == "create") {
            //$values["startpage"] = $lng->txt("wiki_main_page");
            $values["rating_new"] = true;
            
            $values["rating_overall"] = ilObject::hasAutoRating("wiki", $_GET["ref_id"]);
            
            $this->form_gui->setValuesByArray($values);
        } else {
            $values["online"] = $this->object->getOnline();
            $values["title"] = $this->object->getTitle();
            //$values["startpage"] = $this->object->getStartPage();
            $values["startpage_id"] = ilWikiPage::_getPageIdForWikiTitle($this->object->getId(), $this->object->getStartPage());
            $values["shorttitle"] = $this->object->getShortTitle();
            $values["description"] = $this->object->getLongDescription();
            $values["rating_overall"] = $this->object->getRatingOverall();
            $values["rating"] = $this->object->getRating();
            // $values["rating_side"] = $this->object->getRatingAsBlock();
            $values["rating_new"] = $this->object->getRatingForNewPages();
            $values["rating_ext"] = $this->object->getRatingCategories();
            $values["public_notes"] = $this->object->getPublicNotes();
            $values["intro"] = $this->object->getIntroduction();
            //                  $values["imp_pages"] = $this->object->getImportantPages();
            $values["page_toc"] = $this->object->getPageToc();
            $values["link_md_values"] = $this->object->getLinkMetadataValues();
                        
            // only set given values (because of adv. metadata)
            $this->form_gui->setValuesByArray($values, true);
        }
    }

Here is the call graph for this function:

Here is the caller graph for this function:

getSubObjectTitle()

ilObjWikiGUI::getSubObjectTitle	(		$a_id,
			$a_type
	)

Used for rating export.

Parameters

int	$a_id
string	$a_type

Returns

string

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

References ilWikiPage\lookupTitle().

    {
        include_once "Modules/Wiki/classes/class.ilWikiPage.php";
        return ilWikiPage::lookupTitle($a_id);
    }

Here is the call graph for this function:

getTabs()

ilObjWikiGUI::getTabs

(

)

get tabs public

Parameters

object

tabs gui object

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

References $_GET, ilObjectGUI\$access, ilObjectGUI\$ctrl, $help, ilObjectGUI\$lng, getGotoLink(), and ilWikiUtil\makeDbTitle().

    {
        $ilCtrl = $this->ctrl;
        $ilAccess = $this->access;
        $lng = $this->lng;
        $ilHelp = $this->help;
        
        $ilHelp->setScreenIdComponent("wiki");
        
        // wiki tabs
        if (in_array($ilCtrl->getCmdClass(), array("", "ilobjwikigui",
            "ilinfoscreengui", "ilpermissiongui", "ilexportgui", "ilratingcategorygui", "ilobjnotificationsettingsgui", "iltaxmdgui",
            "ilwikistatgui", "ilwikipagetemplategui", "iladvancedmdsettingsgui", "ilsettingspermissiongui", 'ilrepositoryobjectsearchgui'
            )) || (in_array($ilCtrl->getNextClass(), array("ilpermissiongui")))) {
            if ($_GET["page"] != "") {
                $this->tabs_gui->setBackTarget(
                    $lng->txt("wiki_last_visited_page"),
                    $this->getGotoLink(
                        $_GET["ref_id"],
                        ilWikiUtil::makeDbTitle($_GET["page"])
                    )
                );
            }
            
            // pages
            if ($ilAccess->checkAccess('read', "", $this->object->getRefId())) {
                $this->tabs_gui->addTab(
                    "wiki_pages",
                    $lng->txt("wiki_pages"),
                    $this->ctrl->getLinkTarget($this, "allPages")
                );
            }
            
            // info screen
            if ($ilAccess->checkAccess('visible', "", $this->object->getRefId())) {
                $this->tabs_gui->addTab(
                    "info_short",
                    $lng->txt("info_short"),
                    $this->ctrl->getLinkTargetByClass("ilinfoscreengui", "showSummary")
                );
            }
    
            // settings
            if ($ilAccess->checkAccess('write', "", $this->object->getRefId())) {
                $this->tabs_gui->addTab(
                    "settings",
                    $lng->txt("settings"),
                    $this->ctrl->getLinkTarget($this, "editSettings")
                );
                            
                // metadata
                include_once "Services/Object/classes/class.ilObjectMetaDataGUI.php";
                $mdgui = new ilObjectMetaDataGUI($this->object, "wpg");
                $mdtab = $mdgui->getTab();
                if ($mdtab) {
                    $this->tabs_gui->addTab(
                        "advmd",
                        $this->lng->txt("meta_data"),
                        $mdtab
                    );
                }
            }
            
            // contributors
            if ($ilAccess->checkAccess('write', "", $this->object->getRefId())) {
                $this->tabs_gui->addTab(
                    "wiki_contributors",
                    $lng->txt("wiki_contributors"),
                    $this->ctrl->getLinkTarget($this, "listContributors")
                );
            }

            // statistics
            if ($ilAccess->checkAccess('statistics_read', "", $this->object->getRefId())) {
                $this->tabs_gui->addTab(
                    "statistics",
                    $lng->txt("statistics"),
                    $this->ctrl->getLinkTargetByClass("ilWikiStatGUI", "initial")
                );
            }

            if ($ilAccess->checkAccess("write", "", $this->object->getRefId())) {
                $this->tabs_gui->addTab(
                    "export",
                    $lng->txt("export"),
                    $this->ctrl->getLinkTargetByClass("ilexportgui", "")
                );
            }
        
            // edit permissions
            if ($ilAccess->checkAccess('edit_permission', "", $this->object->getRefId())) {
                $this->tabs_gui->addTab(
                    "perm_settings",
                    $lng->txt("perm_settings"),
                    $this->ctrl->getLinkTargetByClass("ilpermissiongui", "perm")
                );
            }
        }
    }

Here is the call graph for this function:

getUserHTMLExportProgressObject()

ilObjWikiGUI::getUserHTMLExportProgressObject

(

)

Get user html export progress.

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

References ilObjectGUI\checkPermission(), ilJsonUtil\encode(), exit, and ilProgressBar\getInstance().

    {
        $this->log->debug("get progress: " . $this->req_with_comments);
        $this->checkPermission("wiki_html_export");
        $p = $this->object->getUserHTMLExportProgress($this->req_with_comments);

        include_once("./Services/UIComponent/ProgressBar/classes/class.ilProgressBar.php");
        $pb = ilProgressBar::getInstance();
        $pb->setCurrent($p["progress"]);

        $r = new stdClass();
        $r->progressBar = $pb->render();
        $r->status = $p["status"];
        include_once("./Services/JSON/classes/class.ilJsonUtil.php");
        $this->log->debug("status: " . $r->status);
        echo(ilJsonUtil::encode($r));
        exit;
    }

Here is the call graph for this function:

gotoPageObject()

ilObjWikiGUI::gotoPageObject

(

$a_page = ""

)

Go to specific page.

Parameters

string

$a_page

page title

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

References $_GET, ilObjectGUI\$ctrl, ilWikiPage\_wikiPageExists(), getGotoLink(), ilWikiUtil\makeDbTitle(), ilWikiUtil\makeUrlTitle(), ilUtil\redirect(), ilUtil\sendFailure(), and ilStr\strLen().

Referenced by randomPageObject().

    {
        $ilCtrl = $this->ctrl;
        
        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 {
            if (!$this->access->checkAccess("edit_content", "", $this->object->getRefId())) {
                ilUtil::sendFailure($this->lng->txt("no_permission"), true);
                ilUtil::redirect(ilObjWikiGUI::getGotoLink($this->object->getRefId(), $_GET["from_page"]));
            }
            if (!$this->object->getTemplateSelectionOnCreation()) {

                // check length
                include_once("./Services/Utilities/classes/class.ilStr.php");
                if (ilStr::strLen(ilWikiUtil::makeDbTitle($a_page)) > 200) {
                    ilUtil::sendFailure($this->lng->txt("wiki_page_title_too_long") . " (" . $a_page . ")", true);
                    $ilCtrl->setParameterByClass("ilwikipagegui", "page", ilWikiUtil::makeUrlTitle($_GET["from_page"]));
                    $ilCtrl->redirectByClass("ilwikipagegui", "preview");
                }
                $this->object->createWikiPage($a_page);

                // redirect to newly created page
                $ilCtrl->setParameterByClass("ilwikipagegui", "page", ilWikiUtil::makeUrlTitle(($a_page)));
                $ilCtrl->redirectByClass("ilwikipagegui", "edit");
            } else {
                $ilCtrl->setParameter($this, "page", ilWikiUtil::makeUrlTitle($_GET["page"]));
                $ilCtrl->setParameter($this, "from_page", ilWikiUtil::makeUrlTitle($_GET["from_page"]));
                $ilCtrl->redirect($this, "showTemplateSelection");
            }
        }
    }

Here is the call graph for this function:

Here is the caller graph for this function:

gotoStartPageObject()

ilObjWikiGUI::gotoStartPageObject

(

)

Go to start page.

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

References ilObjectGUI\$ctrl, getGotoLink(), and ilUtil\redirect().

Referenced by viewObject().

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

Here is the call graph for this function:

Here is the caller graph for this function:

infoScreen()

ilObjWikiGUI::infoScreen

(

)

show information screen

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

References ilObjectGUI\$access, $error, ilObjectGUI\$ilErr, $ilUser, ilObjectGUI\$lng, $tabs, ilObjectGUI\$user, ilLPMarks\_lookupComment(), ilLPMarks\_lookupMark(), ilWikiContributor\_lookupStatus(), getGotoLink(), ilWikiContributor\STATUS_FAILED, ilWikiContributor\STATUS_NOT_GRADED, and ilWikiContributor\STATUS_PASSED.

Referenced by executeCommand(), and infoScreenObject().

    {
        $ilAccess = $this->access;
        $ilUser = $this->user;
        $ilTabs = $this->tabs;
        $lng = $this->lng;
        $ilErr = $this->error;
        
        $ilTabs->activateTab("info_short");

        if (!$ilAccess->checkAccess("visible", "", $this->object->getRefId())) {
            $ilErr->raiseError($this->lng->txt("msg_no_perm_read"), $ilErr->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:

infoScreenObject()

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 436 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:

initCreationForms()

ilObjWikiGUI::initCreationForms (   $a_new_type )

protected

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

References ilObjectGUI\fillCloneTemplate(), getSettingsFormValues(), ilObjectGUI\initImportForm(), and initSettingsForm().

    {
        $this->initSettingsForm("create");
        $this->getSettingsFormValues("create");

        $forms = array(self::CFORM_NEW => $this->form_gui,
                self::CFORM_IMPORT => $this->initImportForm($a_new_type),
                self::CFORM_CLONE => $this->fillCloneTemplate(null, $a_new_type));

        return $forms;
    }

Here is the call graph for this function:

initSettingsForm()

ilObjWikiGUI::initSettingsForm

(

$a_mode = "edit"

)

Init Settings Form.

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

References ilObjectGUI\$ctrl, $ilSetting, ilObjectGUI\$lng, ilObjectGUI\$object_service, $section, ilObjectGUI\$settings, $si, $tabs, ilAdvancedMDRecord\_getSelectedRecordsByObject(), ilSubEnabledFormPropertyGUI\addSubItem(), ilObjectServiceSettingsGUI\CUSTOM_METADATA, ilWikiPage\getAllWikiPages(), ilUtil\getImagePath(), ilObjectServiceSettingsGUI\initServiceSettingsForm(), ilTextAreaInputGUI\setCols(), ilFormPropertyGUI\setInfo(), and ilUtil\shortenText().

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

    {
        $lng = $this->lng;
        $ilCtrl = $this->ctrl;
        $ilTabs = $this->tabs;
        $ilSetting = $this->settings;
        $obj_service = $this->object_service;
        
        $lng->loadLanguageModule("wiki");
        $ilTabs->activateTab("settings");
        
        require_once("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
        if ($a_mode == "edit") {
            $pages = ilWikiPage::getAllWikiPages($this->object->getId());
            foreach ($pages as $p) {
                $options[$p["id"]] = ilUtil::shortenText($p["title"], 60, true);
            }
            $si = new ilSelectInputGUI($lng->txt("wiki_start_page"), "startpage_id");
            $si->setOptions($options);
            $this->form_gui->addItem($si);
        } else {
            $sp = new ilTextInputGUI($lng->txt("wiki_start_page"), "startpage");
            if ($a_mode == "edit") {
                $sp->setInfo($lng->txt("wiki_start_page_info"));
            }
            $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
        
        $lng->loadLanguageModule('rating');
        $rate = new ilCheckboxInputGUI($lng->txt('rating_activate_rating'), 'rating_overall');
        $rate->setInfo($lng->txt('rating_activate_rating_info'));
        $this->form_gui->addItem($rate);
                
        $rating = new ilCheckboxInputGUI($lng->txt("wiki_activate_rating"), "rating");
        $this->form_gui->addItem($rating);
        
        /* always active
        $side = new ilCheckboxInputGUI($lng->txt("wiki_activate_sideblock_rating"), "rating_side");
        $rating->addSubItem($side);
        */
        
        $new = new ilCheckboxInputGUI($lng->txt("wiki_activate_new_page_rating"), "rating_new");
        $rating->addSubItem($new);
        
        $extended = new ilCheckboxInputGUI($lng->txt("wiki_activate_extended_rating"), "rating_ext");
        $rating->addSubItem($extended);
        

        // public comments
        if (!$ilSetting->get("disable_comments")) {
            $comments = new ilCheckboxInputGUI($lng->txt("wiki_public_comments"), "public_notes");
            $this->form_gui->addItem($comments);
        }

        // important pages
        //              $imp_pages = new ilCheckboxInputGUI($lng->txt("wiki_important_pages"), "imp_pages");
        //              $this->form_gui->addItem($imp_pages);

        // page toc
        $page_toc = new ilCheckboxInputGUI($lng->txt("wiki_page_toc"), "page_toc");
        $page_toc->setInfo($lng->txt("wiki_page_toc_info"));
        $this->form_gui->addItem($page_toc);
        
        if ($a_mode == "edit") {
            // advanced metadata auto-linking
            include_once('Services/AdvancedMetaData/classes/class.ilAdvancedMDRecord.php');
            if (count(ilAdvancedMDRecord::_getSelectedRecordsByObject("wiki", $this->object->getRefId(), "wpg")) > 0) {
                $link_md = new ilCheckboxInputGUI($lng->txt("wiki_link_md_values"), "link_md_values");
                $link_md->setInfo($lng->txt("wiki_link_md_values_info"));
                $this->form_gui->addItem($link_md);
            }


            $section = new ilFormSectionHeaderGUI();
            $section->setTitle($this->lng->txt('obj_presentation'));
            $this->form_gui->addItem($section);

            // tile image
            $obj_service->commonSettings()->legacyForm($this->form_gui, $this->object)->addTileImage();


            // additional features
            $feat = new ilFormSectionHeaderGUI();
            $feat->setTitle($this->lng->txt('obj_features'));
            $this->form_gui->addItem($feat);

            include_once './Services/Container/classes/class.ilContainer.php';
            include_once './Services/Object/classes/class.ilObjectServiceSettingsGUI.php';
            ilObjectServiceSettingsGUI::initServiceSettingsForm(
                $this->object->getId(),
                $this->form_gui,
                array(
                        ilObjectServiceSettingsGUI::CUSTOM_METADATA
                    )
            );
        }
        
        // :TODO: sorting

        // Form action and save button
        $this->form_gui->setTitleIcon(ilUtil::getImagePath("icon_wiki.svg"));
        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:

initStylePropertiesForm()

ilObjWikiGUI::initStylePropertiesForm

(

)

Init style properties form.

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

References $_GET, ilObjectGUI\$ctrl, $ilSetting, ilObjectGUI\$lng, ilObjectGUI\$settings, $tabs, ilObjStyleSheet\_getStandardStyles(), ilObjStyleSheet\_lookupStandard(), ilObject\_lookupTitle(), ilUtil\formSelect(), and ilNonEditableValueGUI\setValue().

Referenced by editStylePropertiesObject().

    {
        $ilCtrl = $this->ctrl;
        $lng = $this->lng;
        $ilTabs = $this->tabs;
        $ilSetting = $this->settings;
        
        include_once("./Services/Style/Content/classes/class.ilObjStyleSheet.php");
        $lng->loadLanguageModule("style");

        include_once("./Services/Form/classes/class.ilPropertyFormGUI.php");
        $this->form = new ilPropertyFormGUI();
        
        $fixed_style = $ilSetting->get("fixed_content_style_id");
        $style_id = $this->object->getStyleSheetId();

        if ($fixed_style > 0) {
            $st = new ilNonEditableValueGUI($lng->txt("style_current_style"));
            $st->setValue(ilObject::_lookupTitle($fixed_style) . " (" .
                $this->lng->txt("global_fixed") . ")");
            $this->form->addItem($st);
        } else {
            $st_styles = ilObjStyleSheet::_getStandardStyles(
                true,
                false,
                $_GET["ref_id"]
            );

            $st_styles[0] = $this->lng->txt("default");
            ksort($st_styles);

            if ($style_id > 0) {
                // individual style
                if (!ilObjStyleSheet::_lookupStandard($style_id)) {
                    $st = new ilNonEditableValueGUI($lng->txt("style_current_style"));
                    $st->setValue(ilObject::_lookupTitle($style_id));
                    $this->form->addItem($st);

                    //$this->ctrl->getLinkTargetByClass("ilObjStyleSheetGUI", "edit"));

                    // delete command
                    $this->form->addCommandButton(
                        "editStyle",
                        $lng->txt("style_edit_style")
                    );
                    $this->form->addCommandButton(
                        "deleteStyle",
                        $lng->txt("style_delete_style")
                    );
                    //$this->ctrl->getLinkTargetByClass("ilObjStyleSheetGUI", "delete"));
                }
            }

            if ($style_id <= 0 || ilObjStyleSheet::_lookupStandard($style_id)) {
                $style_sel = ilUtil::formSelect(
                    $style_id,
                    "style_id",
                    $st_styles,
                    false,
                    true
                );
                $style_sel = new ilSelectInputGUI($lng->txt("style_current_style"), "style_id");
                $style_sel->setOptions($st_styles);
                $style_sel->setValue($style_id);
                $this->form->addItem($style_sel);
                //$this->ctrl->getLinkTargetByClass("ilObjStyleSheetGUI", "create"));
                $this->form->addCommandButton(
                    "saveStyleSettings",
                    $lng->txt("save")
                );
                $this->form->addCommandButton(
                    "createStyle",
                    $lng->txt("sty_create_ind_style")
                );
            }
        }
        $this->form->setTitle($lng->txt("wiki_style"));
        $this->form->setFormAction($ilCtrl->getFormAction($this));
    }

Here is the call graph for this function:

Here is the caller graph for this function:

initTemplateSelectionForm()

ilObjWikiGUI::initTemplateSelectionForm

(

)

Init template selection form.

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

References $_GET, ilObjectGUI\$ctrl, ilObjectGUI\$lng, ilWikiPageTemplate\getAllInfo(), ilFormPropertyGUI\setRequired(), and ilWikiPageTemplate\TYPE_NEW_PAGES.

Referenced by createPageUsingTemplateObject(), and showTemplateSelectionObject().

    {
        $lng = $this->lng;
        $ilCtrl = $this->ctrl;

        include_once("Services/Form/classes/class.ilPropertyFormGUI.php");
        $form = new ilPropertyFormGUI();

        // page name
        $hi = new ilHiddenInputGUI("page");
        $hi->setValue($_GET["page"]);
        $form->addItem($hi);

        // page template
        $radg = new ilRadioGroupInputGUI($lng->txt("wiki_page_template"), "page_templ");
        $radg->setRequired(true);

        if ($this->object->getEmptyPageTemplate()) {
            $op1 = new ilRadioOption($lng->txt("wiki_empty_page"), 0);
            $radg->addOption($op1);
        }

        include_once("./Modules/Wiki/classes/class.ilWikiPageTemplate.php");
        $wt = new ilWikiPageTemplate($this->object->getId());
        $ts = $wt->getAllInfo(ilWikiPageTemplate::TYPE_NEW_PAGES);
        foreach ($ts as $t) {
            $op = new ilRadioOption($t["title"], $t["wpage_id"]);
            $radg->addOption($op);
        }

        $form->addItem($radg);

        // save and cancel commands
        $form->addCommandButton("createPageUsingTemplate", $lng->txt("wiki_create_page"));
        $form->addCommandButton("cancelCreationPageUsingTemplate", $lng->txt("cancel"));

        $form->setTitle($lng->txt("wiki_new_page") . ": " . $_GET["page"]);
        $form->setFormAction($ilCtrl->getFormAction($this));

        return $form;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

initUserHTMLExportObject()

ilObjWikiGUI::initUserHTMLExportObject

(

)

Export html (as user)

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

References ilObjectGUI\checkPermission().

    {
        $this->log->debug("init: " . $this->req_with_comments);
        $this->checkPermission("wiki_html_export");
        $this->object->initUserHTMLExport($this->req_with_comments);
    }

Here is the call graph for this function:

isOnlineHelpWiki()

ilObjWikiGUI::isOnlineHelpWiki

(

)

Is wiki an online help wiki?

Returns

boolean true, if current wiki is an online help wiki

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

References ilObjWiki\isOnlineHelpWiki().

    {
        if (is_object($this->object)) {
            return ilObjWiki::isOnlineHelpWiki($this->object->getRefId());
        }
        return false;
    }

Here is the call graph for this function:

listContributorsObject()

ilObjWikiGUI::listContributorsObject

(

)

List all contributors.

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

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

    {
        $tpl = $this->tpl;
        $ilTabs = $this->tabs;
        
        $this->checkPermission("write");
        $ilTabs->activateTab("wiki_contributors");
        
        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:

lookupSubObjectTitle()

static ilObjWikiGUI::lookupSubObjectTitle (   $a_wiki_id,   $a_page_id  )

static

Get title for wiki page (used in ilNotesGUI)

Parameters

int	$a_wiki_id
int	$a_page_id

Returns

string

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

    {
        include_once "Modules/Wiki/classes/class.ilWikiPage.php";
        $page = new ilWikiPage($a_page_id);
        if ($page->getWikiId() == $a_wiki_id) {
            return $page->getTitle();
        }
    }

newPagesObject()

ilObjWikiGUI::newPagesObject

(

)

Latest pages.

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

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

    {
        $tpl = $this->tpl;
        
        $this->checkPermission("read");
        
        include_once("./Modules/Wiki/classes/class.ilWikiPagesTableGUI.php");
        
        $this->addPagesSubTabs();
        
        $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:

orphanedPagesObject()

ilObjWikiGUI::orphanedPagesObject

(

)

Orphaned pages.

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

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

    {
        $tpl = $this->tpl;
        
        $this->checkPermission("read");
        
        include_once("./Modules/Wiki/classes/class.ilWikiPagesTableGUI.php");
        
        $this->addPagesSubTabs();
        
        $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:

pdfExportObject()

ilObjWikiGUI::pdfExportObject

(

)

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

References ilPDFGeneration\doJob(), ilHtmlToPdfTransformerFactory\PDF_OUTPUT_DOWNLOAD, ilPDFGeneratorUtils\prepareGenerationRequest(), and printViewObject().

    {

        // prepare generation before contents are processed (for mathjax)
        ilPDFGeneratorUtils::prepareGenerationRequest("Wiki", "ContentExport");

        $html = $this->printViewObject(true);
        
        // :TODO: fixing css dummy parameters
        $html = preg_replace("/\?dummy\=[0-9]+/", "", $html);
        $html = preg_replace("/\?vers\=[0-9A-Za-z\-]+/", "", $html);
        $html = str_replace('.css$Id$', ".css", $html);

        if (false) {
            include_once "Services/PDFGeneration/classes/class.ilPDFGeneration.php";
            include_once "Services/PDFGeneration/classes/class.ilPDFGenerationJob.php";

            $job = new ilPDFGenerationJob();
            $job->setAutoPageBreak(true)
                ->setMarginLeft("10")
                ->setMarginRight("10")
                ->setMarginTop("10")
                ->setMarginBottom("10")
                ->setOutputMode("D")// download
                ->setFilename("wiki.pdf")// :TODO:
                ->setCreator("ILIAS Wiki")// :TODO:
                ->setImageScale(1.25)// complete content scaling ?!
                ->addPage($html);

            ilPDFGeneration::doJob($job);
        } else {
            $html = preg_replace("/src=\"\\.\\//ims", "src=\"" . ILIAS_HTTP_PATH . "/", $html);
            $html = preg_replace("/href=\"\\.\\//ims", "href=\"" . ILIAS_HTTP_PATH . "/", $html);
            $pdf_factory = new ilHtmlToPdfTransformerFactory();
            $pdf_factory->deliverPDFFromHTMLString($html, "wiki.pdf", ilHtmlToPdfTransformerFactory::PDF_OUTPUT_DOWNLOAD, "Wiki", "ContentExport");
        }
    }

Here is the call graph for this function:

performSearchObject()

ilObjWikiGUI::performSearchObject

(

)

Search.

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

References $_POST, ilObjectGUI\$ctrl, ilObjectGUI\$lng, $tabs, ilObjectGUI\$tpl, ilObjWiki\_performSearch(), ilObjectGUI\checkPermission(), ilUtil\sendFailure(), setSideBlock(), and ilUtil\stripSlashes().

    {
        $tpl = $this->tpl;
        $ilTabs = $this->tabs;
        $ilCtrl = $this->ctrl;
        $lng = $this->lng;
        
        $this->checkPermission("read");
        
        include_once("./Modules/Wiki/classes/class.ilWikiSearchResultsTableGUI.php");
        
        $ilTabs->setTabActive("wiki_search_results");
        
        if (trim($_POST["search_term"]) == "") {
            ilUtil::sendFailure($lng->txt("wiki_please_enter_search_term"), true);
            $ilCtrl->redirectByClass("ilwikipagegui", "preview");
        }
        
        $search_results = ilObjWiki::_performSearch(
            $this->object->getId(),
            ilUtil::stripSlashes($_POST["search_term"])
        );
        $table_gui = new ilWikiSearchResultsTableGUI(
            $this,
            "performSearch",
            $this->object->getId(),
            $search_results,
            $_POST["search_term"]
        );
            
        $this->setSideBlock();
        $tpl->setContent($table_gui->getHTML());
    }

Here is the call graph for this function:

popularPagesObject()

ilObjWikiGUI::popularPagesObject

(

)

Popular pages.

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

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

    {
        $tpl = $this->tpl;
        
        $this->checkPermission("read");
        
        include_once("./Modules/Wiki/classes/class.ilWikiPagesTableGUI.php");
        
        $this->addPagesSubTabs();
        
        $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:

printViewObject()

ilObjWikiGUI::printViewObject

(

$a_pdf_export = false

)

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

References $tabs, ilObjectGUI\$tabs_gui, ilObjectGUI\$tpl, getPrintPageIds(), and setContentStyleSheet().

Referenced by pdfExportObject().

    {
        global $tpl;
        $tpl = $this->tpl;

        $tabs = $this->tabs_gui;

        $tabs->clearTargets();
        $tabs->setBackTarget(
            $this->lng->txt("back"),
            $this->ctrl->getLinkTargetByClass("ilwikipagegui", "printViewSelection")
        );
        
        $page_ids = $this->getPrintPageIds();
        if (!$page_ids) {
            $this->ctrl->redirect($this, "");
        }
                                
        $this->setContentStyleSheet($tpl);

        $page_content = "";
        foreach ($page_ids as $p_id) {
            $page_gui = new ilWikiPageGUI($p_id);
            $page_gui->setWiki($this->object);
            $page_gui->setOutputMode("print");
            $page_content .= $page_gui->showPage();
            
            if ($a_pdf_export) {
                $page_content .= '<p style="page-break-after:always;"></p>';
            }
        }
        
        //$page_content = '<div class="ilInvisibleBorder">' . $page_content . '</div>';
        
        if (!$a_pdf_export) {
            $tpl->addOnLoadCode("il.Util.print();");
        }
        
        $tpl->setContent($page_content);
        
        if (!$a_pdf_export) {
//            $tpl->printToStdout(false);
        } else {
            return $tpl->printToString();
        }
    }

Here is the call graph for this function:

Here is the caller graph for this function:

randomPageObject()

ilObjWikiGUI::randomPageObject

(

)

Go to random page.

Parameters

string

$a_page

page title

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

recentChangesObject()

ilObjWikiGUI::recentChangesObject

(

)

Recent Changes.

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

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

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

Here is the call graph for this function:

removeImportantPagesObject()

ilObjWikiGUI::removeImportantPagesObject

(

)

Remove important pages.

Parameters

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

References $_POST, ilObjectGUI\$ctrl, $i, ilObjectGUI\$lng, and ilObjectGUI\checkPermission().

    {
        $ilCtrl = $this->ctrl;
        $lng = $this->lng;

        $this->checkPermission("edit_wiki_navigation");

        if (is_array($_POST["imp_page_id"])) {
            foreach ($_POST["imp_page_id"] as $i) {
                $this->object->removeImportantPage((int) $i);
            }
        }
        ilUtil::sendSuccess($lng->txt("wiki_removed_imp_pages"), true);
        $ilCtrl->redirect($this, "editImportantPages");
    }

Here is the call graph for this function:

renderSideBlock()

static ilObjWikiGUI::renderSideBlock (   $a_wpg_id,   $a_wiki_ref_id,   $a_wp = null  )

static

Side column.

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

References $DIC, ilObjectGUI\$lng, ilObjectGUI\$tpl, ilObject\_lookupObjId(), ilObjWiki\_lookupRating(), ilObjWiki\_lookupRatingCategories(), ilRepositoryObjectSearchGUI\getSearchBlockHTML(), and ilWikiPage\lookupAdvancedMetadataHidden().

Referenced by ilWikiPageGUI\setSideBlock(), and setSideBlock().

    {
        global $DIC;

        $tpl = $DIC["tpl"];
        $lng = $DIC->language();
        $ilAccess = $DIC->access();
        $ilCtrl = $DIC->ctrl();

        $tpl->addJavaScript("./Modules/Wiki/js/WikiPres.js");

        // setting asynch to false fixes #0019457, since otherwise ilBlockGUI would act on asynch and output html when side blocks
        // being processed during the export. This is a flaw in ilCtrl and/or ilBlockGUI.
        $tpl->addOnLoadCode("il.Wiki.Pres.init('" . $ilCtrl->getLinkTargetByClass("ilobjwikigui", "", "", false, false) . "');");

        if ($a_wpg_id > 0 && !$a_wp) {
            include_once("./Modules/Wiki/classes/class.ilWikiPage.php");
            $a_wp = ilWikiPage($a_wpg_id);
        }

        // search block
        include_once './Services/Search/classes/class.ilRepositoryObjectSearchGUI.php';
        $rcontent = ilRepositoryObjectSearchGUI::getSearchBlockHTML($lng->txt('wiki_search'));
        

        // quick navigation
        if ($a_wpg_id > 0) {
            // rating
            $wiki_id = ilObject::_lookupObjId($a_wiki_ref_id);
            if (ilObjWiki::_lookupRating($wiki_id) &&
                // ilObjWiki::_lookupRatingAsBlock($wiki_id) &&
                $a_wp->getRating()) {
                include_once("./Services/Rating/classes/class.ilRatingGUI.php");
                $rgui = new ilRatingGUI();
                $rgui->setObject($wiki_id, "wiki", $a_wpg_id, "wpg");
                $rgui->enableCategories(ilObjWiki::_lookupRatingCategories($wiki_id));
                $rgui->setYourRatingText("#");
                $rcontent .= $rgui->getBlockHTML($lng->txt("wiki_rate_page"));
            }
        
            // advanced metadata
            if (!ilWikiPage::lookupAdvancedMetadataHidden($a_wpg_id)) {
                $cmd = null;
                if ($ilAccess->checkAccess("write", "", $a_wiki_ref_id) ||
                    $ilAccess->checkAccess("edit_page_meta", "", $a_wiki_ref_id)) {
                    $cmd = array(
                        "edit" => $ilCtrl->getLinkTargetByClass("ilwikipagegui", "editAdvancedMetaData"),
                        "hide" => $ilCtrl->getLinkTargetByClass("ilwikipagegui", "hideAdvancedMetaData")
                    );
                }
                include_once("./Services/Object/classes/class.ilObjectMetaDataGUI.php");
                $wiki = new ilObjWiki($a_wiki_ref_id);
                $callback = $wiki->getLinkMetadataValues()
                    ? array($wiki, "decorateAdvMDValue")
                    : null;
                $mdgui = new ilObjectMetaDataGUI($wiki, "wpg", $a_wpg_id);
                $rcontent .= $mdgui->getBlockHTML($cmd, $callback); // #17291
            }
        }
            
        // important pages
        include_once("./Modules/Wiki/classes/class.ilWikiImportantPagesBlockGUI.php");
        $imp_pages_block = new ilWikiImportantPagesBlockGUI();
        $rcontent .= $imp_pages_block->getHTML();

        // wiki functions block
        if ($a_wpg_id > 0) {
            include_once("./Modules/Wiki/classes/class.ilWikiFunctionsBlockGUI.php");
            $wiki_functions_block = new ilWikiFunctionsBlockGUI();
            $wiki_functions_block->setPageObject($a_wp);
            $rcontent .= $wiki_functions_block->getHTML();
        }

        $tpl->setRightContent($rcontent);
    }

Here is the call graph for this function:

Here is the caller graph for this function:

saveGradingObject()

ilObjWikiGUI::saveGradingObject

(

)

Save grading.

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

References $_POST, ilObjectGUI\$ctrl, ilObjectGUI\$lng, ilWikiContributor\_lookupStatus(), ilWikiContributor\_writeStatus(), ilObjectGUI\checkPermission(), ilLPMarks\getComment(), and ilUtil\stripSlashes().

    {
        $ilCtrl = $this->ctrl;
        $lng = $this->lng;
        
        $this->checkPermission("write");
        
        $users = (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");
        $saved = false;
        foreach ($users as $user_id) {
            if ($user_id != "") {
                $marks_obj = new ilLPMarks($this->object->getId(), $user_id);
                $new_mark = ilUtil::stripSlashes($_POST['mark'][$user_id]);
                $new_comment = ilUtil::stripSlashes($_POST['lcomment'][$user_id]);
                $new_status = ilUtil::stripSlashes($_POST["status"][$user_id]);

                if ($marks_obj->getMark() != $new_mark ||
                    $marks_obj->getComment() != $new_comment ||
                    ilWikiContributor::_lookupStatus($this->object->getId(), $user_id) != $new_status) {
                    ilWikiContributor::_writeStatus($this->object->getId(), $user_id, $new_status);
                    $marks_obj->setMark($new_mark);
                    $marks_obj->setComment($new_comment);
                    $marks_obj->update();
                    $saved = true;
                }
            }
        }
        if ($saved) {
            ilUtil::sendSuccess($lng->txt("msg_obj_modified"), true);
        }
        
        $ilCtrl->redirect($this, "listContributors");
    }

Here is the call graph for this function:

saveObject()

ilObjWikiGUI::saveObject

(

)

save object public

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

References $_GET, $_POST, $error, ilObjectGUI\$ilErr, ilObjectGUI\$lng, ilObjectGUI\$tpl, checkPermissionBool(), ilObjWiki\checkShortTitleAvailability(), and initSettingsForm().

    {
        $tpl = $this->tpl;
        $lng = $this->lng;
        $ilErr = $this->error;

        if (!$this->checkPermissionBool("create", "", "wiki", $_GET["ref_id"])) {
            $ilErr->raiseError($this->lng->txt("permission_denied"), $ilErr->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 {
                // create and insert forum in objecttree
                $_POST["title"] = $this->form_gui->getInput("title");
                $_POST["desc"] = $this->form_gui->getInput("description");
                return parent::saveObject();
            }
        }
    
        $this->form_gui->setValuesByPost();
        $tpl->setContent($this->form_gui->getHtml());
    }

Here is the call graph for this function:

saveOrderingAndIndentObject()

ilObjWikiGUI::saveOrderingAndIndentObject

(

)

Save important pages ordering and indentation.

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

References $_POST, ilObjectGUI\$ctrl, ilObjectGUI\$lng, and ilObjectGUI\checkPermission().

    {
        $ilCtrl = $this->ctrl;
        $lng = $this->lng;

        $this->checkPermission("edit_wiki_navigation");

        $this->object->saveOrderingAndIndentation($_POST["ord"], $_POST["indent"]);
        ilUtil::sendSuccess($lng->txt("wiki_ordering_and_indent_saved"), true);
        $ilCtrl->redirect($this, "editImportantPages");
    }

Here is the call graph for this function:

saveSettingsObject()

ilObjWikiGUI::saveSettingsObject

(

)

Save Settings.

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

References ilObjectGUI\$ctrl, $ilSetting, $ilUser, ilObjectGUI\$lng, ilObjectGUI\$object_service, ilObjectGUI\$settings, ilObjectGUI\$user, ilObjectGUI\checkPermission(), ilObjWiki\checkShortTitleAvailability(), ilObjectServiceSettingsGUI\CUSTOM_METADATA, initSettingsForm(), ilWikiPage\lookupTitle(), and ilObjectServiceSettingsGUI\updateServiceSettingsForm().

    {
        $ilCtrl = $this->ctrl;
        $lng = $this->lng;
        $ilUser = $this->user;
        $ilSetting = $this->settings;
        $obj_service = $this->object_service;
        
        $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(ilWikiPage::lookupTitle($this->form_gui->getInput("startpage_id")));
                $this->object->setShortTitle($this->form_gui->getInput("shorttitle"));
                $this->object->setRatingOverall($this->form_gui->getInput("rating_overall"));
                $this->object->setRating($this->form_gui->getInput("rating"));
                // $this->object->setRatingAsBlock($this->form_gui->getInput("rating_side"));
                $this->object->setRatingForNewPages($this->form_gui->getInput("rating_new"));
                $this->object->setRatingCategories($this->form_gui->getInput("rating_ext"));
                
                if (!$ilSetting->get("disable_comments")) {
                    $this->object->setPublicNotes($this->form_gui->getInput("public_notes"));
                }
                $this->object->setIntroduction($this->form_gui->getInput("intro"));
                //                              $this->object->setImportantPages($this->form_gui->getInput("imp_pages"));
                $this->object->setPageToc($this->form_gui->getInput("page_toc"));
                $this->object->setLinkMetadataValues($this->form_gui->getInput("link_md_values"));
                $this->object->update();

                // tile image
                $obj_service->commonSettings()->legacyForm($this->form_gui, $this->object)->saveTileImage();

                            
                include_once './Services/Object/classes/class.ilObjectServiceSettingsGUI.php';
                ilObjectServiceSettingsGUI::updateServiceSettingsForm(
                    $this->object->getId(),
                    $this->form_gui,
                    array(
                        ilObjectServiceSettingsGUI::CUSTOM_METADATA
                    )
                );
                
                // Update ecs export settings
                include_once 'Modules/Wiki/classes/class.ilECSWikiSettings.php';
                $ecs = new ilECSWikiSettings($this->object);
                if ($ecs->handleSettingsUpdate()) {
                    ilUtil::sendSuccess($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:

saveStyleSettingsObject()

ilObjWikiGUI::saveStyleSettingsObject

(

)

Save style settings.

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

References $_POST, $ilSetting, ilObjectGUI\$settings, ilObjStyleSheet\_lookupStandard(), and ilUtil\stripSlashes().

    {
        $ilSetting = $this->settings;
    
        include_once("./Services/Style/Content/classes/class.ilObjStyleSheet.php");
        if ($ilSetting->get("fixed_content_style_id") <= 0 &&
            (ilObjStyleSheet::_lookupStandard($this->object->getStyleSheetId())
            || $this->object->getStyleSheetId() == 0)) {
            $this->object->setStyleSheetId(ilUtil::stripSlashes($_POST["style_id"]));
            $this->object->update();
            ilUtil::sendSuccess($this->lng->txt("msg_obj_modified"), true);
        }
        $this->ctrl->redirect($this, "editStyleProperties");
    }

Here is the call graph for this function:

setAsStartPageObject()

ilObjWikiGUI::setAsStartPageObject

(

)

Confirm important pages deletion.

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

References $_POST, ilObjectGUI\$ctrl, ilObjectGUI\$lng, ilObjectGUI\checkPermission(), ilWikiPage\lookupTitle(), and ilUtil\sendInfo().

    {
        $ilCtrl = $this->ctrl;
        $lng = $this->lng;

        $this->checkPermission("edit_wiki_navigation");

        if (!is_array($_POST["imp_page_id"]) || count($_POST["imp_page_id"]) != 1) {
            ilUtil::sendInfo($lng->txt("wiki_select_one_item"), true);
        } else {
            $this->object->removeImportantPage((int) $_POST["imp_page_id"][0]);
            $this->object->setStartPage(ilWikiPage::lookupTitle((int) $_POST["imp_page_id"][0]));
            $this->object->update();
            ilUtil::sendSuccess($this->lng->txt("msg_obj_modified"), true);
        }
        $ilCtrl->redirect($this, "editImportantPages");
    }

Here is the call graph for this function:

setContentStyleSheet()

ilObjWikiGUI::setContentStyleSheet

(

$tpl = null

)

Set content style sheet.

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

References ilObjectGUI\$tpl, ilObjStyleSheet\getContentStylePath(), ilObjStyleSheet\getEffectiveContentStyleId(), and ilObjStyleSheet\getSyntaxStylePath().

Referenced by executeCommand(), printViewObject(), and viewPageObject().

    {
        $tpl = $this->tpl;

        if ($tpl == null) {
            $tpl = $this->tpl;
        }

        $tpl->addCss(ilObjStyleSheet::getContentStylePath(
            ilObjStyleSheet::getEffectiveContentStyleId(
                $this->object->getStyleSheetId(),
                "wiki"
            )
        ));
        $tpl->addCss(ilObjStyleSheet::getSyntaxStylePath());
    }

Here is the call graph for this function:

Here is the caller graph for this function:

setSettingsSubTabs()

ilObjWikiGUI::setSettingsSubTabs

(

$a_active

)

Set sub tabs.

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

References ilObjectGUI\$access, ilObjectGUI\$ctrl, ilObjectGUI\$lng, and $tabs.

Referenced by editImportantPagesObject(), editSettingsObject(), editStylePropertiesObject(), and executeCommand().

    {
        $ilTabs = $this->tabs;
        $ilCtrl = $this->ctrl;
        $lng = $this->lng;
        $ilAccess = $this->access;

        if (in_array(
            $a_active,
            array("general_settings", "style", "imp_pages", "rating_categories",
            "page_templates", "advmd", "permission_settings", "notifications")
        )) {
            if ($ilAccess->checkAccess("write", "", $this->object->getRefId())) {
                // general properties
                $ilTabs->addSubTab(
                    "general_settings",
                    $lng->txt("wiki_general_settings"),
                    $ilCtrl->getLinkTarget($this, 'editSettings')
                );

                // permission settings
                $ilTabs->addSubTab(
                    "permission_settings",
                    $lng->txt("obj_permission_settings"),
                    $this->ctrl->getLinkTargetByClass("ilsettingspermissiongui", "")
                );

                // style properties
                $ilTabs->addSubTab(
                    "style",
                    $lng->txt("wiki_style"),
                    $ilCtrl->getLinkTarget($this, 'editStyleProperties')
                );
            }

            if ($ilAccess->checkAccess("write", "", $this->object->getRefId())) {
                // important pages
                $ilTabs->addSubTab(
                    "imp_pages",
                    $lng->txt("wiki_navigation"),
                    $ilCtrl->getLinkTarget($this, 'editImportantPages')
                );
            }

            if ($ilAccess->checkAccess("write", "", $this->object->getRefId())) {
                // page templates
                $ilTabs->addSubTab(
                    "page_templates",
                    $lng->txt("wiki_page_templates"),
                    $ilCtrl->getLinkTargetByClass("ilwikipagetemplategui", "")
                );

                // rating categories
                if ($this->object->getRating() && $this->object->getRatingCategories()) {
                    $lng->loadLanguageModule("rating");
                    $ilTabs->addSubTab(
                        "rating_categories",
                        $lng->txt("rating_categories"),
                        $ilCtrl->getLinkTargetByClass(array('ilratinggui', 'ilratingcategorygui'), '')
                    );
                }

                $ilTabs->addSubTab(
                    'notifications',
                    $lng->txt("notifications"),
                    $ilCtrl->getLinkTargetByClass("ilobjnotificationsettingsgui", '')
                );
            }
            
            $ilTabs->activateSubTab($a_active);
        }
    }

Here is the caller graph for this function:

setSideBlock()

ilObjWikiGUI::setSideBlock

(

$a_wpg_id = 0

)

Side column.

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

References renderSideBlock().

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

    {
        ilObjWikiGUI::renderSideBlock($a_wpg_id, $this->object->getRefId());
    }

Here is the call graph for this function:

Here is the caller graph for this function:

showTemplateSelectionObject()

ilObjWikiGUI::showTemplateSelectionObject

(

)

Show template selection.

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

References $_GET, ilObjectGUI\$ctrl, ilObjectGUI\$lng, $tabs, ilObjectGUI\$tpl, initTemplateSelectionForm(), ilWikiUtil\makeUrlTitle(), and ilUtil\sendInfo().

    {
        $lng = $this->lng;
        $tpl = $this->tpl;
        $ilTabs = $this->tabs;
        $ilCtrl = $this->ctrl;


        $ilCtrl->setParameterByClass("ilobjwikigui", "from_page", ilWikiUtil::makeUrlTitle($_GET["from_page"]));
        $ilTabs->clearTargets();
        ilUtil::sendInfo($lng->txt("wiki_page_not_exist_select_templ"));

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

Here is the call graph for this function:

startUserHTMLExportObject()

ilObjWikiGUI::startUserHTMLExportObject

(

)

Export html (as user)

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

References ilObjectGUI\checkPermission().

    {
        $this->log->debug("start: " . $this->req_with_comments);
        $this->checkPermission("wiki_html_export");
        $this->object->startUserHTMLExport($this->req_with_comments);
    }

Here is the call graph for this function:

triggerAssignmentTool()

ilObjWikiGUI::triggerAssignmentTool ( )

protected

Trigger assignment tool.

Parameters

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

References $i, ilExerciseGSToolProvider\EXC_ASS_BUTTONS, ilExerciseGSToolProvider\EXC_ASS_IDS, getAssignmentButtons(), ilExcRepoObjAssignment\getInstance(), ilExerciseGSToolProvider\SHOW_EXC_ASSIGNMENT_INFO, and user().

Referenced by executeCommand().

    {
        if (!is_object($this->object)) {
            return;
        }
        $ass_info = ilExcRepoObjAssignment::getInstance()->getAssignmentInfoOfObj(
            $this->object->getRefId(),
            $this->user->getId()
        );
        if (count($ass_info) > 0) {
            $ass_ids = array_map(function ($i) {
                return $i->getId();
            }, $ass_info);
            $this->tool_context->current()->addAdditionalData(ilExerciseGSToolProvider::SHOW_EXC_ASSIGNMENT_INFO, true);
            $this->tool_context->current()->addAdditionalData(ilExerciseGSToolProvider::EXC_ASS_IDS, $ass_ids);
            $this->tool_context->current()->addAdditionalData(
                ilExerciseGSToolProvider::EXC_ASS_BUTTONS,
                $this->getAssignmentButtons()
            );
        }
    }

Here is the call graph for this function:

Here is the caller graph for this function:

viewObject()

ilObjWikiGUI::viewObject

(

)

Start page.

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

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

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

Here is the call graph for this function:

viewPageObject()

ilObjWikiGUI::viewPageObject

(

)

view wiki page

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

References $_GET, ilObjectGUI\$access, ilObjectGUI\$ctrl, ilObjectGUI\$lng, $tabs, ilObjectGUI\$tpl, ilObjectGUI\checkPermission(), ilWikiPage\exists(), ilObjStyleSheet\getEffectiveContentStyleId(), ilWikiPageGUI\getGUIForTitle(), ilWikiUtil\makeDbTitle(), ilWikiUtil\makeUrlTitle(), ilUtil\sendInfo(), and setContentStyleSheet().

    {
        $lng = $this->lng;
        $ilCtrl = $this->ctrl;
        $tpl = $this->tpl;
        $ilTabs = $this->tabs;
        $ilAccess = $this->access;
        
        $this->checkPermission("read");

        $ilTabs->clearTargets();
        $tpl->setHeaderActionMenu(null);

        $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),
            0,
            $this->object->getRefId()
        );
        include_once("./Services/Style/Content/classes/class.ilObjStyleSheet.php");
        $wpage_gui->setStyleId(ilObjStyleSheet::getEffectiveContentStyleId(
            $this->object->getStyleSheetId(),
            "wiki"
        ));

        $this->setContentStyleSheet();

        //$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->getPageObject()->getBlocked()
            )) {
            $wpage_gui->setEnableEditing(false);
        }

        // alter title and description
        //$tpl->setTitle($wpage_gui->getPageObject()->getTitle());
        //$tpl->setDescription($this->object->getTitle());
        if ($ilAccess->checkAccess("write", "", $this->object->getRefId())) {
            $wpage_gui->activateMetaDataEditor($this->object, "wpg", $wpage_gui->getId());
        }
        
        
        $html = $ilCtrl->forwardCommand($wpage_gui);
        //$this->addPageTabs();
        
        $tpl->setContent($html);
    }

Here is the call graph for this function:

Field Documentation

$error

ilObjWikiGUI::$error

protected

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

Referenced by infoScreen(), and saveObject().

$help

ilObjWikiGUI::$help

protected

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

Referenced by getTabs().

$log

ilObjWikiGUI::$log

protected

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

$req_with_comments

ilObjWikiGUI::$req_with_comments = false

protected

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

$tabs

ilObjWikiGUI::$tabs

protected

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

Referenced by addPagesSubTabs(), addPageTabs(), editImportantPagesObject(), editStylePropertiesObject(), executeCommand(), infoScreen(), initSettingsForm(), initStylePropertiesForm(), listContributorsObject(), performSearchObject(), printViewObject(), setSettingsSubTabs(), showTemplateSelectionObject(), and viewPageObject().

$tool_context

ilObjWikiGUI::$tool_context

protected

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

$ui

ilObjWikiGUI::$ui

protected

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

Referenced by getAssignmentButtons().

---

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

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