ILIAS  Release_5_0_x_branch Revision 61816
 All Data Structures Namespaces Files Functions Variables Groups Pages
ilDataCollectionFieldListTableGUI Class Reference

Class ilDataCollectionFieldListTableGUI. More...

+ Inheritance diagram for ilDataCollectionFieldListTableGUI:
+ Collaboration diagram for ilDataCollectionFieldListTableGUI:

Public Member Functions

 __construct (ilDataCollectionFieldListGUI $a_parent_obj, $a_parent_cmd, $table_id)
 fillRow (ilDataCollectionField $a_set)
- Public Member Functions inherited from ilTable2GUI
 __construct ($a_parent_obj, $a_parent_cmd="", $a_template_context="")
 Constructor.
 setOpenFormTag ($a_val)
 Set open form tag.
 getOpenFormTag ()
 Get open form tag.
 setCloseFormTag ($a_val)
 Set close form tag.
 getCloseFormTag ()
 Get close form tag.
 determineLimit ()
 Determine the limit.
 getSelectableColumns ()
 Get selectable columns.
 determineSelectedColumns ()
 Determine selected columns.
 isColumnSelected ($a_col)
 Is given column selected?
 getSelectedColumns ()
 Get selected columns.
executeCommand ()
 Execute command.
 resetOffset ($a_in_determination=false)
 Reset offset.
 initFilter ()
 Init filter.
 getParentObject ()
 Get parent object.
 getParentCmd ()
 Get parent command.
 setTopAnchor ($a_val)
 Set top anchor.
 getTopAnchor ()
 Get top anchor.
 setNoEntriesText ($a_text)
 Set text for an empty table.
 getNoEntriesText ()
 Get text for an empty table.
 setIsDataTable ($a_val)
 Set is data table.
 getIsDataTable ()
 Get is data table.
 setEnableTitle ($a_enabletitle)
 Set Enable Title.
 getEnableTitle ()
 Get Enable Title.
 setEnableHeader ($a_enableheader)
 Set Enable Header.
 getEnableHeader ()
 Get Enable Header.
 setEnableNumInfo ($a_val)
 Set enable num info.
 getEnableNumInfo ()
 Get enable num info.
 setTitle ($a_title, $a_icon=0, $a_icon_alt=0)
 Set title and title icon.
 setDescription ($a_val)
 Set description.
 getDescription ()
 Get description.
 setOrderField ($a_order_field)
 set order column
 getOrderField ()
 setData ($a_data)
 set table data public
 getData ()
 dataExists ()
 setPrefix ($a_prefix)
 set prefix for sort and offset fields (if you have two or more tables on a page that you want to sort separately) public
 getPrefix ()
 addFilterItem ($a_input_item, $a_optional=false)
 Add filter item.
 addFilterItemByMetaType ($id, $type=self::FILTER_TEXT, $a_optional=false, $caption=NULL)
 Add filter by standard type.
 getFilterItems ($a_optionals=false)
 Get filter items.
 getFilterItemByPostVar ($a_post_var)
 setFilterCols ($a_val)
 Set filter columns.
 getFilterCols ()
 Get filter columns.
 setDisableFilterHiding ($a_val=true)
 Set disable filter hiding.
 getDisableFilterHiding ()
 Get disable filter hiding.
 isFilterSelected ($a_col)
 Is given filter selected?
 getSelectedFilters ()
 Get selected filters.
 determineSelectedFilters ()
 Determine selected filters.
 setCustomPreviousNext ($a_prev_link, $a_next_link)
 Set custom previous/next links.
 setFormAction ($a_form_action, $a_multipart=false)
 Set Form action parameter.
 getFormAction ()
 Get Form action parameter.
 setFormName ($a_formname)
 Set Form name.
 getFormName ()
 Get Form name.
 setId ($a_val)
 Set id.
 getId ()
 Get element id.
 setDisplayAsBlock ($a_val)
 Set display as block.
 getDisplayAsBlock ()
 Get display as block.
 getSelectAllCheckbox ()
 Get the name of the checkbox that should be toggled with a select all button.
 setSelectAllCheckbox ($a_select_all_checkbox)
 Set the name of the checkbox that should be toggled with a select all button.
 setExternalSorting ($a_val)
 Set external sorting.
 getExternalSorting ()
 Get external sorting.
 setFilterCommand ($a_val, $a_caption=null)
 Set filter command.
 getFilterCommand ()
 Get filter command.
 setResetCommand ($a_val, $a_caption=null)
 Set reset filter command.
 getResetCommand ()
 Get reset filter command.
 setExternalSegmentation ($a_val)
 Set external segmentation.
 getExternalSegmentation ()
 Get external segmentation.
 setRowTemplate ($a_template, $a_template_dir="")
 Set row template.
 setDefaultOrderField ($a_defaultorderfield)
 Set Default order field.
 getDefaultOrderField ()
 Get Default order field.
 setDefaultOrderDirection ($a_defaultorderdirection)
 Set Default order direction.
 getDefaultOrderDirection ()
 Get Default order direction.
 clearCommandButtons ()
 addCommandButton ($a_cmd, $a_text, $a_onclick= '', $a_id="", $a_class=null)
 Add Command button.
 addCommandButtonInstance (ilButton $a_button)
 Add Command button instance.
 addSelectionButton ($a_sel_var, $a_options, $a_cmd, $a_text, $a_default_selection= '')
 Add Selection List + Command button.
 addMultiItemSelectionButton ($a_sel_var, $a_options, $a_cmd, $a_text, $a_default_selection= '')
 Add Selection List + Command button for selected items.
 setCloseCommand ($a_link)
 Add command for closing table.
 addMultiCommand ($a_cmd, $a_text)
 Add Command button.
 addHiddenInput ($a_name, $a_value)
 Add Hidden Input field.
 addHeaderCommand ($a_href, $a_text, $a_target="", $a_img="")
 Add Header Command (Link) (Image needed for now)
 setTopCommands ($a_val)
 Set top commands (display command buttons on top of table, too)
 getTopCommands ()
 Get top commands (display command buttons on top of table, too)
 addColumn ($a_text, $a_sort_field="", $a_width="", $a_is_checkbox_action_column=false, $a_class="", $a_tooltip="")
 Add a column to the header.
 getNavParameter ()
 setOrderLink ($sort_field, $order_dir)
 fillHeader ()
 determineOffsetAndOrder ($a_omit_offset=false)
 Determine offset and order.
 storeNavParameter ()
 getHTML ()
 Get HTML.
 numericOrdering ($a_field)
 Should this field be sorted numeric?
 render ()
 render table public
 writeFilterToSession ()
 Write filter values to session.
 resetFilter ()
 Reset filter.
 fillFooter ()
 Fill footer row.
 getLinkbar ($a_num)
 Get previous/next linkbar.
 fillHiddenRow ()
 fillActionRow ()
 Fill Action Row.
 setHeaderHTML ($html)
 set header html
 storeProperty ($type, $value)
 Store table property.
 loadProperty ($type)
 Load table property.
 getCurrentState ()
 get current settings for order, limit, columns and filter
 setContext ($id)
 Set context.
 getContext ()
 Get context.
 setShowRowsSelector ($a_value)
 Toggle rows-per-page selector.
 getShowRowsSelector ()
 Get rows-per-page selector state.
 setShowTemplates ($a_value)
 Toggle templates.
 getShowTemplates ()
 Get template state.
 restoreTemplate ($a_name)
 Restore state from template.
 saveTemplate ($a_name)
 Save current state as template.
 deleteTemplate ($a_name)
 Delete template.
 getLimit ()
 Get limit.
 getOffset ()
 Get offset.
 setExportFormats (array $formats)
 Set available export formats.
 setPrintMode ($a_value=false)
 Toogle print mode.
 getPrintMode ()
 Get print mode.
 getExportMode ()
 Was export activated?
 exportData ($format, $send=false)
 Export and optionally send current table data.
 setEnableAllCommand ($a_value)
 Enable actions for all entries in current result.
 setRowSelectorLabel ($row_selector_label)
 getRowSelectorLabel ()
 setPreventDoubleSubmission ($a_val)
 Set prevent double submission.
 getPreventDoubleSubmission ()
 Get prevent double submission.
