ilDataCollectionRecordViewViewdefinitionGUI Class Reference

Class ilDataCollectionRecordViewViewdefinitionGUI. More...

Inheritance diagram for ilDataCollectionRecordViewViewdefinitionGUI:

Collaboration diagram for ilDataCollectionRecordViewViewdefinitionGUI:

Public Member Functions
	__construct ($table_id, $a_definition_id=0)
	Constructor.
	initPageObject ($a_parent_type, $a_id, $a_old_nr)
	Init internal data object.
	executeCommand ()
	execute command
	showPage ()
	confirmDelete ()
	confirmDelete
	cancelDelete ()
	cancelDelete
	deleteView ()
	postOutputProcessing ($a_output)
	Finalizing output processing.
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.
	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 ()
	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 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.
	preview ()
	edit ()
	edit ("view" before)
	insertJSAtPlaceholder ()
	InsertJS at placeholder.
	initCaptchaForm ()
	Init captcha form.
	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.
	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.
	initialOpenedContent ()
	Initially opened content.
	initOpenedContentForm ()
	Init form for initially opened content.
	saveInitialOpenedContent ()
	Save initial opened content.

Protected Attributes
	$obj_id
	$table_id

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.
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
Protected Member Functions inherited from ilPageObjectGUI
	getActivationCaptions ()
	Get captions for activation action menu entries.

Detailed Description

Class ilDataCollectionRecordViewViewdefinitionGUI.

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

ilDataCollectionRecordViewViewdefinitionGUI: ilPageEditorGUI, ilEditClipboardGUI, ilMediaPoolTargetSelector ilDataCollectionRecordViewViewdefinitionGUI: ilPublicUserProfileGUI, ilPageObjectGUI

Definition at line 18 of file class.ilDataCollectionRecordViewViewdefinitionGUI.php.

Constructor & Destructor Documentation

ilDataCollectionRecordViewViewdefinitionGUI::__construct	(		$table_id,
			$a_definition_id = 0
	)

Constructor.

Parameters

object	$a_parent_obj
int	$table_id
int	$a_definition_id

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

References $table_id, ilPageObjectGUI\$tpl, ilObjStyleSheet\getContentStylePath(), ilDataCollectionRecordViewViewdefinition\getIdByTableId(), ilObjStyleSheet\getSyntaxStylePath(), ilPageObjectGUI\setEnabledActivation(), ilPageObjectGUI\setEnabledInternalLinks(), ilPageObjectGUI\setEnabledMaps(), ilPageObjectGUI\setEnabledPCTabs(), ilPageObjectGUI\setEnabledWikiLinks(), and ilPageObjectGUI\setPreventHTMLUnmasking().

        {
                global $tpl;
                
                //TODO Permission-Check
                $this->table_id = $table_id;
                        
                if(!$a_definition_id)
                {
                        $a_definition_id = ilDataCollectionRecordViewViewdefinition::getIdByTableId($this->table_id);
                }

                // we always need a page object - create on demand
                if(!$a_definition_id)
                {


                        $viewdef = new ilDataCollectionRecordViewViewdefinition(0, $this->table_id);
                        $viewdef->create();
                        $a_definition_id = $viewdef->getId();

                }

        parent::__construct("dclf", $a_definition_id);

        // content style (using system defaults)
                include_once("./Services/Style/classes/class.ilObjStyleSheet.php");

                $tpl->setCurrentBlock("SyntaxStyle");
                $tpl->setVariable("LOCATION_SYNTAX_STYLESHEET",
                        ilObjStyleSheet::getSyntaxStylePath());
                $tpl->parseCurrentBlock();
                
                $tpl->setCurrentBlock("ContentStyle");
                $tpl->setVariable("LOCATION_CONTENT_STYLESHEET",
                        ilObjStyleSheet::getContentStylePath(0));
                $tpl->parseCurrentBlock();

        // config
                $this->setPreventHTMLUnmasking(true);
                $this->setEnabledPCTabs(true);
                $this->setEnabledMaps(false);
                $this->setEnabledInternalLinks(false);
                $this->setEnabledWikiLinks(false);                                              
                $this->setEnabledActivation(false);
        }

Here is the call graph for this function:

Member Function Documentation

ilDataCollectionRecordViewViewdefinitionGUI::cancelDelete

(

)

cancelDelete

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

References $ilCtrl.

        {
                global $ilCtrl;

                $ilCtrl->redirect($this, "edit");
        }

ilDataCollectionRecordViewViewdefinitionGUI::confirmDelete

(

)

confirmDelete

Definition at line 151 of file class.ilDataCollectionRecordViewViewdefinitionGUI.php.

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

        {
                global $ilCtrl, $lng, $tpl;

                include_once './Services/Utilities/classes/class.ilConfirmationGUI.php';
                $conf = new ilConfirmationGUI();
                $conf->setFormAction($ilCtrl->getFormAction($this));
                $conf->setHeaderText($lng->txt('dcl_confirm_delete_view_title'));

                $conf->addItem('table', (int) $this->table_id, $lng->txt('dcl_confirm_delete_view_text'));

                $conf->setConfirm($lng->txt('delete'), 'deleteView');
                $conf->setCancel($lng->txt('cancel'), 'cancelDelete');

                $tpl->setContent($conf->getHTML());
        }

ilDataCollectionRecordViewViewdefinitionGUI::deleteView

(

)

Definition at line 178 of file class.ilDataCollectionRecordViewViewdefinitionGUI.php.

