ILIAS  Release_5_0_x_branch Revision 61816
 All Data Structures Namespaces Files Functions Variables Groups Pages
ilSCORM2004PageGUI Class Reference

Class ilSCORM2004Page GUI class. More...

+ Inheritance diagram for ilSCORM2004PageGUI:
+ Collaboration diagram for ilSCORM2004PageGUI:

Public Member Functions

 __construct ($a_parent_type, $a_id=0, $a_old_nr=0, $a_slm_id=0, $a_glo_id=0)
 Constructor.
 setGlossaryOverviewInfo ($a_ov_id, $a_sco)
 Set glossary overview id.
 getGlossaryOverviewId ()
 Get glossary overview id.
executeCommand ()
 execute command
 setSCORM2004Page ($a_scpage)
 Set SCORM2004 Page Object.
 getSCORM2004Page ()
 Get SCORM2004 Page Object.
 getQuestionHtmlOfPage ()
 Get question html for page.
 initSelfAssessmentRendering ()
 Init question handling.
 selfAssessmentRendering ($a_output)
 Self assessment question rendering.
 showPage ($a_mode="preview")
 Show the page.
 setDefaultLinkXml ()
 Set standard link xml (currently only glossaries)
 postOutputProcessing ($a_output)
 Post output processing:
- 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.
 setQEditTabs ($a_active)
 Set question editing tabs.
 onFeedbackEditingForwarding ()
 On feedback editing forwarding.
 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.
 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.
 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.
 processAnswer ()
 Process answer.
 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.

Static Public Member Functions

static initExport ()
 Init export.
static getGlossaryHTML ($a_sco)
 Get glossary html (only in export mode)
- 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.

Static Public Attributes

static $export_glo_tpl

Protected Attributes

 $glossary_links = array()
 $scorm_mode = "preview"
- Protected Attributes inherited from ilPageObjectGUI
 $parent_type = ""

Additional Inherited Members

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

Detailed Description

Constructor & Destructor Documentation

ilSCORM2004PageGUI::__construct (   $a_parent_type,
  $a_id = 0,
  $a_old_nr = 0,
  $a_slm_id = 0,
  $a_glo_id = 0 
)

Constructor.

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

References $ilCtrl, ilPageObjectGUI\$tpl, ilPageObjectGUI\enableNotes(), ilPageObjectGUI\getPageObject(), and ilPageObjectGUI\setIntLinkReturn().

{
global $tpl, $ilCtrl;
$this->glo_id = $a_glo_id;
$this->slm_id = $a_slm_id;
$a_parent_type = "sahs";
parent::__construct($a_parent_type, $a_id, $a_old_nr);
$this->getPageObject()->setGlossaryId($this->glo_id);
$ilCtrl->getLinkTargetByClass("ilobjscorm2004learningmodulegui", "showTree",
"", false, false));
include_once("./Modules/ScormAicc/classes/class.ilObjSAHSLearningModule.php");
$this->enableNotes(true, $this->slm_id);
}

+ Here is the call graph for this function:

Member Function Documentation

& ilSCORM2004PageGUI::executeCommand ( )

execute command

Reimplemented from ilPageObjectGUI.

Definition at line 74 of file class.ilSCORM2004PageGUI.php.

References $cmd, and $ilCtrl.

{
global $ilCtrl;
$next_class = $this->ctrl->getNextClass($this);
$cmd = $this->ctrl->getCmd();
switch($next_class)
{
case 'ilmdeditorgui':
break;
case "ilpageobjectgui":
die("ilSCORM2004PageGUI forwarding to ilpageobjectgui error.");
return;
default:
return $html;
}
}
static ilSCORM2004PageGUI::getGlossaryHTML (   $a_sco)
static

Get glossary html (only in export mode)

Definition at line 423 of file class.ilSCORM2004PageGUI.php.

References $ret, and ilSCORM2004ScoGUI\getGloOverviewOv().

Referenced by ilSCORM2004Asset\exportHTMLPageObjects(), and ilSCORM2004ScoGUI\sco_preview().