- Public Member Functions inherited from ilTableGUI
 ilTableGUI ($a_data=0, $a_global_tpl=true)
 Constructor.
 setTemplate (&$a_tpl)
 set template public
getTemplateObject ()
 setHelp ($a_help_page, $a_help_icon, $a_help_icon_alt=0)
 set table help page public
 setHeaderNames ($a_header_names)
 set table header names public
 getColumnCount ()
 Returns the column count based on the number of the header row columns public.
 setHeaderVars ($a_header_vars, $a_header_params=0)
 set table header vars public
 setColumnWidth ($a_column_width)
 set table column widths public
 setOneColumnWidth ($a_column_width, $a_column_number)
 set one table column width public
 setMaxCount ($a_max_count)
 set max.
 setLimit ($a_limit=0, $a_default_limit=0)
 set max.
 setOffset ($a_offset)
 set dataset offset public
 setOrderColumn ($a_order_column=0, $a_default_column=0)
 set order column public
 getOrderColumn ()
 Get order column.
 setOrderDirection ($a_order_direction)
 set order direction public
 getOrderDirection ()
 Get order direction.
 setFooter ($a_style, $a_previous=0, $a_next=0)
 set order direction public
 enable ($a_module_name)
 enables particular modules of table
 disable ($a_module_name)
 diesables particular modules of table
 sortData ()
 renderHeader ()
 setStyle ($a_element, $a_style)
 getStyle ($a_element)
 setBase ($a_base)
 Set Base script name (deprecated, only use this for workarounds).
 getBase ()
 Get Base script name (deprecated, only use this for workarounds).
 clearActionButtons ()
 addActionButton ($btn_name, $btn_value)

