ilAssQuestionPageGUI Class Reference

Question page GUI class. More...

Inheritance diagram for ilAssQuestionPageGUI:

Collaboration diagram for ilAssQuestionPageGUI:

Public Member Functions
	__construct (int $a_id=0)
	showPage ()
	display content of page More...
	finishEditing ()
	postOutputProcessing (string $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 (string $a_output)
	Replace page toc placeholder with question info and actions. More...
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)
	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 ()
	getMetaDataLink ()
	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...
	afterDeleteContents ()

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 ()
	showEditLockInfo ()
	setBackToEditTabs ()
	setBackToHistoryTabs ()
	checkLangPageAvailable (int $id, string $lang)
	isPageContainerToBeRendered ()
	addResourcesToTemplate (ilGlobalTemplateInterface $tpl)
	Add resources to template. More...

Private Attributes
	$question_info_html = ''
	$question_actions_html = ''

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	$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 Attributes inherited from ilPageObjectGUI
ILIAS TestQuestionPool Questions PublicInterface	$questioninfo
ILIAS COPage Page PageManager	$pm
ILIAS COPage Link LinkManager	$link
ILIAS COPage InternalGUIService	$gui
ILIAS COPage PC PCDefinition	$pc_definition
ILIAS COPage Xsl XslManager	$xsl
ILIAS COPage Editor GUIService	$editor_gui
ILIAS Notes Service	$notes
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
ILIAS COPage Compare PageCompare	$compare

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: ILIAS\User\Profile\PublicProfileGUI, ilCommentGUI @ilCtrl_Calls ilAssQuestionPageGUI: ilPropertyFormGUI, ilInternalLinkGUI

\

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

Constructor & Destructor Documentation

__construct()

ilAssQuestionPageGUI::__construct

(

int

$a_id = 0

)

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

    {
        parent::__construct('qpl', $a_id);
        $this->setEnabledPageFocus(false);
    }

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

Here is the call graph for this function:

Member Function Documentation

finishEditing()

ilAssQuestionPageGUI::finishEditing

(

)

Reimplemented from ilPageObjectGUI.

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

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

References ilAssQuestionPreviewGUI\CMD_SHOW, and ILIAS\Repository\ctrl().

Here is the call graph for this function:

insertPageToc()

ilAssQuestionPageGUI::insertPageToc

(

string

$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

Reimplemented from ilPageObjectGUI.

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

                                                   : string
    {
        if (!empty($this->question_info_html) || !empty($this->question_actions_html)) {
            $tpl = new ilTemplate('tpl.tst_question_subtitle_blocks.html', true, true, 'components/ILIAS/TestQuestionPool');
            $tpl->setVariable('QUESTION_INFO', $this->question_info_html);
            $tpl->setVariable('QUESTION_ACTIONS', $this->question_actions_html);
            $a_output = str_replace("{{{{{PageTOC}}}}}", $tpl->get(), $a_output);
        } else {
            $a_output = str_replace("{{{{{PageTOC}}}}}", '', $a_output);
        }
        return $a_output;
    }

References ilPageObjectGUI\$tpl, ILIAS\UICore\GlobalTemplate\get(), and ILIAS\UICore\GlobalTemplate\setVariable().

Here is the call graph for this function:

isPageContainerToBeRendered()

ilAssQuestionPageGUI::isPageContainerToBeRendered ( )

protected

Reimplemented from ilPageObjectGUI.

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

                                                    : bool
    {
        return $this->getRenderPageContainer();
    }

References ilPageObjectGUI\getRenderPageContainer().

Here is the call graph for this function:

postOutputProcessing()

ilAssQuestionPageGUI::postOutputProcessing

(

string

$a_output

)

Finalizing output processing.

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

Reimplemented from ilPageObjectGUI.

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

                                                        : string
    {
        return preg_replace('/src="\./ims', 'src="' . ILIAS_HTTP_PATH . '/', $output);
    }

setQuestionActionsHTML()

ilAssQuestionPageGUI::setQuestionActionsHTML

(

$a_html

)

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

Parameters

string

$a_html

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

                                                   : void
    {
        $this->question_actions_html = $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 73 of file class.ilAssQuestionPageGUI.php.

                                                : void
    {
        $this->question_info_html = $a_html;
    }

showPage()

ilAssQuestionPageGUI::showPage

(

)

display content of page

Reimplemented from ilPageObjectGUI.

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

                              : string
    {
        $config = $this->getPageConfig();
        $config->setEnablePageToc(true);
        $this->setPageConfig($config);
        // fau.
        return parent::showPage();
    }

References ilPageObjectGUI\getPageConfig(), and ilPageObjectGUI\setPageConfig().

Here is the call graph for this function:

Field Documentation

$question_actions_html

ilAssQuestionPageGUI::$question_actions_html = ''

private

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

$question_info_html

ilAssQuestionPageGUI::$question_info_html = ''

private

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

---

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

• components/ILIAS/TestQuestionPool/classes/class.ilAssQuestionPageGUI.php