ILIAS  release_8 Revision v8.23
ilDclCreateViewDefinitionGUI Class Reference

This file is part of ILIAS, a powerful learning management system published by ILIAS open source e-Learning e.V. More...

+ Inheritance diagram for ilDclCreateViewDefinitionGUI:
+ Collaboration diagram for ilDclCreateViewDefinitionGUI:

Public Member Functions

 __construct (int $tableview_id)
 
 executeCommand ()
 
 confirmDelete ()
 
 cancelDelete ()
 
 deleteView ()
 
 postOutputProcessing (string $a_output)
 Finalizing output processing. More...
 
- 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 ()
 
 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...
 

Data Fields

ilDclTableView $tableview
 
- 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

 activate ()
 
 deactivate ()
 
- 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 ()
 
 isPageContainerToBeRendered ()
 
 addResourcesToTemplate (ilGlobalTemplateInterface $tpl)
 Add resources to template. More...
 

Protected Attributes

ilDclCreateViewTableGUI $table_gui
 
ilCtrl $ctrl
 
int $tableview_id
 
ILIAS HTTP Services $http
 
ILIAS Refinery Factory $refinery
 
- Protected Attributes inherited from ilPageObjectGUI
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
 

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

Detailed Description

This file is part of ILIAS, a powerful learning management system published by ILIAS open source e-Learning e.V.

ILIAS is licensed with the GPL-3.0, see https://www.gnu.org/licenses/gpl-3.0.en.html You should have received a copy of said license along with the source code, too.

If this is not the case or you just want to try ILIAS, you'll find us at: https://www.ilias.de https://github.com/ILIAS-eLearning ilDclCreateViewDefinitionGUI: ilPageEditorGUI, ilEditClipboardGUI, ilMediaPoolTargetSelector ilDclCreateViewDefinitionGUI: ilPublicUserProfileGUI, ilPageObjectGUI

Definition at line 23 of file class.ilDclCreateViewDefinitionGUI.php.

Constructor & Destructor Documentation

◆ __construct()

ilDclCreateViewDefinitionGUI::__construct ( int  $tableview_id)

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

References $DIC, $ref_id, $tableview_id, ILIAS\GlobalScreen\Provider\__construct(), ilPageObject\_exists(), ilObject\_lookupObjectId(), ILIAS\Repository\ctrl(), ilDclTableView\findOrGetInstance(), ILIAS\FileDelivery\http(), and ILIAS\Repository\refinery().

33  {
34  global $DIC;
35  $this->ctrl = $DIC['ilCtrl'];
36  $this->tableview_id = $tableview_id;
37  $this->http = $DIC->http();
38  $this->refinery = $DIC->refinery();
39 
41 
42  // we always need a page object - create on demand
43  if (!ilPageObject::_exists('dclf', $tableview_id)) {
44  $ref_id = $this->http->wrapper()->query()->retrieve('ref_id', $this->refinery->kindlyTo()->int());
45 
46  $viewdef = new ilDclCreateViewDefinition();
47  $viewdef->setId($tableview_id);
48  $viewdef->setParentId(ilObject2::_lookupObjectId($ref_id));
49  $viewdef->setActive(false);
50  $viewdef->create();
51  }
52 
54 
55  $table = new ilDclCreateViewTableGUI($this);
56  $this->table_gui = $table;
57  $this->tpl->setContent($table->getHTML());
58  }
This file is part of ILIAS, a powerful learning management system published by ILIAS open source e-Le...
global $DIC
Definition: feed.php:28
static findOrGetInstance($primary_key, array $add_constructor_args=array())
$ref_id
Definition: ltiauth.php:67
static http()
Fetches the global http state from ILIAS.
static _exists(string $a_parent_type, int $a_id, string $a_lang="", bool $a_no_cache=false)
Checks whether page exists.
This file is part of ILIAS, a powerful learning management system published by ILIAS open source e-Le...
static _lookupObjectId(int $ref_id)
__construct(Container $dic, ilPlugin $plugin)
+ Here is the call graph for this function:

Member Function Documentation

◆ activate()

ilDclCreateViewDefinitionGUI::activate ( )
protected

Definition at line 87 of file class.ilDclCreateViewDefinitionGUI.php.

References ILIAS\Repository\ctrl(), and ilPageObjectGUI\getPageObject().