References $ilCtrl, ilPageObjectGUI\$lng, $query, ilDataCollectionRecordViewViewdefinition\getIdByTableId(), and ilUtil\sendSuccess().

                                    {
                global $ilCtrl, $lng;

                if($this->table_id && ilDataCollectionRecordViewViewdefinition::getIdByTableId($this->table_id)){
                        global $ilDB;
                        $id = ilDataCollectionRecordViewViewdefinition::getIdByTableId($this->table_id);
                        $pageObject = new ilPageObject("dclf", $id);
                        $pageObject->delete();

                        $query = "DELETE FROM il_dcl_view WHERE table_id = ".$this->table_id." AND type = ".$ilDB->quote(0, "integer")." AND formtype = ".$ilDB->quote(0, "integer");
                        $ilDB->manipulate($query);
                }

                ilUtil::sendSuccess($lng->txt("dcl_empty_view_success"), true);

                $ilCtrl->redirectByClass("ilDataCollectionFieldListGUI", "listFields");
        }

Here is the call graph for this function:

ilDataCollectionRecordViewViewdefinitionGUI::executeCommand

(

)

execute command

Reimplemented from ilPageObjectGUI.

Definition at line 92 of file class.ilDataCollectionRecordViewViewdefinitionGUI.php.

References $cmd, $ilCtrl, ilPageObjectGUI\$lng, $title, ilPageObjectGUI\$tpl, ilPageObjectGUI\getPageObject(), ilPageObjectGUI\ilPageObjectGUI(), and ilPageObjectGUI\setPresentationTitle().

        {
                global $ilCtrl, $ilLocator, $tpl, $lng;
                
                $next_class = $ilCtrl->getNextClass($this);
                $cmd = $ilCtrl->getCmd();

                $viewdef = $this->getPageObject();              
                if($viewdef)
                {
                        $ilCtrl->setParameter($this, "dclv", $viewdef->getId());                                 
                        $title = $lng->txt("dcl_view_viewdefinition");
                }
                
                switch($next_class)
                {                       
                        case "ilpageobjectgui":
                                $page_gui = new ilPageObjectGUI("dclf",
                                        $this->getPageObject()->getId(),
                                        $this->getPageObject()->old_nr);
                                if($viewdef)
                                {
                                        $this->setPresentationTitle($title);
                                }
                                return $ilCtrl->forwardCommand($page_gui);
                                
                        default:
                                if($viewdef)
                                {                                       
                                        $this->setPresentationTitle($title);                                    
                                        // $tpl->setTitle($title);
                                        
                                        $ilLocator->addItem($title,
                                                $ilCtrl->getLinkTarget($this, "preview"));                                                      
                                }
                                return parent::executeCommand();
                }
        }

Here is the call graph for this function:

ilDataCollectionRecordViewViewdefinitionGUI::initPageObject	(		$a_parent_type,
			$a_id,
			$a_old_nr
	)

Init internal data object.

Parameters

string	$a_parent_type
int	$a_id
int	$a_old_nr

Reimplemented from ilPageObjectGUI.

Definition at line 84 of file class.ilDataCollectionRecordViewViewdefinitionGUI.php.

References ilPageObjectGUI\setPageObject().

        {
                $this->setPageObject(new ilDataCollectionRecordViewViewdefinition($a_id, $this->table_id));
        }

Here is the call graph for this function:

ilDataCollectionRecordViewViewdefinitionGUI::postOutputProcessing

(

$a_output

)

Finalizing output processing.

Parameters

string

$a_output

Returns

string

Reimplemented from ilPageObjectGUI.

Definition at line 202 of file class.ilDataCollectionRecordViewViewdefinitionGUI.php.

References ilDataCollectionRecordViewViewdefinition\getAvailablePlaceholders(), ilPageObjectGUI\getOutputMode(), 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)
                {                                               
                        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 = ilDataCollectionRecordViewViewdefinition::getAvailablePlaceholders($this->table_id);                    
                        
                        // :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:

ilDataCollectionRecordViewViewdefinitionGUI::showPage

(

)

Reimplemented from ilPageObjectGUI.

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

References $ilCtrl, $legend, ilPageObjectGUI\$lng, ilDataCollectionRecordViewViewdefinition\getAvailablePlaceholders(), ilPageObjectGUI\getOutputMode(), IL_PAGE_EDIT, and ilPageObjectGUI\setPrependingHtml().

        {
                global $ilCtrl, $lng;
                // :TODO: temporary legend of available placeholders
                if($this->getOutputMode() == IL_PAGE_EDIT)
                {
                        $legend = ilDataCollectionRecordViewViewdefinition::getAvailablePlaceholders($this->table_id);          
                        if(sizeof($legend))
                        {
                                $this->setPrependingHtml(" <form action=".$ilCtrl->getFormAction($this, "confirmDelete")." method='post'> <input class='submit' type='submit' value='".$lng->txt("dcl_empty_view")."'></form> <span class=\"small\">".$this->lng->txt("dcl_legend_placeholders").
                                        ": ".implode(" ", $legend)."</span>");
                        }
                }
                
                return parent::showPage();
        }

Here is the call graph for this function:

Field Documentation

ilDataCollectionRecordViewViewdefinitionGUI::$obj_id

protected

Definition at line 20 of file class.ilDataCollectionRecordViewViewdefinitionGUI.php.

ilDataCollectionRecordViewViewdefinitionGUI::$table_id

protected

Definition at line 21 of file class.ilDataCollectionRecordViewViewdefinitionGUI.php.

Referenced by __construct().

---

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

• Modules/DataCollection/classes/class.ilDataCollectionRecordViewViewdefinitionGUI.php