Class ilPageLayoutGUI GUI class. More...

Inheritance diagram for ilPageLayoutGUI:

Collaboration diagram for ilPageLayoutGUI:

Public Member Functions
	__construct (string $a_parent_type, int $a_id=0, int $a_old_nr=0, bool $a_prevent_get_id=false, string $a_lang="")

	executeCommand ()

	create ()

	properties (string $a_mode="save", ilPropertyFormGUI $a_form=null)
	Edit page layout properties. More...

	initForm (string $a_mode)

	updateProperties ()

	setTabs (ilTabsGUI $a_tabs=null)
	output tabs More...

	finishEditing ()

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)

	enableChangeComments (bool $a_enabled)

	isEnabledChangeComments ()

	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 Attributes
ilTabsGUI	$tabs

ilSetting	$settings

ilPageLayout	$layout_object = null

Protected Attributes inherited from ilPageObjectGUI
ILIAS TestQuestionPool QuestionInfoService	$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

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	$change_comments = false

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 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...

Detailed Description

Class ilPageLayoutGUI GUI class.

Author: Hendrik Holtmann holtm.nosp@m.ann@.nosp@m.me.co.nosp@m.m ilPageLayoutGUI: ilPageEditorGUI, ilEditClipboardGUI ilPageLayoutGUI: ilPublicUserProfileGUI, ilPageObjectGUI

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

Constructor & Destructor Documentation

◆ __construct()

ilPageLayoutGUI::__construct	(	string	$a_parent_type,
		int	$a_id = `0`,
		int	$a_old_nr = `0`,
		bool	$a_prevent_get_id = `false`,
		string	$a_lang = `""`
	)

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

References $DIC, ilPageObjectGUI\$tpl, ILIAS\MetaData\Repository\Validation\Data\__construct(), ilGlobalTemplateInterface\addCss(), ILIAS\Repository\ctrl(), ilObjStyleSheet\getContentStylePath(), ilObjStyleSheet\getSyntaxStylePath(), ILIAS\Repository\lng(), ilGlobalTemplateInterface\parseCurrentBlock(), ilGlobalTemplateInterface\setCurrentBlock(), ILIAS\Repository\settings(), ilGlobalTemplateInterface\setVariable(), and ILIAS\Repository\tabs().

       {
         global $DIC;
 
         $this->tpl = $DIC["tpl"];
         $this->ctrl = $DIC->ctrl();
         $this->tabs = $DIC->tabs();
         $this->lng = $DIC->language();
         $this->settings = $DIC->settings();
         $tpl = $DIC["tpl"];
 
         parent::__construct($a_parent_type, $a_id, $a_old_nr, $a_prevent_get_id, $a_lang);
 
         //associated object
         $this->layout_object = new ilPageLayout($a_id);
         $this->layout_object->readObject();
 
         // content style
         $tpl->setCurrentBlock("ContentStyle");
         $tpl->setVariable(
             "LOCATION_CONTENT_STYLESHEET",
             ilObjStyleSheet::getContentStylePath(0)
         );
         $tpl->parseCurrentBlock();
 
         $tpl->addCss(ilObjStyleSheet::getSyntaxStylePath());
 
         //        $this->setStyleId($this->layout_object->getStyleId());
     }

Here is the call graph for this function:

Member Function Documentation

◆ create()

ilPageLayoutGUI::create ( )

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

References properties().

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

Here is the call graph for this function:

◆ executeCommand()

ilPageLayoutGUI::executeCommand ( )

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

References ILIAS\Repository\ctrl().

                                     : string
     {
         $next_class = $this->ctrl->getNextClass($this);
 
         switch ($next_class) {
             case 'ilmdeditorgui':
                 return parent::executeCommand();
 
             default:
                 $html = parent::executeCommand();
                 return $html;
         }
     }

Here is the call graph for this function:

◆ finishEditing()

ilPageLayoutGUI::finishEditing ( )

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

