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")
	updateProperties ()
	setTabs ()
	output tabs
Public Member Functions inherited from ilPageObjectGUI
	ilPageObjectGUI ($a_parent_type, $a_id=0, $a_old_nr=0)
	Constructor public.
	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 ()
	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 ()
	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.
	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.
	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)
	Set Enable Self Assessment Questions.
	getEnabledSelfAssessment ()
	Get Enable Self Assessment Questions.
	setCompareMode ($a_val)
	Set compare mode.
	getCompareMode ()
	Get compare mode.
	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 ()
	setDefaultLinkXml ()
	Set standard link xml.
	downloadFile ()
	Download file of file lists.
	displayMediaFullscreen ()
	Show media in fullscreen mode.
	download_paragraph ()
	download source code paragraph
	insertMaps ($a_html)
	Insert Maps.
	insertContentIncludes ($a_html)
	Insert Maps.
	postOutputProcessing ($a_output)
	Finalizing output processing.
	insertHelp ($a_tpl)
	Insert help texts.
	preview ()
	edit ()
	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_mode="")
	Get notes HTML.

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 = true
	$editpreview = false
	$use_meta_data = false
	$enabledtabs = true
	$enabledpctabs = false
	$link_xml_set = false
	$enableediting = true
	$rawpagecontent = false
	$layoutmode = false
	$enabledcontentincludes = false
	$compare_mode = false

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 37 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 46 of file class.ilPageLayoutGUI.php.

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

        {
                global $tpl,$ilCtrl;
        
                parent::__construct($a_parent_type, $a_id, $a_old_nr);
                
                // content style
                include_once("./Services/Style/classes/class.ilObjStyleSheet.php");
                $tpl->setCurrentBlock("ContentStyle");
                $tpl->setVariable("LOCATION_CONTENT_STYLESHEET",
                        ilObjStyleSheet::getContentStylePath(0));
                $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);
                
                //set For GUI and associated object
                $this->setLayoutMode(true);
                $this->obj->setLayoutMode(true);
                
                //associated object
                include_once("./Services/Style/classes/class.ilPageLayout.php");
                                
                $this->layout_object = new ilPageLayout($a_id);
                $this->layout_object->readObject();
                $this->slm_id = $a_slm_id;
                
        }

Here is the call graph for this function:

Member Function Documentation

ilPageLayoutGUI::create

(

)

Definition at line 115 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 90 of file class.ilPageLayoutGUI.php.

References $cmd, $ilCtrl, ilPageObjectGUI\getPageObject(), 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":
                                $page_gui = new ilPageObjectGUI("sahs",
                                        $this->getPageObject()->getId(), $this->getPageObject()->old_nr);
                                $html = $ilCtrl->forwardCommand($page_gui);
                                return $html;
                                
                        default:
                                $html = parent::executeCommand();
                                return $html;
                }
        }

Here is the call graph for this function:

ilPageLayoutGUI::properties

(

$a_mode = "save"

)

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

References $ilCtrl, ilPageObjectGUI\$lng, ilTextInputGUI\setSize(), and ilTextAreaInputGUI\setValue().

Referenced by create(), and updateProperties().

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

                include_once("Services/Form/classes/class.ilRadioMatrixInputGUI.php");
        
                
                $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);

                $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);
                                
                $this->form_gui->addItem($title_input);
                $this->form_gui->addItem($desc_input);
                
                $this->form_gui->addCommandButton("updateProperties", $lng->txt($a_mode));
                $this->tpl->setContent($this->form_gui->getHTML());
        }

Here is the call graph for this function:

Here is the caller graph for this function:

ilPageLayoutGUI::setTabs

(

)

output tabs

Definition at line 174 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

(

)

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

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

        {
                global $lng;
                if($_POST["pgl_title"] == "")
                {
                        $this->ilias->raiseError($this->lng->txt("no_title"),$this->ilias->error_obj->MESSAGE);
                        $this->properties();
                        exit;
                }
                $this->layout_object->setTitle($_POST['pgl_title']);
                $this->layout_object->setDescription($_POST['pgl_desc']);
                $this->layout_object->update();
                ilUtil::sendInfo($lng->txt("saved_successfully"),false);
                $this->properties();
        }

Here is the call graph for this function:

Field Documentation

ilPageLayoutGUI::$layout_object = null

Constructor.

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

---

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

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