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

Description of class. More...

+ Inheritance diagram for ilLPCollectionSettingsTableGUI:
+ Collaboration diagram for ilLPCollectionSettingsTableGUI:

Public Member Functions

 __construct ($a_parent_obj, $a_parent_cmd="", $a_node_id, $a_mode)
 Constructor.
 getNode ()
 Get node id of current learning progress item.
 getMode ()
 parse (ilLPCollection $a_collection)
 Read and parse items.
- 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)

Protected Member Functions

 fillRow ($a_set)
 Fill template row.
 initTable ()
- Protected Member Functions inherited from ilTable2GUI
 prepareOutput ()
 Anything that must be done before HTML is generated.
 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.

Private Attributes

 $node_id
 $mode

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

Description of class.

Author
Stefan Meyer meyer.nosp@m.@lei.nosp@m.fos.c.nosp@m.om

Definition at line 12 of file class.ilLPCollectionSettingsTableGUI.php.

Constructor & Destructor Documentation

ilLPCollectionSettingsTableGUI::__construct (   $a_parent_obj,
  $a_parent_cmd = "",
  $a_node_id,
  $a_mode 
)

Constructor.

Parameters
ilObject$a_parent_obj
string$a_parent_cmd

Definition at line 22 of file class.ilLPCollectionSettingsTableGUI.php.

References getNode(), ilTable2GUI\setId(), and ilTable2GUI\setShowRowsSelector().

{
parent::__construct($a_parent_obj, $a_parent_cmd);
$this->setId('lpobjs_'.$this->getNode());
$this->setShowRowsSelector(false);
$this->node_id = $a_node_id;
$this->mode = $a_mode;
}

+ Here is the call graph for this function:

Member Function Documentation

ilLPCollectionSettingsTableGUI::fillRow (   $a_set)
protected

Fill template row.

Parameters
array$a_set

Reimplemented from ilTable2GUI.

Definition at line 76 of file class.ilLPCollectionSettingsTableGUI.php.

References $mode, $options, $path, ilFrameTargetInfo\_getFrame(), ilObject\_getIcon(), ilLink\_getLink(), ilUtil\formSelect(), ilUtil\getImagePath(), getMode(), getNode(), ilPlugin\lookupTxt(), ilLPObjSettings\LP_MODE_COLLECTION_MANUAL, ilLPObjSettings\LP_MODE_COLLECTION_TLT, ilLPObjSettings\LP_MODE_DEACTIVATED, ilLPObjSettings\LP_MODE_SCORM, ilLPObjSettings\LP_MODE_UNDEFINED, and ilUtil\makeTimeSelect().