87  : void
88  {
89  $page = $this->getPageObject();
90  $page->setActive(true);
91  $page->update();
92  $this->ctrl->redirect($this, 'edit');
93  }
+ Here is the call graph for this function:

◆ cancelDelete()

ilDclCreateViewDefinitionGUI::cancelDelete ( )

Definition at line 122 of file class.ilDclCreateViewDefinitionGUI.php.

References $DIC.

122  : void
123  {
124  global $DIC;
125  $ilCtrl = $DIC['ilCtrl'];
126 
127  $ilCtrl->redirect($this, "edit");
128  }
global $DIC
Definition: feed.php:28

◆ confirmDelete()

ilDclCreateViewDefinitionGUI::confirmDelete ( )

Definition at line 103 of file class.ilDclCreateViewDefinitionGUI.php.

References $DIC, ilPageObjectGUI\$lng, ilPageObjectGUI\$tpl, ilGlobalTemplateInterface\setContent(), and ilLanguage\txt().

103  : void
104  {
105  global $DIC;
106  $ilCtrl = $DIC['ilCtrl'];
107  $lng = $DIC['lng'];
108  $tpl = $DIC['tpl'];
109 
110  $conf = new ilConfirmationGUI();
111  $conf->setFormAction($ilCtrl->getFormAction($this));
112  $conf->setHeaderText($lng->txt('dcl_confirm_delete_detailed_view_title'));
113 
114  $conf->addItem('tableview', $this->tableview_id, $lng->txt('dcl_confirm_delete_detailed_view_text'));
115 
116  $conf->setConfirm($lng->txt('delete'), 'deleteView');
117  $conf->setCancel($lng->txt('cancel'), 'cancelDelete');
118 
119  $tpl->setContent($conf->getHTML());
120  }
txt(string $a_topic, string $a_default_lang_fallback_mod="")
gets the text for a given topic if the topic is not in the list, the topic itself with "-" will be re...
global $DIC
Definition: feed.php:28
setContent(string $a_html)
Sets content for standard template.
ilGlobalTemplateInterface $tpl
This file is part of ILIAS, a powerful learning management system published by ILIAS open source e-Le...
+ Here is the call graph for this function:

◆ deactivate()

ilDclCreateViewDefinitionGUI::deactivate ( )
protected

Definition at line 95 of file class.ilDclCreateViewDefinitionGUI.php.

References ILIAS\Repository\ctrl(), and ilPageObjectGUI\getPageObject().

95  : void
96  {
97  $page = $this->getPageObject();
98  $page->setActive(false);
99  $page->update();
100  $this->ctrl->redirect($this, 'edit');
101  }
+ Here is the call graph for this function:

◆ deleteView()

ilDclCreateViewDefinitionGUI::deleteView ( )

Definition at line 130 of file class.ilDclCreateViewDefinitionGUI.php.

References $DIC, ilPageObjectGUI\$lng, ilDclDetailedViewDefinition\exists(), and ilLanguage\txt().

130  : void
131  {
132  global $DIC;
133  $ilCtrl = $DIC['ilCtrl'];
134  $lng = $DIC['lng'];
135 
136  if ($this->tableview_id && ilDclDetailedViewDefinition::exists($this->tableview_id)) {
137  $pageObject = new ilDclDetailedViewDefinition($this->tableview_id);
138  $pageObject->delete();
139  }
140 
141  $this->tpl->setOnScreenMessage('success', $lng->txt("dcl_empty_detailed_view_success"), true);
142 
143  // Bug fix for mantis 22537: Redirect to settings-tab instead of fields-tab. This solves the problem and is more intuitive.
144  $ilCtrl->redirectByClass("ilDclTableViewEditGUI", "editGeneralSettings");
145  }
txt(string $a_topic, string $a_default_lang_fallback_mod="")
gets the text for a given topic if the topic is not in the list, the topic itself with "-" will be re...
global $DIC
Definition: feed.php:28
This file is part of ILIAS, a powerful learning management system published by ILIAS open source e-Le...
+ Here is the call graph for this function:

◆ executeCommand()

ilDclCreateViewDefinitionGUI::executeCommand ( )

Definition at line 60 of file class.ilDclCreateViewDefinitionGUI.php.

References $DIC, ilPageObjectGUI\$lng, ILIAS\Repository\ctrl(), ilPageObjectGUI\getPageObject(), ilPageObjectGUI\setPresentationTitle(), and ilLanguage\txt().

