ILIAS  release_5-1 Revision 5.0.0-5477-g43f3e3fab5f
ilShoppingCartTableGUI Class Reference

Class ilShoppingCartTableGUI. More...

+ Inheritance diagram for ilShoppingCartTableGUI:
+ Collaboration diagram for ilShoppingCartTableGUI:

Public Member Functions

 __construct ($a_parent_obj, $a_parent_cmd="")
 Constructor. More...
 
 fillRow ($a_set)
 Fill row. More...
 
 setTotalData ($a_key, $a_value)
 set total data More...
 
 getTotalData ()
 
 getCartHTML ()
 Get HTML: only for shoppingcarts does the same as getHTML of table2gui but additional. More...
 
- Public Member Functions inherited from ilTable2GUI
 __construct ($a_parent_obj, $a_parent_cmd="", $a_template_context="")
 Constructor. More...
 
 setOpenFormTag ($a_val)
 Set open form tag. More...
 
 getOpenFormTag ()
 Get open form tag. More...
 
 setCloseFormTag ($a_val)
 Set close form tag. More...
 
 getCloseFormTag ()
 Get close form tag. More...
 
 determineLimit ()
 Determine the limit. More...
 
 getSelectableColumns ()
 Get selectable columns. More...
 
 determineSelectedColumns ()
 Determine selected columns. More...
 
 isColumnSelected ($a_col)
 Is given column selected? More...
 
 getSelectedColumns ()
 Get selected columns. More...
 
executeCommand ()
 Execute command. More...
 
 resetOffset ($a_in_determination=false)
 Reset offset. More...
 
 initFilter ()
 Init filter. More...
 
 getParentObject ()
 Get parent object. More...
 
 getParentCmd ()
 Get parent command. More...
 
 setTopAnchor ($a_val)
 Set top anchor. More...
 
 getTopAnchor ()
 Get top anchor. More...
 
 setNoEntriesText ($a_text)
 Set text for an empty table. More...
 
 getNoEntriesText ()
 Get text for an empty table. More...
 
 setIsDataTable ($a_val)
 Set is data table. More...
 
 getIsDataTable ()
 Get is data table. More...
 
 setEnableTitle ($a_enabletitle)
 Set Enable Title. More...
 
 getEnableTitle ()
 Get Enable Title. More...
 
 setEnableHeader ($a_enableheader)
 Set Enable Header. More...
 
 getEnableHeader ()
 Get Enable Header. More...
 
 setEnableNumInfo ($a_val)
 Set enable num info. More...
 
 getEnableNumInfo ()
 Get enable num info. More...
 
 setTitle ($a_title, $a_icon=0, $a_icon_alt=0)
 Set title and title icon. More...
 
 setDescription ($a_val)
 Set description. More...
 
 getDescription ()
 Get description. More...
 
 setOrderField ($a_order_field)
 set order column More...
 
 getOrderField ()
 
 setData ($a_data)
 set table data @access public More...
 
 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) @access public More...
 
 getPrefix ()
 
 addFilterItem ($a_input_item, $a_optional=false)
 Add filter item. More...
 
 addFilterItemByMetaType ($id, $type=self::FILTER_TEXT, $a_optional=false, $caption=NULL)
 Add filter by standard type. More...
 
 getFilterItems ($a_optionals=false)
 Get filter items. More...
 
 getFilterItemByPostVar ($a_post_var)
 
 setFilterCols ($a_val)
 Set filter columns. More...
 
 getFilterCols ()
 Get filter columns. More...
 
 setDisableFilterHiding ($a_val=true)
 Set disable filter hiding. More...
 
 getDisableFilterHiding ()
 Get disable filter hiding