{
global $objDefinition;
include_once './Services/Link/classes/class.ilLink.php';
$this->tpl->setCurrentBlock('item_row');
$this->tpl->setVariable('ITEM_ID', $a_set['id']);
$this->tpl->setVariable('COLL_TITLE', $a_set['title']);
$this->tpl->setVariable('COLL_DESC',$a_set['description']);
{
$this->tpl->setVariable('TYPE_IMG', ilUtil::getImagePath('icon_sco.svg'));
$this->tpl->setVariable('ALT_IMG', $this->lng->txt('obj_sco'));
}
else
{
if($objDefinition->isPluginTypeName($a_set["type"]))
{
$alt = ilPlugin::lookupTxt("rep_robj", $a_set['type'], "obj_".$a_set['type']);
}
else
{
$alt = $this->lng->txt('obj_' . $a_set['type']);
}
$this->tpl->setVariable('ALT_IMG', $alt);
$this->tpl->setVariable('TYPE_IMG', ilObject::_getIcon("", "tiny", $a_set['type']));
{
$this->tpl->setVariable('COLL_LINK', ilLink::_getLink($a_set['ref_id'], $a_set['type']));
$this->tpl->setVariable('COLL_FRAME', ilFrameTargetInfo::_getFrame('MainContent', $a_set['type']));
include_once './Services/Tree/classes/class.ilPathGUI.php';
$path = new ilPathGUI();
$this->tpl->setVariable('COLL_PATH', $this->lng->txt('path').': '.$path->getPath($this->getNode(),$a_set['ref_id']));
$mode_suffix = '';
if($a_set['grouped'] ||
$a_set['group_item'])
{
// #14941
$mode_suffix = '_INLINE';
if(!$a_set['group_item'])
{
$this->tpl->setVariable("COLL_MODE", "");
}
}
$mode = $a_set['mode_id'];
{
$this->tpl->setVariable("COLL_MODE".$mode_suffix, $a_set['mode']);
}
else
{
$this->tpl->setVariable("COLL_MODE".$mode_suffix, "");
$this->tpl->setVariable("COLL_MODE_DEACTIVATED".$mode_suffix, $a_set['mode']);
}
if($a_set["anonymized"])
{
$this->tpl->setVariable("ANONYMIZED".$mode_suffix, $this->lng->txt('trac_anonymized_info_short'));
}
if($mode_suffix)
{
$this->tpl->setVariable("COLL_MODE_LABEL", $this->lng->txt("trac_mode"));
}
}
else
{
$this->tpl->setVariable('COLL_LINK', $a_set['url']);
{
// handle tlt settings
$this->tpl->setCurrentBlock("tlt");
$this->tpl->setVariable("TXT_MONTH",$this->lng->txt('md_months'));
$this->tpl->setVariable("TXT_DAYS",$this->lng->txt('md_days'));
$this->tpl->setVariable("TXT_TIME",$this->lng->txt('md_time'));
$this->tpl->setVariable("TLT_HINT", '(hh:mm)');
// seconds to units
$mon = floor($a_set["tlt"]/(60*60*24*30));
$tlt = $a_set["tlt"]%(60*60*24*30);
$day = floor($tlt/(60*60*24));
$tlt = $tlt%(60*60*24);
$hr = floor($tlt/(60*60));
$tlt = $tlt%(60*60);
$min = floor($tlt/60);
$options = array();
for($i = 0;$i <= 24;$i++)
{
$options[$i] = sprintf('%02d',$i);
}
$this->tpl->setVariable("SEL_MONTHS",
ilUtil::formSelect($mon,'tlt['.$a_set['id'].'][mo]',$options,false,true));
for($i = 0;$i <= 31;$i++)
{
$options[$i] = sprintf('%02d',$i);
}
$this->tpl->setVariable("SEL_DAYS",
ilUtil::formSelect($day,'tlt['.$a_set['id'].'][d]',$options,false,true));
$this->tpl->setVariable("SEL_TLT",ilUtil::makeTimeSelect('tlt['.$a_set['id'].']',
true,$hr,$min,null,false));
$this->tpl->parseCurrentBlock();
}
}
}
// Assigned ?
$this->tpl->setVariable("ASSIGNED_IMG_OK", $a_set['status']
? ilUtil::getImagePath('icon_ok.svg')
: ilUtil::getImagePath('icon_not_ok.svg')
);
$this->tpl->setVariable("ASSIGNED_STATUS", $a_set['status']
? $this->lng->txt('trac_assigned')
: $this->lng->txt('trac_not_assigned')
);
$this->tpl->parseCurrentBlock();
// Parse grouped items
foreach((array) $a_set['grouped'] as $item)
{
$item['group_item'] = true;
$this->fillRow($item);
}
// show num obligatory info
if(count($a_set['grouped']))
{
$this->tpl->setCurrentBlock('num_passed_items');
$this->tpl->setVariable('MIN_PASSED_TXT', $this->lng->txt('trac_min_passed'));
$this->tpl->setVariable('NUM_OBLIGATORY', $a_set['num_obligatory']);
$this->tpl->setVariable('GRP_ID', $a_set['grouping_id']);
$this->tpl->parseCurrentBlock();
}
}

+ Here is the call graph for this function:

ilLPCollectionSettingsTableGUI::getMode ( )

Definition at line 42 of file class.ilLPCollectionSettingsTableGUI.php.

References $mode.

Referenced by fillRow(), initTable(), and parse().

{
return $this->mode;
}

+ Here is the caller graph for this function:

ilLPCollectionSettingsTableGUI::getNode ( )

Get node id of current learning progress item.

Returns
int $node_id

Definition at line 37 of file class.ilLPCollectionSettingsTableGUI.php.

References $node_id.

Referenced by __construct(), fillRow(), and parse().

{
}

+ Here is the caller graph for this function:

ilLPCollectionSettingsTableGUI::initTable ( )
protected

Definition at line 223 of file class.ilLPCollectionSettingsTableGUI.php.

