ilPageLayoutGUI Class Reference

Class ilPageLayoutGUI GUI class. More...

Inheritance diagram for ilPageLayoutGUI:

Collaboration diagram for ilPageLayoutGUI:

Public Member Functions
	__construct ($a_parent_type, $a_id=0, $a_old_nr=0, $a_slm_id=0)
&	executeCommand ()
	execute command
	create ()
	properties ($a_mode="save", $a_form=null)
	Edit page layout properties.
	initForm ($a_mode)
	updateProperties ()
	Update properties.
	setTabs ()
	output tabs
Public Member Functions inherited from ilPageObjectGUI
	ilPageObjectGUI ($a_parent_type, $a_id=0, $a_old_nr=0, $a_prevent_get_id=false)
	Constructor public.
	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.
	initPageObject ($a_parent_type, $a_id, $a_old_nr)
	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 ()
	setOutputSubmode ($a_mode)
	getOutputSubmode ()
	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 ()
	setEnableKeywords ($a_val)
	Set enable keywords handling.
	getEnableKeywords ()
	Get enable keywords handling.
	setEnableAnchors ($a_val)
	Set enable anchors.
	getEnableAnchors ()
	Get enable anchors.
	setIntLinkHelpDefault ($a_type, $a_id)
	setIntLinkReturn ($a_return)
	enableChangeComments ($a_enabled)
	isEnabledChangeComments ()
	enableNotes ($a_enabled, $a_parent_id)
	isEnabledNotes ()
	enableContentIncludes ($a_enable)
	Enable content includes.
	isEnabledContentIncludes ()
	Are content includes enabled?
	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)
	setEnabledActivation ($a_act)
	getEnabledActivation ()
	setEnabledScheduledActivation ($a_act)
	getEnabledScheduledActivation ()
	setPageToc ($a_val)
	Set page toc.
	getPageToc ()
	Get page toc.
	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.
	setEnabledInternalLinks ($a_enabledinternallinks)
	Set Enable internal links.
	getEnabledInternalLinks ()
	Get Enable internal links.
	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.
	setPreventHTMLUnmasking ($a_preventhtmlunmasking)
	Set Prevent HTML Unmasking (true/false).
	getPreventHTMLUnmasking ()
	Get Prevent HTML Unmasking (true/false).
	setEnabledTabs ($a_enabledtabs)
	Set Output tabs.
	getEnabledTabs ()
	Get Output tabs.
	setEnabledRepositoryObjects ($a_enabledrepositoryobjects)
	Set Enable Repository Objects Content Component.
	getEnabledRepositoryObjects ()
	Get Enable Repository Objects Content Component.
	setEnabledLoginPage ($a_enablegloginpage)
	Set enable login page.
	getEnabledLoginPage ()
	Get enable login page.
	setEnabledMaps ($a_enabledmaps)
	Set Enable Maps Content Component.
	getEnabledMaps ()
	Get Enable Maps Content Component.
	setEnabledPCTabs ($a_enabledpctabs)
	Set Enable Tabs Content Component.
	getEnabledPCTabs ()
	Get Enable Tabs Content Component.
	setEnabledFileLists ($a_enabledfilelists)
	Set Enable File Lists Content Componente (Default is true).
	getEnabledFileLists ()
	Get Enable File Lists Content Componente (Default is true).
	setEnabledPageFocus ($a_enabledpagefocus)
	Set Enable page focus.
	getEnabledPageFocus ()
	Get Enable page focus.
	getEnabledProfile ()
	Get Enable Profile Content Component.
	setEnabledProfile ($a_enableprofile)
	Set Enable Profile Content Component.
	getEnabledVerification ()
	Get Enable Verification Content Component.
	setEnabledVerification ($a_enableverification)
	Set Enable Verification Content Component.
	getEnabledBlog ()
	Get Enable Blog Content Component.
	setEnabledBlog ($a_enableblog)
	Set Enable Blog Content Component.
	getEnabledSkills ()
	Get Enable Skills Content Component.
	setEnabledSkills ($a_enableskills)
	Set Enable Skills Content Component.
	setExplorerUpdater ($a_exp_frame, $a_exp_id, $a_exp_target_script)
	Set Explorer Updater.
	setPrependingHtml ($a_prependinghtml)
	Set Prepending HTML.
	getPrependingHtml ()
	Get Prepending HTML.
	setEnabledWikiLinks ($a_enablewikilinks)
	Set Enable Wiki Links.
	getEnabledWikiLinks ()
	Get Enable Wiki Links.
	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.
	setLayoutMode ($a_layout_mode)
	Set Layout Mode.
	getLayoutMode ()
	Get Layout Mode enabled/disabled.
	setStyleId ($a_styleid)
	Set Style Id.
	getStyleId ()
	Get Style Id.
	setEnabledSelfAssessment ($a_enabledselfassessment, $a_scorm=true)
	Set Enable Self Assessment Questions.
	getEnabledSelfAssessment ()
	Get Enable Self Assessment Questions.
	getEnabledSelfAssessmentScorm ()
	Is self assessment used in SCORM mode?
	setCompareMode ($a_val)
	Set compare mode.
	getCompareMode ()
	Get compare mode.
	setAbstractOnly ($a_val)
	Set abstract only.
	getAbstractOnly ()
	Get abstract only.
	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.
	deactivatePage ()
	activatePage ()
	showPage ()
	replaceCurlyBrackets ($output)
	Replace curly brackets.
	addActionsMenu ($a_tpl, $sel_media_mode, $sel_html_mode, $sel_js_mode)
	Add actions menu.
	setEditMode ()
	Set edit mode.
	setDefaultLinkXml ()
	Set standard link xml.
	downloadFile ()
	Download file of file lists.
	displayMediaFullscreen ()
	Show media in fullscreen mode.
	displayMedia ($a_fullscreen=false)
	Display media.
	download_paragraph ()
	download source code paragraph
	insertMaps ($a_html)
	Insert Maps.
	insertContentIncludes ($a_html)
	Insert Maps.
	insertPageToc ($a_output)
	Insert page toc.
	postOutputProcessing ($a_output)
	Finalizing output processing.
	insertHelp ($a_tpl)
	Insert help texts.
	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.
	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.
	getQuestionJsOfPage ($a_no_interaction=false)
	Get question js.
	initSelfAssessmentRendering ($a_force_no_form=false)
	Init question handling.
	processAnswer ()
	Process answer.
	selfAssessmentRendering ($a_output)
	Self assessment question rendering.

