ilLMPageGUI Class Reference

Extension of ilPageObjectGUI for learning modules. More...

Inheritance diagram for ilLMPageGUI:

Collaboration diagram for ilLMPageGUI:

Public Member Functions
	__construct ($a_id=0, $a_old_nr=0, $a_prevent_get_id=false, $a_lang="")
	Constructor.
	onFeedbackEditingForwarding ()
	On feedback editing forwarding.
	processAnswer ()
	Process answer.
Public Member Functions inherited from ilPageObjectGUI
	ilPageObjectGUI ($a_parent_type, $a_id, $a_old_nr=0, $a_prevent_get_id=false, $a_lang="")
	Constructor.
	afterConstructor ()
	After constructor.
	setParentType ($a_val)
	Set parent type.
	getParentType ()
	Get parent type.
	setId ($a_val)
	Set ID.
	getId ()
	Get ID.
	setOldNr ($a_val)
	Set old nr (historic page)
	getOldNr ()
	Get old nr (historic page)
	setLanguage ($a_val)
	Set language.
	getLanguage ()
	Get language.
	setEnablePCType ($a_pc_type, $a_val)
	Set enable pc type.
	getEnablePCType ($a_pc_type)
	Get enable pc type.
	setPageConfig ($a_val)
	Set page config object.
	getPageConfig ()
	Get page config object.
	setBibId ($a_id)
	Set Bib Id.
	getBibId ()
	Get Bib Id.
	setPageObject ($a_pg_obj)
	Set Page Object.
	getPageObject ()
	Get Page Object.
	setOutputMode ($a_mode=IL_PAGE_PRESENTATION)
	Set Output Mode.
	getOutputMode ()
	setTemplateOutput ($a_output=true)
	outputToTemplate ()
	setPresentationTitle ($a_title="")
	getPresentationTitle ()
	setHeader ($a_title="")
	getHeader ()
	setLinkParams ($l_params="")
	getLinkParams ()
	setLinkFrame ($l_frame="")
	getLinkFrame ()
	setLinkXML ($link_xml)
	getLinkXML ()
	setQuestionXML ($question_xml)
	setQuestionHTML ($question_html)
	getQuestionXML ()
	getQuestionHTML ()
	setTemplateTargetVar ($a_variable)
	getTemplateTargetVar ()
	setTemplateOutputVar ($a_value)
	getTemplateOutputVar ()
	setSourcecodeDownloadScript ($script_name)
	getSourcecodeDownloadScript ()
	enableCitation ($a_enabled)
	isEnabledCitation ()
	setLocator (&$a_locator)
	setTabs ($a_tabs)
	setPageBackTitle ($a_title)
	setFileDownloadLink ($a_download_link)
	getFileDownloadLink ()
	setFullscreenLink ($a_fullscreen_link)
	getFullscreenLink ()
	setIntLinkReturn ($a_return)
	enableChangeComments ($a_enabled)
	isEnabledChangeComments ()
	enableNotes ($a_enabled, $a_parent_id)
	isEnabledNotes ()
	setOfflineDirectory ($offdir)
	set offline directory to offdir
	getOfflineDirectory ()
	get offline directory
	setViewPageLink ($a_link, $a_target="")
	set link for "view page" button
	getViewPageLink ()
	get view page link
	getViewPageTarget ()
	get view page target frame
	setActivationListener (&$a_obj, $a_meth)
	setEnabledNews ($a_enabled, $a_news_obj_id=0, $a_news_obj_type=0)
	Set enabled news.
	getEnabledNews ()
	Get enabled news.
	setTabHook ($a_object, $a_function)
	Set tab hook.
	setEditPreview ($a_editpreview)
	Set Display first Edit tab, then Preview tab, instead of Page and Edit.
	getEditPreview ()
	Get Display first Edit tab, then Preview tab, instead of Page and Edit.
	setEnabledTabs ($a_enabledtabs)
	Set Output tabs.
	getEnabledTabs ()
	Get Output tabs.
	setEnabledPageFocus ($a_enabledpagefocus)
	Set Enable page focus.
	getEnabledPageFocus ()
	Get Enable page focus.
	setExplorerUpdater ($a_exp_frame, $a_exp_id, $a_exp_target_script)
	Set Explorer Updater.
	setPrependingHtml ($a_prependinghtml)
	Set Prepending HTML.
	getPrependingHtml ()
	Get Prepending HTML.
	setEnableEditing ($a_enableediting)
	Set Enable Editing.
	getEnableEditing ()
	Get Enable Editing.
	setRawPageContent ($a_rawpagecontent)
	Set Get raw page content only.
	getRawPageContent ()
	Get Get raw page content only.
	setStyleId ($a_styleid)
	Set Style Id.
	getStyleId ()
	Get Style Id.
	setCompareMode ($a_val)
	Set compare mode.
	getCompareMode ()
	Get compare mode.
	setAbstractOnly ($a_val)
	Set abstract only.
	getAbstractOnly ()
	Get abstract only.
	setRenderPageContainer ($a_val)
	Set render page container.
	getRenderPageContainer ()
	Get render page container.
	activateMetaDataEditor ($a_rep_obj_id, $a_sub_obj_id, $a_type, $a_observer_obj=NULL, $a_observer_func="")
	Activate meda data editor.
	determineFileDownloadLink ()
	Determine file download link.
	determineFullscreenLink ()
	Determine fullscreen link.
	determineSourcecodeDownloadScript ()
	Determine source code download script.
	getComponentPluginsXML ()
	Put information about activated plugins into XML.