Additional Inherited Members

- Static Public Member Functions inherited from ilTable2GUI
static getAllCommandLimit ()
 Get maximum number of entries to enable actions for all.
- Data Fields inherited from ilTable2GUI
const FILTER_TEXT = 1
const FILTER_SELECT = 2
const FILTER_DATE = 3
const FILTER_LANGUAGE = 4
const FILTER_NUMBER_RANGE = 5
const FILTER_DATE_RANGE = 6
const FILTER_DURATION_RANGE = 7
const FILTER_DATETIME_RANGE = 8
const EXPORT_EXCEL = 1
const EXPORT_CSV = 2
const ACTION_ALL_LIMIT = 1000
- Protected Member Functions inherited from ilTable2GUI
 prepareOutput ()
 Anything that must be done before HTML is generated.
 fillRow ($a_set)
 Standard Version of Fill Row.
 getFilterValue (ilFormPropertyGUI $a_item)
 Get current filter value.
 SetFilterValue (ilFormPropertyGUI $a_item, $a_value)
 Set current filter value.
 fillMetaExcel ($worksheet, &$a_row)
 Add meta information to excel export.
 fillHeaderExcel ($worksheet, &$a_row)
 Excel Version of Fill Header.
 fillRowExcel ($a_worksheet, &$a_row, $a_set)
 Excel Version of Fill Row.
 fillMetaCSV ($a_csv)
 Add meta information to csv export.
 fillHeaderCSV ($a_csv)
 CSV Version of Fill Header.
 fillRowCSV ($a_csv, $a_set)
 CSV Version of Fill Row.
- Protected Attributes inherited from ilTable2GUI
 $close_command = ""
 $top_anchor = "il_table_top"
 $filters = array()
 $optional_filters = array()
 $filter_cmd = 'applyFilter'
 $reset_cmd = 'resetFilter'
 $filter_cols = 5
 $ext_sort = false
 $ext_seg = false
 $context = ""
 $mi_sel_buttons = null
 $disable_filter_hiding = false
 $selected_filter = false
 $top_commands = true
 $selectable_columns = array()
 $selected_column = array()
 $show_templates = false
 $show_rows_selector = true
 $nav_determined = false
 $limit_determined = false
 $filters_determined = false
 $columns_determined = false
 $open_form_tag = true
 $close_form_tag = true
 $export_formats
 $export_mode
 $print_mode
 $enable_command_for_all
 $restore_filter
 $restore_filter_values
 $sortable_fields = array()
 $prevent_double_submission = true
 $row_selector_label

Detailed Description

Constructor & Destructor Documentation

ilDataCollectionFieldListTableGUI::__construct ( ilDataCollectionFieldListGUI  $a_parent_obj,
  $a_parent_cmd,
  $table_id 
)
Parameters
ilDataCollectionFieldListGUI$a_parent_obj
string$a_parent_cmd
string$table_id

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

References $ilCtrl, $lng, ilTable2GUI\addColumn(), ilTable2GUI\addCommandButton(), ilTable2GUI\addMultiCommand(), ilTableGUI\getStyle(), ilDataCollectionCache\getTableCache(), ilTable2GUI\setData(), ilTable2GUI\setDefaultOrderDirection(), ilTable2GUI\setEnableHeader(), ilTable2GUI\setEnableTitle(), ilTable2GUI\setExternalSegmentation(), ilTable2GUI\setExternalSorting(), ilTable2GUI\setFormAction(), ilTable2GUI\setFormName(), ilTable2GUI\setId(), ilTable2GUI\setRowTemplate(), ilTable2GUI\setSelectAllCheckbox(), ilTable2GUI\setShowRowsSelector(), ilTable2GUI\setShowTemplates(), ilTableGUI\setStyle(), ilTable2GUI\setTitle(), and ilTable2GUI\setTopCommands().