Data Fields
	$layout_object = null
	Constructor.
Data Fields inherited from ilPageObjectGUI
	$ilias
	$tpl
	$lng
	$ctrl
	$obj
	$output_mode
	$output_submode
	$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
	$enabledinternallinks = false
	$editpreview = false
	$use_meta_data = false
	$enabledpctabs = false
	$link_xml_set = false
	$enableediting = true
	$rawpagecontent = false
	$layoutmode = false
	$enabledcontentincludes = false
	$compare_mode = false
	$page_config = null
	$enable_keywords = false
	$enable_anchors = false
	$tabs_enabled = true
	$pl_start = "{{{{{"
	$pl_end = "}}}}}"
	$pc_types

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)
	Get Tiny Menu.
static	addPreparationJavascript ($a_tpl, $a_lang)
	Add standard texts.
static	getJSTextInitCode ($a_lang)
	Get js txt init code.
Protected Member Functions inherited from ilPageObjectGUI
	getActivationCaptions ()
	Get captions for activation action menu entries.

Detailed Description

Class ilPageLayoutGUI GUI class.

Author

Hendrik Holtmann holtm.nosp@m.ann@.nosp@m.me.co.nosp@m.m

Version

$Id$

ilPageLayoutGUI: ilPageEditorGUI, ilEditClipboardGUI ilPageLayoutGUI: ilPublicUserProfileGUI, ilPageObjectGUI

Definition at line 17 of file class.ilPageLayoutGUI.php.

Constructor & Destructor Documentation

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

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

