ILIAS  release_5-1 Revision 5.0.0-5477-g43f3e3fab5f
ilDataCollectionTableEditGUI Class Reference

Class ilDataCollectionField. More...

+ Collaboration diagram for ilDataCollectionTableEditGUI:

Public Member Functions

 __construct (ilObjDataCollectionGUI $a_parent_obj)
 Constructor. More...
 
 executeCommand ()
 execute command More...
 
 create ()
 create table add form More...
 
 edit ()
 create field edit form More...
 
 getValues ()
 getFieldValues More...
 
 getStandardValues ()
 getStandardValues More...
 
 cancel ()
 
 initForm ($a_mode="create")
 initEditCustomForm More...
 
 save ($a_mode="create")
 save More...
 
 accessDenied ()
 
 confirmDelete ()
 confirmDelete More...
 
 cancelDelete ()
 cancelDelete More...
 
 delete ()
 

Protected Member Functions

 checkInput ($a_mode)
 Custom checks for the form input. More...
 
 checkPermission ()
 

Protected Attributes

 $lng
 
 $ctrl
 
 $tpl
 
 $form
 

Private Attributes

 $table_id
 
 $table
 

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

ilDataCollectionTableEditGUI::__construct ( ilObjDataCollectionGUI  $a_parent_obj)

Constructor.

Parameters
ilObjDataCollectionGUI$a_parent_obj

Definition at line 50 of file class.ilDataCollectionTableEditGUI.php.

References $_GET, $ilCtrl, $lng, $tpl, checkPermission(), ilDataCollectionCache\getTableCache(), and ilUtil\sendFailure().

50  {
51  global $ilCtrl, $lng, $tpl;
52 
53  $this->ctrl = $ilCtrl;
54  $this->lng = $lng;
55  $this->tpl = $tpl;
56  $this->parent_object = $a_parent_obj;
57  $this->obj_id = $a_parent_obj->obj_id;
58  $this->table_id = $_GET['table_id'];
59  $this->table = ilDataCollectionCache::getTableCache($this->table_id);
60  if (!$this->checkPermission()) {
61  ilUtil::sendFailure($this->lng->txt('permission_denied'), true);
62  $this->ctrl->redirectByClass('ildatacollectionrecordlistgui', 'listRecords');
63  }
64  }
$_GET["client_id"]
global $ilCtrl
Definition: ilias.php:18
static sendFailure($a_info="", $a_keep=false)
Send Failure Message to Screen.
+ Here is the call graph for this function:

Member Function Documentation

◆ accessDenied()

ilDataCollectionTableEditGUI::accessDenied ( )

Definition at line 389 of file class.ilDataCollectionTableEditGUI.php.

Referenced by save().

389  {
390  $this->tpl->setContent("Access denied.");
391  }
+ Here is the caller graph for this function:

◆ cancel()

ilDataCollectionTableEditGUI::cancel ( )

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

171  {
172  $this->ctrl->redirectByClass("ilDataCollectionFieldListGUI", "listFields");
173  }

◆ cancelDelete()

ilDataCollectionTableEditGUI::cancelDelete ( )

cancelDelete

Definition at line 415 of file class.ilDataCollectionTableEditGUI.php.

415  {
416  $this->ctrl->redirectByClass("ildatacollectionfieldlistgui", "listFields");
417  }

◆ checkInput()

ilDataCollectionTableEditGUI::checkInput (   $a_mode)
protected

Custom checks for the form input.

Parameters
$a_mode'create' | 'update'
Returns
bool

Definition at line 364 of file class.ilDataCollectionTableEditGUI.php.

References ilObjDataCollection\_hasTableByTitle(), and ilUtil\sendFailure().

Referenced by save().

364  {
365  $return = $this->form->checkInput();
366 
367  // Title of table must be unique in one DC
368  if ($a_mode == 'create') {
369  if ($title = $this->form->getInput('title')) {
370  if (ilObjDataCollection::_hasTableByTitle($title, $this->obj_id)) {
371  $inputObj = $this->form->getItemByPostVar('title');
372  $inputObj->setAlert($this->lng->txt("dcl_table_title_unique"));
373  $return = false;
374  }
375  }
376  }
377 
378  if (! $return) {
379  ilUtil::sendFailure($this->lng->txt("form_input_not_valid"));
380  }
381 
382  return $return;
383  }
static _hasTableByTitle($title, $obj_id)
Checks if a DataCollection has a table with a given title.
static sendFailure($a_info="", $a_keep=false)
Send Failure Message to Screen.
+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ checkPermission()