More...
 
 isFilterSelected ($a_col)
 Is given filter selected? More...
 
 getSelectedFilters ()
 Get selected filters. More...
 
 determineSelectedFilters ()
 Determine selected filters. More...
 
 setCustomPreviousNext ($a_prev_link, $a_next_link)
 Set custom previous/next links. More...
 
 setFormAction ($a_form_action, $a_multipart=false)
 Set Form action parameter. More...
 
 getFormAction ()
 Get Form action parameter. More...
 
 setFormName ($a_formname)
 Set Form name. More...
 
 getFormName ()
 Get Form name. More...
 
 setId ($a_val)
 Set id. More...
 
 getId ()
 Get element id. More...
 
 setDisplayAsBlock ($a_val)
 Set display as block. More...
 
 getDisplayAsBlock ()
 Get display as block. More...
 
 getSelectAllCheckbox ()
 Get the name of the checkbox that should be toggled with a select all button. More...
 
 setSelectAllCheckbox ($a_select_all_checkbox)
 Set the name of the checkbox that should be toggled with a select all button. More...
 
 setExternalSorting ($a_val)
 Set external sorting. More...
 
 getExternalSorting ()
 Get external sorting. More...
 
 setFilterCommand ($a_val, $a_caption=null)
 Set filter command. More...
 
 getFilterCommand ()
 Get filter command. More...
 
 setResetCommand ($a_val, $a_caption=null)
 Set reset filter command. More...
 
 getResetCommand ()
 Get reset filter command. More...
 
 setExternalSegmentation ($a_val)
 Set external segmentation. More...
 
 getExternalSegmentation ()
 Get external segmentation. More...
 
 setRowTemplate ($a_template, $a_template_dir="")
 Set row template. More...
 
 setDefaultOrderField ($a_defaultorderfield)
 Set Default order field. More...
 
 getDefaultOrderField ()
 Get Default order field. More...
 
 setDefaultOrderDirection ($a_defaultorderdirection)
 Set Default order direction. More...
 
 getDefaultOrderDirection ()
 Get Default order direction. More...
 
 clearCommandButtons ()
 
 addCommandButton ($a_cmd, $a_text, $a_onclick='', $a_id="", $a_class=null)
 Add Command button. More...
 
 addCommandButtonInstance (ilButtonBase $a_button)
 Add Command button instance. More...
 
 addSelectionButton ($a_sel_var, $a_options, $a_cmd, $a_text, $a_default_selection='')
 Add Selection List + Command button. More...
 
 addMultiItemSelectionButton ($a_sel_var, $a_options, $a_cmd, $a_text, $a_default_selection='')
 Add Selection List + Command button for selected items. More...
 
 setCloseCommand ($a_link)
 Add command for closing table. More...
 
 addMultiCommand ($a_cmd, $a_text)
 Add Command button. More...
 
 addHiddenInput ($a_name, $a_value)
 Add Hidden Input field. More...
 
 addHeaderCommand ($a_href, $a_text, $a_target="", $a_img="")
 Add Header Command (Link) (Image needed for now) More...
 
 setTopCommands ($a_val)
 Set top commands (display command buttons on top of table, too) More...
 
 getTopCommands ()
 Get top commands (display command buttons on top of table, too) More...
 
 addColumn ($a_text, $a_sort_field="", $a_width="", $a_is_checkbox_action_column=false, $a_class="", $a_tooltip="", $a_tooltip_with_html=false)
 Add a column to the header. More...
 
 getNavParameter ()
 
 setOrderLink ($sort_field, $order_dir)
 
 fillHeader ()
 
 determineOffsetAndOrder ($a_omit_offset=false)
 Determine offset and order. More...
 
 storeNavParameter ()
 
 getHTML ()
 Get HTML. More...
 
 numericOrdering ($a_field)
 Should this field be sorted numeric? More...
 
 render ()
 render table @access public More...
 
 writeFilterToSession ()
 Write filter values to session. More...
 
 resetFilter ()
 Reset filter. More...
 
 fillFooter ()
 Fill footer row. More...
 
 getLinkbar ($a_num)
 Get previous/next linkbar. More...
 
 fillHiddenRow ()
 
 fillActionRow ()
 Fill Action Row. More...
 
 setHeaderHTML ($html)
 set header html More...
 
 storeProperty ($type, $value)
 Store table property. More...
 
 loadProperty ($type)
 Load table property. More...
 
 getCurrentState ()
 get current settings for order, limit, columns and filter More...
 
 setContext ($id)
 Set context. More...
 
 getContext ()
 Get context. More...
 
 setShowRowsSelector ($a_value)
 Toggle rows-per-page selector. More...
 
 getShowRowsSelector ()
 Get rows-per-page selector state. More...
 
 setShowTemplates ($a_value)
 Toggle templates. More...
 
 getShowTemplates ()
 Get template state. More...
 
 restoreTemplate ($a_name)
 Restore state from template. More...
 
 saveTemplate ($a_name)
 Save current state as template. More...
 
 deleteTemplate ($a_name)
 Delete template. More...
 
 getLimit ()
 Get limit. More...
 
 getOffset ()
 Get offset. More...
 
 setExportFormats (array $formats)
 Set available export formats. More...
 
 setPrintMode ($a_value=false)
 Toogle print mode. More...
 
 getPrintMode ()
 Get print mode. More...
 
 getExportMode ()
 Was export activated? More...
 
 exportData ($format, $send=false)
 Export and optionally send current table data. More...
 
 setEnableAllCommand ($a_value)
 Enable actions for all entries in current result. More...
 
 setRowSelectorLabel ($row_selector_label)
 
 getRowSelectorLabel ()
 
 setPreventDoubleSubmission ($a_val)
 Set prevent double submission. More...
 
 getPreventDoubleSubmission ()
 Get prevent double submission. More...
 
 setLimit ($a_limit=0, $a_default_limit=0)
 set max. More...
 
