ILIAS
Release_4_1_x_branch Revision 61804
|
TableGUI class for learning progress. More...
Public Member Functions | |
__construct ($a_parent_obj, $a_parent_cmd="", $a_template_context="") | |
Constructor. | |
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 | |
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. | |
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. | |
fillHeaderExcel ($worksheet, &$a_row) | |
Excel Version of Fill Row. | |
fillRowExcel ($a_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 Attributes | |
$filter | |
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 = 4 | |
$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 = false | |
$nav_determined = false | |
$limit_determined = false | |
$filters_determined = false | |
$columns_determined = false | |
$export_formats | |
$export_mode | |
$print_mode |
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 |
TableGUI class for learning progress.
Definition at line 15 of file class.ilLPTableBaseGUI.php.
ilLPTableBaseGUI::__construct | ( | $a_parent_obj, | |
$a_parent_cmd = "" , |
|||
$a_template_context = "" |
|||
) |
Constructor.
Reimplemented from ilTable2GUI.
Reimplemented in ilTrMatrixTableGUI, and ilLPObjectsTableGUI.
Definition at line 19 of file class.ilLPTableBaseGUI.php.
|
protected |
Build path with deep-link.
array | $ref_ids |
Definition at line 228 of file class.ilLPTableBaseGUI.php.
References ilTableGUI\$data, $ilCtrl, $path, $ref_id, $result, and ilLink\_getLink().
Referenced by ilLPObjectsTableGUI\fillRow(), and ilLPProgressTableGUI\fillRow().
ilLPTableBaseGUI::executeCommand | ( | ) |
Execute command.
Reimplemented from ilTable2GUI.
Definition at line 27 of file class.ilLPTableBaseGUI.php.
References $_GET, $_POST, $ilCtrl, ilTable2GUI\determineOffsetAndOrder(), ilTable2GUI\determineSelectedFilters(), ilTable2GUI\getFilterItemByPostVar(), ilTable2GUI\resetFilter(), ilTable2GUI\resetOffset(), ilTable2GUI\storeNavParameter(), and ilTable2GUI\writeFilterToSession().
|
protected |
Add meta information to csv export.
Likely to be overwritten by derived class.
object | $a_csv | current file |
Reimplemented from ilTable2GUI.
Definition at line 546 of file class.ilLPTableBaseGUI.php.
References getExportMeta().
|
protected |
Add meta information to excel export.
Likely to be overwritten by derived class.
object | $a_worksheet | current sheet |
int | $a_row | row counter |
Reimplemented from ilTable2GUI.
Definition at line 535 of file class.ilLPTableBaseGUI.php.
References getExportMeta().
ilLPTableBaseGUI::getCurrentFilter | ( | $as_query = false | ) |
Definition at line 378 of file class.ilLPTableBaseGUI.php.
References $result, ilTable2GUI\getFilterItemByPostVar(), and IL_CAL_DATETIME.
Referenced by ilLPObjectsTableGUI\getItems(), ilLPProgressTableGUI\getItems(), ilTrObjectUsersPropsTableGUI\getItems(), ilTrSummaryTableGUI\getItems(), and initFilter().
|
protected |
Build export meta data.
Definition at line 506 of file class.ilLPTableBaseGUI.php.
References ilTableGUI\$data, $lng, ilLink\_getLink(), ilObjUser\_lookupFullname(), ilObject\_lookupOwner(), ilObject\_lookupType(), ilDatePresentation\formatDate(), IL_CAL_DATETIME, IL_CAL_UNIX, and ilDatePresentation\setUseRelativeDates().
Referenced by fillMetaCSV(), and fillMetaExcel().
|
protected |
Get possible subtypes.
Definition at line 270 of file class.ilLPTableBaseGUI.php.
References $lng.
Referenced by initFilter().
ilLPTableBaseGUI::initFilter | ( | ) |
Init filter.
Reimplemented from ilTable2GUI.
Reimplemented in ilTrObjectUsersPropsTableGUI, ilTrUserObjectsPropsTableGUI, and ilTrMatrixTableGUI.
Definition at line 164 of file class.ilLPTableBaseGUI.php.
References $lng, ilTable2GUI\addFilterItem(), getCurrentFilter(), getPossibleTypes(), ilTable2GUI\setDisableFilterHiding(), ilTextInputGUI\setMaxLength(), ilSelectInputGUI\setOptions(), and ilRepositorySelectorInputGUI\setSelectText().
Referenced by ilTrSummaryTableGUI\__construct(), ilLPObjectsTableGUI\__construct(), and ilLPProgressTableGUI\__construct().
|
protected |
Definition at line 467 of file class.ilLPTableBaseGUI.php.
References ilLPObjSettings\_lookupMode(), LP_MODE_OBJECTIVES, LP_MODE_SCORM, LP_MODE_TEST_PASSED, LP_MODE_TLT, and LP_MODE_VISITS.
Referenced by ilLPProgressTableGUI\fillRow(), ilTrUserObjectsPropsTableGUI\fillRow(), ilTrSummaryTableGUI\fillRow(), ilTrSummaryTableGUI\getItems(), and ilTrObjectUsersPropsTableGUI\getSelectableColumns().
|
protected |
Definition at line 479 of file class.ilLPTableBaseGUI.php.
References $lng, $user, ilLPObjSettings\_lookupMode(), ilLPObjSettings\_mode2Text(), ilObjectFactory\getInstanceByObjId(), ilTable2GUI\setDescription(), and ilTable2GUI\setTitle().
Referenced by ilTrSummaryTableGUI\__construct(), ilTrUserObjectsPropsTableGUI\__construct(), ilLPProgressTableGUI\__construct(), ilTrMatrixTableGUI\__construct(), and ilTrObjectUsersPropsTableGUI\__construct().
|
protected |
Reimplemented in ilTrSummaryTableGUI.
Definition at line 281 of file class.ilLPTableBaseGUI.php.
References $lng, $path, ilLearningProgressBaseGUI\_getImagePathForStatus(), ilLearningProgressBaseGUI\_getStatusText(), ilFormat\_secondsToString(), ilDatePresentation\formatDate(), IL_CAL_DATE, IL_CAL_DATETIME, IL_CAL_UNIX, and ilUtil\img().
Referenced by ilTrMatrixTableGUI\fillRow(), ilTrObjectUsersPropsTableGUI\fillRow(), ilTrMatrixTableGUI\fillRowCSV(), ilTrUserObjectsPropsTableGUI\fillRowCSV(), ilTrObjectUsersPropsTableGUI\fillRowCSV(), ilTrMatrixTableGUI\fillRowExcel(), ilTrUserObjectsPropsTableGUI\fillRowExcel(), and ilTrObjectUsersPropsTableGUI\fillRowExcel().
ilLPTableBaseGUI::searchFilterListener | ( | $a_ref_id, | |
$a_data | |||
) |
Listener for SearchResultFilter Checks wheather the object is hidden and mode is not LP_MODE_DEACTIVATED public.
Definition at line 147 of file class.ilLPTableBaseGUI.php.
References ilLPObjSettings\_lookupMode(), and LP_MODE_DEACTIVATED.
|
protected |
Search objects that match current filters.
array | $filter | |
string | $permission |
Definition at line 97 of file class.ilLPTableBaseGUI.php.
References $res, and QP_COMBINATION_OR.
Referenced by ilLPObjectsTableGUI\getItems(), and ilLPProgressTableGUI\getItems().
|
protected |
Definition at line 557 of file class.ilLPTableBaseGUI.php.
References ilTimingCache\_getTimings(), and ilTimingCache\_showWarning().
Referenced by ilLPProgressTableGUI\fillRow(), ilTrMatrixTableGUI\fillRow(), ilTrUserObjectsPropsTableGUI\fillRow(), and ilTrObjectUsersPropsTableGUI\fillRow().
|
protected |
Definition at line 17 of file class.ilLPTableBaseGUI.php.