ilDataCollectionTableEditGUI::checkPermission ( )
protected
Returns
bool

Definition at line 439 of file class.ilDataCollectionTableEditGUI.php.

References $ref_id, and ilObjDataCollection\_hasWriteAccess().

Referenced by __construct().

439  {
440  $ref_id = $this->parent_object->getDataCollectionObject()->getRefId();
441 
443  }
$ref_id
Definition: sahs_server.php:39
+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ confirmDelete()

ilDataCollectionTableEditGUI::confirmDelete ( )

confirmDelete

Definition at line 397 of file class.ilDataCollectionTableEditGUI.php.

397  {
398  include_once './Services/Utilities/classes/class.ilConfirmationGUI.php';
399  $conf = new ilConfirmationGUI();
400  $conf->setFormAction($this->ctrl->getFormAction($this));
401  $conf->setHeaderText($this->lng->txt('dcl_confirm_delete_table'));
402 
403  $conf->addItem('table', (int)$this->table->getId(), $this->table->getTitle());
404 
405  $conf->setConfirm($this->lng->txt('delete'), 'delete');
406  $conf->setCancel($this->lng->txt('cancel'), 'cancelDelete');
407 
408  $this->tpl->setContent($conf->getHTML());
409  }
Confirmation screen class.

◆ create()

ilDataCollectionTableEditGUI::create ( )

create table add form

Definition at line 90 of file class.ilDataCollectionTableEditGUI.php.

References getStandardValues(), and initForm().

90  {
91  $this->initForm();
92  $this->getStandardValues();
93  $this->tpl->setContent($this->form->getHTML());
94  }
initForm($a_mode="create")
initEditCustomForm
+ Here is the call graph for this function:

◆ delete()

ilDataCollectionTableEditGUI::delete ( )

Definition at line 423 of file class.ilDataCollectionTableEditGUI.php.

References ilUtil\sendFailure().

423  {
424  $mainTableId = $this->table->getCollectionObject()->getMainTableId();
425  if ($mainTableId == $this->table->getId()) {
426  ilUtil::sendFailure($this->lng->txt("dcl_cant_delete_main_table"), true);
427  } else {
428  $this->ctrl->setParameterByClass("ildatacollectionfieldlistgui", "table_id", $mainTableId);
429  }
430 
431  $this->table->doDelete();
432  $this->ctrl->redirectByClass("ildatacollectionfieldlistgui", "listFields");
433  }
static sendFailure($a_info="", $a_keep=false)
Send Failure Message to Screen.
+ Here is the call graph for this function:

◆ edit()

ilDataCollectionTableEditGUI::edit ( )

create field edit form

Definition at line 100 of file class.ilDataCollectionTableEditGUI.php.

References ilDataCollectionCache\getTableCache(), getValues(), and initForm().

100  {
101  if (!$this->table_id) {
102  $this->ctrl->redirectByClass("ildatacollectionfieldeditgui", "listFields");
103 
104  return;
105  } else {
106  $this->table = ilDataCollectionCache::getTableCache($this->table_id);
107  }
108  $this->initForm("edit");
109  $this->getValues();
110  $this->tpl->setContent($this->form->getHTML());
111  }
initForm($a_mode="create")
initEditCustomForm
+ Here is the call graph for this function:

◆ executeCommand()

ilDataCollectionTableEditGUI::executeCommand ( )

execute command

Definition at line 70 of file class.ilDataCollectionTableEditGUI.php.

References $cmd, and save().

70  {
71  $cmd = $this->ctrl->getCmd();
72  $this->tpl->getStandardTemplate();
73 
74  switch ($cmd) {
75  case 'update':
76  $this->save("update");
77  break;
78  default:
79  $this->$cmd();
80  break;
81  }
82 
83  return true;
84  }
$cmd
Definition: sahs_server.php:35
+ Here is the call graph for this function:

◆ getStandardValues()

ilDataCollectionTableEditGUI::getStandardValues ( )

getStandardValues

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

Referenced by create().

149  {
150  $values = array(
151  'title' => "",
152  'is_visible' => 1,
153  'add_perm' => 1,
154  'edit_perm' => 1,
155  'edit_perm_mode' => 'all',
156  'delete_perm_mode' => 'all',
157  'delete_perm' => 1,
158  'edit_by_owner' => 1,
159  'export_enabled' => 0,
160  'limited' => 0,
161  'limit_start' => NULL,
162  'limit_end' => NULL
163  );
164  $this->form->setValuesByArray($values);
165  }
+ Here is the caller graph for this function:

◆ getValues()

ilDataCollectionTableEditGUI::getValues ( )

getFieldValues

Definition at line 117 of file class.ilDataCollectionTableEditGUI.php.

Referenced by edit().

117  {
118  $values = array(
119  'title' => $this->table->getTitle(),
120  'add_perm' => (int) $this->table->getAddPerm(),
121  'edit_perm' => (int) $this->table->getEditPerm(),
122  'edit_perm_mode' => $this->table->getEditByOwner() ? 'own' : 'all',
123  'delete_perm' => (int) $this->table->getDeletePerm(),
124  'delete_perm_mode' => $this->table->getDeleteByOwner() ? 'own' : 'all',
125  'export_enabled' => $this->table->getExportEnabled(),
126  'limited' => $this->table->getLimited(),
127  'limit_start' => array( "date" => substr($this->table->getLimitStart(), 0, 10), "time" => substr($this->table->getLimitStart(), - 8) ),
128  'limit_end' => array( "date" => substr($this->table->getLimitEnd(), 0, 10), "time" => substr($this->table->getLimitEnd(), - 8) ),
129  'is_visible' => $this->table->getIsVisible(),
130  'default_sort_field' => $this->table->getDefaultSortField(),
131  'default_sort_field_order' => $this->table->getDefaultSortFieldOrder(),
132  'description' => $this->table->getDescription(),
133  'public_comments' => $this->table->getPublicCommentsEnabled(),
134  'view_own_records_perm' => $this->table->getViewOwnRecordsPerm(),
135  );
136  if (!$this->table->getLimitStart()) {
137  $values['limit_start'] = NULL;
138  }
139  if (!$this->table->getLimitEnd()) {
140  $values['limit_end'] = NULL;
141  }
142  $this->form->setValuesByArray($values);
143  }
+ Here is the caller graph for this function:

◆ initForm()

ilDataCollectionTableEditGUI::initForm (   $a_mode = "create")

initEditCustomForm

Parameters
string$a_mode

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

References $options, $section, ilFormPropertyGUI\setInfo(), ilFormPropertyGUI\setRequired(), ilDateTimeInputGUI\setShowTime(), and ilTextAreaInputGUI\setUseRte().

Referenced by create(), edit(), and save().

