Class ilDclDetailedViewDefinitionGUI. More...

Inheritance diagram for ilDclDetailedViewDefinitionGUI:

Collaboration diagram for ilDclDetailedViewDefinitionGUI:

Public Member Functions
	executeCommand ()
	execute command More...

	confirmDelete ()
	confirmDelete More...

	cancelDelete ()
	cancelDelete More...

	deleteView ()

	releasePageLock ()
	Release page lock overwrite to redirect properly. More...

	postOutputProcessing ($a_output)
	Finalizing output processing. 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...

	setPageObject (ilPageObject $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...

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

	getViewPageText ()
	get view page text 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...

	getDisabledText ()
	Get disabled text. 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...

	getProfileBackUrl ()
	Get profile back url. 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...

	initCaptchaForm ()
	Init captcha form. 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...

	getPagePermaLink ()
	Get page perma link. More...

Data Fields
	$obj

	$ctrl

Data Fields inherited from ilPageObjectGUI
	$obj

	$presentation_title

	$target_script

	$return_location

	$target_var

	$template_output_var

	$output2template

	$link_params

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

	deactivate ()

Protected Member Functions inherited from ilPageObjectGUI
	initPageObject ()
	Init page object. More...

	getActivationCaptions ()
	Get captions for activation action menu entries. More...

	isPageContainerToBeRendered ()

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
	$tpl

	$lng

	$ctrl

	$tabs_gui

	$access

	$plugin_admin

	$log

	$user

	$help

	$output_mode

	$parent_type = ""

Detailed Description

Class ilDclDetailedViewDefinitionGUI.

Author: Martin Studer ms@st.nosp@m.uder.nosp@m.-raim.nosp@m.ann..nosp@m.ch; Marcel Raimann mr@st.nosp@m.uder.nosp@m.-raim.nosp@m.ann..nosp@m.ch; Fabian Schmid fs@st.nosp@m.uder.nosp@m.-raim.nosp@m.ann..nosp@m.ch; Jörg Lützenkirchen luetz.nosp@m.enki.nosp@m.rchen.nosp@m.@lei.nosp@m.fos.c.nosp@m.om

ilDclDetailedViewDefinitionGUI: ilPageEditorGUI, ilEditClipboardGUI, ilMediaPoolTargetSelector ilDclDetailedViewDefinitionGUI: ilPublicUserProfileGUI, ilPageObjectGUI

Definition at line 16 of file class.ilDclDetailedViewDefinitionGUI.php.

Member Function Documentation

◆ activate()

ilDclDetailedViewDefinitionGUI::activate ( )

protected

Definition at line 136 of file class.ilDclDetailedViewDefinitionGUI.php.

References ilPageObjectGUI\getPageObject().

     {
         $page = $this->getPageObject();
         $page->setActive(true);
         $page->update();
         $this->ctrl->redirect($this, 'edit');
     }

Here is the call graph for this function:

◆ cancelDelete()

ilDclDetailedViewDefinitionGUI::cancelDelete ( )

cancelDelete

Definition at line 181 of file class.ilDclDetailedViewDefinitionGUI.php.

References $DIC, and $ilCtrl.

     {
         global $DIC;
         $ilCtrl = $DIC['ilCtrl'];
 
         $ilCtrl->redirect($this, "edit");
     }

◆ confirmDelete()

ilDclDetailedViewDefinitionGUI::confirmDelete ( )

confirmDelete

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

References $DIC, $ilCtrl, ilPageObjectGUI\$lng, and ilPageObjectGUI\$tpl.

     {
         global $DIC;
         $ilCtrl = $DIC['ilCtrl'];
         $lng = $DIC['lng'];
         $tpl = $DIC['tpl'];
 
         include_once './Services/Utilities/classes/class.ilConfirmationGUI.php';
         $conf = new ilConfirmationGUI();
         $conf->setFormAction($ilCtrl->getFormAction($this));
         $conf->setHeaderText($lng->txt('dcl_confirm_delete_detailed_view_title'));
 
         $conf->addItem('tableview', (int) $this->tableview_id, $lng->txt('dcl_confirm_delete_detailed_view_text'));
 
         $conf->setConfirm($lng->txt('delete'), 'deleteView');
         $conf->setCancel($lng->txt('cancel'), 'cancelDelete');
 
         $tpl->setContent($conf->getHTML());
     }

◆ deactivate()

ilDclDetailedViewDefinitionGUI::deactivate ( )

protected

Definition at line 145 of file class.ilDclDetailedViewDefinitionGUI.php.

References ilPageObjectGUI\getPageObject().

     {
         $page = $this->getPageObject();
         $page->setActive(false);
         $page->update();
         $this->ctrl->redirect($this, 'edit');
     }

Here is the call graph for this function:

◆ deleteView()

ilDclDetailedViewDefinitionGUI::deleteView ( )

Definition at line 190 of file class.ilDclDetailedViewDefinitionGUI.php.

References $DIC, $ilCtrl, ilPageObjectGUI\$lng, ilDclDetailedViewDefinition\exists(), and ilUtil\sendSuccess().

     {
         global $DIC;
         $ilCtrl = $DIC['ilCtrl'];
         $lng = $DIC['lng'];
 
         if ($this->tableview_id && ilDclDetailedViewDefinition::exists($this->tableview_id)) {
             include_once("class.ilDclDetailedViewDefinition.php");
             $pageObject = new ilDclDetailedViewDefinition($this->tableview_id);
             $pageObject->delete();
         }
 
         ilUtil::sendSuccess($lng->txt("dcl_empty_detailed_view_success"), true);
 
         // Bug fix for mantis 22537: Redirect to settings-tab instead of fields-tab. This solves the problem and is more intuitive.
         $ilCtrl->redirectByClass("ilDclTableViewEditGUI", "editGeneralSettings");
     }

Here is the call graph for this function:

◆ executeCommand()

ilDclDetailedViewDefinitionGUI::executeCommand ( )

execute command

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

References $DIC, $legend, ilPageObjectGUI\$lng, $title, ilLinkButton\getInstance(), ilPageObjectGUI\getOutputMode(), ilPageObjectGUI\getPageObject(), IL_PAGE_EDIT, ilPageObjectGUI\setPrependingHtml(), ilPageObjectGUI\setPresentationTitle(), and ilPageObjectGUI\showPage().

     {
         global $DIC;
         $ilLocator = $DIC['ilLocator'];
         $lng = $DIC['lng'];
 
         $next_class = $this->ctrl->getNextClass($this);
 
         $viewdef = $this->getPageObject();
         if ($viewdef) {
             $this->ctrl->setParameter($this, "dclv", $viewdef->getId());
             $title = $lng->txt("dcl_view_viewdefinition");
         }
 
         switch ($next_class) {
             case "ilpageobjectgui":
                 throw new ilCOPageException("Deprecated. ilDclDetailedViewDefinitionGUI gui forwarding to ilpageobject");
             default:
                 if ($viewdef) {
                     $this->setPresentationTitle($title);
                     $ilLocator->addItem($title, $this->ctrl->getLinkTarget($this, "preview"));
                 }
 
                 return parent::executeCommand();
         }
     }

Here is the call graph for this function:

◆ postOutputProcessing()

ilDclDetailedViewDefinitionGUI::postOutputProcessing ( $a_output )

Finalizing output processing.

Parameters

string $a_output

Returns: string

Definition at line 230 of file class.ilDclDetailedViewDefinitionGUI.php.

References ilPageObjectGUI\getOutputMode(), ilPageObjectGUI\getPageObject(), IL_PAGE_EDIT, and IL_PAGE_PREVIEW.

     {
         // You can use this to parse placeholders and the like before outputting
 
         // user view (IL_PAGE_PRESENTATION?)
         if ($this->getOutputMode() == IL_PAGE_PREVIEW) {
             //page preview is not being used inside DataCollections - if you are here, something's probably wrong
 
 //                      include_once "Services/Form/classes/class.ilPropertyFormGUI.php";
 //
 //                      // :TODO: find a suitable presentation for matched placeholders
 //                      $allp = ilDataCollectionRecordViewViewdefinition::getAvailablePlaceholders($this->table_id, true);
 //                      foreach ($allp as $id => $item) {
 //                              $parsed_item = new ilTextInputGUI("", "fields[" . $item->getId() . "]");
 //                              $parsed_item = $parsed_item->getToolbarHTML();
 //
 //                              $a_output = str_replace($id, $item->getTitle() . ": " . $parsed_item, $a_output);
 //                      }
         } // editor
         else {
             if ($this->getOutputMode() == IL_PAGE_EDIT) {
                 $allp = $this->getPageObject()->getAvailablePlaceholders();
 
                 // :TODO: find a suitable markup for matched placeholders
                 foreach ($allp as $item) {
                     $a_output = str_replace($item, "<span style=\"color:green\">" . $item . "</span>", $a_output);
                 }
             }
         }
 
         return $a_output;
     }

Here is the call graph for this function:

◆ releasePageLock()

ilDclDetailedViewDefinitionGUI::releasePageLock ( )

Release page lock overwrite to redirect properly.

Definition at line 212 of file class.ilDclDetailedViewDefinitionGUI.php.

References $DIC, $ilCtrl, ilPageObjectGUI\$lng, ilPageObjectGUI\getPageObject(), and ilUtil\sendSuccess().

     {
         global $DIC;
         $ilCtrl = $DIC['ilCtrl'];
         $lng = $DIC['lng'];
 
         $this->getPageObject()->releasePageLock();
         ilUtil::sendSuccess($lng->txt("cont_page_lock_released"), true);
         $ilCtrl->redirectByClass('ilDclTableViewGUI', "show");
     }

Here is the call graph for this function:

Field Documentation

◆ $ctrl

ilDclDetailedViewDefinitionGUI::$ctrl

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

◆ $obj

ilDclDetailedViewDefinitionGUI::$obj

Definition at line 22 of file class.ilDclDetailedViewDefinitionGUI.php.

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

Modules/DataCollection/classes/DetailedView/class.ilDclDetailedViewDefinitionGUI.php

Public Member Functions

Data Fields

Protected Member Functions

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ activate()

◆ cancelDelete()

◆ confirmDelete()

◆ deactivate()

◆ deleteView()

◆ executeCommand()

◆ postOutputProcessing()

◆ releasePageLock()

Field Documentation

◆ $ctrl

◆ $obj