&	executeCommand ()
	execute command
	setQEditTabs ($a_active)
	Set question editing tabs.
	deactivatePage ()
	activatePage ()
	showPage ()
	display content of page
	replaceCurlyBrackets ($output)
	Replace curly brackets.
	addActionsMenu ($a_tpl, $sel_media_mode, $sel_html_mode, $sel_js_mode)
	Add actions menu.
	addMultiLangActionsAndInfo ($a_list, $a_tpl)
	Add multi-language actions to menu.
	setEditMode ()
	Set edit mode.
	setDefaultLinkXml ()
	Set standard link xml.
	downloadFile ()
	Download file of file lists.
	displayMediaFullscreen ()
	Show media in fullscreen mode.
	displayMedia ($a_fullscreen=false)
	Display media.
	download_paragraph ()
	download source code paragraph
	insertContentIncludes ($a_html)
	Insert content includes.
	insertPageToc ($a_output)
	Insert page toc.
	insertResources ($a_output)
	Insert resources.
	insertAdvTrigger ($a_output)
	Insert adv content trigger.
	postOutputProcessing ($a_output)
	Finalizing output processing.
	insertHelp ($a_tpl)
	Insert help texts.
	previewHistory ()
	Preview history.
	preview ()
	preview
	edit ()
	edit ("view" before)
	insertJSAtPlaceholder ()
	InsertJS at placeholder.
	presentation ($a_mode=IL_PAGE_PRESENTATION)
	getHTML ()
	showMediaFullscreen ($a_style_id=0)
	show fullscreen view of media object
	displayValidationError ($a_error)
	display validation error
	history ()
	Get history table as HTML.
	rollbackConfirmation ()
	Rollback confirmation.
	rollback ()
	Rollback to a previous version.
	setScreenIdComponent ()
	Set screen id component.
	getTabs ($a_activate="")
	adds tabs to tab gui object
	compareVersion ()
	Compares two revisions of the page.
	replaceDiffTags ($a_html)
	editActivation ()
	Edit activation (only, if scheduled page activation is activated in administration)
	initActivationForm ()
	Init activation form.
	getActivationFormValues ()
	Get values for activation form.
	saveActivation ()
	Save Activation.
	getNotesHTML ($a_content_object=null, $a_enable_private_notes=true, $a_enable_public_notes=false, $a_enable_notes_deletion=false, $a_callback=null)
	Get html for public and/or private notes.
	initialOpenedContent ()
	Initially opened content.
	initOpenedContentForm ()
	Init form for initially opened content.
	saveInitialOpenedContent ()
	Save initial opened content.
	switchToLanguage ()
	Switch to language.
	confirmPageTranslationCreation ()
	Confirm page translation creation.
	editMasterLanguage ()
	Edit master language.
	createPageTranslation ()
	Create page translation.
	releasePageLock ()
	Release page lock.

Additional Inherited Members
Static Public Member Functions inherited from ilPageObjectGUI
static	getTinyMenu ($a_par_type, $a_int_links=false, $a_wiki_links=false, $a_keywords=false, $a_style_id=0, $a_paragraph_styles=true, $a_save_return=true, $a_anchors=false, $a_save_new=true)
	Get Tiny Menu.
Data Fields inherited from ilPageObjectGUI
	$tpl
	$lng
	$ctrl
	$obj
	$output_mode
	$presentation_title
	$target_script
	$return_location
	$target_var
	$template_output_var
	$output2template
	$link_params
	$bib_id
	$citation
	$sourcecode_download_script
	$change_comments
	$question_html
	$activation = false
	$activated = true
	$editpreview = false
	$use_meta_data = false
	$link_xml_set = false
	$enableediting = true
	$rawpagecontent = false
	$enabledcontentincludes = false
	$compare_mode = false
	$page_config = null
	$tabs_enabled = true
	$render_page_container = false
	$pl_start = "{{{{{"
	$pl_end = "}}}}}"
Protected Member Functions inherited from ilPageObjectGUI
	initPageObject ()
	Init page object.
	getActivationCaptions ()
	Get captions for activation action menu entries.
	isPageContainerToBeRendered ()
Protected Attributes inherited from ilPageObjectGUI
	$parent_type = ""

Detailed Description

Extension of ilPageObjectGUI for learning modules.

Author

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

Version

