Question page GUI class. More...

Inheritance diagram for ilAssQuestionPageGUI:

Collaboration diagram for ilAssQuestionPageGUI:

Public Member Functions
	__construct ($a_id=0, $a_old_nr=0)
	Constructor. More...

	getOriginalPresentationTitle ()

	setOriginalPresentationTitle ($originalPresentationTitle)

	showPage ()
	display content of page More...

	finishEditing ()

	postOutputProcessing ($output)
	Finalizing output processing. More...

	setQuestionInfoHTML ($a_html)
	Set the HTML of a question info block below the title (number, status, ...) More...

	setQuestionActionsHTML ($a_html)
	Set the HTML of a question actions block below the title. More...

	insertPageToc ($a_output)
	Replace page toc placeholder with question info and actions. More...

Public Member Functions inherited from ilPageObjectGUI
	__construct ( $a_parent_type, $a_id, $a_old_nr=0, $a_prevent_get_id=false, $a_lang="", $concrete_lang="")
	Constructor. More...

	afterConstructor ()
	After constructor. More...

	setParentType ($a_val)
	Set parent type. More...

	getParentType ()
	Get parent type. More...

	setId ($a_val)
	Set ID. More...

	getId ()
	Get ID. More...

	setOldNr ($a_val)
	Set old nr (historic page) More...

	getOldNr ()
	Get old nr (historic page) More...

	setLanguage ($a_val)
	Set language. More...

	getLanguage ()
	Get language. More...

	setEnablePCType ($a_pc_type, $a_val)
	Set enable pc type. More...

	getEnablePCType ($a_pc_type)
	Get enable pc type. More...

	setPageConfig ($a_val)
	Set page config object. More...

	getPageConfig ()
	Get page config object. More...

	setPageObject (ilPageObject $a_pg_obj)
	Set Page Object. More...

	getPageObject ()
	Get Page Object. More...

	setOutputMode ($a_mode=self::PRESENTATION)
	Set Output Mode. More...

	getOutputMode ()

	setTemplateOutput ($a_output=true)

	outputToTemplate ()

	setPresentationTitle ($a_title="")

	getPresentationTitle ()

	setHeader ($a_title="")

	getHeader ()

	setLinkParams ($l_params="")

	getLinkParams ()

	setLinkFrame ($l_frame="")

	getLinkFrame ()

	setPageLinker ($page_linker)

	getLinkXML ()

	setQuestionXML ($question_xml)

	setQuestionHTML ($question_html)

	getQuestionXML ()

	getQuestionHTML ()

	setTemplateTargetVar ($a_variable)

	getTemplateTargetVar ()

	setTemplateOutputVar ($a_value)

	getTemplateOutputVar ()

	setSourcecodeDownloadScript ($script_name)
	Set sourcecode download script. More...

	getSourcecodeDownloadScript ()
	Get sourcecode download script. More...

	setLocator (&$a_locator)

	setTabs ($a_tabs)

	setPageBackTitle ($a_title)

	setFileDownloadLink ($a_download_link)
	Set file download link. More...

	getFileDownloadLink ()
	Get file download link. More...

	setFullscreenLink ($a_fullscreen_link)
	Set fullscreen link. More...

	getFullscreenLink ()
	Get fullscreen link. More...

	setIntLinkReturn ($a_return)

	enableChangeComments ($a_enabled)

	isEnabledChangeComments ()

	enableNotes ($a_enabled, $a_parent_id)

	isEnabledNotes ()

	setOfflineDirectory ($offdir)
	set offline directory to offdir More...

	getOfflineDirectory ()
	get offline directory More...

	setViewPageLink ($a_link, $a_target="")
	set link for "view page" button More...

	getViewPageLink ()
	get view page link More...

	getViewPageTarget ()
	get view page target frame More...

	getViewPageText ()
	get view page text More...

	setActivationListener (&$a_obj, $a_meth)

	setEnabledNews ($a_enabled, $a_news_obj_id=0, $a_news_obj_type=0)
	Set enabled news. More...

	getEnabledNews ()
	Get enabled news. More...

	setTabHook ($a_object, $a_function)
	Set tab hook. More...

	setEditPreview ($a_editpreview)
	Set Display first Edit tab, then Preview tab, instead of Page and Edit. More...

	getEditPreview ()
	Get Display first Edit tab, then Preview tab, instead of Page and Edit. More...

	setEnabledTabs ($a_enabledtabs)
	Set Output tabs. More...

	getEnabledTabs ()
	Get Output tabs. More...

	setEnabledPageFocus ($a_enabledpagefocus)
	Set Enable page focus. More...

	setOpenPlaceHolder ($a_val)
	Set open placeholder. More...

	getOpenPlaceHolder ()
	Get open placeholder. More...

	getEnabledPageFocus ()
	Get Enable page focus. More...

	setExplorerUpdater ($a_exp_frame, $a_exp_id, $a_exp_target_script)
	Set Explorer Updater. More...

	setPrependingHtml ($a_prependinghtml)
	Set Prepending HTML. More...

	getPrependingHtml ()
	Get Prepending HTML. More...

	setEnableEditing ($a_enableediting)
	Set Enable Editing. More...

	getEnableEditing ()
	Get Enable Editing. More...

	setRawPageContent ($a_rawpagecontent)
	Set Get raw page content only. More...

	getRawPageContent ()
	Get Get raw page content only. More...

	setStyleId ($a_styleid)
	Set Style Id. More...

	getStyleId ()
	Get Style Id. More...

	setCompareMode ($a_val)
	Set compare mode. More...

	getCompareMode ()
	Get compare mode. More...

	setAbstractOnly ($a_val, $pcid="")
	Set abstract only. More...

	getAbstractOnly ()
	Get abstract only. More...

	setRenderPageContainer ($a_val)
	Set render page container. More...

	getRenderPageContainer ()
	Get render page container. More...

	getDisabledText ()
	Get disabled text. More...

	getEnabledHref ()

	setEnabledHref (bool $enable)

	activateMetaDataEditor ( $a_rep_obj, $a_type, $a_sub_obj_id, $a_observer_obj=null, $a_observer_func="")
	Activate meda data editor. More...

	determineFileDownloadLink ()
	Determine file download link. More...

	determineFullscreenLink ()
	Determine fullscreen link. More...

	determineSourcecodeDownloadScript ()
	Determine source code download script. More...

	getComponentPluginsXML ()
	Put information about activated plugins into XML. More...

	executeCommand ()
	execute command More...

	setQEditTabs ($a_active)
	Set question editing tabs. More...

	onFeedbackEditingForwarding ()
	On feedback editing forwarding. More...

	deactivatePage ()

	activatePage ()

	showPage ()
	display content of page More...

	replaceCurlyBrackets ($output)
	Replace curly brackets. More...

	getActivationCaptions ()
	Get captions for activation action menu entries. More...

	setEditMode ()
	Set edit mode. More...

	setDefaultLinkXml ()
	Set standard link xml. More...

	setLinkXml ($xml)
	Set linkXML. More...

	getProfileBackUrl ()
	Get profile back url. More...

	setProfileBackUrl ($url)
	Get profile back url. More...

	downloadFile ()
	Download file of file lists. More...

	displayMediaFullscreen ()
	Show media in fullscreen mode. More...

	displayMedia ($a_fullscreen=false)
	Display media. More...

	download_paragraph ()
	download source code paragraph More...

	insertPageToc ($a_output)
	Insert page toc. More...

	insertResources ($a_output)
	Insert resources. More...

	insertAdvTrigger ($a_output)
	Insert adv content trigger. More...

	postOutputProcessing ($a_output)
	Finalizing output processing. More...

	previewHistory ()
	Preview history. More...

	preview ()
	preview More...

	edit ()
	edit ("view" before) More...

	getBlockingInfoMessage ()
	Get block info message. More...

	insertJSAtPlaceholder ()
	InsertJS at placeholder. More...

	initCaptchaForm ()
	Init captcha form. More...

	presentation ($a_mode=self::PRESENTATION)

	getHTML ()

	showMediaFullscreen ($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 ()
	Set screen id component. More...

	getTabs ($a_activate="")
	adds tabs to tab gui object More...

	compareVersion ()
	Compares two revisions of the page. More...

	replaceDiffTags ($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 ($a_content_object=null, $a_enable_private_notes=true, $a_enable_public_notes=false, $a_enable_notes_deletion=false, $a_callback=null, $export=false)
	Get html for public and/or private notes. More...

	processAnswer ()
	Process answer. More...

	initialOpenedContent ()
	Initially opened content. More...

	initOpenedContentForm ()
	Init form for initially opened content. More...

	saveInitialOpenedContent ()
	Save initial opened content. More...

	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 ()
	Get page perma link. More...

	getAdditionalPageActions ()
	Get additional page actions. More...

Data Fields
const	TEMP_PRESENTATION_TITLE_PLACEHOLDER = '___TEMP_PRESENTATION_TITLE_PLACEHOLDER___'

Data Fields inherited from ilPageObjectGUI
const	PRESENTATION = "presentation"

const	EDIT = "edit"

const	PREVIEW = "preview"

const	OFFLINE = "offline"

const	PRINTING = "print"

	$obj

	$presentation_title

	$target_script

	$return_location

	$target_var

	$template_output_var

	$output2template

	$link_params

	$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
	isPageContainerToBeRendered ()

Protected Member Functions inherited from ilPageObjectGUI
	initPageObject ()
	Init page object. More...

	showEditToolbar ()
	Show edit toolbar. More...

	setEditorToolContext ()
	Set editor tool context. More...

	initEditing ()
	Init editing. More...

	showEditLockInfo ()

	setBackToEditTabs ()

	isPageContainerToBeRendered ()

	addResourcesToTemplate (ilGlobalTemplateInterface $tpl)
	Add resources to template. More...

Private Attributes
	$originalPresentationTitle = ''

	$questionInfoHTML = ''

	$questionActionsHTML = ''

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, $a_user_links=false, \ILIAS\COPage\Editor\Server\UIWrapper $ui_wrapper=null)
	Get Tiny Menu. More...

Protected Attributes inherited from ilPageObjectGUI
	$profile_back_url = ""

	$enabled_href = true

	$tpl

	$lng

	$ctrl

	$tabs_gui

	$access

	$plugin_admin

	$log

	$user

	$help

	$output_mode

	$parent_type = ""

	$tool_context

	$ui

	$page_linker

	$abstract_pcid = ""

	$toolbar

	$open_place_holder

Detailed Description

Question page GUI class.

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

@ilCtrl_Calls ilAssQuestionPageGUI: ilPageEditorGUI, ilEditClipboardGUI, ilMDEditorGUI @ilCtrl_Calls ilAssQuestionPageGUI: ilPublicUserProfileGUI, ilNoteGUI @ilCtrl_Calls ilAssQuestionPageGUI: ilPropertyFormGUI, ilInternalLinkGUI

Definition at line 18 of file class.ilAssQuestionPageGUI.php.

Constructor & Destructor Documentation

◆ __construct()

ilAssQuestionPageGUI::__construct	(	$a_id = `0`,
		$a_old_nr = `0`
	)

Constructor.

Parameters

int	$a_id
int	$a_old_nr

Returns: \ilAssQuestionPageGUI

Reimplemented in ilTestExpressPageObjectGUI.

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

    {
        parent::__construct('qpl', $a_id, $a_old_nr);
        $this->setEnabledPageFocus(false);
        if (strtolower($_GET['cmdClass']) === 'ilassquestionpreviewgui') {
            $this->setFileDownloadLink($this->ctrl->getLinkTargetByClass(ilObjQuestionPoolGUI::class, 'downloadFile'));
        } else {
            $this->setFileDownloadLink($this->ctrl->getLinkTargetByClass(ilObjTestGUI::class, 'downloadFile'));
        }
    }

References $_GET, ILIAS\GlobalScreen\Provider\__construct(), ilPageObjectGUI\setEnabledPageFocus(), and ilPageObjectGUI\setFileDownloadLink().

Here is the call graph for this function:

Member Function Documentation

◆ finishEditing()

ilAssQuestionPageGUI::finishEditing ( )

Reimplemented from ilPageObjectGUI.

Definition at line 78 of file class.ilAssQuestionPageGUI.php.

    {
        $this->ctrl->redirectByClass('ilAssQuestionPreviewGUI', ilAssQuestionPreviewGUI::CMD_SHOW);
    }

References ilAssQuestionPreviewGUI\CMD_SHOW.

◆ getOriginalPresentationTitle()

ilAssQuestionPageGUI::getOriginalPresentationTitle ( )

Definition at line 48 of file class.ilAssQuestionPageGUI.php.

    {
        return $this->originalPresentationTitle;
    }

References $originalPresentationTitle.

Referenced by postOutputProcessing().

Here is the caller graph for this function:

◆ insertPageToc()

ilAssQuestionPageGUI::insertPageToc ( $a_output )

Replace page toc placeholder with question info and actions.

Todo:: : support question info and actions in the page XSL directly the current workaround avoids changing the COPage service

Parameters

$a_output

Returns: mixed

Reimplemented from ilPageObjectGUI.

Definition at line 124 of file class.ilAssQuestionPageGUI.php.

    {
        if (!empty($this->questionInfoHTML) || !empty($this->questionActionsHTML)) {
            $tpl = new ilTemplate('tpl.tst_question_subtitle_blocks.html', true, true, 'Modules/TestQuestionPool');
            $tpl->setVariable('QUESTION_INFO', $this->questionInfoHTML);
            $tpl->setVariable('QUESTION_ACTIONS', $this->questionActionsHTML);
            $a_output = str_replace("{{{{{PageTOC}}}}}", $tpl->get(), $a_output);
        } else {
            $a_output = str_replace("{{{{{PageTOC}}}}}", '', $a_output);
        }
        return $a_output;
    }

References ilPageObjectGUI\$tpl.

◆ isPageContainerToBeRendered()

ilAssQuestionPageGUI::isPageContainerToBeRendered ( )

protected

Reimplemented from ilPageObjectGUI.

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

    {
        return $this->getRenderPageContainer();
    }

References ilPageObjectGUI\getRenderPageContainer().

Here is the call graph for this function:

◆ postOutputProcessing()

ilAssQuestionPageGUI::postOutputProcessing ( $a_output )

Finalizing output processing.

Maybe overwritten in derived classes, e.g. in wiki module.

Reimplemented from ilPageObjectGUI.

Definition at line 83 of file class.ilAssQuestionPageGUI.php.

    {
        $output = str_replace(
            self::TEMP_PRESENTATION_TITLE_PLACEHOLDER,
            $this->getOriginalPresentationTitle(),
            $output
        );
 
        $output = preg_replace("/src=\"\\.\\//ims", "src=\"" . ILIAS_HTTP_PATH . "/", $output);
 
        return $output;
    }

References getOriginalPresentationTitle().

Here is the call graph for this function:

◆ setOriginalPresentationTitle()

ilAssQuestionPageGUI::setOriginalPresentationTitle ( $originalPresentationTitle )

Definition at line 53 of file class.ilAssQuestionPageGUI.php.

    {
        $this->originalPresentationTitle = $originalPresentationTitle;
    }

References $originalPresentationTitle.

Referenced by showPage().

Here is the caller graph for this function:

◆ setQuestionActionsHTML()

ilAssQuestionPageGUI::setQuestionActionsHTML ( $a_html )

Set the HTML of a question actions block below the title.

Parameters

string $a_html

Definition at line 111 of file class.ilAssQuestionPageGUI.php.

    {
        $this->questionActionsHTML = $a_html;
    }

◆ setQuestionInfoHTML()

ilAssQuestionPageGUI::setQuestionInfoHTML ( $a_html )

Set the HTML of a question info block below the title (number, status, ...)

Parameters

string $a_html

Definition at line 102 of file class.ilAssQuestionPageGUI.php.

    {
        $this->questionInfoHTML = $a_html;
    }

◆ showPage()

ilAssQuestionPageGUI::showPage ( )

display content of page

Reimplemented from ilPageObjectGUI.

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

    {
        if ($this->getPresentationTitle() !== null) {
            $this->setOriginalPresentationTitle($this->getPresentationTitle());
            $this->setPresentationTitle(self::TEMP_PRESENTATION_TITLE_PLACEHOLDER);
        }
 
        // fau: testNav - enable page toc as placeholder for info and actions block (see self::insertPageToc)
        $config = $this->getPageConfig();
        $config->setEnablePageToc('y');
        $this->setPageConfig($config);
        // fau.
        return parent::showPage();
    }