- Public Member Functions inherited from ilTableGUI
 ilTableGUI ($a_data=0, $a_global_tpl=true)
 Constructor. More...
 
 setTemplate (&$a_tpl)
 set template @access public More...
 
getTemplateObject ()
 
 setData ($a_data)
 set table data @access public More...
 
 getData ()
 
 setTitle ($a_title, $a_icon=0, $a_icon_alt=0)
 set table title @access public More...
 
 setHelp ($a_help_page, $a_help_icon, $a_help_icon_alt=0)
 set table help page @access public More...
 
 setHeaderNames ($a_header_names)
 set table header names @access public More...
 
 getColumnCount ()
 Returns the column count based on the number of the header row columns @access public. More...
 
 setHeaderVars ($a_header_vars, $a_header_params=0)
 set table header vars @access public More...
 
 setColumnWidth ($a_column_width)
 set table column widths @access public More...
 
 setOneColumnWidth ($a_column_width, $a_column_number)
 set one table column width @access public More...
 
 setMaxCount ($a_max_count)
 set max. More...
 
 setLimit ($a_limit=0, $a_default_limit=0)
 set max. More...
 
 getLimit ()
 Get limit. More...
 
 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) @access public More...
 
 setOffset ($a_offset)
 set dataset offset @access public More...
 
 getOffset ()
 Get offset. More...
 
 setOrderColumn ($a_order_column=0, $a_default_column=0)
 set order column @access public More...
 
 getOrderColumn ()
 Get order column. More...
 
 setOrderDirection ($a_order_direction)
 set order direction @access public More...
 
 getOrderDirection ()
 Get order direction. More...
 
 setFooter ($a_style, $a_previous=0, $a_next=0)
 set order direction @access public More...
 
 enable ($a_module_name)
 enables particular modules of table More...
 
 disable ($a_module_name)
 diesables particular modules of table More...
 
 sortData ()
 
 render ()
 render table @access public More...
 
 renderHeader ()
 
 setOrderLink ($key, $order_dir)
 
 setStyle ($a_element, $a_style)
 
 getStyle ($a_element)
 
 setBase ($a_base)
 Set Base script name (deprecated, only use this for workarounds). More...
 
 getBase ()
 Get Base script name (deprecated, only use this for workarounds). More...
 
 getFormName ()
 
 setFormName ($a_name="cmd")
 
 getSelectAllCheckbox ()
 
 setSelectAllCheckbox ($a_select_all_checkbox)
 
 clearActionButtons ()
 
 addActionButton ($btn_name, $btn_value)
 

Private Attributes

 $total_data = array()
 

Additional Inherited Members

- Static Public Member Functions inherited from ilTable2GUI
static getAllCommandLimit ()
 Get maximum number of entries to enable actions for all. More...
 
- 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
 
- 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 Member Functions inherited from ilTable2GUI
 prepareOutput ()
 Anything that must be done before HTML is generated. More...
 
 isAdvMDFilter (ilAdvancedMDRecordGUI $a_gui, $a_element)
 Check if filter element is based on adv md. More...
 
 fillRow ($a_set)
 Standard Version of Fill Row. More...
 
 getFilterValue (ilFormPropertyGUI $a_item)
 Get current filter value. More...
 
 SetFilterValue (ilFormPropertyGUI $a_item, $a_value)
 Set current filter value. More...
 
 fillMetaExcel ($worksheet, &$a_row)
 Add meta information to excel export. More...
 
 fillHeaderExcel ($worksheet, &$a_row)
 Excel Version of Fill Header. More...
 
 fillRowExcel ($a_worksheet, &$a_row, $a_set)
 Excel Version of Fill Row. More...
 
 fillMetaCSV ($a_csv)
 Add meta information to csv export. More...
 
 fillHeaderCSV ($a_csv)
 CSV Version of Fill Header. More...
 
 fillRowCSV ($a_csv, $a_set)
 CSV Version of Fill Row. More...
 