References $ilCtrl, ilTable2GUI\addColumn(), ilTable2GUI\addCommandButton(), ilTable2GUI\addMultiCommand(), ilTableGUI\enable(), getMode(), ilLPObjSettings\LP_MODE_COLLECTION, ilLPObjSettings\LP_MODE_COLLECTION_MANUAL, ilLPObjSettings\LP_MODE_COLLECTION_TLT, ilLPObjSettings\LP_MODE_MANUAL_BY_TUTOR, ilLPObjSettings\LP_MODE_SCORM, ilTable2GUI\setDescription(), ilTable2GUI\setFormAction(), ilTable2GUI\setRowTemplate(), ilTable2GUI\setSelectAllCheckbox(), and ilTable2GUI\setTitle().

Referenced by parse().

{
global $ilCtrl;
$this->setFormAction($ilCtrl->getFormAction($this->getParentObject()));
switch($this->getMode())
{
$this->setRowTemplate('tpl.lp_collection_row.html', 'Services/Tracking');
$this->setTitle($this->lng->txt('trac_lp_determination'));
$this->setDescription($this->lng->txt('trac_lp_determination_info_crs'));
break;
$this->setRowTemplate('tpl.lp_collection_row.html', 'Services/Tracking');
$this->setTitle($this->lng->txt('trac_lp_determination_tutor'));
$this->setDescription($this->lng->txt('trac_lp_determination_info_crs_tutor'));
break;
$this->setRowTemplate('tpl.lp_collection_scorm_row.html', 'Services/Tracking');
$this->setTitle($this->lng->txt('trac_lp_determination'));
$this->setDescription($this->lng->txt('trac_lp_determination_info_sco'));
break;
$this->setRowTemplate('tpl.lp_collection_subitem_row.html', 'Services/Tracking');
$this->setTitle($this->lng->txt('trac_lp_determination'));
$this->setDescription($this->lng->txt('trac_lp_determination_info_crs'));
$this->lng->loadLanguageModule("meta");
$this->addCommandButton('updateTLT', $this->lng->txt('save'));
break;
}
$this->addColumn('','','1px');
$this->addColumn($this->lng->txt('item'), 'title', '50%');
{
$this->addColumn($this->lng->txt('trac_mode'), 'mode');
}
{
$this->addColumn($this->lng->txt('meta_typical_learning_time'), 'tlt');
}
{
$this->addMultiCommand('assign', $this->lng->txt('trac_collection_assign'));
$this->addMultiCommand('deassign', $this->lng->txt('trac_collection_deassign'));
$this->addColumn($this->lng->txt('trac_determines_learning_progress'), 'status');
}
else
{
$this->addMultiCommand('assign', $this->lng->txt('trac_manual_display'));
$this->addMultiCommand('deassign', $this->lng->txt('trac_manual_no_display'));
$this->addColumn($this->lng->txt('trac_manual_is_displayed'), 'status');
}
$this->enable('select_all');
$this->setSelectAllCheckbox('item_ids');
{
$this->addMultiCommand('groupMaterials', $this->lng->txt('trac_group_materials'));
}
}

+ Here is the call graph for this function:

+ Here is the caller graph for this function:

ilLPCollectionSettingsTableGUI::parse ( ilLPCollection  $a_collection)

Read and parse items.

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

References ilObject\_lookupObjId(), ilTable2GUI\addCommandButton(), ilTable2GUI\addMultiCommand(), getMode(), getNode(), ilLPCollectionOfRepositoryObjects\hasGroupedItems(), initTable(), ilLPObjSettings\LP_MODE_COLLECTION, and ilTable2GUI\setData().

Referenced by ilLPListOfSettingsGUI\getTableByMode().

{
$this->setData($a_collection->getTableGUIData($this->getNode()));
$this->initTable();
// grouping actions
{
$this->addMultiCommand('releaseMaterials', $this->lng->txt('trac_release_materials'));
foreach($this->row_data as $item)
{
if($item["grouped"])
{
$this->addCommandButton('saveObligatoryMaterials', $this->lng->txt('trac_group_materials_save'));
break;
}
}
}
}

+ Here is the call graph for this function:

+ Here is the caller graph for this function:

Field Documentation

ilLPCollectionSettingsTableGUI::$mode
private

Definition at line 15 of file class.ilLPCollectionSettingsTableGUI.php.

Referenced by fillRow(), and getMode().

ilLPCollectionSettingsTableGUI::$node_id
private

Definition at line 14 of file class.ilLPCollectionSettingsTableGUI.php.

Referenced by getNode().


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