ilLPProgressTableGUI Class Reference

TableGUI class for learning progress. More...

Inheritance diagram for ilLPProgressTableGUI:

Collaboration diagram for ilLPProgressTableGUI:

Public Member Functions
	__construct ($a_parent_obj, $a_parent_cmd, $a_type="", $a_user="", $a_objs="")
	Constructor.
	initFilter ()
	Init filter.
Public Member Functions inherited from ilTable2GUI
	__construct ($a_parent_obj, $a_parent_cmd="")
	Constructor.
&	executeCommand ()
	Execute command.
	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.
	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 disable filter hiding.
	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="")
	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
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.
	getLimit ()
	Get limit.
	setOffset ($a_offset)
	set dataset offset public
	getOffset ()
	Get offset.
	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 ($object_id)
	Fill table row.
Protected Member Functions inherited from ilTable2GUI
	prepareOutput ()
	Anything that must be done before HTML is generated.

Additional Inherited Members
Data Fields inherited from ilTableGUI
	$title
	$icon
	$icon_alt
	$help_page
	$help_icon
	$help_icon_alt
	$header_names
	$header_vars
	$linkbar_vars
	$data
	$column_count
	$column_width
	$max_count
	$limit
	$max_limit = false
	$offset
	$order_column
	$order_direction
	$footer_style
	$footer_previous
	$footer_next
	$lang_support = true
	$global_tpl
	$form_name
	$select_all_checkbox
	$action_buttons
	$prefix
	$base = ""
	$enabled
	$styles
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
	$mi_sel_buttons = null
	$disable_filter_hiding = false
	$top_commands = false

Detailed Description

TableGUI class for learning progress.

Author

Alex Killing alex..nosp@m.kill.nosp@m.ing@g.nosp@m.mx.d.nosp@m.e

Version

$Id$

ilLPProgressTableGUI: ilFormPropertyDispatchGUI

Definition at line 16 of file class.ilLPProgressTableGUI.php.

Constructor & Destructor Documentation

ilLPProgressTableGUI::__construct	(		$a_parent_obj,
			$a_parent_cmd,
			$a_type = "",
			$a_user = "",
			$a_objs = ""
	)

Constructor.

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

References $ilCtrl, $lng, ilTable2GUI\addColumn(), ilTable2GUI\addMultiCommand(), ilSearchSettings\getInstance(), initFilter(), ilTable2GUI\setEnableHeader(), ilTable2GUI\setEnableNumInfo(), ilTable2GUI\setEnableTitle(), ilTable2GUI\setFormAction(), ilTable2GUI\setId(), ilTableGUI\setLimit(), ilTable2GUI\setRowTemplate(), ilTable2GUI\setSelectAllCheckbox(), and ilTable2GUI\setTitle().

        {
                global $ilCtrl, $lng, $ilAccess, $lng;

                $this->tracked_user = $a_user;
                $this->objs = $a_objs;
                
                parent::__construct($a_parent_obj, $a_parent_cmd);
                $this->setTitle($this->lng->txt("learning_progress"));
                $this->setLimit(ilSearchSettings::getInstance()->getMaxHits());
                $this->setLimit(9999);
                
                $this->addColumn("", "", "1", true);
                $this->addColumn($this->lng->txt("trac_title_description"), "", "80%");
                $this->addColumn($this->lng->txt("status"), "", "10%");
                $this->addColumn($this->lng->txt("actions"), "", "10%");
                
                $this->setEnableHeader(true);
                $this->setFormAction($ilCtrl->getFormActionByClass("illpfiltergui"));
                $this->setRowTemplate("tpl.lp_progress_list_row.html", "Services/Tracking");
                #$this->disable("footer");
                $this->setEnableHeader(true);
                $this->setEnableNumInfo(true);
                $this->setEnableTitle(true);
                $this->setId("lp_table");
                $this->initFilter();

                $this->setSelectAllCheckbox("item_id");

                $this->addMultiCommand("hideSelected", $lng->txt("trac_hide_selected"));
                //$this->addCommandButton("", $lng->txt(""));
        }

Here is the call graph for this function:

Member Function Documentation

ilLPProgressTableGUI::fillRow (   $object_id )

protected

Fill table row.

Reimplemented from ilTable2GUI.

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