References ILIAS\Repository\ctrl().

                                    : void
     {
         $this->ctrl->redirectByClass("ilpagelayoutadministrationgui", "listLayouts");
     }

Here is the call graph for this function:

◆ initForm()

ilPageLayoutGUI::initForm ( string $a_mode )

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

References ilPageObjectGUI\$ctrl, $ilSetting, ilPageObjectGUI\$lng, $settings, ilPageLayout\getAvailableModules(), ILIAS\Repository\lng(), ilCheckboxGroupInputGUI\setValue(), ilTextAreaInputGUI\setValue(), and ilLanguage\txt().

Referenced by properties(), and updateProperties().

                                             : ilPropertyFormGUI
     {
         $ilCtrl = $this->ctrl;
         $lng = $this->lng;
         $ilSetting = $this->settings;
 
         $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("copg_obj_types"), "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);
 
         $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:

◆ properties()

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

Edit page layout properties.

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

References $tabs, initForm(), and ilTabsGUI\setTabActive().

Referenced by create(), and updateProperties().

      : void {
         $ilTabs = $this->tabs;
 
         $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:

◆ setTabs()

ilPageLayoutGUI::setTabs ( ilTabsGUI $a_tabs = null )

output tabs

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

References ilPageObjectGUI\$ctrl, $DIC, Vendor\Package\$f, ilPageObjectGUI\$lng, $tabs, ilPageObjectGUI\$tpl, ilPageObjectGUI\$ui, ilPageLayout\activeLayouts(), ilUtil\getImagePath(), ILIAS\Repository\lng(), ilGlobalTemplateInterface\setDescription(), ilGlobalTemplateInterface\setTitle(), ilGlobalTemplateInterface\setTitleIcon(), and ilLanguage\txt().

Referenced by ilPageLayoutAdministrationGUI\executeCommand().

                                                      : void
     {
         $ilTabs = $this->tabs;
         $ilCtrl = $this->ctrl;
         $tpl = $this->tpl;
 
         $ilCtrl->setParameterByClass("ilpagelayoutgui", "obj_id", $this->obj->getId());
         $ilTabs->addTab(
             "properties",
             $this->lng->txt("settings"),
             $ilCtrl->getLinkTarget($this, "properties")
         );
         $tpl->setTitleIcon(ilUtil::getImagePath("standard/icon_pg.svg"));
         $tpl->setTitle($this->layout_object->getTitle());
         $tpl->setDescription("");
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ updateProperties()

ilPageLayoutGUI::updateProperties ( )

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

References ilPageObjectGUI\$form, ilPageObjectGUI\$lng, ilPropertyFormGUI\checkInput(), ilPropertyFormGUI\getInput(), initForm(), properties(), ilPropertyFormGUI\setValuesByPost(), and ilLanguage\txt().

                                       : void
     {
         $lng = $this->lng;
 
         $form = $this->initForm("save");
         if (!$form->checkInput()) {
             $form->setValuesByPost();
             $this->properties("save", $form);
             return;
         }
 
         $this->layout_object->setTitle($form->getInput('pgl_title'));
         $this->layout_object->setDescription($form->getInput('pgl_desc'));
         $this->layout_object->setModules($form->getInput('module'));
         $this->layout_object->update();
 
         $this->tpl->setOnScreenMessage('info', $lng->txt("saved_successfully"));
         $this->properties();
     }

Here is the call graph for this function:

Field Documentation

◆ $layout_object

ilPageLayout ilPageLayoutGUI::$layout_object = null

protected

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

◆ $settings

ilSetting ilPageLayoutGUI::$settings

protected

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

Referenced by initForm().

◆ $tabs

ilTabsGUI ilPageLayoutGUI::$tabs

protected

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

Referenced by properties(), and setTabs().

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

Services/COPage/Layout/classes/class.ilPageLayoutGUI.php

Public Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ create()

◆ executeCommand()

◆ finishEditing()

◆ initForm()

◆ properties()

◆ setTabs()

◆ updateProperties()

Field Documentation

◆ $layout_object

◆ $settings

◆ $tabs