{
global $lng, $ilCtrl;
parent::__construct($a_parent_obj, $a_parent_cmd);
$this->parent_obj = $a_parent_obj;
$this->table = ilDataCollectionCache::getTableCache($table_id);
$this->setId('dcl_field_list');
$this->addColumn('', '', '1', true);
$this->addColumn($lng->txt('dcl_order'), NULL, '30px');
$this->addColumn($lng->txt('dcl_title'), NULL, 'auto');
$this->addColumn($lng->txt('dcl_visible'), NULL, '30px');
$this->addColumn($lng->txt('dcl_filter'), NULL, '30px');
$this->addColumn($lng->txt('dcl_locked'), NULL, '30px', false, "", $lng->txt('dcl_locked_tooltip'));
$this->addColumn($lng->txt('dcl_in_export'), NULL, '30px');
$this->addColumn($lng->txt('dcl_description'), NULL, 'auto');
$this->addColumn($lng->txt('dcl_field_datatype'), NULL, 'auto');
$this->addColumn($lng->txt('dcl_required'), NULL, 'auto');
$this->addColumn($lng->txt('dcl_unique'), NULL, 'auto');
$this->addColumn($lng->txt('actions'), NULL, '30px');
// Only add mutli command for custom fields
if (count($this->table->getRecordFields())) {
$this->setSelectAllCheckbox('dcl_field_ids[]');
$this->addMultiCommand('confirmDeleteFields', $lng->txt('dcl_delete_fields'));
}
$ilCtrl->setParameterByClass('ildatacollectionfieldeditgui', 'table_id', $this->parent_obj->table_id);
$ilCtrl->setParameterByClass('ildatacollectionfieldlistgui', 'table_id', $this->parent_obj->table_id);
$this->setFormAction($ilCtrl->getFormActionByClass('ildatacollectionfieldlistgui'));
$this->addCommandButton('save', $lng->txt('dcl_save'));
$this->setFormAction($ilCtrl->getFormAction($a_parent_obj));
$this->setFormName('field_list');
//those two are important as we get our data as objects not as arrays.
$this->setExternalSorting(true);
$this->setTopCommands(true);
$this->setEnableHeader(true);
$this->setShowRowsSelector(false);
$this->setShowTemplates(false);
$this->setEnableHeader(true);
$this->setEnableTitle(true);
$this->setDefaultOrderDirection('asc');
$this->setData($this->table->getFields());
require_once('./Modules/DataCollection/classes/class.ilDataCollectionDatatype.php'); //wird dies benötigt?
$this->setTitle($lng->txt('dcl_table_list_fields'));
$this->setRowTemplate('tpl.field_list_row.html', 'Modules/DataCollection');
$this->setStyle('table', $this->getStyle('table') . ' ' . 'dcl_record_list');
}

+ Here is the call graph for this function:

Member Function Documentation

ilDataCollectionFieldListTableGUI::fillRow ( ilDataCollectionField  $a_set)
Parameters
ilDataCollectionField$a_set

Definition at line 86 of file class.ilDataCollectionFieldListTableGUI.php.

References $ilCtrl, $lng, ilDataCollectionField\getDatatypeId(), ilDataCollectionField\getDatatypeTitle(), ilDataCollectionField\getDescription(), ilDataCollectionField\getExportable(), ilDataCollectionCache\getFieldCache(), ilDataCollectionField\getFieldRef(), ilDataCollectionField\getId(), ilUtil\getImagePath(), ilDataCollectionField\getLocked(), ilDataCollectionField\getRequired(), ilDataCollectionField\getTitle(), ilDataCollectionDatatype\INPUTFORMAT_FILE, ilDataCollectionDatatype\INPUTFORMAT_MOB, ilDataCollectionDatatype\INPUTFORMAT_REFERENCE, ilDataCollectionField\isFilterable(), ilDataCollectionField\isStandardField(), ilDataCollectionField\isUnique(), and ilDataCollectionField\isVisible().

