ILIAS  release_5-2 Revision v5.2.25-18-g3f80b828510
ilAssQuestionPageGUI Class Reference

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...
 
 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="")
 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...
 
 setBibId ($a_id)
 Set Bib Id. More...
 
 getBibId ()
 Get Bib Id. More...
 
 setPageObject ($a_pg_obj)
 Set Page Object. More...
 
 getPageObject ()
 Get Page Object. More...
 
 setOutputMode ($a_mode=IL_PAGE_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 ()
 
 setLinkXML ($link_xml)
 
 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...
 
 enableCitation ($a_enabled)
 
 isEnabledCitation ()
 
 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...
 
 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...
 
 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)
 Set abstract only. More...
 
 getAbstractOnly ()
 Get abstract only. More...
 
 setRenderPageContainer ($a_val)
 Set render page container. More...
 
 getRenderPageContainer ()
 Get render page container. More...
 
 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...
 
 addActionsMenu ($a_tpl, $sel_media_mode, $sel_html_mode, $sel_js_mode)
 Add actions menu. More...
 
 addMultiLangActionsAndInfo ($a_list, $a_tpl)
 Add multi-language actions to menu. More...
 
 setEditMode ()
 Set edit mode. More...
 
 setDefaultLinkXml ()
 Set standard link xml. 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...
 
 insertHelp ($a_tpl)
 Insert help texts. More...
 
 previewHistory ()
 Preview history. More...
 
 preview ()
 preview More...
 
 edit ()
 edit ("view" before) More...
 
 insertJSAtPlaceholder ()
 InsertJS at placeholder. More...
 
 presentation ($a_mode=IL_PAGE_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)
 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...
 

Data Fields

const TEMP_PRESENTATION_TITLE_PLACEHOLDER = '___TEMP_PRESENTATION_TITLE_PLACEHOLDER___'
 
- 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

 isPageContainerToBeRendered ()
 
- Protected Member Functions inherited from ilPageObjectGUI
 initPageObject ()
 Init page object. More...
 
 getActivationCaptions ()
 Get captions for activation action menu entries. More...
 
 isPageContainerToBeRendered ()
 

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)
 Get Tiny Menu. More...
 
- Protected Attributes inherited from ilPageObjectGUI
 $parent_type = ""
 
 $log
 

Detailed Description

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.

38 {
39 parent::__construct('qpl', $a_id, $a_old_nr);
40 $this->setEnabledPageFocus(false);
41 }
setEnabledPageFocus($a_enabledpagefocus)
Set Enable page focus.

References ilPageObjectGUI\setEnabledPageFocus().

+ Here is the call graph for this function:

Member Function Documentation

◆ getOriginalPresentationTitle()

ilAssQuestionPageGUI::getOriginalPresentationTitle ( )

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

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 111 of file class.ilAssQuestionPageGUI.php.

112 {
113 if (!empty($this->questionInfoHTML) || !empty($this->questionActionsHTML))
114 {
115 $tpl = new ilTemplate('tpl.tst_question_subtitle_blocks.html', true, true, 'Modules/TestQuestionPool');
116 $tpl->setVariable('QUESTION_INFO',$this->questionInfoHTML);
117 $tpl->setVariable('QUESTION_ACTIONS',$this->questionActionsHTML);
118 $a_output = str_replace("{{{{{PageTOC}}}}}", $tpl->get(), $a_output);
119 }
120 else
121 {
122 $a_output = str_replace("{{{{{PageTOC}}}}}", '', $a_output);
123 }
124 return $a_output;
125 }
special template class to simplify handling of ITX/PEAR

References ilPageObjectGUI\$tpl.

◆ isPageContainerToBeRendered()

ilAssQuestionPageGUI::isPageContainerToBeRendered ( )
protected

Reimplemented from ilPageObjectGUI.

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

54 {
55 return $this->getRenderPageContainer();
56 }
getRenderPageContainer()
Get render page container.

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 72 of file class.ilAssQuestionPageGUI.php.

73 {
74 $output = str_replace(
75 self::TEMP_PRESENTATION_TITLE_PLACEHOLDER, $this->getOriginalPresentationTitle(), $output
76 );
77
78 $output = preg_replace("/src=\"\\.\\//ims", "src=\"" . ILIAS_HTTP_PATH . "/", $output);
79
80 return $output;
81 }
if(!is_dir( $entity_dir)) exit("Fatal Error ([A-Za-z0-9]+)\s+" &#(? foreach( $entity_files as $file) $output

References $output, and getOriginalPresentationTitle().

+ Here is the call graph for this function:

◆ setOriginalPresentationTitle()

ilAssQuestionPageGUI::setOriginalPresentationTitle (   $originalPresentationTitle)

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

49 {
50 $this->originalPresentationTitle = $originalPresentationTitle;
51 }

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 98 of file class.ilAssQuestionPageGUI.php.

99 {
100 $this->questionActionsHTML = $a_html;
101 }

◆ 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 89 of file class.ilAssQuestionPageGUI.php.

90 {
91 $this->questionInfoHTML = $a_html;
92 }

◆ showPage()

ilAssQuestionPageGUI::showPage ( )

display content of page

Reimplemented from ilPageObjectGUI.

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

59 {
61
62 $this->setPresentationTitle(self::TEMP_PRESENTATION_TITLE_PLACEHOLDER);
63
64// fau: testNav - enable page toc as placeholder for info and actions block (see self::insertPageToc)
65 $config = $this->getPageConfig();
66 $config->setEnablePageToc('y');
67 $this->setPageConfig($config);
68// fau.
69 return parent::showPage();
70 }
setOriginalPresentationTitle($originalPresentationTitle)
setPresentationTitle($a_title="")
setPageConfig($a_val)
Set page config object.
getPageConfig()
Get page config object.

References $config, ilPageObjectGUI\getPageConfig(), ilPageObjectGUI\getPresentationTitle(), setOriginalPresentationTitle(), ilPageObjectGUI\setPageConfig(), and ilPageObjectGUI\setPresentationTitle().

Referenced by ilTestExpressPageObjectGUI\executeCommand().

+ Here is the call graph for this function:
+ Here is the caller graph for this function:

Field Documentation

◆ $originalPresentationTitle

ilAssQuestionPageGUI::$originalPresentationTitle = ''
private

◆ $questionActionsHTML

ilAssQuestionPageGUI::$questionActionsHTML = ''
private

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

◆ $questionInfoHTML

ilAssQuestionPageGUI::$questionInfoHTML = ''
private

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

◆ TEMP_PRESENTATION_TITLE_PLACEHOLDER

const ilAssQuestionPageGUI::TEMP_PRESENTATION_TITLE_PLACEHOLDER = '___TEMP_PRESENTATION_TITLE_PLACEHOLDER___'

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


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