ilLMPageGUI Class Reference

Extension of ilPageObjectGUI for learning modules. More...

Inheritance diagram for ilLMPageGUI:

Collaboration diagram for ilLMPageGUI:

Public Member Functions
	__construct (int $a_id=0, int $a_old_nr=0, bool $a_prevent_get_id=false, string $a_lang="", string $concrete_lang="")
	onFeedbackEditingForwarding ()
	On feedback editing forwarding. More...
	processAnswer ()
	Process answer. More...
	finishEditing ()
Public Member Functions inherited from ilPageObjectGUI
	__construct (string $a_parent_type, int $a_id, int $a_old_nr=0, bool $a_prevent_get_id=false, string $a_lang="", string $concrete_lang="")
	setTemplate (ilGlobalTemplateInterface $main_tpl)
	afterConstructor ()
	setAdvMdRecordObject (int $a_adv_ref_id, string $a_adv_type, string $a_adv_subtype="-")
	Set object, that defines the adv md records being used. More...
	getAdvMdRecordObject ()
	Get adv md record type. More...
	setParentType (string $a_val)
	getParentType ()
	setId (int $a_val)
	getId ()
	setOldNr (int $a_val)
	Set old nr (historic page) More...
	getOldNr ()
	setLanguage (string $a_val)
	getLanguage ()
	setEnablePCType (string $a_pc_type, bool $a_val)
	getEnablePCType (string $a_pc_type)
	setPageConfig (ilPageConfig $a_val)
	getPageConfig ()
	setPageObject (ilPageObject $a_pg_obj)
	getPageObject ()
	setOutputMode (string $a_mode=self::PRESENTATION)
	getOutputMode ()
	setTemplateOutput (bool $a_output=true)
	outputToTemplate ()
	setPresentationTitle (string $a_title="")
	getPresentationTitle ()
	setHeader (string $a_title="")
	getHeader ()
	setLinkParams (string $l_params="")
	getLinkParams ()
	setLinkFrame (string $l_frame="")
	getLinkFrame ()
	setPageLinker (\ILIAS\COPage\PageLinker $page_linker)
	getLinkXML ()
	setQuestionHTML (array $question_html)
	getQuestionHTML ()
	setTemplateTargetVar (string $a_variable)
	getTemplateTargetVar ()
	getTemplateOutputVar ()
	setSourcecodeDownloadScript (string $script_name)
	getSourcecodeDownloadScript ()
	setTabs (ilTabsGUI $a_tabs)
	setPageBackTitle (string $a_title)
	setFileDownloadLink (string $a_download_link)
	getFileDownloadLink ()
	setFullscreenLink (string $a_fullscreen_link)
	getFullscreenLink ()
	setIntLinkReturn (string $a_return)
	enableChangeComments (bool $a_enabled)
	isEnabledChangeComments ()
	enableNotes (bool $a_enabled, int $a_parent_id)
	isEnabledNotes ()
	setOfflineDirectory (string $offdir)
	getOfflineDirectory ()
	setViewPageLink (string $a_link, string $a_target="")
	set link for "view page" button More...
	getViewPageLink ()
	getViewPageTarget ()
	getViewPageText ()
	setActivationListener (object $a_obj, string $a_meth)
	setEnabledNews (bool $a_enabled, int $a_news_obj_id=0, string $a_news_obj_type="")
	getEnabledNews ()
	setTabHook (object $a_object, string $a_function)
	setEditPreview (bool $a_editpreview)
	Set Display first Edit tab, then Preview tab, instead of Page and Edit. More...
	getEditPreview ()
	setEnabledTabs (bool $a_enabledtabs)
	getEnabledTabs ()
	setEnabledPageFocus (bool $a_enabledpagefocus)
	setOpenPlaceHolder (string $a_val)
	getOpenPlaceHolder ()
	getEnabledPageFocus ()
	setPrependingHtml (string $a_prependinghtml)
	getPrependingHtml ()
	setEnableEditing (bool $a_enableediting)
	getEnableEditing ()
	setRawPageContent (bool $a_rawpagecontent)
	Set Get raw page content only. More...
	getRawPageContent ()
	setStyleId (int $a_styleid)
	getStyleId ()
	setCompareMode (bool $a_val)
	getCompareMode ()
	setAbstractOnly (bool $a_val, string $pcid="")
	Get only abstract (first text paragraph) More...
	getAbstractOnly ()
	setRenderPageContainer (bool $a_val)
	getRenderPageContainer ()
	getDisabledText ()
	getEnabledHref ()
	setEnabledHref (bool $enable)
	activateMetaDataEditor (ilObject $a_rep_obj, string $a_type, int $a_sub_obj_id, object $a_observer_obj=null, string $a_observer_func="")
	Activate meda data editor. More...
	determineFileDownloadLink ()
	determineFullscreenLink ()
	determineSourcecodeDownloadScript ()
	getComponentPluginsXML ()
	Put information about activated plugins into XML. More...
	executeCommand ()
	execute command More...
	setQEditTabs (string $a_active)
	Set question editing tabs. More...
	onFeedbackEditingForwarding ()
	deactivatePage ()
	activatePage ()
	showPage ()
	display content of page More...
	replaceCurlyBrackets (string $output)
	getActivationCaptions ()
	Get captions for activation action menu entries. More...
	setEditMode ()
	Set edit mode. More...
	setDefaultLinkXml ()
	setLinkXml (string $xml)
	getProfileBackUrl ()
	setProfileBackUrl (string $url)
	downloadFile ()
	displayMediaFullscreen ()
	displayMedia (bool $a_fullscreen=false)
	download_paragraph ()
	download source code paragraph More...
	insertPageToc (string $a_output)
	insertResources (string $a_output)
	insertAdvTrigger (string $a_output)
	Insert adv content trigger. More...
	postOutputProcessing (string $a_output)
	Finalizing output processing. More...
	previewHistory ()
	Preview history. More...
	preview ()
	edit ()
	getBlockingInfoMessage ()
	insertJSAtPlaceholder ()
	presentation (string $a_mode=self::PRESENTATION)
	getHTML ()
	showMediaFullscreen (int $a_style_id=0)
	show fullscreen view of media object More...
	displayValidationError ($a_error)
	display validation error More...
	history ()
	Get history table as HTML. More...
	rollbackConfirmation ()
	Rollback confirmation. More...
	rollback ()
	Rollback to a previous version. More...
	setScreenIdComponent ()
	getTabs (string $a_activate="")
	compareVersion ()
	Compares two revisions of the page. More...
	replaceDiffTags (string $a_html)
	editActivation ()
	Edit activation (only, if scheduled page activation is activated in administration) More...
	initActivationForm ()
	Init activation form. More...
	getActivationFormValues ()
	Get values for activation form. More...
	saveActivation ()
	Save Activation. More...
	getNotesHTML (object $a_content_object=null, bool $a_enable_private_notes=true, bool $a_enable_public_notes=false, bool $a_enable_notes_deletion=false, callable $a_callback=null, bool $export=false)
	Get html for public and/or private notes. More...
	processAnswer ()
	Process answer. More...
	initialOpenedContent ()
	Initially opened content. More...
	initOpenedContentForm ()
	saveInitialOpenedContent ()
	switchToLanguage ()
	Switch to language. More...
	confirmPageTranslationCreation ()
	Confirm page translation creation. More...
	editMasterLanguage ()
	Edit master language. More...
	createPageTranslation ()
	Create page translation. More...
	releasePageLock ()
	Release page lock. More...
	finishEditing ()
	getPagePermaLink ()
	getAdditionalPageActions ()
	Get additional page actions. More...

