ILIAS  Release_4_1_x_branch Revision 61804
 All Data Structures Namespaces Files Functions Variables Groups Pages
Public Member Functions | Protected Member Functions
ilLPObjectsTableGUI Class Reference

TableGUI class for learning progress (object overview) More...

+ Inheritance diagram for ilLPObjectsTableGUI:
+ Collaboration diagram for ilLPObjectsTableGUI:

Public Member Functions

 __construct ($a_parent_obj, $a_parent_cmd, $a_type="")
 Constructor.
 getItems ()
- Public Member Functions inherited from ilLPTableBaseGUI
 executeCommand ()
 Execute command.
 searchFilterListener ($a_ref_id, $a_data)
 Listener for SearchResultFilter Checks wheather the object is hidden and mode is not LP_MODE_DEACTIVATED public.
 initFilter ()
 Init filter.
 getCurrentFilter ($as_query=false)
- Public Member Functions inherited from ilTable2GUI
 determineLimit ()
 Determine the limit.
 getSelectableColumns ()
 Get selectable columns.
 determineSelectedColumns ()
 Determine selected columns.
 isColumnSelected ($a_col)
 Is given column selected?
 getSelectedColumns ()
 Get selected columns.
 resetOffset ($a_in_determination=false)
 Reset offset.
 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)
 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)
 Set filter command.
 getFilterCommand ()
 Get filter command.
 setResetCommand ($a_val)
 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= '')
 Add Command button.
 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.
- 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 table row.
 fillHeaderExcel ($worksheet, &$a_row)
 Excel Version of Fill Row.
 fillRowExcel ($worksheet, &$a_row, $a_set)
 Excel Version of Fill Row.
 fillHeaderCSV ($a_csv)
 CSV Version of Fill Header.
 fillRowCSV ($a_csv, $a_set)
 CSV Version of Fill Row.
- Protected Member Functions inherited from ilLPTableBaseGUI
 searchObjects (array $filter, $permission)
 Search objects that match current filters.
 buildPath ($ref_ids)
 Build path with deep-link.
 getPossibleTypes ()
 Get possible subtypes.
 parseValue ($id, $value, $type)
 isPercentageAvailable ($a_obj_id)
 parseTitle ($a_obj_id, $action, $a_user_id=false)
 getExportMeta ()
 Build export meta data.
 fillMetaExcel ($worksheet, &$a_row)
 Add meta information to excel export.
 fillMetaCSV ($a_csv)
 Add meta information to csv export.
 showTimingsWarning ($a_ref_id, $a_user_id)
- 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.

Additional Inherited Members

- 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 EXPORT_EXCEL = 1
const EXPORT_CSV = 2
- Protected Attributes inherited from ilLPTableBaseGUI
 $filter

Detailed Description

TableGUI class for learning progress (object overview)

Author
Stefan Meyer smeye.nosp@m.r.il.nosp@m.ias@g.nosp@m.mx.d.nosp@m.e
Version
$Id$

ilLPObjectsTableGUI: ilFormPropertyDispatchGUI

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

Constructor & Destructor Documentation

ilLPObjectsTableGUI::__construct (   $a_parent_obj,
  $a_parent_cmd,
  $a_type = "" 
)

Constructor.

Reimplemented from ilLPTableBaseGUI.

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

References $ilCtrl, $lng, ilLearningProgressBaseGUI\_getStatusText(), ilTable2GUI\addColumn(), ilTable2GUI\addMultiCommand(), ilSearchSettings\getInstance(), getItems(), ilLPTableBaseGUI\initFilter(), LP_STATUS_COMPLETED_NUM, LP_STATUS_FAILED_NUM, LP_STATUS_IN_PROGRESS_NUM, LP_STATUS_NOT_ATTEMPTED_NUM, ilTable2GUI\setDescription(), ilTable2GUI\setEnableHeader(), ilTable2GUI\setEnableNumInfo(), ilTable2GUI\setEnableTitle(), ilTable2GUI\setExportFormats(), ilTable2GUI\setFormAction(), ilTable2GUI\setId(), ilTableGUI\setLimit(), ilTable2GUI\setRowTemplate(), ilTable2GUI\setSelectAllCheckbox(), ilTable2GUI\setShowTemplates(), and ilTable2GUI\setTitle().