References $ilCtrl, ilPageObjectGUI\$tpl, ilObjStyleSheet\getContentStylePath(), ilObjStyleSheet\getPlaceHolderStylePath(), ilObjStyleSheet\getSyntaxStylePath(), ilPageObjectGUI\setEnabledInternalLinks(), ilPageObjectGUI\setEnabledMaps(), ilPageObjectGUI\setEnabledSelfAssessment(), ilPageObjectGUI\setLayoutMode(), ilPageObjectGUI\setPreventHTMLUnmasking(), and ilPageObjectGUI\setStyleId().

        {
                global $tpl,$ilCtrl;
        
                parent::__construct($a_parent_type, $a_id, $a_old_nr);

                //associated object
                include_once("./Services/Style/classes/class.ilPageLayout.php");

                $this->layout_object = new ilPageLayout($a_id);
                $this->layout_object->readObject();

                // content style
                include_once("./Services/Style/classes/class.ilObjStyleSheet.php");
                $tpl->setCurrentBlock("ContentStyle");
                $tpl->setVariable("LOCATION_CONTENT_STYLESHEET",
                        ilObjStyleSheet::getContentStylePath($this->layout_object->getStyleId()));
                $tpl->parseCurrentBlock();
                
                $tpl->setCurrentBlock("SyntaxStyle");
                $tpl->setVariable("LOCATION_SYNTAX_STYLESHEET",
                        ilObjStyleSheet::getSyntaxStylePath());
                $tpl->setVariable("LOCATION_ADDITIONAL_STYLESHEET",
                        ilObjStyleSheet::getPlaceHolderStylePath());    
                $tpl->parseCurrentBlock();
                
                $this->setEnabledMaps(false);
                $this->setPreventHTMLUnmasking(false);
                $this->setEnabledInternalLinks(false);
                $this->setEnabledSelfAssessment(false);
                $this->setStyleId($this->layout_object->getStyleId());
                
                //set For GUI and associated object
                $this->setLayoutMode(true);
                $this->obj->setLayoutMode(true);
                
                $this->slm_id = $a_slm_id;
                
        }

Here is the call graph for this function:

Member Function Documentation

ilPageLayoutGUI::create

(

)

Definition at line 99 of file class.ilPageLayoutGUI.php.

References properties().

                         {
                $this->properties("insert");
        }

Here is the call graph for this function:

& ilPageLayoutGUI::executeCommand

(

)

execute command

Reimplemented from ilPageObjectGUI.

Definition at line 72 of file class.ilPageLayoutGUI.php.

References $cmd, $ilCtrl, ilPageObjectGUI\getPageObject(), ilPageObjectGUI\getStyleId(), and ilPageObjectGUI\ilPageObjectGUI().

        {
                global $ilCtrl;
                
                $next_class = $this->ctrl->getNextClass($this);
                $cmd = $this->ctrl->getCmd();

                switch($next_class)
                {
                        case 'ilmdeditorgui':
                                return parent::executeCommand();
                                break;

                        case "ilpageobjectgui":
                                // "stys" was "sahs" before
                                $page_gui = new ilPageObjectGUI("stys",
                                        $this->getPageObject()->getId(), $this->getPageObject()->old_nr);
                                $page_gui->setStyleId($this->getStyleId());
                                $html = $ilCtrl->forwardCommand($page_gui);
                                return $html;
                                
                        default:
                                $html = parent::executeCommand();
                                return $html;
                }
        }

Here is the call graph for this function:

ilPageLayoutGUI::initForm

(

$a_mode

)

Definition at line 122 of file class.ilPageLayoutGUI.php.

References $ilCtrl, $ilSetting, ilPageObjectGUI\$lng, ilObjStyleSheet\_getStandardStyles(), ilObject\_lookupTitle(), ilPageLayout\getAvailableModules(), ilSelectInputGUI\setOptions(), ilTextInputGUI\setSize(), ilCheckboxGroupInputGUI\setValue(), ilNonEditableValueGUI\setValue(), and ilTextAreaInputGUI\setValue().