Protected Attributes
ilDBInterface	$db
PresentationGUIRequest	$pres_request
Refinery	$refinery
ilComponentRepository	$component_repository
Protected Attributes inherited from ilPageObjectGUI
int	$requested_ref_id
int	$requested_pg_id
string	$requested_file_id
string	$requested_transl
int	$requested_old_nr
EditGUIRequest	$request
EditSessionRepository	$edit_repo
string	$exp_target_script = ""
string	$exp_id = ""
string	$exp_frame = ""
string	$act_meth = ""
object	$act_obj
int	$notes_parent_id = 0
ilPropertyFormGUI	$form
int	$styleid = 0
bool	$enabledpagefocus
string	$link_xml
int	$old_nr = 0
int	$id
string	$language
ilGlobalTemplateInterface	$tpl
ilLanguage	$lng
ilCtrl	$ctrl
ilTabsGUI	$tabs_gui
ilAccessHandler	$access
ilLogger	$log
ilObjUser	$user
ilHelpGUI	$help
string	$output_mode = ""
string	$parent_type = ""
string	$file_download_link = ''
string	$fullscreen_link = ''
string	$link_frame = ''
ILIAS GlobalScreen ScreenContext ContextServices	$tool_context
ILIAS DI UIServices	$ui
ILIAS COPage PageLinker	$page_linker
string	$abstract_pcid = ""
ilToolbarGUI	$toolbar
string	$open_place_holder = ""
int	$requested_user_id = 0
int	$requested_q_id = 0
int	$requested_history_mode = 0
bool	$enabled_news = false
int	$news_obj_id = 0
string	$news_obj_type = ""
array	$tab_hook = null
string	$view_page_link = ""
string	$view_page_target = ""
string	$offline_directory = ""
bool	$notes_enabled = false
string	$prependinghtml = ""
string	$header = ""
string	$int_link_return = ""
bool	$enabled_href = true
int	$adv_ref_id = null
string	$adv_type = null
string	$adv_subtype = null
string	$concrete_lang = ""
string	$profile_back_url = ""
ilComponentFactory	$component_factory