{
global $ilCtrl, $lng, $ilAccess, $lng;
$this->setId("lpobjtbl");
parent::__construct($a_parent_obj, $a_parent_cmd);
$this->setTitle($this->lng->txt("learning_progress"));
$this->setDescription($this->lng->txt("trac_learning_progress_objects_description"));
$this->setLimit(ilSearchSettings::getInstance()->getMaxHits());
$this->setLimit(9999);
$this->addColumn("", "", "1", true);
$this->addColumn($this->lng->txt("trac_title"), "title", "30%");
include_once("Services/Tracking/classes/class.ilLPStatus.php");
$all_status = array(LP_STATUS_NOT_ATTEMPTED_NUM => "status_not_attempted",
LP_STATUS_IN_PROGRESS_NUM => "status_in_progress",
LP_STATUS_COMPLETED_NUM => "status_completed",
LP_STATUS_FAILED_NUM => "status_failed");
foreach($all_status as $status => $column)
{
$caption = ilLearningProgressBaseGUI::_getStatusText($status);
$caption = "<img src=\"".ilLearningProgressBaseGUI::_getImagePathForStatus($status)."\" alt=\"".$caption."\" title=\"".$caption."\" /> ".$caption;
$this->addColumn($caption, $column, "10%");
}
$this->addColumn($this->lng->txt("path"), "", "20%");
$this->addColumn($this->lng->txt("actions"), "", "10%");
$this->setEnableHeader(true);
$this->setFormAction($ilCtrl->getFormActionByClass(get_class($this)));
$this->setRowTemplate("tpl.lp_object_list_row.html", "Services/Tracking");
#$this->disable("footer");
$this->setEnableHeader(true);
$this->setEnableNumInfo(true);
$this->setEnableTitle(true);
$this->setShowTemplates(true);
$this->initFilter();
$this->setSelectAllCheckbox("item_id");
$this->addMultiCommand("hideSelected", $lng->txt("trac_hide_selected"));
$this->setExportFormats(array(self::EXPORT_CSV, self::EXPORT_EXCEL));
$this->getItems();
}

+ Here is the call graph for this function:

Member Function Documentation

ilLPObjectsTableGUI::fillHeaderCSV (   $a_csv)
protected

CSV Version of Fill Header.

Likely to be overwritten by derived class.

Parameters
object$a_csvcurrent file

Reimplemented from ilTable2GUI.

Definition at line 172 of file class.ilLPObjectsTableGUI.php.

References ilLearningProgressBaseGUI\_getStatusText(), LP_STATUS_COMPLETED_NUM, LP_STATUS_FAILED_NUM, LP_STATUS_IN_PROGRESS_NUM, and LP_STATUS_NOT_ATTEMPTED_NUM.

{
$a_csv->addColumn($this->lng->txt("type"));
$a_csv->addColumn($this->lng->txt("trac_title"));
$a_csv->addColumn(ilLearningProgressBaseGUI::_getStatusText(LP_STATUS_NOT_ATTEMPTED_NUM));
$a_csv->addColumn(ilLearningProgressBaseGUI::_getStatusText(LP_STATUS_IN_PROGRESS_NUM));
$a_csv->addColumn(ilLearningProgressBaseGUI::_getStatusText(LP_STATUS_COMPLETED_NUM));
$a_csv->addColumn(ilLearningProgressBaseGUI::_getStatusText(LP_STATUS_FAILED_NUM));
// $a_csv->addColumn($this->lng->txt("path"));
$a_csv->addRow();
}

+ Here is the call graph for this function:

ilLPObjectsTableGUI::fillHeaderExcel (   $worksheet,
&  $a_row 
)
protected

Excel Version of Fill Row.

Likely to be overwritten by derived class.

Parameters
object$a_worksheetcurrent sheet
int$a_rowrow counter

Reimplemented from ilTable2GUI.

Definition at line 136 of file class.ilLPObjectsTableGUI.php.

References ilLearningProgressBaseGUI\_getStatusText(), LP_STATUS_COMPLETED_NUM, LP_STATUS_FAILED_NUM, LP_STATUS_IN_PROGRESS_NUM, and LP_STATUS_NOT_ATTEMPTED_NUM.

{
$worksheet->write($a_row, 0, $this->lng->txt("type"));
$worksheet->write($a_row, 1, $this->lng->txt("trac_title"));
$worksheet->write($a_row, 2, ilLearningProgressBaseGUI::_getStatusText(LP_STATUS_NOT_ATTEMPTED_NUM));
$worksheet->write($a_row, 3, ilLearningProgressBaseGUI::_getStatusText(LP_STATUS_IN_PROGRESS_NUM));
$worksheet->write($a_row, 4, ilLearningProgressBaseGUI::_getStatusText(LP_STATUS_COMPLETED_NUM));
$worksheet->write($a_row, 5, ilLearningProgressBaseGUI::_getStatusText(LP_STATUS_FAILED_NUM));
// $worksheet->write($a_row, 6, $this->lng->txt("path"));
}

+ Here is the call graph for this function:

ilLPObjectsTableGUI::fillRow (   $a_set)
protected

Fill table row.

Reimplemented from ilTable2GUI.

Definition at line 91 of file class.ilLPObjectsTableGUI.php.

References $ilCtrl, $lng, $path, $ref_id, ilLPTableBaseGUI\buildPath(), and ilUtil\getTypeIconPath().

