ilRegistrationCodesTableGUI Class Reference

TableGUI class for registration codes. More...

Inheritance diagram for ilRegistrationCodesTableGUI:

Collaboration diagram for ilRegistrationCodesTableGUI:

Public Member Functions
	__construct ($a_parent_obj, $a_parent_cmd)
	Constructor.
	getItems ()
	Get user items.
	initFilter ()
	Init filter.
	getSelectedColumns ()
	Get selected columns.
Public Member Functions inherited from ilTable2GUI
	__construct ($a_parent_obj, $a_parent_cmd="", $a_template_context="")
	Constructor.
	determineLimit ()
	Determine the limit.
	getSelectableColumns ()
	Get selectable columns.
	determineSelectedColumns ()
	Determine selected columns.
	isColumnSelected ($a_col)
	Is given column selected?
&	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.
	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 ($code)
	Fill table row.
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 Row.
	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.

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

Detailed Description

TableGUI class for registration codes.

Author

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

Version

$Id$

ilRegistrationCodesTableGUI:

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

Constructor & Destructor Documentation

ilRegistrationCodesTableGUI::__construct	(		$a_parent_obj,
			$a_parent_cmd
	)

Constructor.

Definition at line 21 of file class.ilRegistrationCodesTableGUI.php.

References $ilCtrl, $lng, ilTable2GUI\addColumn(), ilTable2GUI\addCommandButton(), ilTable2GUI\addMultiCommand(), getItems(), getSelectedColumns(), initFilter(), ilTable2GUI\setDefaultOrderDirection(), ilTable2GUI\setDefaultOrderField(), ilTable2GUI\setEnableHeader(), ilTable2GUI\setEnableTitle(), ilTable2GUI\setExternalSegmentation(), ilTable2GUI\setExternalSorting(), ilTable2GUI\setFilterCommand(), ilTable2GUI\setFormAction(), ilTable2GUI\setId(), ilTable2GUI\setResetCommand(), ilTable2GUI\setRowTemplate(), ilTable2GUI\setSelectAllCheckbox(), and ilTable2GUI\setTopCommands().

        {
                global $ilCtrl, $lng;
                
                $this->setId("registration_code");
                
                parent::__construct($a_parent_obj, $a_parent_cmd);
                
                $this->addColumn("", "", "1", true);
                foreach ($this->getSelectedColumns() as $c)
                {
                        $this->addColumn($this->lng->txt($c), $c);
                }
                                
                $this->setExternalSorting(true);
                $this->setExternalSegmentation(true);
                $this->setEnableHeader(true);
                $this->setFormAction($ilCtrl->getFormAction($this->parent_obj, "listCodes"));
                $this->setRowTemplate("tpl.code_list_row.html", "Services/Registration");
                $this->setEnableTitle(true);
                $this->initFilter();
                $this->setFilterCommand("applyCodesFilter");
                $this->setResetCommand("resetCodesFilter");
                $this->setDefaultOrderField("generated");
                $this->setDefaultOrderDirection("desc");

                $this->setSelectAllCheckbox("id[]");
                $this->setTopCommands(true);
                $this->addMultiCommand("deleteConfirmation", $lng->txt("delete"));
                
                $this->addCommandButton("exportCodes", $lng->txt("registration_codes_export"));
                
                $this->getItems();
        }

Here is the call graph for this function:

Member Function Documentation

ilRegistrationCodesTableGUI::fillRow (   $code )

protected

Fill table row.

Reimplemented from ilTable2GUI.

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

References getSelectedColumns().

        {
                $this->tpl->setVariable("ID", $code["code_id"]);
                foreach ($this->getSelectedColumns() as $c)
                {
                        $this->tpl->setVariable("VAL_".strtoupper($c), $code[$c]);
                }
        }

Here is the call graph for this function:

ilRegistrationCodesTableGUI::getItems

(

)

Get user items.

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

References $lng, ilObjRole\_lookupRegisterAllowed(), ilTable2GUI\determineOffsetAndOrder(), ilDatePresentation\formatDate(), ilRegistrationCode\getCodesData(), ilTable2GUI\getLimit(), ilTable2GUI\getOffset(), ilTableGUI\getOrderDirection(), ilTable2GUI\getOrderField(), IL_CAL_UNIX, ilTable2GUI\resetOffset(), ilTable2GUI\setData(), ilTableGUI\setMaxCount(), and ilUtil\stripSlashes().