181  {
182  include_once("./Services/Form/classes/class.ilPropertyFormGUI.php");
183  $this->form = new ilPropertyFormGUI();
184 
185  $item = new ilTextInputGUI($this->lng->txt('title'), 'title');
186  $item->setRequired(true);
187  $this->form->addItem($item);
188 
189  //#0019146: Main Table is always visible in the menu-dropdown, if some other table is visible too
190  if ($this->table_id != $this->parent_object->getDataCollectionObject()->getMainTableId()) {
191  $item = new ilCheckboxInputGUI($this->lng->txt('dcl_visible'), 'is_visible');
192  $item->setInfo($this->lng->txt('dcl_visible_desc'));
193  $this->form->addItem($item);
194  }
195 
196  // Show default order field and direction only in edit mode, because table id is not yet given and there are no fields to select
197  if ($a_mode != 'create') {
198  $item = new ilSelectInputGUI($this->lng->txt('dcl_default_sort_field'), 'default_sort_field');
199  $item->setInfo($this->lng->txt('dcl_default_sort_field_desc'));
200  $fields = $this->table->getVisibleFields();
201  $options = array( 0 => $this->lng->txt('dcl_please_select') );
202  foreach ($fields as $field) {
203  $options[$field->getId()] = $field->getTitle();
204  }
205  $item->setOptions($options);
206  $this->form->addItem($item);
207 
208  $item = new ilSelectInputGUI($this->lng->txt('dcl_default_sort_field_order'), 'default_sort_field_order');
209  $options = array( 'asc' => $this->lng->txt('dcl_asc'), 'desc' => $this->lng->txt('dcl_desc') );
210  $item->setOptions($options);
211  $this->form->addItem($item);
212  }
213 
214  $item = new ilTextAreaInputGUI($this->lng->txt('additional_info'), 'description');
215  $item->setUseRte(true);
216  $item->setInfo($this->lng->txt('dcl_additional_info_desc'));
217  // $item->setRTESupport($this->table->getId(), 'dcl', 'table_settings');
218  $item->setRteTagSet('mini');
219  $this->form->addItem($item);
220 
221  $item = new ilCheckboxInputGUI($this->lng->txt('dcl_public_comments'), 'public_comments');
222  $item->setInfo($this->lng->txt('dcl_public_comments_desc'));
223  $this->form->addItem($item);
224 
226  $section->setTitle($this->lng->txt('dcl_permissions_form'));
227  $this->form->addItem($section);
228 
229  $item = new ilCustomInputGUI();
230  $item->setHtml($this->lng->txt('dcl_table_info'));
231  $item->setTitle($this->lng->txt('dcl_table_info_title'));
232  $this->form->addItem($item);
233 
234  $item = new ilCheckboxInputGUI($this->lng->txt('dcl_add_perm'), 'add_perm');
235  $item->setInfo($this->lng->txt("dcl_add_perm_desc"));
236  $this->form->addItem($item);
237 
238  $item = new ilCheckboxInputGUI($this->lng->txt('dcl_edit_perm'), 'edit_perm');
239  // $item->setInfo($this->lng->txt("dcl_edit_perm_info"));
240  $this->form->addItem($item);
241 
242  $radios = new ilRadioGroupInputGUI('', 'edit_perm_mode');
243  $radios->addOption(new ilRadioOption($this->lng->txt('dcl_all_entries'), 'all'));
244  $radios->addOption(new ilRadioOption($this->lng->txt('dcl_own_entries'), 'own'));
245  $item->addSubItem($radios);
246 
247  $item = new ilCheckboxInputGUI($this->lng->txt('dcl_delete_perm'), 'delete_perm');
248  // $item->setInfo($this->lng->txt("dcl_delete_perm_info"));
249  $this->form->addItem($item);
250 
251  $radios = new ilRadioGroupInputGUI('', 'delete_perm_mode');
252  $radios->addOption(new ilRadioOption($this->lng->txt('dcl_all_entries'), 'all'));
253  $radios->addOption(new ilRadioOption($this->lng->txt('dcl_own_entries'), 'own'));
254  $item->addSubItem($radios);
255 
256  $item = new ilCheckboxInputGUI($this->lng->txt('dcl_view_own_records_perm'), 'view_own_records_perm');
257  // $item->setInfo($this->lng->txt("dcl_edit_by_owner_info"));
258  $this->form->addItem($item);
259 
260  $item = new ilCheckboxInputGUI($this->lng->txt('dcl_export_enabled'), 'export_enabled');
261  $item->setInfo($this->lng->txt('dcl_export_enabled_desc'));
262  $this->form->addItem($item);
263 
264  $item = new ilCheckboxInputGUI($this->lng->txt('dcl_limited'), 'limited');
265  $sitem1 = new ilDateTimeInputGUI($this->lng->txt('dcl_limit_start'), 'limit_start');
266  $sitem1->setShowTime(true);
267  $sitem2 = new ilDateTimeInputGUI($this->lng->txt('dcl_limit_end'), 'limit_end');
268  $sitem2->setShowTime(true);
269  $item->setInfo($this->lng->txt("dcl_limited_desc"));
270  $item->addSubItem($sitem1);
271  $item->addSubItem($sitem2);
272  $this->form->addItem($item);
273 
274  if ($a_mode == "edit") {
275  $this->form->addCommandButton('update', $this->lng->txt('dcl_table_' . $a_mode));
276  } else {
277  $this->form->addCommandButton('save', $this->lng->txt('dcl_table_' . $a_mode));
278  }
279 
280  $this->form->addCommandButton('cancel', $this->lng->txt('cancel'));
281  $this->form->setFormAction($this->ctrl->getFormAction($this, $a_mode));
282  if ($a_mode == "edit") {
283  $this->form->setTitle($this->lng->txt('dcl_edit_table'));
284  } else {
285  $this->form->setTitle($this->lng->txt('dcl_new_table'));
286  }
287  }
This class represents an option in a radio group.
This class represents a selection list property in a property form.
This class represents a property form user interface.
This class represents a section header in a property form.
setUseRte($a_usert, $version='')
Set Use Rich Text Editing.
This class represents a checkbox property in a property form.
This class represents a date/time property in a property form.
setInfo($a_info)
Set Information Text.
$section
Definition: Utf8Test.php:84
This class represents a property in a property form.
if(!is_array($argv)) $options
This class represents a text property in a property form.
This class represents a custom property in a property form.
This class represents a text area property in a property form.
setRequired($a_required)
Set Required.
setShowTime($a_showtime)
Set Show Time Information.
+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ save()

ilDataCollectionTableEditGUI::save (   $a_mode = "create")

save

Parameters
string$a_modevalues: create | edit

Definition at line 295 of file class.ilDataCollectionTableEditGUI.php.