60  : string
61  {
62  global $DIC;
63  $ilLocator = $DIC['ilLocator'];
64  $lng = $DIC['lng'];
65 
66  $next_class = $this->ctrl->getNextClass($this);
67 
68  $viewdef = $this->getPageObject();
69  if ($viewdef) {
70  $this->ctrl->setParameter($this, "dclv", $viewdef->getId());
71  $title = $lng->txt("dcl_view_viewdefinition");
72  }
73 
74  switch ($next_class) {
75  case "ilpageobjectgui":
76  throw new ilCOPageException("Deprecated. ilDclDetailedViewDefinitionGUI gui forwarding to ilpageobject");
77  default:
78  if ($viewdef) {
79  $this->setPresentationTitle($title);
80  $ilLocator->addItem($title, $this->ctrl->getLinkTarget($this, "preview"));
81  }
82 
83  return parent::executeCommand();
84  }
85  }
txt(string $a_topic, string $a_default_lang_fallback_mod="")
gets the text for a given topic if the topic is not in the list, the topic itself with "-" will be re...
global $DIC
Definition: feed.php:28
setPresentationTitle(string $a_title="")
This file is part of ILIAS, a powerful learning management system published by ILIAS open source e-Le...
+ Here is the call graph for this function:

◆ postOutputProcessing()

ilDclCreateViewDefinitionGUI::postOutputProcessing ( string  $a_output)

Finalizing output processing.

Parameters
string$a_output
Returns
string

Definition at line 152 of file class.ilDclCreateViewDefinitionGUI.php.

References Vendor\Package\$f, ilPageObjectGUI\$id, ILIAS\LTI\ToolProvider\$key, $parts, ILIAS\Repository\ctrl(), ilPageObjectGUI\EDIT, ilDclTableViewBaseDefaultValue\findAll(), ActiveRecord\getCollection(), ilPageObjectGUI\getOutputMode(), ilPageObjectGUI\getPageObject(), ILIAS\FileDelivery\http(), ilDclDatatype\INPUTFORMAT_NUMBER, ILIAS\Repository\lng(), ilPageObjectGUI\PREVIEW, and ILIAS\Repository\refinery().

152  : string
153  {
154  // You can use this to parse placeholders and the like before outputting
155 
156  if ($this->getOutputMode() == ilPageObjectGUI::PREVIEW) {
157  //page preview is not being used inside DataCollections - if you are here, something's probably wrong
158 
159  //
160  // // :TODO: find a suitable presentation for matched placeholders
161  // $allp = ilDataCollectionRecordViewViewdefinition::getAvailablePlaceholders($this->table_id, true);
162  // foreach ($allp as $id => $item) {
163  // $parsed_item = new ilTextInputGUI("", "fields[" . $item->getId() . "]");
164  // $parsed_item = $parsed_item->getToolbarHTML();
165  //
166  // $a_output = str_replace($id, $item->getTitle() . ": " . $parsed_item, $a_output);
167  // }
168  } // editor
169  else {
170  if ($this->getOutputMode() == ilPageObjectGUI::EDIT) {
171  $allp = $this->getPageObject()->getAvailablePlaceholders();
172 
173  // :TODO: find a suitable markup for matched placeholders
174  foreach ($allp as $item) {
175  $a_output = str_replace($item, "<span style=\"color:green\">" . $item . "</span>", $a_output);
176  }
177  }
178  }
179 
180  return $a_output;
181  }
+ Here is the call graph for this function:

Field Documentation

◆ $ctrl

ilCtrl ilDclCreateViewDefinitionGUI::$ctrl
protected

Definition at line 27 of file class.ilDclCreateViewDefinitionGUI.php.

◆ $http

ILIAS HTTP Services ilDclCreateViewDefinitionGUI::$http
protected

Definition at line 29 of file class.ilDclCreateViewDefinitionGUI.php.

◆ $refinery

ILIAS Refinery Factory ilDclCreateViewDefinitionGUI::$refinery
protected

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

◆ $table_gui

ilDclCreateViewTableGUI ilDclCreateViewDefinitionGUI::$table_gui
protected

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

◆ $tableview

ilDclTableView ilDclCreateViewDefinitionGUI::$tableview

Definition at line 25 of file class.ilDclCreateViewDefinitionGUI.php.

◆ $tableview_id

int ilDclCreateViewDefinitionGUI::$tableview_id
protected

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

Referenced by __construct().


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