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. More...
	executeCommand ()
	execute command More...
	showPage ()
	confirmDelete ()
	confirmDelete More...
	cancelDelete ()
	cancelDelete More...
	deleteView ()
	postOutputProcessing ($a_output)
	Finalizing output processing. More...
Public Member Functions inherited from ilPageObjectGUI
	ilPageObjectGUI ($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...
	setBibId ($a_id)
	Set Bib Id. More...
	getBibId ()
	Get Bib Id. More...
	setPageObject ($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)
	getSourcecodeDownloadScript ()
	enableCitation ($a_enabled)
	isEnabledCitation ()
	setLocator (&$a_locator)
	setTabs ($a_tabs)
	setPageBackTitle ($a_title)
	setFileDownloadLink ($a_download_link)
	getFileDownloadLink ()
	setFullscreenLink ($a_fullscreen_link)
	getFullscreenLink ()
	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...
	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...
	activateMetaDataEditor ($a_rep_obj_id, $a_sub_obj_id, $a_type, $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 ()
	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...
	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...
	insertContentIncludes ($a_html)
	Insert content includes. 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...
	preview ()
	preview More...
	edit ()
	edit ("view" before) More...
	insertJSAtPlaceholder ()
	InsertJS at placeholder. 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...
	getQuestionJsOfPage ($a_no_interaction=false)
	Get question js. More...
	initSelfAssessmentRendering ($a_force_no_form=false)
	Init question handling. More...
	processAnswer ()
	Process answer. More...
	selfAssessmentRendering ($a_output)
	Self assessment question rendering. 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...

Protected Attributes
	$obj_id
	$table_id
Protected Attributes inherited from ilPageObjectGUI
	$parent_type = ""

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)
	Get Tiny Menu. More...
static	addPreparationJavascript ($a_tpl, $a_lang)
	Add standard texts. More...
static	getJSTextInitCode ($a_lang)
	Get js txt init code. More...
Data Fields inherited from ilPageObjectGUI
	$tpl
	$lng
	$ctrl
	$obj
	$output_mode
	$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
	$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 inherited from ilPageObjectGUI
	initPageObject ()
	Init page object. More...
	getActivationCaptions ()
	Get captions for activation action menu entries. More...

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

__construct()

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(), ilPageObjectGUI\getPageObject(), and ilObjStyleSheet\getSyntaxStylePath().

        {
                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();
                        $viewdef->setTableId($this->table_id);
                        $viewdef->create();
                        $a_definition_id = $viewdef->getId();
                }

        parent::__construct("dclf", $a_definition_id);
        $this->getPageObject()->setTableId($this->table_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();

        }

Here is the call graph for this function:

Member Function Documentation

cancelDelete()

ilDataCollectionRecordViewViewdefinitionGUI::cancelDelete

(

)

cancelDelete

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

References $ilCtrl.

        {
                global $ilCtrl;

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

confirmDelete()

ilDataCollectionRecordViewViewdefinitionGUI::confirmDelete

(

)

confirmDelete

Definition at line 126 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());
        }

deleteView()

ilDataCollectionRecordViewViewdefinitionGUI::deleteView

(

)

Definition at line 153 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);
                        include_once("./Modules/DataCollection/classes/class.ilDataCollectionRecordViewViewdefinition.php");
                        $pageObject = new ilDataCollectionRecordViewViewdefinition($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:

executeCommand()

ilDataCollectionRecordViewViewdefinitionGUI::executeCommand

(

)

execute command

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

References $cmd, $ilCtrl, ilPageObjectGUI\$lng, ilPageObjectGUI\$tpl, ilPageObjectGUI\getPageObject(), 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":
                                die("Deprecated. ilDataCollectionRecordViewViewdefinitionGUI gui forwarding to ilpageobject");
                                return;
                                
                        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:

postOutputProcessing()

ilDataCollectionRecordViewViewdefinitionGUI::postOutputProcessing

(

$a_output

)

Finalizing output processing.

Parameters

string

$a_output

Returns

string

Definition at line 178 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:

showPage()

ilDataCollectionRecordViewViewdefinitionGUI::showPage

(

)

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

References $ilCtrl, 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

$obj_id

ilDataCollectionRecordViewViewdefinitionGUI::$obj_id

protected

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

$table_id

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