{
$ret = self::$export_glo_tpl->get();
return $ret;
}

+ Here is the call graph for this function:

+ Here is the caller graph for this function:

ilSCORM2004PageGUI::getGlossaryOverviewId ( )

Get glossary overview id.

Returns
string glossary overview id

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

Referenced by postOutputProcessing().

{
return $this->glossary_ov_id;
}

+ Here is the caller graph for this function:

ilSCORM2004PageGUI::getQuestionHtmlOfPage ( )

Get question html for page.

Definition at line 131 of file class.ilSCORM2004PageGUI.php.

References assQuestionGUI\_getQuestionGUI(), and ilPageObjectGUI\getPageObject().

{
$q_ids = $this->getPageObject()->getQuestionIds();
$html = array();
if (count($q_ids) > 0)
{
foreach ($q_ids as $q_id)
{
include_once("./Modules/TestQuestionPool/classes/class.assQuestionGUI.php");
$q_gui =& assQuestionGUI::_getQuestionGUI("", $q_id);
$q_gui->outAdditionalOutput();
$html[$q_id] = $q_gui->getPreview(TRUE);
}
}
return $html;
}

+ Here is the call graph for this function:

ilSCORM2004PageGUI::getSCORM2004Page ( )

Get SCORM2004 Page Object.

Returns
object Page Object

Definition at line 112 of file class.ilSCORM2004PageGUI.php.

References ilPageObjectGUI\getPageObject().

{
return $this->getPageObject();
}

+ Here is the call graph for this function:

static ilSCORM2004PageGUI::initExport ( )
static

Init export.

Definition at line 415 of file class.ilSCORM2004PageGUI.php.

Referenced by ilSCORM2004Asset\exportHTMLPageObjects(), and ilSCORM2004ScoGUI\sco_preview().

{
self::$export_glo_tpl = new ilTemplate("tpl.glossary_entries.html", true, true, "Modules/Scorm2004");
}

+ Here is the caller graph for this function:

ilSCORM2004PageGUI::initSelfAssessmentRendering ( )

Init question handling.

Parameters
@return

Definition at line 157 of file class.ilSCORM2004PageGUI.php.

{
if ($this->scorm_mode == "preview")
{
// parent::initSelfAssessmentRendering(); // todo: not called anymore
}
}
ilSCORM2004PageGUI::postOutputProcessing (   $a_output)

Post output processing:

  • Add glossary divs

Reimplemented from ilPageObjectGUI.

Definition at line 268 of file class.ilSCORM2004PageGUI.php.

References $export_glo_tpl, $ret, ilPageObjectGUI\$tpl, ilObjSAHSLearningModule\getAffectiveLocalization(), ilSCORM2004ScoGUI\getGloOverviewOv(), getGlossaryOverviewId(), ilPageObjectGUI\getOutputMode(), ilPageObjectGUI\getPageObject(), and IL_PAGE_PREVIEW.