Additional Inherited Members
Static Public Member Functions inherited from ilPageObjectGUI
static	getTinyMenu (string $a_par_type, bool $a_int_links=false, bool $a_wiki_links=false, bool $a_keywords=false, $a_style_id=0, $a_paragraph_styles=true, $a_save_return=true, $a_anchors=false, $a_save_new=true, $a_user_links=false, \ILIAS\COPage\Editor\Server\UIWrapper $ui_wrapper=null)
	Get Tiny Menu. More...
Data Fields inherited from ilPageObjectGUI
const	PRESENTATION = "presentation"
const	EDIT = "edit"
const	PREVIEW = "preview"
const	OFFLINE = "offline"
const	PRINTING = "print"
string	$page_back_title = ""
ilPageObject	$obj
string	$presentation_title = ""
string	$target_script = ""
string	$return_location = ""
string	$target_var = ""
string	$template_output_var = ""
bool	$output2template = false
string	$link_params = ""
string	$sourcecode_download_script = ""
bool	$change_comments = false
bool	$activation = false
bool	$activated = true
bool	$editpreview = false
bool	$use_meta_data = false
ilObject	$meta_data_rep_obj = null
int	$meta_data_sub_obj_id = 0
string	$meta_data_type = ""
object	$meta_data_observer_obj = null
string	$meta_data_observer_func = ""
bool	$link_xml_set = false
bool	$enableediting = true
bool	$rawpagecontent = false
bool	$enabledcontentincludes = false
bool	$compare_mode = false
ilPageConfig	$page_config = null
bool	$tabs_enabled = true
bool	$render_page_container = false
string	$pl_start = "{{{{{"
string	$pl_end = "}}}}}"
Protected Member Functions inherited from ilPageObjectGUI
	initPageObject ()
	Init page object. More...
	showEditToolbar ()
	Show edit toolbar. More...
	setEditorToolContext ()
	Set editor tool context. More...
	initEditing ()
	showEditLockInfo ()
	setBackToEditTabs ()
	isPageContainerToBeRendered ()
	addResourcesToTemplate (ilGlobalTemplateInterface $tpl)
	Add resources to template. More...

Detailed Description

Extension of ilPageObjectGUI for learning modules.

Author

Alexander Killing killi.nosp@m.ng@l.nosp@m.eifos.nosp@m..de ilLMPageGUI: ilPageEditorGUI, ilObjectMetaDataGUI, ilEditClipboardGUI, ilMediaPoolTargetSelector, ilCommonActionDispatcherGUI, ilPageObjectGUI ilLMPageGUI: ilNewsItemGUI, ilQuestionEditGUI, ilAssQuestionFeedbackEditingGUI, ilPageMultiLangGUI, ilPropertyFormGUI

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

Constructor & Destructor Documentation

__construct()

ilLMPageGUI::__construct	(	int	$a_id = 0,
		int	$a_old_nr = 0,
		bool	$a_prevent_get_id = false,
		string	$a_lang = "",
		string	$concrete_lang = ""
	)

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

References ilPageObjectGUI\$concrete_lang, $DIC, ILIAS\GlobalScreen\Provider\__construct(), ilObjContentObject\_lookupStoreTries(), ilPageObjectGUI\getPageConfig(), ilPageObjectGUI\getPageObject(), ILIAS\Repository\lng(), ILIAS\Repository\refinery(), and ILIAS\Repository\user().

      {
        global $DIC;
        $this->lng = $DIC->language();
        $this->user = $DIC->user();
        $this->db = $DIC->database();
        $this->refinery = $DIC['refinery'];
        $this->component_repository = $DIC['component.repository'];

        $this->log = $DIC["ilLog"];
        parent::__construct("lm", $a_id, $a_old_nr, $a_prevent_get_id, $a_lang, $concrete_lang);
        $this->pres_request = $DIC
            ->learningModule()
            ->internal()
            ->gui()
            ->presentation()
            ->request();

        $this->getPageConfig()->setUseStoredQuestionTries(ilObjContentObject::_lookupStoreTries($this->getPageObject()->getParentId()));
    }