Referenced by properties(), and updateProperties().

        {
                global $ilCtrl, $lng, $ilSetting;
                
                include_once("Services/Form/classes/class.ilPropertyFormGUI.php");
                $form_gui = new ilPropertyFormGUI();
                $form_gui->setFormAction($ilCtrl->getFormAction($this));
                $form_gui->setTitle($lng->txt("cont_ed_pglprop"));

                // title
                $title_input = new ilTextInputGUI($lng->txt("title"),"pgl_title");
                $title_input->setSize(50);
                $title_input->setMaxLength(128);
                $title_input->setValue($this->layout_object->title);
                $title_input->setTitle($lng->txt("title"));
                $title_input->setRequired(true);

                // description
                $desc_input = new ilTextAreaInputGUI($lng->txt("description"),"pgl_desc");
                $desc_input->setValue($this->layout_object->description);
                $desc_input->setRows(3);
                $desc_input->setCols(37);
                $desc_input->setTitle($lng->txt("description"));
                $desc_input->setRequired(false);
                
                // modules
                $mods = new ilCheckboxGroupInputGUI($this->lng->txt("modules"), "module");
                // $mods->setRequired(true);
                $mods->setValue($this->layout_object->getModules());
                foreach(ilPageLayout::getAvailableModules() as $mod_id => $mod_caption)
                {
                        $mod = new ilCheckboxOption($mod_caption, $mod_id);
                        $mods->addOption($mod);                 
                }

                $form_gui->addItem($title_input);
                $form_gui->addItem($desc_input);
                $form_gui->addItem($mods);

                // style
                $fixed_style = $ilSetting->get("fixed_content_style_id");
                $style_id = $this->layout_object->getStyleId();

                if ($fixed_style > 0)
                {
                        $st = new ilNonEditableValueGUI($lng->txt("cont_current_style"));
                        $st->setValue(ilObject::_lookupTitle($fixed_style)." (".
                                $this->lng->txt("global_fixed").")");
                        $form_gui->addItem($st);
                }
                else
                {
                        include_once("./Services/Style/classes/class.ilObjStyleSheet.php");
                        $st_styles = ilObjStyleSheet::_getStandardStyles(true, false);
                        $st_styles[0] = $this->lng->txt("default");
                        ksort($st_styles);
                        $style_sel = new ilSelectInputGUI($lng->txt("obj_sty"), "style_id");
                        $style_sel->setOptions($st_styles);
                        $style_sel->setValue($style_id);
                        $form_gui->addItem($style_sel);
                }
                                                
                $form_gui->addCommandButton("updateProperties", $lng->txt($a_mode));
                
                return $form_gui;
        }

Here is the call graph for this function:

Here is the caller graph for this function:

ilPageLayoutGUI::properties	(		$a_mode = "save",
			$a_form = null
	)

Edit page layout properties.

Parameters

string

$a_mode

edit mode

Definition at line 108 of file class.ilPageLayoutGUI.php.

References initForm().

Referenced by create(), and updateProperties().

        {
                global $ilTabs;
        
                $ilTabs->setTabActive('properties');
                
                if(!$a_form)
                {
                        $a_form = $this->initForm($a_mode);
                }
                
                $this->tpl->setContent($a_form->getHTML());
        }

Here is the call graph for this function:

Here is the caller graph for this function:

ilPageLayoutGUI::setTabs

(

)

output tabs

Definition at line 216 of file class.ilPageLayoutGUI.php.

References $ilCtrl, ilPageObjectGUI\$lng, ilPageObjectGUI\$tpl, and ilUtil\getImagePath().

        {
                global $ilTabs, $ilCtrl, $tpl, $lng;
                $ilCtrl->setParameterByClass("ilpagelayoutgui", "obj_id", $this->obj->id);
                $ilTabs->addTarget("properties",
                        $ilCtrl->getLinkTarget($this, "properties"), array("properties","", ""), "", "");
                $tpl->setTitleIcon(ilUtil::getImagePath("icon_pg_b.gif"));
                $tpl->setTitle($this->layout_object->getTitle());
                $tpl->setDescription("");
                //      $tpl->setTitle(
                //              $lng->txt("sahs_page").": ".$this->node_object->getTitle());
        }

Here is the call graph for this function:

ilPageLayoutGUI::updateProperties

(

)

Update properties.

Definition at line 192 of file class.ilPageLayoutGUI.php.

References ilPageObjectGUI\$lng, initForm(), properties(), and ilUtil\sendInfo().

        {
                global $lng;
                
                $form = $this->initForm("save");
                if(!$form->checkInput())
                {
                        $form->setValuesByPost();
                        return $this->properties("save", $form);
                }
                
                $this->layout_object->setTitle($form->getInput('pgl_title'));
                $this->layout_object->setDescription($form->getInput('pgl_desc'));
                $this->layout_object->setStyleId($form->getInput('style_id'));
                $this->layout_object->setModules($form->getInput('module'));
                $this->layout_object->update();
                
                ilUtil::sendInfo($lng->txt("saved_successfully"));
                $this->properties();
        }

Here is the call graph for this function:

Field Documentation

ilPageLayoutGUI::$layout_object = null

Constructor.

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

---

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

• Services/Style/classes/class.ilPageLayoutGUI.php