ilAccountCodesTableGUI Class Reference

TableGUI class for account codes. More...

Inheritance diagram for ilAccountCodesTableGUI:

Collaboration diagram for ilAccountCodesTableGUI:

Public Member Functions
	__construct ($a_parent_obj, $a_parent_cmd)
	Constructor.
	getItems ()
	Get user items.
	initFilter ()
	Init filter.
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.
	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 ($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 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.

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

TableGUI class for account codes.

Author

Jörg Lützenkirchen luetz.nosp@m.enki.nosp@m.rchen.nosp@m.@lei.nosp@m.fos.c.nosp@m.om

Version

$Id$

ilAccountCodesTableGUI:

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

Constructor & Destructor Documentation

ilAccountCodesTableGUI::__construct	(		$a_parent_obj,
			$a_parent_cmd
	)

Constructor.

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

References $ilCtrl, $lng, ilTable2GUI\addColumn(), ilTable2GUI\addCommandButtonInstance(), ilTable2GUI\addMultiCommand(), ilSubmitButton\getInstance(), getItems(), 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("user_account_code");
                
                parent::__construct($a_parent_obj, $a_parent_cmd);
                
                $this->addColumn("", "", "1", true);
                $this->addColumn($lng->txt("user_account_code"), "code");
                $this->addColumn($lng->txt("user_account_code_valid_until"), "valid_until");
                $this->addColumn($lng->txt("user_account_code_generated"), "generated");
                $this->addColumn($lng->txt("user_account_code_used"), "used");          
                                
                $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/User");
                $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"));
                
                include_once "Services/UIComponent/Button/classes/class.ilSubmitButton.php";
                $button = ilSubmitButton::getInstance();
                $button->setCaption("user_account_codes_export");
                $button->setCommand("exportCodes");
                $button->setOmitPreventDoubleSubmission(true);          
                $this->addCommandButtonInstance($button);
                
                $this->getItems();
        }

Here is the call graph for this function:

Member Function Documentation

ilAccountCodesTableGUI::fillRow (   $code )

protected

Fill table row.

Reimplemented from ilTable2GUI.

Definition at line 168 of file class.ilAccountCodesTableGUI.php.

        {
                $this->tpl->setVariable("ID", $code["code_id"]);
                $this->tpl->setVariable("VAL_CODE", $code["code"]);
                $this->tpl->setVariable("VAL_VALID_UNTIL", $code["valid_until"]);
                $this->tpl->setVariable("VAL_GENERATED", $code["generated"]);
                $this->tpl->setVariable("VAL_USED", $code["used"]);
        }

ilAccountCodesTableGUI::getItems

(

)

Get user items.

Definition at line 63 of file class.ilAccountCodesTableGUI.php.

References $lng, $result, $valid, ilTable2GUI\determineOffsetAndOrder(), ilDatePresentation\formatDate(), ilAccountCode\getCodesData(), ilTable2GUI\getLimit(), ilTable2GUI\getOffset(), ilTableGUI\getOrderDirection(), ilTable2GUI\getOrderField(), IL_CAL_DATE, IL_CAL_UNIX, ilTable2GUI\resetOffset(), ilTable2GUI\setData(), ilTableGUI\setMaxCount(), and ilUtil\stripSlashes().

Referenced by __construct().

        {
                global $lng, $rbacreview, $ilObjDataCache;

                $this->determineOffsetAndOrder();
                
                include_once("./Services/User/classes/class.ilAccountCode.php");
                
                $codes_data = ilAccountCode::getCodesData(
                        ilUtil::stripSlashes($this->getOrderField()),
                        ilUtil::stripSlashes($this->getOrderDirection()),
                        ilUtil::stripSlashes($this->getOffset()),
                        ilUtil::stripSlashes($this->getLimit()),
                        $this->filter["code"],
                        $this->filter["valid_until"],
                        $this->filter["generated"]
                        );
                        
                if (count($codes_data["set"]) == 0 && $this->getOffset() > 0)
                {
                        $this->resetOffset();
                        $codes_data = ilAccountCode::getCodesData(
                                ilUtil::stripSlashes($this->getOrderField()),
                                ilUtil::stripSlashes($this->getOrderDirection()),
                                ilUtil::stripSlashes($this->getOffset()),
                                ilUtil::stripSlashes($this->getLimit()),
                                $this->filter["code"],
                                $this->filter["valid_until"],
                                $this->filter["generated"]
                                );
                }
                
                $result = array();
                foreach ($codes_data["set"] as $k => $code)
                {
                        $result[$k]["generated"] = ilDatePresentation::formatDate(new ilDateTime($code["generated"],IL_CAL_UNIX));

                        if($code["used"])
                        {
                                $result[$k]["used"] = ilDatePresentation::formatDate(new ilDateTime($code["used"],IL_CAL_UNIX));
                        }
                        else
                        {
                                $result[$k]["used"] = "";
                        }
                        
                        if($code["valid_until"] === "0")
                        {
                                $valid = $lng->txt("user_account_code_valid_until_unlimited");
                        }
                        else if(is_numeric($code["valid_until"]))
                        {
                                $valid = $code["valid_until"]." ".($code["valid_until"] == 1 ? $lng->txt("day") : $lng->txt("days"));
                        }
                        else
                        {
                                $valid = ilDatePresentation::formatDate(new ilDate($code["valid_until"], IL_CAL_DATE));
                        }
                        $result[$k]["valid_until"] = $valid;                    
                        
                        $result[$k]["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:

ilAccountCodesTableGUI::initFilter

(

)

Init filter.

Reimplemented from ilTable2GUI.

Definition at line 135 of file class.ilAccountCodesTableGUI.php.

References $ilUser, $lng, $options, $si, ilTable2GUI\addFilterItem(), ilAccountCode\CODE_LENGTH, ilDatePresentation\formatDate(), ilAccountCode\getGenerationDates(), IL_CAL_UNIX, and ilTextInputGUI\setMaxLength().

Referenced by __construct().

        {
                global $lng, $rbacreview, $ilUser;
                
                include_once("./Services/User/classes/class.ilAccountCode.php");
                
                // code
                include_once("./Services/Form/classes/class.ilTextInputGUI.php");
                $ti = new ilTextInputGUI($lng->txt("user_account_code"), "query");
                $ti->setMaxLength(ilAccountCode::CODE_LENGTH);
                $ti->setSize(20);
                $ti->setSubmitFormOnEnter(true);
                $this->addFilterItem($ti);
                $ti->readFromSession();
                $this->filter["code"] = $ti->getValue();
                
                // generated
                include_once("./Services/Form/classes/class.ilSelectInputGUI.php");
                $options = array("" => $lng->txt("user_account_code_generated_all"));
                foreach((array)ilAccountCode::getGenerationDates() as $date)
                {
                        $options[$date] = ilDatePresentation::formatDate(new ilDateTime($date,IL_CAL_UNIX));
                }
                $si = new ilSelectInputGUI($lng->txt("user_account_code_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/User/classes/class.ilAccountCodesTableGUI.php