{
//var_dump($this->glossary_links);
include_once("./Services/UIComponent/Overlay/classes/class.ilOverlayGUI.php");
if ($this->scorm_mode != "export")
{
$tpl = new ilTemplate("tpl.glossary_entries.html", true, true, "Modules/Scorm2004");
}
else
{
}
$glossary = false;
$overlays = array();
// overlay for sco glossary
if ($this->getGlossaryOverviewId() != "" && $this->getOutputMode() != "edit")
{
$ovov = $overlays[$this->getGlossaryOverviewId()] = new ilOverlayGUI($this->getGlossaryOverviewId());
// $ovov->setFixedCenter(true);
$ovov->setAutoHide(false);
$ovov->setCloseElementId("glo_ov_close");
if ($this->getGlossaryOverviewId() != "")
{
if ($this->scorm_mode != "export" ||
{
$overlays[$this->getGlossaryOverviewId()]->add();
}
else
{
$tpl->setCurrentBlock("add_script");
$tpl->setVariable("ADD_SCRIPT", "il.Util.addOnLoad(function () {".$overlays[$this->getGlossaryOverviewId()]->getOnLoadCode()."});");
$tpl->parseCurrentBlock();
}
}
}
if ($this->getOutputMode() != "edit")
{
if (is_array($this->glossary_links))
{
foreach ($this->glossary_links as $k => $e)
{
// glossary link
if ($e["Type"] == "GlossaryItem")
{
$karr = explode(":", $k);
$link_id = $karr[0]."_".$this->getPageObject()->getId()."_".$karr[4];
//$ov_id = "ov".$karr[0]."_".$karr[4];
$ov_id = "ov".$karr[0];
$cl_id = "ov".$karr[0]."cl";
$glov_id = "ov".$karr[0]."ov";
$term_id_arr = explode("_", $karr[0]);
$term_id = $term_id_arr[count($term_id_arr) - 1];
// get overlay html from glossary term
include_once("./Modules/Glossary/classes/class.ilGlossaryTermGUI.php");
$id_arr = explode("_", $karr[0]);
$term_gui =& new ilGlossaryTermGUI($id_arr[count($id_arr) - 1]);
$html = $term_gui->getOverlayHTML($cl_id, ($this->getGlossaryOverviewId() != "")
? $glov_id
: "",
$tpl->setCurrentBlock("entry");
$tpl->setVariable("CONTENT", $html);
$tpl->setVariable("OVERLAY_ID", $ov_id);
$glossary = true;
// first time the term is used
if (!isset($overlays[$ov_id]))
{
$overlays[$ov_id] = new ilOverlayGUI($ov_id);
$overlays[$ov_id]->setAnchor($link_id);
$overlays[$ov_id]->setTrigger($link_id, "click", $link_id);
$overlays[$ov_id]->setAutoHide(false);
$overlays[$ov_id]->setCloseElementId($cl_id);
if ($this->scorm_mode != "export" ||
{
$overlays[$ov_id]->add();
}
else
{
$tpl->setVariable("SCRIPT", "il.Util.addOnLoad(function () {".$overlays[$ov_id]->getOnLoadCode()."});");
}
}
else
{
if ($this->scorm_mode != "export" ||
{
$overlays[$ov_id]->addTrigger($link_id, "click", $link_id);
}
else
{
$tpl->setVariable("SCRIPT",
"il.Util.addOnLoad(function () {".$overlays[$ov_id]->getTriggerOnLoadCode($link_id, "click", $link_id)."});");
}
}
if ($this->getGlossaryOverviewId() != "")
{
if ($this->scorm_mode != "export" ||
{
//$overlays[$this->getGlossaryOverviewId()]->addTrigger($glov_id, "click", null);
$overlays[$this->getGlossaryOverviewId()]->addTrigger($glov_id, "click", $ov_id, false, "tl", "tl");
//$overlays[$ov_id]->addTrigger("glo_ov_t".$term_id, "click", null, true);
$overlays[$ov_id]->addTrigger("glo_ov_t".$term_id, "click", $this->getGlossaryOverviewId(), false, "tl", "tl");
}
else
{
$tpl->setVariable("SCRIPT2",
"il.Util.addOnLoad(function () {".
$overlays[$this->getGlossaryOverviewId()]->getTriggerOnLoadCode($glov_id, "click", $ov_id, false, "tl", "tl")."});");
$tpl->setVariable("SCRIPT3",
"il.Util.addOnLoad(function () {".
$overlays[$ov_id]->getTriggerOnLoadCode("glo_ov_t".$term_id, "click", $this->getGlossaryOverviewId(), false, "tl", "tl")."});");
}
}
$tpl->parseCurrentBlock();
}
}
}
if ($glossary && $this->scorm_mode != "export")
{
$ret = $a_output.$tpl->get();
if ($this->getGlossaryOverviewId() != "")
{
}
return $ret;
}
}
return $a_output;
}

+ Here is the call graph for this function:

ilSCORM2004PageGUI::selfAssessmentRendering (   $a_output)

Self assessment question rendering.

Parameters
@return

Definition at line 171 of file class.ilSCORM2004PageGUI.php.

{
if ($this->scorm_mode == "preview")
{
$a_output = parent::selfAssessmentRendering($a_output);
}
return $a_output;
}
ilSCORM2004PageGUI::setDefaultLinkXml ( )

Set standard link xml (currently only glossaries)

Reimplemented from ilPageObjectGUI.

Definition at line 200 of file class.ilSCORM2004PageGUI.php.

References $target_arr, $target_id, ilObjFile\_lookupFileName(), ilObject\_lookupType(), ilPageObjectGUI\determineFileDownloadLink(), ilPageObjectGUI\getOutputMode(), ilPageObjectGUI\getPageObject(), and ilPageObjectGUI\setLinkXML().

{
$int_links = $this->getPageObject()->getInternalLinks(true);
$this->glossary_links = $int_links;
//var_dump($int_links);
// key is il__git_18:GlossaryItem:Glossary::4 => id is il__git_18_4,
$link_info = "<IntLinkInfos>";
$targetframe = "None";
$ltarget = "";
foreach ($int_links as $int_link)
{
$onclick = "";
$target = $int_link["Target"];
$targetframe = "None";
if (substr($target, 0, 4) == "il__")
{
$target_arr = explode("_", $target);
$type = $int_link["Type"];
switch($type)
{
case "GlossaryItem":
$ltarget = "";
//$href = "./goto.php?target=git_".$target_id;
$href = "#";
$onclick = 'OnClick="return false;"';
$anc_par = 'Anchor=""';
$targetframe = "Glossary";
break;
case "File":
$ltarget = "";
if ($this->getOutputMode() == "offline")
{
{
include_once("./Modules/File/classes/class.ilObjFile.php");
$href = "./files/file_".$target_id."/".ilObjFile::_lookupFileName($target_id);
$ltarget = "_blank";
}
}
else
{
$href = str_replace("&", "&amp;", $this->determineFileDownloadLink())."&amp;file_id=il__file_".$target_id;
//echo htmlentities($href);
}
$anc_par = 'Anchor=""';
$targetframe = "None"; //???
break;
}
$link_info.="<IntLinkInfo $onclick Target=\"$target\" Type=\"$type\" ".$anc_par." ".
"TargetFrame=\"$targetframe\" LinkHref=\"$href\" LinkTarget=\"$ltarget\" />";
}
}
$link_info.= "</IntLinkInfos>";
$this->setLinkXML($link_info);
//var_dump($link_info);
}

+ Here is the call graph for this function:

ilSCORM2004PageGUI::setGlossaryOverviewInfo (   $a_ov_id,
  $a_sco 
)

Set glossary overview id.

Parameters
stringglossary overview id

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

{
$this->glossary_ov_id = $a_ov_id;
$this->sco = $a_sco;
}
ilSCORM2004PageGUI::setSCORM2004Page (   $a_scpage)

Set SCORM2004 Page Object.

Parameters
object$a_scpagePage Object

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

References ilPageObjectGUI\setPageObject().

{
$this->setPageObject($a_scpage);
}

+ Here is the call graph for this function:

ilSCORM2004PageGUI::showPage (   $a_mode = "preview")

Show the page.

Definition at line 184 of file class.ilSCORM2004PageGUI.php.

References $ilCtrl, ilPageObjectGUI\$tpl, ilPageObjectGUI\setTemplateOutput(), and ilPageObjectGUI\showPage().

{
global $tpl, $ilCtrl;
$this->scorm_mode = $a_mode;
$this->setTemplateOutput(false);
$output = parent::showPage();
return $output;
}

+ Here is the call graph for this function:

Field Documentation

ilSCORM2004PageGUI::$export_glo_tpl
static

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

Referenced by postOutputProcessing().

ilSCORM2004PageGUI::$glossary_links = array()
protected

Definition at line 23 of file class.ilSCORM2004PageGUI.php.

ilSCORM2004PageGUI::$scorm_mode = "preview"
protected

Definition at line 24 of file class.ilSCORM2004PageGUI.php.


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