References $ilCtrl, $lng, ilLPItemListFactory\_getInstance(), and ilLearningProgressBaseGUI\_showImageByStatus().

        {
                global $lng, $ilObjDataCache, $ilCtrl;

                $this->tpl->setCurrentBlock("item_command");
                $ilCtrl->setParameterByClass('illpfiltergui','hide',$object_id);
                $this->tpl->setVariable("HREF_COMMAND", $ilCtrl->getLinkTargetByClass('illpfiltergui','hide'));
                $this->tpl->setVariable("TXT_COMMAND", $lng->txt('trac_hide'));
                $this->tpl->parseCurrentBlock();

                //$this->tpl->setVariable("", );
                
                $item_list = ilLPItemListFactory::_getInstance(0,$object_id,$ilObjDataCache->lookupType($object_id));
                $item_list->setCurrentUser($this->tracked_user->getId());
                $item_list->readUserInfo();
                $item_list->addCheckbox("");
                $item_list->setCmdClass(get_class($this->parent_obj));
                $item_list->addReferences($this->objs[$object_id]['ref_ids']);
                $item_list->enable('path');
                $item_list->renderSimpleProgress();
                
                // Hide link
                $this->tpl->setVariable("OBJ_ID", $object_id);
                $this->tpl->setVariable("ITEM_HTML",$item_list->getHTML());
                ilLearningProgressBaseGUI::_showImageByStatus($this->tpl,
                        $item_list->getUserStatus());
        }

Here is the call graph for this function:

ilLPProgressTableGUI::initFilter

(

)

Init filter.

Reimplemented from ilTable2GUI.

Definition at line 59 of file class.ilLPProgressTableGUI.php.

References $lng, ilTable2GUI\addFilterItem(), ilLPFilterGUI\getPossibleTypes(), ilTable2GUI\setDisableFilterHiding(), ilTextInputGUI\setMaxLength(), ilSelectInputGUI\setOptions(), ilRepositorySelectorInputGUI\setSelectText(), ilMultiSelectInputGUI\setValue(), and ilNonEditableValueGUI\setValue().

Referenced by __construct().

        {
                global $lng;
                
                $this->setDisableFilterHiding(true);
                
                include_once("./Services/Tracking/classes/class.ilLPFilterGUI.php");
                $filter_gui = new ilLPFilterGUI($this->tracked_user);
                
                // object type selection
                include_once("./Services/Tracking/classes/class.ilLPFilterGUI.php");
                $options = ilLPFilterGUI::getPossibleTypes();
                include_once("./Services/Form/classes/class.ilSelectInputGUI.php");
                $si = new ilSelectInputGUI($this->lng->txt("obj_type"), "type");
                $si->setOptions($options);
                $si->setValue($filter_gui->filter->getFilterType());
                $this->addFilterItem($si);

                // hidden items
                $options = $filter_gui->prepareHidden();
                $values = array_keys($options);
                if (count($options) > 0)
                {
                        include_once("./Services/Form/classes/class.ilMultiSelectInputGUI.php");
                        $msi = new ilMultiSelectInputGUI($lng->txt("trac_filter_hidden"), "hide");
                        $msi->setValue($values);
                        $msi->setOptions($options);
                        $this->addFilterItem($msi);
                }
                else
                {
                        include_once("./Services/Form/classes/class.ilNonEditableValueGUI.php");
                        $ne = new ilNonEditableValueGUI($lng->txt("trac_filter_hidden"),
                                "dummy");
                        $ne->setValue($lng->txt("none"));
                        $this->addFilterItem($ne);
                }

                // title/description
                include_once("./Services/Form/classes/class.ilTextInputGUI.php");
                $ti = new ilTextInputGUI($lng->txt("trac_title_description"), "query");
                $ti->setMaxLength(64);
                $ti->setSize(20);
                $ti->setValue($filter_gui->filter->getQueryString());
                $this->addFilterItem($ti);
                
                // repository area selection
                include_once("./Services/Form/classes/class.ilRepositorySelectorInputGUI.php");
                $rs = new ilRepositorySelectorInputGUI($lng->txt("trac_filter_area"), "area");
                $rs->setSelectText($lng->txt("trac_select_area"));
                $this->addFilterItem($rs);
                $rs->readFromSession();

        }

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:

• Services/Tracking/classes/class.ilLPProgressTableGUI.php