Referenced by __construct().

        {
                global $lng;

                $this->determineOffsetAndOrder();
                
                include_once("./Services/Registration/classes/class.ilRegistrationCode.php");
        
                $order_map = array(
                        "registration_code" => "code",
                        "role" => "role", 
                        "registration_generated" => "generated", 
                        "registration_used" => "used"                   
                );
                
                $codes_data = ilRegistrationCode::getCodesData(
                        ilUtil::stripSlashes($order_map[$this->getOrderField()]),
                        ilUtil::stripSlashes($this->getOrderDirection()),
                        ilUtil::stripSlashes($this->getOffset()),
                        ilUtil::stripSlashes($this->getLimit()),
                        $this->filter["code"],
                        $this->filter["role"],
                        $this->filter["generated"]
                        );
                        
                if (count($codes_data["set"]) == 0 && $this->getOffset() > 0)
                {
                        $this->resetOffset();
                        $codes_data = ilRegistrationCode::getCodesData(
                                ilUtil::stripSlashes($this->getOrderField()),
                                ilUtil::stripSlashes($this->getOrderDirection()),
                                ilUtil::stripSlashes($this->getOffset()),
                                ilUtil::stripSlashes($this->getLimit()),
                                $this->filter["code"],
                                $this->filter["role"],
                                $this->filter["generated"]
                                );
                }
                
                include_once './Services/AccessControl/classes/class.ilObjRole.php';
                $role_map = array();
                foreach(ilObjRole::_lookupRegisterAllowed() as $role)
                {
                        $role_map[$role['id']] = $role['title'];
                }

                $result = array();
                foreach ($codes_data["set"] as $k => $code)
                {
                        $result[$k]["registration_generated"] = ilDatePresentation::formatDate(new ilDateTime($code["generated"],IL_CAL_UNIX));

                        if($code["used"])
                        {
                                $result[$k]["registration_used"] = ilDatePresentation::formatDate(new ilDateTime($code["used"],IL_CAL_UNIX));
                        }
                        else
                        {
                                $result[$k]["registration_used"] = "";
                        }

                        $result[$k]["role"] = $role_map[$code["role"]];
                        $result[$k]["registration_code"] = $code["code"];
                        $result[$k]["code_id"] = $code["code_id"];
                }
                
                $this->setMaxCount($codes_data["cnt"]);
                $this->setData($result);
        }

Here is the call graph for this function:

Here is the caller graph for this function:

ilRegistrationCodesTableGUI::getSelectedColumns

(

)

Get selected columns.

Parameters

@return

Reimplemented from ilTable2GUI.

Definition at line 176 of file class.ilRegistrationCodesTableGUI.php.

Referenced by __construct(), and fillRow().

        {
                return array("registration_code", "role", "registration_generated", "registration_used");
        }

Here is the caller graph for this function:

ilRegistrationCodesTableGUI::initFilter

(

)

Init filter.

Reimplemented from ilTable2GUI.

Definition at line 132 of file class.ilRegistrationCodesTableGUI.php.

References $lng, ilObjRole\_lookupRegisterAllowed(), ilTable2GUI\addFilterItem(), ilRegistrationCode\CODE_LENGTH, ilDatePresentation\formatDate(), ilRegistrationCode\getGenerationDates(), IL_CAL_UNIX, ilTextInputGUI\setMaxLength(), and ilSelectInputGUI\setOptions().

Referenced by __construct().

        {
                global $lng, $rbacreview, $ilUser;
                
                include_once("./Services/Registration/classes/class.ilRegistrationCode.php");
                
                // code
                include_once("./Services/Form/classes/class.ilTextInputGUI.php");
                $ti = new ilTextInputGUI($lng->txt("registration_code"), "query");
                $ti->setMaxLength(ilRegistrationCode::CODE_LENGTH);
                $ti->setSize(20);
                $ti->setSubmitFormOnEnter(true);
                $this->addFilterItem($ti);
                $ti->readFromSession();
                $this->filter["code"] = $ti->getValue();
                
                // role
                include_once("./Services/Form/classes/class.ilSelectInputGUI.php");
                include_once './Services/AccessControl/classes/class.ilObjRole.php';
                $options = array("" => $this->lng->txt("registration_roles_all"));
                foreach(ilObjRole::_lookupRegisterAllowed() as $role)
                {
                        $options[$role['id']] = $role['title'];
                }
                $si = new ilSelectInputGUI($this->lng->txt("role"), "role");
                $si->setOptions($options);
                $this->addFilterItem($si);
                $si->readFromSession();
                $this->filter["role"] = $si->getValue();
                
                // generated
                include_once("./Services/Form/classes/class.ilSelectInputGUI.php");
                $options = array("" => $this->lng->txt("registration_generated_all"));
                foreach((array)ilRegistrationCode::getGenerationDates() as $date)
                {
                        $options[$date] = ilDatePresentation::formatDate(new ilDateTime($date,IL_CAL_UNIX));
                }
                $si = new ilSelectInputGUI($this->lng->txt("registration_generated"), "generated");
                $si->setOptions($options);
                $this->addFilterItem($si);
                $si->readFromSession();
                $this->filter["generated"] = $si->getValue();
        }

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/Registration/classes/class.ilRegistrationCodesTableGUI.php