{
global $lng, $ilCtrl;
if (!$a_set->isStandardField()) {
$this->tpl->setVariable('FIELD_ID', $a_set->getId());
}
$this->tpl->setVariable('NAME', 'order[' . $a_set->getId() . ']');
$this->tpl->setVariable('VALUE', $this->order);
$this->tpl->setVariable('CHECKBOX_VISIBLE', 'visible[' . $a_set->getId() . ']');
if ($a_set->isVisible()) {
$this->tpl->setVariable('CHECKBOX_VISIBLE_CHECKED', 'checked');
}
/* Don't enable setting filter for MOB fields or reference fields that reference a MOB field */
$show_filter = true;
$show_exportable = true;
) {
$show_filter = false;
}
$ref_field = ilDataCollectionCache::getFieldCache((int)$a_set->getFieldRef());
if ($ref_field
&& ($ref_field->getDatatypeId() == ilDataCollectionDatatype::INPUTFORMAT_MOB
|| $ref_field->getDatatypeId() == ilDataCollectionDatatype::INPUTFORMAT_FILE)
) {
$show_filter = false;
}
}
if ($a_set->getId() == 'comments') {
$show_filter = false;
$show_exportable = false;
}
if ($show_filter) {
$this->tpl->setVariable('CHECKBOX_FILTERABLE', 'filterable[' . $a_set->getId() . ']');
if ($a_set->isFilterable()) {
$this->tpl->setVariable('CHECKBOX_FILTERABLE_CHECKED', 'checked');
}
} else {
$this->tpl->setVariable('NO_FILTER', '');
}
if ($show_exportable) {
$this->tpl->setVariable('CHECKBOX_EXPORTABLE', 'exportable[' . $a_set->getId() . ']');
if ($a_set->getExportable()) {
$this->tpl->setVariable('CHECKBOX_EXPORTABLE_CHECKED', 'checked');
}
} else {
$this->tpl->setVariable('NO_FILTER_EXPORTABLE', '');
}
if (!$a_set->isStandardField()) {
$this->tpl->setVariable('CHECKBOX_NAME_LOCKED', 'locked[' . $a_set->getId() . ']');
if ($a_set->getLocked()) {
$this->tpl->setVariable('CHECKBOX_CHECKED_LOCKED', 'checked');
}
} else {
$this->tpl->setVariable('NOT_LOCKED', '');
}
$this->order = $this->order + 10;
$this->tpl->setVariable('ORDER_NAME', 'order[' . $a_set->getId() . ']');
$this->tpl->setVariable('ORDER_VALUE', $this->order);
$this->tpl->setVariable('TITLE', $a_set->getTitle());
$this->tpl->setVariable('DESCRIPTION', $a_set->getDescription());
$this->tpl->setVariable('DATATYPE', $a_set->getDatatypeTitle());
if (!$a_set->isStandardField()) {
switch ($a_set->getRequired()) {
case 0:
$required = ilUtil::getImagePath('icon_not_ok.svg');
break;
case 1:
$required = ilUtil::getImagePath('icon_ok.svg');
break;
}
switch ($a_set->isUnique()) {
case 0:
$uniq = ilUtil::getImagePath('icon_not_ok.svg');
break;
case 1:
$uniq = ilUtil::getImagePath('icon_ok.svg');
break;
}
$this->tpl->setVariable('REQUIRED', $required);
$this->tpl->setVariable('UNIQUE', $uniq);
} else {
$this->tpl->setVariable('NO_REQUIRED', '');
$this->tpl->setVariable('NO_UNIQUE', '');
}
$ilCtrl->setParameterByClass('ildatacollectionfieldeditgui', 'field_id', $a_set->getId());
if (!$a_set->isStandardField()) {
include_once('./Services/UIComponent/AdvancedSelectionList/classes/class.ilAdvancedSelectionListGUI.php');
$alist->setId($a_set->getId());
$alist->setListTitle($lng->txt('actions'));
if ($this->table->hasPermissionToFields($this->parent_obj->parent_obj->ref_id)) {
$alist->addItem($lng->txt('edit'), 'edit', $ilCtrl->getLinkTargetByClass('ildatacollectionfieldeditgui', 'edit'));
$alist->addItem($lng->txt('delete'), 'delete', $ilCtrl->getLinkTargetByClass('ildatacollectionfieldeditgui', 'confirmDelete'));
}
$this->tpl->setVariable('ACTIONS', $alist->getHTML());
}
}

+ Here is the call graph for this function:


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