Here is the call graph for this function:

Member Function Documentation

finishEditing()

ilLMPageGUI::finishEditing

(

)

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

References ILIAS\Repository\ctrl(), ilPageObjectGUI\getId(), and ilPageObjectGUI\getPageObject().

                                   : void
    {
        $lm_tree = new ilLMTree($this->getPageObject()->getParentId());
        if ($lm_tree->isInTree($this->getPageObject()->getId())) {
            $parent_id = $lm_tree->getParentId($this->getPageObject()->getId());
            $this->ctrl->setParameterByClass(
                ilStructureObjectGUI::class,
                "obj_id",
                $parent_id
            );
            $this->ctrl->redirectByClass([
                ilObjLearningModuleGUI::class,
                ilStructureObjectGUI::class
            ], "view");
        }
        $this->ctrl->redirectByClass(
            ilObjLearningModuleGUI::class,
            "pages"
        );
    }

Here is the call graph for this function:

onFeedbackEditingForwarding()

ilLMPageGUI::onFeedbackEditingForwarding

(

)

On feedback editing forwarding.

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

References ilPageObjectGUI\$lng, ilObjContentObject\_lookupDisableDefaultFeedback(), ILIAS\Repository\ctrl(), ilPageObjectGUI\getPageObject(), and ilLanguage\txt().

                                                 : void
    {
        $lng = $this->lng;

        if (strtolower($this->ctrl->getCmdClass()) == "ilassquestionfeedbackeditinggui") {
            if (ilObjContentObject::_lookupDisableDefaultFeedback($this->getPageObject()->getParentId())) {
                $this->tpl->setOnScreenMessage('info', $lng->txt("cont_def_feedb_deactivated"));
            } else {
                $this->tpl->setOnScreenMessage('info', $lng->txt("cont_def_feedb_activated"));
            }
        }
    }

Here is the call graph for this function:

processAnswer()

ilLMPageGUI::processAnswer

(

)

Process answer.

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

References $component_repository, $db, ilPageObjectGUI\$id, $ilDB, $ilUser, ilPageObjectGUI\$lng, $refinery, ilPageObjectGUI\$user, ilObjContentObject\_lookupRestrictForwardNavigation(), ilPageQuestionProcessor\getAnswerStatus(), ilNotification\getNotificationsForObject(), ilPageObject\lookupParentId(), ilUtil\stripSlashes(), ilNotification\TYPE_LM_BLOCKED_USERS, and ilLMMailNotification\TYPE_USER_BLOCKED.

                                   : void
    {
        $ilUser = $this->user;
        $ilDB = $this->db;
        $lng = $this->lng;
        $refinery = $this->refinery;
        $component_repository = $this->component_repository;

        parent::processAnswer();

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

        $parent_id = ilPageObject::lookupParentId(
            $this->pres_request->getQuestionPageId(),
            "lm"
        );

        // is restriction mode set?
        if (ilObjContentObject::_lookupRestrictForwardNavigation($parent_id)) {
            // check if user is blocked
            $id = ilUtil::stripSlashes($this->pres_request->getQuestionId());

            $as = ilPageQuestionProcessor::getAnswerStatus($id, $ilUser->getId());
            // get question information
            $qlist = new ilAssQuestionList($ilDB, $lng, $refinery, $component_repository);
            $qlist->setParentObjId(0);
            $qlist->setJoinObjectData(false);
            $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"]) {
                $users = ilNotification::getNotificationsForObject(ilNotification::TYPE_LM_BLOCKED_USERS, $parent_id);

                if (count($users) > 0) {
                    $not = new ilLMMailNotification();
                    $not->setType(ilLMMailNotification::TYPE_USER_BLOCKED);
                    $not->setQuestionId($id);
                    $not->setRefId($this->pres_request->getRefId());
                    $not->setRecipients($users);
                    $not->send();
                }
            }
        }
    }

Here is the call graph for this function:

Field Documentation

$component_repository

ilComponentRepository ilLMPageGUI::$component_repository

protected

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

Referenced by processAnswer().

$db

ilDBInterface ilLMPageGUI::$db

protected

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

Referenced by processAnswer().

$pres_request

PresentationGUIRequest ilLMPageGUI::$pres_request

protected

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

$refinery

Refinery ilLMPageGUI::$refinery

protected

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

Referenced by processAnswer().

---

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

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