$Id$ ilLMPageGUI: ilPageEditorGUI, ilMDEditorGUI, ilEditClipboardGUI, ilMediaPoolTargetSelector, ilCommonActionDispatcherGUI, ilPageObjectGUI ilLMPageGUI: ilNewsItemGUI, ilQuestionEditGUI, ilAssQuestionFeedbackEditingGUI, ilPageMultiLangGUI, ilPropertyFormGUI

Definition at line 17 of file class.ilLMPageGUI.php.

Constructor & Destructor Documentation

ilLMPageGUI::__construct	(		$a_id = 0,
			$a_old_nr = 0,
			$a_prevent_get_id = false,
			$a_lang = ""
	)

Constructor.

Definition at line 22 of file class.ilLMPageGUI.php.

References ilObjContentObject\_lookupStoreTries(), ilPageObjectGUI\getPageConfig(), and ilPageObjectGUI\getPageObject().

        {
                parent::__construct("lm", $a_id, $a_old_nr, $a_prevent_get_id, $a_lang);

                include_once("./Modules/LearningModule/classes/class.ilObjContentObject.php");
                $this->getPageConfig()->setUseStoredQuestionTries(ilObjContentObject::_lookupStoreTries($this->getPageObject()->getParentId()));
        }

Here is the call graph for this function:

Member Function Documentation

ilLMPageGUI::onFeedbackEditingForwarding

(

)

On feedback editing forwarding.

Reimplemented from ilPageObjectGUI.

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

References $_GET, ilPageObjectGUI\$lng, ilObjContentObject\_lookupDisableDefaultFeedback(), ilPageObjectGUI\getPageObject(), and ilUtil\sendInfo().

        {
                global $lng;

                if (strtolower($_GET["cmdClass"]) == "ilassquestionfeedbackeditinggui")
                {
                        include_once("./Modules/LearningModule/classes/class.ilObjContentObject.php");
                        if (ilObjContentObject::_lookupDisableDefaultFeedback($this->getPageObject()->getParentId()))
                        {
                                ilUtil::sendInfo($lng->txt("cont_def_feedb_deactivated"));
                        }
                        else
                        {
                                ilUtil::sendInfo($lng->txt("cont_def_feedb_activated"));
                        }
                }
        }

Here is the call graph for this function:

ilLMPageGUI::processAnswer

(

)

Process answer.

Reimplemented from ilPageObjectGUI.

Definition at line 55 of file class.ilLMPageGUI.php.

References $_GET, $_POST, $ilDB, $ilLog, $ilUser, ilPageObjectGUI\$lng, ilObjContentObject\_lookupRestrictForwardNavigation(), ilPageQuestionProcessor\getAnswerStatus(), ilNotification\getNotificationsForObject(), ilPageObject\lookupParentId(), ilUtil\stripSlashes(), ilNotification\TYPE_LM_BLOCKED_USERS, and ilLMMailNotification\TYPE_USER_BLOCKED.

        {
                global $ilUser, $ilDB, $lng, $ilPluginAdmin, $ilLog;

                parent::processAnswer();

                //
                // Send notifications to authors that want to be informed on blocked users
                //

                $parent_id = ilPageObject::lookupParentId((int) $_GET["page_id"], "lm");

                // is restriction mode set?
                include_once("./Modules/LearningModule/classes/class.ilObjContentObject.php");
                if (ilObjContentObject::_lookupRestrictForwardNavigation($parent_id))
                {
                        // check if user is blocked
                        $id = ilUtil::stripSlashes($_POST["id"]);

                        include_once("./Services/COPage/classes/class.ilPageQuestionProcessor.php");
                        $as = ilPageQuestionProcessor::getAnswerStatus($id, $ilUser->getId());
                        // get question information
                        include_once("./Modules/TestQuestionPool/classes/class.ilAssQuestionList.php");
                        $qlist = new ilAssQuestionList($ilDB, $lng, $ilPluginAdmin, 0);
                        $qlist->addFieldFilter("question_id", array($id));
                        $qlist->load();
                        $qdata = $qlist->getQuestionDataArray();
                        // has the user been blocked?
                        if ($as["try"] >= $qdata[$as["qst_id"]]["nr_of_tries"] && $qdata[$as["qst_id"]]["nr_of_tries"] > 0 && !$as["passed"])
                        {
                                include_once "./Services/Notification/classes/class.ilNotification.php";
                                $users = ilNotification::getNotificationsForObject(ilNotification::TYPE_LM_BLOCKED_USERS, $parent_id);

                                if (count($users) > 0)
                                {
                                        include_once("./Modules/LearningModule/classes/class.ilLMMailNotification.php");
                                        $not = new ilLMMailNotification();
                                        $not->setType(ilLMMailNotification::TYPE_USER_BLOCKED);
                                        $not->setQuestionId($id);
                                        $not->setRefId((int) $_GET["ref_id"]);
                                        $not->setRecipients($users);
                                        $not->send();
                                }
                        }

                }
        }

Here is the call graph for this function:

---

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

• Modules/LearningModule/classes/class.ilLMPageGUI.php