{
global $lng, $ilObjDataCache, $ilCtrl;
$this->tpl->setVariable("OBJ_ID", $a_set["obj_id"]);
$this->tpl->setVariable("ICON_SRC", ilUtil::getTypeIconPath($a_set["type"], $a_set["obj_id"], "tiny"));
$this->tpl->setVariable("ICON_ALT", $lng->txt($a_set["type"]));
$this->tpl->setVariable("TITLE_TEXT", $a_set["title"]);
$this->tpl->setVariable("STATUS_NOT_ATTEMPTED_VALUE", $a_set["status_not_attempted"]);
$this->tpl->setVariable("STATUS_IN_PROGRESS_VALUE", $a_set["status_in_progress"]);
$this->tpl->setVariable("STATUS_COMPLETED_VALUE", $a_set["status_completed"]);
$this->tpl->setVariable("STATUS_FAILED_VALUE", $a_set["status_failed"]);
// path
$path = $this->buildPath($a_set["ref_ids"]);
if($path)
{
$this->tpl->setCurrentBlock("item_path");
foreach($path as $path_item)
{
$this->tpl->setVariable("PATH_ITEM", $path_item);
$this->tpl->parseCurrentBlock();
}
}
// hide / unhide?!
$this->tpl->setCurrentBlock("item_command");
$ilCtrl->setParameterByClass(get_class($this),'hide', $a_set["obj_id"]);
$this->tpl->setVariable("HREF_COMMAND", $ilCtrl->getLinkTargetByClass(get_class($this),'hide'));
$this->tpl->setVariable("TXT_COMMAND", $lng->txt('trac_hide'));
$this->tpl->parseCurrentBlock();
if(!$this->is_anonymized)
{
$ref_id = $a_set["ref_ids"];
$ref_id = array_shift($ref_id);
$ilCtrl->setParameterByClass($ilCtrl->getCmdClass(), 'details_id', $ref_id);
$this->tpl->setVariable("HREF_COMMAND", $ilCtrl->getLinkTargetByClass($ilCtrl->getCmdClass(), 'details'));
$ilCtrl->setParameterByClass($ilCtrl->getCmdClass(), 'details_id', '');
$this->tpl->setVariable("TXT_COMMAND", $lng->txt('trac_participants'));
$this->tpl->parseCurrentBlock();
}
}

+ Here is the call graph for this function:

ilLPObjectsTableGUI::fillRowCSV (   $a_csv,
  $a_set 
)
protected

CSV Version of Fill Row.

Most likely to be overwritten by derived class.

Parameters
object$a_csvcurrent file
array$a_setdata array

Reimplemented from ilTable2GUI.

Definition at line 184 of file class.ilLPObjectsTableGUI.php.

{
$a_csv->addColumn($this->lng->txt($a_set["type"]));
$a_csv->addColumn($a_set["title"]);
$a_csv->addColumn($a_set["status_not_attempted"]);
$a_csv->addColumn($a_set["status_in_progress"]);
$a_csv->addColumn($a_set["status_completed"]);
$a_csv->addColumn($a_set["status_failed"]);
/*
// path
$path = $this->buildPath($a_set["ref_ids"]);
if($path)
{
$col = 6;
foreach($path as $path_item)
{
$a_csv->addColumn(strip_tags($path_item));
$col++;
}
}
*/
$a_csv->addRow();
}
ilLPObjectsTableGUI::fillRowExcel (   $a_worksheet,
&  $a_row,
  $a_set 
)
protected

Excel Version of Fill Row.

Most likely to be overwritten by derived class.

Parameters
object$a_worksheetcurrent sheet
int$a_rowrow counter
array$a_setdata array

Reimplemented from ilTable2GUI.

Definition at line 147 of file class.ilLPObjectsTableGUI.php.

{
$worksheet->write($a_row, 0, $this->lng->txt($a_set["type"]));
$worksheet->write($a_row, 1, $a_set["title"]);
$worksheet->write($a_row, 2, $a_set["status_not_attempted"]);
$worksheet->write($a_row, 3, $a_set["status_in_progress"]);
$worksheet->write($a_row, 4, $a_set["status_completed"]);
$worksheet->write($a_row, 5, $a_set["status_failed"]);
/*
// path
$path = $this->buildPath($a_set["ref_ids"]);
if($path)
{
$col = 6;
foreach($path as $path_item)
{
$worksheet->write($a_row, $col, strip_tags($path_item));
$col++;
}
}
*/
}
ilLPObjectsTableGUI::getItems ( )

Definition at line 71 of file class.ilLPObjectsTableGUI.php.

References ilTableGUI\$data, ilObjUserTracking\_enabledUserRelatedData(), ilLPTableBaseGUI\getCurrentFilter(), ilTrQuery\getObjectsStatus(), ilLPTableBaseGUI\searchObjects(), and ilTable2GUI\setData().

Referenced by __construct().

{
$obj_ids = $this->obj_ids;
if(!$obj_ids)
{
$obj_ids = $this->searchObjects($this->getCurrentFilter(true), "edit_learning_progress");
}
if($obj_ids)
{
$this->is_anonymized = !ilObjUserTracking::_enabledUserRelatedData();
include_once("./Services/Tracking/classes/class.ilTrQuery.php");
$data = ilTrQuery::getObjectsStatus($obj_ids);
$this->setData($data);
}
}

+ Here is the call graph for this function:

+ Here is the caller graph for this function:

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