References accessDenied(), ilObjDataCollectionAccess\checkActionForObjId(), checkInput(), ilDataCollectionCache\getTableCache(), initForm(), and ilUtil\sendSuccess().

Referenced by executeCommand().

295  {
296  global $ilTabs;
297 
298  if (!ilObjDataCollectionAccess::checkActionForObjId('write', $this->obj_id)) {
299  $this->accessDenied();
300  return;
301  }
302 
303  $ilTabs->activateTab("id_fields");
304  $this->initForm($a_mode);
305 
306  if ($this->checkInput($a_mode)) {
307  if ($a_mode != "update") {
308  $this->table = ilDataCollectionCache::getTableCache();
309  } elseif ($this->table_id) {
310  $this->table = ilDataCollectionCache::getTableCache($this->table_id);
311  } else {
312  $this->ctrl->redirectByClass("ildatacollectionfieldeditgui", "listFields");
313  }
314 
315  $this->table->setTitle($this->form->getInput("title"));
316  $this->table->setObjId($this->obj_id);
317  $this->table->setIsVisible((bool)$this->form->getInput("is_visible"));
318  $this->table->setAddPerm((bool)$this->form->getInput("add_perm"));
319  $this->table->setEditPerm((bool)$this->form->getInput("edit_perm"));
320  if ($this->table->getEditPerm()) {
321  $edit_by_owner = ($this->form->getInput('edit_perm_mode') == 'own');
322  $this->table->setEditByOwner($edit_by_owner);
323  }
324  $this->table->setDeletePerm((bool)$this->form->getInput("delete_perm"));
325  if ($this->table->getDeletePerm()) {
326  $delete_by_owner = ($this->form->getInput('delete_perm_mode') == 'own');
327  $this->table->setDeleteByOwner($delete_by_owner);
328  }
329  $this->table->setViewOwnRecordsPerm($this->form->getInput('view_own_records_perm'));
330  $this->table->setExportEnabled($this->form->getInput("export_enabled"));
331  $this->table->setDefaultSortField($this->form->getInput("default_sort_field"));
332  $this->table->setDefaultSortFieldOrder($this->form->getInput("default_sort_field_order"));
333  $this->table->setPublicCommentsEnabled($this->form->getInput('public_comments'));
334  $this->table->setLimited($this->form->getInput("limited"));
335  $this->table->setDescription($this->form->getInput('description'));
336  $limit_start = $this->form->getInput("limit_start");
337  $limit_end = $this->form->getInput("limit_end");
338  $this->table->setLimitStart($limit_start["date"] . " " . $limit_start["time"]);
339  $this->table->setLimitEnd($limit_end["date"] . " " . $limit_end["time"]);
340  if ($a_mode == "update") {
341  $this->table->doUpdate();
342  ilUtil::sendSuccess($this->lng->txt("dcl_msg_table_edited"), true);
343  $this->ctrl->redirectByClass("ildatacollectiontableeditgui", "edit");
344  } else {
345  $this->table->doCreate();
346  ilUtil::sendSuccess($this->lng->txt("dcl_msg_table_created"), true);
347  $this->ctrl->setParameterByClass("ildatacollectionfieldlistgui", "table_id", $this->table->getId());
348  $this->ctrl->redirectByClass("ildatacollectionfieldlistgui", "listFields");
349  }
350  } else {
351  $this->form->setValuesByPost();
352  $this->tpl->setContent($this->form->getHTML());
353  }
354  }
static sendSuccess($a_info="", $a_keep=false)
Send Success Message to Screen.
checkInput($a_mode)
Custom checks for the form input.
static checkActionForObjId($action, $obj_id)
initForm($a_mode="create")
initEditCustomForm
+ Here is the call graph for this function:
+ Here is the caller graph for this function:

Field Documentation

◆ $ctrl

ilDataCollectionTableEditGUI::$ctrl
protected

Definition at line 35 of file class.ilDataCollectionTableEditGUI.php.

◆ $form

ilDataCollectionTableEditGUI::$form
protected

Definition at line 43 of file class.ilDataCollectionTableEditGUI.php.

◆ $lng

ilDataCollectionTableEditGUI::$lng
protected

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

Referenced by __construct().

◆ $table

ilDataCollectionTableEditGUI::$table
private

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

◆ $table_id

ilDataCollectionTableEditGUI::$table_id
private

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

◆ $tpl

ilDataCollectionTableEditGUI::$tpl
protected

Definition at line 39 of file class.ilDataCollectionTableEditGUI.php.

Referenced by __construct().


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