- 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
 
 $rows_selector_off = false
 
 $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

Class ilShoppingCartTableGUI.

Author
Nadia Ahmad nahma.nosp@m.d@da.nosp@m.tabay.nosp@m..de
Version
$Id:$

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

Constructor & Destructor Documentation

◆ __construct()

ilShoppingCartTableGUI::__construct (   $a_parent_obj,
  $a_parent_cmd = "" 
)

Constructor.

@access public

Definition at line 26 of file class.ilShoppingCartTableGUI.php.

27 {
28
29 global $lng,$ilCtrl;
30
31 $this->lng = $lng;
32 $this->ctrl = $ilCtrl;
33
34 parent::__construct($a_parent_obj, $a_parent_cmd);
35
36
37 $this->setFormAction($this->ctrl->getFormAction($a_parent_obj));
38 }
setFormAction($a_form_action, $a_multipart=false)
Set Form action parameter.
global $ilCtrl
Definition: ilias.php:18
global $lng
Definition: privfeed.php:40

References $ilCtrl, $lng, and ilTable2GUI\setFormAction().

+ Here is the call graph for this function:

Member Function Documentation

◆ fillRow()

ilShoppingCartTableGUI::fillRow (   $a_set)

Fill row.

@access public

Parameters

Reimplemented from ilTable2GUI.

Definition at line 47 of file class.ilShoppingCartTableGUI.php.

48 {
49 foreach ($a_set as $key => $value)
50 {
51 $this->tpl->setVariable("VAL_".strtoupper($key), $value);
52 }
53 }

Referenced by getCartHTML().

+ Here is the caller graph for this function:

◆ getCartHTML()

ilShoppingCartTableGUI::getCartHTML ( )

Get HTML: only for shoppingcarts does the same as getHTML of table2gui but additional.

Definition at line 79 of file class.ilShoppingCartTableGUI.php.

80 {
81
82 global $lng, $ilCtrl, $ilUser;
83
84 $this->prepareOutput();
85
86 if (is_object($ilCtrl) && $this->getId() == "")
87 {
88 $ilCtrl->saveParameter($this->getParentObject(), $this->getNavParameter());
89 }
90
91 if(!$this->enabled['content'])
92 {
93 return $this->render();
94 }
95
96 if (!$this->getExternalSegmentation())
97 {
98 $this->setMaxCount(count($this->row_data));
99 }
100
102
103 $this->setFooter("tblfooter",$this->lng->txt("previous"),$this->lng->txt("next"));
104
105 // sort
106 $data = $this->getData();
107 if (!$this->getExternalSorting())
108 {
110 $this->getOrderDirection(), $this->numericOrdering($this->getOrderField()));
111 }
112
113 // slice
114 if (!$this->getExternalSegmentation())
115 {
116 $data = array_slice($data, $this->getOffset(), $this->getLimit());
117 }
118
119 // fill rows
120 if(count($data) > 0)
121 {
122 $this->tpl->addBlockFile("TBL_CONTENT", "tbl_content", $this->row_template,
123 $this->row_template_dir);
124
125 foreach($data as $set)
126 {
127 $this->tpl->setCurrentBlock("tbl_content");
128 $this->css_row = ($this->css_row != "tblrow1")
129 ? "tblrow1"
130 : "tblrow2";
131 $this->tpl->setVariable("CSS_ROW", $this->css_row);
132
133 $this->fillRow($set);
134 $this->tpl->setCurrentBlock("tbl_content");
135 $this->tpl->parseCurrentBlock();
136 }
137 // Rows for Total Amounts
138 $this->css_row_2 = ($this->css_row == "tblrow1")
139 ? "tblrow2"
140 : "tblrow1";
141
142 $this->tpl->setCurrentBlock('totals_row');
143
144 foreach($this->total_data as $key => $value)
145 {
146 $this->tpl->setVariable('CSS_ROW_2', $this->css_row_2);
147 $this->tpl->setVariable($key, $value);
148 }
149 $this->tpl->parseCurrentBlock();
150 // */
151 }
152 else
153 {
154 // add standard no items text (please tell me, if it messes something up, alex, 29.8.2008)
155 $no_items_text = (trim($this->getNoEntriesText()) != '')
156 ? $this->getNoEntriesText()
157 : $lng->txt("no_items");
158
159 $this->css_row = ($this->css_row != "tblrow1")
160 ? "tblrow1"
161 : "tblrow2";
162
163 $this->tpl->setCurrentBlock("tbl_no_entries");
164 $this->tpl->setVariable('TBL_NO_ENTRY_CSS_ROW', $this->css_row);
165 $this->tpl->setVariable('TBL_NO_ENTRY_COLUMN_COUNT', $this->column_count);
166 $this->tpl->setVariable('TBL_NO_ENTRY_TEXT', trim($no_items_text));
167 $this->tpl->parseCurrentBlock();
168 }
169
170 // set form action
171 if ($this->form_action != "")
172 {
173 $hash = "";
174 if (is_object($ilUser) && $ilUser->prefs["screen_reader_optimization"])
175 {
176 $hash = "#".$this->getTopAnchor();
177 }
178
179 $this->tpl->setCurrentBlock("tbl_form_header");
180 $this->tpl->setVariable("FORMACTION", $this->getFormAction().$hash);
181 $this->tpl->setVariable("FORMNAME", $this->getFormName());
182 $this->tpl->parseCurrentBlock();
183 $this->tpl->touchBlock("tbl_form_footer");
184 }
185
186 // fill Totals Row
187 $this->fillFooter();
188
189 $this->fillHiddenRow();
190
191 $this->fillActionRow();
192
193 $this->storeNavParameter();
194
195 return $this->render();
196 }
getFormName()
Get Form name.
prepareOutput()
Anything that must be done before HTML is generated.
getNoEntriesText()
Get text for an empty table.
getParentObject()
Get parent object.
getFormAction()
Get Form action parameter.
render()
render table @access public
determineOffsetAndOrder($a_omit_offset=false)
Determine offset and order.
getId()
Get element id.
getExternalSorting()
Get external sorting.
getLimit()
Get limit.
fillFooter()
Fill footer row.
getExternalSegmentation()
Get external segmentation.
getOffset()
Get offset.
fillActionRow()
Fill Action Row.
numericOrdering($a_field)
Should this field be sorted numeric?
getOrderDirection()
Get order direction.
setMaxCount($a_max_count)
set max.
setFooter($a_style, $a_previous=0, $a_next=0)
set order direction @access public
static sortArray($array, $a_array_sortby, $a_array_sortorder=0, $a_numeric=false, $a_keep_keys=false)
sortArray
global $ilUser
Definition: imgupload.php:15

References ilTableGUI\$data, $ilCtrl, $ilUser, $lng, ilTable2GUI\determineOffsetAndOrder(), ilTable2GUI\fillActionRow(), ilTable2GUI\fillFooter(), ilTable2GUI\fillHiddenRow(), fillRow(), ilTable2GUI\getData(), ilTable2GUI\getExternalSegmentation(), ilTable2GUI\getExternalSorting(), ilTable2GUI\getFormAction(), ilTable2GUI\getFormName(), ilTable2GUI\getId(), ilTable2GUI\getLimit(), ilTable2GUI\getNavParameter(), ilTable2GUI\getNoEntriesText(), ilTable2GUI\getOffset(), ilTableGUI\getOrderDirection(), ilTable2GUI\getOrderField(), ilTable2GUI\getParentObject(), ilTable2GUI\numericOrdering(), ilTable2GUI\prepareOutput(), ilTable2GUI\render(), ilTableGUI\setFooter(), ilTableGUI\setMaxCount(), ilUtil\sortArray(), and ilTable2GUI\storeNavParameter().

+ Here is the call graph for this function:

◆ getTotalData()

ilShoppingCartTableGUI::getTotalData ( )

Definition at line 69 of file class.ilShoppingCartTableGUI.php.

References $total_data.

◆ setTotalData()

ilShoppingCartTableGUI::setTotalData (   $a_key,
  $a_value 
)

set total data

@access public

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

64 {
65 $this->total_data[$a_key] = $a_value;
66 }

Field Documentation

◆ $total_data

ilShoppingCartTableGUI::$total_data = array()
private

Definition at line 18 of file class.ilShoppingCartTableGUI.php.

Referenced by getTotalData().


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